Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
The table of contents is too big for display.
Diff view
Diff view
  •  
  •  
  •  
13 changes: 13 additions & 0 deletions .prettierignore
Original file line number Diff line number Diff line change
@@ -0,0 +1,13 @@
node_modules/
dist/
types/
package-lock.json

# CI workflow files follow the YAML conventions of the publishing repository,
# not this SDK's source formatting.
.github/

# README and CHANGELOG carry caller-supplied markdown verbatim, which this
# SDK's formatter must not rewrite.
README.md
CHANGELOG.md
4 changes: 4 additions & 0 deletions .prettierrc
Original file line number Diff line number Diff line change
@@ -0,0 +1,4 @@
{
"tabWidth": 4,
"singleQuote": true
}
18 changes: 18 additions & 0 deletions CHANGELOG.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,23 @@
# Change Log

## 29.0.0-rc.1

* Breaking: `Execution.functionId` is replaced by `resourceId` and `resourceType`, now that executions cover both functions and sites
* Breaking: `AppInstallation.authorizationDetails` is now an array instead of an object
* Breaking: removed `dedicatedDatabases.execute` from `ProjectKeyScopes`
* Breaking: `EmbeddingModel` no longer offers `embedding-gemma` or `bge-small`
* Added: `documentsDB`, `vectorsDB`, `mysql`, `postgresql`, and `mongo` services, no longer hidden from server SDKs
* Added: `DocumentsDBIndexType` and `VectorsDBIndexType` enums
* Added: dedicated database models for branches, backups, restorations, poolers, PITR windows, extensions, and executions
* Added: `PostgresExtension`, `VectorsdbCollection`, `AttributeObject`, and `AttributeVector` models
* Added: `ExecutionResourceType` enum and `resourceType` on the `Execution` model
* Added: `OAuth2HuggingFace` model and the `huggingface` OAuth provider
* Added: `userId`, `emailHash`, and `name` parameters to `avatars.getPhoto`
* Added: `error`, `containerStatus`, and `lifecycleState` on the `Database` model
* Added: `changelogWatermark` on the `DatabaseMigration` model
* Added: `total` on the `DedicatedDatabaseBranchList` model
* Updated: `DedicatedDatabaseOperation.status` documents the new `queued` state

## 28.0.0

* Breaking: removed `account.createJWT`; use `users.createJWT` instead. A leaked JWT could mint further JWTs, letting a credential outlive its own expiry — a session cannot duplicate itself to live forever either
Expand Down
2 changes: 1 addition & 1 deletion docs/examples/account/create-email-password-session.md
Original file line number Diff line number Diff line change
Expand Up @@ -10,6 +10,6 @@ const account = new sdk.Account(client);

const result = await account.createEmailPasswordSession({
email: 'email@example.com',
password: 'password'
password: 'password',
});
```
2 changes: 1 addition & 1 deletion docs/examples/account/create-email-token.md
Original file line number Diff line number Diff line change
Expand Up @@ -11,6 +11,6 @@ const account = new sdk.Account(client);
const result = await account.createEmailToken({
userId: '<USER_ID>',
email: 'email@example.com',
phrase: false // optional
phrase: false, // optional
});
```
2 changes: 1 addition & 1 deletion docs/examples/account/create-email-verification.md
Original file line number Diff line number Diff line change
Expand Up @@ -9,6 +9,6 @@ const client = new sdk.Client()
const account = new sdk.Account(client);

const result = await account.createEmailVerification({
url: 'https://example.com'
url: 'https://example.com',
});
```
2 changes: 1 addition & 1 deletion docs/examples/account/create-magic-url-token.md
Original file line number Diff line number Diff line change
Expand Up @@ -12,6 +12,6 @@ const result = await account.createMagicURLToken({
userId: '<USER_ID>',
email: 'email@example.com',
url: 'https://example.com', // optional
phrase: false // optional
phrase: false, // optional
});
```
2 changes: 1 addition & 1 deletion docs/examples/account/create-mfa-authenticator.md
Original file line number Diff line number Diff line change
Expand Up @@ -9,6 +9,6 @@ const client = new sdk.Client()
const account = new sdk.Account(client);

const result = await account.createMFAAuthenticator({
type: sdk.AuthenticatorType.Totp
type: sdk.AuthenticatorType.Totp,
});
```
2 changes: 1 addition & 1 deletion docs/examples/account/create-mfa-challenge.md
Original file line number Diff line number Diff line change
Expand Up @@ -9,6 +9,6 @@ const client = new sdk.Client()
const account = new sdk.Account(client);

const result = await account.createMFAChallenge({
factor: sdk.AuthenticationFactor.Email
factor: sdk.AuthenticationFactor.Email,
});
```
2 changes: 1 addition & 1 deletion docs/examples/account/create-o-auth-2-token.md
Original file line number Diff line number Diff line change
Expand Up @@ -12,6 +12,6 @@ const result = await account.createOAuth2Token({
provider: sdk.OAuthProvider.Amazon,
success: 'https://example.com', // optional
failure: 'https://example.com', // optional
scopes: [] // optional
scopes: [], // optional
});
```
2 changes: 1 addition & 1 deletion docs/examples/account/create-phone-token.md
Original file line number Diff line number Diff line change
Expand Up @@ -10,6 +10,6 @@ const account = new sdk.Account(client);

const result = await account.createPhoneToken({
userId: '<USER_ID>',
phone: '+12065550100'
phone: '+12065550100',
});
```
2 changes: 1 addition & 1 deletion docs/examples/account/create-recovery.md
Original file line number Diff line number Diff line change
Expand Up @@ -10,6 +10,6 @@ const account = new sdk.Account(client);

const result = await account.createRecovery({
email: 'email@example.com',
url: 'https://example.com'
url: 'https://example.com',
});
```
2 changes: 1 addition & 1 deletion docs/examples/account/create-session.md
Original file line number Diff line number Diff line change
Expand Up @@ -10,6 +10,6 @@ const account = new sdk.Account(client);

const result = await account.createSession({
userId: '<USER_ID>',
secret: '<SECRET>'
secret: '<SECRET>',
});
```
2 changes: 1 addition & 1 deletion docs/examples/account/create-verification.md
Original file line number Diff line number Diff line change
Expand Up @@ -9,6 +9,6 @@ const client = new sdk.Client()
const account = new sdk.Account(client);

const result = await account.createVerification({
url: 'https://example.com'
url: 'https://example.com',
});
```
2 changes: 1 addition & 1 deletion docs/examples/account/create.md
Original file line number Diff line number Diff line change
Expand Up @@ -12,6 +12,6 @@ const result = await account.create({
userId: '<USER_ID>',
email: 'email@example.com',
password: 'password',
name: '<NAME>' // optional
name: '<NAME>', // optional
});
```
2 changes: 1 addition & 1 deletion docs/examples/account/delete-consent-token.md
Original file line number Diff line number Diff line change
Expand Up @@ -10,6 +10,6 @@ const account = new sdk.Account(client);

const result = await account.deleteConsentToken({
consentId: '<CONSENT_ID>',
tokenId: '<TOKEN_ID>'
tokenId: '<TOKEN_ID>',
});
```
2 changes: 1 addition & 1 deletion docs/examples/account/delete-consent.md
Original file line number Diff line number Diff line change
Expand Up @@ -9,6 +9,6 @@ const client = new sdk.Client()
const account = new sdk.Account(client);

const result = await account.deleteConsent({
consentId: '<CONSENT_ID>'
consentId: '<CONSENT_ID>',
});
```
2 changes: 1 addition & 1 deletion docs/examples/account/delete-identity.md
Original file line number Diff line number Diff line change
Expand Up @@ -9,6 +9,6 @@ const client = new sdk.Client()
const account = new sdk.Account(client);

const result = await account.deleteIdentity({
identityId: '<IDENTITY_ID>'
identityId: '<IDENTITY_ID>',
});
```
2 changes: 1 addition & 1 deletion docs/examples/account/delete-mfa-authenticator.md
Original file line number Diff line number Diff line change
Expand Up @@ -9,6 +9,6 @@ const client = new sdk.Client()
const account = new sdk.Account(client);

const result = await account.deleteMFAAuthenticator({
type: sdk.AuthenticatorType.Totp
type: sdk.AuthenticatorType.Totp,
});
```
2 changes: 1 addition & 1 deletion docs/examples/account/delete-session.md
Original file line number Diff line number Diff line change
Expand Up @@ -9,6 +9,6 @@ const client = new sdk.Client()
const account = new sdk.Account(client);

const result = await account.deleteSession({
sessionId: '<SESSION_ID>'
sessionId: '<SESSION_ID>',
});
```
2 changes: 1 addition & 1 deletion docs/examples/account/get-consent-token.md
Original file line number Diff line number Diff line change
Expand Up @@ -10,6 +10,6 @@ const account = new sdk.Account(client);

const result = await account.getConsentToken({
consentId: '<CONSENT_ID>',
tokenId: '<TOKEN_ID>'
tokenId: '<TOKEN_ID>',
});
```
2 changes: 1 addition & 1 deletion docs/examples/account/get-consent.md
Original file line number Diff line number Diff line change
Expand Up @@ -9,6 +9,6 @@ const client = new sdk.Client()
const account = new sdk.Account(client);

const result = await account.getConsent({
consentId: '<CONSENT_ID>'
consentId: '<CONSENT_ID>',
});
```
2 changes: 1 addition & 1 deletion docs/examples/account/get-session.md
Original file line number Diff line number Diff line change
Expand Up @@ -9,6 +9,6 @@ const client = new sdk.Client()
const account = new sdk.Account(client);

const result = await account.getSession({
sessionId: '<SESSION_ID>'
sessionId: '<SESSION_ID>',
});
```
2 changes: 1 addition & 1 deletion docs/examples/account/list-consent-tokens.md
Original file line number Diff line number Diff line change
Expand Up @@ -11,6 +11,6 @@ const account = new sdk.Account(client);
const result = await account.listConsentTokens({
consentId: '<CONSENT_ID>',
queries: [], // optional
total: false // optional
total: false, // optional
});
```
2 changes: 1 addition & 1 deletion docs/examples/account/list-consents.md
Original file line number Diff line number Diff line change
Expand Up @@ -10,6 +10,6 @@ const account = new sdk.Account(client);

const result = await account.listConsents({
queries: [], // optional
total: false // optional
total: false, // optional
});
```
2 changes: 1 addition & 1 deletion docs/examples/account/list-identities.md
Original file line number Diff line number Diff line change
Expand Up @@ -10,6 +10,6 @@ const account = new sdk.Account(client);

const result = await account.listIdentities({
queries: [], // optional
total: false // optional
total: false, // optional
});
```
2 changes: 1 addition & 1 deletion docs/examples/account/list-logs.md
Original file line number Diff line number Diff line change
Expand Up @@ -10,6 +10,6 @@ const account = new sdk.Account(client);

const result = await account.listLogs({
queries: [], // optional
total: false // optional
total: false, // optional
});
```
2 changes: 1 addition & 1 deletion docs/examples/account/update-email-verification.md
Original file line number Diff line number Diff line change
Expand Up @@ -10,6 +10,6 @@ const account = new sdk.Account(client);

const result = await account.updateEmailVerification({
userId: '<USER_ID>',
secret: '<SECRET>'
secret: '<SECRET>',
});
```
2 changes: 1 addition & 1 deletion docs/examples/account/update-email.md
Original file line number Diff line number Diff line change
Expand Up @@ -10,6 +10,6 @@ const account = new sdk.Account(client);

const result = await account.updateEmail({
email: 'email@example.com',
password: 'password'
password: 'password',
});
```
2 changes: 1 addition & 1 deletion docs/examples/account/update-magic-url-session.md
Original file line number Diff line number Diff line change
Expand Up @@ -10,6 +10,6 @@ const account = new sdk.Account(client);

const result = await account.updateMagicURLSession({
userId: '<USER_ID>',
secret: '<SECRET>'
secret: '<SECRET>',
});
```
2 changes: 1 addition & 1 deletion docs/examples/account/update-mfa-authenticator.md
Original file line number Diff line number Diff line change
Expand Up @@ -10,6 +10,6 @@ const account = new sdk.Account(client);

const result = await account.updateMFAAuthenticator({
type: sdk.AuthenticatorType.Totp,
otp: '<OTP>'
otp: '<OTP>',
});
```
2 changes: 1 addition & 1 deletion docs/examples/account/update-mfa-challenge.md
Original file line number Diff line number Diff line change
Expand Up @@ -10,6 +10,6 @@ const account = new sdk.Account(client);

const result = await account.updateMFAChallenge({
challengeId: '<CHALLENGE_ID>',
otp: '<OTP>'
otp: '<OTP>',
});
```
2 changes: 1 addition & 1 deletion docs/examples/account/update-mfa.md
Original file line number Diff line number Diff line change
Expand Up @@ -9,6 +9,6 @@ const client = new sdk.Client()
const account = new sdk.Account(client);

const result = await account.updateMFA({
mfa: false
mfa: false,
});
```
2 changes: 1 addition & 1 deletion docs/examples/account/update-name.md
Original file line number Diff line number Diff line change
Expand Up @@ -9,6 +9,6 @@ const client = new sdk.Client()
const account = new sdk.Account(client);

const result = await account.updateName({
name: '<NAME>'
name: '<NAME>',
});
```
2 changes: 1 addition & 1 deletion docs/examples/account/update-password.md
Original file line number Diff line number Diff line change
Expand Up @@ -10,6 +10,6 @@ const account = new sdk.Account(client);

const result = await account.updatePassword({
password: 'password',
oldPassword: 'password' // optional
oldPassword: 'password', // optional
});
```
2 changes: 1 addition & 1 deletion docs/examples/account/update-phone-session.md
Original file line number Diff line number Diff line change
Expand Up @@ -10,6 +10,6 @@ const account = new sdk.Account(client);

const result = await account.updatePhoneSession({
userId: '<USER_ID>',
secret: '<SECRET>'
secret: '<SECRET>',
});
```
2 changes: 1 addition & 1 deletion docs/examples/account/update-phone-verification.md
Original file line number Diff line number Diff line change
Expand Up @@ -10,6 +10,6 @@ const account = new sdk.Account(client);

const result = await account.updatePhoneVerification({
userId: '<USER_ID>',
secret: '<SECRET>'
secret: '<SECRET>',
});
```
2 changes: 1 addition & 1 deletion docs/examples/account/update-phone.md
Original file line number Diff line number Diff line change
Expand Up @@ -10,6 +10,6 @@ const account = new sdk.Account(client);

const result = await account.updatePhone({
phone: '+12065550100',
password: 'password'
password: 'password',
});
```
8 changes: 4 additions & 4 deletions docs/examples/account/update-prefs.md
Original file line number Diff line number Diff line change
Expand Up @@ -10,9 +10,9 @@ const account = new sdk.Account(client);

const result = await account.updatePrefs({
prefs: {
"language": "en",
"timezone": "UTC",
"darkTheme": true
}
language: 'en',
timezone: 'UTC',
darkTheme: true,
},
});
```
2 changes: 1 addition & 1 deletion docs/examples/account/update-recovery.md
Original file line number Diff line number Diff line change
Expand Up @@ -11,6 +11,6 @@ const account = new sdk.Account(client);
const result = await account.updateRecovery({
userId: '<USER_ID>',
secret: '<SECRET>',
password: 'password'
password: 'password',
});
```
2 changes: 1 addition & 1 deletion docs/examples/account/update-session.md
Original file line number Diff line number Diff line change
Expand Up @@ -9,6 +9,6 @@ const client = new sdk.Client()
const account = new sdk.Account(client);

const result = await account.updateSession({
sessionId: '<SESSION_ID>'
sessionId: '<SESSION_ID>',
});
```
2 changes: 1 addition & 1 deletion docs/examples/account/update-verification.md
Original file line number Diff line number Diff line change
Expand Up @@ -10,6 +10,6 @@ const account = new sdk.Account(client);

const result = await account.updateVerification({
userId: '<USER_ID>',
secret: '<SECRET>'
secret: '<SECRET>',
});
```
2 changes: 1 addition & 1 deletion docs/examples/activities/get-event.md
Original file line number Diff line number Diff line change
Expand Up @@ -9,6 +9,6 @@ const client = new sdk.Client()
const activities = new sdk.Activities(client);

const result = await activities.getEvent({
eventId: '<EVENT_ID>'
eventId: '<EVENT_ID>',
});
```
2 changes: 1 addition & 1 deletion docs/examples/activities/list-events.md
Original file line number Diff line number Diff line change
Expand Up @@ -9,6 +9,6 @@ const client = new sdk.Client()
const activities = new sdk.Activities(client);

const result = await activities.listEvents({
queries: [] // optional
queries: [], // optional
});
```
2 changes: 1 addition & 1 deletion docs/examples/advisor/delete-report.md
Original file line number Diff line number Diff line change
Expand Up @@ -9,6 +9,6 @@ const client = new sdk.Client()
const advisor = new sdk.Advisor(client);

const result = await advisor.deleteReport({
reportId: '<REPORT_ID>'
reportId: '<REPORT_ID>',
});
```
2 changes: 1 addition & 1 deletion docs/examples/advisor/get-insight.md
Original file line number Diff line number Diff line change
Expand Up @@ -10,6 +10,6 @@ const advisor = new sdk.Advisor(client);

const result = await advisor.getInsight({
reportId: '<REPORT_ID>',
insightId: '<INSIGHT_ID>'
insightId: '<INSIGHT_ID>',
});
```
Loading