vercel-api-js 0.1.17 → 0.1.18

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
package/dist/index.d.ts CHANGED
@@ -3,6 +3,10 @@
3
3
  *
4
4
  * @version 0.0.1
5
5
  */
6
+ /**
7
+ * Enum containing the actions that can be performed against a resource. Group operations are included.
8
+ */
9
+ type ACLAction = 'create' | 'delete' | 'read' | 'update' | 'list' | 'count';
6
10
  /**
7
11
  * This object contains information related to the pagination of the current request, including the necessary parameters to get the next or previous page of data.
8
12
  */
@@ -114,10 +118,6 @@ type UserEvent = {
114
118
  */
115
119
  userId: string;
116
120
  };
117
- /**
118
- * Enum containing the actions that can be performed against a resource. Group operations are included.
119
- */
120
- type ACLAction = 'create' | 'delete' | 'read' | 'update' | 'list' | 'count';
121
121
  /**
122
122
  * Data representing a Team.
123
123
  */
@@ -243,7 +243,7 @@ type TeamLimited = {
243
243
  createdAt: number;
244
244
  created: number;
245
245
  joinedFrom?: {
246
- origin: 'import' | 'link' | 'saml' | 'mail' | 'teams' | 'github' | 'gitlab' | 'bitbucket' | 'dsync' | 'feedback' | 'organization-teams';
246
+ origin: 'link' | 'import' | 'saml' | 'mail' | 'teams' | 'github' | 'gitlab' | 'bitbucket' | 'dsync' | 'feedback' | 'organization-teams';
247
247
  commitId?: string;
248
248
  repoId?: string;
249
249
  repoPath?: string;
@@ -265,7 +265,7 @@ type TeamLimited = {
265
265
  createdAt: number;
266
266
  created: number;
267
267
  joinedFrom?: {
268
- origin: 'import' | 'link' | 'saml' | 'mail' | 'teams' | 'github' | 'gitlab' | 'bitbucket' | 'dsync' | 'feedback' | 'organization-teams';
268
+ origin: 'link' | 'import' | 'saml' | 'mail' | 'teams' | 'github' | 'gitlab' | 'bitbucket' | 'dsync' | 'feedback' | 'organization-teams';
269
269
  commitId?: string;
270
270
  repoId?: string;
271
271
  repoPath?: string;
@@ -311,7 +311,6 @@ type AuthUser = {
311
311
  */
312
312
  billing: {
313
313
  currency?: 'usd' | 'eur';
314
- addons?: ('custom-deployment-suffix' | 'live-support')[] | null;
315
314
  cancelation?: number | null;
316
315
  period: {
317
316
  start: number;
@@ -739,6 +738,33 @@ type AuthUser = {
739
738
  hidden: boolean;
740
739
  disabledAt?: number | null;
741
740
  };
741
+ dataCacheRead?: {
742
+ tier?: number;
743
+ price: number;
744
+ batch: number;
745
+ threshold: number;
746
+ name?: string;
747
+ hidden: boolean;
748
+ disabledAt?: number | null;
749
+ };
750
+ dataCacheRevalidation?: {
751
+ tier?: number;
752
+ price: number;
753
+ batch: number;
754
+ threshold: number;
755
+ name?: string;
756
+ hidden: boolean;
757
+ disabledAt?: number | null;
758
+ };
759
+ dataCacheWrite?: {
760
+ tier?: number;
761
+ price: number;
762
+ batch: number;
763
+ threshold: number;
764
+ name?: string;
765
+ hidden: boolean;
766
+ disabledAt?: number | null;
767
+ };
742
768
  } | null;
743
769
  invoiceSettings?: {
744
770
  footer?: string;
@@ -788,37 +814,52 @@ type AuthUser = {
788
814
  * An object containing infomation related to the amount of platform resources may be allocated to the User account.
789
815
  */
790
816
  resourceConfig: {
817
+ /**
818
+ * An object containing infomation related to the amount of platform resources may be allocated to the User account.
819
+ */
791
820
  nodeType?: string;
821
+ /**
822
+ * An object containing infomation related to the amount of platform resources may be allocated to the User account.
823
+ */
792
824
  concurrentBuilds?: number;
825
+ /**
826
+ * An object containing infomation related to the amount of platform resources may be allocated to the User account.
827
+ */
793
828
  awsAccountType?: string;
829
+ /**
830
+ * An object containing infomation related to the amount of platform resources may be allocated to the User account.
831
+ */
794
832
  awsAccountIds?: string[];
833
+ /**
834
+ * An object containing infomation related to the amount of platform resources may be allocated to the User account.
835
+ */
795
836
  cfZoneName?: string;
796
837
  /**
797
- * To overwrite the number of Edge Configs an account can create.
838
+ * An object containing infomation related to the amount of platform resources may be allocated to the User account.
798
839
  */
799
840
  edgeConfigs?: number;
800
841
  /**
801
- * To overwrite the maximum size of an Edge Config per account. Size is in kilobytes, eg 64 leads to 64kB or 64_000 bytes worth of storage
842
+ * An object containing infomation related to the amount of platform resources may be allocated to the User account.
802
843
  */
803
844
  edgeConfigSize?: number;
804
845
  /**
805
- * The maximum size for an Edge Function per account. Format is in bytes. eg output of `bytes('3mb')`
846
+ * An object containing infomation related to the amount of platform resources may be allocated to the User account.
806
847
  */
807
848
  edgeFunctionMaxSizeBytes?: number;
808
849
  /**
809
- * The maximum time to wait (in milliseconds) for the response headers.
850
+ * An object containing infomation related to the amount of platform resources may be allocated to the User account.
810
851
  */
811
852
  edgeFunctionExecutionTimeoutMs?: number;
812
853
  /**
813
- * To overwrite the number of KV databases an account can create.
854
+ * An object containing infomation related to the amount of platform resources may be allocated to the User account.
814
855
  */
815
856
  kvDatabases?: number;
816
857
  /**
817
- * To overwrite the number of Postgres databases an account can create.
858
+ * An object containing infomation related to the amount of platform resources may be allocated to the User account.
818
859
  */
819
860
  postgresDatabases?: number;
820
861
  /**
821
- * To overwrite the number of Blob stores an account can create.
862
+ * An object containing infomation related to the amount of platform resources may be allocated to the User account.
822
863
  */
823
864
  blobStores?: number;
824
865
  };
@@ -872,6 +913,12 @@ type AuthUser = {
872
913
  remoteCaching?: {
873
914
  enabled?: boolean;
874
915
  };
916
+ /**
917
+ * data cache settings
918
+ */
919
+ dataCache?: {
920
+ excessBillingEnabled?: boolean;
921
+ };
875
922
  /**
876
923
  * The User's unique identifier.
877
924
  *
@@ -1322,74 +1369,6 @@ type ArtifactQueryVariables = {
1322
1369
  * Query information about an array of artifacts.
1323
1370
  */
1324
1371
  declare const artifactQuery: (variables: ArtifactQueryVariables, signal?: AbortSignal) => Promise<ArtifactQueryResponse>;
1325
- type GetAllChecksPathParams = {
1326
- /**
1327
- * The deployment to get all checks for
1328
- *
1329
- * @example dpl_2qn7PZrx89yxY34vEZPD31Y9XVj6
1330
- */
1331
- deploymentId: string;
1332
- };
1333
- type GetAllChecksQueryParams = {
1334
- /**
1335
- * The Team identifier or slug to perform the request on behalf of.
1336
- */
1337
- teamId?: string;
1338
- };
1339
- type GetAllChecksError = ErrorWrapper<undefined>;
1340
- type GetAllChecksResponse = {
1341
- checks: {
1342
- completedAt?: number;
1343
- conclusion?: 'canceled' | 'failed' | 'neutral' | 'succeeded' | 'skipped' | 'stale';
1344
- createdAt: number;
1345
- detailsUrl?: string;
1346
- id: string;
1347
- integrationId: string;
1348
- name: string;
1349
- output?: {
1350
- metrics?: {
1351
- FCP: {
1352
- value: number | null;
1353
- previousValue?: number;
1354
- source: 'web-vitals';
1355
- };
1356
- LCP: {
1357
- value: number | null;
1358
- previousValue?: number;
1359
- source: 'web-vitals';
1360
- };
1361
- CLS: {
1362
- value: number | null;
1363
- previousValue?: number;
1364
- source: 'web-vitals';
1365
- };
1366
- TBT: {
1367
- value: number | null;
1368
- previousValue?: number;
1369
- source: 'web-vitals';
1370
- };
1371
- virtualExperienceScore?: {
1372
- value: number | null;
1373
- previousValue?: number;
1374
- source: 'web-vitals';
1375
- };
1376
- };
1377
- };
1378
- path?: string;
1379
- rerequestable: boolean;
1380
- startedAt?: number;
1381
- status: 'registered' | 'running' | 'completed';
1382
- updatedAt: number;
1383
- }[];
1384
- };
1385
- type GetAllChecksVariables = {
1386
- pathParams: GetAllChecksPathParams;
1387
- queryParams?: GetAllChecksQueryParams;
1388
- } & FetcherExtraProps;
1389
- /**
1390
- * List all of the checks created for a deployment.
1391
- */
1392
- declare const getAllChecks: (variables: GetAllChecksVariables, signal?: AbortSignal) => Promise<GetAllChecksResponse>;
1393
1372
  type CreateCheckPathParams = {
1394
1373
  /**
1395
1374
  * The deployment to create the check for.
@@ -1500,6 +1479,74 @@ type CreateCheckVariables = {
1500
1479
  * Creates a new check. This endpoint must be called with an OAuth2 or it will produce a 400 error.
1501
1480
  */
1502
1481
  declare const createCheck: (variables: CreateCheckVariables, signal?: AbortSignal) => Promise<CreateCheckResponse>;
1482
+ type GetAllChecksPathParams = {
1483
+ /**
1484
+ * The deployment to get all checks for
1485
+ *
1486
+ * @example dpl_2qn7PZrx89yxY34vEZPD31Y9XVj6
1487
+ */
1488
+ deploymentId: string;
1489
+ };
1490
+ type GetAllChecksQueryParams = {
1491
+ /**
1492
+ * The Team identifier or slug to perform the request on behalf of.
1493
+ */
1494
+ teamId?: string;
1495
+ };
1496
+ type GetAllChecksError = ErrorWrapper<undefined>;
1497
+ type GetAllChecksResponse = {
1498
+ checks: {
1499
+ completedAt?: number;
1500
+ conclusion?: 'canceled' | 'failed' | 'neutral' | 'succeeded' | 'skipped' | 'stale';
1501
+ createdAt: number;
1502
+ detailsUrl?: string;
1503
+ id: string;
1504
+ integrationId: string;
1505
+ name: string;
1506
+ output?: {
1507
+ metrics?: {
1508
+ FCP: {
1509
+ value: number | null;
1510
+ previousValue?: number;
1511
+ source: 'web-vitals';
1512
+ };
1513
+ LCP: {
1514
+ value: number | null;
1515
+ previousValue?: number;
1516
+ source: 'web-vitals';
1517
+ };
1518
+ CLS: {
1519
+ value: number | null;
1520
+ previousValue?: number;
1521
+ source: 'web-vitals';
1522
+ };
1523
+ TBT: {
1524
+ value: number | null;
1525
+ previousValue?: number;
1526
+ source: 'web-vitals';
1527
+ };
1528
+ virtualExperienceScore?: {
1529
+ value: number | null;
1530
+ previousValue?: number;
1531
+ source: 'web-vitals';
1532
+ };
1533
+ };
1534
+ };
1535
+ path?: string;
1536
+ rerequestable: boolean;
1537
+ startedAt?: number;
1538
+ status: 'registered' | 'running' | 'completed';
1539
+ updatedAt: number;
1540
+ }[];
1541
+ };
1542
+ type GetAllChecksVariables = {
1543
+ pathParams: GetAllChecksPathParams;
1544
+ queryParams?: GetAllChecksQueryParams;
1545
+ } & FetcherExtraProps;
1546
+ /**
1547
+ * List all of the checks created for a deployment.
1548
+ */
1549
+ declare const getAllChecks: (variables: GetAllChecksVariables, signal?: AbortSignal) => Promise<GetAllChecksResponse>;
1503
1550
  type GetCheckPathParams = {
1504
1551
  /**
1505
1552
  * The deployment to get the check for.
@@ -1805,209 +1852,697 @@ type RerequestCheckVariables = {
1805
1852
  * Rerequest a selected check that has failed.
1806
1853
  */
1807
1854
  declare const rerequestCheck: (variables: RerequestCheckVariables, signal?: AbortSignal) => Promise<Record<string, any>>;
1808
- type GetDeploymentEventsPathParams = {
1855
+ type UpdateProjectDataCachePathParams = {
1809
1856
  /**
1810
- * The unique identifier or hostname of the deployment.
1857
+ * The unique project identifier
1811
1858
  *
1812
- * @example dpl_5WJWYSyB7BpgTj3EuwF37WMRBXBtPQ2iTMJHJBJyRfd
1859
+ * @example prj_12HKQaOmR5t5Uy6vdcQsNIiZgHGB
1813
1860
  */
1814
- idOrUrl: string;
1861
+ projectId: string;
1815
1862
  };
1816
- type GetDeploymentEventsQueryParams = {
1817
- /**
1818
- * Order of the returned events based on the timestamp.
1819
- *
1820
- * @default forward
1821
- * @example backward
1822
- */
1823
- direction?: 'backward' | 'forward';
1824
- /**
1825
- * When enabled, this endpoint will return live events as they happen.
1826
- *
1827
- * @example 1
1828
- */
1829
- follow?: 0 | 1;
1830
- /**
1831
- * Maximum number of events to return. Provide `-1` to return all available logs.
1832
- *
1833
- * @example 100
1834
- */
1835
- limit?: number;
1836
- /**
1837
- * Deployment build ID.
1838
- *
1839
- * @example bld_cotnkcr76
1840
- */
1841
- name?: string;
1842
- /**
1843
- * Timestamp for when build logs should be pulled from.
1844
- *
1845
- * @example 1540095775941
1846
- */
1847
- since?: number;
1848
- /**
1849
- * Timestamp for when the build logs should be pulled up until.
1850
- *
1851
- * @example 1540106318643
1852
- */
1853
- until?: number;
1854
- /**
1855
- * HTTP status code range to filter events by.
1856
- *
1857
- * @example 5xx
1858
- */
1859
- statusCode?: number | string;
1860
- /**
1861
- * @example 1
1862
- */
1863
- delimiter?: 0 | 1;
1864
- /**
1865
- * @example 1
1866
- */
1867
- builds?: 0 | 1;
1863
+ type UpdateProjectDataCacheQueryParams = {
1868
1864
  /**
1869
1865
  * The Team identifier or slug to perform the request on behalf of.
1870
1866
  */
1871
1867
  teamId?: string;
1872
1868
  };
1873
- type GetDeploymentEventsError = ErrorWrapper<undefined>;
1874
- type GetDeploymentEventsResponse = ({
1875
- type: 'command';
1876
- created: number;
1877
- payload: {
1878
- deploymentId: string;
1879
- text?: string;
1869
+ type UpdateProjectDataCacheError = ErrorWrapper<undefined>;
1870
+ type UpdateProjectDataCacheResponse = {
1871
+ accountId: string;
1872
+ analytics?: {
1880
1873
  id: string;
1881
- date: number;
1882
- serial: string;
1874
+ canceledAt: number | null;
1875
+ disabledAt: number;
1876
+ enabledAt: number;
1877
+ paidAt?: number;
1878
+ sampleRatePercent?: number | null;
1879
+ spendLimitInDollars?: number | null;
1883
1880
  };
1884
- } | {
1885
- type: 'deployment-state';
1886
- created: number;
1887
- payload: {
1888
- deploymentId: string;
1889
- info: {
1890
- type: string;
1891
- name: string;
1892
- entrypoint?: string;
1893
- path?: string;
1894
- step?: string;
1895
- };
1896
- id: string;
1897
- date: number;
1898
- serial: string;
1899
- };
1900
- } | {
1901
- type: 'delimiter';
1902
- created: number;
1903
- payload: {
1904
- deploymentId: string;
1905
- info: {
1906
- type: string;
1907
- name: string;
1908
- entrypoint?: string;
1909
- path?: string;
1910
- step?: string;
1911
- };
1912
- id: string;
1913
- date: number;
1914
- serial: string;
1881
+ autoExposeSystemEnvs?: boolean;
1882
+ buildCommand?: string | null;
1883
+ commandForIgnoringBuildStep?: string | null;
1884
+ connectConfigurationId?: string | null;
1885
+ connectBuildsEnabled?: boolean;
1886
+ createdAt?: number;
1887
+ dataCache?: {
1888
+ userEnabled: boolean;
1889
+ enableAt: number | null;
1915
1890
  };
1916
- } | {
1917
- type: 'exit';
1918
- created: number;
1919
- payload: {
1920
- date: number;
1921
- text?: string;
1922
- id: string;
1923
- deploymentId: string;
1924
- created: number;
1925
- serial: string;
1891
+ crons?: {
1892
+ /**
1893
+ * The time the feature was enabled for this project. Note: It enables automatically with the first Deployment that outputs cronjobs.
1894
+ */
1895
+ enabledAt: number;
1896
+ /**
1897
+ * The time the feature was disabled for this project.
1898
+ */
1899
+ disabledAt: number | null;
1900
+ updatedAt: number;
1901
+ /**
1902
+ * The ID of the Deployment from which the definitions originated.
1903
+ */
1904
+ deploymentId: string | null;
1905
+ definitions: {
1906
+ /**
1907
+ * The hostname that should be used.
1908
+ *
1909
+ * @example vercel.com
1910
+ */
1911
+ host: string;
1912
+ /**
1913
+ * The path that should be called for the cronjob.
1914
+ *
1915
+ * @example /api/crons/sync-something?hello=world
1916
+ */
1917
+ path: string;
1918
+ /**
1919
+ * The cron expression.
1920
+ *
1921
+ * @example 0 0 * * *
1922
+ */
1923
+ schedule: string;
1924
+ }[];
1926
1925
  };
1927
- } | {
1928
- type: 'middleware';
1929
- created: number;
1930
- payload: {
1931
- deploymentId: string;
1932
- info: {
1933
- type: string;
1934
- name: string;
1935
- entrypoint?: string;
1936
- path?: string;
1937
- step?: string;
1938
- };
1939
- text?: string;
1926
+ devCommand?: string | null;
1927
+ directoryListing: boolean;
1928
+ installCommand?: string | null;
1929
+ env?: {
1930
+ target?: ('production' | 'preview' | 'development' | 'preview' | 'development')[] | ('production' | 'preview' | 'development' | 'preview' | 'development');
1931
+ type: 'secret' | 'system' | 'encrypted' | 'plain' | 'sensitive';
1932
+ id?: string;
1933
+ key: string;
1934
+ value: string;
1935
+ configurationId?: string | null;
1936
+ createdAt?: number;
1937
+ updatedAt?: number;
1938
+ createdBy?: string | null;
1939
+ updatedBy?: string | null;
1940
+ gitBranch?: string;
1941
+ edgeConfigId?: string | null;
1942
+ edgeConfigTokenId?: string | null;
1943
+ contentHint?: {
1944
+ type: 'redis-url';
1945
+ storeId: string;
1946
+ } | {
1947
+ type: 'redis-rest-api-url';
1948
+ storeId: string;
1949
+ } | {
1950
+ type: 'redis-rest-api-token';
1951
+ storeId: string;
1952
+ } | {
1953
+ type: 'redis-rest-api-read-only-token';
1954
+ storeId: string;
1955
+ } | {
1956
+ type: 'blob-read-write-token';
1957
+ storeId: string;
1958
+ } | {
1959
+ type: 'postgres-url';
1960
+ storeId: string;
1961
+ } | {
1962
+ type: 'postgres-url-non-pooling';
1963
+ storeId: string;
1964
+ } | {
1965
+ type: 'postgres-prisma-url';
1966
+ storeId: string;
1967
+ } | {
1968
+ type: 'postgres-user';
1969
+ storeId: string;
1970
+ } | {
1971
+ type: 'postgres-host';
1972
+ storeId: string;
1973
+ } | {
1974
+ type: 'postgres-password';
1975
+ storeId: string;
1976
+ } | {
1977
+ type: 'postgres-database';
1978
+ storeId: string;
1979
+ } | null;
1980
+ /**
1981
+ * Whether `value` is decrypted.
1982
+ */
1983
+ decrypted?: boolean;
1984
+ }[];
1985
+ framework?: 'blitzjs' | 'nextjs' | 'gatsby' | 'remix' | 'astro' | 'hexo' | 'eleventy' | 'docusaurus-2' | 'docusaurus' | 'preact' | 'solidstart' | 'dojo' | 'ember' | 'vue' | 'scully' | 'ionic-angular' | 'angular' | 'polymer' | 'svelte' | 'sveltekit' | 'sveltekit-1' | 'ionic-react' | 'create-react-app' | 'gridsome' | 'umijs' | 'sapper' | 'saber' | 'stencil' | 'nuxtjs' | 'redwoodjs' | 'hugo' | 'jekyll' | 'brunch' | 'middleman' | 'zola' | 'hydrogen' | 'vite' | 'vitepress' | 'vuepress' | 'parcel' | 'sanity' | 'storybook' | null;
1986
+ gitForkProtection?: boolean;
1987
+ gitLFS?: boolean;
1988
+ id: string;
1989
+ latestDeployments?: {
1990
+ alias?: string[];
1991
+ aliasAssigned?: number | boolean | null;
1992
+ aliasError?: {
1993
+ code: string;
1994
+ message: string;
1995
+ } | null;
1996
+ aliasFinal?: string | null;
1997
+ automaticAliases?: string[];
1998
+ builds?: {
1999
+ use: string;
2000
+ src?: string;
2001
+ dest?: string;
2002
+ }[];
2003
+ connectConfigurationId?: string;
2004
+ createdAt: number;
2005
+ createdIn: string;
2006
+ creator: {
2007
+ email: string;
2008
+ githubLogin?: string;
2009
+ gitlabLogin?: string;
2010
+ uid: string;
2011
+ username: string;
2012
+ } | null;
2013
+ deploymentHostname: string;
2014
+ name: string;
2015
+ forced?: boolean;
1940
2016
  id: string;
1941
- date: number;
1942
- serial: string;
1943
- requestId?: string;
1944
- };
1945
- } | {
1946
- type: 'delimiter' | 'command' | 'stdout' | 'stderr' | 'exit' | 'deployment-state' | 'middleware' | 'middleware-invocation' | 'edge-function-invocation' | 'fatal';
1947
- created: number;
1948
- payload: {
1949
- deploymentId: string;
1950
- info: {
1951
- type: string;
1952
- name: string;
1953
- entrypoint?: string;
1954
- path?: string;
1955
- step?: string;
2017
+ meta?: {
2018
+ [key: string]: string;
1956
2019
  };
1957
- text?: string;
1958
- id: string;
1959
- date: number;
1960
- serial: string;
1961
- statusCode?: number;
1962
- requestId?: string;
1963
- };
1964
- })[];
1965
- type GetDeploymentEventsVariables = {
1966
- pathParams: GetDeploymentEventsPathParams;
1967
- queryParams?: GetDeploymentEventsQueryParams;
1968
- } & FetcherExtraProps;
1969
- /**
1970
- * Get the build logs of a deployment by deployment ID and build ID. It can work as an infinite stream of logs or as a JSON endpoint depending on the input parameters.
1971
- */
1972
- declare const getDeploymentEvents: (variables: GetDeploymentEventsVariables, signal?: AbortSignal) => Promise<GetDeploymentEventsResponse>;
1973
- type GetDeploymentPathParams = {
1974
- /**
1975
- * The unique identifier or hostname of the deployment.
1976
- *
1977
- * @example dpl_89qyp1cskzkLrVicDaZoDbjyHuDJ
1978
- */
1979
- idOrUrl: string;
1980
- };
1981
- type GetDeploymentQueryParams = {
1982
- /**
1983
- * Whether to add in gitRepo information.
1984
- *
1985
- * @example true
1986
- */
1987
- withGitRepoInfo?: string;
1988
- /**
1989
- * The Team identifier or slug to perform the request on behalf of.
1990
- */
1991
- teamId?: string;
1992
- };
1993
- type GetDeploymentError = ErrorWrapper<undefined>;
1994
- type GetDeploymentVariables = {
1995
- pathParams: GetDeploymentPathParams;
1996
- queryParams?: GetDeploymentQueryParams;
1997
- } & FetcherExtraProps;
1998
- /**
1999
- * Retrieves information for a deployment either by supplying its ID (`id` property) or Hostname (`url` property). Additional details will be included when the authenticated user is an owner of the deployment.
2000
- */
2001
- declare const getDeployment: (variables: GetDeploymentVariables, signal?: AbortSignal) => Promise<{
2002
- aliasAssignedAt?: number | boolean | null;
2003
- build: {
2020
+ monorepoManager?: string | null;
2021
+ plan: 'hobby' | 'enterprise' | 'pro' | 'oss';
2022
+ private: boolean;
2023
+ readyState: 'BUILDING' | 'ERROR' | 'INITIALIZING' | 'QUEUED' | 'READY' | 'CANCELED';
2024
+ requestedAt?: number;
2025
+ target?: string | null;
2026
+ teamId?: string | null;
2027
+ type: 'LAMBDAS';
2028
+ url: string;
2029
+ userId: string;
2030
+ withCache?: boolean;
2031
+ checksConclusion?: 'succeeded' | 'failed' | 'skipped' | 'canceled';
2032
+ checksState?: 'registered' | 'running' | 'completed';
2033
+ readyAt?: number;
2034
+ buildingAt?: number;
2004
2035
  /**
2005
- * The keys of the environment variables that were assigned during the build phase.
2036
+ * Whether or not preview comments are enabled for the deployment
2006
2037
  *
2007
- * @example MY_ENV_VAR
2038
+ * @example false
2008
2039
  */
2009
- env: string[];
2010
- };
2040
+ previewCommentsEnabled?: boolean;
2041
+ }[];
2042
+ link?: {
2043
+ org?: string;
2044
+ repo?: string;
2045
+ repoId?: number;
2046
+ type?: 'github';
2047
+ createdAt?: number;
2048
+ deployHooks: {
2049
+ createdAt?: number;
2050
+ id: string;
2051
+ name: string;
2052
+ ref: string;
2053
+ url: string;
2054
+ }[];
2055
+ gitCredentialId?: string;
2056
+ updatedAt?: number;
2057
+ sourceless?: boolean;
2058
+ productionBranch?: string;
2059
+ } | {
2060
+ projectId?: string;
2061
+ projectName?: string;
2062
+ projectNameWithNamespace?: string;
2063
+ projectNamespace?: string;
2064
+ projectUrl?: string;
2065
+ type?: 'gitlab';
2066
+ createdAt?: number;
2067
+ deployHooks: {
2068
+ createdAt?: number;
2069
+ id: string;
2070
+ name: string;
2071
+ ref: string;
2072
+ url: string;
2073
+ }[];
2074
+ gitCredentialId?: string;
2075
+ updatedAt?: number;
2076
+ sourceless?: boolean;
2077
+ productionBranch?: string;
2078
+ } | {
2079
+ name?: string;
2080
+ slug?: string;
2081
+ owner?: string;
2082
+ type?: 'bitbucket';
2083
+ uuid?: string;
2084
+ workspaceUuid?: string;
2085
+ createdAt?: number;
2086
+ deployHooks: {
2087
+ createdAt?: number;
2088
+ id: string;
2089
+ name: string;
2090
+ ref: string;
2091
+ url: string;
2092
+ }[];
2093
+ gitCredentialId?: string;
2094
+ updatedAt?: number;
2095
+ sourceless?: boolean;
2096
+ productionBranch?: string;
2097
+ };
2098
+ name: string;
2099
+ nodeVersion: '18.x' | '16.x' | '14.x' | '12.x' | '10.x';
2100
+ outputDirectory?: string | null;
2101
+ passwordProtection?: {
2102
+ deploymentType: 'preview' | 'all';
2103
+ } | null;
2104
+ publicSource?: boolean | null;
2105
+ rootDirectory?: string | null;
2106
+ serverlessFunctionRegion?: string | null;
2107
+ skipGitConnectDuringLink?: boolean;
2108
+ sourceFilesOutsideRootDirectory?: boolean;
2109
+ ssoProtection?: {
2110
+ deploymentType: 'preview' | 'all';
2111
+ } | null;
2112
+ targets?: {
2113
+ [key: string]: {
2114
+ alias?: string[];
2115
+ aliasAssigned?: number | boolean | null;
2116
+ aliasError?: {
2117
+ code: string;
2118
+ message: string;
2119
+ } | null;
2120
+ aliasFinal?: string | null;
2121
+ automaticAliases?: string[];
2122
+ builds?: {
2123
+ use: string;
2124
+ src?: string;
2125
+ dest?: string;
2126
+ }[];
2127
+ connectConfigurationId?: string;
2128
+ createdAt: number;
2129
+ createdIn: string;
2130
+ creator: {
2131
+ email: string;
2132
+ githubLogin?: string;
2133
+ gitlabLogin?: string;
2134
+ uid: string;
2135
+ username: string;
2136
+ } | null;
2137
+ deploymentHostname: string;
2138
+ name: string;
2139
+ forced?: boolean;
2140
+ id: string;
2141
+ meta?: {
2142
+ [key: string]: string;
2143
+ };
2144
+ monorepoManager?: string | null;
2145
+ plan: 'hobby' | 'enterprise' | 'pro' | 'oss';
2146
+ private: boolean;
2147
+ readyState: 'BUILDING' | 'ERROR' | 'INITIALIZING' | 'QUEUED' | 'READY' | 'CANCELED';
2148
+ requestedAt?: number;
2149
+ target?: string | null;
2150
+ teamId?: string | null;
2151
+ type: 'LAMBDAS';
2152
+ url: string;
2153
+ userId: string;
2154
+ withCache?: boolean;
2155
+ checksConclusion?: 'succeeded' | 'failed' | 'skipped' | 'canceled';
2156
+ checksState?: 'registered' | 'running' | 'completed';
2157
+ readyAt?: number;
2158
+ buildingAt?: number;
2159
+ /**
2160
+ * Whether or not preview comments are enabled for the deployment
2161
+ *
2162
+ * @example false
2163
+ */
2164
+ previewCommentsEnabled?: boolean;
2165
+ } | null;
2166
+ };
2167
+ transferCompletedAt?: number;
2168
+ transferStartedAt?: number;
2169
+ transferToAccountId?: string;
2170
+ transferredFromAccountId?: string;
2171
+ updatedAt?: number;
2172
+ live?: boolean;
2173
+ enablePreviewFeedback?: boolean | null;
2174
+ permissions?: {
2175
+ aliasGlobal?: ACLAction[];
2176
+ aliasProject?: ACLAction[];
2177
+ analytics?: ACLAction[];
2178
+ analyticsSampling?: ACLAction[];
2179
+ analyticsUsage?: ACLAction[];
2180
+ auditLog?: ACLAction[];
2181
+ billingAddress?: ACLAction[];
2182
+ billingInformation?: ACLAction[];
2183
+ billingInvoice?: ACLAction[];
2184
+ billingInvoiceEmailRecipient?: ACLAction[];
2185
+ billingInvoiceLanguage?: ACLAction[];
2186
+ billingPlan?: ACLAction[];
2187
+ billingPurchaseOrder?: ACLAction[];
2188
+ billingTaxId?: ACLAction[];
2189
+ blob?: ACLAction[];
2190
+ cacheArtifact?: ACLAction[];
2191
+ cacheArtifactUsageEvent?: ACLAction[];
2192
+ concurrentBuilds?: ACLAction[];
2193
+ connect?: ACLAction[];
2194
+ connectConfiguration?: ACLAction[];
2195
+ connectConfigurationLink?: ACLAction[];
2196
+ deployment?: ACLAction[];
2197
+ deploymentProductionGit?: ACLAction[];
2198
+ deploymentCheck?: ACLAction[];
2199
+ deploymentCheckPreview?: ACLAction[];
2200
+ deploymentPreview?: ACLAction[];
2201
+ deploymentPrivate?: ACLAction[];
2202
+ deploymentCheckReRunFromProductionBranch?: ACLAction[];
2203
+ deploymentPromote?: ACLAction[];
2204
+ deploymentRollback?: ACLAction[];
2205
+ domain?: ACLAction[];
2206
+ domainAcceptDelegation?: ACLAction[];
2207
+ domainAuthCodes?: ACLAction[];
2208
+ domainCertificate?: ACLAction[];
2209
+ domainCheckConfig?: ACLAction[];
2210
+ domainMove?: ACLAction[];
2211
+ domainPurchase?: ACLAction[];
2212
+ domainRecord?: ACLAction[];
2213
+ domainTransferIn?: ACLAction[];
2214
+ event?: ACLAction[];
2215
+ sensitiveEnvironmentVariablePolicy?: ACLAction[];
2216
+ fileUpload?: ACLAction[];
2217
+ gitRepository?: ACLAction[];
2218
+ ipBlocking?: ACLAction[];
2219
+ trustedIps?: ACLAction[];
2220
+ integration?: ACLAction[];
2221
+ integrationConfiguration?: ACLAction[];
2222
+ integrationConfigurationTransfer?: ACLAction[];
2223
+ integrationConfigurationProjects?: ACLAction[];
2224
+ integrationVercelConfigurationOverride?: ACLAction[];
2225
+ job?: ACLAction[];
2226
+ logDrain?: ACLAction[];
2227
+ Monitoring?: ACLAction[];
2228
+ monitoringQuery?: ACLAction[];
2229
+ monitoringChart?: ACLAction[];
2230
+ notificationDomainConfiguration?: ACLAction[];
2231
+ notificationDomainExpire?: ACLAction[];
2232
+ notificationDomainMoved?: ACLAction[];
2233
+ notificationDomainPurchase?: ACLAction[];
2234
+ notificationDomainRenewal?: ACLAction[];
2235
+ notificationDomainTransfer?: ACLAction[];
2236
+ notificationDomainUnverified?: ACLAction[];
2237
+ notificationPaymentFailed?: ACLAction[];
2238
+ notificationUsageAlert?: ACLAction[];
2239
+ notificationSpendCap?: ACLAction[];
2240
+ openTelemetryEndpoint?: ACLAction[];
2241
+ passwordProtection?: ACLAction[];
2242
+ paymentMethod?: ACLAction[];
2243
+ permissions?: ACLAction[];
2244
+ postgres?: ACLAction[];
2245
+ previewDeploymentSuffix?: ACLAction[];
2246
+ proTrialOnboarding?: ACLAction[];
2247
+ project?: ACLAction[];
2248
+ projectDeploymentHook?: ACLAction[];
2249
+ projectDomain?: ACLAction[];
2250
+ projectDomainMove?: ACLAction[];
2251
+ projectEnvVars?: ACLAction[];
2252
+ projectEnvVarsUnownedByIntegration?: ACLAction[];
2253
+ sharedEnvVars?: ACLAction[];
2254
+ projectEnvVarsProduction?: ACLAction[];
2255
+ sharedEnvVarsProduction?: ACLAction[];
2256
+ projectIntegrationConfiguration?: ACLAction[];
2257
+ projectLink?: ACLAction[];
2258
+ projectMember?: ACLAction[];
2259
+ projectProductionBranch?: ACLAction[];
2260
+ projectTransfer?: ACLAction[];
2261
+ projectProtectionBypass?: ACLAction[];
2262
+ rateLimit?: ACLAction[];
2263
+ redis?: ACLAction[];
2264
+ remoteCaching?: ACLAction[];
2265
+ samlConfig?: ACLAction[];
2266
+ secret?: ACLAction[];
2267
+ spendCapConfiguration?: ACLAction[];
2268
+ spendCapState?: ACLAction[];
2269
+ supportCase?: ACLAction[];
2270
+ supportCaseComment?: ACLAction[];
2271
+ DataCacheNamespace?: ACLAction[];
2272
+ DataCacheBillingSettings?: ACLAction[];
2273
+ team?: ACLAction[];
2274
+ teamAccessRequest?: ACLAction[];
2275
+ teamFellowMembership?: ACLAction[];
2276
+ teamInvite?: ACLAction[];
2277
+ teamInviteCode?: ACLAction[];
2278
+ teamJoin?: ACLAction[];
2279
+ teamOwnMembership?: ACLAction[];
2280
+ teamOwnMembershipDisconnectSAML?: ACLAction[];
2281
+ token?: ACLAction[];
2282
+ usage?: ACLAction[];
2283
+ user?: ACLAction[];
2284
+ userConnection?: ACLAction[];
2285
+ webAnalytics?: ACLAction[];
2286
+ webAnalyticsPlan?: ACLAction[];
2287
+ edgeConfig?: ACLAction[];
2288
+ edgeConfigItem?: ACLAction[];
2289
+ edgeConfigToken?: ACLAction[];
2290
+ webhook?: ACLAction[];
2291
+ ['webhook-event']?: ACLAction[];
2292
+ endpointVerification?: ACLAction[];
2293
+ aliasProtectionBypass?: ACLAction[];
2294
+ };
2295
+ lastRollbackTarget?: {
2296
+ fromDeploymentId: string;
2297
+ toDeploymentId: string;
2298
+ jobStatus: 'succeeded' | 'failed' | 'skipped' | 'pending' | 'in-progress';
2299
+ requestedAt: number;
2300
+ } | null;
2301
+ lastAliasRequest?: {
2302
+ fromDeploymentId: string;
2303
+ toDeploymentId: string;
2304
+ jobStatus: 'succeeded' | 'failed' | 'skipped' | 'pending' | 'in-progress';
2305
+ requestedAt: number;
2306
+ type: 'promote' | 'rollback';
2307
+ } | null;
2308
+ hasFloatingAliases?: boolean;
2309
+ protectionBypass?: {
2310
+ [key: string]: {
2311
+ createdAt: number;
2312
+ createdBy: string;
2313
+ scope?: 'automation-bypass' | 'shareable-link';
2314
+ };
2315
+ };
2316
+ hasActiveBranches?: boolean;
2317
+ trustedIps?: {
2318
+ deploymentType: 'preview' | 'all';
2319
+ addresses: {
2320
+ value: string;
2321
+ note?: string;
2322
+ }[];
2323
+ protectionMode: 'additional' | 'exclusive';
2324
+ } | null;
2325
+ };
2326
+ type UpdateProjectDataCacheRequestBody = {
2327
+ /**
2328
+ * Enable or disable data cache for the project
2329
+ *
2330
+ * @example true
2331
+ */
2332
+ enabled?: boolean;
2333
+ };
2334
+ type UpdateProjectDataCacheVariables = {
2335
+ body?: UpdateProjectDataCacheRequestBody;
2336
+ pathParams: UpdateProjectDataCachePathParams;
2337
+ queryParams?: UpdateProjectDataCacheQueryParams;
2338
+ } & FetcherExtraProps;
2339
+ /**
2340
+ * Update the cron job feature on a project.
2341
+ */
2342
+ declare const updateProjectDataCache: (variables: UpdateProjectDataCacheVariables, signal?: AbortSignal) => Promise<UpdateProjectDataCacheResponse>;
2343
+ type GetDeploymentEventsPathParams = {
2344
+ /**
2345
+ * The unique identifier or hostname of the deployment.
2346
+ *
2347
+ * @example dpl_5WJWYSyB7BpgTj3EuwF37WMRBXBtPQ2iTMJHJBJyRfd
2348
+ */
2349
+ idOrUrl: string;
2350
+ };
2351
+ type GetDeploymentEventsQueryParams = {
2352
+ /**
2353
+ * Order of the returned events based on the timestamp.
2354
+ *
2355
+ * @default forward
2356
+ * @example backward
2357
+ */
2358
+ direction?: 'backward' | 'forward';
2359
+ /**
2360
+ * When enabled, this endpoint will return live events as they happen.
2361
+ *
2362
+ * @example 1
2363
+ */
2364
+ follow?: 0 | 1;
2365
+ /**
2366
+ * Maximum number of events to return. Provide `-1` to return all available logs.
2367
+ *
2368
+ * @example 100
2369
+ */
2370
+ limit?: number;
2371
+ /**
2372
+ * Deployment build ID.
2373
+ *
2374
+ * @example bld_cotnkcr76
2375
+ */
2376
+ name?: string;
2377
+ /**
2378
+ * Timestamp for when build logs should be pulled from.
2379
+ *
2380
+ * @example 1540095775941
2381
+ */
2382
+ since?: number;
2383
+ /**
2384
+ * Timestamp for when the build logs should be pulled up until.
2385
+ *
2386
+ * @example 1540106318643
2387
+ */
2388
+ until?: number;
2389
+ /**
2390
+ * HTTP status code range to filter events by.
2391
+ *
2392
+ * @example 5xx
2393
+ */
2394
+ statusCode?: number | string;
2395
+ /**
2396
+ * @example 1
2397
+ */
2398
+ delimiter?: 0 | 1;
2399
+ /**
2400
+ * @example 1
2401
+ */
2402
+ builds?: 0 | 1;
2403
+ /**
2404
+ * The Team identifier or slug to perform the request on behalf of.
2405
+ */
2406
+ teamId?: string;
2407
+ };
2408
+ type GetDeploymentEventsError = ErrorWrapper<undefined>;
2409
+ type GetDeploymentEventsResponse = ({
2410
+ type: 'command';
2411
+ created: number;
2412
+ payload: {
2413
+ deploymentId: string;
2414
+ text?: string;
2415
+ id: string;
2416
+ date: number;
2417
+ serial: string;
2418
+ };
2419
+ } | {
2420
+ type: 'deployment-state';
2421
+ created: number;
2422
+ payload: {
2423
+ deploymentId: string;
2424
+ info: {
2425
+ type: string;
2426
+ name: string;
2427
+ entrypoint?: string;
2428
+ path?: string;
2429
+ step?: string;
2430
+ };
2431
+ id: string;
2432
+ date: number;
2433
+ serial: string;
2434
+ };
2435
+ } | {
2436
+ type: 'delimiter';
2437
+ created: number;
2438
+ payload: {
2439
+ deploymentId: string;
2440
+ info: {
2441
+ type: string;
2442
+ name: string;
2443
+ entrypoint?: string;
2444
+ path?: string;
2445
+ step?: string;
2446
+ };
2447
+ id: string;
2448
+ date: number;
2449
+ serial: string;
2450
+ };
2451
+ } | {
2452
+ type: 'exit';
2453
+ created: number;
2454
+ payload: {
2455
+ date: number;
2456
+ text?: string;
2457
+ id: string;
2458
+ deploymentId: string;
2459
+ created: number;
2460
+ serial: string;
2461
+ };
2462
+ } | {
2463
+ type: 'middleware';
2464
+ created: number;
2465
+ payload: {
2466
+ deploymentId: string;
2467
+ info: {
2468
+ type: string;
2469
+ name: string;
2470
+ entrypoint?: string;
2471
+ path?: string;
2472
+ step?: string;
2473
+ };
2474
+ text?: string;
2475
+ id: string;
2476
+ date: number;
2477
+ serial: string;
2478
+ requestId?: string;
2479
+ };
2480
+ } | {
2481
+ type: 'delimiter' | 'command' | 'stdout' | 'stderr' | 'exit' | 'deployment-state' | 'middleware' | 'middleware-invocation' | 'edge-function-invocation' | 'fatal';
2482
+ created: number;
2483
+ payload: {
2484
+ deploymentId: string;
2485
+ info: {
2486
+ type: string;
2487
+ name: string;
2488
+ entrypoint?: string;
2489
+ path?: string;
2490
+ step?: string;
2491
+ };
2492
+ text?: string;
2493
+ id: string;
2494
+ date: number;
2495
+ serial: string;
2496
+ statusCode?: number;
2497
+ requestId?: string;
2498
+ };
2499
+ })[];
2500
+ type GetDeploymentEventsVariables = {
2501
+ pathParams: GetDeploymentEventsPathParams;
2502
+ queryParams?: GetDeploymentEventsQueryParams;
2503
+ } & FetcherExtraProps;
2504
+ /**
2505
+ * Get the build logs of a deployment by deployment ID and build ID. It can work as an infinite stream of logs or as a JSON endpoint depending on the input parameters.
2506
+ */
2507
+ declare const getDeploymentEvents: (variables: GetDeploymentEventsVariables, signal?: AbortSignal) => Promise<GetDeploymentEventsResponse>;
2508
+ type GetDeploymentPathParams = {
2509
+ /**
2510
+ * The unique identifier or hostname of the deployment.
2511
+ *
2512
+ * @example dpl_89qyp1cskzkLrVicDaZoDbjyHuDJ
2513
+ */
2514
+ idOrUrl: string;
2515
+ };
2516
+ type GetDeploymentQueryParams = {
2517
+ /**
2518
+ * Whether to add in gitRepo information.
2519
+ *
2520
+ * @example true
2521
+ */
2522
+ withGitRepoInfo?: string;
2523
+ /**
2524
+ * The Team identifier or slug to perform the request on behalf of.
2525
+ */
2526
+ teamId?: string;
2527
+ };
2528
+ type GetDeploymentError = ErrorWrapper<undefined>;
2529
+ type GetDeploymentVariables = {
2530
+ pathParams: GetDeploymentPathParams;
2531
+ queryParams?: GetDeploymentQueryParams;
2532
+ } & FetcherExtraProps;
2533
+ /**
2534
+ * Retrieves information for a deployment either by supplying its ID (`id` property) or Hostname (`url` property). Additional details will be included when the authenticated user is an owner of the deployment.
2535
+ */
2536
+ declare const getDeployment: (variables: GetDeploymentVariables, signal?: AbortSignal) => Promise<{
2537
+ aliasAssignedAt?: number | boolean | null;
2538
+ build: {
2539
+ /**
2540
+ * The keys of the environment variables that were assigned during the build phase.
2541
+ *
2542
+ * @example MY_ENV_VAR
2543
+ */
2544
+ env: string[];
2545
+ };
2011
2546
  builds?: Record<string, any>[];
2012
2547
  /**
2013
2548
  * The ID of Vercel Connect configuration used for this deployment
@@ -2210,6 +2745,7 @@ declare const getDeployment: (variables: GetDeploymentVariables, signal?: AbortS
2210
2745
  link?: string;
2211
2746
  action?: string;
2212
2747
  } | null;
2748
+ autoAssignCustomDomains?: boolean;
2213
2749
  automaticAliases?: string[];
2214
2750
  bootedAt: number;
2215
2751
  buildErrorAt?: number;
@@ -2426,6 +2962,7 @@ declare const getDeployment: (variables: GetDeploymentVariables, signal?: AbortS
2426
2962
  link?: string;
2427
2963
  action?: string;
2428
2964
  } | null;
2965
+ autoAssignCustomDomains?: boolean;
2429
2966
  automaticAliases?: string[];
2430
2967
  bootedAt: number;
2431
2968
  buildErrorAt?: number;
@@ -2857,6 +3394,7 @@ type CreateDeploymentResponse = {
2857
3394
  link?: string;
2858
3395
  action?: string;
2859
3396
  } | null;
3397
+ autoAssignCustomDomains?: boolean;
2860
3398
  automaticAliases?: string[];
2861
3399
  bootedAt: number;
2862
3400
  buildErrorAt?: number;
@@ -4061,6 +4599,7 @@ type CreateDeploymentRequestBody = {
4061
4599
  data_transfer_bytes: number;
4062
4600
  written_data_bytes: number;
4063
4601
  compute_time_seconds: number;
4602
+ synthetic_storage_size: number;
4064
4603
  }[];
4065
4604
  pagination: {
4066
4605
  cursor: string;
@@ -4301,6 +4840,7 @@ type CancelDeploymentResponse = {
4301
4840
  link?: string;
4302
4841
  action?: string;
4303
4842
  } | null;
4843
+ autoAssignCustomDomains?: boolean;
4304
4844
  automaticAliases?: string[];
4305
4845
  bootedAt: number;
4306
4846
  buildErrorAt?: number;
@@ -4583,6 +5123,76 @@ type CheckDomainPriceVariables = {
4583
5123
  * Check the price to purchase a domain and how long a single purchase period is.
4584
5124
  */
4585
5125
  declare const checkDomainPrice: (variables: CheckDomainPriceVariables, signal?: AbortSignal) => Promise<CheckDomainPriceResponse>;
5126
+ type GetRecordsPathParams = {
5127
+ /**
5128
+ * @example example.com
5129
+ */
5130
+ domain: string;
5131
+ };
5132
+ type GetRecordsQueryParams = {
5133
+ /**
5134
+ * Maximum number of records to list from a request.
5135
+ *
5136
+ * @example 20
5137
+ */
5138
+ limit?: string;
5139
+ /**
5140
+ * Get records created after this JavaScript timestamp.
5141
+ *
5142
+ * @example 1609499532000
5143
+ */
5144
+ since?: string;
5145
+ /**
5146
+ * Get records created before this JavaScript timestamp.
5147
+ *
5148
+ * @example 1612264332000
5149
+ */
5150
+ until?: string;
5151
+ /**
5152
+ * The Team identifier or slug to perform the request on behalf of.
5153
+ */
5154
+ teamId?: string;
5155
+ };
5156
+ type GetRecordsError = ErrorWrapper<undefined>;
5157
+ type GetRecordsVariables = {
5158
+ pathParams: GetRecordsPathParams;
5159
+ queryParams?: GetRecordsQueryParams;
5160
+ } & FetcherExtraProps;
5161
+ /**
5162
+ * Retrieves a list of DNS records created for a domain name. By default it returns 20 records if no limit is provided. The rest can be retrieved using the pagination options.
5163
+ */
5164
+ declare const getRecords: (variables: GetRecordsVariables, signal?: AbortSignal) => Promise<string | {
5165
+ records: {
5166
+ id: string;
5167
+ slug: string;
5168
+ name: string;
5169
+ type: 'A' | 'AAAA' | 'ALIAS' | 'CAA' | 'CNAME' | 'MX' | 'SRV' | 'TXT' | 'NS';
5170
+ value: string;
5171
+ mxPriority?: number;
5172
+ priority?: number;
5173
+ creator: string;
5174
+ created: number | null;
5175
+ updated: number | null;
5176
+ createdAt: number | null;
5177
+ updatedAt: number | null;
5178
+ }[];
5179
+ } | {
5180
+ records: {
5181
+ id: string;
5182
+ slug: string;
5183
+ name: string;
5184
+ type: 'A' | 'AAAA' | 'ALIAS' | 'CAA' | 'CNAME' | 'MX' | 'SRV' | 'TXT' | 'NS';
5185
+ value: string;
5186
+ mxPriority?: number;
5187
+ priority?: number;
5188
+ creator: string;
5189
+ created: number | null;
5190
+ updated: number | null;
5191
+ createdAt: number | null;
5192
+ updatedAt: number | null;
5193
+ }[];
5194
+ pagination: Pagination;
5195
+ }>;
4586
5196
  type CreateRecordPathParams = {
4587
5197
  /**
4588
5198
  * The domain used to create the DNS record.
@@ -4849,76 +5459,6 @@ declare const createRecord: (variables: CreateRecordVariables, signal?: AbortSig
4849
5459
  */
4850
5460
  uid: string;
4851
5461
  }>;
4852
- type GetRecordsPathParams = {
4853
- /**
4854
- * @example example.com
4855
- */
4856
- domain: string;
4857
- };
4858
- type GetRecordsQueryParams = {
4859
- /**
4860
- * Maximum number of records to list from a request.
4861
- *
4862
- * @example 20
4863
- */
4864
- limit?: string;
4865
- /**
4866
- * Get records created after this JavaScript timestamp.
4867
- *
4868
- * @example 1609499532000
4869
- */
4870
- since?: string;
4871
- /**
4872
- * Get records created before this JavaScript timestamp.
4873
- *
4874
- * @example 1612264332000
4875
- */
4876
- until?: string;
4877
- /**
4878
- * The Team identifier or slug to perform the request on behalf of.
4879
- */
4880
- teamId?: string;
4881
- };
4882
- type GetRecordsError = ErrorWrapper<undefined>;
4883
- type GetRecordsVariables = {
4884
- pathParams: GetRecordsPathParams;
4885
- queryParams?: GetRecordsQueryParams;
4886
- } & FetcherExtraProps;
4887
- /**
4888
- * Retrieves a list of DNS records created for a domain name. By default it returns 20 records if no limit is provided. The rest can be retrieved using the pagination options.
4889
- */
4890
- declare const getRecords: (variables: GetRecordsVariables, signal?: AbortSignal) => Promise<string | {
4891
- records: {
4892
- id: string;
4893
- slug: string;
4894
- name: string;
4895
- type: 'A' | 'AAAA' | 'ALIAS' | 'CAA' | 'CNAME' | 'MX' | 'SRV' | 'TXT' | 'NS';
4896
- value: string;
4897
- mxPriority?: number;
4898
- priority?: number;
4899
- creator: string;
4900
- created: number | null;
4901
- updated: number | null;
4902
- createdAt: number | null;
4903
- updatedAt: number | null;
4904
- }[];
4905
- } | {
4906
- records: {
4907
- id: string;
4908
- slug: string;
4909
- name: string;
4910
- type: 'A' | 'AAAA' | 'ALIAS' | 'CAA' | 'CNAME' | 'MX' | 'SRV' | 'TXT' | 'NS';
4911
- value: string;
4912
- mxPriority?: number;
4913
- priority?: number;
4914
- creator: string;
4915
- created: number | null;
4916
- updated: number | null;
4917
- createdAt: number | null;
4918
- updatedAt: number | null;
4919
- }[];
4920
- pagination: Pagination;
4921
- }>;
4922
5462
  type UpdateRecordPathParams = {
4923
5463
  /**
4924
5464
  * The id of the DNS record
@@ -6849,6 +7389,9 @@ type GetConfigurableLogDrainResponse = {
6849
7389
  * @example https://my-log-drain.com
6850
7390
  */
6851
7391
  url: string;
7392
+ status?: 'enabled' | 'disabled';
7393
+ disabledAt?: number;
7394
+ disabledReason?: string;
6852
7395
  };
6853
7396
  type GetConfigurableLogDrainVariables = {
6854
7397
  pathParams: GetConfigurableLogDrainPathParams;
@@ -6956,6 +7499,9 @@ type GetConfigurableLogDrainsResponse = {
6956
7499
  * @example https://my-log-drain.com
6957
7500
  */
6958
7501
  url: string;
7502
+ status?: 'enabled' | 'disabled';
7503
+ disabledAt?: number;
7504
+ disabledReason?: string;
6959
7505
  }[];
6960
7506
  type GetConfigurableLogDrainsVariables = {
6961
7507
  queryParams?: GetConfigurableLogDrainsQueryParams;
@@ -7044,6 +7590,9 @@ type CreateConfigurableLogDrainResponse = {
7044
7590
  * @example https://my-log-drain.com
7045
7591
  */
7046
7592
  url: string;
7593
+ status?: 'enabled' | 'disabled';
7594
+ disabledAt?: number;
7595
+ disabledReason?: string;
7047
7596
  };
7048
7597
  type CreateConfigurableLogDrainRequestBody = {
7049
7598
  /**
@@ -7165,6 +7714,45 @@ type GetProjectsResponse = {
7165
7714
  connectConfigurationId?: string | null;
7166
7715
  connectBuildsEnabled?: boolean;
7167
7716
  createdAt?: number;
7717
+ dataCache?: {
7718
+ userEnabled: boolean;
7719
+ enableAt: number | null;
7720
+ };
7721
+ crons?: {
7722
+ /**
7723
+ * The time the feature was enabled for this project. Note: It enables automatically with the first Deployment that outputs cronjobs.
7724
+ */
7725
+ enabledAt: number;
7726
+ /**
7727
+ * The time the feature was disabled for this project.
7728
+ */
7729
+ disabledAt: number | null;
7730
+ updatedAt: number;
7731
+ /**
7732
+ * The ID of the Deployment from which the definitions originated.
7733
+ */
7734
+ deploymentId: string | null;
7735
+ definitions: {
7736
+ /**
7737
+ * The hostname that should be used.
7738
+ *
7739
+ * @example vercel.com
7740
+ */
7741
+ host: string;
7742
+ /**
7743
+ * The path that should be called for the cronjob.
7744
+ *
7745
+ * @example /api/crons/sync-something?hello=world
7746
+ */
7747
+ path: string;
7748
+ /**
7749
+ * The cron expression.
7750
+ *
7751
+ * @example 0 0 * * *
7752
+ */
7753
+ schedule: string;
7754
+ }[];
7755
+ };
7168
7756
  devCommand?: string | null;
7169
7757
  directoryListing: boolean;
7170
7758
  installCommand?: string | null;
@@ -7458,7 +8046,7 @@ type GetProjectsResponse = {
7458
8046
  fileUpload?: ACLAction[];
7459
8047
  gitRepository?: ACLAction[];
7460
8048
  ipBlocking?: ACLAction[];
7461
- ipAllowlist?: ACLAction[];
8049
+ trustedIps?: ACLAction[];
7462
8050
  integration?: ACLAction[];
7463
8051
  integrationConfiguration?: ACLAction[];
7464
8052
  integrationConfigurationTransfer?: ACLAction[];
@@ -7511,6 +8099,7 @@ type GetProjectsResponse = {
7511
8099
  supportCase?: ACLAction[];
7512
8100
  supportCaseComment?: ACLAction[];
7513
8101
  DataCacheNamespace?: ACLAction[];
8102
+ DataCacheBillingSettings?: ACLAction[];
7514
8103
  team?: ACLAction[];
7515
8104
  teamAccessRequest?: ACLAction[];
7516
8105
  teamFellowMembership?: ACLAction[];
@@ -7555,9 +8144,12 @@ type GetProjectsResponse = {
7555
8144
  };
7556
8145
  };
7557
8146
  hasActiveBranches?: boolean;
7558
- ipAllowlist?: {
8147
+ trustedIps?: {
7559
8148
  deploymentType: 'preview' | 'all';
7560
- ipAddresses: string[];
8149
+ addresses: {
8150
+ value: string;
8151
+ note?: string;
8152
+ }[];
7561
8153
  protectionMode: 'additional' | 'exclusive';
7562
8154
  } | null;
7563
8155
  }[];
@@ -7588,12 +8180,51 @@ type CreateProjectResponse = {
7588
8180
  sampleRatePercent?: number | null;
7589
8181
  spendLimitInDollars?: number | null;
7590
8182
  };
7591
- autoExposeSystemEnvs?: boolean;
7592
- buildCommand?: string | null;
7593
- commandForIgnoringBuildStep?: string | null;
7594
- connectConfigurationId?: string | null;
7595
- connectBuildsEnabled?: boolean;
7596
- createdAt?: number;
8183
+ autoExposeSystemEnvs?: boolean;
8184
+ buildCommand?: string | null;
8185
+ commandForIgnoringBuildStep?: string | null;
8186
+ connectConfigurationId?: string | null;
8187
+ connectBuildsEnabled?: boolean;
8188
+ createdAt?: number;
8189
+ dataCache?: {
8190
+ userEnabled: boolean;
8191
+ enableAt: number | null;
8192
+ };
8193
+ crons?: {
8194
+ /**
8195
+ * The time the feature was enabled for this project. Note: It enables automatically with the first Deployment that outputs cronjobs.
8196
+ */
8197
+ enabledAt: number;
8198
+ /**
8199
+ * The time the feature was disabled for this project.
8200
+ */
8201
+ disabledAt: number | null;
8202
+ updatedAt: number;
8203
+ /**
8204
+ * The ID of the Deployment from which the definitions originated.
8205
+ */
8206
+ deploymentId: string | null;
8207
+ definitions: {
8208
+ /**
8209
+ * The hostname that should be used.
8210
+ *
8211
+ * @example vercel.com
8212
+ */
8213
+ host: string;
8214
+ /**
8215
+ * The path that should be called for the cronjob.
8216
+ *
8217
+ * @example /api/crons/sync-something?hello=world
8218
+ */
8219
+ path: string;
8220
+ /**
8221
+ * The cron expression.
8222
+ *
8223
+ * @example 0 0 * * *
8224
+ */
8225
+ schedule: string;
8226
+ }[];
8227
+ };
7597
8228
  devCommand?: string | null;
7598
8229
  directoryListing: boolean;
7599
8230
  installCommand?: string | null;
@@ -7887,7 +8518,7 @@ type CreateProjectResponse = {
7887
8518
  fileUpload?: ACLAction[];
7888
8519
  gitRepository?: ACLAction[];
7889
8520
  ipBlocking?: ACLAction[];
7890
- ipAllowlist?: ACLAction[];
8521
+ trustedIps?: ACLAction[];
7891
8522
  integration?: ACLAction[];
7892
8523
  integrationConfiguration?: ACLAction[];
7893
8524
  integrationConfigurationTransfer?: ACLAction[];
@@ -7940,6 +8571,7 @@ type CreateProjectResponse = {
7940
8571
  supportCase?: ACLAction[];
7941
8572
  supportCaseComment?: ACLAction[];
7942
8573
  DataCacheNamespace?: ACLAction[];
8574
+ DataCacheBillingSettings?: ACLAction[];
7943
8575
  team?: ACLAction[];
7944
8576
  teamAccessRequest?: ACLAction[];
7945
8577
  teamFellowMembership?: ACLAction[];
@@ -7984,9 +8616,12 @@ type CreateProjectResponse = {
7984
8616
  };
7985
8617
  };
7986
8618
  hasActiveBranches?: boolean;
7987
- ipAllowlist?: {
8619
+ trustedIps?: {
7988
8620
  deploymentType: 'preview' | 'all';
7989
- ipAddresses: string[];
8621
+ addresses: {
8622
+ value: string;
8623
+ note?: string;
8624
+ }[];
7990
8625
  protectionMode: 'additional' | 'exclusive';
7991
8626
  } | null;
7992
8627
  };
@@ -8133,6 +8768,45 @@ type GetProjectResponse = {
8133
8768
  connectConfigurationId?: string | null;
8134
8769
  connectBuildsEnabled?: boolean;
8135
8770
  createdAt?: number;
8771
+ dataCache?: {
8772
+ userEnabled: boolean;
8773
+ enableAt: number | null;
8774
+ };
8775
+ crons?: {
8776
+ /**
8777
+ * The time the feature was enabled for this project. Note: It enables automatically with the first Deployment that outputs cronjobs.
8778
+ */
8779
+ enabledAt: number;
8780
+ /**
8781
+ * The time the feature was disabled for this project.
8782
+ */
8783
+ disabledAt: number | null;
8784
+ updatedAt: number;
8785
+ /**
8786
+ * The ID of the Deployment from which the definitions originated.
8787
+ */
8788
+ deploymentId: string | null;
8789
+ definitions: {
8790
+ /**
8791
+ * The hostname that should be used.
8792
+ *
8793
+ * @example vercel.com
8794
+ */
8795
+ host: string;
8796
+ /**
8797
+ * The path that should be called for the cronjob.
8798
+ *
8799
+ * @example /api/crons/sync-something?hello=world
8800
+ */
8801
+ path: string;
8802
+ /**
8803
+ * The cron expression.
8804
+ *
8805
+ * @example 0 0 * * *
8806
+ */
8807
+ schedule: string;
8808
+ }[];
8809
+ };
8136
8810
  devCommand?: string | null;
8137
8811
  directoryListing: boolean;
8138
8812
  installCommand?: string | null;
@@ -8426,7 +9100,7 @@ type GetProjectResponse = {
8426
9100
  fileUpload?: ACLAction[];
8427
9101
  gitRepository?: ACLAction[];
8428
9102
  ipBlocking?: ACLAction[];
8429
- ipAllowlist?: ACLAction[];
9103
+ trustedIps?: ACLAction[];
8430
9104
  integration?: ACLAction[];
8431
9105
  integrationConfiguration?: ACLAction[];
8432
9106
  integrationConfigurationTransfer?: ACLAction[];
@@ -8479,6 +9153,7 @@ type GetProjectResponse = {
8479
9153
  supportCase?: ACLAction[];
8480
9154
  supportCaseComment?: ACLAction[];
8481
9155
  DataCacheNamespace?: ACLAction[];
9156
+ DataCacheBillingSettings?: ACLAction[];
8482
9157
  team?: ACLAction[];
8483
9158
  teamAccessRequest?: ACLAction[];
8484
9159
  teamFellowMembership?: ACLAction[];
@@ -8523,9 +9198,12 @@ type GetProjectResponse = {
8523
9198
  };
8524
9199
  };
8525
9200
  hasActiveBranches?: boolean;
8526
- ipAllowlist?: {
9201
+ trustedIps?: {
8527
9202
  deploymentType: 'preview' | 'all';
8528
- ipAddresses: string[];
9203
+ addresses: {
9204
+ value: string;
9205
+ note?: string;
9206
+ }[];
8529
9207
  protectionMode: 'additional' | 'exclusive';
8530
9208
  } | null;
8531
9209
  };
@@ -8569,6 +9247,45 @@ type UpdateProjectResponse = {
8569
9247
  connectConfigurationId?: string | null;
8570
9248
  connectBuildsEnabled?: boolean;
8571
9249
  createdAt?: number;
9250
+ dataCache?: {
9251
+ userEnabled: boolean;
9252
+ enableAt: number | null;
9253
+ };
9254
+ crons?: {
9255
+ /**
9256
+ * The time the feature was enabled for this project. Note: It enables automatically with the first Deployment that outputs cronjobs.
9257
+ */
9258
+ enabledAt: number;
9259
+ /**
9260
+ * The time the feature was disabled for this project.
9261
+ */
9262
+ disabledAt: number | null;
9263
+ updatedAt: number;
9264
+ /**
9265
+ * The ID of the Deployment from which the definitions originated.
9266
+ */
9267
+ deploymentId: string | null;
9268
+ definitions: {
9269
+ /**
9270
+ * The hostname that should be used.
9271
+ *
9272
+ * @example vercel.com
9273
+ */
9274
+ host: string;
9275
+ /**
9276
+ * The path that should be called for the cronjob.
9277
+ *
9278
+ * @example /api/crons/sync-something?hello=world
9279
+ */
9280
+ path: string;
9281
+ /**
9282
+ * The cron expression.
9283
+ *
9284
+ * @example 0 0 * * *
9285
+ */
9286
+ schedule: string;
9287
+ }[];
9288
+ };
8572
9289
  devCommand?: string | null;
8573
9290
  directoryListing: boolean;
8574
9291
  installCommand?: string | null;
@@ -8862,7 +9579,7 @@ type UpdateProjectResponse = {
8862
9579
  fileUpload?: ACLAction[];
8863
9580
  gitRepository?: ACLAction[];
8864
9581
  ipBlocking?: ACLAction[];
8865
- ipAllowlist?: ACLAction[];
9582
+ trustedIps?: ACLAction[];
8866
9583
  integration?: ACLAction[];
8867
9584
  integrationConfiguration?: ACLAction[];
8868
9585
  integrationConfigurationTransfer?: ACLAction[];
@@ -8915,6 +9632,7 @@ type UpdateProjectResponse = {
8915
9632
  supportCase?: ACLAction[];
8916
9633
  supportCaseComment?: ACLAction[];
8917
9634
  DataCacheNamespace?: ACLAction[];
9635
+ DataCacheBillingSettings?: ACLAction[];
8918
9636
  team?: ACLAction[];
8919
9637
  teamAccessRequest?: ACLAction[];
8920
9638
  teamFellowMembership?: ACLAction[];
@@ -8959,9 +9677,12 @@ type UpdateProjectResponse = {
8959
9677
  };
8960
9678
  };
8961
9679
  hasActiveBranches?: boolean;
8962
- ipAllowlist?: {
9680
+ trustedIps?: {
8963
9681
  deploymentType: 'all' | 'preview';
8964
- ipAddresses: string[];
9682
+ addresses: {
9683
+ value: string;
9684
+ note?: string;
9685
+ }[];
8965
9686
  protectionMode: 'exclusive' | 'additional';
8966
9687
  } | null;
8967
9688
  };
@@ -9072,15 +9793,24 @@ type UpdateProjectRequestBody = {
9072
9793
  /**
9073
9794
  * Restricts access to deployments based on the incoming request IP address
9074
9795
  */
9075
- ipAllowlist?: {
9796
+ trustedIps?: {
9076
9797
  /**
9077
- * Specify if the IP Allowlist will apply to every Deployment Target or just Preview
9798
+ * Specify if the Trusted IPs will apply to every Deployment Target or just Preview
9078
9799
  */
9079
9800
  deploymentType: 'all' | 'preview';
9080
9801
  /**
9081
- * The IP addresses that are allowlisted e.g. 127.0.0.1, 192.168.0.0/16, ::1, fe80::/32
9802
+ * @minItems 1
9082
9803
  */
9083
- ipAddresses: string[];
9804
+ addresses: {
9805
+ /**
9806
+ * The IP addresses that are allowlisted. Supported formats are IPv4, IPv6 and CIDR.
9807
+ */
9808
+ value: string;
9809
+ /**
9810
+ * An optional note explaining what the IP address or subnet is used for
9811
+ */
9812
+ note?: string;
9813
+ }[];
9084
9814
  /**
9085
9815
  * exclusive: ip match is enough to bypass deployment protection (regardless of other settings). additional: ip must match + any other protection should be also provided (password, vercel auth, shareable link, automation bypass header, automation bypass query param)
9086
9816
  */
@@ -10378,7 +11108,7 @@ type GetTeamMembersResponse = {
10378
11108
  createdAt: number;
10379
11109
  accessRequestedAt: number;
10380
11110
  joinedFrom?: {
10381
- origin: 'import' | 'github' | 'gitlab' | 'bitbucket' | 'link' | 'mail' | 'teams' | 'saml' | 'dsync' | 'feedback' | 'organization-teams';
11111
+ origin: 'link' | 'import' | 'github' | 'gitlab' | 'bitbucket' | 'mail' | 'teams' | 'saml' | 'dsync' | 'feedback' | 'organization-teams';
10382
11112
  commitId?: string;
10383
11113
  repoId?: string;
10384
11114
  repoPath?: string;
@@ -10486,7 +11216,7 @@ type GetTeamMembersResponse = {
10486
11216
  * Map with information about the members origin if they joined by requesting access.
10487
11217
  */
10488
11218
  joinedFrom?: {
10489
- origin: 'import' | 'github' | 'gitlab' | 'bitbucket' | 'link' | 'mail' | 'teams' | 'saml' | 'dsync' | 'feedback' | 'organization-teams';
11219
+ origin: 'link' | 'import' | 'github' | 'gitlab' | 'bitbucket' | 'mail' | 'teams' | 'saml' | 'dsync' | 'feedback' | 'organization-teams';
10490
11220
  commitId?: string;
10491
11221
  repoId?: string;
10492
11222
  repoPath?: string;
@@ -11144,6 +11874,15 @@ declare const uploadFile: (variables: UploadFileVariables, signal?: AbortSignal)
11144
11874
  */
11145
11875
  urls: string[];
11146
11876
  }>;
11877
+ type GetAuthUserError = ErrorWrapper<undefined>;
11878
+ type GetAuthUserResponse = {
11879
+ user: AuthUser | AuthUserLimited;
11880
+ };
11881
+ type GetAuthUserVariables = FetcherExtraProps;
11882
+ /**
11883
+ * Retrieves information related to the currently authenticated User.
11884
+ */
11885
+ declare const getAuthUser: (variables: GetAuthUserVariables, signal?: AbortSignal) => Promise<GetAuthUserResponse>;
11147
11886
  type RequestDeleteError = ErrorWrapper<undefined>;
11148
11887
  type RequestDeleteResponse = {
11149
11888
  /**
@@ -11183,15 +11922,6 @@ type RequestDeleteVariables = {
11183
11922
  * Initiates the deletion process for the currently authenticated User, by sending a deletion confirmation email. The email contains a link that the user needs to visit in order to proceed with the deletion process.
11184
11923
  */
11185
11924
  declare const requestDelete: (variables: RequestDeleteVariables, signal?: AbortSignal) => Promise<RequestDeleteResponse>;
11186
- type GetAuthUserError = ErrorWrapper<undefined>;
11187
- type GetAuthUserResponse = {
11188
- user: AuthUser | AuthUserLimited;
11189
- };
11190
- type GetAuthUserVariables = FetcherExtraProps;
11191
- /**
11192
- * Retrieves information related to the currently authenticated User.
11193
- */
11194
- declare const getAuthUser: (variables: GetAuthUserVariables, signal?: AbortSignal) => Promise<GetAuthUserResponse>;
11195
11925
  type ListAuthTokensError = ErrorWrapper<undefined>;
11196
11926
  type ListAuthTokensResponse = {
11197
11927
  tokens: AuthToken[];
@@ -11462,253 +12192,92 @@ declare const getWebhooks: (variables: GetWebhooksVariables, signal?: AbortSigna
11462
12192
  */
11463
12193
  updatedAt: number;
11464
12194
  /**
11465
- * The ID of the projects the webhook is associated with
11466
- *
11467
- * @example prj_12HKQaOmR5t5Uy6vdcQsNIiZgHGB
11468
- */
11469
- projectIds?: string[];
11470
- }[]>;
11471
- type GetWebhookPathParams = {
11472
- id: string;
11473
- };
11474
- type GetWebhookQueryParams = {
11475
- /**
11476
- * The Team identifier or slug to perform the request on behalf of.
11477
- */
11478
- teamId?: string;
11479
- };
11480
- type GetWebhookError = ErrorWrapper<undefined>;
11481
- type GetWebhookResponse = {
11482
- /**
11483
- * The webhooks events
11484
- *
11485
- * @example deployment.created
11486
- */
11487
- events: ('domain.created' | 'deployment.created' | 'deployment.error' | 'deployment.canceled' | 'deployment.succeeded' | 'deployment.ready' | 'deployment.check-rerequested' | 'integration-configuration.permission-upgraded' | 'integration-configuration.removed' | 'integration-configuration.scope-change-confirmed' | 'project.created' | 'project.removed' | 'deployment-checks-completed' | 'deployment-ready' | 'deployment-prepared' | 'deployment-error' | 'deployment-check-rerequested' | 'deployment-canceled' | 'project-created' | 'project-removed' | 'domain-created' | 'deployment' | 'integration-configuration-permission-updated' | 'integration-configuration-removed' | 'integration-configuration-scope-change-confirmed')[];
11488
- /**
11489
- * The webhook id
11490
- *
11491
- * @example account_hook_GflD6EYyo7F4ViYS
11492
- */
11493
- id: string;
11494
- /**
11495
- * A string with the URL of the webhook
11496
- *
11497
- * @example https://my-webhook.com
11498
- */
11499
- url: string;
11500
- /**
11501
- * The unique ID of the team the webhook belongs to
11502
- *
11503
- * @example ZspSRT4ljIEEmMHgoDwKWDei
11504
- */
11505
- ownerId: string;
11506
- /**
11507
- * A number containing the date when the webhook was created in in milliseconds
11508
- *
11509
- * @example 1567024758130
11510
- */
11511
- createdAt: number;
11512
- /**
11513
- * A number containing the date when the webhook was updated in in milliseconds
11514
- *
11515
- * @example 1567024758130
11516
- */
11517
- updatedAt: number;
11518
- /**
11519
- * The ID of the projects the webhook is associated with
11520
- *
11521
- * @example prj_12HKQaOmR5t5Uy6vdcQsNIiZgHGB
11522
- */
11523
- projectIds?: string[];
11524
- };
11525
- type GetWebhookVariables = {
11526
- pathParams: GetWebhookPathParams;
11527
- queryParams?: GetWebhookQueryParams;
11528
- } & FetcherExtraProps;
11529
- /**
11530
- * Get a webhook
11531
- */
11532
- declare const getWebhook: (variables: GetWebhookVariables, signal?: AbortSignal) => Promise<GetWebhookResponse>;
11533
- type DeleteWebhookPathParams = {
11534
- id: string;
11535
- };
11536
- type DeleteWebhookQueryParams = {
11537
- /**
11538
- * The Team identifier or slug to perform the request on behalf of.
11539
- */
11540
- teamId?: string;
11541
- };
11542
- type DeleteWebhookError = ErrorWrapper<undefined>;
11543
- type DeleteWebhookVariables = {
11544
- pathParams: DeleteWebhookPathParams;
11545
- queryParams?: DeleteWebhookQueryParams;
11546
- } & FetcherExtraProps;
11547
- /**
11548
- * Deletes a webhook
11549
- */
11550
- declare const deleteWebhook: (variables: DeleteWebhookVariables, signal?: AbortSignal) => Promise<undefined>;
11551
- type GetAliasPathParams = {
11552
- /**
11553
- * The alias or alias ID to be retrieved
11554
- *
11555
- * @example example.vercel.app
11556
- */
11557
- idOrAlias: string;
11558
- };
11559
- type GetAliasQueryParams = {
11560
- /**
11561
- * Get the alias only if it was created after the provided timestamp
11562
- *
11563
- * @deprecated true
11564
- * @example 1540095775951
11565
- */
11566
- from?: number;
11567
- /**
11568
- * Get the alias only if it is assigned to the provided project ID
11569
- *
11570
- * @example prj_12HKQaOmR5t5Uy6vdcQsNIiZgHGB
11571
- */
11572
- projectId?: string;
11573
- /**
11574
- * Get the alias only if it was created after this JavaScript timestamp
11575
- *
11576
- * @example 1540095775941
11577
- */
11578
- since?: number;
11579
- /**
11580
- * Get the alias only if it was created before this JavaScript timestamp
11581
- *
11582
- * @example 1540095775951
11583
- */
11584
- until?: number;
11585
- /**
11586
- * The Team identifier or slug to perform the request on behalf of.
11587
- */
11588
- teamId?: string;
11589
- };
11590
- type GetAliasError = ErrorWrapper<undefined>;
11591
- type GetAliasResponse = {
11592
- /**
11593
- * The alias name, it could be a `.vercel.app` subdomain or a custom domain
11594
- *
11595
- * @example my-alias.vercel.app
11596
- */
11597
- alias: string;
11598
- /**
11599
- * The date when the alias was created
11600
- *
11601
- * @format date-time
11602
- * @example 2017-04-26T23:00:34.232Z
11603
- */
11604
- created: string;
11605
- /**
11606
- * The date when the alias was created in milliseconds since the UNIX epoch
11607
- *
11608
- * @example 1540095775941
11609
- */
11610
- createdAt?: number;
11611
- /**
11612
- * Information of the user who created the alias
11613
- */
11614
- creator?: {
11615
- /**
11616
- * ID of the user who created the alias
11617
- *
11618
- * @example 96SnxkFiMyVKsK3pnoHfx3Hz
11619
- */
11620
- uid: string;
11621
- /**
11622
- * Email of the user who created the alias
11623
- *
11624
- * @example john-doe@gmail.com
11625
- */
11626
- email: string;
11627
- /**
11628
- * Username of the user who created the alias
11629
- *
11630
- * @example john-doe
11631
- */
11632
- username: string;
11633
- };
11634
- /**
11635
- * The date when the alias was deleted in milliseconds since the UNIX epoch
12195
+ * The ID of the projects the webhook is associated with
11636
12196
  *
11637
- * @example 1540095775941
12197
+ * @example prj_12HKQaOmR5t5Uy6vdcQsNIiZgHGB
11638
12198
  */
11639
- deletedAt?: number;
12199
+ projectIds?: string[];
12200
+ }[]>;
12201
+ type GetWebhookPathParams = {
12202
+ id: string;
12203
+ };
12204
+ type GetWebhookQueryParams = {
11640
12205
  /**
11641
- * A map with the deployment ID, URL and metadata
12206
+ * The Team identifier or slug to perform the request on behalf of.
11642
12207
  */
11643
- deployment?: {
11644
- /**
11645
- * The deployment unique identifier
11646
- *
11647
- * @example dpl_5m8CQaRBm3FnWRW1od3wKTpaECPx
11648
- */
11649
- id: string;
11650
- /**
11651
- * The deployment unique URL
11652
- *
11653
- * @example my-instant-deployment-3ij3cxz9qr.now.sh
11654
- */
11655
- url: string;
11656
- /**
11657
- * The deployment metadata
11658
- *
11659
- * @example {}
11660
- */
11661
- meta?: string;
11662
- };
12208
+ teamId?: string;
12209
+ };
12210
+ type GetWebhookError = ErrorWrapper<undefined>;
12211
+ type GetWebhookResponse = {
11663
12212
  /**
11664
- * The deployment ID
12213
+ * The webhooks events
11665
12214
  *
11666
- * @example dpl_5m8CQaRBm3FnWRW1od3wKTpaECPx
12215
+ * @example deployment.created
11667
12216
  */
11668
- deploymentId: string | null;
12217
+ events: ('domain.created' | 'deployment.created' | 'deployment.error' | 'deployment.canceled' | 'deployment.succeeded' | 'deployment.ready' | 'deployment.check-rerequested' | 'integration-configuration.permission-upgraded' | 'integration-configuration.removed' | 'integration-configuration.scope-change-confirmed' | 'project.created' | 'project.removed' | 'deployment-checks-completed' | 'deployment-ready' | 'deployment-prepared' | 'deployment-error' | 'deployment-check-rerequested' | 'deployment-canceled' | 'project-created' | 'project-removed' | 'domain-created' | 'deployment' | 'integration-configuration-permission-updated' | 'integration-configuration-removed' | 'integration-configuration-scope-change-confirmed')[];
11669
12218
  /**
11670
- * The unique identifier of the project
12219
+ * The webhook id
11671
12220
  *
11672
- * @example prj_12HKQaOmR5t5Uy6vdcQsNIiZgHGB
12221
+ * @example account_hook_GflD6EYyo7F4ViYS
11673
12222
  */
11674
- projectId: string | null;
12223
+ id: string;
11675
12224
  /**
11676
- * Target destination domain for redirect when the alias is a redirect
12225
+ * A string with the URL of the webhook
12226
+ *
12227
+ * @example https://my-webhook.com
11677
12228
  */
11678
- redirect?: string | null;
12229
+ url: string;
11679
12230
  /**
11680
- * Status code to be used on redirect
12231
+ * The unique ID of the team the webhook belongs to
12232
+ *
12233
+ * @example ZspSRT4ljIEEmMHgoDwKWDei
11681
12234
  */
11682
- redirectStatusCode?: 301 | 302 | 307 | 308 | null;
12235
+ ownerId: string;
11683
12236
  /**
11684
- * The unique identifier of the alias
12237
+ * A number containing the date when the webhook was created in in milliseconds
12238
+ *
12239
+ * @example 1567024758130
11685
12240
  */
11686
- uid: string;
12241
+ createdAt: number;
11687
12242
  /**
11688
- * The date when the alias was updated in milliseconds since the UNIX epoch
12243
+ * A number containing the date when the webhook was updated in in milliseconds
11689
12244
  *
11690
- * @example 1540095775941
12245
+ * @example 1567024758130
11691
12246
  */
11692
- updatedAt?: number;
12247
+ updatedAt: number;
11693
12248
  /**
11694
- * The protection bypass for the alias
12249
+ * The ID of the projects the webhook is associated with
12250
+ *
12251
+ * @example prj_12HKQaOmR5t5Uy6vdcQsNIiZgHGB
11695
12252
  */
11696
- protectionBypass?: {
11697
- [key: string]: {
11698
- createdAt: number;
11699
- createdBy: string;
11700
- scope?: 'automation-bypass' | 'shareable-link';
11701
- };
11702
- };
12253
+ projectIds?: string[];
11703
12254
  };
11704
- type GetAliasVariables = {
11705
- pathParams: GetAliasPathParams;
11706
- queryParams?: GetAliasQueryParams;
12255
+ type GetWebhookVariables = {
12256
+ pathParams: GetWebhookPathParams;
12257
+ queryParams?: GetWebhookQueryParams;
11707
12258
  } & FetcherExtraProps;
11708
12259
  /**
11709
- * Retrieves an Alias for the given host name or alias ID.
12260
+ * Get a webhook
11710
12261
  */
11711
- declare const getAlias: (variables: GetAliasVariables, signal?: AbortSignal) => Promise<GetAliasResponse>;
12262
+ declare const getWebhook: (variables: GetWebhookVariables, signal?: AbortSignal) => Promise<GetWebhookResponse>;
12263
+ type DeleteWebhookPathParams = {
12264
+ id: string;
12265
+ };
12266
+ type DeleteWebhookQueryParams = {
12267
+ /**
12268
+ * The Team identifier or slug to perform the request on behalf of.
12269
+ */
12270
+ teamId?: string;
12271
+ };
12272
+ type DeleteWebhookError = ErrorWrapper<undefined>;
12273
+ type DeleteWebhookVariables = {
12274
+ pathParams: DeleteWebhookPathParams;
12275
+ queryParams?: DeleteWebhookQueryParams;
12276
+ } & FetcherExtraProps;
12277
+ /**
12278
+ * Deletes a webhook
12279
+ */
12280
+ declare const deleteWebhook: (variables: DeleteWebhookVariables, signal?: AbortSignal) => Promise<undefined>;
11712
12281
  type ListAliasesQueryParams = {
11713
12282
  /**
11714
12283
  * Get only aliases of the given domain name
@@ -11805,84 +12374,245 @@ type ListAliasesResponse = {
11805
12374
  username: string;
11806
12375
  };
11807
12376
  /**
11808
- * The date when the alias was deleted in milliseconds since the UNIX epoch
12377
+ * The date when the alias was deleted in milliseconds since the UNIX epoch
12378
+ *
12379
+ * @example 1540095775941
12380
+ */
12381
+ deletedAt?: number;
12382
+ /**
12383
+ * A map with the deployment ID, URL and metadata
12384
+ */
12385
+ deployment?: {
12386
+ /**
12387
+ * The deployment unique identifier
12388
+ *
12389
+ * @example dpl_5m8CQaRBm3FnWRW1od3wKTpaECPx
12390
+ */
12391
+ id: string;
12392
+ /**
12393
+ * The deployment unique URL
12394
+ *
12395
+ * @example my-instant-deployment-3ij3cxz9qr.now.sh
12396
+ */
12397
+ url: string;
12398
+ /**
12399
+ * The deployment metadata
12400
+ *
12401
+ * @example {}
12402
+ */
12403
+ meta?: string;
12404
+ };
12405
+ /**
12406
+ * The deployment ID
12407
+ *
12408
+ * @example dpl_5m8CQaRBm3FnWRW1od3wKTpaECPx
12409
+ */
12410
+ deploymentId: string | null;
12411
+ /**
12412
+ * The unique identifier of the project
12413
+ *
12414
+ * @example prj_12HKQaOmR5t5Uy6vdcQsNIiZgHGB
12415
+ */
12416
+ projectId: string | null;
12417
+ /**
12418
+ * Target destination domain for redirect when the alias is a redirect
12419
+ */
12420
+ redirect?: string | null;
12421
+ /**
12422
+ * Status code to be used on redirect
12423
+ */
12424
+ redirectStatusCode?: 301 | 302 | 307 | 308 | null;
12425
+ /**
12426
+ * The unique identifier of the alias
12427
+ */
12428
+ uid: string;
12429
+ /**
12430
+ * The date when the alias was updated in milliseconds since the UNIX epoch
12431
+ *
12432
+ * @example 1540095775941
12433
+ */
12434
+ updatedAt?: number;
12435
+ /**
12436
+ * The protection bypass for the alias
12437
+ */
12438
+ protectionBypass?: {
12439
+ [key: string]: {
12440
+ createdAt: number;
12441
+ createdBy: string;
12442
+ scope?: 'automation-bypass' | 'shareable-link';
12443
+ };
12444
+ };
12445
+ }[];
12446
+ pagination: Pagination;
12447
+ };
12448
+ type ListAliasesVariables = {
12449
+ queryParams?: ListAliasesQueryParams;
12450
+ } & FetcherExtraProps;
12451
+ /**
12452
+ * Retrieves a list of aliases for the authenticated User or Team. When `domain` is provided, only aliases for that domain will be returned. When `projectId` is provided, it will only return the given project aliases.
12453
+ */
12454
+ declare const listAliases: (variables: ListAliasesVariables, signal?: AbortSignal) => Promise<ListAliasesResponse>;
12455
+ type GetAliasPathParams = {
12456
+ /**
12457
+ * The alias or alias ID to be retrieved
12458
+ *
12459
+ * @example example.vercel.app
12460
+ */
12461
+ idOrAlias: string;
12462
+ };
12463
+ type GetAliasQueryParams = {
12464
+ /**
12465
+ * Get the alias only if it was created after the provided timestamp
12466
+ *
12467
+ * @deprecated true
12468
+ * @example 1540095775951
12469
+ */
12470
+ from?: number;
12471
+ /**
12472
+ * Get the alias only if it is assigned to the provided project ID
12473
+ *
12474
+ * @example prj_12HKQaOmR5t5Uy6vdcQsNIiZgHGB
12475
+ */
12476
+ projectId?: string;
12477
+ /**
12478
+ * Get the alias only if it was created after this JavaScript timestamp
12479
+ *
12480
+ * @example 1540095775941
12481
+ */
12482
+ since?: number;
12483
+ /**
12484
+ * Get the alias only if it was created before this JavaScript timestamp
12485
+ *
12486
+ * @example 1540095775951
12487
+ */
12488
+ until?: number;
12489
+ /**
12490
+ * The Team identifier or slug to perform the request on behalf of.
12491
+ */
12492
+ teamId?: string;
12493
+ };
12494
+ type GetAliasError = ErrorWrapper<undefined>;
12495
+ type GetAliasResponse = {
12496
+ /**
12497
+ * The alias name, it could be a `.vercel.app` subdomain or a custom domain
12498
+ *
12499
+ * @example my-alias.vercel.app
12500
+ */
12501
+ alias: string;
12502
+ /**
12503
+ * The date when the alias was created
12504
+ *
12505
+ * @format date-time
12506
+ * @example 2017-04-26T23:00:34.232Z
12507
+ */
12508
+ created: string;
12509
+ /**
12510
+ * The date when the alias was created in milliseconds since the UNIX epoch
12511
+ *
12512
+ * @example 1540095775941
12513
+ */
12514
+ createdAt?: number;
12515
+ /**
12516
+ * Information of the user who created the alias
12517
+ */
12518
+ creator?: {
12519
+ /**
12520
+ * ID of the user who created the alias
11809
12521
  *
11810
- * @example 1540095775941
11811
- */
11812
- deletedAt?: number;
11813
- /**
11814
- * A map with the deployment ID, URL and metadata
12522
+ * @example 96SnxkFiMyVKsK3pnoHfx3Hz
11815
12523
  */
11816
- deployment?: {
11817
- /**
11818
- * The deployment unique identifier
11819
- *
11820
- * @example dpl_5m8CQaRBm3FnWRW1od3wKTpaECPx
11821
- */
11822
- id: string;
11823
- /**
11824
- * The deployment unique URL
11825
- *
11826
- * @example my-instant-deployment-3ij3cxz9qr.now.sh
11827
- */
11828
- url: string;
11829
- /**
11830
- * The deployment metadata
11831
- *
11832
- * @example {}
11833
- */
11834
- meta?: string;
11835
- };
12524
+ uid: string;
11836
12525
  /**
11837
- * The deployment ID
12526
+ * Email of the user who created the alias
11838
12527
  *
11839
- * @example dpl_5m8CQaRBm3FnWRW1od3wKTpaECPx
12528
+ * @example john-doe@gmail.com
11840
12529
  */
11841
- deploymentId: string | null;
12530
+ email: string;
11842
12531
  /**
11843
- * The unique identifier of the project
12532
+ * Username of the user who created the alias
11844
12533
  *
11845
- * @example prj_12HKQaOmR5t5Uy6vdcQsNIiZgHGB
11846
- */
11847
- projectId: string | null;
11848
- /**
11849
- * Target destination domain for redirect when the alias is a redirect
11850
- */
11851
- redirect?: string | null;
11852
- /**
11853
- * Status code to be used on redirect
12534
+ * @example john-doe
11854
12535
  */
11855
- redirectStatusCode?: 301 | 302 | 307 | 308 | null;
12536
+ username: string;
12537
+ };
12538
+ /**
12539
+ * The date when the alias was deleted in milliseconds since the UNIX epoch
12540
+ *
12541
+ * @example 1540095775941
12542
+ */
12543
+ deletedAt?: number;
12544
+ /**
12545
+ * A map with the deployment ID, URL and metadata
12546
+ */
12547
+ deployment?: {
11856
12548
  /**
11857
- * The unique identifier of the alias
12549
+ * The deployment unique identifier
12550
+ *
12551
+ * @example dpl_5m8CQaRBm3FnWRW1od3wKTpaECPx
11858
12552
  */
11859
- uid: string;
12553
+ id: string;
11860
12554
  /**
11861
- * The date when the alias was updated in milliseconds since the UNIX epoch
12555
+ * The deployment unique URL
11862
12556
  *
11863
- * @example 1540095775941
12557
+ * @example my-instant-deployment-3ij3cxz9qr.now.sh
11864
12558
  */
11865
- updatedAt?: number;
12559
+ url: string;
11866
12560
  /**
11867
- * The protection bypass for the alias
12561
+ * The deployment metadata
12562
+ *
12563
+ * @example {}
11868
12564
  */
11869
- protectionBypass?: {
11870
- [key: string]: {
11871
- createdAt: number;
11872
- createdBy: string;
11873
- scope?: 'automation-bypass' | 'shareable-link';
11874
- };
12565
+ meta?: string;
12566
+ };
12567
+ /**
12568
+ * The deployment ID
12569
+ *
12570
+ * @example dpl_5m8CQaRBm3FnWRW1od3wKTpaECPx
12571
+ */
12572
+ deploymentId: string | null;
12573
+ /**
12574
+ * The unique identifier of the project
12575
+ *
12576
+ * @example prj_12HKQaOmR5t5Uy6vdcQsNIiZgHGB
12577
+ */
12578
+ projectId: string | null;
12579
+ /**
12580
+ * Target destination domain for redirect when the alias is a redirect
12581
+ */
12582
+ redirect?: string | null;
12583
+ /**
12584
+ * Status code to be used on redirect
12585
+ */
12586
+ redirectStatusCode?: 301 | 302 | 307 | 308 | null;
12587
+ /**
12588
+ * The unique identifier of the alias
12589
+ */
12590
+ uid: string;
12591
+ /**
12592
+ * The date when the alias was updated in milliseconds since the UNIX epoch
12593
+ *
12594
+ * @example 1540095775941
12595
+ */
12596
+ updatedAt?: number;
12597
+ /**
12598
+ * The protection bypass for the alias
12599
+ */
12600
+ protectionBypass?: {
12601
+ [key: string]: {
12602
+ createdAt: number;
12603
+ createdBy: string;
12604
+ scope?: 'automation-bypass' | 'shareable-link';
11875
12605
  };
11876
- }[];
11877
- pagination: Pagination;
12606
+ };
11878
12607
  };
11879
- type ListAliasesVariables = {
11880
- queryParams?: ListAliasesQueryParams;
12608
+ type GetAliasVariables = {
12609
+ pathParams: GetAliasPathParams;
12610
+ queryParams?: GetAliasQueryParams;
11881
12611
  } & FetcherExtraProps;
11882
12612
  /**
11883
- * Retrieves a list of aliases for the authenticated User or Team. When `domain` is provided, only aliases for that domain will be returned. When `projectId` is provided, it will only return the given project aliases.
12613
+ * Retrieves an Alias for the given host name or alias ID.
11884
12614
  */
11885
- declare const listAliases: (variables: ListAliasesVariables, signal?: AbortSignal) => Promise<ListAliasesResponse>;
12615
+ declare const getAlias: (variables: GetAliasVariables, signal?: AbortSignal) => Promise<GetAliasResponse>;
11886
12616
  type DeleteAliasPathParams = {
11887
12617
  /**
11888
12618
  * The ID or alias that will be removed
@@ -12443,42 +13173,6 @@ type GetDeploymentsVariables = {
12443
13173
  * List deployments under the account corresponding to the API token. If a deployment hasn't finished uploading (is incomplete), the `url` property will have a value of `null`.
12444
13174
  */
12445
13175
  declare const getDeployments: (variables: GetDeploymentsVariables, signal?: AbortSignal) => Promise<GetDeploymentsResponse>;
12446
- type EmailLoginError = ErrorWrapper<undefined>;
12447
- type EmailLoginResponse = {
12448
- /**
12449
- * The token used to verify the user accepted the login request
12450
- *
12451
- * @example T1dmvPu36nmyYisXAs7IRzcR
12452
- */
12453
- token: string;
12454
- /**
12455
- * The code the user is going to receive on the email. **Must** be displayed to the user so they can verify the request is the correct.
12456
- *
12457
- * @example Practical Saola
12458
- */
12459
- securityCode: string;
12460
- };
12461
- type EmailLoginRequestBody = {
12462
- /**
12463
- * The user email.
12464
- *
12465
- * @example user@mail.com
12466
- */
12467
- email: string;
12468
- /**
12469
- * The desired name for the token. It will be displayed on the user account details.
12470
- *
12471
- * @example Your Client App Name
12472
- */
12473
- tokenName?: string;
12474
- };
12475
- type EmailLoginVariables = {
12476
- body: EmailLoginRequestBody;
12477
- } & FetcherExtraProps;
12478
- /**
12479
- * Request a new login for a user to get a token. This will respond with a verification token and send an email to confirm the request. Once confirmed you can use the verification token to get an authentication token.
12480
- */
12481
- declare const emailLogin: (variables: EmailLoginVariables, signal?: AbortSignal) => Promise<EmailLoginResponse>;
12482
13176
  type VerifyTokenQueryParams = {
12483
13177
  /**
12484
13178
  * Email to verify the login.
@@ -12527,6 +13221,42 @@ type VerifyTokenVariables = {
12527
13221
  * Verify the user accepted the login request and get a authentication token. The user email address and the token received after requesting the login must be added to the URL as a query string with the names `email` and `token`.
12528
13222
  */
12529
13223
  declare const verifyToken: (variables: VerifyTokenVariables, signal?: AbortSignal) => Promise<VerifyTokenResponse>;
13224
+ type EmailLoginError = ErrorWrapper<undefined>;
13225
+ type EmailLoginResponse = {
13226
+ /**
13227
+ * The token used to verify the user accepted the login request
13228
+ *
13229
+ * @example T1dmvPu36nmyYisXAs7IRzcR
13230
+ */
13231
+ token: string;
13232
+ /**
13233
+ * The code the user is going to receive on the email. **Must** be displayed to the user so they can verify the request is the correct.
13234
+ *
13235
+ * @example Practical Saola
13236
+ */
13237
+ securityCode: string;
13238
+ };
13239
+ type EmailLoginRequestBody = {
13240
+ /**
13241
+ * The user email.
13242
+ *
13243
+ * @example user@mail.com
13244
+ */
13245
+ email: string;
13246
+ /**
13247
+ * The desired name for the token. It will be displayed on the user account details.
13248
+ *
13249
+ * @example Your Client App Name
13250
+ */
13251
+ tokenName?: string;
13252
+ };
13253
+ type EmailLoginVariables = {
13254
+ body: EmailLoginRequestBody;
13255
+ } & FetcherExtraProps;
13256
+ /**
13257
+ * Request a new login for a user to get a token. This will respond with a verification token and send an email to confirm the request. Once confirmed you can use the verification token to get an authentication token.
13258
+ */
13259
+ declare const emailLogin: (variables: EmailLoginVariables, signal?: AbortSignal) => Promise<EmailLoginResponse>;
12530
13260
  type DeleteDeploymentPathParams = {
12531
13261
  /**
12532
13262
  * The ID of the deployment to be deleted
@@ -12560,14 +13290,100 @@ type DeleteDeploymentResponse = {
12560
13290
  */
12561
13291
  state: 'DELETED';
12562
13292
  };
12563
- type DeleteDeploymentVariables = {
12564
- pathParams: DeleteDeploymentPathParams;
12565
- queryParams?: DeleteDeploymentQueryParams;
13293
+ type DeleteDeploymentVariables = {
13294
+ pathParams: DeleteDeploymentPathParams;
13295
+ queryParams?: DeleteDeploymentQueryParams;
13296
+ } & FetcherExtraProps;
13297
+ /**
13298
+ * This API allows you to delete a deployment, either by supplying its `id` in the URL or the `url` of the deployment as a query parameter. You can obtain the ID, for example, by listing all deployments.
13299
+ */
13300
+ declare const deleteDeployment: (variables: DeleteDeploymentVariables, signal?: AbortSignal) => Promise<DeleteDeploymentResponse>;
13301
+ type GetSecretsQueryParams = {
13302
+ /**
13303
+ * Filter out secrets based on comma separated secret ids.
13304
+ *
13305
+ * @example sec_RKc5iV0rV3ZSrFrHiruRno7k,sec_fGc5iV0rV3ZSrFrHiruRnouQ
13306
+ * @deprecated true
13307
+ */
13308
+ id?: string;
13309
+ /**
13310
+ * Filter out secrets that belong to a project.
13311
+ *
13312
+ * @example prj_2WjyKQmM8ZnGcJsPWMrHRHrE
13313
+ * @deprecated true
13314
+ */
13315
+ projectId?: string;
13316
+ /**
13317
+ * The Team identifier or slug to perform the request on behalf of.
13318
+ */
13319
+ teamId?: string;
13320
+ };
13321
+ type GetSecretsError = ErrorWrapper<undefined>;
13322
+ type GetSecretsResponse = {
13323
+ secrets: {
13324
+ /**
13325
+ * The date when the secret was created.
13326
+ *
13327
+ * @format date-time
13328
+ * @example 2021-02-10T13:11:49.180Z
13329
+ */
13330
+ created: string;
13331
+ /**
13332
+ * The name of the secret.
13333
+ *
13334
+ * @example my-api-key
13335
+ */
13336
+ name: string;
13337
+ /**
13338
+ * The unique identifier of the team the secret was created for.
13339
+ *
13340
+ * @example team_LLHUOMOoDlqOp8wPE4kFo9pE
13341
+ */
13342
+ teamId?: string | null;
13343
+ /**
13344
+ * The unique identifier of the secret.
13345
+ *
13346
+ * @example sec_XCG7t7AIHuO2SBA8667zNUiM
13347
+ */
13348
+ uid: string;
13349
+ /**
13350
+ * The unique identifier of the user who created the secret.
13351
+ *
13352
+ * @example 2qDDuGFTWXBLDNnqZfWPDp1A
13353
+ */
13354
+ userId?: string;
13355
+ /**
13356
+ * The value of the secret.
13357
+ */
13358
+ value?: string;
13359
+ /**
13360
+ * Timestamp for when the secret was created.
13361
+ *
13362
+ * @example 1609492210000
13363
+ */
13364
+ createdAt?: number;
13365
+ /**
13366
+ * The unique identifier of the project which the secret belongs to.
13367
+ *
13368
+ * @example prj_2WjyKQmM8ZnGcJsPWMrHRHrE
13369
+ */
13370
+ projectId?: string;
13371
+ /**
13372
+ * Indicates whether the secret value can be decrypted after it has been created.
13373
+ *
13374
+ * @example true
13375
+ */
13376
+ decryptable?: boolean;
13377
+ }[];
13378
+ pagination: Pagination;
13379
+ };
13380
+ type GetSecretsVariables = {
13381
+ queryParams?: GetSecretsQueryParams;
12566
13382
  } & FetcherExtraProps;
12567
13383
  /**
12568
- * This API allows you to delete a deployment, either by supplying its `id` in the URL or the `url` of the deployment as a query parameter. You can obtain the ID, for example, by listing all deployments.
13384
+ * Retrieves the active Vercel secrets for the authenticated user. By default it returns 20 secrets. The rest can be retrieved using the pagination options. The body will contain an entry for each secret.
12569
13385
  */
12570
- declare const deleteDeployment: (variables: DeleteDeploymentVariables, signal?: AbortSignal) => Promise<DeleteDeploymentResponse>;
13386
+ declare const getSecrets: (variables: GetSecretsVariables, signal?: AbortSignal) => Promise<GetSecretsResponse>;
12571
13387
  type CreateSecretQueryParams = {
12572
13388
  /**
12573
13389
  * The Team identifier or slug to perform the request on behalf of.
@@ -12708,92 +13524,6 @@ type RenameSecretVariables = {
12708
13524
  * Enables to edit the name of a user's secret. The name has to be unique to that user's secrets.
12709
13525
  */
12710
13526
  declare const renameSecret: (variables: RenameSecretVariables, signal?: AbortSignal) => Promise<RenameSecretResponse>;
12711
- type GetSecretsQueryParams = {
12712
- /**
12713
- * Filter out secrets based on comma separated secret ids.
12714
- *
12715
- * @example sec_RKc5iV0rV3ZSrFrHiruRno7k,sec_fGc5iV0rV3ZSrFrHiruRnouQ
12716
- * @deprecated true
12717
- */
12718
- id?: string;
12719
- /**
12720
- * Filter out secrets that belong to a project.
12721
- *
12722
- * @example prj_2WjyKQmM8ZnGcJsPWMrHRHrE
12723
- * @deprecated true
12724
- */
12725
- projectId?: string;
12726
- /**
12727
- * The Team identifier or slug to perform the request on behalf of.
12728
- */
12729
- teamId?: string;
12730
- };
12731
- type GetSecretsError = ErrorWrapper<undefined>;
12732
- type GetSecretsResponse = {
12733
- secrets: {
12734
- /**
12735
- * The date when the secret was created.
12736
- *
12737
- * @format date-time
12738
- * @example 2021-02-10T13:11:49.180Z
12739
- */
12740
- created: string;
12741
- /**
12742
- * The name of the secret.
12743
- *
12744
- * @example my-api-key
12745
- */
12746
- name: string;
12747
- /**
12748
- * The unique identifier of the team the secret was created for.
12749
- *
12750
- * @example team_LLHUOMOoDlqOp8wPE4kFo9pE
12751
- */
12752
- teamId?: string | null;
12753
- /**
12754
- * The unique identifier of the secret.
12755
- *
12756
- * @example sec_XCG7t7AIHuO2SBA8667zNUiM
12757
- */
12758
- uid: string;
12759
- /**
12760
- * The unique identifier of the user who created the secret.
12761
- *
12762
- * @example 2qDDuGFTWXBLDNnqZfWPDp1A
12763
- */
12764
- userId?: string;
12765
- /**
12766
- * The value of the secret.
12767
- */
12768
- value?: string;
12769
- /**
12770
- * Timestamp for when the secret was created.
12771
- *
12772
- * @example 1609492210000
12773
- */
12774
- createdAt?: number;
12775
- /**
12776
- * The unique identifier of the project which the secret belongs to.
12777
- *
12778
- * @example prj_2WjyKQmM8ZnGcJsPWMrHRHrE
12779
- */
12780
- projectId?: string;
12781
- /**
12782
- * Indicates whether the secret value can be decrypted after it has been created.
12783
- *
12784
- * @example true
12785
- */
12786
- decryptable?: boolean;
12787
- }[];
12788
- pagination: Pagination;
12789
- };
12790
- type GetSecretsVariables = {
12791
- queryParams?: GetSecretsQueryParams;
12792
- } & FetcherExtraProps;
12793
- /**
12794
- * Retrieves the active Vercel secrets for the authenticated user. By default it returns 20 secrets. The rest can be retrieved using the pagination options. The body will contain an entry for each secret.
12795
- */
12796
- declare const getSecrets: (variables: GetSecretsVariables, signal?: AbortSignal) => Promise<GetSecretsResponse>;
12797
13527
  type GetSecretPathParams = {
12798
13528
  /**
12799
13529
  * The name or the unique identifier to which the secret belongs to.
@@ -12930,12 +13660,370 @@ declare const operationsByTag: {
12930
13660
  artifactQuery: (variables: ArtifactQueryVariables, signal?: AbortSignal) => Promise<ArtifactQueryResponse>;
12931
13661
  };
12932
13662
  checks: {
12933
- getAllChecks: (variables: GetAllChecksVariables, signal?: AbortSignal) => Promise<GetAllChecksResponse>;
12934
13663
  createCheck: (variables: CreateCheckVariables, signal?: AbortSignal) => Promise<CreateCheckResponse>;
13664
+ getAllChecks: (variables: GetAllChecksVariables, signal?: AbortSignal) => Promise<GetAllChecksResponse>;
12935
13665
  getCheck: (variables: GetCheckVariables, signal?: AbortSignal) => Promise<GetCheckResponse>;
12936
13666
  updateCheck: (variables: UpdateCheckVariables, signal?: AbortSignal) => Promise<UpdateCheckResponse>;
12937
13667
  rerequestCheck: (variables: RerequestCheckVariables, signal?: AbortSignal) => Promise<Record<string, any>>;
12938
13668
  };
13669
+ projects: {
13670
+ updateProjectDataCache: (variables: UpdateProjectDataCacheVariables, signal?: AbortSignal) => Promise<UpdateProjectDataCacheResponse>;
13671
+ getProjects: (variables: GetProjectsVariables, signal?: AbortSignal) => Promise<GetProjectsResponse>;
13672
+ createProject: (variables: CreateProjectVariables, signal?: AbortSignal) => Promise<CreateProjectResponse>;
13673
+ getProject: (variables: GetProjectVariables, signal?: AbortSignal) => Promise<GetProjectResponse>;
13674
+ updateProject: (variables: UpdateProjectVariables, signal?: AbortSignal) => Promise<UpdateProjectResponse>;
13675
+ deleteProject: (variables: DeleteProjectVariables, signal?: AbortSignal) => Promise<undefined>;
13676
+ getProjectDomains: (variables: GetProjectDomainsVariables, signal?: AbortSignal) => Promise<GetProjectDomainsResponse>;
13677
+ getProjectDomain: (variables: GetProjectDomainVariables, signal?: AbortSignal) => Promise<GetProjectDomainResponse>;
13678
+ updateProjectDomain: (variables: UpdateProjectDomainVariables, signal?: AbortSignal) => Promise<UpdateProjectDomainResponse>;
13679
+ removeProjectDomain: (variables: RemoveProjectDomainVariables, signal?: AbortSignal) => Promise<Record<string, any>>;
13680
+ addProjectDomain: (variables: AddProjectDomainVariables, signal?: AbortSignal) => Promise<AddProjectDomainResponse>;
13681
+ verifyProjectDomain: (variables: VerifyProjectDomainVariables, signal?: AbortSignal) => Promise<VerifyProjectDomainResponse>;
13682
+ filterProjectEnvs: (variables: FilterProjectEnvsVariables, signal?: AbortSignal) => Promise<{
13683
+ target?: ('production' | 'preview' | 'development' | 'preview' | 'development')[] | ('production' | 'preview' | 'development' | 'preview' | 'development');
13684
+ type?: 'secret' | 'system' | 'encrypted' | 'plain' | 'sensitive';
13685
+ id?: string;
13686
+ key?: string;
13687
+ value?: string;
13688
+ configurationId?: string | null;
13689
+ createdAt?: number;
13690
+ updatedAt?: number;
13691
+ createdBy?: string | null;
13692
+ updatedBy?: string | null;
13693
+ gitBranch?: string;
13694
+ edgeConfigId?: string | null;
13695
+ edgeConfigTokenId?: string | null;
13696
+ contentHint?: {
13697
+ type: 'redis-url';
13698
+ storeId: string;
13699
+ } | {
13700
+ type: 'redis-rest-api-url';
13701
+ storeId: string;
13702
+ } | {
13703
+ type: 'redis-rest-api-token';
13704
+ storeId: string;
13705
+ } | {
13706
+ type: 'redis-rest-api-read-only-token';
13707
+ storeId: string;
13708
+ } | {
13709
+ type: 'blob-read-write-token';
13710
+ storeId: string;
13711
+ } | {
13712
+ type: 'postgres-url';
13713
+ storeId: string;
13714
+ } | {
13715
+ type: 'postgres-url-non-pooling';
13716
+ storeId: string;
13717
+ } | {
13718
+ type: 'postgres-prisma-url';
13719
+ storeId: string;
13720
+ } | {
13721
+ type: 'postgres-user';
13722
+ storeId: string;
13723
+ } | {
13724
+ type: 'postgres-host';
13725
+ storeId: string;
13726
+ } | {
13727
+ type: 'postgres-password';
13728
+ storeId: string;
13729
+ } | {
13730
+ type: 'postgres-database';
13731
+ storeId: string;
13732
+ } | null;
13733
+ /**
13734
+ * Whether `value` is decrypted.
13735
+ */
13736
+ decrypted?: boolean;
13737
+ system?: boolean;
13738
+ } | {
13739
+ envs: {
13740
+ target?: ('production' | 'preview' | 'development' | 'preview' | 'development')[] | ('production' | 'preview' | 'development' | 'preview' | 'development');
13741
+ type?: 'secret' | 'system' | 'encrypted' | 'plain' | 'sensitive';
13742
+ id?: string;
13743
+ key?: string;
13744
+ value?: string;
13745
+ configurationId?: string | null;
13746
+ createdAt?: number;
13747
+ updatedAt?: number;
13748
+ createdBy?: string | null;
13749
+ updatedBy?: string | null;
13750
+ gitBranch?: string;
13751
+ edgeConfigId?: string | null;
13752
+ edgeConfigTokenId?: string | null;
13753
+ contentHint?: {
13754
+ type: 'redis-url';
13755
+ storeId: string;
13756
+ } | {
13757
+ type: 'redis-rest-api-url';
13758
+ storeId: string;
13759
+ } | {
13760
+ type: 'redis-rest-api-token';
13761
+ storeId: string;
13762
+ } | {
13763
+ type: 'redis-rest-api-read-only-token';
13764
+ storeId: string;
13765
+ } | {
13766
+ type: 'blob-read-write-token';
13767
+ storeId: string;
13768
+ } | {
13769
+ type: 'postgres-url';
13770
+ storeId: string;
13771
+ } | {
13772
+ type: 'postgres-url-non-pooling';
13773
+ storeId: string;
13774
+ } | {
13775
+ type: 'postgres-prisma-url';
13776
+ storeId: string;
13777
+ } | {
13778
+ type: 'postgres-user';
13779
+ storeId: string;
13780
+ } | {
13781
+ type: 'postgres-host';
13782
+ storeId: string;
13783
+ } | {
13784
+ type: 'postgres-password';
13785
+ storeId: string;
13786
+ } | {
13787
+ type: 'postgres-database';
13788
+ storeId: string;
13789
+ } | null;
13790
+ /**
13791
+ * Whether `value` is decrypted.
13792
+ */
13793
+ decrypted?: boolean;
13794
+ system?: boolean;
13795
+ }[];
13796
+ pagination: Pagination;
13797
+ } | {
13798
+ envs: {
13799
+ target?: ('production' | 'preview' | 'development' | 'preview' | 'development')[] | ('production' | 'preview' | 'development' | 'preview' | 'development');
13800
+ type?: 'secret' | 'system' | 'encrypted' | 'plain' | 'sensitive';
13801
+ id?: string;
13802
+ key?: string;
13803
+ value?: string;
13804
+ configurationId?: string | null;
13805
+ createdAt?: number;
13806
+ updatedAt?: number;
13807
+ createdBy?: string | null;
13808
+ updatedBy?: string | null;
13809
+ gitBranch?: string;
13810
+ edgeConfigId?: string | null;
13811
+ edgeConfigTokenId?: string | null;
13812
+ contentHint?: {
13813
+ type: 'redis-url';
13814
+ storeId: string;
13815
+ } | {
13816
+ type: 'redis-rest-api-url';
13817
+ storeId: string;
13818
+ } | {
13819
+ type: 'redis-rest-api-token';
13820
+ storeId: string;
13821
+ } | {
13822
+ type: 'redis-rest-api-read-only-token';
13823
+ storeId: string;
13824
+ } | {
13825
+ type: 'blob-read-write-token';
13826
+ storeId: string;
13827
+ } | {
13828
+ type: 'postgres-url';
13829
+ storeId: string;
13830
+ } | {
13831
+ type: 'postgres-url-non-pooling';
13832
+ storeId: string;
13833
+ } | {
13834
+ type: 'postgres-prisma-url';
13835
+ storeId: string;
13836
+ } | {
13837
+ type: 'postgres-user';
13838
+ storeId: string;
13839
+ } | {
13840
+ type: 'postgres-host';
13841
+ storeId: string;
13842
+ } | {
13843
+ type: 'postgres-password';
13844
+ storeId: string;
13845
+ } | {
13846
+ type: 'postgres-database';
13847
+ storeId: string;
13848
+ } | null;
13849
+ /**
13850
+ * Whether `value` is decrypted.
13851
+ */
13852
+ decrypted?: boolean;
13853
+ system?: boolean;
13854
+ }[];
13855
+ }>;
13856
+ getProjectEnv: (variables: GetProjectEnvVariables, signal?: AbortSignal) => Promise<GetProjectEnvResponse>;
13857
+ createProjectEnv: (variables: CreateProjectEnvVariables, signal?: AbortSignal) => Promise<CreateProjectEnvResponse>;
13858
+ removeProjectEnv: (variables: RemoveProjectEnvVariables, signal?: AbortSignal) => Promise<{
13859
+ system?: boolean;
13860
+ target?: ('production' | 'preview' | 'development' | 'preview' | 'development' | 'preview' | 'development')[] | ('production' | 'preview' | 'development' | 'preview' | 'development' | 'preview' | 'development');
13861
+ type: 'secret' | 'system' | 'encrypted' | 'plain' | 'sensitive';
13862
+ id?: string;
13863
+ key: string;
13864
+ value: string;
13865
+ configurationId?: string | null;
13866
+ createdAt?: number;
13867
+ updatedAt?: number;
13868
+ createdBy?: string | null;
13869
+ updatedBy?: string | null;
13870
+ gitBranch?: string;
13871
+ edgeConfigId?: string | null;
13872
+ edgeConfigTokenId?: string | null;
13873
+ contentHint?: {
13874
+ type: 'redis-url';
13875
+ storeId: string;
13876
+ } | {
13877
+ type: 'redis-rest-api-url';
13878
+ storeId: string;
13879
+ } | {
13880
+ type: 'redis-rest-api-token';
13881
+ storeId: string;
13882
+ } | {
13883
+ type: 'redis-rest-api-read-only-token';
13884
+ storeId: string;
13885
+ } | {
13886
+ type: 'blob-read-write-token';
13887
+ storeId: string;
13888
+ } | {
13889
+ type: 'postgres-url';
13890
+ storeId: string;
13891
+ } | {
13892
+ type: 'postgres-url-non-pooling';
13893
+ storeId: string;
13894
+ } | {
13895
+ type: 'postgres-prisma-url';
13896
+ storeId: string;
13897
+ } | {
13898
+ type: 'postgres-user';
13899
+ storeId: string;
13900
+ } | {
13901
+ type: 'postgres-host';
13902
+ storeId: string;
13903
+ } | {
13904
+ type: 'postgres-password';
13905
+ storeId: string;
13906
+ } | {
13907
+ type: 'postgres-database';
13908
+ storeId: string;
13909
+ } | null;
13910
+ /**
13911
+ * Whether `value` is decrypted.
13912
+ */
13913
+ decrypted?: boolean;
13914
+ } | {
13915
+ target?: ('production' | 'preview' | 'development' | 'preview' | 'development' | 'preview' | 'development')[] | ('production' | 'preview' | 'development' | 'preview' | 'development' | 'preview' | 'development');
13916
+ type: 'secret' | 'system' | 'encrypted' | 'plain' | 'sensitive';
13917
+ id?: string;
13918
+ key: string;
13919
+ value: string;
13920
+ configurationId?: string | null;
13921
+ createdAt?: number;
13922
+ updatedAt?: number;
13923
+ createdBy?: string | null;
13924
+ updatedBy?: string | null;
13925
+ gitBranch?: string;
13926
+ edgeConfigId?: string | null;
13927
+ edgeConfigTokenId?: string | null;
13928
+ contentHint?: {
13929
+ type: 'redis-url';
13930
+ storeId: string;
13931
+ } | {
13932
+ type: 'redis-rest-api-url';
13933
+ storeId: string;
13934
+ } | {
13935
+ type: 'redis-rest-api-token';
13936
+ storeId: string;
13937
+ } | {
13938
+ type: 'redis-rest-api-read-only-token';
13939
+ storeId: string;
13940
+ } | {
13941
+ type: 'blob-read-write-token';
13942
+ storeId: string;
13943
+ } | {
13944
+ type: 'postgres-url';
13945
+ storeId: string;
13946
+ } | {
13947
+ type: 'postgres-url-non-pooling';
13948
+ storeId: string;
13949
+ } | {
13950
+ type: 'postgres-prisma-url';
13951
+ storeId: string;
13952
+ } | {
13953
+ type: 'postgres-user';
13954
+ storeId: string;
13955
+ } | {
13956
+ type: 'postgres-host';
13957
+ storeId: string;
13958
+ } | {
13959
+ type: 'postgres-password';
13960
+ storeId: string;
13961
+ } | {
13962
+ type: 'postgres-database';
13963
+ storeId: string;
13964
+ } | null;
13965
+ /**
13966
+ * Whether `value` is decrypted.
13967
+ */
13968
+ decrypted?: boolean;
13969
+ } | {
13970
+ target?: ('production' | 'preview' | 'development' | 'preview' | 'development' | 'preview' | 'development')[] | ('production' | 'preview' | 'development' | 'preview' | 'development' | 'preview' | 'development');
13971
+ type: 'secret' | 'system' | 'encrypted' | 'plain' | 'sensitive';
13972
+ id?: string;
13973
+ key: string;
13974
+ value: string;
13975
+ configurationId?: string | null;
13976
+ createdAt?: number;
13977
+ updatedAt?: number;
13978
+ createdBy?: string | null;
13979
+ updatedBy?: string | null;
13980
+ gitBranch?: string;
13981
+ edgeConfigId?: string | null;
13982
+ edgeConfigTokenId?: string | null;
13983
+ contentHint?: {
13984
+ type: 'redis-url';
13985
+ storeId: string;
13986
+ } | {
13987
+ type: 'redis-rest-api-url';
13988
+ storeId: string;
13989
+ } | {
13990
+ type: 'redis-rest-api-token';
13991
+ storeId: string;
13992
+ } | {
13993
+ type: 'redis-rest-api-read-only-token';
13994
+ storeId: string;
13995
+ } | {
13996
+ type: 'blob-read-write-token';
13997
+ storeId: string;
13998
+ } | {
13999
+ type: 'postgres-url';
14000
+ storeId: string;
14001
+ } | {
14002
+ type: 'postgres-url-non-pooling';
14003
+ storeId: string;
14004
+ } | {
14005
+ type: 'postgres-prisma-url';
14006
+ storeId: string;
14007
+ } | {
14008
+ type: 'postgres-user';
14009
+ storeId: string;
14010
+ } | {
14011
+ type: 'postgres-host';
14012
+ storeId: string;
14013
+ } | {
14014
+ type: 'postgres-password';
14015
+ storeId: string;
14016
+ } | {
14017
+ type: 'postgres-database';
14018
+ storeId: string;
14019
+ } | null;
14020
+ /**
14021
+ * Whether `value` is decrypted.
14022
+ */
14023
+ decrypted?: boolean;
14024
+ }[]>;
14025
+ editProjectEnv: (variables: EditProjectEnvVariables, signal?: AbortSignal) => Promise<EditProjectEnvResponse>;
14026
+ };
12939
14027
  deployments: {
12940
14028
  getDeploymentEvents: (variables: GetDeploymentEventsVariables, signal?: AbortSignal) => Promise<GetDeploymentEventsResponse>;
12941
14029
  getDeployment: (variables: GetDeploymentVariables, signal?: AbortSignal) => Promise<{
@@ -13150,6 +14238,7 @@ declare const operationsByTag: {
13150
14238
  link?: string;
13151
14239
  action?: string;
13152
14240
  } | null;
14241
+ autoAssignCustomDomains?: boolean;
13153
14242
  automaticAliases?: string[];
13154
14243
  bootedAt: number;
13155
14244
  buildErrorAt?: number;
@@ -13366,6 +14455,7 @@ declare const operationsByTag: {
13366
14455
  link?: string;
13367
14456
  action?: string;
13368
14457
  } | null;
14458
+ autoAssignCustomDomains?: boolean;
13369
14459
  automaticAliases?: string[];
13370
14460
  bootedAt: number;
13371
14461
  buildErrorAt?: number;
@@ -13596,17 +14686,6 @@ declare const operationsByTag: {
13596
14686
  deleteDomain: (variables: DeleteDomainVariables, signal?: AbortSignal) => Promise<DeleteDomainResponse>;
13597
14687
  };
13598
14688
  dns: {
13599
- createRecord: (variables: CreateRecordVariables, signal?: AbortSignal) => Promise<{
13600
- uid: string;
13601
- updated: number;
13602
- } | {
13603
- /**
13604
- * The id of the newly created DNS record
13605
- *
13606
- * @example rec_V0fra8eEgQwEpFhYG2vTzC3K
13607
- */
13608
- uid: string;
13609
- }>;
13610
14689
  getRecords: (variables: GetRecordsVariables, signal?: AbortSignal) => Promise<string | {
13611
14690
  records: {
13612
14691
  id: string;
@@ -13639,6 +14718,17 @@ declare const operationsByTag: {
13639
14718
  }[];
13640
14719
  pagination: Pagination;
13641
14720
  }>;
14721
+ createRecord: (variables: CreateRecordVariables, signal?: AbortSignal) => Promise<{
14722
+ uid: string;
14723
+ updated: number;
14724
+ } | {
14725
+ /**
14726
+ * The id of the newly created DNS record
14727
+ *
14728
+ * @example rec_V0fra8eEgQwEpFhYG2vTzC3K
14729
+ */
14730
+ uid: string;
14731
+ }>;
13642
14732
  updateRecord: (variables: UpdateRecordVariables, signal?: AbortSignal) => Promise<UpdateRecordResponse>;
13643
14733
  removeRecord: (variables: RemoveRecordVariables, signal?: AbortSignal) => Promise<Record<string, any>>;
13644
14734
  };
@@ -13658,8 +14748,8 @@ declare const operationsByTag: {
13658
14748
  };
13659
14749
  user: {
13660
14750
  listUserEvents: (variables: ListUserEventsVariables, signal?: AbortSignal) => Promise<ListUserEventsResponse>;
13661
- requestDelete: (variables: RequestDeleteVariables, signal?: AbortSignal) => Promise<RequestDeleteResponse>;
13662
14751
  getAuthUser: (variables: GetAuthUserVariables, signal?: AbortSignal) => Promise<GetAuthUserResponse>;
14752
+ requestDelete: (variables: RequestDeleteVariables, signal?: AbortSignal) => Promise<RequestDeleteResponse>;
13663
14753
  };
13664
14754
  integrations: {
13665
14755
  getConfigurations: (variables: GetConfigurationsVariables, signal?: AbortSignal) => Promise<{
@@ -13927,551 +15017,194 @@ declare const operationsByTag: {
13927
15017
  */
13928
15018
  projects?: string[];
13929
15019
  /**
13930
- * Source defines where the configuration was installed from. It is used to analyze user engagement for integration installations in product metrics.
13931
- *
13932
- * @example marketplace
13933
- */
13934
- source?: 'marketplace' | 'deploy-button' | 'oauth' | 'external';
13935
- removedLogDrainsAt?: number;
13936
- removedProjectEnvsAt?: number;
13937
- removedTokensAt?: number;
13938
- removedWebhooksAt?: number;
13939
- /**
13940
- * The slug of the integration the configuration is created for.
13941
- *
13942
- * @example slack
13943
- */
13944
- slug: string;
13945
- /**
13946
- * When the configuration was created for a team, this will show the ID of the team.
13947
- *
13948
- * @example team_nLlpyC6RE1qxydlFKbrxDlud
13949
- */
13950
- teamId?: string | null;
13951
- type: 'integration-configuration';
13952
- /**
13953
- * A timestamp that tells you when the configuration was updated.
13954
- *
13955
- * @example 1558531915505
13956
- */
13957
- updatedAt: number;
13958
- /**
13959
- * The ID of the user that created the configuration.
13960
- *
13961
- * @example kr1PsOIzqEL5Xg6M4VZcZosf
13962
- */
13963
- userId: string;
13964
- /**
13965
- * The resources that are allowed to be accessed by the configuration.
13966
- *
13967
- * @example read:project
13968
- * @example read-write:log-drain
13969
- */
13970
- scopes: string[];
13971
- scopesQueue?: {
13972
- scopes: {
13973
- added: ('read:integration-configuration' | 'read-write:integration-configuration' | 'read:deployment' | 'read-write:deployment' | 'read-write:deployment-check' | 'read:project' | 'read-write:project' | 'read-write:project-env-vars' | 'read-write:global-project-env-vars' | 'read:team' | 'read:user' | 'read-write:log-drain' | 'read:domain' | 'read-write:domain' | 'read-write:edge-config' | 'read-write:otel-endpoint' | 'read:monitoring')[];
13974
- upgraded: ('read:integration-configuration' | 'read-write:integration-configuration' | 'read:deployment' | 'read-write:deployment' | 'read-write:deployment-check' | 'read:project' | 'read-write:project' | 'read-write:project-env-vars' | 'read-write:global-project-env-vars' | 'read:team' | 'read:user' | 'read-write:log-drain' | 'read:domain' | 'read-write:domain' | 'read-write:edge-config' | 'read-write:otel-endpoint' | 'read:monitoring')[];
13975
- };
13976
- note: string;
13977
- requestedAt: number;
13978
- confirmedAt?: number;
13979
- }[];
13980
- /**
13981
- * A timestamp that tells you when the configuration was disabled. Note: Configurations can be disabled when the associated user loses access to a team. They do not function during this time until the configuration is 'transferred', meaning the associated user is changed to one with access to the team.
13982
- *
13983
- * @example 1558531915505
13984
- */
13985
- disabledAt?: number;
13986
- /**
13987
- * A timestamp that tells you when the configuration was updated.
13988
- *
13989
- * @example 1558531915505
13990
- */
13991
- deletedAt?: number | null;
13992
- } | {
13993
- /**
13994
- * A string representing the permission for projects. Possible values are `all` or `selected`.
13995
- *
13996
- * @example all
13997
- */
13998
- projectSelection: 'selected' | 'all';
13999
- /**
14000
- * A timestamp that tells you when the configuration was installed successfully
14001
- *
14002
- * @example 1558531915505
14003
- */
14004
- completedAt?: number;
14005
- /**
14006
- * A timestamp that tells you when the configuration was created
14007
- *
14008
- * @example 1558531915505
14009
- */
14010
- createdAt: number;
14011
- /**
14012
- * The unique identifier of the configuration
14013
- *
14014
- * @example icfg_3bwCLgxL8qt5kjRLcv2Dit7F
14015
- */
14016
- id: string;
14017
- /**
14018
- * The unique identifier of the app the configuration was created for
14019
- *
14020
- * @example oac_xzpVzcUOgcB1nrVlirtKhbWV
14021
- */
14022
- integrationId: string;
14023
- /**
14024
- * Will be truthy in those cases where the configuration was created to authorize a client through the OAuth2 flow.
14025
- *
14026
- * @example false
14027
- */
14028
- oauthConfiguration?: boolean;
14029
- /**
14030
- * The user or team ID that owns the configuration
14031
- *
14032
- * @example kr1PsOIzqEL5Xg6M4VZcZosf
14033
- */
14034
- ownerId: string;
14035
- /**
14036
- * When a configuration is limited to access certain projects, this will contain each of the project ID it is allowed to access. If it is not defined, the configuration has full access.
14037
- *
14038
- * @example prj_xQxbutw1HpL6HLYPAzt5h75m8NjO
14039
- */
14040
- projects?: string[];
14041
- /**
14042
- * Source defines where the configuration was installed from. It is used to analyze user engagement for integration installations in product metrics.
14043
- *
14044
- * @example marketplace
14045
- */
14046
- source?: 'marketplace' | 'deploy-button' | 'oauth' | 'external';
14047
- removedLogDrainsAt?: number;
14048
- removedProjectEnvsAt?: number;
14049
- removedTokensAt?: number;
14050
- removedWebhooksAt?: number;
14051
- /**
14052
- * The slug of the integration the configuration is created for.
14053
- *
14054
- * @example slack
14055
- */
14056
- slug: string;
14057
- /**
14058
- * When the configuration was created for a team, this will show the ID of the team.
14059
- *
14060
- * @example team_nLlpyC6RE1qxydlFKbrxDlud
14061
- */
14062
- teamId?: string | null;
14063
- type: 'integration-configuration';
14064
- /**
14065
- * A timestamp that tells you when the configuration was updated.
14066
- *
14067
- * @example 1558531915505
14068
- */
14069
- updatedAt: number;
14070
- /**
14071
- * The ID of the user that created the configuration.
14072
- *
14073
- * @example kr1PsOIzqEL5Xg6M4VZcZosf
14074
- */
14075
- userId: string;
14076
- /**
14077
- * The resources that are allowed to be accessed by the configuration.
14078
- *
14079
- * @example read:project
14080
- * @example read-write:log-drain
14081
- */
14082
- scopes: string[];
14083
- scopesQueue?: {
14084
- scopes: {
14085
- added: ('read:integration-configuration' | 'read-write:integration-configuration' | 'read:deployment' | 'read-write:deployment' | 'read-write:deployment-check' | 'read:project' | 'read-write:project' | 'read-write:project-env-vars' | 'read-write:global-project-env-vars' | 'read:team' | 'read:user' | 'read-write:log-drain' | 'read:domain' | 'read-write:domain' | 'read-write:edge-config' | 'read-write:otel-endpoint' | 'read:monitoring')[];
14086
- upgraded: ('read:integration-configuration' | 'read-write:integration-configuration' | 'read:deployment' | 'read-write:deployment' | 'read-write:deployment-check' | 'read:project' | 'read-write:project' | 'read-write:project-env-vars' | 'read-write:global-project-env-vars' | 'read:team' | 'read:user' | 'read-write:log-drain' | 'read:domain' | 'read-write:domain' | 'read-write:edge-config' | 'read-write:otel-endpoint' | 'read:monitoring')[];
14087
- };
14088
- note: string;
14089
- requestedAt: number;
14090
- confirmedAt?: number;
14091
- }[];
14092
- /**
14093
- * A timestamp that tells you when the configuration was disabled. Note: Configurations can be disabled when the associated user loses access to a team. They do not function during this time until the configuration is 'transferred', meaning the associated user is changed to one with access to the team.
14094
- *
14095
- * @example 1558531915505
14096
- */
14097
- disabledAt?: number;
14098
- /**
14099
- * A timestamp that tells you when the configuration was updated.
14100
- *
14101
- * @example 1558531915505
14102
- */
14103
- deletedAt?: number | null;
14104
- canConfigureOpenTelemetry?: boolean;
14105
- }>;
14106
- deleteConfiguration: (variables: DeleteConfigurationVariables, signal?: AbortSignal) => Promise<undefined>;
14107
- gitNamespaces: (variables: GitNamespacesVariables, signal?: AbortSignal) => Promise<GitNamespacesResponse>;
14108
- searchRepo: (variables: SearchRepoVariables, signal?: AbortSignal) => Promise<SearchRepoResponse>;
14109
- };
14110
- logDrains: {
14111
- getIntegrationLogDrains: (variables: GetIntegrationLogDrainsVariables, signal?: AbortSignal) => Promise<GetIntegrationLogDrainsResponse>;
14112
- createLogDrain: (variables: CreateLogDrainVariables, signal?: AbortSignal) => Promise<CreateLogDrainResponse>;
14113
- deleteIntegrationLogDrain: (variables: DeleteIntegrationLogDrainVariables, signal?: AbortSignal) => Promise<undefined>;
14114
- getConfigurableLogDrain: (variables: GetConfigurableLogDrainVariables, signal?: AbortSignal) => Promise<GetConfigurableLogDrainResponse>;
14115
- deleteConfigurableLogDrain: (variables: DeleteConfigurableLogDrainVariables, signal?: AbortSignal) => Promise<undefined>;
14116
- getConfigurableLogDrains: (variables: GetConfigurableLogDrainsVariables, signal?: AbortSignal) => Promise<GetConfigurableLogDrainsResponse>;
14117
- createConfigurableLogDrain: (variables: CreateConfigurableLogDrainVariables, signal?: AbortSignal) => Promise<CreateConfigurableLogDrainResponse>;
14118
- };
14119
- projects: {
14120
- getProjects: (variables: GetProjectsVariables, signal?: AbortSignal) => Promise<GetProjectsResponse>;
14121
- createProject: (variables: CreateProjectVariables, signal?: AbortSignal) => Promise<CreateProjectResponse>;
14122
- getProject: (variables: GetProjectVariables, signal?: AbortSignal) => Promise<GetProjectResponse>;
14123
- updateProject: (variables: UpdateProjectVariables, signal?: AbortSignal) => Promise<UpdateProjectResponse>;
14124
- deleteProject: (variables: DeleteProjectVariables, signal?: AbortSignal) => Promise<undefined>;
14125
- getProjectDomains: (variables: GetProjectDomainsVariables, signal?: AbortSignal) => Promise<GetProjectDomainsResponse>;
14126
- getProjectDomain: (variables: GetProjectDomainVariables, signal?: AbortSignal) => Promise<GetProjectDomainResponse>;
14127
- updateProjectDomain: (variables: UpdateProjectDomainVariables, signal?: AbortSignal) => Promise<UpdateProjectDomainResponse>;
14128
- removeProjectDomain: (variables: RemoveProjectDomainVariables, signal?: AbortSignal) => Promise<Record<string, any>>;
14129
- addProjectDomain: (variables: AddProjectDomainVariables, signal?: AbortSignal) => Promise<AddProjectDomainResponse>;
14130
- verifyProjectDomain: (variables: VerifyProjectDomainVariables, signal?: AbortSignal) => Promise<VerifyProjectDomainResponse>;
14131
- filterProjectEnvs: (variables: FilterProjectEnvsVariables, signal?: AbortSignal) => Promise<{
14132
- target?: ('production' | 'preview' | 'development' | 'preview' | 'development')[] | ('production' | 'preview' | 'development' | 'preview' | 'development');
14133
- type?: 'secret' | 'system' | 'encrypted' | 'plain' | 'sensitive';
14134
- id?: string;
14135
- key?: string;
14136
- value?: string;
14137
- configurationId?: string | null;
14138
- createdAt?: number;
14139
- updatedAt?: number;
14140
- createdBy?: string | null;
14141
- updatedBy?: string | null;
14142
- gitBranch?: string;
14143
- edgeConfigId?: string | null;
14144
- edgeConfigTokenId?: string | null;
14145
- contentHint?: {
14146
- type: 'redis-url';
14147
- storeId: string;
14148
- } | {
14149
- type: 'redis-rest-api-url';
14150
- storeId: string;
14151
- } | {
14152
- type: 'redis-rest-api-token';
14153
- storeId: string;
14154
- } | {
14155
- type: 'redis-rest-api-read-only-token';
14156
- storeId: string;
14157
- } | {
14158
- type: 'blob-read-write-token';
14159
- storeId: string;
14160
- } | {
14161
- type: 'postgres-url';
14162
- storeId: string;
14163
- } | {
14164
- type: 'postgres-url-non-pooling';
14165
- storeId: string;
14166
- } | {
14167
- type: 'postgres-prisma-url';
14168
- storeId: string;
14169
- } | {
14170
- type: 'postgres-user';
14171
- storeId: string;
14172
- } | {
14173
- type: 'postgres-host';
14174
- storeId: string;
14175
- } | {
14176
- type: 'postgres-password';
14177
- storeId: string;
14178
- } | {
14179
- type: 'postgres-database';
14180
- storeId: string;
14181
- } | null;
14182
- /**
14183
- * Whether `value` is decrypted.
15020
+ * Source defines where the configuration was installed from. It is used to analyze user engagement for integration installations in product metrics.
15021
+ *
15022
+ * @example marketplace
14184
15023
  */
14185
- decrypted?: boolean;
14186
- system?: boolean;
14187
- } | {
14188
- envs: {
14189
- target?: ('production' | 'preview' | 'development' | 'preview' | 'development')[] | ('production' | 'preview' | 'development' | 'preview' | 'development');
14190
- type?: 'secret' | 'system' | 'encrypted' | 'plain' | 'sensitive';
14191
- id?: string;
14192
- key?: string;
14193
- value?: string;
14194
- configurationId?: string | null;
14195
- createdAt?: number;
14196
- updatedAt?: number;
14197
- createdBy?: string | null;
14198
- updatedBy?: string | null;
14199
- gitBranch?: string;
14200
- edgeConfigId?: string | null;
14201
- edgeConfigTokenId?: string | null;
14202
- contentHint?: {
14203
- type: 'redis-url';
14204
- storeId: string;
14205
- } | {
14206
- type: 'redis-rest-api-url';
14207
- storeId: string;
14208
- } | {
14209
- type: 'redis-rest-api-token';
14210
- storeId: string;
14211
- } | {
14212
- type: 'redis-rest-api-read-only-token';
14213
- storeId: string;
14214
- } | {
14215
- type: 'blob-read-write-token';
14216
- storeId: string;
14217
- } | {
14218
- type: 'postgres-url';
14219
- storeId: string;
14220
- } | {
14221
- type: 'postgres-url-non-pooling';
14222
- storeId: string;
14223
- } | {
14224
- type: 'postgres-prisma-url';
14225
- storeId: string;
14226
- } | {
14227
- type: 'postgres-user';
14228
- storeId: string;
14229
- } | {
14230
- type: 'postgres-host';
14231
- storeId: string;
14232
- } | {
14233
- type: 'postgres-password';
14234
- storeId: string;
14235
- } | {
14236
- type: 'postgres-database';
14237
- storeId: string;
14238
- } | null;
14239
- /**
14240
- * Whether `value` is decrypted.
14241
- */
14242
- decrypted?: boolean;
14243
- system?: boolean;
15024
+ source?: 'marketplace' | 'deploy-button' | 'oauth' | 'external';
15025
+ removedLogDrainsAt?: number;
15026
+ removedProjectEnvsAt?: number;
15027
+ removedTokensAt?: number;
15028
+ removedWebhooksAt?: number;
15029
+ /**
15030
+ * The slug of the integration the configuration is created for.
15031
+ *
15032
+ * @example slack
15033
+ */
15034
+ slug: string;
15035
+ /**
15036
+ * When the configuration was created for a team, this will show the ID of the team.
15037
+ *
15038
+ * @example team_nLlpyC6RE1qxydlFKbrxDlud
15039
+ */
15040
+ teamId?: string | null;
15041
+ type: 'integration-configuration';
15042
+ /**
15043
+ * A timestamp that tells you when the configuration was updated.
15044
+ *
15045
+ * @example 1558531915505
15046
+ */
15047
+ updatedAt: number;
15048
+ /**
15049
+ * The ID of the user that created the configuration.
15050
+ *
15051
+ * @example kr1PsOIzqEL5Xg6M4VZcZosf
15052
+ */
15053
+ userId: string;
15054
+ /**
15055
+ * The resources that are allowed to be accessed by the configuration.
15056
+ *
15057
+ * @example read:project
15058
+ * @example read-write:log-drain
15059
+ */
15060
+ scopes: string[];
15061
+ scopesQueue?: {
15062
+ scopes: {
15063
+ added: ('read:integration-configuration' | 'read-write:integration-configuration' | 'read:deployment' | 'read-write:deployment' | 'read-write:deployment-check' | 'read:project' | 'read-write:project' | 'read-write:project-env-vars' | 'read-write:global-project-env-vars' | 'read:team' | 'read:user' | 'read-write:log-drain' | 'read:domain' | 'read-write:domain' | 'read-write:edge-config' | 'read-write:otel-endpoint' | 'read:monitoring')[];
15064
+ upgraded: ('read:integration-configuration' | 'read-write:integration-configuration' | 'read:deployment' | 'read-write:deployment' | 'read-write:deployment-check' | 'read:project' | 'read-write:project' | 'read-write:project-env-vars' | 'read-write:global-project-env-vars' | 'read:team' | 'read:user' | 'read-write:log-drain' | 'read:domain' | 'read-write:domain' | 'read-write:edge-config' | 'read-write:otel-endpoint' | 'read:monitoring')[];
15065
+ };
15066
+ note: string;
15067
+ requestedAt: number;
15068
+ confirmedAt?: number;
14244
15069
  }[];
14245
- pagination: Pagination;
15070
+ /**
15071
+ * A timestamp that tells you when the configuration was disabled. Note: Configurations can be disabled when the associated user loses access to a team. They do not function during this time until the configuration is 'transferred', meaning the associated user is changed to one with access to the team.
15072
+ *
15073
+ * @example 1558531915505
15074
+ */
15075
+ disabledAt?: number;
15076
+ /**
15077
+ * A timestamp that tells you when the configuration was updated.
15078
+ *
15079
+ * @example 1558531915505
15080
+ */
15081
+ deletedAt?: number | null;
14246
15082
  } | {
14247
- envs: {
14248
- target?: ('production' | 'preview' | 'development' | 'preview' | 'development')[] | ('production' | 'preview' | 'development' | 'preview' | 'development');
14249
- type?: 'secret' | 'system' | 'encrypted' | 'plain' | 'sensitive';
14250
- id?: string;
14251
- key?: string;
14252
- value?: string;
14253
- configurationId?: string | null;
14254
- createdAt?: number;
14255
- updatedAt?: number;
14256
- createdBy?: string | null;
14257
- updatedBy?: string | null;
14258
- gitBranch?: string;
14259
- edgeConfigId?: string | null;
14260
- edgeConfigTokenId?: string | null;
14261
- contentHint?: {
14262
- type: 'redis-url';
14263
- storeId: string;
14264
- } | {
14265
- type: 'redis-rest-api-url';
14266
- storeId: string;
14267
- } | {
14268
- type: 'redis-rest-api-token';
14269
- storeId: string;
14270
- } | {
14271
- type: 'redis-rest-api-read-only-token';
14272
- storeId: string;
14273
- } | {
14274
- type: 'blob-read-write-token';
14275
- storeId: string;
14276
- } | {
14277
- type: 'postgres-url';
14278
- storeId: string;
14279
- } | {
14280
- type: 'postgres-url-non-pooling';
14281
- storeId: string;
14282
- } | {
14283
- type: 'postgres-prisma-url';
14284
- storeId: string;
14285
- } | {
14286
- type: 'postgres-user';
14287
- storeId: string;
14288
- } | {
14289
- type: 'postgres-host';
14290
- storeId: string;
14291
- } | {
14292
- type: 'postgres-password';
14293
- storeId: string;
14294
- } | {
14295
- type: 'postgres-database';
14296
- storeId: string;
14297
- } | null;
14298
- /**
14299
- * Whether `value` is decrypted.
14300
- */
14301
- decrypted?: boolean;
14302
- system?: boolean;
14303
- }[];
14304
- }>;
14305
- getProjectEnv: (variables: GetProjectEnvVariables, signal?: AbortSignal) => Promise<GetProjectEnvResponse>;
14306
- createProjectEnv: (variables: CreateProjectEnvVariables, signal?: AbortSignal) => Promise<CreateProjectEnvResponse>;
14307
- removeProjectEnv: (variables: RemoveProjectEnvVariables, signal?: AbortSignal) => Promise<{
14308
- system?: boolean;
14309
- target?: ('production' | 'preview' | 'development' | 'preview' | 'development' | 'preview' | 'development')[] | ('production' | 'preview' | 'development' | 'preview' | 'development' | 'preview' | 'development');
14310
- type: 'secret' | 'system' | 'encrypted' | 'plain' | 'sensitive';
14311
- id?: string;
14312
- key: string;
14313
- value: string;
14314
- configurationId?: string | null;
14315
- createdAt?: number;
14316
- updatedAt?: number;
14317
- createdBy?: string | null;
14318
- updatedBy?: string | null;
14319
- gitBranch?: string;
14320
- edgeConfigId?: string | null;
14321
- edgeConfigTokenId?: string | null;
14322
- contentHint?: {
14323
- type: 'redis-url';
14324
- storeId: string;
14325
- } | {
14326
- type: 'redis-rest-api-url';
14327
- storeId: string;
14328
- } | {
14329
- type: 'redis-rest-api-token';
14330
- storeId: string;
14331
- } | {
14332
- type: 'redis-rest-api-read-only-token';
14333
- storeId: string;
14334
- } | {
14335
- type: 'blob-read-write-token';
14336
- storeId: string;
14337
- } | {
14338
- type: 'postgres-url';
14339
- storeId: string;
14340
- } | {
14341
- type: 'postgres-url-non-pooling';
14342
- storeId: string;
14343
- } | {
14344
- type: 'postgres-prisma-url';
14345
- storeId: string;
14346
- } | {
14347
- type: 'postgres-user';
14348
- storeId: string;
14349
- } | {
14350
- type: 'postgres-host';
14351
- storeId: string;
14352
- } | {
14353
- type: 'postgres-password';
14354
- storeId: string;
14355
- } | {
14356
- type: 'postgres-database';
14357
- storeId: string;
14358
- } | null;
14359
15083
  /**
14360
- * Whether `value` is decrypted.
15084
+ * A string representing the permission for projects. Possible values are `all` or `selected`.
15085
+ *
15086
+ * @example all
15087
+ */
15088
+ projectSelection: 'selected' | 'all';
15089
+ /**
15090
+ * A timestamp that tells you when the configuration was installed successfully
15091
+ *
15092
+ * @example 1558531915505
15093
+ */
15094
+ completedAt?: number;
15095
+ /**
15096
+ * A timestamp that tells you when the configuration was created
15097
+ *
15098
+ * @example 1558531915505
15099
+ */
15100
+ createdAt: number;
15101
+ /**
15102
+ * The unique identifier of the configuration
15103
+ *
15104
+ * @example icfg_3bwCLgxL8qt5kjRLcv2Dit7F
15105
+ */
15106
+ id: string;
15107
+ /**
15108
+ * The unique identifier of the app the configuration was created for
15109
+ *
15110
+ * @example oac_xzpVzcUOgcB1nrVlirtKhbWV
14361
15111
  */
14362
- decrypted?: boolean;
14363
- } | {
14364
- target?: ('production' | 'preview' | 'development' | 'preview' | 'development' | 'preview' | 'development')[] | ('production' | 'preview' | 'development' | 'preview' | 'development' | 'preview' | 'development');
14365
- type: 'secret' | 'system' | 'encrypted' | 'plain' | 'sensitive';
14366
- id?: string;
14367
- key: string;
14368
- value: string;
14369
- configurationId?: string | null;
14370
- createdAt?: number;
14371
- updatedAt?: number;
14372
- createdBy?: string | null;
14373
- updatedBy?: string | null;
14374
- gitBranch?: string;
14375
- edgeConfigId?: string | null;
14376
- edgeConfigTokenId?: string | null;
14377
- contentHint?: {
14378
- type: 'redis-url';
14379
- storeId: string;
14380
- } | {
14381
- type: 'redis-rest-api-url';
14382
- storeId: string;
14383
- } | {
14384
- type: 'redis-rest-api-token';
14385
- storeId: string;
14386
- } | {
14387
- type: 'redis-rest-api-read-only-token';
14388
- storeId: string;
14389
- } | {
14390
- type: 'blob-read-write-token';
14391
- storeId: string;
14392
- } | {
14393
- type: 'postgres-url';
14394
- storeId: string;
14395
- } | {
14396
- type: 'postgres-url-non-pooling';
14397
- storeId: string;
14398
- } | {
14399
- type: 'postgres-prisma-url';
14400
- storeId: string;
14401
- } | {
14402
- type: 'postgres-user';
14403
- storeId: string;
14404
- } | {
14405
- type: 'postgres-host';
14406
- storeId: string;
14407
- } | {
14408
- type: 'postgres-password';
14409
- storeId: string;
14410
- } | {
14411
- type: 'postgres-database';
14412
- storeId: string;
14413
- } | null;
15112
+ integrationId: string;
14414
15113
  /**
14415
- * Whether `value` is decrypted.
15114
+ * Will be truthy in those cases where the configuration was created to authorize a client through the OAuth2 flow.
15115
+ *
15116
+ * @example false
14416
15117
  */
14417
- decrypted?: boolean;
14418
- } | {
14419
- target?: ('production' | 'preview' | 'development' | 'preview' | 'development' | 'preview' | 'development')[] | ('production' | 'preview' | 'development' | 'preview' | 'development' | 'preview' | 'development');
14420
- type: 'secret' | 'system' | 'encrypted' | 'plain' | 'sensitive';
14421
- id?: string;
14422
- key: string;
14423
- value: string;
14424
- configurationId?: string | null;
14425
- createdAt?: number;
14426
- updatedAt?: number;
14427
- createdBy?: string | null;
14428
- updatedBy?: string | null;
14429
- gitBranch?: string;
14430
- edgeConfigId?: string | null;
14431
- edgeConfigTokenId?: string | null;
14432
- contentHint?: {
14433
- type: 'redis-url';
14434
- storeId: string;
14435
- } | {
14436
- type: 'redis-rest-api-url';
14437
- storeId: string;
14438
- } | {
14439
- type: 'redis-rest-api-token';
14440
- storeId: string;
14441
- } | {
14442
- type: 'redis-rest-api-read-only-token';
14443
- storeId: string;
14444
- } | {
14445
- type: 'blob-read-write-token';
14446
- storeId: string;
14447
- } | {
14448
- type: 'postgres-url';
14449
- storeId: string;
14450
- } | {
14451
- type: 'postgres-url-non-pooling';
14452
- storeId: string;
14453
- } | {
14454
- type: 'postgres-prisma-url';
14455
- storeId: string;
14456
- } | {
14457
- type: 'postgres-user';
14458
- storeId: string;
14459
- } | {
14460
- type: 'postgres-host';
14461
- storeId: string;
14462
- } | {
14463
- type: 'postgres-password';
14464
- storeId: string;
14465
- } | {
14466
- type: 'postgres-database';
14467
- storeId: string;
14468
- } | null;
15118
+ oauthConfiguration?: boolean;
14469
15119
  /**
14470
- * Whether `value` is decrypted.
15120
+ * The user or team ID that owns the configuration
15121
+ *
15122
+ * @example kr1PsOIzqEL5Xg6M4VZcZosf
14471
15123
  */
14472
- decrypted?: boolean;
14473
- }[]>;
14474
- editProjectEnv: (variables: EditProjectEnvVariables, signal?: AbortSignal) => Promise<EditProjectEnvResponse>;
15124
+ ownerId: string;
15125
+ /**
15126
+ * When a configuration is limited to access certain projects, this will contain each of the project ID it is allowed to access. If it is not defined, the configuration has full access.
15127
+ *
15128
+ * @example prj_xQxbutw1HpL6HLYPAzt5h75m8NjO
15129
+ */
15130
+ projects?: string[];
15131
+ /**
15132
+ * Source defines where the configuration was installed from. It is used to analyze user engagement for integration installations in product metrics.
15133
+ *
15134
+ * @example marketplace
15135
+ */
15136
+ source?: 'marketplace' | 'deploy-button' | 'oauth' | 'external';
15137
+ removedLogDrainsAt?: number;
15138
+ removedProjectEnvsAt?: number;
15139
+ removedTokensAt?: number;
15140
+ removedWebhooksAt?: number;
15141
+ /**
15142
+ * The slug of the integration the configuration is created for.
15143
+ *
15144
+ * @example slack
15145
+ */
15146
+ slug: string;
15147
+ /**
15148
+ * When the configuration was created for a team, this will show the ID of the team.
15149
+ *
15150
+ * @example team_nLlpyC6RE1qxydlFKbrxDlud
15151
+ */
15152
+ teamId?: string | null;
15153
+ type: 'integration-configuration';
15154
+ /**
15155
+ * A timestamp that tells you when the configuration was updated.
15156
+ *
15157
+ * @example 1558531915505
15158
+ */
15159
+ updatedAt: number;
15160
+ /**
15161
+ * The ID of the user that created the configuration.
15162
+ *
15163
+ * @example kr1PsOIzqEL5Xg6M4VZcZosf
15164
+ */
15165
+ userId: string;
15166
+ /**
15167
+ * The resources that are allowed to be accessed by the configuration.
15168
+ *
15169
+ * @example read:project
15170
+ * @example read-write:log-drain
15171
+ */
15172
+ scopes: string[];
15173
+ scopesQueue?: {
15174
+ scopes: {
15175
+ added: ('read:integration-configuration' | 'read-write:integration-configuration' | 'read:deployment' | 'read-write:deployment' | 'read-write:deployment-check' | 'read:project' | 'read-write:project' | 'read-write:project-env-vars' | 'read-write:global-project-env-vars' | 'read:team' | 'read:user' | 'read-write:log-drain' | 'read:domain' | 'read-write:domain' | 'read-write:edge-config' | 'read-write:otel-endpoint' | 'read:monitoring')[];
15176
+ upgraded: ('read:integration-configuration' | 'read-write:integration-configuration' | 'read:deployment' | 'read-write:deployment' | 'read-write:deployment-check' | 'read:project' | 'read-write:project' | 'read-write:project-env-vars' | 'read-write:global-project-env-vars' | 'read:team' | 'read:user' | 'read-write:log-drain' | 'read:domain' | 'read-write:domain' | 'read-write:edge-config' | 'read-write:otel-endpoint' | 'read:monitoring')[];
15177
+ };
15178
+ note: string;
15179
+ requestedAt: number;
15180
+ confirmedAt?: number;
15181
+ }[];
15182
+ /**
15183
+ * A timestamp that tells you when the configuration was disabled. Note: Configurations can be disabled when the associated user loses access to a team. They do not function during this time until the configuration is 'transferred', meaning the associated user is changed to one with access to the team.
15184
+ *
15185
+ * @example 1558531915505
15186
+ */
15187
+ disabledAt?: number;
15188
+ /**
15189
+ * A timestamp that tells you when the configuration was updated.
15190
+ *
15191
+ * @example 1558531915505
15192
+ */
15193
+ deletedAt?: number | null;
15194
+ canConfigureOpenTelemetry?: boolean;
15195
+ }>;
15196
+ deleteConfiguration: (variables: DeleteConfigurationVariables, signal?: AbortSignal) => Promise<undefined>;
15197
+ gitNamespaces: (variables: GitNamespacesVariables, signal?: AbortSignal) => Promise<GitNamespacesResponse>;
15198
+ searchRepo: (variables: SearchRepoVariables, signal?: AbortSignal) => Promise<SearchRepoResponse>;
15199
+ };
15200
+ logDrains: {
15201
+ getIntegrationLogDrains: (variables: GetIntegrationLogDrainsVariables, signal?: AbortSignal) => Promise<GetIntegrationLogDrainsResponse>;
15202
+ createLogDrain: (variables: CreateLogDrainVariables, signal?: AbortSignal) => Promise<CreateLogDrainResponse>;
15203
+ deleteIntegrationLogDrain: (variables: DeleteIntegrationLogDrainVariables, signal?: AbortSignal) => Promise<undefined>;
15204
+ getConfigurableLogDrain: (variables: GetConfigurableLogDrainVariables, signal?: AbortSignal) => Promise<GetConfigurableLogDrainResponse>;
15205
+ deleteConfigurableLogDrain: (variables: DeleteConfigurableLogDrainVariables, signal?: AbortSignal) => Promise<undefined>;
15206
+ getConfigurableLogDrains: (variables: GetConfigurableLogDrainsVariables, signal?: AbortSignal) => Promise<GetConfigurableLogDrainsResponse>;
15207
+ createConfigurableLogDrain: (variables: CreateConfigurableLogDrainVariables, signal?: AbortSignal) => Promise<CreateConfigurableLogDrainResponse>;
14475
15208
  };
14476
15209
  teams: {
14477
15210
  getTeamMembers: (variables: GetTeamMembersVariables, signal?: AbortSignal) => Promise<GetTeamMembersResponse>;
@@ -14522,8 +15255,8 @@ declare const operationsByTag: {
14522
15255
  createAuthToken: (variables: CreateAuthTokenVariables, signal?: AbortSignal) => Promise<CreateAuthTokenResponse>;
14523
15256
  getAuthToken: (variables: GetAuthTokenVariables, signal?: AbortSignal) => Promise<GetAuthTokenResponse>;
14524
15257
  deleteAuthToken: (variables: DeleteAuthTokenVariables, signal?: AbortSignal) => Promise<DeleteAuthTokenResponse>;
14525
- emailLogin: (variables: EmailLoginVariables, signal?: AbortSignal) => Promise<EmailLoginResponse>;
14526
15258
  verifyToken: (variables: VerifyTokenVariables, signal?: AbortSignal) => Promise<VerifyTokenResponse>;
15259
+ emailLogin: (variables: EmailLoginVariables, signal?: AbortSignal) => Promise<EmailLoginResponse>;
14527
15260
  };
14528
15261
  webhooks: {
14529
15262
  createWebhook: (variables: CreateWebhookVariables, signal?: AbortSignal) => Promise<CreateWebhookResponse>;
@@ -14624,8 +15357,8 @@ declare const operationsByTag: {
14624
15357
  deleteWebhook: (variables: DeleteWebhookVariables, signal?: AbortSignal) => Promise<undefined>;
14625
15358
  };
14626
15359
  aliases: {
14627
- getAlias: (variables: GetAliasVariables, signal?: AbortSignal) => Promise<GetAliasResponse>;
14628
15360
  listAliases: (variables: ListAliasesVariables, signal?: AbortSignal) => Promise<ListAliasesResponse>;
15361
+ getAlias: (variables: GetAliasVariables, signal?: AbortSignal) => Promise<GetAliasResponse>;
14629
15362
  deleteAlias: (variables: DeleteAliasVariables, signal?: AbortSignal) => Promise<DeleteAliasResponse>;
14630
15363
  listDeploymentAliases: (variables: ListDeploymentAliasesVariables, signal?: AbortSignal) => Promise<ListDeploymentAliasesResponse>;
14631
15364
  assignAlias: (variables: AssignAliasVariables, signal?: AbortSignal) => Promise<AssignAliasResponse>;
@@ -14637,9 +15370,9 @@ declare const operationsByTag: {
14637
15370
  uploadCert: (variables: UploadCertVariables, signal?: AbortSignal) => Promise<UploadCertResponse>;
14638
15371
  };
14639
15372
  secrets: {
15373
+ getSecrets: (variables: GetSecretsVariables, signal?: AbortSignal) => Promise<GetSecretsResponse>;
14640
15374
  createSecret: (variables: CreateSecretVariables, signal?: AbortSignal) => Promise<CreateSecretResponse>;
14641
15375
  renameSecret: (variables: RenameSecretVariables, signal?: AbortSignal) => Promise<RenameSecretResponse>;
14642
- getSecrets: (variables: GetSecretsVariables, signal?: AbortSignal) => Promise<GetSecretsResponse>;
14643
15376
  getSecret: (variables: GetSecretVariables, signal?: AbortSignal) => Promise<GetSecretResponse>;
14644
15377
  deleteSecret: (variables: DeleteSecretVariables, signal?: AbortSignal) => Promise<DeleteSecretResponse>;
14645
15378
  };
@@ -15103,6 +15836,12 @@ type components_UpdateEdgeConfigQueryParams = UpdateEdgeConfigQueryParams;
15103
15836
  type components_UpdateEdgeConfigRequestBody = UpdateEdgeConfigRequestBody;
15104
15837
  type components_UpdateEdgeConfigResponse = UpdateEdgeConfigResponse;
15105
15838
  type components_UpdateEdgeConfigVariables = UpdateEdgeConfigVariables;
15839
+ type components_UpdateProjectDataCacheError = UpdateProjectDataCacheError;
15840
+ type components_UpdateProjectDataCachePathParams = UpdateProjectDataCachePathParams;
15841
+ type components_UpdateProjectDataCacheQueryParams = UpdateProjectDataCacheQueryParams;
15842
+ type components_UpdateProjectDataCacheRequestBody = UpdateProjectDataCacheRequestBody;
15843
+ type components_UpdateProjectDataCacheResponse = UpdateProjectDataCacheResponse;
15844
+ type components_UpdateProjectDataCacheVariables = UpdateProjectDataCacheVariables;
15106
15845
  type components_UpdateProjectDomainError = UpdateProjectDomainError;
15107
15846
  type components_UpdateProjectDomainPathParams = UpdateProjectDomainPathParams;
15108
15847
  type components_UpdateProjectDomainQueryParams = UpdateProjectDomainQueryParams;
@@ -15254,6 +15993,7 @@ declare const components_status: typeof status;
15254
15993
  declare const components_updateCheck: typeof updateCheck;
15255
15994
  declare const components_updateEdgeConfig: typeof updateEdgeConfig;
15256
15995
  declare const components_updateProject: typeof updateProject;
15996
+ declare const components_updateProjectDataCache: typeof updateProjectDataCache;
15257
15997
  declare const components_updateProjectDomain: typeof updateProjectDomain;
15258
15998
  declare const components_updateRecord: typeof updateRecord;
15259
15999
  declare const components_updateTeamMember: typeof updateTeamMember;
@@ -15722,6 +16462,12 @@ declare namespace components {
15722
16462
  components_UpdateEdgeConfigRequestBody as UpdateEdgeConfigRequestBody,
15723
16463
  components_UpdateEdgeConfigResponse as UpdateEdgeConfigResponse,
15724
16464
  components_UpdateEdgeConfigVariables as UpdateEdgeConfigVariables,
16465
+ components_UpdateProjectDataCacheError as UpdateProjectDataCacheError,
16466
+ components_UpdateProjectDataCachePathParams as UpdateProjectDataCachePathParams,
16467
+ components_UpdateProjectDataCacheQueryParams as UpdateProjectDataCacheQueryParams,
16468
+ components_UpdateProjectDataCacheRequestBody as UpdateProjectDataCacheRequestBody,
16469
+ components_UpdateProjectDataCacheResponse as UpdateProjectDataCacheResponse,
16470
+ components_UpdateProjectDataCacheVariables as UpdateProjectDataCacheVariables,
15725
16471
  components_UpdateProjectDomainError as UpdateProjectDomainError,
15726
16472
  components_UpdateProjectDomainPathParams as UpdateProjectDomainPathParams,
15727
16473
  components_UpdateProjectDomainQueryParams as UpdateProjectDomainQueryParams,
@@ -15873,6 +16619,7 @@ declare namespace components {
15873
16619
  components_updateCheck as updateCheck,
15874
16620
  components_updateEdgeConfig as updateEdgeConfig,
15875
16621
  components_updateProject as updateProject,
16622
+ components_updateProjectDataCache as updateProjectDataCache,
15876
16623
  components_updateProjectDomain as updateProjectDomain,
15877
16624
  components_updateRecord as updateRecord,
15878
16625
  components_updateTeamMember as updateTeamMember,
@@ -15890,11 +16637,12 @@ declare const operationsByPath: {
15890
16637
  'PUT /v8/artifacts/{hash}': (variables: UploadArtifactVariables, signal?: AbortSignal | undefined) => Promise<UploadArtifactResponse>;
15891
16638
  'GET /v8/artifacts/{hash}': (variables: DownloadArtifactVariables, signal?: AbortSignal | undefined) => Promise<Blob>;
15892
16639
  'POST /v8/artifacts': (variables: ArtifactQueryVariables, signal?: AbortSignal | undefined) => Promise<ArtifactQueryResponse>;
15893
- 'GET /v1/deployments/{deploymentId}/checks': (variables: GetAllChecksVariables, signal?: AbortSignal | undefined) => Promise<GetAllChecksResponse>;
15894
16640
  'POST /v1/deployments/{deploymentId}/checks': (variables: CreateCheckVariables, signal?: AbortSignal | undefined) => Promise<CreateCheckResponse>;
16641
+ 'GET /v1/deployments/{deploymentId}/checks': (variables: GetAllChecksVariables, signal?: AbortSignal | undefined) => Promise<GetAllChecksResponse>;
15895
16642
  'GET /v1/deployments/{deploymentId}/checks/{checkId}': (variables: GetCheckVariables, signal?: AbortSignal | undefined) => Promise<GetCheckResponse>;
15896
16643
  'PATCH /v1/deployments/{deploymentId}/checks/{checkId}': (variables: UpdateCheckVariables, signal?: AbortSignal | undefined) => Promise<UpdateCheckResponse>;
15897
16644
  'POST /v1/deployments/{deploymentId}/checks/{checkId}/rerequest': (variables: RerequestCheckVariables, signal?: AbortSignal | undefined) => Promise<Record<string, any>>;
16645
+ 'PATCH /v1/data-cache/projects/{projectId}': (variables: UpdateProjectDataCacheVariables, signal?: AbortSignal | undefined) => Promise<UpdateProjectDataCacheResponse>;
15898
16646
  'GET /v2/deployments/{idOrUrl}/events': (variables: GetDeploymentEventsVariables, signal?: AbortSignal | undefined) => Promise<GetDeploymentEventsResponse>;
15899
16647
  'GET /v13/deployments/{idOrUrl}': (variables: GetDeploymentVariables, signal?: AbortSignal | undefined) => Promise<{
15900
16648
  aliasAssignedAt?: number | boolean | null;
@@ -16018,6 +16766,7 @@ declare const operationsByPath: {
16018
16766
  link?: string;
16019
16767
  action?: string;
16020
16768
  } | null;
16769
+ autoAssignCustomDomains?: boolean;
16021
16770
  automaticAliases?: string[];
16022
16771
  bootedAt: number;
16023
16772
  buildErrorAt?: number;
@@ -16106,10 +16855,10 @@ declare const operationsByPath: {
16106
16855
  }[];
16107
16856
  }[];
16108
16857
  public: boolean;
16109
- readyState: "BUILDING" | "ERROR" | "INITIALIZING" | "READY" | "QUEUED" | "CANCELED";
16858
+ readyState: "BUILDING" | "ERROR" | "INITIALIZING" | "QUEUED" | "READY" | "CANCELED";
16110
16859
  regions: string[];
16111
16860
  source?: "import" | "cli" | "git" | "import/repo" | "clone/repo";
16112
- target?: "staging" | "production" | null;
16861
+ target?: "production" | "staging" | null;
16113
16862
  team?: {
16114
16863
  id: string;
16115
16864
  name: string;
@@ -16134,6 +16883,7 @@ declare const operationsByPath: {
16134
16883
  link?: string;
16135
16884
  action?: string;
16136
16885
  } | null;
16886
+ autoAssignCustomDomains?: boolean;
16137
16887
  automaticAliases?: string[];
16138
16888
  bootedAt: number;
16139
16889
  buildErrorAt?: number;
@@ -16226,10 +16976,10 @@ declare const operationsByPath: {
16226
16976
  [key: string]: string;
16227
16977
  };
16228
16978
  public: boolean;
16229
- readyState: "BUILDING" | "ERROR" | "INITIALIZING" | "READY" | "QUEUED" | "CANCELED";
16979
+ readyState: "BUILDING" | "ERROR" | "INITIALIZING" | "QUEUED" | "READY" | "CANCELED";
16230
16980
  regions: string[];
16231
16981
  source?: "import" | "cli" | "git" | "import/repo" | "clone/repo";
16232
- target?: "staging" | "production" | null;
16982
+ target?: "production" | "staging" | null;
16233
16983
  team?: {
16234
16984
  id: string;
16235
16985
  name: string;
@@ -16245,12 +16995,6 @@ declare const operationsByPath: {
16245
16995
  'PATCH /v12/deployments/{id}/cancel': (variables: CancelDeploymentVariables, signal?: AbortSignal | undefined) => Promise<CancelDeploymentResponse>;
16246
16996
  'POST /v4/domains/buy': (variables: BuyDomainVariables, signal?: AbortSignal | undefined) => Promise<BuyDomainResponse>;
16247
16997
  'GET /v4/domains/price': (variables: CheckDomainPriceVariables, signal?: AbortSignal | undefined) => Promise<CheckDomainPriceResponse>;
16248
- 'POST /v2/domains/{domain}/records': (variables: CreateRecordVariables, signal?: AbortSignal | undefined) => Promise<{
16249
- uid: string;
16250
- updated: number;
16251
- } | {
16252
- uid: string;
16253
- }>;
16254
16998
  'GET /v4/domains/{domain}/records': (variables: GetRecordsVariables, signal?: AbortSignal | undefined) => Promise<string | {
16255
16999
  records: {
16256
17000
  id: string;
@@ -16283,6 +17027,12 @@ declare const operationsByPath: {
16283
17027
  }[];
16284
17028
  pagination: Pagination;
16285
17029
  }>;
17030
+ 'POST /v2/domains/{domain}/records': (variables: CreateRecordVariables, signal?: AbortSignal | undefined) => Promise<{
17031
+ uid: string;
17032
+ updated: number;
17033
+ } | {
17034
+ uid: string;
17035
+ }>;
16286
17036
  'PATCH /v1/domains/records/{recordId}': (variables: UpdateRecordVariables, signal?: AbortSignal | undefined) => Promise<UpdateRecordResponse>;
16287
17037
  'DELETE /v2/domains/{domain}/records/{recordId}': (variables: RemoveRecordVariables, signal?: AbortSignal | undefined) => Promise<Record<string, any>>;
16288
17038
  'GET /v4/domains/status': (variables: CheckDomainStatusVariables, signal?: AbortSignal | undefined) => Promise<CheckDomainStatusResponse>;
@@ -16808,8 +17558,8 @@ declare const operationsByPath: {
16808
17558
  'POST /v2/files': (variables: UploadFileVariables, signal?: AbortSignal | undefined) => Promise<Record<string, any> | {
16809
17559
  urls: string[];
16810
17560
  }>;
16811
- 'DELETE /v1/user': (variables: RequestDeleteVariables, signal?: AbortSignal | undefined) => Promise<RequestDeleteResponse>;
16812
17561
  'GET /v2/user': (variables: FetcherExtraProps, signal?: AbortSignal | undefined) => Promise<GetAuthUserResponse>;
17562
+ 'DELETE /v1/user': (variables: RequestDeleteVariables, signal?: AbortSignal | undefined) => Promise<RequestDeleteResponse>;
16813
17563
  'GET /v5/user/tokens': (variables: FetcherExtraProps, signal?: AbortSignal | undefined) => Promise<ListAuthTokensResponse>;
16814
17564
  'POST /v3/user/tokens': (variables: CreateAuthTokenVariables, signal?: AbortSignal | undefined) => Promise<CreateAuthTokenResponse>;
16815
17565
  'GET /v5/user/tokens/{tokenId}': (variables: GetAuthTokenVariables, signal?: AbortSignal | undefined) => Promise<GetAuthTokenResponse>;
@@ -16840,8 +17590,8 @@ declare const operationsByPath: {
16840
17590
  }[]>;
16841
17591
  'GET /v1/webhooks/{id}': (variables: GetWebhookVariables, signal?: AbortSignal | undefined) => Promise<GetWebhookResponse>;
16842
17592
  'DELETE /v1/webhooks/{id}': (variables: DeleteWebhookVariables, signal?: AbortSignal | undefined) => Promise<undefined>;
16843
- 'GET /v4/aliases/{idOrAlias}': (variables: GetAliasVariables, signal?: AbortSignal | undefined) => Promise<GetAliasResponse>;
16844
17593
  'GET /v4/aliases': (variables: ListAliasesVariables, signal?: AbortSignal | undefined) => Promise<ListAliasesResponse>;
17594
+ 'GET /v4/aliases/{idOrAlias}': (variables: GetAliasVariables, signal?: AbortSignal | undefined) => Promise<GetAliasResponse>;
16845
17595
  'DELETE /v2/aliases/{aliasId}': (variables: DeleteAliasVariables, signal?: AbortSignal | undefined) => Promise<DeleteAliasResponse>;
16846
17596
  'GET /v2/deployments/{id}/aliases': (variables: ListDeploymentAliasesVariables, signal?: AbortSignal | undefined) => Promise<ListDeploymentAliasesResponse>;
16847
17597
  'POST /v2/deployments/{id}/aliases': (variables: AssignAliasVariables, signal?: AbortSignal | undefined) => Promise<AssignAliasResponse>;
@@ -16852,12 +17602,12 @@ declare const operationsByPath: {
16852
17602
  'GET /v6/deployments/{id}/files': (variables: ListDeploymentFilesVariables, signal?: AbortSignal | undefined) => Promise<ListDeploymentFilesResponse>;
16853
17603
  'GET /v6/deployments/{id}/files/{fileId}': (variables: GetDeploymentFileContentsVariables, signal?: AbortSignal | undefined) => Promise<undefined>;
16854
17604
  'GET /v6/deployments': (variables: GetDeploymentsVariables, signal?: AbortSignal | undefined) => Promise<GetDeploymentsResponse>;
16855
- 'POST /registration': (variables: EmailLoginVariables, signal?: AbortSignal | undefined) => Promise<EmailLoginResponse>;
16856
17605
  'GET /registration/verify': (variables: VerifyTokenVariables, signal?: AbortSignal | undefined) => Promise<VerifyTokenResponse>;
17606
+ 'POST /registration': (variables: EmailLoginVariables, signal?: AbortSignal | undefined) => Promise<EmailLoginResponse>;
16857
17607
  'DELETE /v13/deployments/{id}': (variables: DeleteDeploymentVariables, signal?: AbortSignal | undefined) => Promise<DeleteDeploymentResponse>;
17608
+ 'GET /v3/secrets': (variables: GetSecretsVariables, signal?: AbortSignal | undefined) => Promise<GetSecretsResponse>;
16858
17609
  'POST /v2/secrets/{name}': (variables: CreateSecretVariables, signal?: AbortSignal | undefined) => Promise<CreateSecretResponse>;
16859
17610
  'PATCH /v2/secrets/{name}': (variables: RenameSecretVariables, signal?: AbortSignal | undefined) => Promise<RenameSecretResponse>;
16860
- 'GET /v3/secrets': (variables: GetSecretsVariables, signal?: AbortSignal | undefined) => Promise<GetSecretsResponse>;
16861
17611
  'GET /v3/secrets/{idOrName}': (variables: GetSecretVariables, signal?: AbortSignal | undefined) => Promise<GetSecretResponse>;
16862
17612
  'DELETE /v2/secrets/{idOrName}': (variables: DeleteSecretVariables, signal?: AbortSignal | undefined) => Promise<DeleteSecretResponse>;
16863
17613
  };
@@ -16889,11 +17639,12 @@ declare class VercelApi {
16889
17639
  'PUT /v8/artifacts/{hash}': (variables: UploadArtifactVariables, signal?: AbortSignal | undefined) => Promise<UploadArtifactResponse>;
16890
17640
  'GET /v8/artifacts/{hash}': (variables: DownloadArtifactVariables, signal?: AbortSignal | undefined) => Promise<Blob>;
16891
17641
  'POST /v8/artifacts': (variables: ArtifactQueryVariables, signal?: AbortSignal | undefined) => Promise<ArtifactQueryResponse>;
16892
- 'GET /v1/deployments/{deploymentId}/checks': (variables: GetAllChecksVariables, signal?: AbortSignal | undefined) => Promise<GetAllChecksResponse>;
16893
17642
  'POST /v1/deployments/{deploymentId}/checks': (variables: CreateCheckVariables, signal?: AbortSignal | undefined) => Promise<CreateCheckResponse>;
17643
+ 'GET /v1/deployments/{deploymentId}/checks': (variables: GetAllChecksVariables, signal?: AbortSignal | undefined) => Promise<GetAllChecksResponse>;
16894
17644
  'GET /v1/deployments/{deploymentId}/checks/{checkId}': (variables: GetCheckVariables, signal?: AbortSignal | undefined) => Promise<GetCheckResponse>;
16895
17645
  'PATCH /v1/deployments/{deploymentId}/checks/{checkId}': (variables: UpdateCheckVariables, signal?: AbortSignal | undefined) => Promise<UpdateCheckResponse>;
16896
17646
  'POST /v1/deployments/{deploymentId}/checks/{checkId}/rerequest': (variables: RerequestCheckVariables, signal?: AbortSignal | undefined) => Promise<Record<string, any>>;
17647
+ 'PATCH /v1/data-cache/projects/{projectId}': (variables: UpdateProjectDataCacheVariables, signal?: AbortSignal | undefined) => Promise<UpdateProjectDataCacheResponse>;
16897
17648
  'GET /v2/deployments/{idOrUrl}/events': (variables: GetDeploymentEventsVariables, signal?: AbortSignal | undefined) => Promise<GetDeploymentEventsResponse>;
16898
17649
  'GET /v13/deployments/{idOrUrl}': (variables: GetDeploymentVariables, signal?: AbortSignal | undefined) => Promise<{
16899
17650
  aliasAssignedAt?: number | boolean | null;
@@ -17017,6 +17768,7 @@ declare class VercelApi {
17017
17768
  link?: string;
17018
17769
  action?: string;
17019
17770
  } | null;
17771
+ autoAssignCustomDomains?: boolean;
17020
17772
  automaticAliases?: string[];
17021
17773
  bootedAt: number;
17022
17774
  buildErrorAt?: number;
@@ -17105,10 +17857,10 @@ declare class VercelApi {
17105
17857
  }[];
17106
17858
  }[];
17107
17859
  public: boolean;
17108
- readyState: "BUILDING" | "ERROR" | "INITIALIZING" | "READY" | "QUEUED" | "CANCELED";
17860
+ readyState: "BUILDING" | "ERROR" | "INITIALIZING" | "QUEUED" | "READY" | "CANCELED";
17109
17861
  regions: string[];
17110
17862
  source?: "import" | "cli" | "git" | "import/repo" | "clone/repo";
17111
- target?: "staging" | "production" | null;
17863
+ target?: "production" | "staging" | null;
17112
17864
  team?: {
17113
17865
  id: string;
17114
17866
  name: string;
@@ -17133,6 +17885,7 @@ declare class VercelApi {
17133
17885
  link?: string;
17134
17886
  action?: string;
17135
17887
  } | null;
17888
+ autoAssignCustomDomains?: boolean;
17136
17889
  automaticAliases?: string[];
17137
17890
  bootedAt: number;
17138
17891
  buildErrorAt?: number;
@@ -17225,10 +17978,10 @@ declare class VercelApi {
17225
17978
  [key: string]: string;
17226
17979
  };
17227
17980
  public: boolean;
17228
- readyState: "BUILDING" | "ERROR" | "INITIALIZING" | "READY" | "QUEUED" | "CANCELED";
17981
+ readyState: "BUILDING" | "ERROR" | "INITIALIZING" | "QUEUED" | "READY" | "CANCELED";
17229
17982
  regions: string[];
17230
17983
  source?: "import" | "cli" | "git" | "import/repo" | "clone/repo";
17231
- target?: "staging" | "production" | null;
17984
+ target?: "production" | "staging" | null;
17232
17985
  team?: {
17233
17986
  id: string;
17234
17987
  name: string;
@@ -17244,12 +17997,6 @@ declare class VercelApi {
17244
17997
  'PATCH /v12/deployments/{id}/cancel': (variables: CancelDeploymentVariables, signal?: AbortSignal | undefined) => Promise<CancelDeploymentResponse>;
17245
17998
  'POST /v4/domains/buy': (variables: BuyDomainVariables, signal?: AbortSignal | undefined) => Promise<BuyDomainResponse>;
17246
17999
  'GET /v4/domains/price': (variables: CheckDomainPriceVariables, signal?: AbortSignal | undefined) => Promise<CheckDomainPriceResponse>;
17247
- 'POST /v2/domains/{domain}/records': (variables: CreateRecordVariables, signal?: AbortSignal | undefined) => Promise<{
17248
- uid: string;
17249
- updated: number;
17250
- } | {
17251
- uid: string;
17252
- }>;
17253
18000
  'GET /v4/domains/{domain}/records': (variables: GetRecordsVariables, signal?: AbortSignal | undefined) => Promise<string | {
17254
18001
  records: {
17255
18002
  id: string;
@@ -17282,6 +18029,12 @@ declare class VercelApi {
17282
18029
  }[];
17283
18030
  pagination: Pagination;
17284
18031
  }>;
18032
+ 'POST /v2/domains/{domain}/records': (variables: CreateRecordVariables, signal?: AbortSignal | undefined) => Promise<{
18033
+ uid: string;
18034
+ updated: number;
18035
+ } | {
18036
+ uid: string;
18037
+ }>;
17285
18038
  'PATCH /v1/domains/records/{recordId}': (variables: UpdateRecordVariables, signal?: AbortSignal | undefined) => Promise<UpdateRecordResponse>;
17286
18039
  'DELETE /v2/domains/{domain}/records/{recordId}': (variables: RemoveRecordVariables, signal?: AbortSignal | undefined) => Promise<Record<string, any>>;
17287
18040
  'GET /v4/domains/status': (variables: CheckDomainStatusVariables, signal?: AbortSignal | undefined) => Promise<CheckDomainStatusResponse>;
@@ -17807,8 +18560,8 @@ declare class VercelApi {
17807
18560
  'POST /v2/files': (variables: UploadFileVariables, signal?: AbortSignal | undefined) => Promise<Record<string, any> | {
17808
18561
  urls: string[];
17809
18562
  }>;
17810
- 'DELETE /v1/user': (variables: RequestDeleteVariables, signal?: AbortSignal | undefined) => Promise<RequestDeleteResponse>;
17811
18563
  'GET /v2/user': (variables: FetcherExtraProps, signal?: AbortSignal | undefined) => Promise<GetAuthUserResponse>;
18564
+ 'DELETE /v1/user': (variables: RequestDeleteVariables, signal?: AbortSignal | undefined) => Promise<RequestDeleteResponse>;
17812
18565
  'GET /v5/user/tokens': (variables: FetcherExtraProps, signal?: AbortSignal | undefined) => Promise<ListAuthTokensResponse>;
17813
18566
  'POST /v3/user/tokens': (variables: CreateAuthTokenVariables, signal?: AbortSignal | undefined) => Promise<CreateAuthTokenResponse>;
17814
18567
  'GET /v5/user/tokens/{tokenId}': (variables: GetAuthTokenVariables, signal?: AbortSignal | undefined) => Promise<GetAuthTokenResponse>;
@@ -17839,8 +18592,8 @@ declare class VercelApi {
17839
18592
  }[]>;
17840
18593
  'GET /v1/webhooks/{id}': (variables: GetWebhookVariables, signal?: AbortSignal | undefined) => Promise<GetWebhookResponse>;
17841
18594
  'DELETE /v1/webhooks/{id}': (variables: DeleteWebhookVariables, signal?: AbortSignal | undefined) => Promise<undefined>;
17842
- 'GET /v4/aliases/{idOrAlias}': (variables: GetAliasVariables, signal?: AbortSignal | undefined) => Promise<GetAliasResponse>;
17843
18595
  'GET /v4/aliases': (variables: ListAliasesVariables, signal?: AbortSignal | undefined) => Promise<ListAliasesResponse>;
18596
+ 'GET /v4/aliases/{idOrAlias}': (variables: GetAliasVariables, signal?: AbortSignal | undefined) => Promise<GetAliasResponse>;
17844
18597
  'DELETE /v2/aliases/{aliasId}': (variables: DeleteAliasVariables, signal?: AbortSignal | undefined) => Promise<DeleteAliasResponse>;
17845
18598
  'GET /v2/deployments/{id}/aliases': (variables: ListDeploymentAliasesVariables, signal?: AbortSignal | undefined) => Promise<ListDeploymentAliasesResponse>;
17846
18599
  'POST /v2/deployments/{id}/aliases': (variables: AssignAliasVariables, signal?: AbortSignal | undefined) => Promise<AssignAliasResponse>;
@@ -17851,12 +18604,12 @@ declare class VercelApi {
17851
18604
  'GET /v6/deployments/{id}/files': (variables: ListDeploymentFilesVariables, signal?: AbortSignal | undefined) => Promise<ListDeploymentFilesResponse>;
17852
18605
  'GET /v6/deployments/{id}/files/{fileId}': (variables: GetDeploymentFileContentsVariables, signal?: AbortSignal | undefined) => Promise<undefined>;
17853
18606
  'GET /v6/deployments': (variables: GetDeploymentsVariables, signal?: AbortSignal | undefined) => Promise<GetDeploymentsResponse>;
17854
- 'POST /registration': (variables: EmailLoginVariables, signal?: AbortSignal | undefined) => Promise<EmailLoginResponse>;
17855
18607
  'GET /registration/verify': (variables: VerifyTokenVariables, signal?: AbortSignal | undefined) => Promise<VerifyTokenResponse>;
18608
+ 'POST /registration': (variables: EmailLoginVariables, signal?: AbortSignal | undefined) => Promise<EmailLoginResponse>;
17856
18609
  'DELETE /v13/deployments/{id}': (variables: DeleteDeploymentVariables, signal?: AbortSignal | undefined) => Promise<DeleteDeploymentResponse>;
18610
+ 'GET /v3/secrets': (variables: GetSecretsVariables, signal?: AbortSignal | undefined) => Promise<GetSecretsResponse>;
17857
18611
  'POST /v2/secrets/{name}': (variables: CreateSecretVariables, signal?: AbortSignal | undefined) => Promise<CreateSecretResponse>;
17858
18612
  'PATCH /v2/secrets/{name}': (variables: RenameSecretVariables, signal?: AbortSignal | undefined) => Promise<RenameSecretResponse>;
17859
- 'GET /v3/secrets': (variables: GetSecretsVariables, signal?: AbortSignal | undefined) => Promise<GetSecretsResponse>;
17860
18613
  'GET /v3/secrets/{idOrName}': (variables: GetSecretVariables, signal?: AbortSignal | undefined) => Promise<GetSecretResponse>;
17861
18614
  'DELETE /v2/secrets/{idOrName}': (variables: DeleteSecretVariables, signal?: AbortSignal | undefined) => Promise<DeleteSecretResponse>;
17862
18615
  }[Endpoint]>>;