@gscdump/contracts 1.2.0 → 1.3.1
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/index.d.mts +2601 -0
- package/dist/v1/index.mjs +1276 -1
- package/package.json +1 -1
package/dist/v1/index.d.mts
CHANGED
|
@@ -8160,6 +8160,2607 @@ declare function createGscdumpV1Protocol(): {
|
|
|
8160
8160
|
};
|
|
8161
8161
|
};
|
|
8162
8162
|
};
|
|
8163
|
+
readonly createSitemapAction: {
|
|
8164
|
+
readonly id: "partner.sites.sitemaps.action.create";
|
|
8165
|
+
readonly method: "POST";
|
|
8166
|
+
readonly path: "/sites/{siteId}/sitemaps/actions";
|
|
8167
|
+
readonly visibility: "public";
|
|
8168
|
+
readonly semantics: {
|
|
8169
|
+
readonly kind: "mutation";
|
|
8170
|
+
readonly sideEffects: "state";
|
|
8171
|
+
readonly idempotent: false;
|
|
8172
|
+
readonly retry: "never";
|
|
8173
|
+
readonly readConsistency: null;
|
|
8174
|
+
};
|
|
8175
|
+
readonly auth: {
|
|
8176
|
+
readonly credentials: readonly ["user_key", "partner_key"];
|
|
8177
|
+
readonly scopes: readonly ["sitemaps:write"];
|
|
8178
|
+
readonly ownership: readonly [{
|
|
8179
|
+
readonly credential: "user_key";
|
|
8180
|
+
readonly rule: "authorized_site";
|
|
8181
|
+
}, {
|
|
8182
|
+
readonly credential: "partner_key";
|
|
8183
|
+
readonly rule: "authorized_site";
|
|
8184
|
+
}];
|
|
8185
|
+
};
|
|
8186
|
+
readonly request: {
|
|
8187
|
+
readonly params: z.ZodObject<{
|
|
8188
|
+
siteId: z.ZodString;
|
|
8189
|
+
}, z.core.$strict>;
|
|
8190
|
+
readonly query: null;
|
|
8191
|
+
readonly headers: z.ZodObject<{
|
|
8192
|
+
'x-request-id': z.ZodOptional<z.ZodString>;
|
|
8193
|
+
}, z.core.$strict>;
|
|
8194
|
+
readonly body: z.ZodDiscriminatedUnion<[z.ZodObject<{
|
|
8195
|
+
action: z.ZodLiteral<"submit">;
|
|
8196
|
+
sitemapUrl: z.ZodString;
|
|
8197
|
+
}, z.core.$strip>, z.ZodObject<{
|
|
8198
|
+
action: z.ZodLiteral<"delete">;
|
|
8199
|
+
sitemapUrl: z.ZodString;
|
|
8200
|
+
}, z.core.$strip>, z.ZodObject<{
|
|
8201
|
+
action: z.ZodLiteral<"refresh">;
|
|
8202
|
+
}, z.core.$strip>, z.ZodObject<{
|
|
8203
|
+
action: z.ZodLiteral<"auto-discover">;
|
|
8204
|
+
}, z.core.$strip>], "action">;
|
|
8205
|
+
};
|
|
8206
|
+
readonly responses: {
|
|
8207
|
+
readonly 200: CompatibleResponseSchema<z.ZodObject<{
|
|
8208
|
+
data: z.ZodDiscriminatedUnion<[z.ZodObject<{
|
|
8209
|
+
success: z.ZodBoolean;
|
|
8210
|
+
action: z.ZodEnum<{
|
|
8211
|
+
submitted: "submitted";
|
|
8212
|
+
deleted: "deleted";
|
|
8213
|
+
}>;
|
|
8214
|
+
sitemapUrl: z.ZodString;
|
|
8215
|
+
sitemapCount: z.ZodNumber;
|
|
8216
|
+
}, z.core.$loose>, z.ZodObject<{
|
|
8217
|
+
success: z.ZodLiteral<true>;
|
|
8218
|
+
action: z.ZodLiteral<"refreshed">;
|
|
8219
|
+
sitemapCount: z.ZodNumber;
|
|
8220
|
+
changed: z.ZodBoolean;
|
|
8221
|
+
}, z.core.$loose>, z.ZodObject<{
|
|
8222
|
+
success: z.ZodBoolean;
|
|
8223
|
+
action: z.ZodLiteral<"auto-discover">;
|
|
8224
|
+
discovered: z.ZodNullable<z.ZodString>;
|
|
8225
|
+
submitError: z.ZodOptional<z.ZodNullable<z.ZodString>>;
|
|
8226
|
+
sitemapCount: z.ZodNumber;
|
|
8227
|
+
}, z.core.$loose>], "action">;
|
|
8228
|
+
meta: z.ZodObject<{
|
|
8229
|
+
readonly requestId: z.ZodString;
|
|
8230
|
+
readonly surface: z.ZodLiteral<"partner">;
|
|
8231
|
+
readonly version: z.ZodLiteral<"1.0">;
|
|
8232
|
+
}, z.core.$strip>;
|
|
8233
|
+
}, z.core.$strip>, z.ZodObject<{
|
|
8234
|
+
data: z.ZodDiscriminatedUnion<[z.ZodObject<{
|
|
8235
|
+
success: z.ZodBoolean;
|
|
8236
|
+
action: z.ZodEnum<{
|
|
8237
|
+
submitted: "submitted";
|
|
8238
|
+
deleted: "deleted";
|
|
8239
|
+
}>;
|
|
8240
|
+
sitemapUrl: z.ZodString;
|
|
8241
|
+
sitemapCount: z.ZodNumber;
|
|
8242
|
+
}, z.core.$loose>, z.ZodObject<{
|
|
8243
|
+
success: z.ZodLiteral<true>;
|
|
8244
|
+
action: z.ZodLiteral<"refreshed">;
|
|
8245
|
+
sitemapCount: z.ZodNumber;
|
|
8246
|
+
changed: z.ZodBoolean;
|
|
8247
|
+
}, z.core.$loose>, z.ZodObject<{
|
|
8248
|
+
success: z.ZodBoolean;
|
|
8249
|
+
action: z.ZodLiteral<"auto-discover">;
|
|
8250
|
+
discovered: z.ZodNullable<z.ZodString>;
|
|
8251
|
+
submitError: z.ZodOptional<z.ZodNullable<z.ZodString>>;
|
|
8252
|
+
sitemapCount: z.ZodNumber;
|
|
8253
|
+
}, z.core.$loose>], "action">;
|
|
8254
|
+
meta: z.ZodObject<{
|
|
8255
|
+
readonly requestId: z.ZodString;
|
|
8256
|
+
readonly surface: z.ZodLiteral<"partner">;
|
|
8257
|
+
readonly version: z.ZodLiteral<"1.0">;
|
|
8258
|
+
}, z.core.$strip>;
|
|
8259
|
+
}, z.core.$strip>>;
|
|
8260
|
+
};
|
|
8261
|
+
readonly errors: readonly ["invalid_request", "unauthorized", "forbidden", "site_not_found", "rate_limited", "internal_error", "contract_violation"];
|
|
8262
|
+
readonly errorResponse: CompatibleResponseSchema<z.ZodObject<{
|
|
8263
|
+
readonly error: z.ZodObject<{
|
|
8264
|
+
code: z.ZodEnum<{
|
|
8265
|
+
rate_limited: "rate_limited";
|
|
8266
|
+
internal_error: "internal_error";
|
|
8267
|
+
invalid_request: "invalid_request";
|
|
8268
|
+
unauthorized: "unauthorized";
|
|
8269
|
+
forbidden: "forbidden";
|
|
8270
|
+
site_not_found: "site_not_found";
|
|
8271
|
+
contract_violation: "contract_violation";
|
|
8272
|
+
}>;
|
|
8273
|
+
message: z.ZodString;
|
|
8274
|
+
requestId: z.ZodString;
|
|
8275
|
+
retryable: z.ZodBoolean;
|
|
8276
|
+
details: z.ZodRecord<z.ZodString, z.ZodJSONSchema>;
|
|
8277
|
+
}, z.core.$strict>;
|
|
8278
|
+
}, z.core.$strip>, z.ZodObject<{
|
|
8279
|
+
readonly error: z.ZodObject<{
|
|
8280
|
+
code: z.ZodEnum<{
|
|
8281
|
+
rate_limited: "rate_limited";
|
|
8282
|
+
internal_error: "internal_error";
|
|
8283
|
+
invalid_request: "invalid_request";
|
|
8284
|
+
unauthorized: "unauthorized";
|
|
8285
|
+
forbidden: "forbidden";
|
|
8286
|
+
site_not_found: "site_not_found";
|
|
8287
|
+
contract_violation: "contract_violation";
|
|
8288
|
+
}>;
|
|
8289
|
+
message: z.ZodString;
|
|
8290
|
+
requestId: z.ZodString;
|
|
8291
|
+
retryable: z.ZodBoolean;
|
|
8292
|
+
details: z.ZodRecord<z.ZodString, z.ZodJSONSchema>;
|
|
8293
|
+
}, z.core.$loose>;
|
|
8294
|
+
}, z.core.$strip>>;
|
|
8295
|
+
readonly resources: {
|
|
8296
|
+
readonly reads: readonly [{
|
|
8297
|
+
readonly type: "site.sitemaps";
|
|
8298
|
+
readonly idFrom: "params.siteId";
|
|
8299
|
+
}];
|
|
8300
|
+
readonly changes: readonly [{
|
|
8301
|
+
readonly type: "site.sitemaps";
|
|
8302
|
+
readonly idFrom: "params.siteId";
|
|
8303
|
+
}];
|
|
8304
|
+
};
|
|
8305
|
+
readonly lifecycle: {
|
|
8306
|
+
readonly introduced: "1.3.0";
|
|
8307
|
+
};
|
|
8308
|
+
readonly docs: {
|
|
8309
|
+
readonly summary: "Run a sitemap action";
|
|
8310
|
+
readonly description: "Submits, deletes, refreshes, or auto-discovers a site's sitemap; the response shape depends on the requested action.";
|
|
8311
|
+
readonly tags: readonly ["Sitemaps"];
|
|
8312
|
+
readonly examples: {
|
|
8313
|
+
readonly request: {
|
|
8314
|
+
readonly params: {
|
|
8315
|
+
readonly siteId: "s_01";
|
|
8316
|
+
};
|
|
8317
|
+
readonly body: {
|
|
8318
|
+
readonly action: "refresh";
|
|
8319
|
+
};
|
|
8320
|
+
};
|
|
8321
|
+
readonly response: {
|
|
8322
|
+
readonly data: {
|
|
8323
|
+
readonly success: true;
|
|
8324
|
+
readonly action: "refreshed";
|
|
8325
|
+
readonly sitemapCount: 0;
|
|
8326
|
+
readonly changed: false;
|
|
8327
|
+
};
|
|
8328
|
+
readonly meta: {
|
|
8329
|
+
readonly requestId: "req_01";
|
|
8330
|
+
readonly surface: "partner";
|
|
8331
|
+
readonly version: "1.0";
|
|
8332
|
+
};
|
|
8333
|
+
};
|
|
8334
|
+
};
|
|
8335
|
+
};
|
|
8336
|
+
};
|
|
8337
|
+
readonly querySitemapMembership: {
|
|
8338
|
+
readonly id: "partner.sites.sitemaps.membership.query";
|
|
8339
|
+
readonly method: "POST";
|
|
8340
|
+
readonly path: "/sites/{siteId}/sitemaps/membership";
|
|
8341
|
+
readonly visibility: "public";
|
|
8342
|
+
readonly semantics: {
|
|
8343
|
+
readonly kind: "query";
|
|
8344
|
+
readonly sideEffects: "none";
|
|
8345
|
+
readonly idempotent: true;
|
|
8346
|
+
readonly retry: "idempotent";
|
|
8347
|
+
readonly readConsistency: "primary";
|
|
8348
|
+
};
|
|
8349
|
+
readonly auth: {
|
|
8350
|
+
readonly credentials: readonly ["user_key", "partner_key"];
|
|
8351
|
+
readonly scopes: readonly ["sitemaps:read"];
|
|
8352
|
+
readonly ownership: readonly [{
|
|
8353
|
+
readonly credential: "user_key";
|
|
8354
|
+
readonly rule: "authorized_site";
|
|
8355
|
+
}, {
|
|
8356
|
+
readonly credential: "partner_key";
|
|
8357
|
+
readonly rule: "authorized_site";
|
|
8358
|
+
}];
|
|
8359
|
+
};
|
|
8360
|
+
readonly request: {
|
|
8361
|
+
readonly params: z.ZodObject<{
|
|
8362
|
+
siteId: z.ZodString;
|
|
8363
|
+
}, z.core.$strict>;
|
|
8364
|
+
readonly query: null;
|
|
8365
|
+
readonly headers: z.ZodObject<{
|
|
8366
|
+
'x-request-id': z.ZodOptional<z.ZodString>;
|
|
8367
|
+
}, z.core.$strict>;
|
|
8368
|
+
readonly body: z.ZodObject<{
|
|
8369
|
+
urls: z.ZodArray<z.ZodString>;
|
|
8370
|
+
maxAgeDays: z.ZodOptional<z.ZodNumber>;
|
|
8371
|
+
}, z.core.$strict>;
|
|
8372
|
+
};
|
|
8373
|
+
readonly responses: {
|
|
8374
|
+
readonly 200: CompatibleResponseSchema<z.ZodObject<{
|
|
8375
|
+
data: z.ZodObject<{
|
|
8376
|
+
urls: z.ZodArray<z.ZodObject<{
|
|
8377
|
+
url: z.ZodString;
|
|
8378
|
+
normalized: z.ZodString;
|
|
8379
|
+
inSitemap: z.ZodBoolean;
|
|
8380
|
+
sitemapUrl: z.ZodOptional<z.ZodNullable<z.ZodString>>;
|
|
8381
|
+
lastSeenAt: z.ZodOptional<z.ZodNullable<z.ZodString>>;
|
|
8382
|
+
lastmod: z.ZodOptional<z.ZodNullable<z.ZodString>>;
|
|
8383
|
+
sitemapFetchedAt: z.ZodOptional<z.ZodNullable<z.ZodString>>;
|
|
8384
|
+
}, z.core.$loose>>;
|
|
8385
|
+
meta: z.ZodObject<{
|
|
8386
|
+
available: z.ZodBoolean;
|
|
8387
|
+
reason: z.ZodNullable<z.ZodEnum<{
|
|
8388
|
+
empty: "empty";
|
|
8389
|
+
site_url_cap_exceeded: "site_url_cap_exceeded";
|
|
8390
|
+
stale_sitemaps: "stale_sitemaps";
|
|
8391
|
+
}>>;
|
|
8392
|
+
requested: z.ZodNumber;
|
|
8393
|
+
checked: z.ZodNumber;
|
|
8394
|
+
matched: z.ZodNumber;
|
|
8395
|
+
newestFetchedAt: z.ZodNullable<z.ZodString>;
|
|
8396
|
+
}, z.core.$loose>;
|
|
8397
|
+
}, z.core.$strip>;
|
|
8398
|
+
meta: z.ZodObject<{
|
|
8399
|
+
readonly requestId: z.ZodString;
|
|
8400
|
+
readonly surface: z.ZodLiteral<"partner">;
|
|
8401
|
+
readonly version: z.ZodLiteral<"1.0">;
|
|
8402
|
+
}, z.core.$strip>;
|
|
8403
|
+
}, z.core.$strip>, z.ZodObject<{
|
|
8404
|
+
data: z.ZodObject<{
|
|
8405
|
+
urls: z.ZodArray<z.ZodObject<{
|
|
8406
|
+
url: z.ZodString;
|
|
8407
|
+
normalized: z.ZodString;
|
|
8408
|
+
inSitemap: z.ZodBoolean;
|
|
8409
|
+
sitemapUrl: z.ZodOptional<z.ZodNullable<z.ZodString>>;
|
|
8410
|
+
lastSeenAt: z.ZodOptional<z.ZodNullable<z.ZodString>>;
|
|
8411
|
+
lastmod: z.ZodOptional<z.ZodNullable<z.ZodString>>;
|
|
8412
|
+
sitemapFetchedAt: z.ZodOptional<z.ZodNullable<z.ZodString>>;
|
|
8413
|
+
}, z.core.$loose>>;
|
|
8414
|
+
meta: z.ZodObject<{
|
|
8415
|
+
available: z.ZodBoolean;
|
|
8416
|
+
reason: z.ZodNullable<z.ZodEnum<{
|
|
8417
|
+
empty: "empty";
|
|
8418
|
+
site_url_cap_exceeded: "site_url_cap_exceeded";
|
|
8419
|
+
stale_sitemaps: "stale_sitemaps";
|
|
8420
|
+
}>>;
|
|
8421
|
+
requested: z.ZodNumber;
|
|
8422
|
+
checked: z.ZodNumber;
|
|
8423
|
+
matched: z.ZodNumber;
|
|
8424
|
+
newestFetchedAt: z.ZodNullable<z.ZodString>;
|
|
8425
|
+
}, z.core.$loose>;
|
|
8426
|
+
}, z.core.$strip>;
|
|
8427
|
+
meta: z.ZodObject<{
|
|
8428
|
+
readonly requestId: z.ZodString;
|
|
8429
|
+
readonly surface: z.ZodLiteral<"partner">;
|
|
8430
|
+
readonly version: z.ZodLiteral<"1.0">;
|
|
8431
|
+
}, z.core.$strip>;
|
|
8432
|
+
}, z.core.$strip>>;
|
|
8433
|
+
};
|
|
8434
|
+
readonly errors: readonly ["invalid_request", "unauthorized", "forbidden", "site_not_found", "rate_limited", "internal_error", "contract_violation"];
|
|
8435
|
+
readonly errorResponse: CompatibleResponseSchema<z.ZodObject<{
|
|
8436
|
+
readonly error: z.ZodObject<{
|
|
8437
|
+
code: z.ZodEnum<{
|
|
8438
|
+
rate_limited: "rate_limited";
|
|
8439
|
+
internal_error: "internal_error";
|
|
8440
|
+
invalid_request: "invalid_request";
|
|
8441
|
+
unauthorized: "unauthorized";
|
|
8442
|
+
forbidden: "forbidden";
|
|
8443
|
+
site_not_found: "site_not_found";
|
|
8444
|
+
contract_violation: "contract_violation";
|
|
8445
|
+
}>;
|
|
8446
|
+
message: z.ZodString;
|
|
8447
|
+
requestId: z.ZodString;
|
|
8448
|
+
retryable: z.ZodBoolean;
|
|
8449
|
+
details: z.ZodRecord<z.ZodString, z.ZodJSONSchema>;
|
|
8450
|
+
}, z.core.$strict>;
|
|
8451
|
+
}, z.core.$strip>, z.ZodObject<{
|
|
8452
|
+
readonly error: z.ZodObject<{
|
|
8453
|
+
code: z.ZodEnum<{
|
|
8454
|
+
rate_limited: "rate_limited";
|
|
8455
|
+
internal_error: "internal_error";
|
|
8456
|
+
invalid_request: "invalid_request";
|
|
8457
|
+
unauthorized: "unauthorized";
|
|
8458
|
+
forbidden: "forbidden";
|
|
8459
|
+
site_not_found: "site_not_found";
|
|
8460
|
+
contract_violation: "contract_violation";
|
|
8461
|
+
}>;
|
|
8462
|
+
message: z.ZodString;
|
|
8463
|
+
requestId: z.ZodString;
|
|
8464
|
+
retryable: z.ZodBoolean;
|
|
8465
|
+
details: z.ZodRecord<z.ZodString, z.ZodJSONSchema>;
|
|
8466
|
+
}, z.core.$loose>;
|
|
8467
|
+
}, z.core.$strip>>;
|
|
8468
|
+
readonly resources: {
|
|
8469
|
+
readonly reads: readonly [{
|
|
8470
|
+
readonly type: "site.sitemaps";
|
|
8471
|
+
readonly idFrom: "params.siteId";
|
|
8472
|
+
}];
|
|
8473
|
+
readonly changes: readonly [];
|
|
8474
|
+
};
|
|
8475
|
+
readonly lifecycle: {
|
|
8476
|
+
readonly introduced: "1.3.0";
|
|
8477
|
+
};
|
|
8478
|
+
readonly docs: {
|
|
8479
|
+
readonly summary: "Query sitemap membership";
|
|
8480
|
+
readonly description: "Checks whether each requested URL is present in the site's known sitemaps, subject to a freshness cap.";
|
|
8481
|
+
readonly tags: readonly ["Sitemaps"];
|
|
8482
|
+
readonly examples: {
|
|
8483
|
+
readonly request: {
|
|
8484
|
+
readonly params: {
|
|
8485
|
+
readonly siteId: "s_01";
|
|
8486
|
+
};
|
|
8487
|
+
readonly body: {
|
|
8488
|
+
readonly urls: readonly ["https://example.com/"];
|
|
8489
|
+
readonly maxAgeDays: 30;
|
|
8490
|
+
};
|
|
8491
|
+
};
|
|
8492
|
+
readonly response: {
|
|
8493
|
+
readonly data: {
|
|
8494
|
+
readonly urls: readonly [];
|
|
8495
|
+
readonly meta: {
|
|
8496
|
+
readonly available: true;
|
|
8497
|
+
readonly reason: null;
|
|
8498
|
+
readonly requested: 1;
|
|
8499
|
+
readonly checked: 1;
|
|
8500
|
+
readonly matched: 0;
|
|
8501
|
+
readonly newestFetchedAt: null;
|
|
8502
|
+
};
|
|
8503
|
+
};
|
|
8504
|
+
readonly meta: {
|
|
8505
|
+
readonly requestId: "req_01";
|
|
8506
|
+
readonly surface: "partner";
|
|
8507
|
+
readonly version: "1.0";
|
|
8508
|
+
};
|
|
8509
|
+
};
|
|
8510
|
+
};
|
|
8511
|
+
};
|
|
8512
|
+
};
|
|
8513
|
+
readonly createTeam: {
|
|
8514
|
+
readonly id: "partner.teams.create";
|
|
8515
|
+
readonly method: "POST";
|
|
8516
|
+
readonly path: "/teams";
|
|
8517
|
+
readonly visibility: "public";
|
|
8518
|
+
readonly semantics: {
|
|
8519
|
+
readonly kind: "mutation";
|
|
8520
|
+
readonly sideEffects: "state";
|
|
8521
|
+
readonly idempotent: false;
|
|
8522
|
+
readonly retry: "never";
|
|
8523
|
+
readonly readConsistency: null;
|
|
8524
|
+
};
|
|
8525
|
+
readonly auth: {
|
|
8526
|
+
readonly credentials: readonly ["partner_key"];
|
|
8527
|
+
readonly scopes: readonly ["teams:write"];
|
|
8528
|
+
readonly ownership: readonly [{
|
|
8529
|
+
readonly credential: "partner_key";
|
|
8530
|
+
readonly rule: "partner_tenant";
|
|
8531
|
+
}];
|
|
8532
|
+
};
|
|
8533
|
+
readonly request: {
|
|
8534
|
+
readonly params: null;
|
|
8535
|
+
readonly query: null;
|
|
8536
|
+
readonly headers: z.ZodObject<{
|
|
8537
|
+
'x-request-id': z.ZodOptional<z.ZodString>;
|
|
8538
|
+
}, z.core.$strict>;
|
|
8539
|
+
readonly body: z.ZodObject<{
|
|
8540
|
+
ownerUserId: z.ZodString;
|
|
8541
|
+
name: z.ZodString;
|
|
8542
|
+
personalTeam: z.ZodOptional<z.ZodBoolean>;
|
|
8543
|
+
}, z.core.$strict>;
|
|
8544
|
+
};
|
|
8545
|
+
readonly responses: {
|
|
8546
|
+
readonly 200: CompatibleResponseSchema<z.ZodObject<{
|
|
8547
|
+
data: z.ZodObject<{
|
|
8548
|
+
team: z.ZodObject<{
|
|
8549
|
+
id: z.ZodString;
|
|
8550
|
+
ownerId: z.ZodNumber;
|
|
8551
|
+
name: z.ZodString;
|
|
8552
|
+
personalTeam: z.ZodBoolean;
|
|
8553
|
+
createdAt: z.ZodNumber;
|
|
8554
|
+
updatedAt: z.ZodNumber;
|
|
8555
|
+
}, z.core.$loose>;
|
|
8556
|
+
}, z.core.$strip>;
|
|
8557
|
+
meta: z.ZodObject<{
|
|
8558
|
+
readonly requestId: z.ZodString;
|
|
8559
|
+
readonly surface: z.ZodLiteral<"partner">;
|
|
8560
|
+
readonly version: z.ZodLiteral<"1.0">;
|
|
8561
|
+
}, z.core.$strip>;
|
|
8562
|
+
}, z.core.$strip>, z.ZodObject<{
|
|
8563
|
+
data: z.ZodObject<{
|
|
8564
|
+
team: z.ZodObject<{
|
|
8565
|
+
id: z.ZodString;
|
|
8566
|
+
ownerId: z.ZodNumber;
|
|
8567
|
+
name: z.ZodString;
|
|
8568
|
+
personalTeam: z.ZodBoolean;
|
|
8569
|
+
createdAt: z.ZodNumber;
|
|
8570
|
+
updatedAt: z.ZodNumber;
|
|
8571
|
+
}, z.core.$loose>;
|
|
8572
|
+
}, z.core.$strip>;
|
|
8573
|
+
meta: z.ZodObject<{
|
|
8574
|
+
readonly requestId: z.ZodString;
|
|
8575
|
+
readonly surface: z.ZodLiteral<"partner">;
|
|
8576
|
+
readonly version: z.ZodLiteral<"1.0">;
|
|
8577
|
+
}, z.core.$strip>;
|
|
8578
|
+
}, z.core.$strip>>;
|
|
8579
|
+
};
|
|
8580
|
+
readonly errors: readonly ["invalid_request", "unauthorized", "forbidden", "user_not_found", "rate_limited", "internal_error", "contract_violation"];
|
|
8581
|
+
readonly errorResponse: CompatibleResponseSchema<z.ZodObject<{
|
|
8582
|
+
readonly error: z.ZodObject<{
|
|
8583
|
+
code: z.ZodEnum<{
|
|
8584
|
+
rate_limited: "rate_limited";
|
|
8585
|
+
internal_error: "internal_error";
|
|
8586
|
+
invalid_request: "invalid_request";
|
|
8587
|
+
unauthorized: "unauthorized";
|
|
8588
|
+
forbidden: "forbidden";
|
|
8589
|
+
user_not_found: "user_not_found";
|
|
8590
|
+
contract_violation: "contract_violation";
|
|
8591
|
+
}>;
|
|
8592
|
+
message: z.ZodString;
|
|
8593
|
+
requestId: z.ZodString;
|
|
8594
|
+
retryable: z.ZodBoolean;
|
|
8595
|
+
details: z.ZodRecord<z.ZodString, z.ZodJSONSchema>;
|
|
8596
|
+
}, z.core.$strict>;
|
|
8597
|
+
}, z.core.$strip>, z.ZodObject<{
|
|
8598
|
+
readonly error: z.ZodObject<{
|
|
8599
|
+
code: z.ZodEnum<{
|
|
8600
|
+
rate_limited: "rate_limited";
|
|
8601
|
+
internal_error: "internal_error";
|
|
8602
|
+
invalid_request: "invalid_request";
|
|
8603
|
+
unauthorized: "unauthorized";
|
|
8604
|
+
forbidden: "forbidden";
|
|
8605
|
+
user_not_found: "user_not_found";
|
|
8606
|
+
contract_violation: "contract_violation";
|
|
8607
|
+
}>;
|
|
8608
|
+
message: z.ZodString;
|
|
8609
|
+
requestId: z.ZodString;
|
|
8610
|
+
retryable: z.ZodBoolean;
|
|
8611
|
+
details: z.ZodRecord<z.ZodString, z.ZodJSONSchema>;
|
|
8612
|
+
}, z.core.$loose>;
|
|
8613
|
+
}, z.core.$strip>>;
|
|
8614
|
+
readonly resources: {
|
|
8615
|
+
readonly reads: readonly [];
|
|
8616
|
+
readonly changes: readonly [{
|
|
8617
|
+
readonly type: "partner.team";
|
|
8618
|
+
readonly idFrom: "principal.id";
|
|
8619
|
+
}];
|
|
8620
|
+
};
|
|
8621
|
+
readonly lifecycle: {
|
|
8622
|
+
readonly introduced: "1.3.0";
|
|
8623
|
+
};
|
|
8624
|
+
readonly docs: {
|
|
8625
|
+
readonly summary: "Create a team";
|
|
8626
|
+
readonly description: "Creates a team owned by a user linked to the authenticated partner tenant.";
|
|
8627
|
+
readonly tags: readonly ["Teams"];
|
|
8628
|
+
readonly examples: {
|
|
8629
|
+
readonly request: {
|
|
8630
|
+
readonly body: {
|
|
8631
|
+
readonly ownerUserId: "u_01";
|
|
8632
|
+
readonly name: "Acme Team";
|
|
8633
|
+
};
|
|
8634
|
+
};
|
|
8635
|
+
readonly response: {
|
|
8636
|
+
readonly data: {
|
|
8637
|
+
readonly team: {
|
|
8638
|
+
readonly id: "t_01";
|
|
8639
|
+
readonly ownerId: 1;
|
|
8640
|
+
readonly name: "Acme Team";
|
|
8641
|
+
readonly personalTeam: false;
|
|
8642
|
+
readonly createdAt: 0;
|
|
8643
|
+
readonly updatedAt: 0;
|
|
8644
|
+
};
|
|
8645
|
+
};
|
|
8646
|
+
readonly meta: {
|
|
8647
|
+
readonly requestId: "req_01";
|
|
8648
|
+
readonly surface: "partner";
|
|
8649
|
+
readonly version: "1.0";
|
|
8650
|
+
};
|
|
8651
|
+
};
|
|
8652
|
+
};
|
|
8653
|
+
};
|
|
8654
|
+
};
|
|
8655
|
+
readonly renameTeam: {
|
|
8656
|
+
readonly id: "partner.teams.rename";
|
|
8657
|
+
readonly method: "PATCH";
|
|
8658
|
+
readonly path: "/teams/{teamId}";
|
|
8659
|
+
readonly visibility: "public";
|
|
8660
|
+
readonly semantics: {
|
|
8661
|
+
readonly kind: "mutation";
|
|
8662
|
+
readonly sideEffects: "state";
|
|
8663
|
+
readonly idempotent: true;
|
|
8664
|
+
readonly retry: "idempotent";
|
|
8665
|
+
readonly readConsistency: null;
|
|
8666
|
+
};
|
|
8667
|
+
readonly auth: {
|
|
8668
|
+
readonly credentials: readonly ["partner_key"];
|
|
8669
|
+
readonly scopes: readonly ["teams:write"];
|
|
8670
|
+
readonly ownership: readonly [{
|
|
8671
|
+
readonly credential: "partner_key";
|
|
8672
|
+
readonly rule: "partner_tenant";
|
|
8673
|
+
}];
|
|
8674
|
+
};
|
|
8675
|
+
readonly request: {
|
|
8676
|
+
readonly params: z.ZodObject<{
|
|
8677
|
+
teamId: z.ZodString;
|
|
8678
|
+
}, z.core.$strict>;
|
|
8679
|
+
readonly query: null;
|
|
8680
|
+
readonly headers: z.ZodObject<{
|
|
8681
|
+
'x-request-id': z.ZodOptional<z.ZodString>;
|
|
8682
|
+
}, z.core.$strict>;
|
|
8683
|
+
readonly body: z.ZodObject<{
|
|
8684
|
+
name: z.ZodString;
|
|
8685
|
+
}, z.core.$strict>;
|
|
8686
|
+
};
|
|
8687
|
+
readonly responses: {
|
|
8688
|
+
readonly 200: CompatibleResponseSchema<z.ZodObject<{
|
|
8689
|
+
data: z.ZodObject<{
|
|
8690
|
+
ok: z.ZodLiteral<true>;
|
|
8691
|
+
name: z.ZodString;
|
|
8692
|
+
}, z.core.$strip>;
|
|
8693
|
+
meta: z.ZodObject<{
|
|
8694
|
+
readonly requestId: z.ZodString;
|
|
8695
|
+
readonly surface: z.ZodLiteral<"partner">;
|
|
8696
|
+
readonly version: z.ZodLiteral<"1.0">;
|
|
8697
|
+
}, z.core.$strip>;
|
|
8698
|
+
}, z.core.$strip>, z.ZodObject<{
|
|
8699
|
+
data: z.ZodObject<{
|
|
8700
|
+
ok: z.ZodLiteral<true>;
|
|
8701
|
+
name: z.ZodString;
|
|
8702
|
+
}, z.core.$strip>;
|
|
8703
|
+
meta: z.ZodObject<{
|
|
8704
|
+
readonly requestId: z.ZodString;
|
|
8705
|
+
readonly surface: z.ZodLiteral<"partner">;
|
|
8706
|
+
readonly version: z.ZodLiteral<"1.0">;
|
|
8707
|
+
}, z.core.$strip>;
|
|
8708
|
+
}, z.core.$strip>>;
|
|
8709
|
+
};
|
|
8710
|
+
readonly errors: readonly ["invalid_request", "unauthorized", "forbidden", "user_not_found", "rate_limited", "internal_error", "contract_violation"];
|
|
8711
|
+
readonly errorResponse: CompatibleResponseSchema<z.ZodObject<{
|
|
8712
|
+
readonly error: z.ZodObject<{
|
|
8713
|
+
code: z.ZodEnum<{
|
|
8714
|
+
rate_limited: "rate_limited";
|
|
8715
|
+
internal_error: "internal_error";
|
|
8716
|
+
invalid_request: "invalid_request";
|
|
8717
|
+
unauthorized: "unauthorized";
|
|
8718
|
+
forbidden: "forbidden";
|
|
8719
|
+
user_not_found: "user_not_found";
|
|
8720
|
+
contract_violation: "contract_violation";
|
|
8721
|
+
}>;
|
|
8722
|
+
message: z.ZodString;
|
|
8723
|
+
requestId: z.ZodString;
|
|
8724
|
+
retryable: z.ZodBoolean;
|
|
8725
|
+
details: z.ZodRecord<z.ZodString, z.ZodJSONSchema>;
|
|
8726
|
+
}, z.core.$strict>;
|
|
8727
|
+
}, z.core.$strip>, z.ZodObject<{
|
|
8728
|
+
readonly error: z.ZodObject<{
|
|
8729
|
+
code: z.ZodEnum<{
|
|
8730
|
+
rate_limited: "rate_limited";
|
|
8731
|
+
internal_error: "internal_error";
|
|
8732
|
+
invalid_request: "invalid_request";
|
|
8733
|
+
unauthorized: "unauthorized";
|
|
8734
|
+
forbidden: "forbidden";
|
|
8735
|
+
user_not_found: "user_not_found";
|
|
8736
|
+
contract_violation: "contract_violation";
|
|
8737
|
+
}>;
|
|
8738
|
+
message: z.ZodString;
|
|
8739
|
+
requestId: z.ZodString;
|
|
8740
|
+
retryable: z.ZodBoolean;
|
|
8741
|
+
details: z.ZodRecord<z.ZodString, z.ZodJSONSchema>;
|
|
8742
|
+
}, z.core.$loose>;
|
|
8743
|
+
}, z.core.$strip>>;
|
|
8744
|
+
readonly resources: {
|
|
8745
|
+
readonly reads: readonly [{
|
|
8746
|
+
readonly type: "partner.team";
|
|
8747
|
+
readonly idFrom: "params.teamId";
|
|
8748
|
+
}];
|
|
8749
|
+
readonly changes: readonly [{
|
|
8750
|
+
readonly type: "partner.team";
|
|
8751
|
+
readonly idFrom: "params.teamId";
|
|
8752
|
+
}];
|
|
8753
|
+
};
|
|
8754
|
+
readonly lifecycle: {
|
|
8755
|
+
readonly introduced: "1.3.0";
|
|
8756
|
+
};
|
|
8757
|
+
readonly docs: {
|
|
8758
|
+
readonly summary: "Rename a team";
|
|
8759
|
+
readonly description: "Renames a team owned by the authenticated partner tenant.";
|
|
8760
|
+
readonly tags: readonly ["Teams"];
|
|
8761
|
+
readonly examples: {
|
|
8762
|
+
readonly request: {
|
|
8763
|
+
readonly params: {
|
|
8764
|
+
readonly teamId: "t_01";
|
|
8765
|
+
};
|
|
8766
|
+
readonly body: {
|
|
8767
|
+
readonly name: "New name";
|
|
8768
|
+
};
|
|
8769
|
+
};
|
|
8770
|
+
readonly response: {
|
|
8771
|
+
readonly data: {
|
|
8772
|
+
readonly ok: true;
|
|
8773
|
+
readonly name: "New name";
|
|
8774
|
+
};
|
|
8775
|
+
readonly meta: {
|
|
8776
|
+
readonly requestId: "req_01";
|
|
8777
|
+
readonly surface: "partner";
|
|
8778
|
+
readonly version: "1.0";
|
|
8779
|
+
};
|
|
8780
|
+
};
|
|
8781
|
+
};
|
|
8782
|
+
};
|
|
8783
|
+
};
|
|
8784
|
+
readonly deleteTeam: {
|
|
8785
|
+
readonly id: "partner.teams.delete";
|
|
8786
|
+
readonly method: "DELETE";
|
|
8787
|
+
readonly path: "/teams/{teamId}";
|
|
8788
|
+
readonly visibility: "public";
|
|
8789
|
+
readonly semantics: {
|
|
8790
|
+
readonly kind: "mutation";
|
|
8791
|
+
readonly sideEffects: "state";
|
|
8792
|
+
readonly idempotent: true;
|
|
8793
|
+
readonly retry: "idempotent";
|
|
8794
|
+
readonly readConsistency: null;
|
|
8795
|
+
};
|
|
8796
|
+
readonly auth: {
|
|
8797
|
+
readonly credentials: readonly ["partner_key"];
|
|
8798
|
+
readonly scopes: readonly ["teams:write"];
|
|
8799
|
+
readonly ownership: readonly [{
|
|
8800
|
+
readonly credential: "partner_key";
|
|
8801
|
+
readonly rule: "partner_tenant";
|
|
8802
|
+
}];
|
|
8803
|
+
};
|
|
8804
|
+
readonly request: {
|
|
8805
|
+
readonly params: z.ZodObject<{
|
|
8806
|
+
teamId: z.ZodString;
|
|
8807
|
+
}, z.core.$strict>;
|
|
8808
|
+
readonly query: null;
|
|
8809
|
+
readonly headers: z.ZodObject<{
|
|
8810
|
+
'x-request-id': z.ZodOptional<z.ZodString>;
|
|
8811
|
+
}, z.core.$strict>;
|
|
8812
|
+
readonly body: null;
|
|
8813
|
+
};
|
|
8814
|
+
readonly responses: {
|
|
8815
|
+
readonly 200: CompatibleResponseSchema<z.ZodObject<{
|
|
8816
|
+
data: z.ZodObject<{
|
|
8817
|
+
ok: z.ZodLiteral<true>;
|
|
8818
|
+
}, z.core.$strip>;
|
|
8819
|
+
meta: z.ZodObject<{
|
|
8820
|
+
readonly requestId: z.ZodString;
|
|
8821
|
+
readonly surface: z.ZodLiteral<"partner">;
|
|
8822
|
+
readonly version: z.ZodLiteral<"1.0">;
|
|
8823
|
+
}, z.core.$strip>;
|
|
8824
|
+
}, z.core.$strip>, z.ZodObject<{
|
|
8825
|
+
data: z.ZodObject<{
|
|
8826
|
+
ok: z.ZodLiteral<true>;
|
|
8827
|
+
}, z.core.$strip>;
|
|
8828
|
+
meta: z.ZodObject<{
|
|
8829
|
+
readonly requestId: z.ZodString;
|
|
8830
|
+
readonly surface: z.ZodLiteral<"partner">;
|
|
8831
|
+
readonly version: z.ZodLiteral<"1.0">;
|
|
8832
|
+
}, z.core.$strip>;
|
|
8833
|
+
}, z.core.$strip>>;
|
|
8834
|
+
};
|
|
8835
|
+
readonly errors: readonly ["invalid_request", "unauthorized", "forbidden", "user_not_found", "rate_limited", "internal_error", "contract_violation"];
|
|
8836
|
+
readonly errorResponse: CompatibleResponseSchema<z.ZodObject<{
|
|
8837
|
+
readonly error: z.ZodObject<{
|
|
8838
|
+
code: z.ZodEnum<{
|
|
8839
|
+
rate_limited: "rate_limited";
|
|
8840
|
+
internal_error: "internal_error";
|
|
8841
|
+
invalid_request: "invalid_request";
|
|
8842
|
+
unauthorized: "unauthorized";
|
|
8843
|
+
forbidden: "forbidden";
|
|
8844
|
+
user_not_found: "user_not_found";
|
|
8845
|
+
contract_violation: "contract_violation";
|
|
8846
|
+
}>;
|
|
8847
|
+
message: z.ZodString;
|
|
8848
|
+
requestId: z.ZodString;
|
|
8849
|
+
retryable: z.ZodBoolean;
|
|
8850
|
+
details: z.ZodRecord<z.ZodString, z.ZodJSONSchema>;
|
|
8851
|
+
}, z.core.$strict>;
|
|
8852
|
+
}, z.core.$strip>, z.ZodObject<{
|
|
8853
|
+
readonly error: z.ZodObject<{
|
|
8854
|
+
code: z.ZodEnum<{
|
|
8855
|
+
rate_limited: "rate_limited";
|
|
8856
|
+
internal_error: "internal_error";
|
|
8857
|
+
invalid_request: "invalid_request";
|
|
8858
|
+
unauthorized: "unauthorized";
|
|
8859
|
+
forbidden: "forbidden";
|
|
8860
|
+
user_not_found: "user_not_found";
|
|
8861
|
+
contract_violation: "contract_violation";
|
|
8862
|
+
}>;
|
|
8863
|
+
message: z.ZodString;
|
|
8864
|
+
requestId: z.ZodString;
|
|
8865
|
+
retryable: z.ZodBoolean;
|
|
8866
|
+
details: z.ZodRecord<z.ZodString, z.ZodJSONSchema>;
|
|
8867
|
+
}, z.core.$loose>;
|
|
8868
|
+
}, z.core.$strip>>;
|
|
8869
|
+
readonly resources: {
|
|
8870
|
+
readonly reads: readonly [{
|
|
8871
|
+
readonly type: "partner.team";
|
|
8872
|
+
readonly idFrom: "params.teamId";
|
|
8873
|
+
}];
|
|
8874
|
+
readonly changes: readonly [{
|
|
8875
|
+
readonly type: "partner.team";
|
|
8876
|
+
readonly idFrom: "params.teamId";
|
|
8877
|
+
}];
|
|
8878
|
+
};
|
|
8879
|
+
readonly lifecycle: {
|
|
8880
|
+
readonly introduced: "1.3.0";
|
|
8881
|
+
};
|
|
8882
|
+
readonly docs: {
|
|
8883
|
+
readonly summary: "Delete a team";
|
|
8884
|
+
readonly description: "Deletes a team owned by the authenticated partner tenant.";
|
|
8885
|
+
readonly tags: readonly ["Teams"];
|
|
8886
|
+
readonly examples: {
|
|
8887
|
+
readonly request: {
|
|
8888
|
+
readonly params: {
|
|
8889
|
+
readonly teamId: "t_01";
|
|
8890
|
+
};
|
|
8891
|
+
};
|
|
8892
|
+
readonly response: {
|
|
8893
|
+
readonly data: {
|
|
8894
|
+
readonly ok: true;
|
|
8895
|
+
};
|
|
8896
|
+
readonly meta: {
|
|
8897
|
+
readonly requestId: "req_01";
|
|
8898
|
+
readonly surface: "partner";
|
|
8899
|
+
readonly version: "1.0";
|
|
8900
|
+
};
|
|
8901
|
+
};
|
|
8902
|
+
};
|
|
8903
|
+
};
|
|
8904
|
+
};
|
|
8905
|
+
readonly listTeamMembers: {
|
|
8906
|
+
readonly id: "partner.teams.members.list";
|
|
8907
|
+
readonly method: "GET";
|
|
8908
|
+
readonly path: "/teams/{teamId}/members";
|
|
8909
|
+
readonly visibility: "public";
|
|
8910
|
+
readonly semantics: {
|
|
8911
|
+
readonly kind: "query";
|
|
8912
|
+
readonly sideEffects: "none";
|
|
8913
|
+
readonly idempotent: true;
|
|
8914
|
+
readonly retry: "idempotent";
|
|
8915
|
+
readonly readConsistency: "primary";
|
|
8916
|
+
};
|
|
8917
|
+
readonly auth: {
|
|
8918
|
+
readonly credentials: readonly ["partner_key"];
|
|
8919
|
+
readonly scopes: readonly ["teams:read"];
|
|
8920
|
+
readonly ownership: readonly [{
|
|
8921
|
+
readonly credential: "partner_key";
|
|
8922
|
+
readonly rule: "partner_tenant";
|
|
8923
|
+
}];
|
|
8924
|
+
};
|
|
8925
|
+
readonly request: {
|
|
8926
|
+
readonly params: z.ZodObject<{
|
|
8927
|
+
teamId: z.ZodString;
|
|
8928
|
+
}, z.core.$strict>;
|
|
8929
|
+
readonly query: null;
|
|
8930
|
+
readonly headers: z.ZodObject<{
|
|
8931
|
+
'x-request-id': z.ZodOptional<z.ZodString>;
|
|
8932
|
+
}, z.core.$strict>;
|
|
8933
|
+
readonly body: null;
|
|
8934
|
+
};
|
|
8935
|
+
readonly responses: {
|
|
8936
|
+
readonly 200: CompatibleResponseSchema<z.ZodObject<{
|
|
8937
|
+
data: z.ZodObject<{
|
|
8938
|
+
members: z.ZodArray<z.ZodObject<{
|
|
8939
|
+
userId: z.ZodNumber;
|
|
8940
|
+
publicId: z.ZodString;
|
|
8941
|
+
name: z.ZodNullable<z.ZodString>;
|
|
8942
|
+
email: z.ZodEmail;
|
|
8943
|
+
picture: z.ZodNullable<z.ZodString>;
|
|
8944
|
+
role: z.ZodEnum<{
|
|
8945
|
+
admin: "admin";
|
|
8946
|
+
editor: "editor";
|
|
8947
|
+
viewer: "viewer";
|
|
8948
|
+
}>;
|
|
8949
|
+
joinedAt: z.ZodNumber;
|
|
8950
|
+
}, z.core.$loose>>;
|
|
8951
|
+
}, z.core.$strip>;
|
|
8952
|
+
meta: z.ZodObject<{
|
|
8953
|
+
readonly requestId: z.ZodString;
|
|
8954
|
+
readonly surface: z.ZodLiteral<"partner">;
|
|
8955
|
+
readonly version: z.ZodLiteral<"1.0">;
|
|
8956
|
+
}, z.core.$strip>;
|
|
8957
|
+
}, z.core.$strip>, z.ZodObject<{
|
|
8958
|
+
data: z.ZodObject<{
|
|
8959
|
+
members: z.ZodArray<z.ZodObject<{
|
|
8960
|
+
userId: z.ZodNumber;
|
|
8961
|
+
publicId: z.ZodString;
|
|
8962
|
+
name: z.ZodNullable<z.ZodString>;
|
|
8963
|
+
email: z.ZodEmail;
|
|
8964
|
+
picture: z.ZodNullable<z.ZodString>;
|
|
8965
|
+
role: z.ZodEnum<{
|
|
8966
|
+
admin: "admin";
|
|
8967
|
+
editor: "editor";
|
|
8968
|
+
viewer: "viewer";
|
|
8969
|
+
}>;
|
|
8970
|
+
joinedAt: z.ZodNumber;
|
|
8971
|
+
}, z.core.$loose>>;
|
|
8972
|
+
}, z.core.$strip>;
|
|
8973
|
+
meta: z.ZodObject<{
|
|
8974
|
+
readonly requestId: z.ZodString;
|
|
8975
|
+
readonly surface: z.ZodLiteral<"partner">;
|
|
8976
|
+
readonly version: z.ZodLiteral<"1.0">;
|
|
8977
|
+
}, z.core.$strip>;
|
|
8978
|
+
}, z.core.$strip>>;
|
|
8979
|
+
};
|
|
8980
|
+
readonly errors: readonly ["invalid_request", "unauthorized", "forbidden", "user_not_found", "rate_limited", "internal_error", "contract_violation"];
|
|
8981
|
+
readonly errorResponse: CompatibleResponseSchema<z.ZodObject<{
|
|
8982
|
+
readonly error: z.ZodObject<{
|
|
8983
|
+
code: z.ZodEnum<{
|
|
8984
|
+
rate_limited: "rate_limited";
|
|
8985
|
+
internal_error: "internal_error";
|
|
8986
|
+
invalid_request: "invalid_request";
|
|
8987
|
+
unauthorized: "unauthorized";
|
|
8988
|
+
forbidden: "forbidden";
|
|
8989
|
+
user_not_found: "user_not_found";
|
|
8990
|
+
contract_violation: "contract_violation";
|
|
8991
|
+
}>;
|
|
8992
|
+
message: z.ZodString;
|
|
8993
|
+
requestId: z.ZodString;
|
|
8994
|
+
retryable: z.ZodBoolean;
|
|
8995
|
+
details: z.ZodRecord<z.ZodString, z.ZodJSONSchema>;
|
|
8996
|
+
}, z.core.$strict>;
|
|
8997
|
+
}, z.core.$strip>, z.ZodObject<{
|
|
8998
|
+
readonly error: z.ZodObject<{
|
|
8999
|
+
code: z.ZodEnum<{
|
|
9000
|
+
rate_limited: "rate_limited";
|
|
9001
|
+
internal_error: "internal_error";
|
|
9002
|
+
invalid_request: "invalid_request";
|
|
9003
|
+
unauthorized: "unauthorized";
|
|
9004
|
+
forbidden: "forbidden";
|
|
9005
|
+
user_not_found: "user_not_found";
|
|
9006
|
+
contract_violation: "contract_violation";
|
|
9007
|
+
}>;
|
|
9008
|
+
message: z.ZodString;
|
|
9009
|
+
requestId: z.ZodString;
|
|
9010
|
+
retryable: z.ZodBoolean;
|
|
9011
|
+
details: z.ZodRecord<z.ZodString, z.ZodJSONSchema>;
|
|
9012
|
+
}, z.core.$loose>;
|
|
9013
|
+
}, z.core.$strip>>;
|
|
9014
|
+
readonly resources: {
|
|
9015
|
+
readonly reads: readonly [{
|
|
9016
|
+
readonly type: "partner.team";
|
|
9017
|
+
readonly idFrom: "params.teamId";
|
|
9018
|
+
}];
|
|
9019
|
+
readonly changes: readonly [];
|
|
9020
|
+
};
|
|
9021
|
+
readonly lifecycle: {
|
|
9022
|
+
readonly introduced: "1.3.0";
|
|
9023
|
+
};
|
|
9024
|
+
readonly docs: {
|
|
9025
|
+
readonly summary: "List team members";
|
|
9026
|
+
readonly description: "Lists the members of a team owned by the authenticated partner tenant.";
|
|
9027
|
+
readonly tags: readonly ["Teams"];
|
|
9028
|
+
readonly examples: {
|
|
9029
|
+
readonly request: {
|
|
9030
|
+
readonly params: {
|
|
9031
|
+
readonly teamId: "t_01";
|
|
9032
|
+
};
|
|
9033
|
+
};
|
|
9034
|
+
readonly response: {
|
|
9035
|
+
readonly data: {
|
|
9036
|
+
readonly members: readonly [];
|
|
9037
|
+
};
|
|
9038
|
+
readonly meta: {
|
|
9039
|
+
readonly requestId: "req_01";
|
|
9040
|
+
readonly surface: "partner";
|
|
9041
|
+
readonly version: "1.0";
|
|
9042
|
+
};
|
|
9043
|
+
};
|
|
9044
|
+
};
|
|
9045
|
+
};
|
|
9046
|
+
};
|
|
9047
|
+
readonly addTeamMember: {
|
|
9048
|
+
readonly id: "partner.teams.members.add";
|
|
9049
|
+
readonly method: "POST";
|
|
9050
|
+
readonly path: "/teams/{teamId}/members";
|
|
9051
|
+
readonly visibility: "public";
|
|
9052
|
+
readonly semantics: {
|
|
9053
|
+
readonly kind: "mutation";
|
|
9054
|
+
readonly sideEffects: "state";
|
|
9055
|
+
readonly idempotent: true;
|
|
9056
|
+
readonly retry: "idempotent";
|
|
9057
|
+
readonly readConsistency: null;
|
|
9058
|
+
};
|
|
9059
|
+
readonly auth: {
|
|
9060
|
+
readonly credentials: readonly ["partner_key"];
|
|
9061
|
+
readonly scopes: readonly ["teams:write"];
|
|
9062
|
+
readonly ownership: readonly [{
|
|
9063
|
+
readonly credential: "partner_key";
|
|
9064
|
+
readonly rule: "partner_tenant";
|
|
9065
|
+
}];
|
|
9066
|
+
};
|
|
9067
|
+
readonly request: {
|
|
9068
|
+
readonly params: z.ZodObject<{
|
|
9069
|
+
teamId: z.ZodString;
|
|
9070
|
+
}, z.core.$strict>;
|
|
9071
|
+
readonly query: null;
|
|
9072
|
+
readonly headers: z.ZodObject<{
|
|
9073
|
+
'x-request-id': z.ZodOptional<z.ZodString>;
|
|
9074
|
+
}, z.core.$strict>;
|
|
9075
|
+
readonly body: z.ZodObject<{
|
|
9076
|
+
userId: z.ZodString;
|
|
9077
|
+
role: z.ZodEnum<{
|
|
9078
|
+
admin: "admin";
|
|
9079
|
+
editor: "editor";
|
|
9080
|
+
viewer: "viewer";
|
|
9081
|
+
}>;
|
|
9082
|
+
}, z.core.$strict>;
|
|
9083
|
+
};
|
|
9084
|
+
readonly responses: {
|
|
9085
|
+
readonly 200: CompatibleResponseSchema<z.ZodObject<{
|
|
9086
|
+
data: z.ZodObject<{
|
|
9087
|
+
ok: z.ZodLiteral<true>;
|
|
9088
|
+
role: z.ZodEnum<{
|
|
9089
|
+
admin: "admin";
|
|
9090
|
+
editor: "editor";
|
|
9091
|
+
viewer: "viewer";
|
|
9092
|
+
}>;
|
|
9093
|
+
alreadyExisted: z.ZodOptional<z.ZodBoolean>;
|
|
9094
|
+
}, z.core.$strip>;
|
|
9095
|
+
meta: z.ZodObject<{
|
|
9096
|
+
readonly requestId: z.ZodString;
|
|
9097
|
+
readonly surface: z.ZodLiteral<"partner">;
|
|
9098
|
+
readonly version: z.ZodLiteral<"1.0">;
|
|
9099
|
+
}, z.core.$strip>;
|
|
9100
|
+
}, z.core.$strip>, z.ZodObject<{
|
|
9101
|
+
data: z.ZodObject<{
|
|
9102
|
+
ok: z.ZodLiteral<true>;
|
|
9103
|
+
role: z.ZodEnum<{
|
|
9104
|
+
admin: "admin";
|
|
9105
|
+
editor: "editor";
|
|
9106
|
+
viewer: "viewer";
|
|
9107
|
+
}>;
|
|
9108
|
+
alreadyExisted: z.ZodOptional<z.ZodBoolean>;
|
|
9109
|
+
}, z.core.$strip>;
|
|
9110
|
+
meta: z.ZodObject<{
|
|
9111
|
+
readonly requestId: z.ZodString;
|
|
9112
|
+
readonly surface: z.ZodLiteral<"partner">;
|
|
9113
|
+
readonly version: z.ZodLiteral<"1.0">;
|
|
9114
|
+
}, z.core.$strip>;
|
|
9115
|
+
}, z.core.$strip>>;
|
|
9116
|
+
};
|
|
9117
|
+
readonly errors: readonly ["invalid_request", "unauthorized", "forbidden", "user_not_found", "rate_limited", "internal_error", "contract_violation"];
|
|
9118
|
+
readonly errorResponse: CompatibleResponseSchema<z.ZodObject<{
|
|
9119
|
+
readonly error: z.ZodObject<{
|
|
9120
|
+
code: z.ZodEnum<{
|
|
9121
|
+
rate_limited: "rate_limited";
|
|
9122
|
+
internal_error: "internal_error";
|
|
9123
|
+
invalid_request: "invalid_request";
|
|
9124
|
+
unauthorized: "unauthorized";
|
|
9125
|
+
forbidden: "forbidden";
|
|
9126
|
+
user_not_found: "user_not_found";
|
|
9127
|
+
contract_violation: "contract_violation";
|
|
9128
|
+
}>;
|
|
9129
|
+
message: z.ZodString;
|
|
9130
|
+
requestId: z.ZodString;
|
|
9131
|
+
retryable: z.ZodBoolean;
|
|
9132
|
+
details: z.ZodRecord<z.ZodString, z.ZodJSONSchema>;
|
|
9133
|
+
}, z.core.$strict>;
|
|
9134
|
+
}, z.core.$strip>, z.ZodObject<{
|
|
9135
|
+
readonly error: z.ZodObject<{
|
|
9136
|
+
code: z.ZodEnum<{
|
|
9137
|
+
rate_limited: "rate_limited";
|
|
9138
|
+
internal_error: "internal_error";
|
|
9139
|
+
invalid_request: "invalid_request";
|
|
9140
|
+
unauthorized: "unauthorized";
|
|
9141
|
+
forbidden: "forbidden";
|
|
9142
|
+
user_not_found: "user_not_found";
|
|
9143
|
+
contract_violation: "contract_violation";
|
|
9144
|
+
}>;
|
|
9145
|
+
message: z.ZodString;
|
|
9146
|
+
requestId: z.ZodString;
|
|
9147
|
+
retryable: z.ZodBoolean;
|
|
9148
|
+
details: z.ZodRecord<z.ZodString, z.ZodJSONSchema>;
|
|
9149
|
+
}, z.core.$loose>;
|
|
9150
|
+
}, z.core.$strip>>;
|
|
9151
|
+
readonly resources: {
|
|
9152
|
+
readonly reads: readonly [{
|
|
9153
|
+
readonly type: "partner.team";
|
|
9154
|
+
readonly idFrom: "params.teamId";
|
|
9155
|
+
}];
|
|
9156
|
+
readonly changes: readonly [{
|
|
9157
|
+
readonly type: "partner.team";
|
|
9158
|
+
readonly idFrom: "params.teamId";
|
|
9159
|
+
}];
|
|
9160
|
+
};
|
|
9161
|
+
readonly lifecycle: {
|
|
9162
|
+
readonly introduced: "1.3.0";
|
|
9163
|
+
};
|
|
9164
|
+
readonly docs: {
|
|
9165
|
+
readonly summary: "Add a team member";
|
|
9166
|
+
readonly description: "Adds a user to a team owned by the authenticated partner tenant, or reports it was already a member.";
|
|
9167
|
+
readonly tags: readonly ["Teams"];
|
|
9168
|
+
readonly examples: {
|
|
9169
|
+
readonly request: {
|
|
9170
|
+
readonly params: {
|
|
9171
|
+
readonly teamId: "t_01";
|
|
9172
|
+
};
|
|
9173
|
+
readonly body: {
|
|
9174
|
+
readonly userId: "u_02";
|
|
9175
|
+
readonly role: "editor";
|
|
9176
|
+
};
|
|
9177
|
+
};
|
|
9178
|
+
readonly response: {
|
|
9179
|
+
readonly data: {
|
|
9180
|
+
readonly ok: true;
|
|
9181
|
+
readonly role: "editor";
|
|
9182
|
+
};
|
|
9183
|
+
readonly meta: {
|
|
9184
|
+
readonly requestId: "req_01";
|
|
9185
|
+
readonly surface: "partner";
|
|
9186
|
+
readonly version: "1.0";
|
|
9187
|
+
};
|
|
9188
|
+
};
|
|
9189
|
+
};
|
|
9190
|
+
};
|
|
9191
|
+
};
|
|
9192
|
+
readonly updateTeamMemberRole: {
|
|
9193
|
+
readonly id: "partner.teams.members.role.update";
|
|
9194
|
+
readonly method: "PATCH";
|
|
9195
|
+
readonly path: "/teams/{teamId}/members/{userId}";
|
|
9196
|
+
readonly visibility: "public";
|
|
9197
|
+
readonly semantics: {
|
|
9198
|
+
readonly kind: "mutation";
|
|
9199
|
+
readonly sideEffects: "state";
|
|
9200
|
+
readonly idempotent: true;
|
|
9201
|
+
readonly retry: "idempotent";
|
|
9202
|
+
readonly readConsistency: null;
|
|
9203
|
+
};
|
|
9204
|
+
readonly auth: {
|
|
9205
|
+
readonly credentials: readonly ["partner_key"];
|
|
9206
|
+
readonly scopes: readonly ["teams:write"];
|
|
9207
|
+
readonly ownership: readonly [{
|
|
9208
|
+
readonly credential: "partner_key";
|
|
9209
|
+
readonly rule: "partner_tenant";
|
|
9210
|
+
}];
|
|
9211
|
+
};
|
|
9212
|
+
readonly request: {
|
|
9213
|
+
readonly params: z.ZodObject<{
|
|
9214
|
+
teamId: z.ZodString;
|
|
9215
|
+
userId: z.ZodString;
|
|
9216
|
+
}, z.core.$strict>;
|
|
9217
|
+
readonly query: null;
|
|
9218
|
+
readonly headers: z.ZodObject<{
|
|
9219
|
+
'x-request-id': z.ZodOptional<z.ZodString>;
|
|
9220
|
+
}, z.core.$strict>;
|
|
9221
|
+
readonly body: z.ZodObject<{
|
|
9222
|
+
role: z.ZodEnum<{
|
|
9223
|
+
admin: "admin";
|
|
9224
|
+
editor: "editor";
|
|
9225
|
+
viewer: "viewer";
|
|
9226
|
+
}>;
|
|
9227
|
+
}, z.core.$strict>;
|
|
9228
|
+
};
|
|
9229
|
+
readonly responses: {
|
|
9230
|
+
readonly 200: CompatibleResponseSchema<z.ZodObject<{
|
|
9231
|
+
data: z.ZodObject<{
|
|
9232
|
+
ok: z.ZodLiteral<true>;
|
|
9233
|
+
role: z.ZodEnum<{
|
|
9234
|
+
admin: "admin";
|
|
9235
|
+
editor: "editor";
|
|
9236
|
+
viewer: "viewer";
|
|
9237
|
+
}>;
|
|
9238
|
+
}, z.core.$strip>;
|
|
9239
|
+
meta: z.ZodObject<{
|
|
9240
|
+
readonly requestId: z.ZodString;
|
|
9241
|
+
readonly surface: z.ZodLiteral<"partner">;
|
|
9242
|
+
readonly version: z.ZodLiteral<"1.0">;
|
|
9243
|
+
}, z.core.$strip>;
|
|
9244
|
+
}, z.core.$strip>, z.ZodObject<{
|
|
9245
|
+
data: z.ZodObject<{
|
|
9246
|
+
ok: z.ZodLiteral<true>;
|
|
9247
|
+
role: z.ZodEnum<{
|
|
9248
|
+
admin: "admin";
|
|
9249
|
+
editor: "editor";
|
|
9250
|
+
viewer: "viewer";
|
|
9251
|
+
}>;
|
|
9252
|
+
}, z.core.$strip>;
|
|
9253
|
+
meta: z.ZodObject<{
|
|
9254
|
+
readonly requestId: z.ZodString;
|
|
9255
|
+
readonly surface: z.ZodLiteral<"partner">;
|
|
9256
|
+
readonly version: z.ZodLiteral<"1.0">;
|
|
9257
|
+
}, z.core.$strip>;
|
|
9258
|
+
}, z.core.$strip>>;
|
|
9259
|
+
};
|
|
9260
|
+
readonly errors: readonly ["invalid_request", "unauthorized", "forbidden", "user_not_found", "rate_limited", "internal_error", "contract_violation"];
|
|
9261
|
+
readonly errorResponse: CompatibleResponseSchema<z.ZodObject<{
|
|
9262
|
+
readonly error: z.ZodObject<{
|
|
9263
|
+
code: z.ZodEnum<{
|
|
9264
|
+
rate_limited: "rate_limited";
|
|
9265
|
+
internal_error: "internal_error";
|
|
9266
|
+
invalid_request: "invalid_request";
|
|
9267
|
+
unauthorized: "unauthorized";
|
|
9268
|
+
forbidden: "forbidden";
|
|
9269
|
+
user_not_found: "user_not_found";
|
|
9270
|
+
contract_violation: "contract_violation";
|
|
9271
|
+
}>;
|
|
9272
|
+
message: z.ZodString;
|
|
9273
|
+
requestId: z.ZodString;
|
|
9274
|
+
retryable: z.ZodBoolean;
|
|
9275
|
+
details: z.ZodRecord<z.ZodString, z.ZodJSONSchema>;
|
|
9276
|
+
}, z.core.$strict>;
|
|
9277
|
+
}, z.core.$strip>, z.ZodObject<{
|
|
9278
|
+
readonly error: z.ZodObject<{
|
|
9279
|
+
code: z.ZodEnum<{
|
|
9280
|
+
rate_limited: "rate_limited";
|
|
9281
|
+
internal_error: "internal_error";
|
|
9282
|
+
invalid_request: "invalid_request";
|
|
9283
|
+
unauthorized: "unauthorized";
|
|
9284
|
+
forbidden: "forbidden";
|
|
9285
|
+
user_not_found: "user_not_found";
|
|
9286
|
+
contract_violation: "contract_violation";
|
|
9287
|
+
}>;
|
|
9288
|
+
message: z.ZodString;
|
|
9289
|
+
requestId: z.ZodString;
|
|
9290
|
+
retryable: z.ZodBoolean;
|
|
9291
|
+
details: z.ZodRecord<z.ZodString, z.ZodJSONSchema>;
|
|
9292
|
+
}, z.core.$loose>;
|
|
9293
|
+
}, z.core.$strip>>;
|
|
9294
|
+
readonly resources: {
|
|
9295
|
+
readonly reads: readonly [{
|
|
9296
|
+
readonly type: "partner.team";
|
|
9297
|
+
readonly idFrom: "params.teamId";
|
|
9298
|
+
}, {
|
|
9299
|
+
readonly type: "partner.user";
|
|
9300
|
+
readonly idFrom: "params.userId";
|
|
9301
|
+
}];
|
|
9302
|
+
readonly changes: readonly [{
|
|
9303
|
+
readonly type: "partner.team";
|
|
9304
|
+
readonly idFrom: "params.teamId";
|
|
9305
|
+
}, {
|
|
9306
|
+
readonly type: "partner.user";
|
|
9307
|
+
readonly idFrom: "params.userId";
|
|
9308
|
+
}];
|
|
9309
|
+
};
|
|
9310
|
+
readonly lifecycle: {
|
|
9311
|
+
readonly introduced: "1.3.0";
|
|
9312
|
+
};
|
|
9313
|
+
readonly docs: {
|
|
9314
|
+
readonly summary: "Update a team member role";
|
|
9315
|
+
readonly description: "Updates the role of an existing member of a team owned by the authenticated partner tenant.";
|
|
9316
|
+
readonly tags: readonly ["Teams"];
|
|
9317
|
+
readonly examples: {
|
|
9318
|
+
readonly request: {
|
|
9319
|
+
readonly params: {
|
|
9320
|
+
readonly teamId: "t_01";
|
|
9321
|
+
readonly userId: "u_02";
|
|
9322
|
+
};
|
|
9323
|
+
readonly body: {
|
|
9324
|
+
readonly role: "admin";
|
|
9325
|
+
};
|
|
9326
|
+
};
|
|
9327
|
+
readonly response: {
|
|
9328
|
+
readonly data: {
|
|
9329
|
+
readonly ok: true;
|
|
9330
|
+
readonly role: "admin";
|
|
9331
|
+
};
|
|
9332
|
+
readonly meta: {
|
|
9333
|
+
readonly requestId: "req_01";
|
|
9334
|
+
readonly surface: "partner";
|
|
9335
|
+
readonly version: "1.0";
|
|
9336
|
+
};
|
|
9337
|
+
};
|
|
9338
|
+
};
|
|
9339
|
+
};
|
|
9340
|
+
};
|
|
9341
|
+
readonly removeTeamMember: {
|
|
9342
|
+
readonly id: "partner.teams.members.remove";
|
|
9343
|
+
readonly method: "DELETE";
|
|
9344
|
+
readonly path: "/teams/{teamId}/members/{userId}";
|
|
9345
|
+
readonly visibility: "public";
|
|
9346
|
+
readonly semantics: {
|
|
9347
|
+
readonly kind: "mutation";
|
|
9348
|
+
readonly sideEffects: "state";
|
|
9349
|
+
readonly idempotent: true;
|
|
9350
|
+
readonly retry: "idempotent";
|
|
9351
|
+
readonly readConsistency: null;
|
|
9352
|
+
};
|
|
9353
|
+
readonly auth: {
|
|
9354
|
+
readonly credentials: readonly ["partner_key"];
|
|
9355
|
+
readonly scopes: readonly ["teams:write"];
|
|
9356
|
+
readonly ownership: readonly [{
|
|
9357
|
+
readonly credential: "partner_key";
|
|
9358
|
+
readonly rule: "partner_tenant";
|
|
9359
|
+
}];
|
|
9360
|
+
};
|
|
9361
|
+
readonly request: {
|
|
9362
|
+
readonly params: z.ZodObject<{
|
|
9363
|
+
teamId: z.ZodString;
|
|
9364
|
+
userId: z.ZodString;
|
|
9365
|
+
}, z.core.$strict>;
|
|
9366
|
+
readonly query: null;
|
|
9367
|
+
readonly headers: z.ZodObject<{
|
|
9368
|
+
'x-request-id': z.ZodOptional<z.ZodString>;
|
|
9369
|
+
}, z.core.$strict>;
|
|
9370
|
+
readonly body: null;
|
|
9371
|
+
};
|
|
9372
|
+
readonly responses: {
|
|
9373
|
+
readonly 200: CompatibleResponseSchema<z.ZodObject<{
|
|
9374
|
+
data: z.ZodObject<{
|
|
9375
|
+
ok: z.ZodLiteral<true>;
|
|
9376
|
+
}, z.core.$strip>;
|
|
9377
|
+
meta: z.ZodObject<{
|
|
9378
|
+
readonly requestId: z.ZodString;
|
|
9379
|
+
readonly surface: z.ZodLiteral<"partner">;
|
|
9380
|
+
readonly version: z.ZodLiteral<"1.0">;
|
|
9381
|
+
}, z.core.$strip>;
|
|
9382
|
+
}, z.core.$strip>, z.ZodObject<{
|
|
9383
|
+
data: z.ZodObject<{
|
|
9384
|
+
ok: z.ZodLiteral<true>;
|
|
9385
|
+
}, z.core.$strip>;
|
|
9386
|
+
meta: z.ZodObject<{
|
|
9387
|
+
readonly requestId: z.ZodString;
|
|
9388
|
+
readonly surface: z.ZodLiteral<"partner">;
|
|
9389
|
+
readonly version: z.ZodLiteral<"1.0">;
|
|
9390
|
+
}, z.core.$strip>;
|
|
9391
|
+
}, z.core.$strip>>;
|
|
9392
|
+
};
|
|
9393
|
+
readonly errors: readonly ["invalid_request", "unauthorized", "forbidden", "user_not_found", "rate_limited", "internal_error", "contract_violation"];
|
|
9394
|
+
readonly errorResponse: CompatibleResponseSchema<z.ZodObject<{
|
|
9395
|
+
readonly error: z.ZodObject<{
|
|
9396
|
+
code: z.ZodEnum<{
|
|
9397
|
+
rate_limited: "rate_limited";
|
|
9398
|
+
internal_error: "internal_error";
|
|
9399
|
+
invalid_request: "invalid_request";
|
|
9400
|
+
unauthorized: "unauthorized";
|
|
9401
|
+
forbidden: "forbidden";
|
|
9402
|
+
user_not_found: "user_not_found";
|
|
9403
|
+
contract_violation: "contract_violation";
|
|
9404
|
+
}>;
|
|
9405
|
+
message: z.ZodString;
|
|
9406
|
+
requestId: z.ZodString;
|
|
9407
|
+
retryable: z.ZodBoolean;
|
|
9408
|
+
details: z.ZodRecord<z.ZodString, z.ZodJSONSchema>;
|
|
9409
|
+
}, z.core.$strict>;
|
|
9410
|
+
}, z.core.$strip>, z.ZodObject<{
|
|
9411
|
+
readonly error: z.ZodObject<{
|
|
9412
|
+
code: z.ZodEnum<{
|
|
9413
|
+
rate_limited: "rate_limited";
|
|
9414
|
+
internal_error: "internal_error";
|
|
9415
|
+
invalid_request: "invalid_request";
|
|
9416
|
+
unauthorized: "unauthorized";
|
|
9417
|
+
forbidden: "forbidden";
|
|
9418
|
+
user_not_found: "user_not_found";
|
|
9419
|
+
contract_violation: "contract_violation";
|
|
9420
|
+
}>;
|
|
9421
|
+
message: z.ZodString;
|
|
9422
|
+
requestId: z.ZodString;
|
|
9423
|
+
retryable: z.ZodBoolean;
|
|
9424
|
+
details: z.ZodRecord<z.ZodString, z.ZodJSONSchema>;
|
|
9425
|
+
}, z.core.$loose>;
|
|
9426
|
+
}, z.core.$strip>>;
|
|
9427
|
+
readonly resources: {
|
|
9428
|
+
readonly reads: readonly [{
|
|
9429
|
+
readonly type: "partner.team";
|
|
9430
|
+
readonly idFrom: "params.teamId";
|
|
9431
|
+
}, {
|
|
9432
|
+
readonly type: "partner.user";
|
|
9433
|
+
readonly idFrom: "params.userId";
|
|
9434
|
+
}];
|
|
9435
|
+
readonly changes: readonly [{
|
|
9436
|
+
readonly type: "partner.team";
|
|
9437
|
+
readonly idFrom: "params.teamId";
|
|
9438
|
+
}, {
|
|
9439
|
+
readonly type: "partner.user";
|
|
9440
|
+
readonly idFrom: "params.userId";
|
|
9441
|
+
}];
|
|
9442
|
+
};
|
|
9443
|
+
readonly lifecycle: {
|
|
9444
|
+
readonly introduced: "1.3.0";
|
|
9445
|
+
};
|
|
9446
|
+
readonly docs: {
|
|
9447
|
+
readonly summary: "Remove a team member";
|
|
9448
|
+
readonly description: "Removes a member from a team owned by the authenticated partner tenant.";
|
|
9449
|
+
readonly tags: readonly ["Teams"];
|
|
9450
|
+
readonly examples: {
|
|
9451
|
+
readonly request: {
|
|
9452
|
+
readonly params: {
|
|
9453
|
+
readonly teamId: "t_01";
|
|
9454
|
+
readonly userId: "u_02";
|
|
9455
|
+
};
|
|
9456
|
+
};
|
|
9457
|
+
readonly response: {
|
|
9458
|
+
readonly data: {
|
|
9459
|
+
readonly ok: true;
|
|
9460
|
+
};
|
|
9461
|
+
readonly meta: {
|
|
9462
|
+
readonly requestId: "req_01";
|
|
9463
|
+
readonly surface: "partner";
|
|
9464
|
+
readonly version: "1.0";
|
|
9465
|
+
};
|
|
9466
|
+
};
|
|
9467
|
+
};
|
|
9468
|
+
};
|
|
9469
|
+
};
|
|
9470
|
+
readonly updateSiteTeam: {
|
|
9471
|
+
readonly id: "partner.sites.team.update";
|
|
9472
|
+
readonly method: "PATCH";
|
|
9473
|
+
readonly path: "/sites/{siteId}/team";
|
|
9474
|
+
readonly visibility: "public";
|
|
9475
|
+
readonly semantics: {
|
|
9476
|
+
readonly kind: "mutation";
|
|
9477
|
+
readonly sideEffects: "state";
|
|
9478
|
+
readonly idempotent: true;
|
|
9479
|
+
readonly retry: "idempotent";
|
|
9480
|
+
readonly readConsistency: null;
|
|
9481
|
+
};
|
|
9482
|
+
readonly auth: {
|
|
9483
|
+
readonly credentials: readonly ["partner_key"];
|
|
9484
|
+
readonly scopes: readonly ["sites:write"];
|
|
9485
|
+
readonly ownership: readonly [{
|
|
9486
|
+
readonly credential: "partner_key";
|
|
9487
|
+
readonly rule: "authorized_site";
|
|
9488
|
+
}];
|
|
9489
|
+
};
|
|
9490
|
+
readonly request: {
|
|
9491
|
+
readonly params: z.ZodObject<{
|
|
9492
|
+
siteId: z.ZodString;
|
|
9493
|
+
}, z.core.$strict>;
|
|
9494
|
+
readonly query: null;
|
|
9495
|
+
readonly headers: z.ZodObject<{
|
|
9496
|
+
'x-request-id': z.ZodOptional<z.ZodString>;
|
|
9497
|
+
}, z.core.$strict>;
|
|
9498
|
+
readonly body: z.ZodObject<{
|
|
9499
|
+
teamId: z.ZodNullable<z.ZodString>;
|
|
9500
|
+
}, z.core.$strict>;
|
|
9501
|
+
};
|
|
9502
|
+
readonly responses: {
|
|
9503
|
+
readonly 200: CompatibleResponseSchema<z.ZodObject<{
|
|
9504
|
+
data: z.ZodObject<{
|
|
9505
|
+
ok: z.ZodLiteral<true>;
|
|
9506
|
+
teamId: z.ZodNullable<z.ZodString>;
|
|
9507
|
+
}, z.core.$strip>;
|
|
9508
|
+
meta: z.ZodObject<{
|
|
9509
|
+
readonly requestId: z.ZodString;
|
|
9510
|
+
readonly surface: z.ZodLiteral<"partner">;
|
|
9511
|
+
readonly version: z.ZodLiteral<"1.0">;
|
|
9512
|
+
}, z.core.$strip>;
|
|
9513
|
+
}, z.core.$strip>, z.ZodObject<{
|
|
9514
|
+
data: z.ZodObject<{
|
|
9515
|
+
ok: z.ZodLiteral<true>;
|
|
9516
|
+
teamId: z.ZodNullable<z.ZodString>;
|
|
9517
|
+
}, z.core.$strip>;
|
|
9518
|
+
meta: z.ZodObject<{
|
|
9519
|
+
readonly requestId: z.ZodString;
|
|
9520
|
+
readonly surface: z.ZodLiteral<"partner">;
|
|
9521
|
+
readonly version: z.ZodLiteral<"1.0">;
|
|
9522
|
+
}, z.core.$strip>;
|
|
9523
|
+
}, z.core.$strip>>;
|
|
9524
|
+
};
|
|
9525
|
+
readonly errors: readonly ["invalid_request", "unauthorized", "forbidden", "site_not_found", "rate_limited", "internal_error", "contract_violation"];
|
|
9526
|
+
readonly errorResponse: CompatibleResponseSchema<z.ZodObject<{
|
|
9527
|
+
readonly error: z.ZodObject<{
|
|
9528
|
+
code: z.ZodEnum<{
|
|
9529
|
+
rate_limited: "rate_limited";
|
|
9530
|
+
internal_error: "internal_error";
|
|
9531
|
+
invalid_request: "invalid_request";
|
|
9532
|
+
unauthorized: "unauthorized";
|
|
9533
|
+
forbidden: "forbidden";
|
|
9534
|
+
site_not_found: "site_not_found";
|
|
9535
|
+
contract_violation: "contract_violation";
|
|
9536
|
+
}>;
|
|
9537
|
+
message: z.ZodString;
|
|
9538
|
+
requestId: z.ZodString;
|
|
9539
|
+
retryable: z.ZodBoolean;
|
|
9540
|
+
details: z.ZodRecord<z.ZodString, z.ZodJSONSchema>;
|
|
9541
|
+
}, z.core.$strict>;
|
|
9542
|
+
}, z.core.$strip>, z.ZodObject<{
|
|
9543
|
+
readonly error: z.ZodObject<{
|
|
9544
|
+
code: z.ZodEnum<{
|
|
9545
|
+
rate_limited: "rate_limited";
|
|
9546
|
+
internal_error: "internal_error";
|
|
9547
|
+
invalid_request: "invalid_request";
|
|
9548
|
+
unauthorized: "unauthorized";
|
|
9549
|
+
forbidden: "forbidden";
|
|
9550
|
+
site_not_found: "site_not_found";
|
|
9551
|
+
contract_violation: "contract_violation";
|
|
9552
|
+
}>;
|
|
9553
|
+
message: z.ZodString;
|
|
9554
|
+
requestId: z.ZodString;
|
|
9555
|
+
retryable: z.ZodBoolean;
|
|
9556
|
+
details: z.ZodRecord<z.ZodString, z.ZodJSONSchema>;
|
|
9557
|
+
}, z.core.$loose>;
|
|
9558
|
+
}, z.core.$strip>>;
|
|
9559
|
+
readonly resources: {
|
|
9560
|
+
readonly reads: readonly [{
|
|
9561
|
+
readonly type: "site.registration";
|
|
9562
|
+
readonly idFrom: "params.siteId";
|
|
9563
|
+
}];
|
|
9564
|
+
readonly changes: readonly [{
|
|
9565
|
+
readonly type: "site.registration";
|
|
9566
|
+
readonly idFrom: "params.siteId";
|
|
9567
|
+
}];
|
|
9568
|
+
};
|
|
9569
|
+
readonly lifecycle: {
|
|
9570
|
+
readonly introduced: "1.3.0";
|
|
9571
|
+
};
|
|
9572
|
+
readonly docs: {
|
|
9573
|
+
readonly summary: "Bind a site to a team";
|
|
9574
|
+
readonly description: "Binds or unbinds (teamId: null) a partner-owned site to a partner-owned team.";
|
|
9575
|
+
readonly tags: readonly ["Teams"];
|
|
9576
|
+
readonly examples: {
|
|
9577
|
+
readonly request: {
|
|
9578
|
+
readonly params: {
|
|
9579
|
+
readonly siteId: "s_01";
|
|
9580
|
+
};
|
|
9581
|
+
readonly body: {
|
|
9582
|
+
readonly teamId: "t_01";
|
|
9583
|
+
};
|
|
9584
|
+
};
|
|
9585
|
+
readonly response: {
|
|
9586
|
+
readonly data: {
|
|
9587
|
+
readonly ok: true;
|
|
9588
|
+
readonly teamId: "t_01";
|
|
9589
|
+
};
|
|
9590
|
+
readonly meta: {
|
|
9591
|
+
readonly requestId: "req_01";
|
|
9592
|
+
readonly surface: "partner";
|
|
9593
|
+
readonly version: "1.0";
|
|
9594
|
+
};
|
|
9595
|
+
};
|
|
9596
|
+
};
|
|
9597
|
+
};
|
|
9598
|
+
};
|
|
9599
|
+
readonly getTeamCatalog: {
|
|
9600
|
+
readonly id: "partner.teams.catalog.get";
|
|
9601
|
+
readonly method: "GET";
|
|
9602
|
+
readonly path: "/teams/{teamId}/catalog";
|
|
9603
|
+
readonly visibility: "public";
|
|
9604
|
+
readonly semantics: {
|
|
9605
|
+
readonly kind: "query";
|
|
9606
|
+
readonly sideEffects: "none";
|
|
9607
|
+
readonly idempotent: true;
|
|
9608
|
+
readonly retry: "idempotent";
|
|
9609
|
+
readonly readConsistency: "primary";
|
|
9610
|
+
};
|
|
9611
|
+
readonly auth: {
|
|
9612
|
+
readonly credentials: readonly ["partner_key"];
|
|
9613
|
+
readonly scopes: readonly ["teams:read"];
|
|
9614
|
+
readonly ownership: readonly [{
|
|
9615
|
+
readonly credential: "partner_key";
|
|
9616
|
+
readonly rule: "partner_tenant";
|
|
9617
|
+
}];
|
|
9618
|
+
};
|
|
9619
|
+
readonly request: {
|
|
9620
|
+
readonly params: z.ZodObject<{
|
|
9621
|
+
teamId: z.ZodString;
|
|
9622
|
+
}, z.core.$strict>;
|
|
9623
|
+
readonly query: null;
|
|
9624
|
+
readonly headers: z.ZodObject<{
|
|
9625
|
+
'x-request-id': z.ZodOptional<z.ZodString>;
|
|
9626
|
+
}, z.core.$strict>;
|
|
9627
|
+
readonly body: null;
|
|
9628
|
+
};
|
|
9629
|
+
readonly responses: {
|
|
9630
|
+
readonly 200: CompatibleResponseSchema<z.ZodObject<{
|
|
9631
|
+
data: z.ZodObject<{
|
|
9632
|
+
teamId: z.ZodString;
|
|
9633
|
+
catalogUri: z.ZodNullable<z.ZodString>;
|
|
9634
|
+
warehouse: z.ZodNullable<z.ZodString>;
|
|
9635
|
+
bucket: z.ZodNullable<z.ZodString>;
|
|
9636
|
+
namespace: z.ZodNullable<z.ZodString>;
|
|
9637
|
+
provisioningState: z.ZodNullable<z.ZodString>;
|
|
9638
|
+
keyEncoding: z.ZodNullable<z.ZodString>;
|
|
9639
|
+
catalogTablesReady: z.ZodBoolean;
|
|
9640
|
+
readsEnabled: z.ZodBoolean;
|
|
9641
|
+
}, z.core.$strip>;
|
|
9642
|
+
meta: z.ZodObject<{
|
|
9643
|
+
readonly requestId: z.ZodString;
|
|
9644
|
+
readonly surface: z.ZodLiteral<"partner">;
|
|
9645
|
+
readonly version: z.ZodLiteral<"1.0">;
|
|
9646
|
+
}, z.core.$strip>;
|
|
9647
|
+
}, z.core.$strip>, z.ZodObject<{
|
|
9648
|
+
data: z.ZodObject<{
|
|
9649
|
+
teamId: z.ZodString;
|
|
9650
|
+
catalogUri: z.ZodNullable<z.ZodString>;
|
|
9651
|
+
warehouse: z.ZodNullable<z.ZodString>;
|
|
9652
|
+
bucket: z.ZodNullable<z.ZodString>;
|
|
9653
|
+
namespace: z.ZodNullable<z.ZodString>;
|
|
9654
|
+
provisioningState: z.ZodNullable<z.ZodString>;
|
|
9655
|
+
keyEncoding: z.ZodNullable<z.ZodString>;
|
|
9656
|
+
catalogTablesReady: z.ZodBoolean;
|
|
9657
|
+
readsEnabled: z.ZodBoolean;
|
|
9658
|
+
}, z.core.$strip>;
|
|
9659
|
+
meta: z.ZodObject<{
|
|
9660
|
+
readonly requestId: z.ZodString;
|
|
9661
|
+
readonly surface: z.ZodLiteral<"partner">;
|
|
9662
|
+
readonly version: z.ZodLiteral<"1.0">;
|
|
9663
|
+
}, z.core.$strip>;
|
|
9664
|
+
}, z.core.$strip>>;
|
|
9665
|
+
};
|
|
9666
|
+
readonly errors: readonly ["invalid_request", "unauthorized", "forbidden", "user_not_found", "rate_limited", "internal_error", "contract_violation"];
|
|
9667
|
+
readonly errorResponse: CompatibleResponseSchema<z.ZodObject<{
|
|
9668
|
+
readonly error: z.ZodObject<{
|
|
9669
|
+
code: z.ZodEnum<{
|
|
9670
|
+
rate_limited: "rate_limited";
|
|
9671
|
+
internal_error: "internal_error";
|
|
9672
|
+
invalid_request: "invalid_request";
|
|
9673
|
+
unauthorized: "unauthorized";
|
|
9674
|
+
forbidden: "forbidden";
|
|
9675
|
+
user_not_found: "user_not_found";
|
|
9676
|
+
contract_violation: "contract_violation";
|
|
9677
|
+
}>;
|
|
9678
|
+
message: z.ZodString;
|
|
9679
|
+
requestId: z.ZodString;
|
|
9680
|
+
retryable: z.ZodBoolean;
|
|
9681
|
+
details: z.ZodRecord<z.ZodString, z.ZodJSONSchema>;
|
|
9682
|
+
}, z.core.$strict>;
|
|
9683
|
+
}, z.core.$strip>, z.ZodObject<{
|
|
9684
|
+
readonly error: z.ZodObject<{
|
|
9685
|
+
code: z.ZodEnum<{
|
|
9686
|
+
rate_limited: "rate_limited";
|
|
9687
|
+
internal_error: "internal_error";
|
|
9688
|
+
invalid_request: "invalid_request";
|
|
9689
|
+
unauthorized: "unauthorized";
|
|
9690
|
+
forbidden: "forbidden";
|
|
9691
|
+
user_not_found: "user_not_found";
|
|
9692
|
+
contract_violation: "contract_violation";
|
|
9693
|
+
}>;
|
|
9694
|
+
message: z.ZodString;
|
|
9695
|
+
requestId: z.ZodString;
|
|
9696
|
+
retryable: z.ZodBoolean;
|
|
9697
|
+
details: z.ZodRecord<z.ZodString, z.ZodJSONSchema>;
|
|
9698
|
+
}, z.core.$loose>;
|
|
9699
|
+
}, z.core.$strip>>;
|
|
9700
|
+
readonly resources: {
|
|
9701
|
+
readonly reads: readonly [{
|
|
9702
|
+
readonly type: "partner.team";
|
|
9703
|
+
readonly idFrom: "params.teamId";
|
|
9704
|
+
}];
|
|
9705
|
+
readonly changes: readonly [];
|
|
9706
|
+
};
|
|
9707
|
+
readonly lifecycle: {
|
|
9708
|
+
readonly introduced: "1.3.0";
|
|
9709
|
+
};
|
|
9710
|
+
readonly docs: {
|
|
9711
|
+
readonly summary: "Get a team catalog";
|
|
9712
|
+
readonly description: "Returns the Iceberg catalog reference bound to a partner-owned team, if any.";
|
|
9713
|
+
readonly tags: readonly ["Teams"];
|
|
9714
|
+
readonly examples: {
|
|
9715
|
+
readonly request: {
|
|
9716
|
+
readonly params: {
|
|
9717
|
+
readonly teamId: "t_01";
|
|
9718
|
+
};
|
|
9719
|
+
};
|
|
9720
|
+
readonly response: {
|
|
9721
|
+
readonly data: {
|
|
9722
|
+
readonly teamId: "t_01";
|
|
9723
|
+
readonly catalogUri: null;
|
|
9724
|
+
readonly warehouse: null;
|
|
9725
|
+
readonly bucket: null;
|
|
9726
|
+
readonly namespace: null;
|
|
9727
|
+
readonly provisioningState: null;
|
|
9728
|
+
readonly keyEncoding: null;
|
|
9729
|
+
readonly catalogTablesReady: false;
|
|
9730
|
+
readonly readsEnabled: false;
|
|
9731
|
+
};
|
|
9732
|
+
readonly meta: {
|
|
9733
|
+
readonly requestId: "req_01";
|
|
9734
|
+
readonly surface: "partner";
|
|
9735
|
+
readonly version: "1.0";
|
|
9736
|
+
};
|
|
9737
|
+
};
|
|
9738
|
+
};
|
|
9739
|
+
};
|
|
9740
|
+
};
|
|
9741
|
+
readonly bindTeamCatalog: {
|
|
9742
|
+
readonly id: "partner.teams.catalog.bind";
|
|
9743
|
+
readonly method: "POST";
|
|
9744
|
+
readonly path: "/teams/{teamId}/catalog";
|
|
9745
|
+
readonly visibility: "public";
|
|
9746
|
+
readonly semantics: {
|
|
9747
|
+
readonly kind: "mutation";
|
|
9748
|
+
readonly sideEffects: "state";
|
|
9749
|
+
readonly idempotent: true;
|
|
9750
|
+
readonly retry: "idempotent";
|
|
9751
|
+
readonly readConsistency: null;
|
|
9752
|
+
};
|
|
9753
|
+
readonly auth: {
|
|
9754
|
+
readonly credentials: readonly ["partner_key"];
|
|
9755
|
+
readonly scopes: readonly ["teams:write"];
|
|
9756
|
+
readonly ownership: readonly [{
|
|
9757
|
+
readonly credential: "partner_key";
|
|
9758
|
+
readonly rule: "partner_tenant";
|
|
9759
|
+
}];
|
|
9760
|
+
};
|
|
9761
|
+
readonly request: {
|
|
9762
|
+
readonly params: z.ZodObject<{
|
|
9763
|
+
teamId: z.ZodString;
|
|
9764
|
+
}, z.core.$strict>;
|
|
9765
|
+
readonly query: null;
|
|
9766
|
+
readonly headers: z.ZodObject<{
|
|
9767
|
+
'x-request-id': z.ZodOptional<z.ZodString>;
|
|
9768
|
+
}, z.core.$strict>;
|
|
9769
|
+
readonly body: z.ZodObject<{
|
|
9770
|
+
catalogUri: z.ZodString;
|
|
9771
|
+
warehouse: z.ZodString;
|
|
9772
|
+
namespace: z.ZodOptional<z.ZodString>;
|
|
9773
|
+
bucket: z.ZodOptional<z.ZodString>;
|
|
9774
|
+
}, z.core.$strict>;
|
|
9775
|
+
};
|
|
9776
|
+
readonly responses: {
|
|
9777
|
+
readonly 200: CompatibleResponseSchema<z.ZodObject<{
|
|
9778
|
+
data: z.ZodObject<{
|
|
9779
|
+
teamId: z.ZodString;
|
|
9780
|
+
status: z.ZodLiteral<"ready">;
|
|
9781
|
+
catalogUri: z.ZodString;
|
|
9782
|
+
warehouse: z.ZodString;
|
|
9783
|
+
bucket: z.ZodString;
|
|
9784
|
+
namespace: z.ZodString;
|
|
9785
|
+
}, z.core.$strip>;
|
|
9786
|
+
meta: z.ZodObject<{
|
|
9787
|
+
readonly requestId: z.ZodString;
|
|
9788
|
+
readonly surface: z.ZodLiteral<"partner">;
|
|
9789
|
+
readonly version: z.ZodLiteral<"1.0">;
|
|
9790
|
+
}, z.core.$strip>;
|
|
9791
|
+
}, z.core.$strip>, z.ZodObject<{
|
|
9792
|
+
data: z.ZodObject<{
|
|
9793
|
+
teamId: z.ZodString;
|
|
9794
|
+
status: z.ZodLiteral<"ready">;
|
|
9795
|
+
catalogUri: z.ZodString;
|
|
9796
|
+
warehouse: z.ZodString;
|
|
9797
|
+
bucket: z.ZodString;
|
|
9798
|
+
namespace: z.ZodString;
|
|
9799
|
+
}, z.core.$strip>;
|
|
9800
|
+
meta: z.ZodObject<{
|
|
9801
|
+
readonly requestId: z.ZodString;
|
|
9802
|
+
readonly surface: z.ZodLiteral<"partner">;
|
|
9803
|
+
readonly version: z.ZodLiteral<"1.0">;
|
|
9804
|
+
}, z.core.$strip>;
|
|
9805
|
+
}, z.core.$strip>>;
|
|
9806
|
+
};
|
|
9807
|
+
readonly errors: readonly ["invalid_request", "unauthorized", "forbidden", "user_not_found", "rate_limited", "internal_error", "contract_violation"];
|
|
9808
|
+
readonly errorResponse: CompatibleResponseSchema<z.ZodObject<{
|
|
9809
|
+
readonly error: z.ZodObject<{
|
|
9810
|
+
code: z.ZodEnum<{
|
|
9811
|
+
rate_limited: "rate_limited";
|
|
9812
|
+
internal_error: "internal_error";
|
|
9813
|
+
invalid_request: "invalid_request";
|
|
9814
|
+
unauthorized: "unauthorized";
|
|
9815
|
+
forbidden: "forbidden";
|
|
9816
|
+
user_not_found: "user_not_found";
|
|
9817
|
+
contract_violation: "contract_violation";
|
|
9818
|
+
}>;
|
|
9819
|
+
message: z.ZodString;
|
|
9820
|
+
requestId: z.ZodString;
|
|
9821
|
+
retryable: z.ZodBoolean;
|
|
9822
|
+
details: z.ZodRecord<z.ZodString, z.ZodJSONSchema>;
|
|
9823
|
+
}, z.core.$strict>;
|
|
9824
|
+
}, z.core.$strip>, z.ZodObject<{
|
|
9825
|
+
readonly error: z.ZodObject<{
|
|
9826
|
+
code: z.ZodEnum<{
|
|
9827
|
+
rate_limited: "rate_limited";
|
|
9828
|
+
internal_error: "internal_error";
|
|
9829
|
+
invalid_request: "invalid_request";
|
|
9830
|
+
unauthorized: "unauthorized";
|
|
9831
|
+
forbidden: "forbidden";
|
|
9832
|
+
user_not_found: "user_not_found";
|
|
9833
|
+
contract_violation: "contract_violation";
|
|
9834
|
+
}>;
|
|
9835
|
+
message: z.ZodString;
|
|
9836
|
+
requestId: z.ZodString;
|
|
9837
|
+
retryable: z.ZodBoolean;
|
|
9838
|
+
details: z.ZodRecord<z.ZodString, z.ZodJSONSchema>;
|
|
9839
|
+
}, z.core.$loose>;
|
|
9840
|
+
}, z.core.$strip>>;
|
|
9841
|
+
readonly resources: {
|
|
9842
|
+
readonly reads: readonly [{
|
|
9843
|
+
readonly type: "partner.team";
|
|
9844
|
+
readonly idFrom: "params.teamId";
|
|
9845
|
+
}];
|
|
9846
|
+
readonly changes: readonly [{
|
|
9847
|
+
readonly type: "partner.team";
|
|
9848
|
+
readonly idFrom: "params.teamId";
|
|
9849
|
+
}];
|
|
9850
|
+
};
|
|
9851
|
+
readonly lifecycle: {
|
|
9852
|
+
readonly introduced: "1.3.0";
|
|
9853
|
+
};
|
|
9854
|
+
readonly docs: {
|
|
9855
|
+
readonly summary: "Bind a team catalog";
|
|
9856
|
+
readonly description: "Binds an Iceberg catalog (URI, warehouse, and optional bucket/namespace) to a partner-owned team.";
|
|
9857
|
+
readonly tags: readonly ["Teams"];
|
|
9858
|
+
readonly examples: {
|
|
9859
|
+
readonly request: {
|
|
9860
|
+
readonly params: {
|
|
9861
|
+
readonly teamId: "t_01";
|
|
9862
|
+
};
|
|
9863
|
+
readonly body: {
|
|
9864
|
+
readonly catalogUri: "gs://bucket/catalog";
|
|
9865
|
+
readonly warehouse: "primary";
|
|
9866
|
+
readonly namespace: "ns1";
|
|
9867
|
+
readonly bucket: "bucket1";
|
|
9868
|
+
};
|
|
9869
|
+
};
|
|
9870
|
+
readonly response: {
|
|
9871
|
+
readonly data: {
|
|
9872
|
+
readonly teamId: "t_01";
|
|
9873
|
+
readonly status: "ready";
|
|
9874
|
+
readonly catalogUri: "gs://bucket/catalog";
|
|
9875
|
+
readonly warehouse: "primary";
|
|
9876
|
+
readonly bucket: "bucket1";
|
|
9877
|
+
readonly namespace: "ns1";
|
|
9878
|
+
};
|
|
9879
|
+
readonly meta: {
|
|
9880
|
+
readonly requestId: "req_01";
|
|
9881
|
+
readonly surface: "partner";
|
|
9882
|
+
readonly version: "1.0";
|
|
9883
|
+
};
|
|
9884
|
+
};
|
|
9885
|
+
};
|
|
9886
|
+
};
|
|
9887
|
+
};
|
|
9888
|
+
readonly getSiteIntIdCrosswalk: {
|
|
9889
|
+
readonly id: "partner.users.sites.crosswalk.get";
|
|
9890
|
+
readonly method: "GET";
|
|
9891
|
+
readonly path: "/users/{userId}/sites/crosswalk";
|
|
9892
|
+
readonly visibility: "public";
|
|
9893
|
+
readonly semantics: {
|
|
9894
|
+
readonly kind: "query";
|
|
9895
|
+
readonly sideEffects: "none";
|
|
9896
|
+
readonly idempotent: true;
|
|
9897
|
+
readonly retry: "idempotent";
|
|
9898
|
+
readonly readConsistency: "primary";
|
|
9899
|
+
};
|
|
9900
|
+
readonly auth: {
|
|
9901
|
+
readonly credentials: readonly ["user_key", "partner_key"];
|
|
9902
|
+
readonly scopes: readonly ["sites:read"];
|
|
9903
|
+
readonly ownership: readonly [{
|
|
9904
|
+
readonly credential: "user_key";
|
|
9905
|
+
readonly rule: "self";
|
|
9906
|
+
}, {
|
|
9907
|
+
readonly credential: "partner_key";
|
|
9908
|
+
readonly rule: "linked_user";
|
|
9909
|
+
}];
|
|
9910
|
+
};
|
|
9911
|
+
readonly request: {
|
|
9912
|
+
readonly params: z.ZodObject<{
|
|
9913
|
+
userId: z.ZodString;
|
|
9914
|
+
}, z.core.$strict>;
|
|
9915
|
+
readonly query: null;
|
|
9916
|
+
readonly headers: z.ZodObject<{
|
|
9917
|
+
'x-request-id': z.ZodOptional<z.ZodString>;
|
|
9918
|
+
}, z.core.$strict>;
|
|
9919
|
+
readonly body: null;
|
|
9920
|
+
};
|
|
9921
|
+
readonly responses: {
|
|
9922
|
+
readonly 200: CompatibleResponseSchema<z.ZodObject<{
|
|
9923
|
+
data: z.ZodObject<{
|
|
9924
|
+
crosswalk: z.ZodRecord<z.ZodString, z.ZodNumber>;
|
|
9925
|
+
sites: z.ZodArray<z.ZodObject<{
|
|
9926
|
+
siteId: z.ZodString;
|
|
9927
|
+
intId: z.ZodNumber;
|
|
9928
|
+
siteUrl: z.ZodString;
|
|
9929
|
+
}, z.core.$loose>>;
|
|
9930
|
+
}, z.core.$strip>;
|
|
9931
|
+
meta: z.ZodObject<{
|
|
9932
|
+
readonly requestId: z.ZodString;
|
|
9933
|
+
readonly surface: z.ZodLiteral<"partner">;
|
|
9934
|
+
readonly version: z.ZodLiteral<"1.0">;
|
|
9935
|
+
}, z.core.$strip>;
|
|
9936
|
+
}, z.core.$strip>, z.ZodObject<{
|
|
9937
|
+
data: z.ZodObject<{
|
|
9938
|
+
crosswalk: z.ZodRecord<z.ZodString, z.ZodNumber>;
|
|
9939
|
+
sites: z.ZodArray<z.ZodObject<{
|
|
9940
|
+
siteId: z.ZodString;
|
|
9941
|
+
intId: z.ZodNumber;
|
|
9942
|
+
siteUrl: z.ZodString;
|
|
9943
|
+
}, z.core.$loose>>;
|
|
9944
|
+
}, z.core.$strip>;
|
|
9945
|
+
meta: z.ZodObject<{
|
|
9946
|
+
readonly requestId: z.ZodString;
|
|
9947
|
+
readonly surface: z.ZodLiteral<"partner">;
|
|
9948
|
+
readonly version: z.ZodLiteral<"1.0">;
|
|
9949
|
+
}, z.core.$strip>;
|
|
9950
|
+
}, z.core.$strip>>;
|
|
9951
|
+
};
|
|
9952
|
+
readonly errors: readonly ["invalid_request", "unauthorized", "forbidden", "user_not_found", "rate_limited", "internal_error", "contract_violation"];
|
|
9953
|
+
readonly errorResponse: CompatibleResponseSchema<z.ZodObject<{
|
|
9954
|
+
readonly error: z.ZodObject<{
|
|
9955
|
+
code: z.ZodEnum<{
|
|
9956
|
+
rate_limited: "rate_limited";
|
|
9957
|
+
internal_error: "internal_error";
|
|
9958
|
+
invalid_request: "invalid_request";
|
|
9959
|
+
unauthorized: "unauthorized";
|
|
9960
|
+
forbidden: "forbidden";
|
|
9961
|
+
user_not_found: "user_not_found";
|
|
9962
|
+
contract_violation: "contract_violation";
|
|
9963
|
+
}>;
|
|
9964
|
+
message: z.ZodString;
|
|
9965
|
+
requestId: z.ZodString;
|
|
9966
|
+
retryable: z.ZodBoolean;
|
|
9967
|
+
details: z.ZodRecord<z.ZodString, z.ZodJSONSchema>;
|
|
9968
|
+
}, z.core.$strict>;
|
|
9969
|
+
}, z.core.$strip>, z.ZodObject<{
|
|
9970
|
+
readonly error: z.ZodObject<{
|
|
9971
|
+
code: z.ZodEnum<{
|
|
9972
|
+
rate_limited: "rate_limited";
|
|
9973
|
+
internal_error: "internal_error";
|
|
9974
|
+
invalid_request: "invalid_request";
|
|
9975
|
+
unauthorized: "unauthorized";
|
|
9976
|
+
forbidden: "forbidden";
|
|
9977
|
+
user_not_found: "user_not_found";
|
|
9978
|
+
contract_violation: "contract_violation";
|
|
9979
|
+
}>;
|
|
9980
|
+
message: z.ZodString;
|
|
9981
|
+
requestId: z.ZodString;
|
|
9982
|
+
retryable: z.ZodBoolean;
|
|
9983
|
+
details: z.ZodRecord<z.ZodString, z.ZodJSONSchema>;
|
|
9984
|
+
}, z.core.$loose>;
|
|
9985
|
+
}, z.core.$strip>>;
|
|
9986
|
+
readonly resources: {
|
|
9987
|
+
readonly reads: readonly [{
|
|
9988
|
+
readonly type: "partner.user";
|
|
9989
|
+
readonly idFrom: "params.userId";
|
|
9990
|
+
}, {
|
|
9991
|
+
readonly type: "user.sites";
|
|
9992
|
+
readonly idFrom: "params.userId";
|
|
9993
|
+
}];
|
|
9994
|
+
readonly changes: readonly [];
|
|
9995
|
+
};
|
|
9996
|
+
readonly lifecycle: {
|
|
9997
|
+
readonly introduced: "1.3.0";
|
|
9998
|
+
};
|
|
9999
|
+
readonly docs: {
|
|
10000
|
+
readonly summary: "Get the site int-id crosswalk";
|
|
10001
|
+
readonly description: "Maps a user's public site IDs to their internal integer IDs, for partners that need the legacy numeric identifier.";
|
|
10002
|
+
readonly tags: readonly ["Sites"];
|
|
10003
|
+
readonly examples: {
|
|
10004
|
+
readonly request: {
|
|
10005
|
+
readonly params: {
|
|
10006
|
+
readonly userId: "u_01";
|
|
10007
|
+
};
|
|
10008
|
+
};
|
|
10009
|
+
readonly response: {
|
|
10010
|
+
readonly data: {
|
|
10011
|
+
readonly crosswalk: {};
|
|
10012
|
+
readonly sites: readonly [];
|
|
10013
|
+
};
|
|
10014
|
+
readonly meta: {
|
|
10015
|
+
readonly requestId: "req_01";
|
|
10016
|
+
readonly surface: "partner";
|
|
10017
|
+
readonly version: "1.0";
|
|
10018
|
+
};
|
|
10019
|
+
};
|
|
10020
|
+
};
|
|
10021
|
+
};
|
|
10022
|
+
};
|
|
10023
|
+
readonly deleteUser: {
|
|
10024
|
+
readonly id: "partner.users.delete";
|
|
10025
|
+
readonly method: "DELETE";
|
|
10026
|
+
readonly path: "/users/{userId}";
|
|
10027
|
+
readonly visibility: "public";
|
|
10028
|
+
readonly semantics: {
|
|
10029
|
+
readonly kind: "mutation";
|
|
10030
|
+
readonly sideEffects: "state";
|
|
10031
|
+
readonly idempotent: true;
|
|
10032
|
+
readonly retry: "idempotent";
|
|
10033
|
+
readonly readConsistency: null;
|
|
10034
|
+
};
|
|
10035
|
+
readonly auth: {
|
|
10036
|
+
readonly credentials: readonly ["partner_key"];
|
|
10037
|
+
readonly scopes: readonly ["users:write"];
|
|
10038
|
+
readonly ownership: readonly [{
|
|
10039
|
+
readonly credential: "partner_key";
|
|
10040
|
+
readonly rule: "linked_user";
|
|
10041
|
+
}];
|
|
10042
|
+
};
|
|
10043
|
+
readonly request: {
|
|
10044
|
+
readonly params: z.ZodObject<{
|
|
10045
|
+
userId: z.ZodString;
|
|
10046
|
+
}, z.core.$strict>;
|
|
10047
|
+
readonly query: null;
|
|
10048
|
+
readonly headers: z.ZodObject<{
|
|
10049
|
+
'x-request-id': z.ZodOptional<z.ZodString>;
|
|
10050
|
+
}, z.core.$strict>;
|
|
10051
|
+
readonly body: null;
|
|
10052
|
+
};
|
|
10053
|
+
readonly responses: {
|
|
10054
|
+
readonly 200: CompatibleResponseSchema<z.ZodObject<{
|
|
10055
|
+
data: z.ZodObject<{
|
|
10056
|
+
ok: z.ZodLiteral<true>;
|
|
10057
|
+
queued: z.ZodLiteral<true>;
|
|
10058
|
+
userId: z.ZodNumber;
|
|
10059
|
+
publicId: z.ZodString;
|
|
10060
|
+
}, z.core.$strip>;
|
|
10061
|
+
meta: z.ZodObject<{
|
|
10062
|
+
readonly requestId: z.ZodString;
|
|
10063
|
+
readonly surface: z.ZodLiteral<"partner">;
|
|
10064
|
+
readonly version: z.ZodLiteral<"1.0">;
|
|
10065
|
+
}, z.core.$strip>;
|
|
10066
|
+
}, z.core.$strip>, z.ZodObject<{
|
|
10067
|
+
data: z.ZodObject<{
|
|
10068
|
+
ok: z.ZodLiteral<true>;
|
|
10069
|
+
queued: z.ZodLiteral<true>;
|
|
10070
|
+
userId: z.ZodNumber;
|
|
10071
|
+
publicId: z.ZodString;
|
|
10072
|
+
}, z.core.$strip>;
|
|
10073
|
+
meta: z.ZodObject<{
|
|
10074
|
+
readonly requestId: z.ZodString;
|
|
10075
|
+
readonly surface: z.ZodLiteral<"partner">;
|
|
10076
|
+
readonly version: z.ZodLiteral<"1.0">;
|
|
10077
|
+
}, z.core.$strip>;
|
|
10078
|
+
}, z.core.$strip>>;
|
|
10079
|
+
};
|
|
10080
|
+
readonly errors: readonly ["invalid_request", "unauthorized", "forbidden", "user_not_found", "rate_limited", "internal_error", "contract_violation"];
|
|
10081
|
+
readonly errorResponse: CompatibleResponseSchema<z.ZodObject<{
|
|
10082
|
+
readonly error: z.ZodObject<{
|
|
10083
|
+
code: z.ZodEnum<{
|
|
10084
|
+
rate_limited: "rate_limited";
|
|
10085
|
+
internal_error: "internal_error";
|
|
10086
|
+
invalid_request: "invalid_request";
|
|
10087
|
+
unauthorized: "unauthorized";
|
|
10088
|
+
forbidden: "forbidden";
|
|
10089
|
+
user_not_found: "user_not_found";
|
|
10090
|
+
contract_violation: "contract_violation";
|
|
10091
|
+
}>;
|
|
10092
|
+
message: z.ZodString;
|
|
10093
|
+
requestId: z.ZodString;
|
|
10094
|
+
retryable: z.ZodBoolean;
|
|
10095
|
+
details: z.ZodRecord<z.ZodString, z.ZodJSONSchema>;
|
|
10096
|
+
}, z.core.$strict>;
|
|
10097
|
+
}, z.core.$strip>, z.ZodObject<{
|
|
10098
|
+
readonly error: z.ZodObject<{
|
|
10099
|
+
code: z.ZodEnum<{
|
|
10100
|
+
rate_limited: "rate_limited";
|
|
10101
|
+
internal_error: "internal_error";
|
|
10102
|
+
invalid_request: "invalid_request";
|
|
10103
|
+
unauthorized: "unauthorized";
|
|
10104
|
+
forbidden: "forbidden";
|
|
10105
|
+
user_not_found: "user_not_found";
|
|
10106
|
+
contract_violation: "contract_violation";
|
|
10107
|
+
}>;
|
|
10108
|
+
message: z.ZodString;
|
|
10109
|
+
requestId: z.ZodString;
|
|
10110
|
+
retryable: z.ZodBoolean;
|
|
10111
|
+
details: z.ZodRecord<z.ZodString, z.ZodJSONSchema>;
|
|
10112
|
+
}, z.core.$loose>;
|
|
10113
|
+
}, z.core.$strip>>;
|
|
10114
|
+
readonly resources: {
|
|
10115
|
+
readonly reads: readonly [{
|
|
10116
|
+
readonly type: "partner.user";
|
|
10117
|
+
readonly idFrom: "params.userId";
|
|
10118
|
+
}];
|
|
10119
|
+
readonly changes: readonly [{
|
|
10120
|
+
readonly type: "partner.user";
|
|
10121
|
+
readonly idFrom: "params.userId";
|
|
10122
|
+
}, {
|
|
10123
|
+
readonly type: "user.sites";
|
|
10124
|
+
readonly idFrom: "params.userId";
|
|
10125
|
+
}];
|
|
10126
|
+
};
|
|
10127
|
+
readonly lifecycle: {
|
|
10128
|
+
readonly introduced: "1.3.0";
|
|
10129
|
+
};
|
|
10130
|
+
readonly docs: {
|
|
10131
|
+
readonly summary: "Delete a partner user";
|
|
10132
|
+
readonly description: "Queues cascade deletion of a partner-linked user and their sites.";
|
|
10133
|
+
readonly tags: readonly ["Users"];
|
|
10134
|
+
readonly examples: {
|
|
10135
|
+
readonly request: {
|
|
10136
|
+
readonly params: {
|
|
10137
|
+
readonly userId: "u_01";
|
|
10138
|
+
};
|
|
10139
|
+
};
|
|
10140
|
+
readonly response: {
|
|
10141
|
+
readonly data: {
|
|
10142
|
+
readonly ok: true;
|
|
10143
|
+
readonly queued: true;
|
|
10144
|
+
readonly userId: 1;
|
|
10145
|
+
readonly publicId: "u_01";
|
|
10146
|
+
};
|
|
10147
|
+
readonly meta: {
|
|
10148
|
+
readonly requestId: "req_01";
|
|
10149
|
+
readonly surface: "partner";
|
|
10150
|
+
readonly version: "1.0";
|
|
10151
|
+
};
|
|
10152
|
+
};
|
|
10153
|
+
};
|
|
10154
|
+
};
|
|
10155
|
+
};
|
|
10156
|
+
readonly createVerificationToken: {
|
|
10157
|
+
readonly id: "partner.users.verification.token.create";
|
|
10158
|
+
readonly method: "POST";
|
|
10159
|
+
readonly path: "/users/{userId}/verification-token";
|
|
10160
|
+
readonly visibility: "public";
|
|
10161
|
+
readonly semantics: {
|
|
10162
|
+
readonly kind: "query";
|
|
10163
|
+
readonly sideEffects: "none";
|
|
10164
|
+
readonly idempotent: true;
|
|
10165
|
+
readonly retry: "idempotent";
|
|
10166
|
+
readonly readConsistency: "primary";
|
|
10167
|
+
};
|
|
10168
|
+
readonly auth: {
|
|
10169
|
+
readonly credentials: readonly ["user_key", "partner_key"];
|
|
10170
|
+
readonly scopes: readonly ["sites:write"];
|
|
10171
|
+
readonly ownership: readonly [{
|
|
10172
|
+
readonly credential: "user_key";
|
|
10173
|
+
readonly rule: "self";
|
|
10174
|
+
}, {
|
|
10175
|
+
readonly credential: "partner_key";
|
|
10176
|
+
readonly rule: "linked_user";
|
|
10177
|
+
}];
|
|
10178
|
+
};
|
|
10179
|
+
readonly request: {
|
|
10180
|
+
readonly params: z.ZodObject<{
|
|
10181
|
+
userId: z.ZodString;
|
|
10182
|
+
}, z.core.$strict>;
|
|
10183
|
+
readonly query: null;
|
|
10184
|
+
readonly headers: z.ZodObject<{
|
|
10185
|
+
'x-request-id': z.ZodOptional<z.ZodString>;
|
|
10186
|
+
}, z.core.$strict>;
|
|
10187
|
+
readonly body: z.ZodObject<{
|
|
10188
|
+
siteUrl: z.ZodString;
|
|
10189
|
+
method: z.ZodOptional<z.ZodEnum<{
|
|
10190
|
+
META: "META";
|
|
10191
|
+
FILE: "FILE";
|
|
10192
|
+
DNS_TXT: "DNS_TXT";
|
|
10193
|
+
DNS_CNAME: "DNS_CNAME";
|
|
10194
|
+
ANALYTICS: "ANALYTICS";
|
|
10195
|
+
TAG_MANAGER: "TAG_MANAGER";
|
|
10196
|
+
}>>;
|
|
10197
|
+
}, z.core.$strict>;
|
|
10198
|
+
};
|
|
10199
|
+
readonly responses: {
|
|
10200
|
+
readonly 200: CompatibleResponseSchema<z.ZodObject<{
|
|
10201
|
+
data: z.ZodObject<{
|
|
10202
|
+
readonly siteUrl: z.ZodString;
|
|
10203
|
+
readonly site: z.ZodObject<{
|
|
10204
|
+
type: z.ZodString;
|
|
10205
|
+
identifier: z.ZodString;
|
|
10206
|
+
}, z.core.$loose>;
|
|
10207
|
+
readonly method: z.ZodString;
|
|
10208
|
+
readonly token: z.ZodString;
|
|
10209
|
+
readonly metaContent: z.ZodNullable<z.ZodString>;
|
|
10210
|
+
readonly dnsRecord: z.ZodNullable<z.ZodObject<{
|
|
10211
|
+
type: z.ZodEnum<{
|
|
10212
|
+
TXT: "TXT";
|
|
10213
|
+
CNAME: "CNAME";
|
|
10214
|
+
}>;
|
|
10215
|
+
host: z.ZodString;
|
|
10216
|
+
value: z.ZodString;
|
|
10217
|
+
}, z.core.$strip>>;
|
|
10218
|
+
}, z.core.$strip>;
|
|
10219
|
+
meta: z.ZodObject<{
|
|
10220
|
+
readonly requestId: z.ZodString;
|
|
10221
|
+
readonly surface: z.ZodLiteral<"partner">;
|
|
10222
|
+
readonly version: z.ZodLiteral<"1.0">;
|
|
10223
|
+
}, z.core.$strip>;
|
|
10224
|
+
}, z.core.$strip>, z.ZodObject<{
|
|
10225
|
+
data: z.ZodObject<{
|
|
10226
|
+
readonly siteUrl: z.ZodString;
|
|
10227
|
+
readonly site: z.ZodObject<{
|
|
10228
|
+
type: z.ZodString;
|
|
10229
|
+
identifier: z.ZodString;
|
|
10230
|
+
}, z.core.$loose>;
|
|
10231
|
+
readonly method: z.ZodString;
|
|
10232
|
+
readonly token: z.ZodString;
|
|
10233
|
+
readonly metaContent: z.ZodNullable<z.ZodString>;
|
|
10234
|
+
readonly dnsRecord: z.ZodNullable<z.ZodObject<{
|
|
10235
|
+
type: z.ZodEnum<{
|
|
10236
|
+
TXT: "TXT";
|
|
10237
|
+
CNAME: "CNAME";
|
|
10238
|
+
}>;
|
|
10239
|
+
host: z.ZodString;
|
|
10240
|
+
value: z.ZodString;
|
|
10241
|
+
}, z.core.$strip>>;
|
|
10242
|
+
}, z.core.$strip>;
|
|
10243
|
+
meta: z.ZodObject<{
|
|
10244
|
+
readonly requestId: z.ZodString;
|
|
10245
|
+
readonly surface: z.ZodLiteral<"partner">;
|
|
10246
|
+
readonly version: z.ZodLiteral<"1.0">;
|
|
10247
|
+
}, z.core.$strip>;
|
|
10248
|
+
}, z.core.$strip>>;
|
|
10249
|
+
};
|
|
10250
|
+
readonly errors: readonly ["invalid_request", "unauthorized", "forbidden", "user_not_found", "rate_limited", "internal_error", "contract_violation"];
|
|
10251
|
+
readonly errorResponse: CompatibleResponseSchema<z.ZodObject<{
|
|
10252
|
+
readonly error: z.ZodObject<{
|
|
10253
|
+
code: z.ZodEnum<{
|
|
10254
|
+
rate_limited: "rate_limited";
|
|
10255
|
+
internal_error: "internal_error";
|
|
10256
|
+
invalid_request: "invalid_request";
|
|
10257
|
+
unauthorized: "unauthorized";
|
|
10258
|
+
forbidden: "forbidden";
|
|
10259
|
+
user_not_found: "user_not_found";
|
|
10260
|
+
contract_violation: "contract_violation";
|
|
10261
|
+
}>;
|
|
10262
|
+
message: z.ZodString;
|
|
10263
|
+
requestId: z.ZodString;
|
|
10264
|
+
retryable: z.ZodBoolean;
|
|
10265
|
+
details: z.ZodRecord<z.ZodString, z.ZodJSONSchema>;
|
|
10266
|
+
}, z.core.$strict>;
|
|
10267
|
+
}, z.core.$strip>, z.ZodObject<{
|
|
10268
|
+
readonly error: z.ZodObject<{
|
|
10269
|
+
code: z.ZodEnum<{
|
|
10270
|
+
rate_limited: "rate_limited";
|
|
10271
|
+
internal_error: "internal_error";
|
|
10272
|
+
invalid_request: "invalid_request";
|
|
10273
|
+
unauthorized: "unauthorized";
|
|
10274
|
+
forbidden: "forbidden";
|
|
10275
|
+
user_not_found: "user_not_found";
|
|
10276
|
+
contract_violation: "contract_violation";
|
|
10277
|
+
}>;
|
|
10278
|
+
message: z.ZodString;
|
|
10279
|
+
requestId: z.ZodString;
|
|
10280
|
+
retryable: z.ZodBoolean;
|
|
10281
|
+
details: z.ZodRecord<z.ZodString, z.ZodJSONSchema>;
|
|
10282
|
+
}, z.core.$loose>;
|
|
10283
|
+
}, z.core.$strip>>;
|
|
10284
|
+
readonly resources: {
|
|
10285
|
+
readonly reads: readonly [{
|
|
10286
|
+
readonly type: "partner.user";
|
|
10287
|
+
readonly idFrom: "params.userId";
|
|
10288
|
+
}, {
|
|
10289
|
+
readonly type: "user.sites";
|
|
10290
|
+
readonly idFrom: "params.userId";
|
|
10291
|
+
}];
|
|
10292
|
+
readonly changes: readonly [];
|
|
10293
|
+
};
|
|
10294
|
+
readonly lifecycle: {
|
|
10295
|
+
readonly introduced: "1.3.0";
|
|
10296
|
+
};
|
|
10297
|
+
readonly docs: {
|
|
10298
|
+
readonly summary: "Create a site verification token";
|
|
10299
|
+
readonly description: "Mints a Search Console site-ownership verification token (meta tag or DNS record) for a not-yet-registered site.";
|
|
10300
|
+
readonly tags: readonly ["Sites"];
|
|
10301
|
+
readonly examples: {
|
|
10302
|
+
readonly request: {
|
|
10303
|
+
readonly params: {
|
|
10304
|
+
readonly userId: "u_01";
|
|
10305
|
+
};
|
|
10306
|
+
readonly body: {
|
|
10307
|
+
readonly siteUrl: "https://example.com";
|
|
10308
|
+
readonly method: "DNS_TXT";
|
|
10309
|
+
};
|
|
10310
|
+
};
|
|
10311
|
+
readonly response: {
|
|
10312
|
+
readonly data: {
|
|
10313
|
+
readonly siteUrl: "https://example.com";
|
|
10314
|
+
readonly site: {
|
|
10315
|
+
readonly type: "INET_DOMAIN";
|
|
10316
|
+
readonly identifier: "example.com";
|
|
10317
|
+
};
|
|
10318
|
+
readonly method: "DNS_TXT";
|
|
10319
|
+
readonly token: "abc123";
|
|
10320
|
+
readonly metaContent: null;
|
|
10321
|
+
readonly dnsRecord: {
|
|
10322
|
+
readonly type: "TXT";
|
|
10323
|
+
readonly host: "_gsc.example.com";
|
|
10324
|
+
readonly value: "abc123";
|
|
10325
|
+
};
|
|
10326
|
+
};
|
|
10327
|
+
readonly meta: {
|
|
10328
|
+
readonly requestId: "req_01";
|
|
10329
|
+
readonly surface: "partner";
|
|
10330
|
+
readonly version: "1.0";
|
|
10331
|
+
};
|
|
10332
|
+
};
|
|
10333
|
+
};
|
|
10334
|
+
};
|
|
10335
|
+
};
|
|
10336
|
+
readonly addAndVerifySite: {
|
|
10337
|
+
readonly id: "partner.users.sites.verify.create";
|
|
10338
|
+
readonly method: "POST";
|
|
10339
|
+
readonly path: "/users/{userId}/sites/verify";
|
|
10340
|
+
readonly visibility: "public";
|
|
10341
|
+
readonly semantics: {
|
|
10342
|
+
readonly kind: "mutation";
|
|
10343
|
+
readonly sideEffects: "state";
|
|
10344
|
+
readonly idempotent: true;
|
|
10345
|
+
readonly retry: "idempotent";
|
|
10346
|
+
readonly readConsistency: null;
|
|
10347
|
+
};
|
|
10348
|
+
readonly auth: {
|
|
10349
|
+
readonly credentials: readonly ["user_key", "partner_key"];
|
|
10350
|
+
readonly scopes: readonly ["sites:write"];
|
|
10351
|
+
readonly ownership: readonly [{
|
|
10352
|
+
readonly credential: "user_key";
|
|
10353
|
+
readonly rule: "self";
|
|
10354
|
+
}, {
|
|
10355
|
+
readonly credential: "partner_key";
|
|
10356
|
+
readonly rule: "linked_user";
|
|
10357
|
+
}];
|
|
10358
|
+
};
|
|
10359
|
+
readonly request: {
|
|
10360
|
+
readonly params: z.ZodObject<{
|
|
10361
|
+
userId: z.ZodString;
|
|
10362
|
+
}, z.core.$strict>;
|
|
10363
|
+
readonly query: null;
|
|
10364
|
+
readonly headers: z.ZodObject<{
|
|
10365
|
+
'x-request-id': z.ZodOptional<z.ZodString>;
|
|
10366
|
+
}, z.core.$strict>;
|
|
10367
|
+
readonly body: z.ZodObject<{
|
|
10368
|
+
siteUrl: z.ZodString;
|
|
10369
|
+
method: z.ZodOptional<z.ZodEnum<{
|
|
10370
|
+
META: "META";
|
|
10371
|
+
FILE: "FILE";
|
|
10372
|
+
DNS_TXT: "DNS_TXT";
|
|
10373
|
+
DNS_CNAME: "DNS_CNAME";
|
|
10374
|
+
ANALYTICS: "ANALYTICS";
|
|
10375
|
+
TAG_MANAGER: "TAG_MANAGER";
|
|
10376
|
+
}>>;
|
|
10377
|
+
}, z.core.$strict>;
|
|
10378
|
+
};
|
|
10379
|
+
readonly responses: {
|
|
10380
|
+
readonly 200: CompatibleResponseSchema<z.ZodObject<{
|
|
10381
|
+
data: z.ZodObject<{
|
|
10382
|
+
readonly siteUrl: z.ZodString;
|
|
10383
|
+
readonly site: z.ZodObject<{
|
|
10384
|
+
type: z.ZodString;
|
|
10385
|
+
identifier: z.ZodString;
|
|
10386
|
+
}, z.core.$loose>;
|
|
10387
|
+
readonly method: z.ZodString;
|
|
10388
|
+
readonly verified: z.ZodLiteral<true>;
|
|
10389
|
+
readonly owners: z.ZodOptional<z.ZodArray<z.ZodString>>;
|
|
10390
|
+
}, z.core.$strip>;
|
|
10391
|
+
meta: z.ZodObject<{
|
|
10392
|
+
readonly requestId: z.ZodString;
|
|
10393
|
+
readonly surface: z.ZodLiteral<"partner">;
|
|
10394
|
+
readonly version: z.ZodLiteral<"1.0">;
|
|
10395
|
+
}, z.core.$strip>;
|
|
10396
|
+
}, z.core.$strip>, z.ZodObject<{
|
|
10397
|
+
data: z.ZodObject<{
|
|
10398
|
+
readonly siteUrl: z.ZodString;
|
|
10399
|
+
readonly site: z.ZodObject<{
|
|
10400
|
+
type: z.ZodString;
|
|
10401
|
+
identifier: z.ZodString;
|
|
10402
|
+
}, z.core.$loose>;
|
|
10403
|
+
readonly method: z.ZodString;
|
|
10404
|
+
readonly verified: z.ZodLiteral<true>;
|
|
10405
|
+
readonly owners: z.ZodOptional<z.ZodArray<z.ZodString>>;
|
|
10406
|
+
}, z.core.$strip>;
|
|
10407
|
+
meta: z.ZodObject<{
|
|
10408
|
+
readonly requestId: z.ZodString;
|
|
10409
|
+
readonly surface: z.ZodLiteral<"partner">;
|
|
10410
|
+
readonly version: z.ZodLiteral<"1.0">;
|
|
10411
|
+
}, z.core.$strip>;
|
|
10412
|
+
}, z.core.$strip>>;
|
|
10413
|
+
};
|
|
10414
|
+
readonly errors: readonly ["invalid_request", "unauthorized", "forbidden", "user_not_found", "rate_limited", "internal_error", "contract_violation"];
|
|
10415
|
+
readonly errorResponse: CompatibleResponseSchema<z.ZodObject<{
|
|
10416
|
+
readonly error: z.ZodObject<{
|
|
10417
|
+
code: z.ZodEnum<{
|
|
10418
|
+
rate_limited: "rate_limited";
|
|
10419
|
+
internal_error: "internal_error";
|
|
10420
|
+
invalid_request: "invalid_request";
|
|
10421
|
+
unauthorized: "unauthorized";
|
|
10422
|
+
forbidden: "forbidden";
|
|
10423
|
+
user_not_found: "user_not_found";
|
|
10424
|
+
contract_violation: "contract_violation";
|
|
10425
|
+
}>;
|
|
10426
|
+
message: z.ZodString;
|
|
10427
|
+
requestId: z.ZodString;
|
|
10428
|
+
retryable: z.ZodBoolean;
|
|
10429
|
+
details: z.ZodRecord<z.ZodString, z.ZodJSONSchema>;
|
|
10430
|
+
}, z.core.$strict>;
|
|
10431
|
+
}, z.core.$strip>, z.ZodObject<{
|
|
10432
|
+
readonly error: z.ZodObject<{
|
|
10433
|
+
code: z.ZodEnum<{
|
|
10434
|
+
rate_limited: "rate_limited";
|
|
10435
|
+
internal_error: "internal_error";
|
|
10436
|
+
invalid_request: "invalid_request";
|
|
10437
|
+
unauthorized: "unauthorized";
|
|
10438
|
+
forbidden: "forbidden";
|
|
10439
|
+
user_not_found: "user_not_found";
|
|
10440
|
+
contract_violation: "contract_violation";
|
|
10441
|
+
}>;
|
|
10442
|
+
message: z.ZodString;
|
|
10443
|
+
requestId: z.ZodString;
|
|
10444
|
+
retryable: z.ZodBoolean;
|
|
10445
|
+
details: z.ZodRecord<z.ZodString, z.ZodJSONSchema>;
|
|
10446
|
+
}, z.core.$loose>;
|
|
10447
|
+
}, z.core.$strip>>;
|
|
10448
|
+
readonly resources: {
|
|
10449
|
+
readonly reads: readonly [{
|
|
10450
|
+
readonly type: "partner.user";
|
|
10451
|
+
readonly idFrom: "params.userId";
|
|
10452
|
+
}];
|
|
10453
|
+
readonly changes: readonly [{
|
|
10454
|
+
readonly type: "user.sites";
|
|
10455
|
+
readonly idFrom: "params.userId";
|
|
10456
|
+
}];
|
|
10457
|
+
};
|
|
10458
|
+
readonly lifecycle: {
|
|
10459
|
+
readonly introduced: "1.3.0";
|
|
10460
|
+
};
|
|
10461
|
+
readonly docs: {
|
|
10462
|
+
readonly summary: "Add and verify a site";
|
|
10463
|
+
readonly description: "Verifies Search Console ownership of a site for a user via the given method and records the verified ownership.";
|
|
10464
|
+
readonly tags: readonly ["Sites"];
|
|
10465
|
+
readonly examples: {
|
|
10466
|
+
readonly request: {
|
|
10467
|
+
readonly params: {
|
|
10468
|
+
readonly userId: "u_01";
|
|
10469
|
+
};
|
|
10470
|
+
readonly body: {
|
|
10471
|
+
readonly siteUrl: "https://example.com";
|
|
10472
|
+
readonly method: "DNS_TXT";
|
|
10473
|
+
};
|
|
10474
|
+
};
|
|
10475
|
+
readonly response: {
|
|
10476
|
+
readonly data: {
|
|
10477
|
+
readonly siteUrl: "https://example.com";
|
|
10478
|
+
readonly site: {
|
|
10479
|
+
readonly type: "INET_DOMAIN";
|
|
10480
|
+
readonly identifier: "example.com";
|
|
10481
|
+
};
|
|
10482
|
+
readonly method: "DNS_TXT";
|
|
10483
|
+
readonly verified: true;
|
|
10484
|
+
readonly owners: readonly ["owner@example.com"];
|
|
10485
|
+
};
|
|
10486
|
+
readonly meta: {
|
|
10487
|
+
readonly requestId: "req_01";
|
|
10488
|
+
readonly surface: "partner";
|
|
10489
|
+
readonly version: "1.0";
|
|
10490
|
+
};
|
|
10491
|
+
};
|
|
10492
|
+
};
|
|
10493
|
+
};
|
|
10494
|
+
};
|
|
10495
|
+
readonly queryCrossSource: {
|
|
10496
|
+
readonly id: "partner.sites.cross.source.query";
|
|
10497
|
+
readonly method: "POST";
|
|
10498
|
+
readonly path: "/sites/{siteId}/cross-source";
|
|
10499
|
+
readonly visibility: "public";
|
|
10500
|
+
readonly semantics: {
|
|
10501
|
+
readonly kind: "query";
|
|
10502
|
+
readonly sideEffects: "none";
|
|
10503
|
+
readonly idempotent: true;
|
|
10504
|
+
readonly retry: "idempotent";
|
|
10505
|
+
readonly readConsistency: "primary";
|
|
10506
|
+
};
|
|
10507
|
+
readonly auth: {
|
|
10508
|
+
readonly credentials: readonly ["partner_key"];
|
|
10509
|
+
readonly scopes: readonly ["analytics:read"];
|
|
10510
|
+
readonly ownership: readonly [{
|
|
10511
|
+
readonly credential: "partner_key";
|
|
10512
|
+
readonly rule: "authorized_site";
|
|
10513
|
+
}];
|
|
10514
|
+
};
|
|
10515
|
+
readonly request: {
|
|
10516
|
+
readonly params: z.ZodObject<{
|
|
10517
|
+
siteId: z.ZodString;
|
|
10518
|
+
}, z.core.$strict>;
|
|
10519
|
+
readonly query: null;
|
|
10520
|
+
readonly headers: z.ZodObject<{
|
|
10521
|
+
'x-request-id': z.ZodOptional<z.ZodString>;
|
|
10522
|
+
}, z.core.$strict>;
|
|
10523
|
+
readonly body: z.ZodObject<{
|
|
10524
|
+
queryKey: z.ZodEnum<{
|
|
10525
|
+
"crawl-error-losing-impressions": "crawl-error-losing-impressions";
|
|
10526
|
+
"declining-clicks-poor-lcp": "declining-clicks-poor-lcp";
|
|
10527
|
+
"striking-distance-slow-pages": "striking-distance-slow-pages";
|
|
10528
|
+
"top-impressions-low-performance": "top-impressions-low-performance";
|
|
10529
|
+
}>;
|
|
10530
|
+
rangeDays: z.ZodOptional<z.ZodNumber>;
|
|
10531
|
+
limit: z.ZodOptional<z.ZodNumber>;
|
|
10532
|
+
}, z.core.$strict>;
|
|
10533
|
+
};
|
|
10534
|
+
readonly responses: {
|
|
10535
|
+
readonly 200: CompatibleResponseSchema<z.ZodObject<{
|
|
10536
|
+
data: z.ZodObject<{
|
|
10537
|
+
readonly reason: z.ZodOptional<z.ZodString>;
|
|
10538
|
+
readonly sources: z.ZodArray<z.ZodString>;
|
|
10539
|
+
readonly rows: z.ZodArray<z.ZodRecord<z.ZodString, z.ZodJSONSchema>>;
|
|
10540
|
+
}, z.core.$strip>;
|
|
10541
|
+
meta: z.ZodObject<{
|
|
10542
|
+
readonly requestId: z.ZodString;
|
|
10543
|
+
readonly surface: z.ZodLiteral<"partner">;
|
|
10544
|
+
readonly version: z.ZodLiteral<"1.0">;
|
|
10545
|
+
}, z.core.$strip>;
|
|
10546
|
+
}, z.core.$strip>, z.ZodObject<{
|
|
10547
|
+
data: z.ZodObject<{
|
|
10548
|
+
readonly reason: z.ZodOptional<z.ZodString>;
|
|
10549
|
+
readonly sources: z.ZodArray<z.ZodString>;
|
|
10550
|
+
readonly rows: z.ZodArray<z.ZodRecord<z.ZodString, z.ZodJSONSchema>>;
|
|
10551
|
+
}, z.core.$strip>;
|
|
10552
|
+
meta: z.ZodObject<{
|
|
10553
|
+
readonly requestId: z.ZodString;
|
|
10554
|
+
readonly surface: z.ZodLiteral<"partner">;
|
|
10555
|
+
readonly version: z.ZodLiteral<"1.0">;
|
|
10556
|
+
}, z.core.$strip>;
|
|
10557
|
+
}, z.core.$strip>>;
|
|
10558
|
+
};
|
|
10559
|
+
readonly errors: readonly ["invalid_request", "unauthorized", "forbidden", "site_not_found", "rate_limited", "internal_error", "contract_violation"];
|
|
10560
|
+
readonly errorResponse: CompatibleResponseSchema<z.ZodObject<{
|
|
10561
|
+
readonly error: z.ZodObject<{
|
|
10562
|
+
code: z.ZodEnum<{
|
|
10563
|
+
rate_limited: "rate_limited";
|
|
10564
|
+
internal_error: "internal_error";
|
|
10565
|
+
invalid_request: "invalid_request";
|
|
10566
|
+
unauthorized: "unauthorized";
|
|
10567
|
+
forbidden: "forbidden";
|
|
10568
|
+
site_not_found: "site_not_found";
|
|
10569
|
+
contract_violation: "contract_violation";
|
|
10570
|
+
}>;
|
|
10571
|
+
message: z.ZodString;
|
|
10572
|
+
requestId: z.ZodString;
|
|
10573
|
+
retryable: z.ZodBoolean;
|
|
10574
|
+
details: z.ZodRecord<z.ZodString, z.ZodJSONSchema>;
|
|
10575
|
+
}, z.core.$strict>;
|
|
10576
|
+
}, z.core.$strip>, z.ZodObject<{
|
|
10577
|
+
readonly error: z.ZodObject<{
|
|
10578
|
+
code: z.ZodEnum<{
|
|
10579
|
+
rate_limited: "rate_limited";
|
|
10580
|
+
internal_error: "internal_error";
|
|
10581
|
+
invalid_request: "invalid_request";
|
|
10582
|
+
unauthorized: "unauthorized";
|
|
10583
|
+
forbidden: "forbidden";
|
|
10584
|
+
site_not_found: "site_not_found";
|
|
10585
|
+
contract_violation: "contract_violation";
|
|
10586
|
+
}>;
|
|
10587
|
+
message: z.ZodString;
|
|
10588
|
+
requestId: z.ZodString;
|
|
10589
|
+
retryable: z.ZodBoolean;
|
|
10590
|
+
details: z.ZodRecord<z.ZodString, z.ZodJSONSchema>;
|
|
10591
|
+
}, z.core.$loose>;
|
|
10592
|
+
}, z.core.$strip>>;
|
|
10593
|
+
readonly resources: {
|
|
10594
|
+
readonly reads: readonly [{
|
|
10595
|
+
readonly type: "site.analytics";
|
|
10596
|
+
readonly idFrom: "params.siteId";
|
|
10597
|
+
}];
|
|
10598
|
+
readonly changes: readonly [];
|
|
10599
|
+
};
|
|
10600
|
+
readonly lifecycle: {
|
|
10601
|
+
readonly introduced: "1.3.0";
|
|
10602
|
+
};
|
|
10603
|
+
readonly docs: {
|
|
10604
|
+
readonly summary: "Query cross-source analysis";
|
|
10605
|
+
readonly description: "Runs one predefined cross-source query joining crawl, CWV, and GSC signals for a site.";
|
|
10606
|
+
readonly tags: readonly ["Analytics"];
|
|
10607
|
+
readonly examples: {
|
|
10608
|
+
readonly request: {
|
|
10609
|
+
readonly params: {
|
|
10610
|
+
readonly siteId: "s_01";
|
|
10611
|
+
};
|
|
10612
|
+
readonly body: {
|
|
10613
|
+
readonly queryKey: "crawl-error-losing-impressions";
|
|
10614
|
+
readonly rangeDays: 28;
|
|
10615
|
+
readonly limit: 50;
|
|
10616
|
+
};
|
|
10617
|
+
};
|
|
10618
|
+
readonly response: {
|
|
10619
|
+
readonly data: {
|
|
10620
|
+
readonly sources: readonly ["crawl", "gsc"];
|
|
10621
|
+
readonly rows: readonly [];
|
|
10622
|
+
};
|
|
10623
|
+
readonly meta: {
|
|
10624
|
+
readonly requestId: "req_01";
|
|
10625
|
+
readonly surface: "partner";
|
|
10626
|
+
readonly version: "1.0";
|
|
10627
|
+
};
|
|
10628
|
+
};
|
|
10629
|
+
};
|
|
10630
|
+
};
|
|
10631
|
+
};
|
|
10632
|
+
readonly enrichKeywords: {
|
|
10633
|
+
readonly id: "partner.keywords.enrich.query";
|
|
10634
|
+
readonly method: "POST";
|
|
10635
|
+
readonly path: "/keywords/enrich";
|
|
10636
|
+
readonly visibility: "public";
|
|
10637
|
+
readonly semantics: {
|
|
10638
|
+
readonly kind: "query";
|
|
10639
|
+
readonly sideEffects: "none";
|
|
10640
|
+
readonly idempotent: true;
|
|
10641
|
+
readonly retry: "idempotent";
|
|
10642
|
+
readonly readConsistency: "primary";
|
|
10643
|
+
};
|
|
10644
|
+
readonly auth: {
|
|
10645
|
+
readonly credentials: readonly ["user_key", "partner_key"];
|
|
10646
|
+
readonly scopes: readonly ["analytics:read"];
|
|
10647
|
+
readonly ownership: readonly [{
|
|
10648
|
+
readonly credential: "user_key";
|
|
10649
|
+
readonly rule: "self";
|
|
10650
|
+
}, {
|
|
10651
|
+
readonly credential: "partner_key";
|
|
10652
|
+
readonly rule: "partner_tenant";
|
|
10653
|
+
}];
|
|
10654
|
+
};
|
|
10655
|
+
readonly request: {
|
|
10656
|
+
readonly params: null;
|
|
10657
|
+
readonly query: null;
|
|
10658
|
+
readonly headers: z.ZodObject<{
|
|
10659
|
+
'x-request-id': z.ZodOptional<z.ZodString>;
|
|
10660
|
+
}, z.core.$strict>;
|
|
10661
|
+
readonly body: z.ZodObject<{
|
|
10662
|
+
keywords: z.ZodArray<z.ZodString>;
|
|
10663
|
+
}, z.core.$strict>;
|
|
10664
|
+
};
|
|
10665
|
+
readonly responses: {
|
|
10666
|
+
readonly 200: CompatibleResponseSchema<z.ZodObject<{
|
|
10667
|
+
data: z.ZodObject<{
|
|
10668
|
+
readonly metrics: z.ZodRecord<z.ZodString, z.ZodObject<{
|
|
10669
|
+
difficulty: z.ZodNullable<z.ZodNumber>;
|
|
10670
|
+
searchVolume: z.ZodNullable<z.ZodNumber>;
|
|
10671
|
+
cpc: z.ZodNullable<z.ZodNumber>;
|
|
10672
|
+
}, z.core.$loose>>;
|
|
10673
|
+
}, z.core.$strip>;
|
|
10674
|
+
meta: z.ZodObject<{
|
|
10675
|
+
readonly requestId: z.ZodString;
|
|
10676
|
+
readonly surface: z.ZodLiteral<"partner">;
|
|
10677
|
+
readonly version: z.ZodLiteral<"1.0">;
|
|
10678
|
+
}, z.core.$strip>;
|
|
10679
|
+
}, z.core.$strip>, z.ZodObject<{
|
|
10680
|
+
data: z.ZodObject<{
|
|
10681
|
+
readonly metrics: z.ZodRecord<z.ZodString, z.ZodObject<{
|
|
10682
|
+
difficulty: z.ZodNullable<z.ZodNumber>;
|
|
10683
|
+
searchVolume: z.ZodNullable<z.ZodNumber>;
|
|
10684
|
+
cpc: z.ZodNullable<z.ZodNumber>;
|
|
10685
|
+
}, z.core.$loose>>;
|
|
10686
|
+
}, z.core.$strip>;
|
|
10687
|
+
meta: z.ZodObject<{
|
|
10688
|
+
readonly requestId: z.ZodString;
|
|
10689
|
+
readonly surface: z.ZodLiteral<"partner">;
|
|
10690
|
+
readonly version: z.ZodLiteral<"1.0">;
|
|
10691
|
+
}, z.core.$strip>;
|
|
10692
|
+
}, z.core.$strip>>;
|
|
10693
|
+
};
|
|
10694
|
+
readonly errors: readonly ["invalid_request", "unauthorized", "forbidden", "user_not_found", "rate_limited", "internal_error", "contract_violation"];
|
|
10695
|
+
readonly errorResponse: CompatibleResponseSchema<z.ZodObject<{
|
|
10696
|
+
readonly error: z.ZodObject<{
|
|
10697
|
+
code: z.ZodEnum<{
|
|
10698
|
+
rate_limited: "rate_limited";
|
|
10699
|
+
internal_error: "internal_error";
|
|
10700
|
+
invalid_request: "invalid_request";
|
|
10701
|
+
unauthorized: "unauthorized";
|
|
10702
|
+
forbidden: "forbidden";
|
|
10703
|
+
user_not_found: "user_not_found";
|
|
10704
|
+
contract_violation: "contract_violation";
|
|
10705
|
+
}>;
|
|
10706
|
+
message: z.ZodString;
|
|
10707
|
+
requestId: z.ZodString;
|
|
10708
|
+
retryable: z.ZodBoolean;
|
|
10709
|
+
details: z.ZodRecord<z.ZodString, z.ZodJSONSchema>;
|
|
10710
|
+
}, z.core.$strict>;
|
|
10711
|
+
}, z.core.$strip>, z.ZodObject<{
|
|
10712
|
+
readonly error: z.ZodObject<{
|
|
10713
|
+
code: z.ZodEnum<{
|
|
10714
|
+
rate_limited: "rate_limited";
|
|
10715
|
+
internal_error: "internal_error";
|
|
10716
|
+
invalid_request: "invalid_request";
|
|
10717
|
+
unauthorized: "unauthorized";
|
|
10718
|
+
forbidden: "forbidden";
|
|
10719
|
+
user_not_found: "user_not_found";
|
|
10720
|
+
contract_violation: "contract_violation";
|
|
10721
|
+
}>;
|
|
10722
|
+
message: z.ZodString;
|
|
10723
|
+
requestId: z.ZodString;
|
|
10724
|
+
retryable: z.ZodBoolean;
|
|
10725
|
+
details: z.ZodRecord<z.ZodString, z.ZodJSONSchema>;
|
|
10726
|
+
}, z.core.$loose>;
|
|
10727
|
+
}, z.core.$strip>>;
|
|
10728
|
+
readonly resources: {
|
|
10729
|
+
readonly reads: readonly [];
|
|
10730
|
+
readonly changes: readonly [];
|
|
10731
|
+
};
|
|
10732
|
+
readonly lifecycle: {
|
|
10733
|
+
readonly introduced: "1.3.0";
|
|
10734
|
+
};
|
|
10735
|
+
readonly docs: {
|
|
10736
|
+
readonly summary: "Enrich keywords with metrics";
|
|
10737
|
+
readonly description: "Returns difficulty, search volume, and CPC estimates for up to 500 keywords.";
|
|
10738
|
+
readonly tags: readonly ["Analytics"];
|
|
10739
|
+
readonly examples: {
|
|
10740
|
+
readonly request: {
|
|
10741
|
+
readonly body: {
|
|
10742
|
+
readonly keywords: readonly ["nuxt seo"];
|
|
10743
|
+
};
|
|
10744
|
+
};
|
|
10745
|
+
readonly response: {
|
|
10746
|
+
readonly data: {
|
|
10747
|
+
readonly metrics: {
|
|
10748
|
+
readonly 'nuxt seo': {
|
|
10749
|
+
readonly difficulty: 40;
|
|
10750
|
+
readonly searchVolume: 100;
|
|
10751
|
+
readonly cpc: 1.2;
|
|
10752
|
+
};
|
|
10753
|
+
};
|
|
10754
|
+
};
|
|
10755
|
+
readonly meta: {
|
|
10756
|
+
readonly requestId: "req_01";
|
|
10757
|
+
readonly surface: "partner";
|
|
10758
|
+
readonly version: "1.0";
|
|
10759
|
+
};
|
|
10760
|
+
};
|
|
10761
|
+
};
|
|
10762
|
+
};
|
|
10763
|
+
};
|
|
8163
10764
|
}>;
|
|
8164
10765
|
analytics: HttpV1Surface<{
|
|
8165
10766
|
readonly queryRows: {
|