@vercel/sdk 1.16.0 → 1.16.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.
Files changed (191) hide show
  1. package/README.md +39 -37
  2. package/bin/mcp-server.js +1263 -912
  3. package/bin/mcp-server.js.map +42 -39
  4. package/docs/sdks/logdrains/README.md +7 -7
  5. package/docs/sdks/projects/README.md +78 -0
  6. package/docs/sdks/teams/README.md +1 -1
  7. package/esm/__tests__/accessgroups.test.js +6 -2
  8. package/esm/__tests__/accessgroups.test.js.map +1 -1
  9. package/esm/__tests__/domains.test.js +5 -5
  10. package/esm/__tests__/domains.test.js.map +1 -1
  11. package/esm/__tests__/edgeconfig.test.js +6 -6
  12. package/esm/__tests__/edgeconfig.test.js.map +1 -1
  13. package/esm/__tests__/integrations.test.js +1 -1
  14. package/esm/__tests__/logdrains.test.js +4 -4
  15. package/esm/__tests__/logdrains.test.js.map +1 -1
  16. package/esm/__tests__/projects.test.js +17 -0
  17. package/esm/__tests__/projects.test.js.map +1 -1
  18. package/esm/__tests__/rollingrelease.test.js +2 -7
  19. package/esm/__tests__/rollingrelease.test.js.map +1 -1
  20. package/esm/__tests__/security.test.js +1 -11
  21. package/esm/__tests__/security.test.js.map +1 -1
  22. package/esm/funcs/logDrainsCreateConfigurableLogDrain.d.ts +1 -1
  23. package/esm/funcs/logDrainsCreateConfigurableLogDrain.js +1 -1
  24. package/esm/funcs/logDrainsCreateLogDrain.d.ts +1 -1
  25. package/esm/funcs/logDrainsCreateLogDrain.js +1 -1
  26. package/esm/funcs/logDrainsDeleteConfigurableLogDrain.d.ts +1 -1
  27. package/esm/funcs/logDrainsDeleteConfigurableLogDrain.js +1 -1
  28. package/esm/funcs/logDrainsDeleteIntegrationLogDrain.d.ts +1 -1
  29. package/esm/funcs/logDrainsDeleteIntegrationLogDrain.js +1 -1
  30. package/esm/funcs/logDrainsGetAllLogDrains.d.ts +1 -1
  31. package/esm/funcs/logDrainsGetAllLogDrains.js +1 -1
  32. package/esm/funcs/logDrainsGetConfigurableLogDrain.d.ts +1 -1
  33. package/esm/funcs/logDrainsGetConfigurableLogDrain.js +1 -1
  34. package/esm/funcs/logDrainsGetIntegrationLogDrains.d.ts +1 -1
  35. package/esm/funcs/logDrainsGetIntegrationLogDrains.js +1 -1
  36. package/esm/funcs/projectsGetProjectClientCerts.d.ts +17 -0
  37. package/esm/funcs/projectsGetProjectClientCerts.d.ts.map +1 -0
  38. package/esm/funcs/projectsGetProjectClientCerts.js +88 -0
  39. package/esm/funcs/projectsGetProjectClientCerts.js.map +1 -0
  40. package/esm/funcs/teamsInviteUserToTeam.d.ts +1 -1
  41. package/esm/funcs/teamsInviteUserToTeam.js +1 -1
  42. package/esm/lib/config.d.ts +3 -3
  43. package/esm/lib/config.js +3 -3
  44. package/esm/mcp-server/mcp-server.js +1 -1
  45. package/esm/mcp-server/server.d.ts.map +1 -1
  46. package/esm/mcp-server/server.js +3 -1
  47. package/esm/mcp-server/server.js.map +1 -1
  48. package/esm/mcp-server/tools/logDrainsCreateConfigurableLogDrain.js +1 -1
  49. package/esm/mcp-server/tools/logDrainsCreateLogDrain.js +1 -1
  50. package/esm/mcp-server/tools/logDrainsDeleteConfigurableLogDrain.js +1 -1
  51. package/esm/mcp-server/tools/logDrainsDeleteIntegrationLogDrain.d.ts.map +1 -1
  52. package/esm/mcp-server/tools/logDrainsDeleteIntegrationLogDrain.js +1 -1
  53. package/esm/mcp-server/tools/logDrainsDeleteIntegrationLogDrain.js.map +1 -1
  54. package/esm/mcp-server/tools/logDrainsGetAllLogDrains.js +1 -1
  55. package/esm/mcp-server/tools/logDrainsGetConfigurableLogDrain.js +1 -1
  56. package/esm/mcp-server/tools/logDrainsGetIntegrationLogDrains.js +1 -1
  57. package/esm/mcp-server/tools/projectsGetProjectClientCerts.d.ts +7 -0
  58. package/esm/mcp-server/tools/projectsGetProjectClientCerts.d.ts.map +1 -0
  59. package/esm/mcp-server/tools/projectsGetProjectClientCerts.js +28 -0
  60. package/esm/mcp-server/tools/projectsGetProjectClientCerts.js.map +1 -0
  61. package/esm/mcp-server/tools/teamsInviteUserToTeam.js +1 -1
  62. package/esm/mcp-server/tools/teamsInviteUserToTeam.js.map +1 -1
  63. package/esm/models/approverollingreleasestageop.d.ts +78 -0
  64. package/esm/models/approverollingreleasestageop.d.ts.map +1 -1
  65. package/esm/models/approverollingreleasestageop.js +18 -0
  66. package/esm/models/approverollingreleasestageop.js.map +1 -1
  67. package/esm/models/authuser.d.ts +67 -0
  68. package/esm/models/authuser.d.ts.map +1 -1
  69. package/esm/models/authuser.js +49 -0
  70. package/esm/models/authuser.js.map +1 -1
  71. package/esm/models/canceldeploymentop.d.ts +106 -1
  72. package/esm/models/canceldeploymentop.d.ts.map +1 -1
  73. package/esm/models/canceldeploymentop.js +9 -0
  74. package/esm/models/canceldeploymentop.js.map +1 -1
  75. package/esm/models/completerollingreleaseop.d.ts +78 -0
  76. package/esm/models/completerollingreleaseop.d.ts.map +1 -1
  77. package/esm/models/completerollingreleaseop.js +18 -0
  78. package/esm/models/completerollingreleaseop.js.map +1 -1
  79. package/esm/models/createdeploymentop.d.ts +106 -1
  80. package/esm/models/createdeploymentop.d.ts.map +1 -1
  81. package/esm/models/createdeploymentop.js +9 -0
  82. package/esm/models/createdeploymentop.js.map +1 -1
  83. package/esm/models/createintegrationstoredirectop.d.ts +285 -285
  84. package/esm/models/createintegrationstoredirectop.js +351 -351
  85. package/esm/models/createlogdrainop.d.ts +3 -0
  86. package/esm/models/createlogdrainop.d.ts.map +1 -1
  87. package/esm/models/createlogdrainop.js +1 -0
  88. package/esm/models/createlogdrainop.js.map +1 -1
  89. package/esm/models/createprojectop.d.ts +67 -15
  90. package/esm/models/createprojectop.d.ts.map +1 -1
  91. package/esm/models/createprojectop.js +47 -6
  92. package/esm/models/createprojectop.js.map +1 -1
  93. package/esm/models/getconfigurationproductsop.d.ts +375 -375
  94. package/esm/models/getconfigurationproductsop.js +465 -465
  95. package/esm/models/getdeploymentop.d.ts +212 -2
  96. package/esm/models/getdeploymentop.d.ts.map +1 -1
  97. package/esm/models/getdeploymentop.js +18 -0
  98. package/esm/models/getdeploymentop.js.map +1 -1
  99. package/esm/models/getintegrationlogdrainsop.d.ts +3 -0
  100. package/esm/models/getintegrationlogdrainsop.d.ts.map +1 -1
  101. package/esm/models/getintegrationlogdrainsop.js +1 -0
  102. package/esm/models/getintegrationlogdrainsop.js.map +1 -1
  103. package/esm/models/getprojectclientcertsop.d.ts +97 -0
  104. package/esm/models/getprojectclientcertsop.d.ts.map +1 -0
  105. package/esm/models/getprojectclientcertsop.js +87 -0
  106. package/esm/models/getprojectclientcertsop.js.map +1 -0
  107. package/esm/models/getprojectsop.d.ts +67 -15
  108. package/esm/models/getprojectsop.d.ts.map +1 -1
  109. package/esm/models/getprojectsop.js +47 -6
  110. package/esm/models/getprojectsop.js.map +1 -1
  111. package/esm/models/getrollingreleaseop.d.ts +78 -0
  112. package/esm/models/getrollingreleaseop.d.ts.map +1 -1
  113. package/esm/models/getrollingreleaseop.js +18 -0
  114. package/esm/models/getrollingreleaseop.js.map +1 -1
  115. package/esm/models/updateprojectdatacacheop.d.ts +67 -15
  116. package/esm/models/updateprojectdatacacheop.d.ts.map +1 -1
  117. package/esm/models/updateprojectdatacacheop.js +47 -6
  118. package/esm/models/updateprojectdatacacheop.js.map +1 -1
  119. package/esm/models/updateprojectop.d.ts +67 -15
  120. package/esm/models/updateprojectop.d.ts.map +1 -1
  121. package/esm/models/updateprojectop.js +47 -6
  122. package/esm/models/updateprojectop.js.map +1 -1
  123. package/esm/models/updatestaticipsop.d.ts +3 -3
  124. package/esm/models/updatestaticipsop.js +1 -1
  125. package/esm/models/updatestaticipsop.js.map +1 -1
  126. package/esm/models/userevent.d.ts +176 -30
  127. package/esm/models/userevent.d.ts.map +1 -1
  128. package/esm/models/userevent.js +136 -12
  129. package/esm/models/userevent.js.map +1 -1
  130. package/esm/sdk/logdrains.d.ts +7 -7
  131. package/esm/sdk/logdrains.js +7 -7
  132. package/esm/sdk/projects.d.ts +8 -0
  133. package/esm/sdk/projects.d.ts.map +1 -1
  134. package/esm/sdk/projects.js +10 -0
  135. package/esm/sdk/projects.js.map +1 -1
  136. package/esm/sdk/teams.d.ts +1 -1
  137. package/esm/sdk/teams.js +1 -1
  138. package/examples/package-lock.json +1 -1
  139. package/jsr.json +1 -1
  140. package/package.json +1 -1
  141. package/src/__tests__/accessgroups.test.ts +6 -2
  142. package/src/__tests__/domains.test.ts +5 -5
  143. package/src/__tests__/edgeconfig.test.ts +6 -6
  144. package/src/__tests__/integrations.test.ts +1 -1
  145. package/src/__tests__/logdrains.test.ts +4 -4
  146. package/src/__tests__/projects.test.ts +20 -0
  147. package/src/__tests__/rollingrelease.test.ts +2 -7
  148. package/src/__tests__/security.test.ts +1 -11
  149. package/src/funcs/logDrainsCreateConfigurableLogDrain.ts +1 -1
  150. package/src/funcs/logDrainsCreateLogDrain.ts +1 -1
  151. package/src/funcs/logDrainsDeleteConfigurableLogDrain.ts +1 -1
  152. package/src/funcs/logDrainsDeleteIntegrationLogDrain.ts +1 -1
  153. package/src/funcs/logDrainsGetAllLogDrains.ts +1 -1
  154. package/src/funcs/logDrainsGetConfigurableLogDrain.ts +1 -1
  155. package/src/funcs/logDrainsGetIntegrationLogDrains.ts +1 -1
  156. package/src/funcs/projectsGetProjectClientCerts.ts +177 -0
  157. package/src/funcs/teamsInviteUserToTeam.ts +1 -1
  158. package/src/lib/config.ts +3 -3
  159. package/src/mcp-server/mcp-server.ts +1 -1
  160. package/src/mcp-server/server.ts +3 -1
  161. package/src/mcp-server/tools/logDrainsCreateConfigurableLogDrain.ts +1 -1
  162. package/src/mcp-server/tools/logDrainsCreateLogDrain.ts +1 -1
  163. package/src/mcp-server/tools/logDrainsDeleteConfigurableLogDrain.ts +1 -1
  164. package/src/mcp-server/tools/logDrainsDeleteIntegrationLogDrain.ts +2 -1
  165. package/src/mcp-server/tools/logDrainsGetAllLogDrains.ts +1 -1
  166. package/src/mcp-server/tools/logDrainsGetConfigurableLogDrain.ts +1 -1
  167. package/src/mcp-server/tools/logDrainsGetIntegrationLogDrains.ts +1 -1
  168. package/src/mcp-server/tools/projectsGetProjectClientCerts.ts +37 -0
  169. package/src/mcp-server/tools/teamsInviteUserToTeam.ts +1 -1
  170. package/src/models/approverollingreleasestageop.ts +78 -0
  171. package/src/models/authuser.ts +100 -0
  172. package/src/models/canceldeploymentop.ts +106 -1
  173. package/src/models/completerollingreleaseop.ts +78 -0
  174. package/src/models/createdeploymentop.ts +106 -1
  175. package/src/models/createintegrationstoredirectop.ts +604 -604
  176. package/src/models/createlogdrainop.ts +1 -0
  177. package/src/models/createprojectop.ts +126 -19
  178. package/src/models/getconfigurationproductsop.ts +802 -802
  179. package/src/models/getdeploymentop.ts +212 -2
  180. package/src/models/getintegrationlogdrainsop.ts +1 -0
  181. package/src/models/getprojectclientcertsop.ts +207 -0
  182. package/src/models/getprojectsop.ts +124 -19
  183. package/src/models/getrollingreleaseop.ts +78 -0
  184. package/src/models/updateprojectdatacacheop.ts +129 -19
  185. package/src/models/updateprojectop.ts +126 -19
  186. package/src/models/updatestaticipsop.ts +1 -1
  187. package/src/models/userevent.ts +329 -39
  188. package/src/sdk/logdrains.ts +7 -7
  189. package/src/sdk/projects.ts +22 -0
  190. package/src/sdk/teams.ts +1 -1
  191. package/vercel-spec.json +1092 -278
@@ -34,9 +34,21 @@ export type GetDeploymentRequest = {
34
34
  slug?: string | undefined;
35
35
  };
36
36
 
37
+ /**
38
+ * Information about the deployment creator
39
+ */
37
40
  export type GetDeploymentResponseBodyCreator = {
41
+ /**
42
+ * The ID of the user that created the deployment
43
+ */
38
44
  uid: string;
45
+ /**
46
+ * The username of the user that created the deployment
47
+ */
39
48
  username?: string | undefined;
49
+ /**
50
+ * The avatar of the user that created the deployment
51
+ */
40
52
  avatar?: string | undefined;
41
53
  };
42
54
 
@@ -79,6 +91,9 @@ export type GetDeploymentResponseBodyStatus = ClosedEnum<
79
91
  typeof GetDeploymentResponseBodyStatus
80
92
  >;
81
93
 
94
+ /**
95
+ * The team that owns the deployment if any
96
+ */
82
97
  export type ResponseBodyTeam = {
83
98
  id: string;
84
99
  name: string;
@@ -86,6 +101,9 @@ export type ResponseBodyTeam = {
86
101
  avatar?: string | undefined;
87
102
  };
88
103
 
104
+ /**
105
+ * If the deployment was created using a Custom Environment, then this property contains information regarding the environment used.
106
+ */
89
107
  export type GetDeploymentCustomEnvironment2 = {
90
108
  id: string;
91
109
  };
@@ -168,7 +186,7 @@ export type GetDeploymentCustomEnvironmentDomains = {
168
186
  };
169
187
 
170
188
  /**
171
- * Internal representation of a custom environment with all required properties
189
+ * If the deployment was created using a Custom Environment, then this property contains information regarding the environment used.
172
190
  */
173
191
  export type GetDeploymentCustomEnvironment1 = {
174
192
  /**
@@ -225,6 +243,9 @@ export type ResponseBodyAliasWarning = {
225
243
  action?: string | undefined;
226
244
  };
227
245
 
246
+ /**
247
+ * The state of the deployment depending on the process of deploying, or if it is ready or in an error state
248
+ */
228
249
  export const GetDeploymentResponseBodyReadyState = {
229
250
  Queued: "QUEUED",
230
251
  Building: "BUILDING",
@@ -233,6 +254,9 @@ export const GetDeploymentResponseBodyReadyState = {
233
254
  Ready: "READY",
234
255
  Canceled: "CANCELED",
235
256
  } as const;
257
+ /**
258
+ * The state of the deployment depending on the process of deploying, or if it is ready or in an error state
259
+ */
236
260
  export type GetDeploymentResponseBodyReadyState = ClosedEnum<
237
261
  typeof GetDeploymentResponseBodyReadyState
238
262
  >;
@@ -244,6 +268,9 @@ export type GetDeploymentResponseBodyDeploymentsType = ClosedEnum<
244
268
  typeof GetDeploymentResponseBodyDeploymentsType
245
269
  >;
246
270
 
271
+ /**
272
+ * An object that will contain a `code` and a `message` when the aliasing fails, otherwise the value will be `null`
273
+ */
247
274
  export type GetDeploymentResponseBodyAliasError = {
248
275
  code: string;
249
276
  message: string;
@@ -599,6 +626,9 @@ export type GetDeploymentResponseBodyNodeVersion = ClosedEnum<
599
626
  typeof GetDeploymentResponseBodyNodeVersion
600
627
  >;
601
628
 
629
+ /**
630
+ * The public project information associated with the deployment.
631
+ */
602
632
  export type GetDeploymentResponseBodyProject = {
603
633
  id: string;
604
634
  name: string;
@@ -620,6 +650,9 @@ export type GetDeploymentResponseBodyReadySubstate = ClosedEnum<
620
650
  typeof GetDeploymentResponseBodyReadySubstate
621
651
  >;
622
652
 
653
+ /**
654
+ * Where was the deployment created from
655
+ */
623
656
  export const GetDeploymentResponseBodySource = {
624
657
  ApiTriggerGitDeploy: "api-trigger-git-deploy",
625
658
  Cli: "cli",
@@ -630,14 +663,23 @@ export const GetDeploymentResponseBodySource = {
630
663
  Redeploy: "redeploy",
631
664
  V0Web: "v0-web",
632
665
  } as const;
666
+ /**
667
+ * Where was the deployment created from
668
+ */
633
669
  export type GetDeploymentResponseBodySource = ClosedEnum<
634
670
  typeof GetDeploymentResponseBodySource
635
671
  >;
636
672
 
673
+ /**
674
+ * If defined, either `staging` if a staging alias in the format `<project>.<team>.now.sh` was assigned upon creation, or `production` if the aliases from `alias` were assigned. `null` value indicates the "preview" deployment.
675
+ */
637
676
  export const GetDeploymentResponseBodyTarget = {
638
677
  Staging: "staging",
639
678
  Production: "production",
640
679
  } as const;
680
+ /**
681
+ * If defined, either `staging` if a staging alias in the format `<project>.<team>.now.sh` was assigned upon creation, or `production` if the aliases from `alias` were assigned. `null` value indicates the "preview" deployment.
682
+ */
641
683
  export type GetDeploymentResponseBodyTarget = ClosedEnum<
642
684
  typeof GetDeploymentResponseBodyTarget
643
685
  >;
@@ -658,7 +700,13 @@ export type GetDeploymentResponseBodyOidcTokenClaims = {
658
700
  * The deployment including only public information
659
701
  */
660
702
  export type GetDeploymentResponseBody2 = {
703
+ /**
704
+ * A list of all the aliases (default aliases, staging aliases and production aliases) that were assigned upon deployment creation
705
+ */
661
706
  alias?: Array<string> | undefined;
707
+ /**
708
+ * A boolean that will be true when the aliases from the alias property were assigned successfully
709
+ */
662
710
  aliasAssigned: boolean;
663
711
  bootedAt: number;
664
712
  buildingAt: number;
@@ -667,15 +715,30 @@ export type GetDeploymentResponseBody2 = {
667
715
  */
668
716
  buildContainerFinishedAt?: number | undefined;
669
717
  buildSkipped: boolean;
718
+ /**
719
+ * Information about the deployment creator
720
+ */
670
721
  creator: GetDeploymentResponseBodyCreator;
671
722
  initReadyAt?: number | undefined;
672
723
  isFirstBranchDeployment?: boolean | undefined;
673
724
  lambdas?: Array<ResponseBodyLambdas> | undefined;
725
+ /**
726
+ * A boolean representing if the deployment is public or not. By default this is `false`
727
+ */
674
728
  public: boolean;
675
729
  ready?: number | undefined;
676
730
  status: GetDeploymentResponseBodyStatus;
731
+ /**
732
+ * The team that owns the deployment if any
733
+ */
677
734
  team?: ResponseBodyTeam | undefined;
735
+ /**
736
+ * An array of domains that were provided by the user when creating the Deployment.
737
+ */
678
738
  userAliases?: Array<string> | undefined;
739
+ /**
740
+ * Whether or not preview comments are enabled for the deployment
741
+ */
679
742
  previewCommentsEnabled?: boolean | undefined;
680
743
  ttyBuildLogs?: boolean | undefined;
681
744
  customEnvironment?:
@@ -684,11 +747,26 @@ export type GetDeploymentResponseBody2 = {
684
747
  | undefined;
685
748
  oomReport?: ResponseBodyOomReport | undefined;
686
749
  aliasWarning?: ResponseBodyAliasWarning | null | undefined;
750
+ /**
751
+ * A string holding the unique ID of the deployment
752
+ */
687
753
  id: string;
754
+ /**
755
+ * A number containing the date when the deployment was created in milliseconds
756
+ */
688
757
  createdAt: number;
758
+ /**
759
+ * The state of the deployment depending on the process of deploying, or if it is ready or in an error state
760
+ */
689
761
  readyState: GetDeploymentResponseBodyReadyState;
762
+ /**
763
+ * The name of the project associated with the deployment at the time that the deployment was created
764
+ */
690
765
  name: string;
691
766
  type: GetDeploymentResponseBodyDeploymentsType;
767
+ /**
768
+ * An object that will contain a `code` and a `message` when the aliasing fails, otherwise the value will be `null`
769
+ */
692
770
  aliasError?: GetDeploymentResponseBodyAliasError | null | undefined;
693
771
  aliasFinal?: string | null | undefined;
694
772
  /**
@@ -699,6 +777,9 @@ export type GetDeploymentResponseBody2 = {
699
777
  buildErrorAt?: number | undefined;
700
778
  checksState?: GetDeploymentResponseBodyChecksState | undefined;
701
779
  checksConclusion?: GetDeploymentResponseBodyChecksConclusion | undefined;
780
+ /**
781
+ * A number containing the date when the deployment was deleted at milliseconds
782
+ */
702
783
  deletedAt?: number | null | undefined;
703
784
  /**
704
785
  * Computed field that is only available for deployments with a microfrontend configuration.
@@ -736,17 +817,41 @@ export type GetDeploymentResponseBody2 = {
736
817
  * If set it overrides the `projectSettings.nodeVersion` for this deployment.
737
818
  */
738
819
  nodeVersion?: GetDeploymentResponseBodyNodeVersion | undefined;
820
+ /**
821
+ * The public project information associated with the deployment.
822
+ */
739
823
  project?: GetDeploymentResponseBodyProject | undefined;
740
824
  /**
741
825
  * Substate of deployment when readyState is 'READY' Tracks whether or not deployment has seen production traffic: - STAGED: never seen production traffic - ROLLING: in the process of having production traffic gradually transitioned. - PROMOTED: has seen production traffic
742
826
  */
743
827
  readySubstate?: GetDeploymentResponseBodyReadySubstate | undefined;
828
+ /**
829
+ * The regions the deployment exists in
830
+ */
744
831
  regions: Array<string>;
832
+ /**
833
+ * flag to indicate if the deployment was deleted by retention policy
834
+ */
745
835
  softDeletedByRetention?: boolean | undefined;
836
+ /**
837
+ * Where was the deployment created from
838
+ */
746
839
  source?: GetDeploymentResponseBodySource | undefined;
840
+ /**
841
+ * If defined, either `staging` if a staging alias in the format `<project>.<team>.now.sh` was assigned upon creation, or `production` if the aliases from `alias` were assigned. `null` value indicates the "preview" deployment.
842
+ */
747
843
  target?: GetDeploymentResponseBodyTarget | null | undefined;
844
+ /**
845
+ * A number containing the date when the deployment was undeleted at milliseconds
846
+ */
748
847
  undeletedAt?: number | undefined;
848
+ /**
849
+ * A string with the unique URL of the deployment
850
+ */
749
851
  url: string;
852
+ /**
853
+ * The platform version that was used to create the deployment.
854
+ */
750
855
  version: number;
751
856
  oidcTokenClaims?: GetDeploymentResponseBodyOidcTokenClaims | undefined;
752
857
  };
@@ -942,9 +1047,21 @@ export type ResponseBodyImages = {
942
1047
  contentDispositionType?: ResponseBodyContentDispositionType | undefined;
943
1048
  };
944
1049
 
1050
+ /**
1051
+ * Information about the deployment creator
1052
+ */
945
1053
  export type ResponseBodyCreator = {
1054
+ /**
1055
+ * The ID of the user that created the deployment
1056
+ */
946
1057
  uid: string;
1058
+ /**
1059
+ * The username of the user that created the deployment
1060
+ */
947
1061
  username?: string | undefined;
1062
+ /**
1063
+ * The avatar of the user that created the deployment
1064
+ */
948
1065
  avatar?: string | undefined;
949
1066
  };
950
1067
 
@@ -987,6 +1104,9 @@ export const ResponseBodyStatus = {
987
1104
  } as const;
988
1105
  export type ResponseBodyStatus = ClosedEnum<typeof ResponseBodyStatus>;
989
1106
 
1107
+ /**
1108
+ * The team that owns the deployment if any
1109
+ */
990
1110
  export type GetDeploymentResponseBodyTeam = {
991
1111
  id: string;
992
1112
  name: string;
@@ -994,6 +1114,9 @@ export type GetDeploymentResponseBodyTeam = {
994
1114
  avatar?: string | undefined;
995
1115
  };
996
1116
 
1117
+ /**
1118
+ * If the deployment was created using a Custom Environment, then this property contains information regarding the environment used.
1119
+ */
997
1120
  export type GetDeploymentCustomEnvironmentDeployments2 = {
998
1121
  id: string;
999
1122
  };
@@ -1077,7 +1200,7 @@ export type GetDeploymentCustomEnvironmentDeploymentsDomains = {
1077
1200
  };
1078
1201
 
1079
1202
  /**
1080
- * Internal representation of a custom environment with all required properties
1203
+ * If the deployment was created using a Custom Environment, then this property contains information regarding the environment used.
1081
1204
  */
1082
1205
  export type GetDeploymentCustomEnvironmentDeployments1 = {
1083
1206
  /**
@@ -1138,6 +1261,9 @@ export type GetDeploymentResponseBodyAliasWarning = {
1138
1261
  action?: string | undefined;
1139
1262
  };
1140
1263
 
1264
+ /**
1265
+ * The state of the deployment depending on the process of deploying, or if it is ready or in an error state
1266
+ */
1141
1267
  export const ResponseBodyReadyState = {
1142
1268
  Queued: "QUEUED",
1143
1269
  Building: "BUILDING",
@@ -1146,6 +1272,9 @@ export const ResponseBodyReadyState = {
1146
1272
  Ready: "READY",
1147
1273
  Canceled: "CANCELED",
1148
1274
  } as const;
1275
+ /**
1276
+ * The state of the deployment depending on the process of deploying, or if it is ready or in an error state
1277
+ */
1149
1278
  export type ResponseBodyReadyState = ClosedEnum<typeof ResponseBodyReadyState>;
1150
1279
 
1151
1280
  export const GetDeploymentResponseBodyType = {
@@ -1155,6 +1284,9 @@ export type GetDeploymentResponseBodyType = ClosedEnum<
1155
1284
  typeof GetDeploymentResponseBodyType
1156
1285
  >;
1157
1286
 
1287
+ /**
1288
+ * An object that will contain a `code` and a `message` when the aliasing fails, otherwise the value will be `null`
1289
+ */
1158
1290
  export type ResponseBodyAliasError = {
1159
1291
  code: string;
1160
1292
  message: string;
@@ -1498,6 +1630,9 @@ export type ResponseBodyNodeVersion = ClosedEnum<
1498
1630
  typeof ResponseBodyNodeVersion
1499
1631
  >;
1500
1632
 
1633
+ /**
1634
+ * The public project information associated with the deployment.
1635
+ */
1501
1636
  export type ResponseBodyProject = {
1502
1637
  id: string;
1503
1638
  name: string;
@@ -1519,6 +1654,9 @@ export type ResponseBodyReadySubstate = ClosedEnum<
1519
1654
  typeof ResponseBodyReadySubstate
1520
1655
  >;
1521
1656
 
1657
+ /**
1658
+ * Where was the deployment created from
1659
+ */
1522
1660
  export const ResponseBodySource = {
1523
1661
  ApiTriggerGitDeploy: "api-trigger-git-deploy",
1524
1662
  Cli: "cli",
@@ -1529,12 +1667,21 @@ export const ResponseBodySource = {
1529
1667
  Redeploy: "redeploy",
1530
1668
  V0Web: "v0-web",
1531
1669
  } as const;
1670
+ /**
1671
+ * Where was the deployment created from
1672
+ */
1532
1673
  export type ResponseBodySource = ClosedEnum<typeof ResponseBodySource>;
1533
1674
 
1675
+ /**
1676
+ * If defined, either `staging` if a staging alias in the format `<project>.<team>.now.sh` was assigned upon creation, or `production` if the aliases from `alias` were assigned. `null` value indicates the "preview" deployment.
1677
+ */
1534
1678
  export const ResponseBodyTarget = {
1535
1679
  Staging: "staging",
1536
1680
  Production: "production",
1537
1681
  } as const;
1682
+ /**
1683
+ * If defined, either `staging` if a staging alias in the format `<project>.<team>.now.sh` was assigned upon creation, or `production` if the aliases from `alias` were assigned. `null` value indicates the "preview" deployment.
1684
+ */
1538
1685
  export type ResponseBodyTarget = ClosedEnum<typeof ResponseBodyTarget>;
1539
1686
 
1540
1687
  export type ResponseBodyOidcTokenClaims = {
@@ -2154,7 +2301,13 @@ export type GetDeploymentResponseBody1 = {
2154
2301
  readyStateReason?: string | undefined;
2155
2302
  integrations?: ResponseBodyIntegrations | undefined;
2156
2303
  images?: ResponseBodyImages | undefined;
2304
+ /**
2305
+ * A list of all the aliases (default aliases, staging aliases and production aliases) that were assigned upon deployment creation
2306
+ */
2157
2307
  alias?: Array<string> | undefined;
2308
+ /**
2309
+ * A boolean that will be true when the aliases from the alias property were assigned successfully
2310
+ */
2158
2311
  aliasAssigned: boolean;
2159
2312
  bootedAt: number;
2160
2313
  buildingAt: number;
@@ -2163,15 +2316,30 @@ export type GetDeploymentResponseBody1 = {
2163
2316
  */
2164
2317
  buildContainerFinishedAt?: number | undefined;
2165
2318
  buildSkipped: boolean;
2319
+ /**
2320
+ * Information about the deployment creator
2321
+ */
2166
2322
  creator: ResponseBodyCreator;
2167
2323
  initReadyAt?: number | undefined;
2168
2324
  isFirstBranchDeployment?: boolean | undefined;
2169
2325
  lambdas?: Array<GetDeploymentResponseBodyLambdas> | undefined;
2326
+ /**
2327
+ * A boolean representing if the deployment is public or not. By default this is `false`
2328
+ */
2170
2329
  public: boolean;
2171
2330
  ready?: number | undefined;
2172
2331
  status: ResponseBodyStatus;
2332
+ /**
2333
+ * The team that owns the deployment if any
2334
+ */
2173
2335
  team?: GetDeploymentResponseBodyTeam | undefined;
2336
+ /**
2337
+ * An array of domains that were provided by the user when creating the Deployment.
2338
+ */
2174
2339
  userAliases?: Array<string> | undefined;
2340
+ /**
2341
+ * Whether or not preview comments are enabled for the deployment
2342
+ */
2175
2343
  previewCommentsEnabled?: boolean | undefined;
2176
2344
  ttyBuildLogs?: boolean | undefined;
2177
2345
  customEnvironment?:
@@ -2180,11 +2348,26 @@ export type GetDeploymentResponseBody1 = {
2180
2348
  | undefined;
2181
2349
  oomReport?: GetDeploymentResponseBodyOomReport | undefined;
2182
2350
  aliasWarning?: GetDeploymentResponseBodyAliasWarning | null | undefined;
2351
+ /**
2352
+ * A string holding the unique ID of the deployment
2353
+ */
2183
2354
  id: string;
2355
+ /**
2356
+ * A number containing the date when the deployment was created in milliseconds
2357
+ */
2184
2358
  createdAt: number;
2359
+ /**
2360
+ * The state of the deployment depending on the process of deploying, or if it is ready or in an error state
2361
+ */
2185
2362
  readyState: ResponseBodyReadyState;
2363
+ /**
2364
+ * The name of the project associated with the deployment at the time that the deployment was created
2365
+ */
2186
2366
  name: string;
2187
2367
  type: GetDeploymentResponseBodyType;
2368
+ /**
2369
+ * An object that will contain a `code` and a `message` when the aliasing fails, otherwise the value will be `null`
2370
+ */
2188
2371
  aliasError?: ResponseBodyAliasError | null | undefined;
2189
2372
  aliasFinal?: string | null | undefined;
2190
2373
  /**
@@ -2195,6 +2378,9 @@ export type GetDeploymentResponseBody1 = {
2195
2378
  buildErrorAt?: number | undefined;
2196
2379
  checksState?: ResponseBodyChecksState | undefined;
2197
2380
  checksConclusion?: ResponseBodyChecksConclusion | undefined;
2381
+ /**
2382
+ * A number containing the date when the deployment was deleted at milliseconds
2383
+ */
2198
2384
  deletedAt?: number | null | undefined;
2199
2385
  /**
2200
2386
  * Computed field that is only available for deployments with a microfrontend configuration.
@@ -2232,17 +2418,41 @@ export type GetDeploymentResponseBody1 = {
2232
2418
  * If set it overrides the `projectSettings.nodeVersion` for this deployment.
2233
2419
  */
2234
2420
  nodeVersion?: ResponseBodyNodeVersion | undefined;
2421
+ /**
2422
+ * The public project information associated with the deployment.
2423
+ */
2235
2424
  project?: ResponseBodyProject | undefined;
2236
2425
  /**
2237
2426
  * Substate of deployment when readyState is 'READY' Tracks whether or not deployment has seen production traffic: - STAGED: never seen production traffic - ROLLING: in the process of having production traffic gradually transitioned. - PROMOTED: has seen production traffic
2238
2427
  */
2239
2428
  readySubstate?: ResponseBodyReadySubstate | undefined;
2429
+ /**
2430
+ * The regions the deployment exists in
2431
+ */
2240
2432
  regions: Array<string>;
2433
+ /**
2434
+ * flag to indicate if the deployment was deleted by retention policy
2435
+ */
2241
2436
  softDeletedByRetention?: boolean | undefined;
2437
+ /**
2438
+ * Where was the deployment created from
2439
+ */
2242
2440
  source?: ResponseBodySource | undefined;
2441
+ /**
2442
+ * If defined, either `staging` if a staging alias in the format `<project>.<team>.now.sh` was assigned upon creation, or `production` if the aliases from `alias` were assigned. `null` value indicates the "preview" deployment.
2443
+ */
2243
2444
  target?: ResponseBodyTarget | null | undefined;
2445
+ /**
2446
+ * A number containing the date when the deployment was undeleted at milliseconds
2447
+ */
2244
2448
  undeletedAt?: number | undefined;
2449
+ /**
2450
+ * A string with the unique URL of the deployment
2451
+ */
2245
2452
  url: string;
2453
+ /**
2454
+ * The platform version that was used to create the deployment.
2455
+ */
2246
2456
  version: number;
2247
2457
  oidcTokenClaims?: ResponseBodyOidcTokenClaims | undefined;
2248
2458
  projectId: string;
@@ -45,6 +45,7 @@ export const GetIntegrationLogDrainsSources = {
45
45
  Static: "static",
46
46
  External: "external",
47
47
  Firewall: "firewall",
48
+ Redirect: "redirect",
48
49
  } as const;
49
50
  /**
50
51
  * The sources from which logs are currently being delivered to this log drain.
@@ -0,0 +1,207 @@
1
+ /*
2
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
3
+ */
4
+
5
+ import * as z from "zod/v3";
6
+ import { safeParse } from "../lib/schemas.js";
7
+ import { Result as SafeParseResult } from "../types/fp.js";
8
+ import { SDKValidationError } from "./sdkvalidationerror.js";
9
+
10
+ export type GetProjectClientCertsRequest = {
11
+ /**
12
+ * The unique project identifier or the project name
13
+ */
14
+ idOrName: string;
15
+ /**
16
+ * The Team identifier to perform the request on behalf of.
17
+ */
18
+ teamId?: string | undefined;
19
+ /**
20
+ * The Team slug to perform the request on behalf of.
21
+ */
22
+ slug?: string | undefined;
23
+ };
24
+
25
+ export type ClientCerts = {
26
+ origin: string;
27
+ id: string;
28
+ };
29
+
30
+ /**
31
+ * Client certificates retrieved successfully
32
+ */
33
+ export type GetProjectClientCertsResponseBody = {
34
+ clientCerts: Array<ClientCerts>;
35
+ };
36
+
37
+ /** @internal */
38
+ export const GetProjectClientCertsRequest$inboundSchema: z.ZodType<
39
+ GetProjectClientCertsRequest,
40
+ z.ZodTypeDef,
41
+ unknown
42
+ > = z.object({
43
+ idOrName: z.string(),
44
+ teamId: z.string().optional(),
45
+ slug: z.string().optional(),
46
+ });
47
+
48
+ /** @internal */
49
+ export type GetProjectClientCertsRequest$Outbound = {
50
+ idOrName: string;
51
+ teamId?: string | undefined;
52
+ slug?: string | undefined;
53
+ };
54
+
55
+ /** @internal */
56
+ export const GetProjectClientCertsRequest$outboundSchema: z.ZodType<
57
+ GetProjectClientCertsRequest$Outbound,
58
+ z.ZodTypeDef,
59
+ GetProjectClientCertsRequest
60
+ > = z.object({
61
+ idOrName: z.string(),
62
+ teamId: z.string().optional(),
63
+ slug: z.string().optional(),
64
+ });
65
+
66
+ /**
67
+ * @internal
68
+ * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module.
69
+ */
70
+ export namespace GetProjectClientCertsRequest$ {
71
+ /** @deprecated use `GetProjectClientCertsRequest$inboundSchema` instead. */
72
+ export const inboundSchema = GetProjectClientCertsRequest$inboundSchema;
73
+ /** @deprecated use `GetProjectClientCertsRequest$outboundSchema` instead. */
74
+ export const outboundSchema = GetProjectClientCertsRequest$outboundSchema;
75
+ /** @deprecated use `GetProjectClientCertsRequest$Outbound` instead. */
76
+ export type Outbound = GetProjectClientCertsRequest$Outbound;
77
+ }
78
+
79
+ export function getProjectClientCertsRequestToJSON(
80
+ getProjectClientCertsRequest: GetProjectClientCertsRequest,
81
+ ): string {
82
+ return JSON.stringify(
83
+ GetProjectClientCertsRequest$outboundSchema.parse(
84
+ getProjectClientCertsRequest,
85
+ ),
86
+ );
87
+ }
88
+
89
+ export function getProjectClientCertsRequestFromJSON(
90
+ jsonString: string,
91
+ ): SafeParseResult<GetProjectClientCertsRequest, SDKValidationError> {
92
+ return safeParse(
93
+ jsonString,
94
+ (x) => GetProjectClientCertsRequest$inboundSchema.parse(JSON.parse(x)),
95
+ `Failed to parse 'GetProjectClientCertsRequest' from JSON`,
96
+ );
97
+ }
98
+
99
+ /** @internal */
100
+ export const ClientCerts$inboundSchema: z.ZodType<
101
+ ClientCerts,
102
+ z.ZodTypeDef,
103
+ unknown
104
+ > = z.object({
105
+ origin: z.string(),
106
+ id: z.string(),
107
+ });
108
+
109
+ /** @internal */
110
+ export type ClientCerts$Outbound = {
111
+ origin: string;
112
+ id: string;
113
+ };
114
+
115
+ /** @internal */
116
+ export const ClientCerts$outboundSchema: z.ZodType<
117
+ ClientCerts$Outbound,
118
+ z.ZodTypeDef,
119
+ ClientCerts
120
+ > = z.object({
121
+ origin: z.string(),
122
+ id: z.string(),
123
+ });
124
+
125
+ /**
126
+ * @internal
127
+ * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module.
128
+ */
129
+ export namespace ClientCerts$ {
130
+ /** @deprecated use `ClientCerts$inboundSchema` instead. */
131
+ export const inboundSchema = ClientCerts$inboundSchema;
132
+ /** @deprecated use `ClientCerts$outboundSchema` instead. */
133
+ export const outboundSchema = ClientCerts$outboundSchema;
134
+ /** @deprecated use `ClientCerts$Outbound` instead. */
135
+ export type Outbound = ClientCerts$Outbound;
136
+ }
137
+
138
+ export function clientCertsToJSON(clientCerts: ClientCerts): string {
139
+ return JSON.stringify(ClientCerts$outboundSchema.parse(clientCerts));
140
+ }
141
+
142
+ export function clientCertsFromJSON(
143
+ jsonString: string,
144
+ ): SafeParseResult<ClientCerts, SDKValidationError> {
145
+ return safeParse(
146
+ jsonString,
147
+ (x) => ClientCerts$inboundSchema.parse(JSON.parse(x)),
148
+ `Failed to parse 'ClientCerts' from JSON`,
149
+ );
150
+ }
151
+
152
+ /** @internal */
153
+ export const GetProjectClientCertsResponseBody$inboundSchema: z.ZodType<
154
+ GetProjectClientCertsResponseBody,
155
+ z.ZodTypeDef,
156
+ unknown
157
+ > = z.object({
158
+ clientCerts: z.array(z.lazy(() => ClientCerts$inboundSchema)),
159
+ });
160
+
161
+ /** @internal */
162
+ export type GetProjectClientCertsResponseBody$Outbound = {
163
+ clientCerts: Array<ClientCerts$Outbound>;
164
+ };
165
+
166
+ /** @internal */
167
+ export const GetProjectClientCertsResponseBody$outboundSchema: z.ZodType<
168
+ GetProjectClientCertsResponseBody$Outbound,
169
+ z.ZodTypeDef,
170
+ GetProjectClientCertsResponseBody
171
+ > = z.object({
172
+ clientCerts: z.array(z.lazy(() => ClientCerts$outboundSchema)),
173
+ });
174
+
175
+ /**
176
+ * @internal
177
+ * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module.
178
+ */
179
+ export namespace GetProjectClientCertsResponseBody$ {
180
+ /** @deprecated use `GetProjectClientCertsResponseBody$inboundSchema` instead. */
181
+ export const inboundSchema = GetProjectClientCertsResponseBody$inboundSchema;
182
+ /** @deprecated use `GetProjectClientCertsResponseBody$outboundSchema` instead. */
183
+ export const outboundSchema =
184
+ GetProjectClientCertsResponseBody$outboundSchema;
185
+ /** @deprecated use `GetProjectClientCertsResponseBody$Outbound` instead. */
186
+ export type Outbound = GetProjectClientCertsResponseBody$Outbound;
187
+ }
188
+
189
+ export function getProjectClientCertsResponseBodyToJSON(
190
+ getProjectClientCertsResponseBody: GetProjectClientCertsResponseBody,
191
+ ): string {
192
+ return JSON.stringify(
193
+ GetProjectClientCertsResponseBody$outboundSchema.parse(
194
+ getProjectClientCertsResponseBody,
195
+ ),
196
+ );
197
+ }
198
+
199
+ export function getProjectClientCertsResponseBodyFromJSON(
200
+ jsonString: string,
201
+ ): SafeParseResult<GetProjectClientCertsResponseBody, SDKValidationError> {
202
+ return safeParse(
203
+ jsonString,
204
+ (x) => GetProjectClientCertsResponseBody$inboundSchema.parse(JSON.parse(x)),
205
+ `Failed to parse 'GetProjectClientCertsResponseBody' from JSON`,
206
+ );
207
+ }