@typeship-ax/mcp 0.21.0 → 0.23.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (133) hide show
  1. package/AGENTS.md +15 -11
  2. package/README.md +22 -53
  3. package/api.json +9998 -10118
  4. package/api.md +8983 -9120
  5. package/dist/arguments.d.ts +54 -0
  6. package/dist/arguments.d.ts.map +1 -0
  7. package/dist/arguments.js +265 -0
  8. package/dist/core/http.d.ts +162 -19
  9. package/dist/core/http.d.ts.map +1 -1
  10. package/dist/core/http.js +381 -48
  11. package/dist/core/pagination.d.ts +42 -6
  12. package/dist/core/pagination.d.ts.map +1 -1
  13. package/dist/core/pagination.js +111 -17
  14. package/dist/credential-storage.d.ts +10 -3
  15. package/dist/credential-storage.d.ts.map +1 -1
  16. package/dist/credential-storage.js +15 -6
  17. package/dist/dates.d.ts +1 -1
  18. package/dist/dates.js +1 -1
  19. package/dist/errors.d.ts +20 -84
  20. package/dist/errors.d.ts.map +1 -1
  21. package/dist/errors.js +20 -108
  22. package/dist/fields.d.ts +36 -0
  23. package/dist/fields.d.ts.map +1 -0
  24. package/dist/fields.js +187 -0
  25. package/dist/index.d.ts +28 -18
  26. package/dist/index.d.ts.map +1 -1
  27. package/dist/index.js +35 -25
  28. package/dist/mcp-authorization.d.ts.map +1 -1
  29. package/dist/mcp-authorization.js +34 -10
  30. package/dist/mcp-protocol.d.ts +108 -44
  31. package/dist/mcp-protocol.d.ts.map +1 -1
  32. package/dist/mcp-protocol.js +780 -484
  33. package/dist/mcp.d.ts.map +1 -1
  34. package/dist/mcp.js +129 -29
  35. package/dist/named-credentials.d.ts +19 -0
  36. package/dist/named-credentials.d.ts.map +1 -1
  37. package/dist/named-credentials.js +81 -1
  38. package/dist/oauth-request.d.ts +7 -1
  39. package/dist/oauth-request.d.ts.map +1 -1
  40. package/dist/oauth-request.js +26 -4
  41. package/dist/oauth-session.d.ts +13 -1
  42. package/dist/oauth-session.d.ts.map +1 -1
  43. package/dist/oauth-session.js +34 -18
  44. package/dist/ops.d.ts +58 -5
  45. package/dist/ops.d.ts.map +1 -1
  46. package/dist/ops.js +110 -41
  47. package/dist/resources/api-keys.d.ts +10 -7
  48. package/dist/resources/api-keys.d.ts.map +1 -1
  49. package/dist/resources/api-keys.js +10 -31
  50. package/dist/resources/deliveries.d.ts +89 -5
  51. package/dist/resources/deliveries.d.ts.map +1 -1
  52. package/dist/resources/deliveries.js +96 -19
  53. package/dist/resources/drafts.d.ts +16 -16
  54. package/dist/resources/drafts.d.ts.map +1 -1
  55. package/dist/resources/drafts.js +12 -65
  56. package/dist/resources/files.d.ts +4 -4
  57. package/dist/resources/files.d.ts.map +1 -1
  58. package/dist/resources/files.js +3 -12
  59. package/dist/resources/generations.d.ts +16 -16
  60. package/dist/resources/generations.d.ts.map +1 -1
  61. package/dist/resources/generations.js +23 -47
  62. package/dist/resources/organization.d.ts +4 -4
  63. package/dist/resources/organization.d.ts.map +1 -1
  64. package/dist/resources/organization.js +3 -10
  65. package/dist/resources/{generate.d.ts → packages.d.ts} +16 -16
  66. package/dist/resources/packages.d.ts.map +1 -0
  67. package/dist/resources/{generate.js → packages.js} +13 -29
  68. package/dist/resources/projects.d.ts +50 -50
  69. package/dist/resources/projects.d.ts.map +1 -1
  70. package/dist/resources/projects.js +60 -116
  71. package/dist/resources/releases.d.ts +22 -17
  72. package/dist/resources/releases.d.ts.map +1 -1
  73. package/dist/resources/releases.js +19 -40
  74. package/dist/resources/spec-revisions.d.ts +16 -7
  75. package/dist/resources/spec-revisions.d.ts.map +1 -1
  76. package/dist/resources/spec-revisions.js +7 -29
  77. package/dist/resources/specs.d.ts +7 -7
  78. package/dist/resources/specs.d.ts.map +1 -1
  79. package/dist/resources/specs.js +6 -34
  80. package/dist/resources/targets.d.ts +49 -49
  81. package/dist/resources/targets.d.ts.map +1 -1
  82. package/dist/resources/targets.js +59 -115
  83. package/dist/schemas.d.ts.map +1 -1
  84. package/dist/schemas.js +78 -76
  85. package/dist/search.d.ts +54 -0
  86. package/dist/search.d.ts.map +1 -0
  87. package/dist/search.js +421 -0
  88. package/dist/type-docs.d.ts +61 -0
  89. package/dist/type-docs.d.ts.map +1 -0
  90. package/dist/type-docs.js +174 -0
  91. package/dist/types.d.ts +499 -339
  92. package/dist/types.d.ts.map +1 -1
  93. package/dist/types.js +18 -18
  94. package/dist/worker.js +2 -2
  95. package/package.json +5 -2
  96. package/server.json +5 -5
  97. package/src/arguments.ts +254 -0
  98. package/src/core/http.ts +457 -58
  99. package/src/core/pagination.ts +129 -18
  100. package/src/credential-storage.ts +16 -6
  101. package/src/dates.ts +1 -1
  102. package/src/errors.ts +46 -115
  103. package/src/fields.ts +167 -0
  104. package/src/index.ts +45 -28
  105. package/src/mcp-authorization.ts +29 -9
  106. package/src/mcp-protocol.ts +808 -435
  107. package/src/mcp.ts +115 -27
  108. package/src/named-credentials.ts +66 -1
  109. package/src/oauth-request.ts +32 -6
  110. package/src/oauth-session.ts +37 -19
  111. package/src/ops.ts +146 -45
  112. package/src/resources/api-keys.ts +34 -48
  113. package/src/resources/deliveries.ts +213 -32
  114. package/src/resources/drafts.ts +62 -109
  115. package/src/resources/files.ts +19 -20
  116. package/src/resources/generations.ts +61 -79
  117. package/src/resources/organization.ts +11 -16
  118. package/src/resources/{generate.ts → packages.ts} +43 -51
  119. package/src/resources/projects.ts +145 -200
  120. package/src/resources/releases.ts +50 -67
  121. package/src/resources/spec-revisions.ts +40 -49
  122. package/src/resources/specs.ts +39 -59
  123. package/src/resources/targets.ts +144 -194
  124. package/src/schemas.ts +78 -76
  125. package/src/search.ts +434 -0
  126. package/src/type-docs.ts +205 -0
  127. package/src/types.ts +538 -357
  128. package/src/worker.ts +2 -2
  129. package/dist/resources/generate.d.ts.map +0 -1
  130. package/dist/resources/publications.d.ts +0 -47
  131. package/dist/resources/publications.d.ts.map +0 -1
  132. package/dist/resources/publications.js +0 -70
  133. package/src/resources/publications.ts +0 -140
package/dist/types.d.ts CHANGED
@@ -1,3 +1,15 @@
1
+ declare const unknownVariantTag: unique symbol;
2
+ /**
3
+ * A tag value the server added after this SDK was generated. It is a string
4
+ * at runtime; read it with `String(tag)`.
5
+ */
6
+ export interface UnknownVariantTag extends String {
7
+ readonly [unknownVariantTag]: true;
8
+ }
9
+ /** A union member the server added after this SDK was generated, with every field as received. */
10
+ export type UnknownVariant<Tag extends string> = {
11
+ [K in Tag]: UnknownVariantTag;
12
+ } & Record<string, unknown>;
1
13
  /** Unique identifier for a project. */
2
14
  export type ProjectId = string;
3
15
  /** Unique identifier for a generation. */
@@ -20,7 +32,6 @@ export type DeliveryId = string;
20
32
  /** Unique identifier for a Draft. */
21
33
  export type DraftId = string;
22
34
  export type ReleaseId = string;
23
- export type PublicationId = string;
24
35
  /**
25
36
  * Generator implementation selected by a Target. This is configuration, not identity; several
26
37
  * Targets may use the same generator. cli is the TypeScript CLI; go_cli is the native Go CLI, a
@@ -58,7 +69,10 @@ export interface UrlSpecInputRead {
58
69
  url: string;
59
70
  }
60
71
  export interface InlineSpecInput {
61
- /** Raw Spec text (OpenAPI JSON/YAML or GraphQL SDL). Up to 10MB. */
72
+ /**
73
+ * Raw Spec text (OpenAPI JSON/YAML or GraphQL SDL). Up to 4 MB, because the request body carries
74
+ * it; send Specs up to 10 MB with `url`.
75
+ */
62
76
  inline: string;
63
77
  }
64
78
  /** A Spec for one-shot generation, provided as exactly one URL or inline entrypoint. */
@@ -312,6 +326,8 @@ export interface SpecRevisionFileListRead {
312
326
  request_id: RequestId;
313
327
  }
314
328
  export interface GenerationResult {
329
+ /** One generated package. It has no ID: download it with download.url before download.expires_at. */
330
+ object: "package";
315
331
  files: GeneratedFile[];
316
332
  download?: GenerationDownload;
317
333
  warnings: GenerationWarning[];
@@ -330,6 +346,8 @@ export interface GenerationResult {
330
346
  }
331
347
  /** Response shape for GenerationResult. */
332
348
  export interface GenerationResultRead {
349
+ /** One generated package. It has no ID: download it with download.url before download.expires_at. */
350
+ object: "package" | (string & {});
333
351
  files: GeneratedFileRead[];
334
352
  download?: GenerationDownload;
335
353
  warnings: GenerationWarning[];
@@ -388,11 +406,6 @@ export interface UrlSpecSourceWrite {
388
406
  type: "url";
389
407
  url: UrlSpecSourceSettingsWrite;
390
408
  }
391
- /** Response shape for UrlSpecSource. */
392
- export interface UrlSpecSourceRead {
393
- type: "url" | (string & {});
394
- url: UrlSpecSourceSettings;
395
- }
396
409
  /** GitHub is the only launch provider; the field is stable for future adapters. */
397
410
  export declare const RepositoryProvider: {
398
411
  readonly GITHUB: "github";
@@ -400,15 +413,6 @@ export declare const RepositoryProvider: {
400
413
  export type RepositoryProvider = (typeof RepositoryProvider)[keyof typeof RepositoryProvider];
401
414
  /** Provider-native repository identity, opaque outside its adapter. */
402
415
  export type RepositoryIdentifier = string;
403
- export interface RepositoryReference {
404
- provider: RepositoryProvider;
405
- identifier: RepositoryIdentifier;
406
- }
407
- /** Response shape for RepositoryReference. */
408
- export interface RepositoryReferenceRead {
409
- provider: RepositoryProvider | (string & {});
410
- identifier: RepositoryIdentifier;
411
- }
412
416
  export interface RepositorySpecSourceSettings {
413
417
  provider: RepositoryProvider;
414
418
  identifier: RepositoryIdentifier;
@@ -428,7 +432,7 @@ export interface RepositorySpecSource {
428
432
  }
429
433
  /** Response shape for RepositorySpecSource. */
430
434
  export interface RepositorySpecSourceRead {
431
- type: "repository" | (string & {});
435
+ type: "repository";
432
436
  repository: RepositorySpecSourceSettingsRead;
433
437
  }
434
438
  /** The single source of truth for where a Project's Spec lives. */
@@ -436,9 +440,7 @@ export type SpecSource = UrlSpecSource | RepositorySpecSource;
436
440
  /** Request shape for SpecSource. */
437
441
  export type SpecSourceWrite = UrlSpecSourceWrite | RepositorySpecSource;
438
442
  /** Response shape for SpecSource. */
439
- export type SpecSourceRead = UrlSpecSourceRead | RepositorySpecSourceRead | Record<string, unknown> & {
440
- type?: string;
441
- };
443
+ export type SpecSourceRead = UrlSpecSource | RepositorySpecSourceRead | UnknownVariant<"type">;
442
444
  export interface UrlSpecSourceSettingsInput {
443
445
  /**
444
446
  * URL of an OpenAPI document, GraphQL SDL file, or GraphQL endpoint.
@@ -467,7 +469,7 @@ export interface UrlSpecSourceInput {
467
469
  }
468
470
  /** Response shape for UrlSpecSourceInput. */
469
471
  export interface UrlSpecSourceInputRead {
470
- type: "url" | (string & {});
472
+ type: "url";
471
473
  url: UrlSpecSourceSettingsInputRead;
472
474
  }
473
475
  export interface RepositorySpecSourceSettingsInput {
@@ -489,14 +491,12 @@ export interface RepositorySpecSourceInput {
489
491
  }
490
492
  /** Response shape for RepositorySpecSourceInput. */
491
493
  export interface RepositorySpecSourceInputRead {
492
- type: "repository" | (string & {});
494
+ type: "repository";
493
495
  repository: RepositorySpecSourceSettingsInputRead;
494
496
  }
495
497
  export type SpecSourceInput = UrlSpecSourceInput | RepositorySpecSourceInput;
496
498
  /** Response shape for SpecSourceInput. */
497
- export type SpecSourceInputRead = UrlSpecSourceInputRead | RepositorySpecSourceInputRead | Record<string, unknown> & {
498
- type?: string;
499
- };
499
+ export type SpecSourceInputRead = UrlSpecSourceInputRead | RepositorySpecSourceInputRead | UnknownVariant<"type">;
500
500
  /**
501
501
  * A fix applied to the resolved Spec before generation. Paths are JSON
502
502
  * Pointers into the document. A patch whose target no longer exists is
@@ -533,8 +533,26 @@ export interface SpecPatchRead {
533
533
  to?: string | null;
534
534
  reason?: string | null;
535
535
  }
536
- /** One exact place where a Diagnostic rule found evidence. */
536
+ /**
537
+ * One exact place where a Diagnostic rule found evidence, with its own state under the Spec's
538
+ * Diagnostic policy.
539
+ */
537
540
  export interface DiagnosticLocation {
541
+ /**
542
+ * Whether this location fails the Spec's Diagnostic policy. Fix these locations to pass the
543
+ * policy.
544
+ */
545
+ blocking: boolean;
546
+ /**
547
+ * Whether this location is new since baseline_spec_revision_id in the Diagnostic summary. Always
548
+ * true when there is no baseline.
549
+ */
550
+ introduced: boolean;
551
+ /**
552
+ * Whether a reviewed exception in the Spec's Diagnostic policy covers this location, by its path
553
+ * or for the whole rule. Suppressed locations never block.
554
+ */
555
+ suppressed: boolean;
538
556
  /** Source file path from the Spec Revision when the finding maps to a captured file. */
539
557
  file_path?: string;
540
558
  /** The captured source file, present with file_path. Read it with getFile. */
@@ -583,13 +601,14 @@ export interface Diagnostic {
583
601
  id: string;
584
602
  object: "diagnostic";
585
603
  /**
586
- * Whether this Diagnostic fails the Spec's Diagnostic policy. Suppressed occurrences and, when
587
- * only_new is set, occurrences present in the baseline never block.
604
+ * Whether any location fails the Spec's Diagnostic policy. Each location's blocking field names
605
+ * which ones. Suppressed locations and, when only_new is set, locations present in the baseline
606
+ * never block.
588
607
  */
589
608
  blocking: boolean;
590
609
  /**
591
- * Whether any occurrence is new since baseline_spec_revision_id in the Diagnostic summary. Always
592
- * true when there is no baseline.
610
+ * Whether any location is new since baseline_spec_revision_id in the Diagnostic summary. Each
611
+ * location's introduced field names which ones. Always true when there is no baseline.
593
612
  */
594
613
  introduced: boolean;
595
614
  /** Whether the rule reports invalid behavior, material risk, or an improvement. */
@@ -604,7 +623,10 @@ export interface Diagnostic {
604
623
  surfaces: Array<"api" | "sdk" | "cli" | "mcp">;
605
624
  /** Whether remediation requires intent that the Spec cannot prove. */
606
625
  owner_decision_required: boolean;
607
- /** All affected coordinates, kept under one grouped diagnostic. */
626
+ /**
627
+ * The affected coordinates, kept under one grouped Diagnostic. With a filter, only the matching
628
+ * locations.
629
+ */
608
630
  locations: DiagnosticLocation[];
609
631
  fix?: DiagnosticFix;
610
632
  /**
@@ -619,13 +641,14 @@ export interface DiagnosticRead {
619
641
  id: string;
620
642
  object: "diagnostic" | (string & {});
621
643
  /**
622
- * Whether this Diagnostic fails the Spec's Diagnostic policy. Suppressed occurrences and, when
623
- * only_new is set, occurrences present in the baseline never block.
644
+ * Whether any location fails the Spec's Diagnostic policy. Each location's blocking field names
645
+ * which ones. Suppressed locations and, when only_new is set, locations present in the baseline
646
+ * never block.
624
647
  */
625
648
  blocking: boolean;
626
649
  /**
627
- * Whether any occurrence is new since baseline_spec_revision_id in the Diagnostic summary. Always
628
- * true when there is no baseline.
650
+ * Whether any location is new since baseline_spec_revision_id in the Diagnostic summary. Each
651
+ * location's introduced field names which ones. Always true when there is no baseline.
629
652
  */
630
653
  introduced: boolean;
631
654
  /** Whether the rule reports invalid behavior, material risk, or an improvement. */
@@ -640,7 +663,10 @@ export interface DiagnosticRead {
640
663
  surfaces: Array<("api" | "sdk" | "cli" | "mcp") | (string & {})>;
641
664
  /** Whether remediation requires intent that the Spec cannot prove. */
642
665
  owner_decision_required: boolean;
643
- /** All affected coordinates, kept under one grouped diagnostic. */
666
+ /**
667
+ * The affected coordinates, kept under one grouped Diagnostic. With a filter, only the matching
668
+ * locations.
669
+ */
644
670
  locations: DiagnosticLocation[];
645
671
  fix?: DiagnosticFixRead;
646
672
  /**
@@ -778,21 +804,61 @@ export interface RepositoryDeliveryInput {
778
804
  }
779
805
  /** Response shape for RepositoryDeliveryInput. */
780
806
  export interface RepositoryDeliveryInputRead {
781
- type: "repository" | (string & {});
807
+ type: "repository";
782
808
  repository: RepositoryDeliverySettingsInputRead;
783
809
  }
784
810
  export interface HostedMcpDeliveryInput {
785
811
  type: "hosted_mcp";
786
812
  }
787
- /** Response shape for HostedMcpDeliveryInput. */
788
- export interface HostedMcpDeliveryInputRead {
789
- type: "hosted_mcp" | (string & {});
790
- }
791
813
  export type DeliveryInput = RepositoryDeliveryInput | HostedMcpDeliveryInput;
792
814
  /** Response shape for DeliveryInput. */
793
- export type DeliveryInputRead = RepositoryDeliveryInputRead | HostedMcpDeliveryInputRead | Record<string, unknown> & {
794
- type?: string;
795
- };
815
+ export type DeliveryInputRead = RepositoryDeliveryInputRead | HostedMcpDeliveryInput | UnknownVariant<"type">;
816
+ export interface RepositoryDeliveryCreateRequest {
817
+ target_id: TargetId;
818
+ type: "repository";
819
+ repository: RepositoryDeliverySettingsInput;
820
+ }
821
+ /** Response shape for RepositoryDeliveryCreateRequest. */
822
+ export interface RepositoryDeliveryCreateRequestRead {
823
+ target_id: TargetId;
824
+ type: "repository";
825
+ repository: RepositoryDeliverySettingsInputRead;
826
+ }
827
+ export interface HostedMcpDeliveryCreateRequest {
828
+ target_id: TargetId;
829
+ type: "hosted_mcp";
830
+ }
831
+ export type DeliveryCreateRequest = RepositoryDeliveryCreateRequest | HostedMcpDeliveryCreateRequest;
832
+ /** Response shape for DeliveryCreateRequest. */
833
+ export type DeliveryCreateRequestRead = RepositoryDeliveryCreateRequestRead | HostedMcpDeliveryCreateRequest | UnknownVariant<"type">;
834
+ export interface DeliveryUpdateRequest {
835
+ /**
836
+ * Replaces the complete repository settings, so omitted optional settings reset to their
837
+ * defaults. Only repository Deliveries have settings to update.
838
+ */
839
+ repository: RepositoryDeliverySettingsInput;
840
+ }
841
+ /** Response shape for DeliveryUpdateRequest. */
842
+ export interface DeliveryUpdateRequestRead {
843
+ /**
844
+ * Replaces the complete repository settings, so omitted optional settings reset to their
845
+ * defaults. Only repository Deliveries have settings to update.
846
+ */
847
+ repository: RepositoryDeliverySettingsInputRead;
848
+ }
849
+ export interface DeletedDelivery {
850
+ id: DeliveryId;
851
+ object: "delivery";
852
+ deleted: true;
853
+ request_id: RequestId;
854
+ }
855
+ /** Response shape for DeletedDelivery. */
856
+ export interface DeletedDeliveryRead {
857
+ id: DeliveryId;
858
+ object: "delivery" | (string & {});
859
+ deleted: true;
860
+ request_id: RequestId;
861
+ }
796
862
  export interface RepositoryDeliverySettings {
797
863
  provider: RepositoryProvider;
798
864
  identifier: RepositoryIdentifier;
@@ -846,7 +912,7 @@ export interface RepositoryDeliveryRead {
846
912
  id: DeliveryId;
847
913
  object: "delivery" | (string & {});
848
914
  target_id: TargetId;
849
- type: "repository" | (string & {});
915
+ type: "repository";
850
916
  /**
851
917
  * active: the repository accepts generated changes. action_required: inspect issues for the
852
918
  * correction. disabled: the Target is disabled and receives no changes.
@@ -915,7 +981,7 @@ export interface HostedMcpDeliveryRead {
915
981
  id: DeliveryId;
916
982
  object: "delivery" | (string & {});
917
983
  target_id: TargetId;
918
- type: "hosted_mcp" | (string & {});
984
+ type: "hosted_mcp";
919
985
  /**
920
986
  * active: the endpoint serves the Target's latest accepted package. disabled: the Target is
921
987
  * disabled and the endpoint is paused.
@@ -929,9 +995,7 @@ export interface HostedMcpDeliveryRead {
929
995
  }
930
996
  export type Delivery = RepositoryDelivery | HostedMcpDelivery;
931
997
  /** Response shape for Delivery. */
932
- export type DeliveryRead = RepositoryDeliveryRead | HostedMcpDeliveryRead | Record<string, unknown> & {
933
- type?: string;
934
- };
998
+ export type DeliveryRead = RepositoryDeliveryRead | HostedMcpDeliveryRead | UnknownVariant<"type">;
935
999
  /**
936
1000
  * repository is present for a repository Delivery, with issues, required_checks, and last_event;
937
1001
  * hosted_mcp is present for a hosted_mcp Delivery.
@@ -1013,7 +1077,6 @@ export interface TargetChecksRead {
1013
1077
  export interface TargetCreateRequest {
1014
1078
  project_id: ProjectId;
1015
1079
  name: string;
1016
- spec_id: SpecId;
1017
1080
  type: GeneratorKind;
1018
1081
  /** Default: "active" */
1019
1082
  status?: "active" | "disabled";
@@ -1031,7 +1094,6 @@ export interface TargetCreateRequest {
1031
1094
  export interface TargetCreateRequestRead {
1032
1095
  project_id: ProjectId;
1033
1096
  name: string;
1034
- spec_id: SpecId;
1035
1097
  type: GeneratorKind | (string & {});
1036
1098
  /** Default: "active" */
1037
1099
  status?: ("active" | "disabled") | (string & {});
@@ -1086,14 +1148,6 @@ export interface TargetUpdateRequest {
1086
1148
  * inheritance. Effective values merge over Project.config; GraphQL settings belong to the Spec.
1087
1149
  */
1088
1150
  config?: TargetConfig | null;
1089
- /**
1090
- * Replaces the Delivery set; include each kind you want to keep. Retained kinds preserve their
1091
- * ID, creation time, and hosted URL. Each supplied Delivery replaces its configuration, so
1092
- * omitted optional settings reset to their defaults. Omit deliveries to keep the existing set, or
1093
- * send [] to remove all Deliveries. Removing and later recreating a kind allocates a new ID and,
1094
- * for hosted_mcp, a new URL.
1095
- */
1096
- deliveries?: DeliveryInput[];
1097
1151
  }
1098
1152
  /** Response shape for TargetUpdateRequest. */
1099
1153
  export interface TargetUpdateRequestRead {
@@ -1106,14 +1160,6 @@ export interface TargetUpdateRequestRead {
1106
1160
  * inheritance. Effective values merge over Project.config; GraphQL settings belong to the Spec.
1107
1161
  */
1108
1162
  config?: TargetConfigRead | null;
1109
- /**
1110
- * Replaces the Delivery set; include each kind you want to keep. Retained kinds preserve their
1111
- * ID, creation time, and hosted URL. Each supplied Delivery replaces its configuration, so
1112
- * omitted optional settings reset to their defaults. Omit deliveries to keep the existing set, or
1113
- * send [] to remove all Deliveries. Removing and later recreating a kind allocates a new ID and,
1114
- * for hosted_mcp, a new URL.
1115
- */
1116
- deliveries?: DeliveryInputRead[];
1117
1163
  }
1118
1164
  /**
1119
1165
  * All Targets follow reviewed SemVer. Before 1.0.0, breaking changes require a minor version; the
@@ -1234,21 +1280,6 @@ export interface DeliveryListRead {
1234
1280
  next_cursor: string | null;
1235
1281
  request_id: RequestId;
1236
1282
  }
1237
- export interface PublicationList {
1238
- object: ListObject;
1239
- data: Publication[];
1240
- has_more: boolean;
1241
- next_cursor: string | null;
1242
- request_id: RequestId;
1243
- }
1244
- /** Response shape for PublicationList. */
1245
- export interface PublicationListRead {
1246
- object: ListObject;
1247
- data: PublicationRead[];
1248
- has_more: boolean;
1249
- next_cursor: string | null;
1250
- request_id: RequestId;
1251
- }
1252
1283
  export interface DraftList {
1253
1284
  object: ListObject;
1254
1285
  data: Draft[];
@@ -1296,7 +1327,8 @@ export interface Release {
1296
1327
  origin: "typeship" | "imported";
1297
1328
  /** Immutable package version released from this Target. */
1298
1329
  version: string;
1299
- channel: "stable" | "prerelease";
1330
+ /** The Target's release_channel when this version was released. */
1331
+ release_channel: "stable" | "prerelease";
1300
1332
  repository: RepositoryReferenceResponse | null;
1301
1333
  spec_revision_id: SpecRevisionId | null;
1302
1334
  /**
@@ -1326,9 +1358,19 @@ export interface Release {
1326
1358
  */
1327
1359
  imported_at: string | null;
1328
1360
  } | null;
1361
+ /**
1362
+ * One entry per destination Typeship has attempted to publish. Empty when publishing is off for
1363
+ * the Target's repository Delivery.
1364
+ */
1329
1365
  publications: Publication[];
1330
1366
  /** Format: date-time */
1331
1367
  created_at: string;
1368
+ /**
1369
+ * When a Publication of this release last changed. The version, commit, and checks never change
1370
+ * after the release is created.
1371
+ * Format: date-time
1372
+ */
1373
+ updated_at: string;
1332
1374
  request_id?: RequestId;
1333
1375
  }
1334
1376
  /** Response shape for Release. */
@@ -1341,7 +1383,8 @@ export interface ReleaseRead {
1341
1383
  origin: ("typeship" | "imported") | (string & {});
1342
1384
  /** Immutable package version released from this Target. */
1343
1385
  version: string;
1344
- channel: ("stable" | "prerelease") | (string & {});
1386
+ /** The Target's release_channel when this version was released. */
1387
+ release_channel: ("stable" | "prerelease") | (string & {});
1345
1388
  repository: RepositoryReferenceResponseRead | null;
1346
1389
  spec_revision_id: SpecRevisionId | null;
1347
1390
  /**
@@ -1371,9 +1414,19 @@ export interface ReleaseRead {
1371
1414
  */
1372
1415
  imported_at: string | null;
1373
1416
  } | null;
1417
+ /**
1418
+ * One entry per destination Typeship has attempted to publish. Empty when publishing is off for
1419
+ * the Target's repository Delivery.
1420
+ */
1374
1421
  publications: PublicationRead[];
1375
1422
  /** Format: date-time */
1376
1423
  created_at: string;
1424
+ /**
1425
+ * When a Publication of this release last changed. The version, commit, and checks never change
1426
+ * after the release is created.
1427
+ * Format: date-time
1428
+ */
1429
+ updated_at: string;
1377
1430
  request_id?: RequestId;
1378
1431
  }
1379
1432
  export type ReleaseResponse = Release & ResponseMetadata;
@@ -1394,12 +1447,20 @@ export interface ReleaseListRead {
1394
1447
  next_cursor: string | null;
1395
1448
  request_id: RequestId;
1396
1449
  }
1450
+ /** One destination's publishing progress for its Release. It has no ID; read it on the Release. */
1397
1451
  export interface Publication {
1398
- id: PublicationId;
1399
- object: "publication";
1400
- release_id: ReleaseId;
1401
- destination: "github" | "npm" | "pypi" | "go" | "mcp";
1402
- status: "pending" | "publishing" | "published" | "failed" | "disabled";
1452
+ /**
1453
+ * Where the release is published. github is the repository's GitHub Release; the others are
1454
+ * package registries.
1455
+ */
1456
+ type: "github" | "npm" | "pypi" | "go" | "mcp";
1457
+ /**
1458
+ * queued: the repository workflow has not started this destination; get the Publication or its
1459
+ * Release again. running: the workflow is publishing; get it again. completed: the package is
1460
+ * published at registry_url. failed: read errors, correct the cause, then retry the Release.
1461
+ * Lifecycle events are publication.running, publication.completed, and publication.failed.
1462
+ */
1463
+ status: "queued" | "running" | "completed" | "failed";
1403
1464
  attempt: number;
1404
1465
  /** Format: uri */
1405
1466
  run_url: string | null;
@@ -1421,11 +1482,18 @@ export interface Publication {
1421
1482
  }
1422
1483
  /** Response shape for Publication. */
1423
1484
  export interface PublicationRead {
1424
- id: PublicationId;
1425
- object: "publication" | (string & {});
1426
- release_id: ReleaseId;
1427
- destination: ("github" | "npm" | "pypi" | "go" | "mcp") | (string & {});
1428
- status: ("pending" | "publishing" | "published" | "failed" | "disabled") | (string & {});
1485
+ /**
1486
+ * Where the release is published. github is the repository's GitHub Release; the others are
1487
+ * package registries.
1488
+ */
1489
+ type: ("github" | "npm" | "pypi" | "go" | "mcp") | (string & {});
1490
+ /**
1491
+ * queued: the repository workflow has not started this destination; get the Publication or its
1492
+ * Release again. running: the workflow is publishing; get it again. completed: the package is
1493
+ * published at registry_url. failed: read errors, correct the cause, then retry the Release.
1494
+ * Lifecycle events are publication.running, publication.completed, and publication.failed.
1495
+ */
1496
+ status: ("queued" | "running" | "completed" | "failed") | (string & {});
1429
1497
  attempt: number;
1430
1498
  /** Format: uri */
1431
1499
  run_url: string | null;
@@ -1445,18 +1513,15 @@ export interface PublicationRead {
1445
1513
  /** Format: date-time */
1446
1514
  updated_at: string;
1447
1515
  }
1448
- export type PublicationResponse = Publication & ResponseMetadata;
1449
- /** Response shape for PublicationResponse. */
1450
- export type PublicationResponseRead = PublicationRead & ResponseMetadata;
1451
1516
  /**
1452
- * none: the open Draft has no pending change; generate the Target to start one. working: Typeship
1517
+ * idle: the open Draft has no pending change; generate the Target to start one. working: Typeship
1453
1518
  * is generating, carrying repository edits forward, applying decisions, or checking the Draft;
1454
1519
  * retrieve it again. action_required: use the typed reason to find the customer's next action.
1455
1520
  * ready: required checks passed on head_sha; merge the pull request. merged: the pull request
1456
1521
  * merged and the Draft is final; retrieve the Target for the draft_id of its next Draft.
1457
1522
  */
1458
1523
  export declare const DraftStatus: {
1459
- readonly NONE: "none";
1524
+ readonly IDLE: "idle";
1460
1525
  readonly WORKING: "working";
1461
1526
  readonly ACTION_REQUIRED: "action_required";
1462
1527
  readonly READY: "ready";
@@ -1465,8 +1530,8 @@ export declare const DraftStatus: {
1465
1530
  export type DraftStatus = (typeof DraftStatus)[keyof typeof DraftStatus];
1466
1531
  /**
1467
1532
  * conflict: resolve the listed files. checks_failed: correct failed package checks. review_failed:
1468
- * correct the Draft title, version, or other readiness finding. checks_unavailable: restore a
1469
- * required check. history_rewritten: review the affected files and approve recovery.
1533
+ * correct the Draft title or version. checks_unavailable: restore a required check.
1534
+ * history_rewritten: review the affected files and approve recovery.
1470
1535
  */
1471
1536
  export declare const DraftActionReason: {
1472
1537
  readonly CONFLICT: "conflict";
@@ -1491,64 +1556,49 @@ export interface DraftHistoryRecovery {
1491
1556
  /** Existing Draft branch that stays available after recovery opens a new Draft. */
1492
1557
  preserved_branch: string | null;
1493
1558
  }
1494
- /**
1495
- * Readiness decision for the Draft's head_sha. Null readiness on the Draft means no Draft has been
1496
- * generated.
1497
- */
1498
- export interface DraftReadiness {
1559
+ /** Comparison of the Draft's head_sha with the latest release. */
1560
+ export interface DraftCompatibility {
1561
+ /** API surface comparison. unknown means analysis is unavailable. */
1562
+ api: "compatible" | "breaking" | "unknown";
1499
1563
  /**
1500
- * success means required checks passed; failure means the Draft needs correction or review; error
1501
- * means assessment could not finish; pending means checks have not finished.
1564
+ * Package and supported SDK source comparison. unknown means analysis is incomplete or
1565
+ * unavailable.
1502
1566
  */
1503
- status: "success" | "failure" | "error" | "pending";
1504
- /** Human-readable explanation of the current decision. Do not parse it for control flow. */
1505
- description: string;
1506
- /** API surface comparison against the latest release. unknown means analysis is unavailable. */
1507
- compatibility_api: "compatible" | "breaking" | "unknown";
1567
+ package: "compatible" | "breaking" | "unknown";
1568
+ }
1569
+ /** Response shape for DraftCompatibility. */
1570
+ export interface DraftCompatibilityRead {
1571
+ /** API surface comparison. unknown means analysis is unavailable. */
1572
+ api: ("compatible" | "breaking" | "unknown") | (string & {});
1508
1573
  /**
1509
- * Package and supported SDK source comparison against the latest release. unknown means analysis
1510
- * is incomplete or unavailable.
1574
+ * Package and supported SDK source comparison. unknown means analysis is incomplete or
1575
+ * unavailable.
1511
1576
  */
1512
- compatibility_package: "compatible" | "breaking" | "unknown";
1513
- /** Whether the version satisfies the assessed change. Null when no verdict is available. */
1514
- version_correct: boolean | null;
1577
+ package: ("compatible" | "breaking" | "unknown") | (string & {});
1578
+ }
1579
+ /** How version_next relates to the assessed change. */
1580
+ export interface DraftVersion {
1515
1581
  /**
1516
1582
  * Minimum assessed version bump. Approval never waives an insufficient bump. Null when no bump
1517
1583
  * has been determined.
1518
1584
  */
1519
1585
  bump_required: "major" | "minor" | "patch" | null;
1586
+ /** Whether version_next satisfies the assessed change. Null when no verdict is available. */
1587
+ correct: boolean | null;
1520
1588
  /** Latest release version used for the comparison. Null before the first release. */
1521
- version_previous: string | null;
1522
- /** Draft title error that must be corrected before release. Null when none is recorded. */
1523
- title_error: string | null;
1589
+ previous: string | null;
1524
1590
  }
1525
- /** Response shape for DraftReadiness. */
1526
- export interface DraftReadinessRead {
1527
- /**
1528
- * success means required checks passed; failure means the Draft needs correction or review; error
1529
- * means assessment could not finish; pending means checks have not finished.
1530
- */
1531
- status: ("success" | "failure" | "error" | "pending") | (string & {});
1532
- /** Human-readable explanation of the current decision. Do not parse it for control flow. */
1533
- description: string;
1534
- /** API surface comparison against the latest release. unknown means analysis is unavailable. */
1535
- compatibility_api: ("compatible" | "breaking" | "unknown") | (string & {});
1536
- /**
1537
- * Package and supported SDK source comparison against the latest release. unknown means analysis
1538
- * is incomplete or unavailable.
1539
- */
1540
- compatibility_package: ("compatible" | "breaking" | "unknown") | (string & {});
1541
- /** Whether the version satisfies the assessed change. Null when no verdict is available. */
1542
- version_correct: boolean | null;
1591
+ /** Response shape for DraftVersion. */
1592
+ export interface DraftVersionRead {
1543
1593
  /**
1544
1594
  * Minimum assessed version bump. Approval never waives an insufficient bump. Null when no bump
1545
1595
  * has been determined.
1546
1596
  */
1547
1597
  bump_required: ("major" | "minor" | "patch" | null) | (string & {}) | null;
1598
+ /** Whether version_next satisfies the assessed change. Null when no verdict is available. */
1599
+ correct: boolean | null;
1548
1600
  /** Latest release version used for the comparison. Null before the first release. */
1549
- version_previous: string | null;
1550
- /** Draft title error that must be corrected before release. Null when none is recorded. */
1551
- title_error: string | null;
1601
+ previous: string | null;
1552
1602
  }
1553
1603
  /**
1554
1604
  * One reviewed package change for a Target. A Target has one open Draft, named by its draft_id;
@@ -1567,16 +1617,23 @@ export interface Draft {
1567
1617
  version_next: string | null;
1568
1618
  /** Where version_next was selected; null once the Draft merged. */
1569
1619
  version_source: "automatic" | "console" | "api" | "github" | null;
1570
- readiness: DraftReadiness | null;
1620
+ /** Null until the Draft has a generated change, and on a merged Draft. */
1621
+ compatibility: DraftCompatibility | null;
1622
+ /** Null until the Draft has a generated change, and on a merged Draft. */
1623
+ version: DraftVersion | null;
1624
+ /**
1625
+ * What blocks the Draft, one entry per finding, each with a code and suggested_action. Empty
1626
+ * unless status is action_required.
1627
+ */
1628
+ errors: ErrorDetail[];
1571
1629
  changes: {
1572
1630
  /** Cumulative changelog against the latest release. */
1573
1631
  changelog?: string | null;
1574
1632
  breaking_count?: number | null;
1575
- version_previous?: string | null;
1576
1633
  } | null;
1577
1634
  /**
1578
- * Draft commit that readiness, checks, and conflicts describe. Send it as expected_head_sha when
1579
- * resolving or discarding.
1635
+ * Draft commit that compatibility, version, checks, and conflicts describe. Send it as
1636
+ * expected_head_sha when resolving or discarding.
1580
1637
  */
1581
1638
  head_sha: string | null;
1582
1639
  /** The Draft pull request in the destination repository, or null before one is opened. */
@@ -1624,16 +1681,23 @@ export interface DraftRead {
1624
1681
  version_next: string | null;
1625
1682
  /** Where version_next was selected; null once the Draft merged. */
1626
1683
  version_source: ("automatic" | "console" | "api" | "github" | null) | (string & {}) | null;
1627
- readiness: DraftReadinessRead | null;
1684
+ /** Null until the Draft has a generated change, and on a merged Draft. */
1685
+ compatibility: DraftCompatibilityRead | null;
1686
+ /** Null until the Draft has a generated change, and on a merged Draft. */
1687
+ version: DraftVersionRead | null;
1688
+ /**
1689
+ * What blocks the Draft, one entry per finding, each with a code and suggested_action. Empty
1690
+ * unless status is action_required.
1691
+ */
1692
+ errors: ErrorDetailRead[];
1628
1693
  changes: {
1629
1694
  /** Cumulative changelog against the latest release. */
1630
1695
  changelog?: string | null;
1631
1696
  breaking_count?: number | null;
1632
- version_previous?: string | null;
1633
1697
  } | null;
1634
1698
  /**
1635
- * Draft commit that readiness, checks, and conflicts describe. Send it as expected_head_sha when
1636
- * resolving or discarding.
1699
+ * Draft commit that compatibility, version, checks, and conflicts describe. Send it as
1700
+ * expected_head_sha when resolving or discarding.
1637
1701
  */
1638
1702
  head_sha: string | null;
1639
1703
  /** The Draft pull request in the destination repository, or null before one is opened. */
@@ -1840,7 +1904,7 @@ export interface Project {
1840
1904
  * Format: date-time
1841
1905
  */
1842
1906
  updated_at: string;
1843
- request_id: RequestId;
1907
+ request_id?: RequestId;
1844
1908
  }
1845
1909
  /** Request shape for Project. */
1846
1910
  export interface ProjectWrite {
@@ -1856,7 +1920,7 @@ export interface ProjectWrite {
1856
1920
  * settings remain Spec-owned.
1857
1921
  */
1858
1922
  config: ProjectConfigResponse | null;
1859
- request_id: RequestId;
1923
+ request_id?: RequestId;
1860
1924
  }
1861
1925
  /** Response shape for Project. */
1862
1926
  export interface ProjectRead {
@@ -1881,35 +1945,13 @@ export interface ProjectRead {
1881
1945
  * Format: date-time
1882
1946
  */
1883
1947
  updated_at: string;
1884
- request_id: RequestId;
1885
- }
1886
- /**
1887
- * Lean Project identity returned by collection endpoints. Retrieve the Project for shared
1888
- * configuration and list its Targets for the complete canonical child collection.
1889
- */
1890
- export interface ProjectSummary {
1891
- id: ProjectId;
1892
- object: "project";
1893
- name: string;
1894
- spec_id: SpecId;
1895
- auto_generate: boolean;
1896
- /** Format: date-time */
1897
- created_at: string;
1898
- /** Format: date-time */
1899
- updated_at: string;
1900
- }
1901
- /** Response shape for ProjectSummary. */
1902
- export interface ProjectSummaryRead {
1903
- id: ProjectId;
1904
- object: "project" | (string & {});
1905
- name: string;
1906
- spec_id: SpecId;
1907
- auto_generate: boolean;
1908
- /** Format: date-time */
1909
- created_at: string;
1910
- /** Format: date-time */
1911
- updated_at: string;
1948
+ request_id?: RequestId;
1912
1949
  }
1950
+ export type ProjectResponse = Project & ResponseMetadata;
1951
+ /** Request shape for ProjectResponse. */
1952
+ export type ProjectResponseWrite = ProjectWrite & ResponseMetadata;
1953
+ /** Response shape for ProjectResponse. */
1954
+ export type ProjectResponseRead = ProjectRead & ResponseMetadata;
1913
1955
  export interface CreateProjectRequest {
1914
1956
  name: string;
1915
1957
  spec: SpecFields;
@@ -2127,6 +2169,24 @@ export interface AuthenticationConfig {
2127
2169
  approval_url?: string | null;
2128
2170
  /** Authentication selections keyed by generated API environment name. */
2129
2171
  environments?: Record<string, AuthenticationEnvironment> | null;
2172
+ /**
2173
+ * Environment variables the generated CLI, MCP server, and SDK environment fallbacks read, keyed
2174
+ * by security scheme name. A string names the token or key variable; a Basic scheme takes {
2175
+ * username, password }. Wins over the scheme's x-typeship-env extension. Without either, names
2176
+ * derive from the package and scheme.
2177
+ */
2178
+ credential_variables?: Record<string, string | {
2179
+ username: string;
2180
+ password: string;
2181
+ }> | null;
2182
+ /**
2183
+ * Whether a parameter carries the operation's credential, keyed by operationId, "METHOD /path",
2184
+ * or "*" for every operation, then by the parameter's wire name. true leaves the parameter out of
2185
+ * generated signatures, CLI flags, and MCP tool input, because the configured credential already
2186
+ * reaches the API; false keeps it. Wins over the parameter's x-typeship-credential extension and
2187
+ * the generator's inference.
2188
+ */
2189
+ credential_parameters?: Record<string, Record<string, boolean>> | null;
2130
2190
  }
2131
2191
  export interface TargetAuthenticationEnvironment {
2132
2192
  oauth_application?: string | null;
@@ -2338,6 +2398,13 @@ export interface ReadmeBehavior {
2338
2398
  * destination.
2339
2399
  */
2340
2400
  export interface PackageBehavior {
2401
+ /**
2402
+ * The API's name as generated READMEs, AGENTS.md, package descriptions, and help text show it,
2403
+ * such as "Parcel" for a Spec titled "Parcel - Public API". Display only: package, client, and
2404
+ * command names still come from the Spec. Defaults to the Spec title with common noise removed
2405
+ * ("Parcel - API" shows as Parcel).
2406
+ */
2407
+ title?: string | null;
2341
2408
  /** Homepage written into registry metadata. */
2342
2409
  homepage?: string | null;
2343
2410
  /** SPDX identifier written into registry metadata. Defaults to info.license. */
@@ -2365,6 +2432,16 @@ export interface Config {
2365
2432
  * are reported as generation warnings.
2366
2433
  */
2367
2434
  globals?: string[];
2435
+ /**
2436
+ * Generate only matching operations: tag names, or path globs such as `/zones/**` (`*` is one
2437
+ * path segment, `**` any number), optionally after an HTTP method (`DELETE /zones/*`). Applied
2438
+ * before the Spec size limit, with components nothing references any more removed, so a one-shot
2439
+ * run can generate part of a Spec up to 64 MB. Selectors that match nothing are reported as
2440
+ * generation warnings.
2441
+ */
2442
+ include?: string[];
2443
+ /** Leave out matching operations (tag names or path globs, as for `include`). Wins over `include`. */
2444
+ exclude?: string[];
2368
2445
  retries?: RetryTuning;
2369
2446
  /**
2370
2447
  * Per-operation pagination control, keyed by operationId or "METHOD /path". Unmatched keys are
@@ -2398,6 +2475,16 @@ export interface ConfigRead {
2398
2475
  * are reported as generation warnings.
2399
2476
  */
2400
2477
  globals?: string[];
2478
+ /**
2479
+ * Generate only matching operations: tag names, or path globs such as `/zones/**` (`*` is one
2480
+ * path segment, `**` any number), optionally after an HTTP method (`DELETE /zones/*`). Applied
2481
+ * before the Spec size limit, with components nothing references any more removed, so a one-shot
2482
+ * run can generate part of a Spec up to 64 MB. Selectors that match nothing are reported as
2483
+ * generation warnings.
2484
+ */
2485
+ include?: string[];
2486
+ /** Leave out matching operations (tag names or path globs, as for `include`). Wins over `include`. */
2487
+ exclude?: string[];
2401
2488
  retries?: RetryTuning;
2402
2489
  /**
2403
2490
  * Per-operation pagination control, keyed by operationId or "METHOD /path". Unmatched keys are
@@ -2436,6 +2523,16 @@ export interface ProjectConfig {
2436
2523
  * are reported as generation warnings.
2437
2524
  */
2438
2525
  globals?: string[];
2526
+ /**
2527
+ * Generate only matching operations: tag names, or path globs such as `/zones/**` (`*` is one
2528
+ * path segment, `**` any number), optionally after an HTTP method (`DELETE /zones/*`). Applied
2529
+ * before the Spec size limit, with components nothing references any more removed, so a one-shot
2530
+ * run can generate part of a Spec up to 64 MB. Selectors that match nothing are reported as
2531
+ * generation warnings.
2532
+ */
2533
+ include?: string[];
2534
+ /** Leave out matching operations (tag names or path globs, as for `include`). Wins over `include`. */
2535
+ exclude?: string[];
2439
2536
  retries?: RetryTuning;
2440
2537
  /**
2441
2538
  * Per-operation pagination control, keyed by operationId or "METHOD /path". Unmatched keys are
@@ -2468,6 +2565,16 @@ export interface ProjectConfigRead {
2468
2565
  * are reported as generation warnings.
2469
2566
  */
2470
2567
  globals?: string[];
2568
+ /**
2569
+ * Generate only matching operations: tag names, or path globs such as `/zones/**` (`*` is one
2570
+ * path segment, `**` any number), optionally after an HTTP method (`DELETE /zones/*`). Applied
2571
+ * before the Spec size limit, with components nothing references any more removed, so a one-shot
2572
+ * run can generate part of a Spec up to 64 MB. Selectors that match nothing are reported as
2573
+ * generation warnings.
2574
+ */
2575
+ include?: string[];
2576
+ /** Leave out matching operations (tag names or path globs, as for `include`). Wins over `include`. */
2577
+ exclude?: string[];
2471
2578
  retries?: RetryTuning;
2472
2579
  /**
2473
2580
  * Per-operation pagination control, keyed by operationId or "METHOD /path". Unmatched keys are
@@ -2504,6 +2611,16 @@ export interface TargetConfig {
2504
2611
  * are reported as generation warnings.
2505
2612
  */
2506
2613
  globals?: string[];
2614
+ /**
2615
+ * Generate only matching operations: tag names, or path globs such as `/zones/**` (`*` is one
2616
+ * path segment, `**` any number), optionally after an HTTP method (`DELETE /zones/*`). Applied
2617
+ * before the Spec size limit, with components nothing references any more removed, so a one-shot
2618
+ * run can generate part of a Spec up to 64 MB. Selectors that match nothing are reported as
2619
+ * generation warnings.
2620
+ */
2621
+ include?: string[];
2622
+ /** Leave out matching operations (tag names or path globs, as for `include`). Wins over `include`. */
2623
+ exclude?: string[];
2507
2624
  retries?: RetryTuning;
2508
2625
  /**
2509
2626
  * Per-operation pagination control, keyed by operationId or "METHOD /path". Unmatched keys are
@@ -2536,6 +2653,16 @@ export interface TargetConfigRead {
2536
2653
  * are reported as generation warnings.
2537
2654
  */
2538
2655
  globals?: string[];
2656
+ /**
2657
+ * Generate only matching operations: tag names, or path globs such as `/zones/**` (`*` is one
2658
+ * path segment, `**` any number), optionally after an HTTP method (`DELETE /zones/*`). Applied
2659
+ * before the Spec size limit, with components nothing references any more removed, so a one-shot
2660
+ * run can generate part of a Spec up to 64 MB. Selectors that match nothing are reported as
2661
+ * generation warnings.
2662
+ */
2663
+ include?: string[];
2664
+ /** Leave out matching operations (tag names or path globs, as for `include`). Wins over `include`. */
2665
+ exclude?: string[];
2539
2666
  retries?: RetryTuning;
2540
2667
  /**
2541
2668
  * Per-operation pagination control, keyed by operationId or "METHOD /path". Unmatched keys are
@@ -2579,14 +2706,16 @@ export interface GraphqlSettings {
2579
2706
  }>;
2580
2707
  /**
2581
2708
  * How requests authenticate. bearer sends Authorization: Bearer; basic is for key-pair APIs
2582
- * (public key as username, private key as password); api_key sends a header named by
2583
- * api_key_header; none generates no auth option.
2709
+ * (public key as username, private key as password); basic_api_key sends one API key as the
2710
+ * Basic-auth username with an empty password; api_key sends a header named by api_key_header;
2711
+ * api_key_or_bearer sends a key in api_key_header (Authorization for a raw key) and also accepts
2712
+ * an OAuth access token as Authorization: Bearer; none generates no auth option.
2584
2713
  * Default: "bearer"
2585
2714
  */
2586
- auth?: "bearer" | "basic" | "api_key" | "none";
2715
+ auth?: "bearer" | "basic" | "basic_api_key" | "api_key" | "api_key_or_bearer" | "none";
2587
2716
  /**
2588
- * Header carrying the key when auth is api_key. Required for that mode; Typeship does not invent
2589
- * a vendor-specific header name.
2717
+ * Header carrying the key when auth is api_key or api_key_or_bearer. Required for those modes;
2718
+ * Typeship does not invent a vendor-specific header name.
2590
2719
  */
2591
2720
  api_key_header?: string;
2592
2721
  /**
@@ -2599,6 +2728,20 @@ export interface GraphqlSettings {
2599
2728
  * generate as the language's untyped JSON value and produce a warning. Unmatched keys warn.
2600
2729
  */
2601
2730
  scalars?: Record<string, "string" | "integer" | "number" | "boolean" | "json">;
2731
+ /**
2732
+ * Object types that report a failure when an operation's union or interface result resolves to
2733
+ * them (errors returned as data). Replaces the default, which is every member whose name ends in
2734
+ * Error when the result can also be something else. An empty array treats no result as a failure.
2735
+ * Names that are not object types in the schema produce a generation warning.
2736
+ */
2737
+ error_types?: string[];
2738
+ /**
2739
+ * Page size a paginated connection call sends as first when the caller passes neither first nor
2740
+ * last. Relay servers such as GitHub reject a connection query without one. Ignored for a
2741
+ * connection whose first argument has a schema default.
2742
+ * Default: 100
2743
+ */
2744
+ page_size?: number;
2602
2745
  }
2603
2746
  /** Response shape for GraphqlSettings. */
2604
2747
  export interface GraphqlSettingsRead {
@@ -2619,14 +2762,16 @@ export interface GraphqlSettingsRead {
2619
2762
  }>;
2620
2763
  /**
2621
2764
  * How requests authenticate. bearer sends Authorization: Bearer; basic is for key-pair APIs
2622
- * (public key as username, private key as password); api_key sends a header named by
2623
- * api_key_header; none generates no auth option.
2765
+ * (public key as username, private key as password); basic_api_key sends one API key as the
2766
+ * Basic-auth username with an empty password; api_key sends a header named by api_key_header;
2767
+ * api_key_or_bearer sends a key in api_key_header (Authorization for a raw key) and also accepts
2768
+ * an OAuth access token as Authorization: Bearer; none generates no auth option.
2624
2769
  * Default: "bearer"
2625
2770
  */
2626
- auth?: ("bearer" | "basic" | "api_key" | "none") | (string & {});
2771
+ auth?: ("bearer" | "basic" | "basic_api_key" | "api_key" | "api_key_or_bearer" | "none") | (string & {});
2627
2772
  /**
2628
- * Header carrying the key when auth is api_key. Required for that mode; Typeship does not invent
2629
- * a vendor-specific header name.
2773
+ * Header carrying the key when auth is api_key or api_key_or_bearer. Required for those modes;
2774
+ * Typeship does not invent a vendor-specific header name.
2630
2775
  */
2631
2776
  api_key_header?: string;
2632
2777
  /**
@@ -2639,6 +2784,20 @@ export interface GraphqlSettingsRead {
2639
2784
  * generate as the language's untyped JSON value and produce a warning. Unmatched keys warn.
2640
2785
  */
2641
2786
  scalars?: Record<string, ("string" | "integer" | "number" | "boolean" | "json") | (string & {})>;
2787
+ /**
2788
+ * Object types that report a failure when an operation's union or interface result resolves to
2789
+ * them (errors returned as data). Replaces the default, which is every member whose name ends in
2790
+ * Error when the result can also be something else. An empty array treats no result as a failure.
2791
+ * Names that are not object types in the schema produce a generation warning.
2792
+ */
2793
+ error_types?: string[];
2794
+ /**
2795
+ * Page size a paginated connection call sends as first when the caller passes neither first nor
2796
+ * last. Relay servers such as GitHub reject a connection query without one. Ignored for a
2797
+ * connection whose first argument has a schema default.
2798
+ * Default: 100
2799
+ */
2800
+ page_size?: number;
2642
2801
  }
2643
2802
  /**
2644
2803
  * Retry behavior. Top-level fields adjust every operation; operations maps operationId or "METHOD
@@ -2683,17 +2842,6 @@ export interface PaginationRuleRead {
2683
2842
  offset_param?: string;
2684
2843
  limit_param?: string;
2685
2844
  }
2686
- export interface FileStub {
2687
- path: string;
2688
- bytes: number;
2689
- mode: "100644" | "100755";
2690
- }
2691
- /** Response shape for FileStub. */
2692
- export interface FileStubRead {
2693
- path: string;
2694
- bytes: number;
2695
- mode: ("100644" | "100755") | (string & {});
2696
- }
2697
2845
  /**
2698
2846
  * A Generation moves from queued to running, then completes when its files are saved or fails.
2699
2847
  * Delivery and Draft status are separate.
@@ -2800,49 +2948,27 @@ export interface GenerationRead {
2800
2948
  /** Format: date-time */
2801
2949
  updated_at: string;
2802
2950
  }
2803
- /** Generation metadata returned by collection endpoints. */
2804
- export type GenerationSummary = Generation;
2805
- /** Request shape for GenerationSummary. */
2806
- export type GenerationSummaryWrite = GenerationWrite;
2807
- /** Response shape for GenerationSummary. */
2808
- export type GenerationSummaryRead = GenerationRead;
2809
2951
  export type GenerationResponse = Generation & ResponseMetadata;
2810
2952
  /** Request shape for GenerationResponse. */
2811
2953
  export type GenerationResponseWrite = GenerationWrite & ResponseMetadata;
2812
2954
  /** Response shape for GenerationResponse. */
2813
2955
  export type GenerationResponseRead = GenerationRead & ResponseMetadata;
2814
- /** A selected target that did not generate in a multi-target run. */
2815
- export interface GenerationFailure {
2816
- target_id: TargetId;
2817
- type: GeneratorKind;
2818
- status: "failed";
2819
- /** Recorded failures. Empty when this resource has no recorded failure. */
2820
- errors: DomainError[];
2821
- }
2822
- /** Response shape for GenerationFailure. */
2823
- export interface GenerationFailureRead {
2824
- target_id: TargetId;
2825
- type: GeneratorKind | (string & {});
2826
- status: "failed" | (string & {});
2827
- /** Recorded failures. Empty when this resource has no recorded failure. */
2828
- errors: DomainErrorRead[];
2829
- }
2830
2956
  /**
2831
2957
  * One Generation per selected Target. Retrieve each Generation for current status and generated
2832
2958
  * files.
2833
2959
  */
2834
2960
  export interface GenerationBatch {
2835
- data: GenerationSummary[];
2961
+ data: Generation[];
2836
2962
  request_id: RequestId;
2837
2963
  }
2838
2964
  /** Request shape for GenerationBatch. */
2839
2965
  export interface GenerationBatchWrite {
2840
- data: GenerationSummaryWrite[];
2966
+ data: GenerationWrite[];
2841
2967
  request_id: RequestId;
2842
2968
  }
2843
2969
  /** Response shape for GenerationBatch. */
2844
2970
  export interface GenerationBatchRead {
2845
- data: GenerationSummaryRead[];
2971
+ data: GenerationRead[];
2846
2972
  request_id: RequestId;
2847
2973
  }
2848
2974
  export interface ApiKey {
@@ -2851,7 +2977,11 @@ export interface ApiKey {
2851
2977
  name: string;
2852
2978
  /** Last four characters of the secret; the secret itself is never stored. */
2853
2979
  last4: string;
2854
- revoked: boolean;
2980
+ /**
2981
+ * active: the key authenticates requests. revoked: it no longer does and cannot be restored;
2982
+ * create a new key in the Console or with typeship login.
2983
+ */
2984
+ status: "active" | "revoked";
2855
2985
  /** Format: date-time */
2856
2986
  last_used_at: string | null;
2857
2987
  /** Format: date-time */
@@ -2870,7 +3000,11 @@ export interface ApiKeyRead {
2870
3000
  name: string;
2871
3001
  /** Last four characters of the secret; the secret itself is never stored. */
2872
3002
  last4: string;
2873
- revoked: boolean;
3003
+ /**
3004
+ * active: the key authenticates requests. revoked: it no longer does and cannot be restored;
3005
+ * create a new key in the Console or with typeship login.
3006
+ */
3007
+ status: ("active" | "revoked") | (string & {});
2874
3008
  /** Format: date-time */
2875
3009
  last_used_at: string | null;
2876
3010
  /** Format: date-time */
@@ -2892,14 +3026,6 @@ export interface UrlSpecRevisionSource {
2892
3026
  url: string;
2893
3027
  };
2894
3028
  }
2895
- /** Response shape for UrlSpecRevisionSource. */
2896
- export interface UrlSpecRevisionSourceRead {
2897
- type: "url" | (string & {});
2898
- url: {
2899
- /** Format: uri */
2900
- url: string;
2901
- };
2902
- }
2903
3029
  export interface RepositorySpecRevisionSource {
2904
3030
  type: "repository";
2905
3031
  repository: {
@@ -2915,7 +3041,7 @@ export interface RepositorySpecRevisionSource {
2915
3041
  }
2916
3042
  /** Response shape for RepositorySpecRevisionSource. */
2917
3043
  export interface RepositorySpecRevisionSourceRead {
2918
- type: "repository" | (string & {});
3044
+ type: "repository";
2919
3045
  repository: {
2920
3046
  provider: RepositoryProvider | (string & {});
2921
3047
  identifier: RepositoryIdentifier;
@@ -2929,9 +3055,7 @@ export interface RepositorySpecRevisionSourceRead {
2929
3055
  }
2930
3056
  export type SpecRevisionSource = UrlSpecRevisionSource | RepositorySpecRevisionSource;
2931
3057
  /** Response shape for SpecRevisionSource. */
2932
- export type SpecRevisionSourceRead = UrlSpecRevisionSourceRead | RepositorySpecRevisionSourceRead | Record<string, unknown> & {
2933
- type?: string;
2934
- };
3058
+ export type SpecRevisionSourceRead = UrlSpecRevisionSource | RepositorySpecRevisionSourceRead | UnknownVariant<"type">;
2935
3059
  export interface SpecRevision {
2936
3060
  id: SpecRevisionId;
2937
3061
  object: "spec_revision";
@@ -2990,7 +3114,17 @@ export type SpecRevisionResponse = SpecRevision & ResponseMetadata;
2990
3114
  export type SpecRevisionResponseRead = SpecRevisionRead & ResponseMetadata;
2991
3115
  export interface ProjectList {
2992
3116
  object: ListObject;
2993
- data: ProjectSummary[];
3117
+ data: Project[];
3118
+ /** Whether another page is available after this one. */
3119
+ has_more: boolean;
3120
+ /** Pass this value as cursor to retrieve the next page; null on the last page. */
3121
+ next_cursor: string | null;
3122
+ request_id: RequestId;
3123
+ }
3124
+ /** Request shape for ProjectList. */
3125
+ export interface ProjectListWrite {
3126
+ object: ListObject;
3127
+ data: ProjectWrite[];
2994
3128
  /** Whether another page is available after this one. */
2995
3129
  has_more: boolean;
2996
3130
  /** Pass this value as cursor to retrieve the next page; null on the last page. */
@@ -3000,7 +3134,7 @@ export interface ProjectList {
3000
3134
  /** Response shape for ProjectList. */
3001
3135
  export interface ProjectListRead {
3002
3136
  object: ListObject;
3003
- data: ProjectSummaryRead[];
3137
+ data: ProjectRead[];
3004
3138
  /** Whether another page is available after this one. */
3005
3139
  has_more: boolean;
3006
3140
  /** Pass this value as cursor to retrieve the next page; null on the last page. */
@@ -3009,7 +3143,7 @@ export interface ProjectListRead {
3009
3143
  }
3010
3144
  export interface GenerationList {
3011
3145
  object: ListObject;
3012
- data: GenerationSummary[];
3146
+ data: Generation[];
3013
3147
  /** Whether another page is available after this one. */
3014
3148
  has_more: boolean;
3015
3149
  /** Pass this value as cursor to retrieve the next page; null on the last page. */
@@ -3019,7 +3153,7 @@ export interface GenerationList {
3019
3153
  /** Request shape for GenerationList. */
3020
3154
  export interface GenerationListWrite {
3021
3155
  object: ListObject;
3022
- data: GenerationSummaryWrite[];
3156
+ data: GenerationWrite[];
3023
3157
  /** Whether another page is available after this one. */
3024
3158
  has_more: boolean;
3025
3159
  /** Pass this value as cursor to retrieve the next page; null on the last page. */
@@ -3029,7 +3163,7 @@ export interface GenerationListWrite {
3029
3163
  /** Response shape for GenerationList. */
3030
3164
  export interface GenerationListRead {
3031
3165
  object: ListObject;
3032
- data: GenerationSummaryRead[];
3166
+ data: GenerationRead[];
3033
3167
  /** Whether another page is available after this one. */
3034
3168
  has_more: boolean;
3035
3169
  /** Pass this value as cursor to retrieve the next page; null on the last page. */
@@ -3119,6 +3253,13 @@ export type ErrorType = (typeof ErrorType)[keyof typeof ErrorType];
3119
3253
  /** Stable programmatic identifier. Do not branch on message. */
3120
3254
  export declare const ErrorCode: {
3121
3255
  readonly INPUT_INVALID: "input_invalid";
3256
+ readonly INPUT_MISSING: "input_missing";
3257
+ readonly INPUT_TYPE_INVALID: "input_type_invalid";
3258
+ readonly INPUT_FORMAT_INVALID: "input_format_invalid";
3259
+ readonly INPUT_TOO_LONG: "input_too_long";
3260
+ readonly INPUT_TOO_SHORT: "input_too_short";
3261
+ readonly INPUT_DUPLICATE: "input_duplicate";
3262
+ readonly INPUT_UNKNOWN: "input_unknown";
3122
3263
  readonly QUERY_PARAM_INVALID: "query_param_invalid";
3123
3264
  readonly CURSOR_INVALID: "cursor_invalid";
3124
3265
  readonly METHOD_NOT_ALLOWED: "method_not_allowed";
@@ -3133,7 +3274,8 @@ export declare const ErrorCode: {
3133
3274
  readonly INSUFFICIENT_SCOPE: "insufficient_scope";
3134
3275
  readonly ROLE_INSUFFICIENT: "role_insufficient";
3135
3276
  readonly RATE_LIMIT_EXCEEDED: "rate_limit_exceeded";
3136
- readonly PLAN_LIMIT_REACHED: "plan_limit_reached";
3277
+ readonly FEATURE_NOT_AVAILABLE: "feature_not_available";
3278
+ readonly QUOTA_EXCEEDED: "quota_exceeded";
3137
3279
  readonly SPEC_INVALID: "spec_invalid";
3138
3280
  readonly SPEC_TOO_LARGE: "spec_too_large";
3139
3281
  readonly SPEC_UNREACHABLE: "spec_unreachable";
@@ -3156,8 +3298,11 @@ export declare const ErrorCode: {
3156
3298
  readonly PUBLICATION_RECOVERY_UNAVAILABLE: "publication_recovery_unavailable";
3157
3299
  readonly PUBLICATION_FAILED: "publication_failed";
3158
3300
  readonly DELIVERY_CONFLICT: "delivery_conflict";
3301
+ readonly DELIVERY_EXISTS: "delivery_exists";
3159
3302
  readonly RESOURCE_HAS_DEPENDENCIES: "resource_has_dependencies";
3160
3303
  readonly CUSTOMIZATION_CONFLICT: "customization_conflict";
3304
+ readonly CHECKS_FAILED: "checks_failed";
3305
+ readonly DRAFT_TITLE_INVALID: "draft_title_invalid";
3161
3306
  readonly HISTORY_RECOVERY_REQUIRED: "history_recovery_required";
3162
3307
  readonly CHECKS_UNAVAILABLE: "checks_unavailable";
3163
3308
  readonly DEPENDENCY_MISSING: "dependency_missing";
@@ -3480,6 +3625,24 @@ export interface AuthenticationConfigResponse {
3480
3625
  approval_url?: string | null;
3481
3626
  /** Authentication selections keyed by generated API environment name. */
3482
3627
  environments?: Record<string, AuthenticationEnvironmentResponse> | null;
3628
+ /**
3629
+ * Environment variables the generated CLI, MCP server, and SDK environment fallbacks read, keyed
3630
+ * by security scheme name. A string names the token or key variable; a Basic scheme takes {
3631
+ * username, password }. Wins over the scheme's x-typeship-env extension. Without either, names
3632
+ * derive from the package and scheme.
3633
+ */
3634
+ credential_variables?: Record<string, string | {
3635
+ username: string;
3636
+ password: string;
3637
+ }> | null;
3638
+ /**
3639
+ * Whether a parameter carries the operation's credential, keyed by operationId, "METHOD /path",
3640
+ * or "*" for every operation, then by the parameter's wire name. true leaves the parameter out of
3641
+ * generated signatures, CLI flags, and MCP tool input, because the configured credential already
3642
+ * reaches the API; false keeps it. Wins over the parameter's x-typeship-credential extension and
3643
+ * the generator's inference.
3644
+ */
3645
+ credential_parameters?: Record<string, Record<string, boolean>> | null;
3483
3646
  }
3484
3647
  export interface TargetAuthenticationEnvironmentResponse {
3485
3648
  oauth_application?: string | null;
@@ -3691,6 +3854,13 @@ export interface ReadmeBehaviorResponse {
3691
3854
  * destination.
3692
3855
  */
3693
3856
  export interface PackageBehaviorResponse {
3857
+ /**
3858
+ * The API's name as generated READMEs, AGENTS.md, package descriptions, and help text show it,
3859
+ * such as "Parcel" for a Spec titled "Parcel - Public API". Display only: package, client, and
3860
+ * command names still come from the Spec. Defaults to the Spec title with common noise removed
3861
+ * ("Parcel - API" shows as Parcel).
3862
+ */
3863
+ title?: string | null;
3694
3864
  /** Homepage written into registry metadata. */
3695
3865
  homepage?: string | null;
3696
3866
  /** SPDX identifier written into registry metadata. Defaults to info.license. */
@@ -3705,77 +3875,6 @@ export interface PackageBehaviorResponse {
3705
3875
  /** Go identifier when the destination repository name is unsuitable. */
3706
3876
  go_package_name?: string | null;
3707
3877
  }
3708
- /**
3709
- * Everything Typeship needs beyond the Spec, in one object: generation customization (globals,
3710
- * retries, pagination, readme) and how the generated tooling behaves (cli, mcp, package, docs_url).
3711
- * Plain configuration. Typeship never requires vendor extensions inside the Spec itself. One-shot
3712
- * generation also accepts GraphQL settings here; stored projects keep those settings on their Spec.
3713
- */
3714
- export interface ConfigResponse {
3715
- /**
3716
- * Wire names of query/header parameters that become settable once on the generated client and
3717
- * auto-apply to every operation that accepts them; per-call values win. Names that match nothing
3718
- * are reported as generation warnings.
3719
- */
3720
- globals?: string[];
3721
- retries?: RetryTuningResponse;
3722
- /**
3723
- * Per-operation pagination control, keyed by operationId or "METHOD /path". Unmatched keys are
3724
- * reported as generation warnings.
3725
- */
3726
- pagination?: Record<string, PaginationRuleResponse | boolean>;
3727
- graphql?: GraphqlSettingsResponse;
3728
- auth?: AuthenticationConfigResponse;
3729
- cli?: CliBehaviorResponse;
3730
- mcp?: McpBehaviorResponse;
3731
- readme?: ReadmeBehaviorResponse;
3732
- package?: PackageBehaviorResponse;
3733
- /**
3734
- * The API's documentation site. Read through its llms.txt by the generated CLI's docs command,
3735
- * the MCP server's docs tools, and the package's AGENTS.md. Defaults to the Spec's externalDocs
3736
- * URL.
3737
- * Format: uri
3738
- */
3739
- docs_url?: string | null;
3740
- /**
3741
- * Exact llms.txt URL when the documentation site does not publish it at docs_url + /llms.txt.
3742
- * Format: uri
3743
- */
3744
- docs_index_url?: string | null;
3745
- }
3746
- /** Response shape for ConfigResponse. */
3747
- export interface ConfigResponseRead {
3748
- /**
3749
- * Wire names of query/header parameters that become settable once on the generated client and
3750
- * auto-apply to every operation that accepts them; per-call values win. Names that match nothing
3751
- * are reported as generation warnings.
3752
- */
3753
- globals?: string[];
3754
- retries?: RetryTuningResponse;
3755
- /**
3756
- * Per-operation pagination control, keyed by operationId or "METHOD /path". Unmatched keys are
3757
- * reported as generation warnings.
3758
- */
3759
- pagination?: Record<string, PaginationRuleResponseRead | boolean>;
3760
- graphql?: GraphqlSettingsResponseRead;
3761
- auth?: AuthenticationConfigResponse;
3762
- cli?: CliBehaviorResponse;
3763
- mcp?: McpBehaviorResponseRead;
3764
- readme?: ReadmeBehaviorResponse;
3765
- package?: PackageBehaviorResponse;
3766
- /**
3767
- * The API's documentation site. Read through its llms.txt by the generated CLI's docs command,
3768
- * the MCP server's docs tools, and the package's AGENTS.md. Defaults to the Spec's externalDocs
3769
- * URL.
3770
- * Format: uri
3771
- */
3772
- docs_url?: string | null;
3773
- /**
3774
- * Exact llms.txt URL when the documentation site does not publish it at docs_url + /llms.txt.
3775
- * Format: uri
3776
- */
3777
- docs_index_url?: string | null;
3778
- }
3779
3878
  /**
3780
3879
  * Shared generated-client and tooling behavior for a stored Project. Every Target inherits these
3781
3880
  * defaults. Target.config is merged over them for one Target; top-level values replace defaults
@@ -3789,6 +3888,16 @@ export interface ProjectConfigResponse {
3789
3888
  * are reported as generation warnings.
3790
3889
  */
3791
3890
  globals?: string[];
3891
+ /**
3892
+ * Generate only matching operations: tag names, or path globs such as `/zones/**` (`*` is one
3893
+ * path segment, `**` any number), optionally after an HTTP method (`DELETE /zones/*`). Applied
3894
+ * before the Spec size limit, with components nothing references any more removed, so a one-shot
3895
+ * run can generate part of a Spec up to 64 MB. Selectors that match nothing are reported as
3896
+ * generation warnings.
3897
+ */
3898
+ include?: string[];
3899
+ /** Leave out matching operations (tag names or path globs, as for `include`). Wins over `include`. */
3900
+ exclude?: string[];
3792
3901
  retries?: RetryTuningResponse;
3793
3902
  /**
3794
3903
  * Per-operation pagination control, keyed by operationId or "METHOD /path". Unmatched keys are
@@ -3821,6 +3930,16 @@ export interface ProjectConfigResponseRead {
3821
3930
  * are reported as generation warnings.
3822
3931
  */
3823
3932
  globals?: string[];
3933
+ /**
3934
+ * Generate only matching operations: tag names, or path globs such as `/zones/**` (`*` is one
3935
+ * path segment, `**` any number), optionally after an HTTP method (`DELETE /zones/*`). Applied
3936
+ * before the Spec size limit, with components nothing references any more removed, so a one-shot
3937
+ * run can generate part of a Spec up to 64 MB. Selectors that match nothing are reported as
3938
+ * generation warnings.
3939
+ */
3940
+ include?: string[];
3941
+ /** Leave out matching operations (tag names or path globs, as for `include`). Wins over `include`. */
3942
+ exclude?: string[];
3824
3943
  retries?: RetryTuningResponse;
3825
3944
  /**
3826
3945
  * Per-operation pagination control, keyed by operationId or "METHOD /path". Unmatched keys are
@@ -3857,6 +3976,16 @@ export interface TargetConfigResponse {
3857
3976
  * are reported as generation warnings.
3858
3977
  */
3859
3978
  globals?: string[];
3979
+ /**
3980
+ * Generate only matching operations: tag names, or path globs such as `/zones/**` (`*` is one
3981
+ * path segment, `**` any number), optionally after an HTTP method (`DELETE /zones/*`). Applied
3982
+ * before the Spec size limit, with components nothing references any more removed, so a one-shot
3983
+ * run can generate part of a Spec up to 64 MB. Selectors that match nothing are reported as
3984
+ * generation warnings.
3985
+ */
3986
+ include?: string[];
3987
+ /** Leave out matching operations (tag names or path globs, as for `include`). Wins over `include`. */
3988
+ exclude?: string[];
3860
3989
  retries?: RetryTuningResponse;
3861
3990
  /**
3862
3991
  * Per-operation pagination control, keyed by operationId or "METHOD /path". Unmatched keys are
@@ -3889,6 +4018,16 @@ export interface TargetConfigResponseRead {
3889
4018
  * are reported as generation warnings.
3890
4019
  */
3891
4020
  globals?: string[];
4021
+ /**
4022
+ * Generate only matching operations: tag names, or path globs such as `/zones/**` (`*` is one
4023
+ * path segment, `**` any number), optionally after an HTTP method (`DELETE /zones/*`). Applied
4024
+ * before the Spec size limit, with components nothing references any more removed, so a one-shot
4025
+ * run can generate part of a Spec up to 64 MB. Selectors that match nothing are reported as
4026
+ * generation warnings.
4027
+ */
4028
+ include?: string[];
4029
+ /** Leave out matching operations (tag names or path globs, as for `include`). Wins over `include`. */
4030
+ exclude?: string[];
3892
4031
  retries?: RetryTuningResponse;
3893
4032
  /**
3894
4033
  * Per-operation pagination control, keyed by operationId or "METHOD /path". Unmatched keys are
@@ -3932,14 +4071,16 @@ export interface GraphqlSettingsResponse {
3932
4071
  }>;
3933
4072
  /**
3934
4073
  * How requests authenticate. bearer sends Authorization: Bearer; basic is for key-pair APIs
3935
- * (public key as username, private key as password); api_key sends a header named by
3936
- * api_key_header; none generates no auth option.
4074
+ * (public key as username, private key as password); basic_api_key sends one API key as the
4075
+ * Basic-auth username with an empty password; api_key sends a header named by api_key_header;
4076
+ * api_key_or_bearer sends a key in api_key_header (Authorization for a raw key) and also accepts
4077
+ * an OAuth access token as Authorization: Bearer; none generates no auth option.
3937
4078
  * Default: "bearer"
3938
4079
  */
3939
- auth?: "bearer" | "basic" | "api_key" | "none";
4080
+ auth?: "bearer" | "basic" | "basic_api_key" | "api_key" | "api_key_or_bearer" | "none";
3940
4081
  /**
3941
- * Header carrying the key when auth is api_key. Required for that mode; Typeship does not invent
3942
- * a vendor-specific header name.
4082
+ * Header carrying the key when auth is api_key or api_key_or_bearer. Required for those modes;
4083
+ * Typeship does not invent a vendor-specific header name.
3943
4084
  */
3944
4085
  api_key_header?: string;
3945
4086
  /**
@@ -3952,6 +4093,20 @@ export interface GraphqlSettingsResponse {
3952
4093
  * generate as the language's untyped JSON value and produce a warning. Unmatched keys warn.
3953
4094
  */
3954
4095
  scalars?: Record<string, "string" | "integer" | "number" | "boolean" | "json">;
4096
+ /**
4097
+ * Object types that report a failure when an operation's union or interface result resolves to
4098
+ * them (errors returned as data). Replaces the default, which is every member whose name ends in
4099
+ * Error when the result can also be something else. An empty array treats no result as a failure.
4100
+ * Names that are not object types in the schema produce a generation warning.
4101
+ */
4102
+ error_types?: string[];
4103
+ /**
4104
+ * Page size a paginated connection call sends as first when the caller passes neither first nor
4105
+ * last. Relay servers such as GitHub reject a connection query without one. Ignored for a
4106
+ * connection whose first argument has a schema default.
4107
+ * Default: 100
4108
+ */
4109
+ page_size?: number;
3955
4110
  }
3956
4111
  /** Response shape for GraphqlSettingsResponse. */
3957
4112
  export interface GraphqlSettingsResponseRead {
@@ -3972,14 +4127,16 @@ export interface GraphqlSettingsResponseRead {
3972
4127
  }>;
3973
4128
  /**
3974
4129
  * How requests authenticate. bearer sends Authorization: Bearer; basic is for key-pair APIs
3975
- * (public key as username, private key as password); api_key sends a header named by
3976
- * api_key_header; none generates no auth option.
4130
+ * (public key as username, private key as password); basic_api_key sends one API key as the
4131
+ * Basic-auth username with an empty password; api_key sends a header named by api_key_header;
4132
+ * api_key_or_bearer sends a key in api_key_header (Authorization for a raw key) and also accepts
4133
+ * an OAuth access token as Authorization: Bearer; none generates no auth option.
3977
4134
  * Default: "bearer"
3978
4135
  */
3979
- auth?: ("bearer" | "basic" | "api_key" | "none") | (string & {});
4136
+ auth?: ("bearer" | "basic" | "basic_api_key" | "api_key" | "api_key_or_bearer" | "none") | (string & {});
3980
4137
  /**
3981
- * Header carrying the key when auth is api_key. Required for that mode; Typeship does not invent
3982
- * a vendor-specific header name.
4138
+ * Header carrying the key when auth is api_key or api_key_or_bearer. Required for those modes;
4139
+ * Typeship does not invent a vendor-specific header name.
3983
4140
  */
3984
4141
  api_key_header?: string;
3985
4142
  /**
@@ -3992,6 +4149,20 @@ export interface GraphqlSettingsResponseRead {
3992
4149
  * generate as the language's untyped JSON value and produce a warning. Unmatched keys warn.
3993
4150
  */
3994
4151
  scalars?: Record<string, ("string" | "integer" | "number" | "boolean" | "json") | (string & {})>;
4152
+ /**
4153
+ * Object types that report a failure when an operation's union or interface result resolves to
4154
+ * them (errors returned as data). Replaces the default, which is every member whose name ends in
4155
+ * Error when the result can also be something else. An empty array treats no result as a failure.
4156
+ * Names that are not object types in the schema produce a generation warning.
4157
+ */
4158
+ error_types?: string[];
4159
+ /**
4160
+ * Page size a paginated connection call sends as first when the caller passes neither first nor
4161
+ * last. Relay servers such as GitHub reject a connection query without one. Ignored for a
4162
+ * connection whose first argument has a schema default.
4163
+ * Default: 100
4164
+ */
4165
+ page_size?: number;
3995
4166
  }
3996
4167
  /**
3997
4168
  * Retry behavior. Top-level fields adjust every operation; operations maps operationId or "METHOD
@@ -4052,18 +4223,6 @@ export declare const GitFileMode: {
4052
4223
  readonly V_120000: "120000";
4053
4224
  };
4054
4225
  export type GitFileMode = (typeof GitFileMode)[keyof typeof GitFileMode];
4055
- /**
4056
- * One side of a Draft file comparison: base is the last merged version, yours is your repository
4057
- * edit, and generated is the new version Typeship proposes for this conflict stage. The conflict
4058
- * source identifies whether that version comes from a Generation, the default branch, or a saved
4059
- * Draft. Missing sides represent deleted or absent files.
4060
- */
4061
- export declare const DraftFileSide: {
4062
- readonly BASE: "base";
4063
- readonly YOURS: "yours";
4064
- readonly GENERATED: "generated";
4065
- };
4066
- export type DraftFileSide = (typeof DraftFileSide)[keyof typeof DraftFileSide];
4067
4226
  /**
4068
4227
  * File IDs for each side of a conflict or history comparison. null means the file is absent on that
4069
4228
  * side.
@@ -4272,4 +4431,5 @@ export interface DraftRecoverRequest {
4272
4431
  /** The Draft's history_recovery.head_sha; null when the Draft branch is absent. */
4273
4432
  expected_head_sha: string | null;
4274
4433
  }
4434
+ export {};
4275
4435
  //# sourceMappingURL=types.d.ts.map