pgbeam 0.3.4 → 0.3.6

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.
@@ -1,3 +1,32 @@
1
+ /**
2
+ * Generated by generate-sdk-ts-maps.ts — do not edit manually.
3
+ * Run: pnpm --filter pgbeam generate
4
+ *
5
+ * Per-operation inputs and success response rendered as compact TypeScript
6
+ * types. Powers the CLI management MCP's describe_endpoint; mirrors the hosted
7
+ * Go management MCP (backend/services/api/mcp).
8
+ */
9
+ interface DescribeParam {
10
+ name: string;
11
+ in: string;
12
+ required: boolean;
13
+ type: string;
14
+ description: string;
15
+ }
16
+ interface DescribeEndpoint {
17
+ operationId: string;
18
+ method: string;
19
+ path: string;
20
+ summary: string;
21
+ description: string;
22
+ parameters: DescribeParam[];
23
+ requestBodyType: string;
24
+ requestBodyRequired: boolean;
25
+ responseType: string;
26
+ responseStatus: string;
27
+ }
28
+ declare const describeByOperationId: Record<string, DescribeEndpoint>;
29
+
1
30
  /**
2
31
  * Generated by Kubb (https://kubb.dev/).
3
32
  * Do not edit manually.
@@ -1881,6 +1910,136 @@ type GetOrganizationPlanRequestConfig = {
1881
1910
  url: `/v1/organizations/${string}/plan`;
1882
1911
  };
1883
1912
 
1913
+ /**
1914
+ * Generated by Kubb (https://kubb.dev/).
1915
+ * Do not edit manually.
1916
+ */
1917
+ declare const vercelResourceStatusStatusEnum: {
1918
+ readonly ready: "ready";
1919
+ readonly suspended: "suspended";
1920
+ readonly deleted: "deleted";
1921
+ };
1922
+ type VercelResourceStatusStatusEnumKey = (typeof vercelResourceStatusStatusEnum)[keyof typeof vercelResourceStatusStatusEnum];
1923
+ /**
1924
+ * @description A PgBeam project provisioned as a Vercel Marketplace resource, with current-period usage.
1925
+ * @type object
1926
+ */
1927
+ type VercelResourceStatus = {
1928
+ /**
1929
+ * @description Vercel resource identifier.
1930
+ * @type string
1931
+ */
1932
+ resource_id: string;
1933
+ /**
1934
+ * @description PgBeam project identifier backing the resource.
1935
+ * @type string
1936
+ */
1937
+ project_id: string;
1938
+ /**
1939
+ * @description Human-readable resource/project name.
1940
+ * @type string
1941
+ */
1942
+ name: string;
1943
+ /**
1944
+ * @description Plan tier the resource is billed on.
1945
+ * @type string
1946
+ */
1947
+ billing_plan_id: string;
1948
+ /**
1949
+ * @description Current resource lifecycle status.
1950
+ * @type string
1951
+ */
1952
+ status: VercelResourceStatusStatusEnumKey;
1953
+ /**
1954
+ * @description Queries this resource has served in the current billing period.
1955
+ * @type integer
1956
+ */
1957
+ period_queries: number;
1958
+ /**
1959
+ * @description Bytes transferred by this resource in the current billing period.
1960
+ * @type integer
1961
+ */
1962
+ period_bytes: number;
1963
+ };
1964
+
1965
+ /**
1966
+ * Generated by Kubb (https://kubb.dev/).
1967
+ * Do not edit manually.
1968
+ */
1969
+
1970
+ /**
1971
+ * @description Vercel Marketplace installation status for an organization, including its resources.
1972
+ * @type object
1973
+ */
1974
+ type VercelInstallationStatus = {
1975
+ /**
1976
+ * @description Vercel installation (integration configuration) identifier.
1977
+ * @type string
1978
+ */
1979
+ installation_id: string;
1980
+ /**
1981
+ * @description Vercel account/team identifier that owns the installation.
1982
+ * @type string
1983
+ */
1984
+ vercel_account_id: string;
1985
+ /**
1986
+ * @description Current plan tier for the organization.
1987
+ * @type string
1988
+ */
1989
+ plan: string;
1990
+ /**
1991
+ * @description Installation status (active).
1992
+ * @type string
1993
+ */
1994
+ status: string;
1995
+ /**
1996
+ * @description When the installation was created.
1997
+ * @type string | undefined
1998
+ */
1999
+ created_at?: string;
2000
+ /**
2001
+ * @description Resources (projects) provisioned under this installation.
2002
+ * @type array
2003
+ */
2004
+ resources: VercelResourceStatus[];
2005
+ };
2006
+
2007
+ /**
2008
+ * Generated by Kubb (https://kubb.dev/).
2009
+ * Do not edit manually.
2010
+ */
2011
+
2012
+ /**
2013
+ * @description Unique organization identifier.
2014
+ * @pattern ^[a-zA-Z0-9_.-]+$
2015
+ * @example org_abc123
2016
+ * @type string
2017
+ */
2018
+ type GetVercelInstallationPathOrgId = string;
2019
+ /**
2020
+ * @description Vercel Marketplace installation status for an organization, including its resources.
2021
+ * @type object
2022
+ */
2023
+ type GetVercelInstallationStatus200 = VercelInstallationStatus;
2024
+ /**
2025
+ * @type object
2026
+ */
2027
+ type GetVercelInstallationRequestConfig = {
2028
+ data?: never;
2029
+ /**
2030
+ * @type object
2031
+ */
2032
+ pathParams: {
2033
+ org_id: GetVercelInstallationPathOrgId;
2034
+ };
2035
+ queryParams?: never;
2036
+ headerParams?: never;
2037
+ /**
2038
+ * @type string
2039
+ */
2040
+ url: `/v1/organizations/${string}/vercel-installation`;
2041
+ };
2042
+
1884
2043
  /**
1885
2044
  * Generated by Kubb (https://kubb.dev/).
1886
2045
  * Do not edit manually.
@@ -7493,6 +7652,10 @@ declare const operationsByTag: {
7493
7652
  readonly method: "GET";
7494
7653
  readonly path: "/v1/organizations/{org_id}/plan";
7495
7654
  };
7655
+ readonly getVercelInstallation: {
7656
+ readonly method: "GET";
7657
+ readonly path: "/v1/organizations/{org_id}/vercel-installation";
7658
+ };
7496
7659
  readonly updateSpendLimit: {
7497
7660
  readonly method: "PUT";
7498
7661
  readonly path: "/v1/organizations/{org_id}/spend-limit";
@@ -7798,6 +7961,11 @@ declare const operationsByPath: {
7798
7961
  readonly path: "/v1/organizations/{org_id}/plan";
7799
7962
  readonly operationId: "getOrganizationPlan";
7800
7963
  };
7964
+ readonly "GET /v1/organizations/{org_id}/vercel-installation": {
7965
+ readonly method: "GET";
7966
+ readonly path: "/v1/organizations/{org_id}/vercel-installation";
7967
+ readonly operationId: "getVercelInstallation";
7968
+ };
7801
7969
  readonly "PUT /v1/organizations/{org_id}/spend-limit": {
7802
7970
  readonly method: "PUT";
7803
7971
  readonly path: "/v1/organizations/{org_id}/spend-limit";
@@ -8116,6 +8284,9 @@ type ExportAuditLogsParams = {
8116
8284
  type GetOrganizationPlanParams = {
8117
8285
  pathParams: NonNullable<GetOrganizationPlanRequestConfig["pathParams"]>;
8118
8286
  };
8287
+ type GetVercelInstallationParams = {
8288
+ pathParams: NonNullable<GetVercelInstallationRequestConfig["pathParams"]>;
8289
+ };
8119
8290
  type UpdateSpendLimitParams = {
8120
8291
  pathParams: NonNullable<UpdateSpendLimitRequestConfig["pathParams"]>;
8121
8292
  body: NonNullable<UpdateSpendLimitRequestConfig["data"]>;
@@ -8326,6 +8497,7 @@ interface ApiOperations {
8326
8497
  analytics: {
8327
8498
  listPlans(): Promise<ListPlansStatus200>;
8328
8499
  getOrganizationPlan(params: GetOrganizationPlanParams): Promise<GetOrganizationPlanStatus200>;
8500
+ getVercelInstallation(params: GetVercelInstallationParams): Promise<GetVercelInstallationStatus200>;
8329
8501
  updateSpendLimit(params: UpdateSpendLimitParams): Promise<UpdateSpendLimitStatus200>;
8330
8502
  submitCancellationFeedback(params: SubmitCancellationFeedbackParams): Promise<void>;
8331
8503
  getProjectInsights(params: GetProjectInsightsParams): Promise<GetProjectInsightsStatus200>;
@@ -8462,6 +8634,10 @@ interface RequestMap {
8462
8634
  params: GetOrganizationPlanParams;
8463
8635
  response: GetOrganizationPlanStatus200;
8464
8636
  };
8637
+ "GET /v1/organizations/{org_id}/vercel-installation": {
8638
+ params: GetVercelInstallationParams;
8639
+ response: GetVercelInstallationStatus200;
8640
+ };
8465
8641
  "PUT /v1/organizations/{org_id}/spend-limit": {
8466
8642
  params: UpdateSpendLimitParams;
8467
8643
  response: UpdateSpendLimitStatus200;
@@ -8678,5 +8854,5 @@ interface RequestMap {
8678
8854
  type ApiTag = keyof ApiOperations;
8679
8855
  type Route = keyof RequestMap;
8680
8856
 
8681
- export { operationsByPath, operationsByTag };
8682
- export type { ApiOperations, ApiTag, RequestMap, Route };
8857
+ export { describeByOperationId, operationsByPath, operationsByTag };
8858
+ export type { ApiOperations, ApiTag, DescribeEndpoint, DescribeParam, RequestMap, Route };
@@ -1,3 +1,32 @@
1
+ /**
2
+ * Generated by generate-sdk-ts-maps.ts — do not edit manually.
3
+ * Run: pnpm --filter pgbeam generate
4
+ *
5
+ * Per-operation inputs and success response rendered as compact TypeScript
6
+ * types. Powers the CLI management MCP's describe_endpoint; mirrors the hosted
7
+ * Go management MCP (backend/services/api/mcp).
8
+ */
9
+ interface DescribeParam {
10
+ name: string;
11
+ in: string;
12
+ required: boolean;
13
+ type: string;
14
+ description: string;
15
+ }
16
+ interface DescribeEndpoint {
17
+ operationId: string;
18
+ method: string;
19
+ path: string;
20
+ summary: string;
21
+ description: string;
22
+ parameters: DescribeParam[];
23
+ requestBodyType: string;
24
+ requestBodyRequired: boolean;
25
+ responseType: string;
26
+ responseStatus: string;
27
+ }
28
+ declare const describeByOperationId: Record<string, DescribeEndpoint>;
29
+
1
30
  /**
2
31
  * Generated by Kubb (https://kubb.dev/).
3
32
  * Do not edit manually.
@@ -1881,6 +1910,136 @@ type GetOrganizationPlanRequestConfig = {
1881
1910
  url: `/v1/organizations/${string}/plan`;
1882
1911
  };
1883
1912
 
1913
+ /**
1914
+ * Generated by Kubb (https://kubb.dev/).
1915
+ * Do not edit manually.
1916
+ */
1917
+ declare const vercelResourceStatusStatusEnum: {
1918
+ readonly ready: "ready";
1919
+ readonly suspended: "suspended";
1920
+ readonly deleted: "deleted";
1921
+ };
1922
+ type VercelResourceStatusStatusEnumKey = (typeof vercelResourceStatusStatusEnum)[keyof typeof vercelResourceStatusStatusEnum];
1923
+ /**
1924
+ * @description A PgBeam project provisioned as a Vercel Marketplace resource, with current-period usage.
1925
+ * @type object
1926
+ */
1927
+ type VercelResourceStatus = {
1928
+ /**
1929
+ * @description Vercel resource identifier.
1930
+ * @type string
1931
+ */
1932
+ resource_id: string;
1933
+ /**
1934
+ * @description PgBeam project identifier backing the resource.
1935
+ * @type string
1936
+ */
1937
+ project_id: string;
1938
+ /**
1939
+ * @description Human-readable resource/project name.
1940
+ * @type string
1941
+ */
1942
+ name: string;
1943
+ /**
1944
+ * @description Plan tier the resource is billed on.
1945
+ * @type string
1946
+ */
1947
+ billing_plan_id: string;
1948
+ /**
1949
+ * @description Current resource lifecycle status.
1950
+ * @type string
1951
+ */
1952
+ status: VercelResourceStatusStatusEnumKey;
1953
+ /**
1954
+ * @description Queries this resource has served in the current billing period.
1955
+ * @type integer
1956
+ */
1957
+ period_queries: number;
1958
+ /**
1959
+ * @description Bytes transferred by this resource in the current billing period.
1960
+ * @type integer
1961
+ */
1962
+ period_bytes: number;
1963
+ };
1964
+
1965
+ /**
1966
+ * Generated by Kubb (https://kubb.dev/).
1967
+ * Do not edit manually.
1968
+ */
1969
+
1970
+ /**
1971
+ * @description Vercel Marketplace installation status for an organization, including its resources.
1972
+ * @type object
1973
+ */
1974
+ type VercelInstallationStatus = {
1975
+ /**
1976
+ * @description Vercel installation (integration configuration) identifier.
1977
+ * @type string
1978
+ */
1979
+ installation_id: string;
1980
+ /**
1981
+ * @description Vercel account/team identifier that owns the installation.
1982
+ * @type string
1983
+ */
1984
+ vercel_account_id: string;
1985
+ /**
1986
+ * @description Current plan tier for the organization.
1987
+ * @type string
1988
+ */
1989
+ plan: string;
1990
+ /**
1991
+ * @description Installation status (active).
1992
+ * @type string
1993
+ */
1994
+ status: string;
1995
+ /**
1996
+ * @description When the installation was created.
1997
+ * @type string | undefined
1998
+ */
1999
+ created_at?: string;
2000
+ /**
2001
+ * @description Resources (projects) provisioned under this installation.
2002
+ * @type array
2003
+ */
2004
+ resources: VercelResourceStatus[];
2005
+ };
2006
+
2007
+ /**
2008
+ * Generated by Kubb (https://kubb.dev/).
2009
+ * Do not edit manually.
2010
+ */
2011
+
2012
+ /**
2013
+ * @description Unique organization identifier.
2014
+ * @pattern ^[a-zA-Z0-9_.-]+$
2015
+ * @example org_abc123
2016
+ * @type string
2017
+ */
2018
+ type GetVercelInstallationPathOrgId = string;
2019
+ /**
2020
+ * @description Vercel Marketplace installation status for an organization, including its resources.
2021
+ * @type object
2022
+ */
2023
+ type GetVercelInstallationStatus200 = VercelInstallationStatus;
2024
+ /**
2025
+ * @type object
2026
+ */
2027
+ type GetVercelInstallationRequestConfig = {
2028
+ data?: never;
2029
+ /**
2030
+ * @type object
2031
+ */
2032
+ pathParams: {
2033
+ org_id: GetVercelInstallationPathOrgId;
2034
+ };
2035
+ queryParams?: never;
2036
+ headerParams?: never;
2037
+ /**
2038
+ * @type string
2039
+ */
2040
+ url: `/v1/organizations/${string}/vercel-installation`;
2041
+ };
2042
+
1884
2043
  /**
1885
2044
  * Generated by Kubb (https://kubb.dev/).
1886
2045
  * Do not edit manually.
@@ -7493,6 +7652,10 @@ declare const operationsByTag: {
7493
7652
  readonly method: "GET";
7494
7653
  readonly path: "/v1/organizations/{org_id}/plan";
7495
7654
  };
7655
+ readonly getVercelInstallation: {
7656
+ readonly method: "GET";
7657
+ readonly path: "/v1/organizations/{org_id}/vercel-installation";
7658
+ };
7496
7659
  readonly updateSpendLimit: {
7497
7660
  readonly method: "PUT";
7498
7661
  readonly path: "/v1/organizations/{org_id}/spend-limit";
@@ -7798,6 +7961,11 @@ declare const operationsByPath: {
7798
7961
  readonly path: "/v1/organizations/{org_id}/plan";
7799
7962
  readonly operationId: "getOrganizationPlan";
7800
7963
  };
7964
+ readonly "GET /v1/organizations/{org_id}/vercel-installation": {
7965
+ readonly method: "GET";
7966
+ readonly path: "/v1/organizations/{org_id}/vercel-installation";
7967
+ readonly operationId: "getVercelInstallation";
7968
+ };
7801
7969
  readonly "PUT /v1/organizations/{org_id}/spend-limit": {
7802
7970
  readonly method: "PUT";
7803
7971
  readonly path: "/v1/organizations/{org_id}/spend-limit";
@@ -8116,6 +8284,9 @@ type ExportAuditLogsParams = {
8116
8284
  type GetOrganizationPlanParams = {
8117
8285
  pathParams: NonNullable<GetOrganizationPlanRequestConfig["pathParams"]>;
8118
8286
  };
8287
+ type GetVercelInstallationParams = {
8288
+ pathParams: NonNullable<GetVercelInstallationRequestConfig["pathParams"]>;
8289
+ };
8119
8290
  type UpdateSpendLimitParams = {
8120
8291
  pathParams: NonNullable<UpdateSpendLimitRequestConfig["pathParams"]>;
8121
8292
  body: NonNullable<UpdateSpendLimitRequestConfig["data"]>;
@@ -8326,6 +8497,7 @@ interface ApiOperations {
8326
8497
  analytics: {
8327
8498
  listPlans(): Promise<ListPlansStatus200>;
8328
8499
  getOrganizationPlan(params: GetOrganizationPlanParams): Promise<GetOrganizationPlanStatus200>;
8500
+ getVercelInstallation(params: GetVercelInstallationParams): Promise<GetVercelInstallationStatus200>;
8329
8501
  updateSpendLimit(params: UpdateSpendLimitParams): Promise<UpdateSpendLimitStatus200>;
8330
8502
  submitCancellationFeedback(params: SubmitCancellationFeedbackParams): Promise<void>;
8331
8503
  getProjectInsights(params: GetProjectInsightsParams): Promise<GetProjectInsightsStatus200>;
@@ -8462,6 +8634,10 @@ interface RequestMap {
8462
8634
  params: GetOrganizationPlanParams;
8463
8635
  response: GetOrganizationPlanStatus200;
8464
8636
  };
8637
+ "GET /v1/organizations/{org_id}/vercel-installation": {
8638
+ params: GetVercelInstallationParams;
8639
+ response: GetVercelInstallationStatus200;
8640
+ };
8465
8641
  "PUT /v1/organizations/{org_id}/spend-limit": {
8466
8642
  params: UpdateSpendLimitParams;
8467
8643
  response: UpdateSpendLimitStatus200;
@@ -8678,5 +8854,5 @@ interface RequestMap {
8678
8854
  type ApiTag = keyof ApiOperations;
8679
8855
  type Route = keyof RequestMap;
8680
8856
 
8681
- export { operationsByPath, operationsByTag };
8682
- export type { ApiOperations, ApiTag, RequestMap, Route };
8857
+ export { describeByOperationId, operationsByPath, operationsByTag };
8858
+ export type { ApiOperations, ApiTag, DescribeEndpoint, DescribeParam, RequestMap, Route };