@vercel/sdk 1.15.0 → 1.16.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/README.md +42 -25
- package/bin/mcp-server.js +3040 -1304
- package/bin/mcp-server.js.map +60 -42
- package/docs/sdks/connect/README.md +10 -10
- package/docs/sdks/environment/README.md +512 -0
- package/docs/sdks/staticips/README.md +95 -0
- package/esm/__tests__/accessgroups.test.js +1 -3
- package/esm/__tests__/accessgroups.test.js.map +1 -1
- package/esm/__tests__/checks.test.js +1 -1
- package/esm/__tests__/checks.test.js.map +1 -1
- package/esm/__tests__/connect.test.js +10 -7
- package/esm/__tests__/connect.test.js.map +1 -1
- package/esm/__tests__/domains.test.js +10 -3
- package/esm/__tests__/domains.test.js.map +1 -1
- package/esm/__tests__/edgeconfig.test.js +6 -6
- package/esm/__tests__/edgeconfig.test.js.map +1 -1
- package/esm/__tests__/environment.test.js +164 -0
- package/esm/__tests__/environment.test.js.map +1 -1
- package/esm/__tests__/integrations.test.js +1 -1
- package/esm/__tests__/logdrains.test.js +1 -3
- package/esm/__tests__/logdrains.test.js.map +1 -1
- package/esm/__tests__/rollingrelease.test.js +2 -1
- package/esm/__tests__/rollingrelease.test.js.map +1 -1
- package/esm/__tests__/security.test.js +11 -1
- package/esm/__tests__/security.test.js.map +1 -1
- package/esm/funcs/connectUpdateStaticIps.d.ts +17 -0
- package/esm/funcs/connectUpdateStaticIps.d.ts.map +1 -0
- package/esm/funcs/{connectUpdateSharedConnectLinks.js → connectUpdateStaticIps.js} +8 -8
- package/esm/funcs/connectUpdateStaticIps.js.map +1 -0
- package/esm/funcs/environmentCreateSharedEnvVariable.d.ts +17 -0
- package/esm/funcs/environmentCreateSharedEnvVariable.d.ts.map +1 -0
- package/esm/funcs/environmentCreateSharedEnvVariable.js +83 -0
- package/esm/funcs/environmentCreateSharedEnvVariable.js.map +1 -0
- package/esm/funcs/environmentDeleteSharedEnvVariable.d.ts +17 -0
- package/esm/funcs/environmentDeleteSharedEnvVariable.d.ts.map +1 -0
- package/esm/funcs/environmentDeleteSharedEnvVariable.js +83 -0
- package/esm/funcs/environmentDeleteSharedEnvVariable.js.map +1 -0
- package/esm/funcs/environmentGetSharedEnvVar.d.ts +17 -0
- package/esm/funcs/environmentGetSharedEnvVar.d.ts.map +1 -0
- package/esm/funcs/environmentGetSharedEnvVar.js +88 -0
- package/esm/funcs/environmentGetSharedEnvVar.js.map +1 -0
- package/esm/funcs/environmentListSharedEnvVariable.d.ts +17 -0
- package/esm/funcs/environmentListSharedEnvVariable.d.ts.map +1 -0
- package/esm/funcs/environmentListSharedEnvVariable.js +89 -0
- package/esm/funcs/environmentListSharedEnvVariable.js.map +1 -0
- package/esm/funcs/environmentUnlinkSharedEnvVariable.d.ts +17 -0
- package/esm/funcs/environmentUnlinkSharedEnvVariable.d.ts.map +1 -0
- package/esm/funcs/environmentUnlinkSharedEnvVariable.js +92 -0
- package/esm/funcs/environmentUnlinkSharedEnvVariable.js.map +1 -0
- package/esm/funcs/environmentUpdateSharedEnvVariable.d.ts +17 -0
- package/esm/funcs/environmentUpdateSharedEnvVariable.d.ts.map +1 -0
- package/esm/funcs/environmentUpdateSharedEnvVariable.js +83 -0
- package/esm/funcs/environmentUpdateSharedEnvVariable.js.map +1 -0
- package/esm/funcs/integrationsCreateIntegrationStoreDirect.js +13 -2
- package/esm/funcs/integrationsCreateIntegrationStoreDirect.js.map +1 -1
- package/esm/lib/config.d.ts +3 -3
- package/esm/lib/config.js +3 -3
- package/esm/mcp-server/mcp-server.js +1 -1
- package/esm/mcp-server/server.d.ts.map +1 -1
- package/esm/mcp-server/server.js +20 -8
- package/esm/mcp-server/server.js.map +1 -1
- package/esm/mcp-server/tools/connectUpdateStaticIps.d.ts +7 -0
- package/esm/mcp-server/tools/connectUpdateStaticIps.d.ts.map +1 -0
- package/esm/mcp-server/tools/connectUpdateStaticIps.js +28 -0
- package/esm/mcp-server/tools/connectUpdateStaticIps.js.map +1 -0
- package/esm/mcp-server/tools/environmentCreateSharedEnvVariable.d.ts +7 -0
- package/esm/mcp-server/tools/environmentCreateSharedEnvVariable.d.ts.map +1 -0
- package/esm/mcp-server/tools/environmentCreateSharedEnvVariable.js +28 -0
- package/esm/mcp-server/tools/environmentCreateSharedEnvVariable.js.map +1 -0
- package/esm/mcp-server/tools/environmentDeleteSharedEnvVariable.d.ts +7 -0
- package/esm/mcp-server/tools/environmentDeleteSharedEnvVariable.d.ts.map +1 -0
- package/esm/mcp-server/tools/environmentDeleteSharedEnvVariable.js +28 -0
- package/esm/mcp-server/tools/environmentDeleteSharedEnvVariable.js.map +1 -0
- package/esm/mcp-server/tools/environmentGetSharedEnvVar.d.ts +7 -0
- package/esm/mcp-server/tools/environmentGetSharedEnvVar.d.ts.map +1 -0
- package/esm/mcp-server/tools/environmentGetSharedEnvVar.js +28 -0
- package/esm/mcp-server/tools/environmentGetSharedEnvVar.js.map +1 -0
- package/esm/mcp-server/tools/environmentListSharedEnvVariable.d.ts +7 -0
- package/esm/mcp-server/tools/environmentListSharedEnvVariable.d.ts.map +1 -0
- package/esm/mcp-server/tools/environmentListSharedEnvVariable.js +28 -0
- package/esm/mcp-server/tools/environmentListSharedEnvVariable.js.map +1 -0
- package/esm/mcp-server/tools/environmentUnlinkSharedEnvVariable.d.ts +7 -0
- package/esm/mcp-server/tools/environmentUnlinkSharedEnvVariable.d.ts.map +1 -0
- package/esm/mcp-server/tools/environmentUnlinkSharedEnvVariable.js +28 -0
- package/esm/mcp-server/tools/environmentUnlinkSharedEnvVariable.js.map +1 -0
- package/esm/mcp-server/tools/environmentUpdateSharedEnvVariable.d.ts +7 -0
- package/esm/mcp-server/tools/environmentUpdateSharedEnvVariable.d.ts.map +1 -0
- package/esm/mcp-server/tools/environmentUpdateSharedEnvVariable.js +28 -0
- package/esm/mcp-server/tools/environmentUpdateSharedEnvVariable.js.map +1 -0
- package/esm/models/buydomainsop.d.ts +4 -4
- package/esm/models/buydomainsop.d.ts.map +1 -1
- package/esm/models/buysingledomainop.d.ts +4 -4
- package/esm/models/buysingledomainop.d.ts.map +1 -1
- package/esm/models/canceldeploymentop.d.ts +3 -0
- package/esm/models/canceldeploymentop.d.ts.map +1 -1
- package/esm/models/canceldeploymentop.js +1 -0
- package/esm/models/canceldeploymentop.js.map +1 -1
- package/esm/models/createdeploymentop.d.ts +6 -0
- package/esm/models/createdeploymentop.d.ts.map +1 -1
- package/esm/models/createdeploymentop.js +2 -0
- package/esm/models/createdeploymentop.js.map +1 -1
- package/esm/models/createdrainop.d.ts +3 -0
- package/esm/models/createdrainop.d.ts.map +1 -1
- package/esm/models/createdrainop.js +1 -0
- package/esm/models/createdrainop.js.map +1 -1
- package/esm/models/createintegrationstoredirectop.d.ts +288 -285
- package/esm/models/createintegrationstoredirectop.d.ts.map +1 -1
- package/esm/models/createintegrationstoredirectop.js +352 -351
- package/esm/models/createintegrationstoredirectop.js.map +1 -1
- package/esm/models/createprojectenvop.d.ts +37 -37
- package/esm/models/createprojectenvop.d.ts.map +1 -1
- package/esm/models/createprojectenvop.js +44 -44
- package/esm/models/createprojectenvop.js.map +1 -1
- package/esm/models/createprojectop.d.ts +6 -0
- package/esm/models/createprojectop.d.ts.map +1 -1
- package/esm/models/createprojectop.js +2 -0
- package/esm/models/createprojectop.js.map +1 -1
- package/esm/models/createsharedenvvariableop.d.ts +746 -0
- package/esm/models/createsharedenvvariableop.d.ts.map +1 -0
- package/esm/models/createsharedenvvariableop.js +609 -0
- package/esm/models/createsharedenvvariableop.js.map +1 -0
- package/esm/models/deletesharedenvvariableop.d.ts +291 -0
- package/esm/models/deletesharedenvvariableop.d.ts.map +1 -0
- package/esm/models/deletesharedenvvariableop.js +291 -0
- package/esm/models/deletesharedenvvariableop.js.map +1 -0
- package/esm/models/getalllogdrainsop.d.ts +6 -0
- package/esm/models/getalllogdrainsop.d.ts.map +1 -1
- package/esm/models/getalllogdrainsop.js +2 -0
- package/esm/models/getalllogdrainsop.js.map +1 -1
- package/esm/models/getconfigurablelogdrainop.d.ts +3 -0
- package/esm/models/getconfigurablelogdrainop.d.ts.map +1 -1
- package/esm/models/getconfigurablelogdrainop.js +1 -0
- package/esm/models/getconfigurablelogdrainop.js.map +1 -1
- package/esm/models/getconfigurationproductsop.d.ts +375 -375
- package/esm/models/getconfigurationproductsop.js +465 -465
- package/esm/models/getcontactinfoschemaop.d.ts +2 -2
- package/esm/models/getcontactinfoschemaop.d.ts.map +1 -1
- package/esm/models/getdeploymentop.d.ts +3 -0
- package/esm/models/getdeploymentop.d.ts.map +1 -1
- package/esm/models/getdeploymentop.js +1 -0
- package/esm/models/getdeploymentop.js.map +1 -1
- package/esm/models/getdeploymentsop.d.ts +3 -0
- package/esm/models/getdeploymentsop.d.ts.map +1 -1
- package/esm/models/getdeploymentsop.js +1 -0
- package/esm/models/getdeploymentsop.js.map +1 -1
- package/esm/models/getdomainauthcodeop.d.ts +4 -4
- package/esm/models/getdomainauthcodeop.d.ts.map +1 -1
- package/esm/models/getdomainpriceop.d.ts +2 -2
- package/esm/models/getdomainpriceop.d.ts.map +1 -1
- package/esm/models/getdomaintransferinop.d.ts +2 -2
- package/esm/models/getdomaintransferinop.d.ts.map +1 -1
- package/esm/models/getdrainop.d.ts +3 -0
- package/esm/models/getdrainop.d.ts.map +1 -1
- package/esm/models/getdrainop.js +1 -0
- package/esm/models/getdrainop.js.map +1 -1
- package/esm/models/getdrainsop.d.ts +3 -0
- package/esm/models/getdrainsop.d.ts.map +1 -1
- package/esm/models/getdrainsop.js +1 -0
- package/esm/models/getdrainsop.js.map +1 -1
- package/esm/models/getinvoiceop.d.ts +3 -0
- package/esm/models/getinvoiceop.d.ts.map +1 -1
- package/esm/models/getinvoiceop.js +1 -0
- package/esm/models/getinvoiceop.js.map +1 -1
- package/esm/models/getorderop.d.ts +2 -2
- package/esm/models/getorderop.d.ts.map +1 -1
- package/esm/models/getprojectsop.d.ts +3 -0
- package/esm/models/getprojectsop.d.ts.map +1 -1
- package/esm/models/getprojectsop.js +1 -0
- package/esm/models/getprojectsop.js.map +1 -1
- package/esm/models/getsharedenvvarop.d.ts +227 -0
- package/esm/models/getsharedenvvarop.d.ts.map +1 -0
- package/esm/models/getsharedenvvarop.js +142 -0
- package/esm/models/getsharedenvvarop.js.map +1 -0
- package/esm/models/gettldpriceop.d.ts +2 -2
- package/esm/models/gettldpriceop.d.ts.map +1 -1
- package/esm/models/getwebhooksop.d.ts +3 -0
- package/esm/models/getwebhooksop.d.ts.map +1 -1
- package/esm/models/getwebhooksop.js +1 -0
- package/esm/models/getwebhooksop.js.map +1 -1
- package/esm/models/listsharedenvvariableop.d.ts +285 -0
- package/esm/models/listsharedenvvariableop.d.ts.map +1 -0
- package/esm/models/listsharedenvvariableop.js +198 -0
- package/esm/models/listsharedenvvariableop.js.map +1 -0
- package/esm/models/renewdomainop.d.ts +4 -4
- package/esm/models/renewdomainop.d.ts.map +1 -1
- package/esm/models/transferindomainop.d.ts +4 -4
- package/esm/models/transferindomainop.d.ts.map +1 -1
- package/esm/models/unlinksharedenvvariableop.d.ts +69 -0
- package/esm/models/unlinksharedenvvariableop.d.ts.map +1 -0
- package/esm/models/unlinksharedenvvariableop.js +62 -0
- package/esm/models/unlinksharedenvvariableop.js.map +1 -0
- package/esm/models/updatedomainautorenewop.d.ts +4 -4
- package/esm/models/updatedomainautorenewop.d.ts.map +1 -1
- package/esm/models/updatedomainnameserversop.d.ts +4 -4
- package/esm/models/updatedomainnameserversop.d.ts.map +1 -1
- package/esm/models/updatedrainop.d.ts +3 -0
- package/esm/models/updatedrainop.d.ts.map +1 -1
- package/esm/models/updatedrainop.js +1 -0
- package/esm/models/updatedrainop.js.map +1 -1
- package/esm/models/updateinstallationop.d.ts +32 -5
- package/esm/models/updateinstallationop.d.ts.map +1 -1
- package/esm/models/updateinstallationop.js +29 -4
- package/esm/models/updateinstallationop.js.map +1 -1
- package/esm/models/updateprojectdatacacheop.d.ts +3 -0
- package/esm/models/updateprojectdatacacheop.d.ts.map +1 -1
- package/esm/models/updateprojectdatacacheop.js +1 -0
- package/esm/models/updateprojectdatacacheop.js.map +1 -1
- package/esm/models/updateprojectop.d.ts +6 -0
- package/esm/models/updateprojectop.d.ts.map +1 -1
- package/esm/models/updateprojectop.js +2 -0
- package/esm/models/updateprojectop.js.map +1 -1
- package/esm/models/updatesharedenvvariableop.d.ts +629 -0
- package/esm/models/updatesharedenvvariableop.d.ts.map +1 -0
- package/esm/models/updatesharedenvvariableop.js +507 -0
- package/esm/models/updatesharedenvvariableop.js.map +1 -0
- package/esm/models/updatestaticipsop.d.ts +238 -0
- package/esm/models/updatestaticipsop.d.ts.map +1 -0
- package/esm/models/updatestaticipsop.js +239 -0
- package/esm/models/updatestaticipsop.js.map +1 -0
- package/esm/sdk/connect.d.ts +4 -4
- package/esm/sdk/connect.d.ts.map +1 -1
- package/esm/sdk/connect.js +5 -5
- package/esm/sdk/connect.js.map +1 -1
- package/esm/sdk/environment.d.ts +48 -0
- package/esm/sdk/environment.d.ts.map +1 -1
- package/esm/sdk/environment.js +60 -0
- package/esm/sdk/environment.js.map +1 -1
- package/esm/sdk/sdk.d.ts +5 -2
- package/esm/sdk/sdk.d.ts.map +1 -1
- package/esm/sdk/sdk.js +6 -2
- package/esm/sdk/sdk.js.map +1 -1
- package/esm/sdk/staticips.d.ts +12 -0
- package/esm/sdk/staticips.d.ts.map +1 -0
- package/esm/sdk/staticips.js +18 -0
- package/esm/sdk/staticips.js.map +1 -0
- package/examples/package-lock.json +1 -1
- package/jsr.json +1 -1
- package/package.json +1 -1
- package/src/__tests__/accessgroups.test.ts +1 -3
- package/src/__tests__/checks.test.ts +1 -1
- package/src/__tests__/connect.test.ts +13 -7
- package/src/__tests__/domains.test.ts +10 -3
- package/src/__tests__/edgeconfig.test.ts +6 -6
- package/src/__tests__/environment.test.ts +184 -0
- package/src/__tests__/integrations.test.ts +1 -1
- package/src/__tests__/logdrains.test.ts +1 -3
- package/src/__tests__/rollingrelease.test.ts +2 -1
- package/src/__tests__/security.test.ts +11 -1
- package/src/funcs/{connectUpdateSharedConnectLinks.ts → connectUpdateStaticIps.ts} +16 -16
- package/src/funcs/environmentCreateSharedEnvVariable.ts +171 -0
- package/src/funcs/environmentDeleteSharedEnvVariable.ts +171 -0
- package/src/funcs/environmentGetSharedEnvVar.ts +177 -0
- package/src/funcs/environmentListSharedEnvVariable.ts +177 -0
- package/src/funcs/environmentUnlinkSharedEnvVariable.ts +181 -0
- package/src/funcs/environmentUpdateSharedEnvVariable.ts +171 -0
- package/src/funcs/integrationsCreateIntegrationStoreDirect.ts +13 -2
- package/src/lib/config.ts +3 -3
- package/src/mcp-server/mcp-server.ts +1 -1
- package/src/mcp-server/server.ts +20 -8
- package/src/mcp-server/tools/connectUpdateStaticIps.ts +37 -0
- package/src/mcp-server/tools/environmentCreateSharedEnvVariable.ts +39 -0
- package/src/mcp-server/tools/environmentDeleteSharedEnvVariable.ts +39 -0
- package/src/mcp-server/tools/environmentGetSharedEnvVar.ts +38 -0
- package/src/mcp-server/tools/environmentListSharedEnvVariable.ts +39 -0
- package/src/mcp-server/tools/environmentUnlinkSharedEnvVariable.ts +39 -0
- package/src/mcp-server/tools/environmentUpdateSharedEnvVariable.ts +39 -0
- package/src/models/buydomainsop.ts +2 -2
- package/src/models/buysingledomainop.ts +2 -2
- package/src/models/canceldeploymentop.ts +1 -0
- package/src/models/createdeploymentop.ts +2 -0
- package/src/models/createdrainop.ts +1 -0
- package/src/models/createintegrationstoredirectop.ts +605 -604
- package/src/models/createprojectenvop.ts +86 -66
- package/src/models/createprojectop.ts +2 -0
- package/src/models/createsharedenvvariableop.ts +1298 -0
- package/src/models/deletesharedenvvariableop.ts +608 -0
- package/src/models/getalllogdrainsop.ts +2 -0
- package/src/models/getconfigurablelogdrainop.ts +1 -0
- package/src/models/getconfigurationproductsop.ts +802 -802
- package/src/models/getcontactinfoschemaop.ts +1 -1
- package/src/models/getdeploymentop.ts +1 -0
- package/src/models/getdeploymentsop.ts +1 -0
- package/src/models/getdomainauthcodeop.ts +2 -2
- package/src/models/getdomainpriceop.ts +1 -1
- package/src/models/getdomaintransferinop.ts +1 -1
- package/src/models/getdrainop.ts +1 -0
- package/src/models/getdrainsop.ts +1 -0
- package/src/models/getinvoiceop.ts +1 -0
- package/src/models/getorderop.ts +1 -1
- package/src/models/getprojectsop.ts +1 -0
- package/src/models/getsharedenvvarop.ts +336 -0
- package/src/models/gettldpriceop.ts +1 -1
- package/src/models/getwebhooksop.ts +1 -0
- package/src/models/listsharedenvvariableop.ts +458 -0
- package/src/models/renewdomainop.ts +2 -2
- package/src/models/transferindomainop.ts +2 -2
- package/src/models/unlinksharedenvvariableop.ts +152 -0
- package/src/models/updatedomainautorenewop.ts +2 -2
- package/src/models/updatedomainnameserversop.ts +2 -2
- package/src/models/updatedrainop.ts +1 -0
- package/src/models/updateinstallationop.ts +67 -11
- package/src/models/updateprojectdatacacheop.ts +1 -0
- package/src/models/updateprojectop.ts +2 -0
- package/src/models/updatesharedenvvariableop.ts +1105 -0
- package/src/models/updatestaticipsop.ts +530 -0
- package/src/sdk/connect.ts +10 -10
- package/src/sdk/environment.ts +132 -0
- package/src/sdk/sdk.ts +9 -3
- package/src/sdk/staticips.ts +30 -0
- package/vercel-spec.json +1623 -121
- package/esm/funcs/connectUpdateSharedConnectLinks.d.ts +0 -17
- package/esm/funcs/connectUpdateSharedConnectLinks.d.ts.map +0 -1
- package/esm/funcs/connectUpdateSharedConnectLinks.js.map +0 -1
- package/esm/mcp-server/tools/connectUpdateSharedConnectLinks.d.ts +0 -7
- package/esm/mcp-server/tools/connectUpdateSharedConnectLinks.d.ts.map +0 -1
- package/esm/mcp-server/tools/connectUpdateSharedConnectLinks.js +0 -28
- package/esm/mcp-server/tools/connectUpdateSharedConnectLinks.js.map +0 -1
- package/esm/models/updatesharedconnectlinksop.d.ts +0 -182
- package/esm/models/updatesharedconnectlinksop.d.ts.map +0 -1
- package/esm/models/updatesharedconnectlinksop.js +0 -179
- package/esm/models/updatesharedconnectlinksop.js.map +0 -1
- package/src/mcp-server/tools/connectUpdateSharedConnectLinks.ts +0 -38
- package/src/models/updatesharedconnectlinksop.ts +0 -402
|
@@ -5,15 +5,15 @@
|
|
|
5
5
|
|
|
6
6
|
### Available Operations
|
|
7
7
|
|
|
8
|
-
* [
|
|
8
|
+
* [updateStaticIps](#updatestaticips) - Configures Static IPs for a project
|
|
9
9
|
|
|
10
|
-
##
|
|
10
|
+
## updateStaticIps
|
|
11
11
|
|
|
12
|
-
Allows
|
|
12
|
+
Allows configuring Static IPs for a project
|
|
13
13
|
|
|
14
14
|
### Example Usage
|
|
15
15
|
|
|
16
|
-
<!-- UsageSnippet language="typescript" operationID="
|
|
16
|
+
<!-- UsageSnippet language="typescript" operationID="updateStaticIps" method="patch" path="/v1/projects/{idOrName}/shared-connect-links" -->
|
|
17
17
|
```typescript
|
|
18
18
|
import { Vercel } from "@vercel/sdk";
|
|
19
19
|
|
|
@@ -22,7 +22,7 @@ const vercel = new Vercel({
|
|
|
22
22
|
});
|
|
23
23
|
|
|
24
24
|
async function run() {
|
|
25
|
-
const result = await vercel.connect.
|
|
25
|
+
const result = await vercel.connect.updateStaticIps({
|
|
26
26
|
idOrName: "<value>",
|
|
27
27
|
teamId: "team_1a2b3c4d5e6f7g8h9i0j1k2l",
|
|
28
28
|
slug: "my-team-url-slug",
|
|
@@ -45,7 +45,7 @@ The standalone function version of this method:
|
|
|
45
45
|
|
|
46
46
|
```typescript
|
|
47
47
|
import { VercelCore } from "@vercel/sdk/core.js";
|
|
48
|
-
import {
|
|
48
|
+
import { connectUpdateStaticIps } from "@vercel/sdk/funcs/connectUpdateStaticIps.js";
|
|
49
49
|
|
|
50
50
|
// Use `VercelCore` for best tree-shaking performance.
|
|
51
51
|
// You can create one instance of it to use across an application.
|
|
@@ -54,7 +54,7 @@ const vercel = new VercelCore({
|
|
|
54
54
|
});
|
|
55
55
|
|
|
56
56
|
async function run() {
|
|
57
|
-
const res = await
|
|
57
|
+
const res = await connectUpdateStaticIps(vercel, {
|
|
58
58
|
idOrName: "<value>",
|
|
59
59
|
teamId: "team_1a2b3c4d5e6f7g8h9i0j1k2l",
|
|
60
60
|
slug: "my-team-url-slug",
|
|
@@ -68,7 +68,7 @@ async function run() {
|
|
|
68
68
|
const { value: result } = res;
|
|
69
69
|
console.log(result);
|
|
70
70
|
} else {
|
|
71
|
-
console.log("
|
|
71
|
+
console.log("connectUpdateStaticIps failed:", res.error);
|
|
72
72
|
}
|
|
73
73
|
}
|
|
74
74
|
|
|
@@ -79,14 +79,14 @@ run();
|
|
|
79
79
|
|
|
80
80
|
| Parameter | Type | Required | Description |
|
|
81
81
|
| ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
|
|
82
|
-
| `request` | [models.
|
|
82
|
+
| `request` | [models.UpdateStaticIpsRequest](../../models/updatestaticipsrequest.md) | :heavy_check_mark: | The request object to use for the request. |
|
|
83
83
|
| `options` | RequestOptions | :heavy_minus_sign: | Used to set various options for making HTTP requests. |
|
|
84
84
|
| `options.fetchOptions` | [RequestInit](https://developer.mozilla.org/en-US/docs/Web/API/Request/Request#options) | :heavy_minus_sign: | Options that are passed to the underlying HTTP request. This can be used to inject extra headers for examples. All `Request` options, except `method` and `body`, are allowed. |
|
|
85
85
|
| `options.retries` | [RetryConfig](../../lib/utils/retryconfig.md) | :heavy_minus_sign: | Enables retrying HTTP requests under certain failure conditions. |
|
|
86
86
|
|
|
87
87
|
### Response
|
|
88
88
|
|
|
89
|
-
**Promise\<[models.
|
|
89
|
+
**Promise\<[models.UpdateStaticIpsResponseBody[]](../../models/.md)\>**
|
|
90
90
|
|
|
91
91
|
### Errors
|
|
92
92
|
|
|
@@ -5,12 +5,524 @@
|
|
|
5
5
|
|
|
6
6
|
### Available Operations
|
|
7
7
|
|
|
8
|
+
* [createSharedEnvVariable](#createsharedenvvariable) - Create one or more shared environment variables
|
|
9
|
+
* [listSharedEnvVariable](#listsharedenvvariable) - Lists all Shared Environment Variables for a team
|
|
10
|
+
* [updateSharedEnvVariable](#updatesharedenvvariable) - Updates one or more shared environment variables
|
|
11
|
+
* [deleteSharedEnvVariable](#deletesharedenvvariable) - Delete one or more Env Var
|
|
12
|
+
* [getSharedEnvVar](#getsharedenvvar) - Retrieve the decrypted value of a Shared Environment Variable by id.
|
|
13
|
+
* [unlinkSharedEnvVariable](#unlinksharedenvvariable) - Disconnects a shared environment variable for a given project
|
|
8
14
|
* [createCustomEnvironment](#createcustomenvironment) - Create a custom environment for the current project.
|
|
9
15
|
* [getV9ProjectsIdOrNameCustomEnvironments](#getv9projectsidornamecustomenvironments) - Retrieve custom environments
|
|
10
16
|
* [getCustomEnvironment](#getcustomenvironment) - Retrieve a custom environment
|
|
11
17
|
* [updateCustomEnvironment](#updatecustomenvironment) - Update a custom environment
|
|
12
18
|
* [removeCustomEnvironment](#removecustomenvironment) - Remove a custom environment
|
|
13
19
|
|
|
20
|
+
## createSharedEnvVariable
|
|
21
|
+
|
|
22
|
+
Creates shared environment variable(s) for a team.
|
|
23
|
+
|
|
24
|
+
### Example Usage
|
|
25
|
+
|
|
26
|
+
<!-- UsageSnippet language="typescript" operationID="createSharedEnvVariable" method="post" path="/v1/env" -->
|
|
27
|
+
```typescript
|
|
28
|
+
import { Vercel } from "@vercel/sdk";
|
|
29
|
+
|
|
30
|
+
const vercel = new Vercel({
|
|
31
|
+
bearerToken: "<YOUR_BEARER_TOKEN_HERE>",
|
|
32
|
+
});
|
|
33
|
+
|
|
34
|
+
async function run() {
|
|
35
|
+
const result = await vercel.environment.createSharedEnvVariable({
|
|
36
|
+
teamId: "team_1a2b3c4d5e6f7g8h9i0j1k2l",
|
|
37
|
+
slug: "my-team-url-slug",
|
|
38
|
+
requestBody: {
|
|
39
|
+
evs: [],
|
|
40
|
+
type: "encrypted",
|
|
41
|
+
target: [
|
|
42
|
+
"production",
|
|
43
|
+
"preview",
|
|
44
|
+
],
|
|
45
|
+
},
|
|
46
|
+
});
|
|
47
|
+
|
|
48
|
+
console.log(result);
|
|
49
|
+
}
|
|
50
|
+
|
|
51
|
+
run();
|
|
52
|
+
```
|
|
53
|
+
|
|
54
|
+
### Standalone function
|
|
55
|
+
|
|
56
|
+
The standalone function version of this method:
|
|
57
|
+
|
|
58
|
+
```typescript
|
|
59
|
+
import { VercelCore } from "@vercel/sdk/core.js";
|
|
60
|
+
import { environmentCreateSharedEnvVariable } from "@vercel/sdk/funcs/environmentCreateSharedEnvVariable.js";
|
|
61
|
+
|
|
62
|
+
// Use `VercelCore` for best tree-shaking performance.
|
|
63
|
+
// You can create one instance of it to use across an application.
|
|
64
|
+
const vercel = new VercelCore({
|
|
65
|
+
bearerToken: "<YOUR_BEARER_TOKEN_HERE>",
|
|
66
|
+
});
|
|
67
|
+
|
|
68
|
+
async function run() {
|
|
69
|
+
const res = await environmentCreateSharedEnvVariable(vercel, {
|
|
70
|
+
teamId: "team_1a2b3c4d5e6f7g8h9i0j1k2l",
|
|
71
|
+
slug: "my-team-url-slug",
|
|
72
|
+
requestBody: {
|
|
73
|
+
evs: [],
|
|
74
|
+
type: "encrypted",
|
|
75
|
+
target: [
|
|
76
|
+
"production",
|
|
77
|
+
"preview",
|
|
78
|
+
],
|
|
79
|
+
},
|
|
80
|
+
});
|
|
81
|
+
if (res.ok) {
|
|
82
|
+
const { value: result } = res;
|
|
83
|
+
console.log(result);
|
|
84
|
+
} else {
|
|
85
|
+
console.log("environmentCreateSharedEnvVariable failed:", res.error);
|
|
86
|
+
}
|
|
87
|
+
}
|
|
88
|
+
|
|
89
|
+
run();
|
|
90
|
+
```
|
|
91
|
+
|
|
92
|
+
### Parameters
|
|
93
|
+
|
|
94
|
+
| Parameter | Type | Required | Description |
|
|
95
|
+
| ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
|
|
96
|
+
| `request` | [models.CreateSharedEnvVariableRequest](../../models/createsharedenvvariablerequest.md) | :heavy_check_mark: | The request object to use for the request. |
|
|
97
|
+
| `options` | RequestOptions | :heavy_minus_sign: | Used to set various options for making HTTP requests. |
|
|
98
|
+
| `options.fetchOptions` | [RequestInit](https://developer.mozilla.org/en-US/docs/Web/API/Request/Request#options) | :heavy_minus_sign: | Options that are passed to the underlying HTTP request. This can be used to inject extra headers for examples. All `Request` options, except `method` and `body`, are allowed. |
|
|
99
|
+
| `options.retries` | [RetryConfig](../../lib/utils/retryconfig.md) | :heavy_minus_sign: | Enables retrying HTTP requests under certain failure conditions. |
|
|
100
|
+
|
|
101
|
+
### Response
|
|
102
|
+
|
|
103
|
+
**Promise\<[models.CreateSharedEnvVariableResponseBody](../../models/createsharedenvvariableresponsebody.md)\>**
|
|
104
|
+
|
|
105
|
+
### Errors
|
|
106
|
+
|
|
107
|
+
| Error Type | Status Code | Content Type |
|
|
108
|
+
| --------------- | --------------- | --------------- |
|
|
109
|
+
| models.SDKError | 4XX, 5XX | \*/\* |
|
|
110
|
+
|
|
111
|
+
## listSharedEnvVariable
|
|
112
|
+
|
|
113
|
+
Lists all Shared Environment Variables for a team, taking into account optional filters.
|
|
114
|
+
|
|
115
|
+
### Example Usage
|
|
116
|
+
|
|
117
|
+
<!-- UsageSnippet language="typescript" operationID="listSharedEnvVariable" method="get" path="/v1/env" -->
|
|
118
|
+
```typescript
|
|
119
|
+
import { Vercel } from "@vercel/sdk";
|
|
120
|
+
|
|
121
|
+
const vercel = new Vercel({
|
|
122
|
+
bearerToken: "<YOUR_BEARER_TOKEN_HERE>",
|
|
123
|
+
});
|
|
124
|
+
|
|
125
|
+
async function run() {
|
|
126
|
+
const result = await vercel.environment.listSharedEnvVariable({
|
|
127
|
+
projectId: "prj_2WjyKQmM8ZnGcJsPWMrHRHrE",
|
|
128
|
+
ids: "env_2WjyKQmM8ZnGcJsPWMrHRHrE,env_2WjyKQmM8ZnGcJsPWMrHRCRV",
|
|
129
|
+
excludeIdsQueryParameter: "env_2WjyKQmM8ZnGcJsPWMrHRHrE,env_2WjyKQmM8ZnGcJsPWMrHRCRV",
|
|
130
|
+
excludeIdsQueryParameter1: "env_2WjyKQmM8ZnGcJsPWMrHRHrE,env_2WjyKQmM8ZnGcJsPWMrHRCRV",
|
|
131
|
+
excludeProjectIdQueryParameter: "prj_2WjyKQmM8ZnGcJsPWMrHRHrE",
|
|
132
|
+
excludeProjectIdQueryParameter1: "prj_2WjyKQmM8ZnGcJsPWMrHRHrE",
|
|
133
|
+
teamId: "team_1a2b3c4d5e6f7g8h9i0j1k2l",
|
|
134
|
+
slug: "my-team-url-slug",
|
|
135
|
+
});
|
|
136
|
+
|
|
137
|
+
console.log(result);
|
|
138
|
+
}
|
|
139
|
+
|
|
140
|
+
run();
|
|
141
|
+
```
|
|
142
|
+
|
|
143
|
+
### Standalone function
|
|
144
|
+
|
|
145
|
+
The standalone function version of this method:
|
|
146
|
+
|
|
147
|
+
```typescript
|
|
148
|
+
import { VercelCore } from "@vercel/sdk/core.js";
|
|
149
|
+
import { environmentListSharedEnvVariable } from "@vercel/sdk/funcs/environmentListSharedEnvVariable.js";
|
|
150
|
+
|
|
151
|
+
// Use `VercelCore` for best tree-shaking performance.
|
|
152
|
+
// You can create one instance of it to use across an application.
|
|
153
|
+
const vercel = new VercelCore({
|
|
154
|
+
bearerToken: "<YOUR_BEARER_TOKEN_HERE>",
|
|
155
|
+
});
|
|
156
|
+
|
|
157
|
+
async function run() {
|
|
158
|
+
const res = await environmentListSharedEnvVariable(vercel, {
|
|
159
|
+
projectId: "prj_2WjyKQmM8ZnGcJsPWMrHRHrE",
|
|
160
|
+
ids: "env_2WjyKQmM8ZnGcJsPWMrHRHrE,env_2WjyKQmM8ZnGcJsPWMrHRCRV",
|
|
161
|
+
excludeIdsQueryParameter: "env_2WjyKQmM8ZnGcJsPWMrHRHrE,env_2WjyKQmM8ZnGcJsPWMrHRCRV",
|
|
162
|
+
excludeIdsQueryParameter1: "env_2WjyKQmM8ZnGcJsPWMrHRHrE,env_2WjyKQmM8ZnGcJsPWMrHRCRV",
|
|
163
|
+
excludeProjectIdQueryParameter: "prj_2WjyKQmM8ZnGcJsPWMrHRHrE",
|
|
164
|
+
excludeProjectIdQueryParameter1: "prj_2WjyKQmM8ZnGcJsPWMrHRHrE",
|
|
165
|
+
teamId: "team_1a2b3c4d5e6f7g8h9i0j1k2l",
|
|
166
|
+
slug: "my-team-url-slug",
|
|
167
|
+
});
|
|
168
|
+
if (res.ok) {
|
|
169
|
+
const { value: result } = res;
|
|
170
|
+
console.log(result);
|
|
171
|
+
} else {
|
|
172
|
+
console.log("environmentListSharedEnvVariable failed:", res.error);
|
|
173
|
+
}
|
|
174
|
+
}
|
|
175
|
+
|
|
176
|
+
run();
|
|
177
|
+
```
|
|
178
|
+
|
|
179
|
+
### Parameters
|
|
180
|
+
|
|
181
|
+
| Parameter | Type | Required | Description |
|
|
182
|
+
| ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
|
|
183
|
+
| `request` | [models.ListSharedEnvVariableRequest](../../models/listsharedenvvariablerequest.md) | :heavy_check_mark: | The request object to use for the request. |
|
|
184
|
+
| `options` | RequestOptions | :heavy_minus_sign: | Used to set various options for making HTTP requests. |
|
|
185
|
+
| `options.fetchOptions` | [RequestInit](https://developer.mozilla.org/en-US/docs/Web/API/Request/Request#options) | :heavy_minus_sign: | Options that are passed to the underlying HTTP request. This can be used to inject extra headers for examples. All `Request` options, except `method` and `body`, are allowed. |
|
|
186
|
+
| `options.retries` | [RetryConfig](../../lib/utils/retryconfig.md) | :heavy_minus_sign: | Enables retrying HTTP requests under certain failure conditions. |
|
|
187
|
+
|
|
188
|
+
### Response
|
|
189
|
+
|
|
190
|
+
**Promise\<[models.ListSharedEnvVariableResponseBody](../../models/listsharedenvvariableresponsebody.md)\>**
|
|
191
|
+
|
|
192
|
+
### Errors
|
|
193
|
+
|
|
194
|
+
| Error Type | Status Code | Content Type |
|
|
195
|
+
| --------------- | --------------- | --------------- |
|
|
196
|
+
| models.SDKError | 4XX, 5XX | \*/\* |
|
|
197
|
+
|
|
198
|
+
## updateSharedEnvVariable
|
|
199
|
+
|
|
200
|
+
Updates a given Shared Environment Variable for a Team.
|
|
201
|
+
|
|
202
|
+
### Example Usage
|
|
203
|
+
|
|
204
|
+
<!-- UsageSnippet language="typescript" operationID="updateSharedEnvVariable" method="patch" path="/v1/env" -->
|
|
205
|
+
```typescript
|
|
206
|
+
import { Vercel } from "@vercel/sdk";
|
|
207
|
+
|
|
208
|
+
const vercel = new Vercel({
|
|
209
|
+
bearerToken: "<YOUR_BEARER_TOKEN_HERE>",
|
|
210
|
+
});
|
|
211
|
+
|
|
212
|
+
async function run() {
|
|
213
|
+
const result = await vercel.environment.updateSharedEnvVariable({
|
|
214
|
+
teamId: "team_1a2b3c4d5e6f7g8h9i0j1k2l",
|
|
215
|
+
slug: "my-team-url-slug",
|
|
216
|
+
requestBody: {
|
|
217
|
+
updates: {
|
|
218
|
+
|
|
219
|
+
},
|
|
220
|
+
},
|
|
221
|
+
});
|
|
222
|
+
|
|
223
|
+
console.log(result);
|
|
224
|
+
}
|
|
225
|
+
|
|
226
|
+
run();
|
|
227
|
+
```
|
|
228
|
+
|
|
229
|
+
### Standalone function
|
|
230
|
+
|
|
231
|
+
The standalone function version of this method:
|
|
232
|
+
|
|
233
|
+
```typescript
|
|
234
|
+
import { VercelCore } from "@vercel/sdk/core.js";
|
|
235
|
+
import { environmentUpdateSharedEnvVariable } from "@vercel/sdk/funcs/environmentUpdateSharedEnvVariable.js";
|
|
236
|
+
|
|
237
|
+
// Use `VercelCore` for best tree-shaking performance.
|
|
238
|
+
// You can create one instance of it to use across an application.
|
|
239
|
+
const vercel = new VercelCore({
|
|
240
|
+
bearerToken: "<YOUR_BEARER_TOKEN_HERE>",
|
|
241
|
+
});
|
|
242
|
+
|
|
243
|
+
async function run() {
|
|
244
|
+
const res = await environmentUpdateSharedEnvVariable(vercel, {
|
|
245
|
+
teamId: "team_1a2b3c4d5e6f7g8h9i0j1k2l",
|
|
246
|
+
slug: "my-team-url-slug",
|
|
247
|
+
requestBody: {
|
|
248
|
+
updates: {
|
|
249
|
+
|
|
250
|
+
},
|
|
251
|
+
},
|
|
252
|
+
});
|
|
253
|
+
if (res.ok) {
|
|
254
|
+
const { value: result } = res;
|
|
255
|
+
console.log(result);
|
|
256
|
+
} else {
|
|
257
|
+
console.log("environmentUpdateSharedEnvVariable failed:", res.error);
|
|
258
|
+
}
|
|
259
|
+
}
|
|
260
|
+
|
|
261
|
+
run();
|
|
262
|
+
```
|
|
263
|
+
|
|
264
|
+
### Parameters
|
|
265
|
+
|
|
266
|
+
| Parameter | Type | Required | Description |
|
|
267
|
+
| ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
|
|
268
|
+
| `request` | [models.UpdateSharedEnvVariableRequest](../../models/updatesharedenvvariablerequest.md) | :heavy_check_mark: | The request object to use for the request. |
|
|
269
|
+
| `options` | RequestOptions | :heavy_minus_sign: | Used to set various options for making HTTP requests. |
|
|
270
|
+
| `options.fetchOptions` | [RequestInit](https://developer.mozilla.org/en-US/docs/Web/API/Request/Request#options) | :heavy_minus_sign: | Options that are passed to the underlying HTTP request. This can be used to inject extra headers for examples. All `Request` options, except `method` and `body`, are allowed. |
|
|
271
|
+
| `options.retries` | [RetryConfig](../../lib/utils/retryconfig.md) | :heavy_minus_sign: | Enables retrying HTTP requests under certain failure conditions. |
|
|
272
|
+
|
|
273
|
+
### Response
|
|
274
|
+
|
|
275
|
+
**Promise\<[models.UpdateSharedEnvVariableResponseBody](../../models/updatesharedenvvariableresponsebody.md)\>**
|
|
276
|
+
|
|
277
|
+
### Errors
|
|
278
|
+
|
|
279
|
+
| Error Type | Status Code | Content Type |
|
|
280
|
+
| --------------- | --------------- | --------------- |
|
|
281
|
+
| models.SDKError | 4XX, 5XX | \*/\* |
|
|
282
|
+
|
|
283
|
+
## deleteSharedEnvVariable
|
|
284
|
+
|
|
285
|
+
Deletes one or many Shared Environment Variables for a given team.
|
|
286
|
+
|
|
287
|
+
### Example Usage
|
|
288
|
+
|
|
289
|
+
<!-- UsageSnippet language="typescript" operationID="deleteSharedEnvVariable" method="delete" path="/v1/env" -->
|
|
290
|
+
```typescript
|
|
291
|
+
import { Vercel } from "@vercel/sdk";
|
|
292
|
+
|
|
293
|
+
const vercel = new Vercel({
|
|
294
|
+
bearerToken: "<YOUR_BEARER_TOKEN_HERE>",
|
|
295
|
+
});
|
|
296
|
+
|
|
297
|
+
async function run() {
|
|
298
|
+
const result = await vercel.environment.deleteSharedEnvVariable({
|
|
299
|
+
teamId: "team_1a2b3c4d5e6f7g8h9i0j1k2l",
|
|
300
|
+
slug: "my-team-url-slug",
|
|
301
|
+
requestBody: {
|
|
302
|
+
ids: [
|
|
303
|
+
"env_abc123",
|
|
304
|
+
"env_abc124",
|
|
305
|
+
],
|
|
306
|
+
},
|
|
307
|
+
});
|
|
308
|
+
|
|
309
|
+
console.log(result);
|
|
310
|
+
}
|
|
311
|
+
|
|
312
|
+
run();
|
|
313
|
+
```
|
|
314
|
+
|
|
315
|
+
### Standalone function
|
|
316
|
+
|
|
317
|
+
The standalone function version of this method:
|
|
318
|
+
|
|
319
|
+
```typescript
|
|
320
|
+
import { VercelCore } from "@vercel/sdk/core.js";
|
|
321
|
+
import { environmentDeleteSharedEnvVariable } from "@vercel/sdk/funcs/environmentDeleteSharedEnvVariable.js";
|
|
322
|
+
|
|
323
|
+
// Use `VercelCore` for best tree-shaking performance.
|
|
324
|
+
// You can create one instance of it to use across an application.
|
|
325
|
+
const vercel = new VercelCore({
|
|
326
|
+
bearerToken: "<YOUR_BEARER_TOKEN_HERE>",
|
|
327
|
+
});
|
|
328
|
+
|
|
329
|
+
async function run() {
|
|
330
|
+
const res = await environmentDeleteSharedEnvVariable(vercel, {
|
|
331
|
+
teamId: "team_1a2b3c4d5e6f7g8h9i0j1k2l",
|
|
332
|
+
slug: "my-team-url-slug",
|
|
333
|
+
requestBody: {
|
|
334
|
+
ids: [
|
|
335
|
+
"env_abc123",
|
|
336
|
+
"env_abc124",
|
|
337
|
+
],
|
|
338
|
+
},
|
|
339
|
+
});
|
|
340
|
+
if (res.ok) {
|
|
341
|
+
const { value: result } = res;
|
|
342
|
+
console.log(result);
|
|
343
|
+
} else {
|
|
344
|
+
console.log("environmentDeleteSharedEnvVariable failed:", res.error);
|
|
345
|
+
}
|
|
346
|
+
}
|
|
347
|
+
|
|
348
|
+
run();
|
|
349
|
+
```
|
|
350
|
+
|
|
351
|
+
### Parameters
|
|
352
|
+
|
|
353
|
+
| Parameter | Type | Required | Description |
|
|
354
|
+
| ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
|
|
355
|
+
| `request` | [models.DeleteSharedEnvVariableRequest](../../models/deletesharedenvvariablerequest.md) | :heavy_check_mark: | The request object to use for the request. |
|
|
356
|
+
| `options` | RequestOptions | :heavy_minus_sign: | Used to set various options for making HTTP requests. |
|
|
357
|
+
| `options.fetchOptions` | [RequestInit](https://developer.mozilla.org/en-US/docs/Web/API/Request/Request#options) | :heavy_minus_sign: | Options that are passed to the underlying HTTP request. This can be used to inject extra headers for examples. All `Request` options, except `method` and `body`, are allowed. |
|
|
358
|
+
| `options.retries` | [RetryConfig](../../lib/utils/retryconfig.md) | :heavy_minus_sign: | Enables retrying HTTP requests under certain failure conditions. |
|
|
359
|
+
|
|
360
|
+
### Response
|
|
361
|
+
|
|
362
|
+
**Promise\<[models.DeleteSharedEnvVariableResponseBody](../../models/deletesharedenvvariableresponsebody.md)\>**
|
|
363
|
+
|
|
364
|
+
### Errors
|
|
365
|
+
|
|
366
|
+
| Error Type | Status Code | Content Type |
|
|
367
|
+
| --------------- | --------------- | --------------- |
|
|
368
|
+
| models.SDKError | 4XX, 5XX | \*/\* |
|
|
369
|
+
|
|
370
|
+
## getSharedEnvVar
|
|
371
|
+
|
|
372
|
+
Retrieve the decrypted value of a Shared Environment Variable by id.
|
|
373
|
+
|
|
374
|
+
### Example Usage
|
|
375
|
+
|
|
376
|
+
<!-- UsageSnippet language="typescript" operationID="getSharedEnvVar" method="get" path="/v1/env/{id}" -->
|
|
377
|
+
```typescript
|
|
378
|
+
import { Vercel } from "@vercel/sdk";
|
|
379
|
+
|
|
380
|
+
const vercel = new Vercel({
|
|
381
|
+
bearerToken: "<YOUR_BEARER_TOKEN_HERE>",
|
|
382
|
+
});
|
|
383
|
+
|
|
384
|
+
async function run() {
|
|
385
|
+
const result = await vercel.environment.getSharedEnvVar({
|
|
386
|
+
id: "<id>",
|
|
387
|
+
teamId: "team_1a2b3c4d5e6f7g8h9i0j1k2l",
|
|
388
|
+
slug: "my-team-url-slug",
|
|
389
|
+
});
|
|
390
|
+
|
|
391
|
+
console.log(result);
|
|
392
|
+
}
|
|
393
|
+
|
|
394
|
+
run();
|
|
395
|
+
```
|
|
396
|
+
|
|
397
|
+
### Standalone function
|
|
398
|
+
|
|
399
|
+
The standalone function version of this method:
|
|
400
|
+
|
|
401
|
+
```typescript
|
|
402
|
+
import { VercelCore } from "@vercel/sdk/core.js";
|
|
403
|
+
import { environmentGetSharedEnvVar } from "@vercel/sdk/funcs/environmentGetSharedEnvVar.js";
|
|
404
|
+
|
|
405
|
+
// Use `VercelCore` for best tree-shaking performance.
|
|
406
|
+
// You can create one instance of it to use across an application.
|
|
407
|
+
const vercel = new VercelCore({
|
|
408
|
+
bearerToken: "<YOUR_BEARER_TOKEN_HERE>",
|
|
409
|
+
});
|
|
410
|
+
|
|
411
|
+
async function run() {
|
|
412
|
+
const res = await environmentGetSharedEnvVar(vercel, {
|
|
413
|
+
id: "<id>",
|
|
414
|
+
teamId: "team_1a2b3c4d5e6f7g8h9i0j1k2l",
|
|
415
|
+
slug: "my-team-url-slug",
|
|
416
|
+
});
|
|
417
|
+
if (res.ok) {
|
|
418
|
+
const { value: result } = res;
|
|
419
|
+
console.log(result);
|
|
420
|
+
} else {
|
|
421
|
+
console.log("environmentGetSharedEnvVar failed:", res.error);
|
|
422
|
+
}
|
|
423
|
+
}
|
|
424
|
+
|
|
425
|
+
run();
|
|
426
|
+
```
|
|
427
|
+
|
|
428
|
+
### Parameters
|
|
429
|
+
|
|
430
|
+
| Parameter | Type | Required | Description |
|
|
431
|
+
| ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
|
|
432
|
+
| `request` | [models.GetSharedEnvVarRequest](../../models/getsharedenvvarrequest.md) | :heavy_check_mark: | The request object to use for the request. |
|
|
433
|
+
| `options` | RequestOptions | :heavy_minus_sign: | Used to set various options for making HTTP requests. |
|
|
434
|
+
| `options.fetchOptions` | [RequestInit](https://developer.mozilla.org/en-US/docs/Web/API/Request/Request#options) | :heavy_minus_sign: | Options that are passed to the underlying HTTP request. This can be used to inject extra headers for examples. All `Request` options, except `method` and `body`, are allowed. |
|
|
435
|
+
| `options.retries` | [RetryConfig](../../lib/utils/retryconfig.md) | :heavy_minus_sign: | Enables retrying HTTP requests under certain failure conditions. |
|
|
436
|
+
|
|
437
|
+
### Response
|
|
438
|
+
|
|
439
|
+
**Promise\<[models.GetSharedEnvVarResponseBody](../../models/getsharedenvvarresponsebody.md)\>**
|
|
440
|
+
|
|
441
|
+
### Errors
|
|
442
|
+
|
|
443
|
+
| Error Type | Status Code | Content Type |
|
|
444
|
+
| --------------- | --------------- | --------------- |
|
|
445
|
+
| models.SDKError | 4XX, 5XX | \*/\* |
|
|
446
|
+
|
|
447
|
+
## unlinkSharedEnvVariable
|
|
448
|
+
|
|
449
|
+
Disconnects a shared environment variable for a given project
|
|
450
|
+
|
|
451
|
+
### Example Usage
|
|
452
|
+
|
|
453
|
+
<!-- UsageSnippet language="typescript" operationID="unlinkSharedEnvVariable" method="patch" path="/v1/env/{id}/unlink/{projectId}" -->
|
|
454
|
+
```typescript
|
|
455
|
+
import { Vercel } from "@vercel/sdk";
|
|
456
|
+
|
|
457
|
+
const vercel = new Vercel({
|
|
458
|
+
bearerToken: "<YOUR_BEARER_TOKEN_HERE>",
|
|
459
|
+
});
|
|
460
|
+
|
|
461
|
+
async function run() {
|
|
462
|
+
const result = await vercel.environment.unlinkSharedEnvVariable({
|
|
463
|
+
id: "<id>",
|
|
464
|
+
projectId: "<id>",
|
|
465
|
+
teamId: "team_1a2b3c4d5e6f7g8h9i0j1k2l",
|
|
466
|
+
slug: "my-team-url-slug",
|
|
467
|
+
});
|
|
468
|
+
|
|
469
|
+
console.log(result);
|
|
470
|
+
}
|
|
471
|
+
|
|
472
|
+
run();
|
|
473
|
+
```
|
|
474
|
+
|
|
475
|
+
### Standalone function
|
|
476
|
+
|
|
477
|
+
The standalone function version of this method:
|
|
478
|
+
|
|
479
|
+
```typescript
|
|
480
|
+
import { VercelCore } from "@vercel/sdk/core.js";
|
|
481
|
+
import { environmentUnlinkSharedEnvVariable } from "@vercel/sdk/funcs/environmentUnlinkSharedEnvVariable.js";
|
|
482
|
+
|
|
483
|
+
// Use `VercelCore` for best tree-shaking performance.
|
|
484
|
+
// You can create one instance of it to use across an application.
|
|
485
|
+
const vercel = new VercelCore({
|
|
486
|
+
bearerToken: "<YOUR_BEARER_TOKEN_HERE>",
|
|
487
|
+
});
|
|
488
|
+
|
|
489
|
+
async function run() {
|
|
490
|
+
const res = await environmentUnlinkSharedEnvVariable(vercel, {
|
|
491
|
+
id: "<id>",
|
|
492
|
+
projectId: "<id>",
|
|
493
|
+
teamId: "team_1a2b3c4d5e6f7g8h9i0j1k2l",
|
|
494
|
+
slug: "my-team-url-slug",
|
|
495
|
+
});
|
|
496
|
+
if (res.ok) {
|
|
497
|
+
const { value: result } = res;
|
|
498
|
+
console.log(result);
|
|
499
|
+
} else {
|
|
500
|
+
console.log("environmentUnlinkSharedEnvVariable failed:", res.error);
|
|
501
|
+
}
|
|
502
|
+
}
|
|
503
|
+
|
|
504
|
+
run();
|
|
505
|
+
```
|
|
506
|
+
|
|
507
|
+
### Parameters
|
|
508
|
+
|
|
509
|
+
| Parameter | Type | Required | Description |
|
|
510
|
+
| ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
|
|
511
|
+
| `request` | [models.UnlinkSharedEnvVariableRequest](../../models/unlinksharedenvvariablerequest.md) | :heavy_check_mark: | The request object to use for the request. |
|
|
512
|
+
| `options` | RequestOptions | :heavy_minus_sign: | Used to set various options for making HTTP requests. |
|
|
513
|
+
| `options.fetchOptions` | [RequestInit](https://developer.mozilla.org/en-US/docs/Web/API/Request/Request#options) | :heavy_minus_sign: | Options that are passed to the underlying HTTP request. This can be used to inject extra headers for examples. All `Request` options, except `method` and `body`, are allowed. |
|
|
514
|
+
| `options.retries` | [RetryConfig](../../lib/utils/retryconfig.md) | :heavy_minus_sign: | Enables retrying HTTP requests under certain failure conditions. |
|
|
515
|
+
|
|
516
|
+
### Response
|
|
517
|
+
|
|
518
|
+
**Promise\<[models.UnlinkSharedEnvVariableResponseBody](../../models/unlinksharedenvvariableresponsebody.md)\>**
|
|
519
|
+
|
|
520
|
+
### Errors
|
|
521
|
+
|
|
522
|
+
| Error Type | Status Code | Content Type |
|
|
523
|
+
| --------------- | --------------- | --------------- |
|
|
524
|
+
| models.SDKError | 4XX, 5XX | \*/\* |
|
|
525
|
+
|
|
14
526
|
## createCustomEnvironment
|
|
15
527
|
|
|
16
528
|
Creates a custom environment for the current project. Cannot be named 'Production' or 'Preview'.
|