diff --git a/CHANGELOG.md b/CHANGELOG.md index e7443565..345fee45 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -1,5 +1,10 @@ # Change Log +## 20.1.0 + +* Fix doc examples with proper formatting +* Add support for the new `Backups` service + ## 20.0.0 * Add array-based enum parameters (e.g., `permissions: array`). @@ -48,4 +53,4 @@ * Add `dart38` and `flutter332` support to runtime models * Add `gif` support to `ImageFormat` enum * Add `upsertDocument` support to `Databases` service -* Add `sequence` support to `Document` model \ No newline at end of file +* Add `sequence` support to `Document` model diff --git a/README.md b/README.md index 9713e5df..6f4db851 100644 --- a/README.md +++ b/README.md @@ -6,7 +6,7 @@ [![Twitter Account](https://img.shields.io/twitter/follow/appwrite?color=00acee&label=twitter&style=flat-square)](https://twitter.com/appwrite) [![Discord](https://img.shields.io/discord/564160730845151244?label=discord&style=flat-square)](https://appwrite.io/discord) -**This SDK is compatible with Appwrite server version 1.8.x. For older versions, please check [previous releases](https://github.com/appwrite/sdk-for-php/releases).** +**This SDK is compatible with Appwrite server version latest. For older versions, please check [previous releases](https://github.com/appwrite/sdk-for-php/releases).** Appwrite is an open-source backend as a service server that abstracts and simplifies complex and repetitive development tasks behind a very simple to use REST API. Appwrite aims to help you develop your apps faster and in a more secure way. Use the PHP SDK to integrate your app with the Appwrite server to easily start interacting with all of Appwrite backend APIs and tools. For full API documentation and tutorials go to [https://appwrite.io/docs](https://appwrite.io/docs) diff --git a/docs/backups.md b/docs/backups.md new file mode 100644 index 00000000..36a4ee91 --- /dev/null +++ b/docs/backups.md @@ -0,0 +1,172 @@ +# Backups Service + + +```http request +GET https://cloud.appwrite.io/v1/backups/archives +``` + +** List all archives for a project. ** + +### Parameters + +| Field Name | Type | Description | Default | +| --- | --- | --- | --- | +| queries | array | Array of query strings generated using the Query class provided by the SDK. [Learn more about queries](https://appwrite.io/docs/queries). Maximum of 100 queries are allowed, each 4096 characters long. | [] | + + +```http request +POST https://cloud.appwrite.io/v1/backups/archives +``` + +** Create a new archive asynchronously for a project. ** + +### Parameters + +| Field Name | Type | Description | Default | +| --- | --- | --- | --- | +| services | array | Array of services to backup | | +| resourceId | string | Resource ID. When set, only this single resource will be backed up. | | + + +```http request +GET https://cloud.appwrite.io/v1/backups/archives/{archiveId} +``` + +** Get a backup archive using it's ID. ** + +### Parameters + +| Field Name | Type | Description | Default | +| --- | --- | --- | --- | +| archiveId | string | **Required** Archive ID. Choose a custom ID`. Valid chars are a-z, A-Z, 0-9, period, hyphen, and underscore. Can't start with a special char. Max length is 36 chars. | | + + +```http request +DELETE https://cloud.appwrite.io/v1/backups/archives/{archiveId} +``` + +** Delete an existing archive for a project. ** + +### Parameters + +| Field Name | Type | Description | Default | +| --- | --- | --- | --- | +| archiveId | string | **Required** Policy ID. Choose a custom ID or generate a random ID with `ID.unique()`. Valid chars are a-z, A-Z, 0-9, period, hyphen, and underscore. Can't start with a special char. Max length is 36 chars. | | + + +```http request +GET https://cloud.appwrite.io/v1/backups/policies +``` + +** List all policies for a project. ** + +### Parameters + +| Field Name | Type | Description | Default | +| --- | --- | --- | --- | +| queries | array | Array of query strings generated using the Query class provided by the SDK. [Learn more about queries](https://appwrite.io/docs/queries). Maximum of 100 queries are allowed, each 4096 characters long. | [] | + + +```http request +POST https://cloud.appwrite.io/v1/backups/policies +``` + +** Create a new backup policy. ** + +### Parameters + +| Field Name | Type | Description | Default | +| --- | --- | --- | --- | +| policyId | string | Policy ID. Choose a custom ID or generate a random ID with `ID.unique()`. Valid chars are a-z, A-Z, 0-9, period, hyphen, and underscore. Can't start with a special char. Max length is 36 chars. | | +| name | string | Policy name. Max length: 128 chars. | | +| services | array | Array of services to backup | | +| resourceId | string | Resource ID. When set, only this single resource will be backed up. | | +| enabled | boolean | Is policy enabled? When set to 'disabled', no backups will be taken | 1 | +| retention | integer | Days to keep backups before deletion | | +| schedule | string | Schedule CRON syntax. | | + + +```http request +GET https://cloud.appwrite.io/v1/backups/policies/{policyId} +``` + +** Get a backup policy using it's ID. ** + +### Parameters + +| Field Name | Type | Description | Default | +| --- | --- | --- | --- | +| policyId | string | **Required** Policy ID. Choose a custom ID`. Valid chars are a-z, A-Z, 0-9, period, hyphen, and underscore. Can't start with a special char. Max length is 36 chars. | | + + +```http request +PATCH https://cloud.appwrite.io/v1/backups/policies/{policyId} +``` + +** Update an existing policy using it's ID. ** + +### Parameters + +| Field Name | Type | Description | Default | +| --- | --- | --- | --- | +| policyId | string | **Required** Policy ID. Choose a custom ID`. Valid chars are a-z, A-Z, 0-9, period, hyphen, and underscore. Can't start with a special char. Max length is 36 chars. | | +| name | string | Policy name. Max length: 128 chars. | | +| retention | integer | Days to keep backups before deletion | | +| schedule | string | Cron expression | | +| enabled | boolean | Is Backup enabled? When set to 'disabled', No backup will be taken | | + + +```http request +DELETE https://cloud.appwrite.io/v1/backups/policies/{policyId} +``` + +** Delete a policy using it's ID. ** + +### Parameters + +| Field Name | Type | Description | Default | +| --- | --- | --- | --- | +| policyId | string | **Required** Policy ID. Choose a custom ID or generate a random ID with `ID.unique()`. Valid chars are a-z, A-Z, 0-9, period, hyphen, and underscore. Can't start with a special char. Max length is 36 chars. | | + + +```http request +POST https://cloud.appwrite.io/v1/backups/restoration +``` + +** Create and trigger a new restoration for a backup on a project. ** + +### Parameters + +| Field Name | Type | Description | Default | +| --- | --- | --- | --- | +| archiveId | string | Backup archive ID to restore | | +| services | array | Array of services to restore | | +| newResourceId | string | Unique Id. Choose a custom ID or generate a random ID with `ID.unique()`. Valid chars are a-z, A-Z, 0-9, period, hyphen, and underscore. Can't start with a special char. Max length is 36 chars. | | +| newResourceName | string | Database name. Max length: 128 chars. | | + + +```http request +GET https://cloud.appwrite.io/v1/backups/restorations +``` + +** List all backup restorations for a project. ** + +### Parameters + +| Field Name | Type | Description | Default | +| --- | --- | --- | --- | +| queries | array | Array of query strings generated using the Query class provided by the SDK. [Learn more about queries](https://appwrite.io/docs/queries). Maximum of 100 queries are allowed, each 4096 characters long. | [] | + + +```http request +GET https://cloud.appwrite.io/v1/backups/restorations/{restorationId} +``` + +** Get the current status of a backup restoration. ** + +### Parameters + +| Field Name | Type | Description | Default | +| --- | --- | --- | --- | +| restorationId | string | **Required** Restoration ID. Choose a custom ID`. Valid chars are a-z, A-Z, 0-9, period, hyphen, and underscore. Can't start with a special char. Max length is 36 chars. | | + diff --git a/docs/examples/account/create-anonymous-session.md b/docs/examples/account/create-anonymous-session.md index 9959a3fe..90283cf3 100644 --- a/docs/examples/account/create-anonymous-session.md +++ b/docs/examples/account/create-anonymous-session.md @@ -1,3 +1,4 @@ +```php createAnonymousSession(); +``` diff --git a/docs/examples/account/create-email-password-session.md b/docs/examples/account/create-email-password-session.md index 3ffa5a5a..2a80ab61 100644 --- a/docs/examples/account/create-email-password-session.md +++ b/docs/examples/account/create-email-password-session.md @@ -1,3 +1,4 @@ +```php createEmailPasswordSession( email: 'email@example.com', password: 'password' -); \ No newline at end of file +);``` diff --git a/docs/examples/account/create-email-token.md b/docs/examples/account/create-email-token.md index f1405da5..9c20e746 100644 --- a/docs/examples/account/create-email-token.md +++ b/docs/examples/account/create-email-token.md @@ -1,3 +1,4 @@ +```php createEmailToken( userId: '', email: 'email@example.com', phrase: false // optional -); \ No newline at end of file +);``` diff --git a/docs/examples/account/create-email-verification.md b/docs/examples/account/create-email-verification.md index 691d6fa3..650f5777 100644 --- a/docs/examples/account/create-email-verification.md +++ b/docs/examples/account/create-email-verification.md @@ -1,3 +1,4 @@ +```php createEmailVerification( url: 'https://example.com' -); \ No newline at end of file +);``` diff --git a/docs/examples/account/create-jwt.md b/docs/examples/account/create-jwt.md index 4031c649..3314407a 100644 --- a/docs/examples/account/create-jwt.md +++ b/docs/examples/account/create-jwt.md @@ -1,3 +1,4 @@ +```php createJWT( duration: 0 // optional -); \ No newline at end of file +);``` diff --git a/docs/examples/account/create-magic-url-token.md b/docs/examples/account/create-magic-url-token.md index 6e738e64..a4dde3d7 100644 --- a/docs/examples/account/create-magic-url-token.md +++ b/docs/examples/account/create-magic-url-token.md @@ -1,3 +1,4 @@ +```php createMagicURLToken( email: 'email@example.com', url: 'https://example.com', // optional phrase: false // optional -); \ No newline at end of file +);``` diff --git a/docs/examples/account/create-mfa-authenticator.md b/docs/examples/account/create-mfa-authenticator.md index 2eb50c3f..fbbc193f 100644 --- a/docs/examples/account/create-mfa-authenticator.md +++ b/docs/examples/account/create-mfa-authenticator.md @@ -1,3 +1,4 @@ +```php createMFAAuthenticator( type: AuthenticatorType::TOTP() -); \ No newline at end of file +);``` diff --git a/docs/examples/account/create-mfa-challenge.md b/docs/examples/account/create-mfa-challenge.md index 6f0ecf87..08bf57d8 100644 --- a/docs/examples/account/create-mfa-challenge.md +++ b/docs/examples/account/create-mfa-challenge.md @@ -1,3 +1,4 @@ +```php createMFAChallenge( factor: AuthenticationFactor::EMAIL() -); \ No newline at end of file +);``` diff --git a/docs/examples/account/create-mfa-recovery-codes.md b/docs/examples/account/create-mfa-recovery-codes.md index 031bc4df..655663f7 100644 --- a/docs/examples/account/create-mfa-recovery-codes.md +++ b/docs/examples/account/create-mfa-recovery-codes.md @@ -1,3 +1,4 @@ +```php createMFARecoveryCodes(); +``` diff --git a/docs/examples/account/create-o-auth-2-token.md b/docs/examples/account/create-o-auth-2-token.md index 721ed364..170192d6 100644 --- a/docs/examples/account/create-o-auth-2-token.md +++ b/docs/examples/account/create-o-auth-2-token.md @@ -1,3 +1,4 @@ +```php createOAuth2Token( success: 'https://example.com', // optional failure: 'https://example.com', // optional scopes: [] // optional -); \ No newline at end of file +);``` diff --git a/docs/examples/account/create-phone-token.md b/docs/examples/account/create-phone-token.md index a2b45f76..f48754f5 100644 --- a/docs/examples/account/create-phone-token.md +++ b/docs/examples/account/create-phone-token.md @@ -1,3 +1,4 @@ +```php createPhoneToken( userId: '', phone: '+12065550100' -); \ No newline at end of file +);``` diff --git a/docs/examples/account/create-phone-verification.md b/docs/examples/account/create-phone-verification.md index a1526673..4cedfba4 100644 --- a/docs/examples/account/create-phone-verification.md +++ b/docs/examples/account/create-phone-verification.md @@ -1,3 +1,4 @@ +```php createPhoneVerification(); +``` diff --git a/docs/examples/account/create-recovery.md b/docs/examples/account/create-recovery.md index c15e41d5..c6eaadaf 100644 --- a/docs/examples/account/create-recovery.md +++ b/docs/examples/account/create-recovery.md @@ -1,3 +1,4 @@ +```php createRecovery( email: 'email@example.com', url: 'https://example.com' -); \ No newline at end of file +);``` diff --git a/docs/examples/account/create-session.md b/docs/examples/account/create-session.md index 02525f74..6e339b09 100644 --- a/docs/examples/account/create-session.md +++ b/docs/examples/account/create-session.md @@ -1,3 +1,4 @@ +```php createSession( userId: '', secret: '' -); \ No newline at end of file +);``` diff --git a/docs/examples/account/create-verification.md b/docs/examples/account/create-verification.md index 4628175f..2266a0f1 100644 --- a/docs/examples/account/create-verification.md +++ b/docs/examples/account/create-verification.md @@ -1,3 +1,4 @@ +```php createVerification( url: 'https://example.com' -); \ No newline at end of file +);``` diff --git a/docs/examples/account/create.md b/docs/examples/account/create.md index 91684345..8975698b 100644 --- a/docs/examples/account/create.md +++ b/docs/examples/account/create.md @@ -1,3 +1,4 @@ +```php create( email: 'email@example.com', password: '', name: '' // optional -); \ No newline at end of file +);``` diff --git a/docs/examples/account/delete-identity.md b/docs/examples/account/delete-identity.md index fd66d3ae..56db56fd 100644 --- a/docs/examples/account/delete-identity.md +++ b/docs/examples/account/delete-identity.md @@ -1,3 +1,4 @@ +```php deleteIdentity( identityId: '' -); \ No newline at end of file +);``` diff --git a/docs/examples/account/delete-mfa-authenticator.md b/docs/examples/account/delete-mfa-authenticator.md index 524b9b3e..c171381d 100644 --- a/docs/examples/account/delete-mfa-authenticator.md +++ b/docs/examples/account/delete-mfa-authenticator.md @@ -1,3 +1,4 @@ +```php deleteMFAAuthenticator( type: AuthenticatorType::TOTP() -); \ No newline at end of file +);``` diff --git a/docs/examples/account/delete-session.md b/docs/examples/account/delete-session.md index 9233ae14..b200785f 100644 --- a/docs/examples/account/delete-session.md +++ b/docs/examples/account/delete-session.md @@ -1,3 +1,4 @@ +```php deleteSession( sessionId: '' -); \ No newline at end of file +);``` diff --git a/docs/examples/account/delete-sessions.md b/docs/examples/account/delete-sessions.md index 557fd6d3..7886fabf 100644 --- a/docs/examples/account/delete-sessions.md +++ b/docs/examples/account/delete-sessions.md @@ -1,3 +1,4 @@ +```php deleteSessions(); +``` diff --git a/docs/examples/account/get-mfa-recovery-codes.md b/docs/examples/account/get-mfa-recovery-codes.md index fc5aef27..9a99dac2 100644 --- a/docs/examples/account/get-mfa-recovery-codes.md +++ b/docs/examples/account/get-mfa-recovery-codes.md @@ -1,3 +1,4 @@ +```php getMFARecoveryCodes(); +``` diff --git a/docs/examples/account/get-prefs.md b/docs/examples/account/get-prefs.md index c7077aff..e1259176 100644 --- a/docs/examples/account/get-prefs.md +++ b/docs/examples/account/get-prefs.md @@ -1,3 +1,4 @@ +```php getPrefs(); +``` diff --git a/docs/examples/account/get-session.md b/docs/examples/account/get-session.md index be267134..7e79a07f 100644 --- a/docs/examples/account/get-session.md +++ b/docs/examples/account/get-session.md @@ -1,3 +1,4 @@ +```php getSession( sessionId: '' -); \ No newline at end of file +);``` diff --git a/docs/examples/account/get.md b/docs/examples/account/get.md index 30cb7b2a..d1fb255b 100644 --- a/docs/examples/account/get.md +++ b/docs/examples/account/get.md @@ -1,3 +1,4 @@ +```php get(); +``` diff --git a/docs/examples/account/list-identities.md b/docs/examples/account/list-identities.md index b75a64cf..1bd2ef02 100644 --- a/docs/examples/account/list-identities.md +++ b/docs/examples/account/list-identities.md @@ -1,3 +1,4 @@ +```php listIdentities( queries: [], // optional total: false // optional -); \ No newline at end of file +);``` diff --git a/docs/examples/account/list-logs.md b/docs/examples/account/list-logs.md index deddc9ec..763b7727 100644 --- a/docs/examples/account/list-logs.md +++ b/docs/examples/account/list-logs.md @@ -1,3 +1,4 @@ +```php listLogs( queries: [], // optional total: false // optional -); \ No newline at end of file +);``` diff --git a/docs/examples/account/list-mfa-factors.md b/docs/examples/account/list-mfa-factors.md index f7b6e262..96b6021b 100644 --- a/docs/examples/account/list-mfa-factors.md +++ b/docs/examples/account/list-mfa-factors.md @@ -1,3 +1,4 @@ +```php listMFAFactors(); +``` diff --git a/docs/examples/account/list-sessions.md b/docs/examples/account/list-sessions.md index 7f9749f7..9c42f8ca 100644 --- a/docs/examples/account/list-sessions.md +++ b/docs/examples/account/list-sessions.md @@ -1,3 +1,4 @@ +```php listSessions(); +``` diff --git a/docs/examples/account/update-email-verification.md b/docs/examples/account/update-email-verification.md index 95cd1b5e..2fa17a54 100644 --- a/docs/examples/account/update-email-verification.md +++ b/docs/examples/account/update-email-verification.md @@ -1,3 +1,4 @@ +```php updateEmailVerification( userId: '', secret: '' -); \ No newline at end of file +);``` diff --git a/docs/examples/account/update-email.md b/docs/examples/account/update-email.md index c7c0d485..8cdfc5f1 100644 --- a/docs/examples/account/update-email.md +++ b/docs/examples/account/update-email.md @@ -1,3 +1,4 @@ +```php updateEmail( email: 'email@example.com', password: 'password' -); \ No newline at end of file +);``` diff --git a/docs/examples/account/update-magic-url-session.md b/docs/examples/account/update-magic-url-session.md index ef6b8cc0..055f0664 100644 --- a/docs/examples/account/update-magic-url-session.md +++ b/docs/examples/account/update-magic-url-session.md @@ -1,3 +1,4 @@ +```php updateMagicURLSession( userId: '', secret: '' -); \ No newline at end of file +);``` diff --git a/docs/examples/account/update-mfa-authenticator.md b/docs/examples/account/update-mfa-authenticator.md index 8486e88c..c2f9dd66 100644 --- a/docs/examples/account/update-mfa-authenticator.md +++ b/docs/examples/account/update-mfa-authenticator.md @@ -1,3 +1,4 @@ +```php updateMFAAuthenticator( type: AuthenticatorType::TOTP(), otp: '' -); \ No newline at end of file +);``` diff --git a/docs/examples/account/update-mfa-challenge.md b/docs/examples/account/update-mfa-challenge.md index e5821e55..effbb172 100644 --- a/docs/examples/account/update-mfa-challenge.md +++ b/docs/examples/account/update-mfa-challenge.md @@ -1,3 +1,4 @@ +```php updateMFAChallenge( challengeId: '', otp: '' -); \ No newline at end of file +);``` diff --git a/docs/examples/account/update-mfa-recovery-codes.md b/docs/examples/account/update-mfa-recovery-codes.md index f57e490f..ee16a9c9 100644 --- a/docs/examples/account/update-mfa-recovery-codes.md +++ b/docs/examples/account/update-mfa-recovery-codes.md @@ -1,3 +1,4 @@ +```php updateMFARecoveryCodes(); +``` diff --git a/docs/examples/account/update-mfa.md b/docs/examples/account/update-mfa.md index a1978e63..3d2f9b62 100644 --- a/docs/examples/account/update-mfa.md +++ b/docs/examples/account/update-mfa.md @@ -1,3 +1,4 @@ +```php updateMFA( mfa: false -); \ No newline at end of file +);``` diff --git a/docs/examples/account/update-name.md b/docs/examples/account/update-name.md index 2603b6e6..4a34bc32 100644 --- a/docs/examples/account/update-name.md +++ b/docs/examples/account/update-name.md @@ -1,3 +1,4 @@ +```php updateName( name: '' -); \ No newline at end of file +);``` diff --git a/docs/examples/account/update-password.md b/docs/examples/account/update-password.md index c5101381..ea1996a6 100644 --- a/docs/examples/account/update-password.md +++ b/docs/examples/account/update-password.md @@ -1,3 +1,4 @@ +```php updatePassword( password: '', oldPassword: 'password' // optional -); \ No newline at end of file +);``` diff --git a/docs/examples/account/update-phone-session.md b/docs/examples/account/update-phone-session.md index 42f7fb93..67b5816d 100644 --- a/docs/examples/account/update-phone-session.md +++ b/docs/examples/account/update-phone-session.md @@ -1,3 +1,4 @@ +```php updatePhoneSession( userId: '', secret: '' -); \ No newline at end of file +);``` diff --git a/docs/examples/account/update-phone-verification.md b/docs/examples/account/update-phone-verification.md index df599229..877a0346 100644 --- a/docs/examples/account/update-phone-verification.md +++ b/docs/examples/account/update-phone-verification.md @@ -1,3 +1,4 @@ +```php updatePhoneVerification( userId: '', secret: '' -); \ No newline at end of file +);``` diff --git a/docs/examples/account/update-phone.md b/docs/examples/account/update-phone.md index 853cb62f..6b5e9cad 100644 --- a/docs/examples/account/update-phone.md +++ b/docs/examples/account/update-phone.md @@ -1,3 +1,4 @@ +```php updatePhone( phone: '+12065550100', password: 'password' -); \ No newline at end of file +);``` diff --git a/docs/examples/account/update-prefs.md b/docs/examples/account/update-prefs.md index f6a10030..4709edd2 100644 --- a/docs/examples/account/update-prefs.md +++ b/docs/examples/account/update-prefs.md @@ -1,3 +1,4 @@ +```php updatePrefs( 'timezone' => 'UTC', 'darkTheme' => true ] -); \ No newline at end of file +);``` diff --git a/docs/examples/account/update-recovery.md b/docs/examples/account/update-recovery.md index 63518b00..7b5c1d0b 100644 --- a/docs/examples/account/update-recovery.md +++ b/docs/examples/account/update-recovery.md @@ -1,3 +1,4 @@ +```php updateRecovery( userId: '', secret: '', password: '' -); \ No newline at end of file +);``` diff --git a/docs/examples/account/update-session.md b/docs/examples/account/update-session.md index 11cb4c7d..aecf2fe8 100644 --- a/docs/examples/account/update-session.md +++ b/docs/examples/account/update-session.md @@ -1,3 +1,4 @@ +```php updateSession( sessionId: '' -); \ No newline at end of file +);``` diff --git a/docs/examples/account/update-status.md b/docs/examples/account/update-status.md index 7c8075e5..7f0088a6 100644 --- a/docs/examples/account/update-status.md +++ b/docs/examples/account/update-status.md @@ -1,3 +1,4 @@ +```php updateStatus(); +``` diff --git a/docs/examples/account/update-verification.md b/docs/examples/account/update-verification.md index 60ec0b31..24bb3ff0 100644 --- a/docs/examples/account/update-verification.md +++ b/docs/examples/account/update-verification.md @@ -1,3 +1,4 @@ +```php updateVerification( userId: '', secret: '' -); \ No newline at end of file +);``` diff --git a/docs/examples/avatars/get-browser.md b/docs/examples/avatars/get-browser.md index 2449c260..ec2a7599 100644 --- a/docs/examples/avatars/get-browser.md +++ b/docs/examples/avatars/get-browser.md @@ -1,3 +1,4 @@ +```php getBrowser( width: 0, // optional height: 0, // optional quality: -1 // optional -); \ No newline at end of file +);``` diff --git a/docs/examples/avatars/get-credit-card.md b/docs/examples/avatars/get-credit-card.md index 123b345a..05ddc247 100644 --- a/docs/examples/avatars/get-credit-card.md +++ b/docs/examples/avatars/get-credit-card.md @@ -1,3 +1,4 @@ +```php getCreditCard( width: 0, // optional height: 0, // optional quality: -1 // optional -); \ No newline at end of file +);``` diff --git a/docs/examples/avatars/get-favicon.md b/docs/examples/avatars/get-favicon.md index 1e671864..424cea84 100644 --- a/docs/examples/avatars/get-favicon.md +++ b/docs/examples/avatars/get-favicon.md @@ -1,3 +1,4 @@ +```php getFavicon( url: 'https://example.com' -); \ No newline at end of file +);``` diff --git a/docs/examples/avatars/get-flag.md b/docs/examples/avatars/get-flag.md index 5b7d8bab..1a4ef37a 100644 --- a/docs/examples/avatars/get-flag.md +++ b/docs/examples/avatars/get-flag.md @@ -1,3 +1,4 @@ +```php getFlag( width: 0, // optional height: 0, // optional quality: -1 // optional -); \ No newline at end of file +);``` diff --git a/docs/examples/avatars/get-image.md b/docs/examples/avatars/get-image.md index e1555453..4ceb8d38 100644 --- a/docs/examples/avatars/get-image.md +++ b/docs/examples/avatars/get-image.md @@ -1,3 +1,4 @@ +```php getImage( url: 'https://example.com', width: 0, // optional height: 0 // optional -); \ No newline at end of file +);``` diff --git a/docs/examples/avatars/get-initials.md b/docs/examples/avatars/get-initials.md index d84e23a1..2bd523b5 100644 --- a/docs/examples/avatars/get-initials.md +++ b/docs/examples/avatars/get-initials.md @@ -1,3 +1,4 @@ +```php getInitials( width: 0, // optional height: 0, // optional background: '' // optional -); \ No newline at end of file +);``` diff --git a/docs/examples/avatars/get-qr.md b/docs/examples/avatars/get-qr.md index 0d5936af..ad49bf9e 100644 --- a/docs/examples/avatars/get-qr.md +++ b/docs/examples/avatars/get-qr.md @@ -1,3 +1,4 @@ +```php getQR( size: 1, // optional margin: 0, // optional download: false // optional -); \ No newline at end of file +);``` diff --git a/docs/examples/avatars/get-screenshot.md b/docs/examples/avatars/get-screenshot.md index 24c3aaa9..9db8b3cd 100644 --- a/docs/examples/avatars/get-screenshot.md +++ b/docs/examples/avatars/get-screenshot.md @@ -1,3 +1,4 @@ +```php getScreenshot( height: 600, // optional quality: 85, // optional output: ImageFormat::JPEG() // optional -); \ No newline at end of file +);``` diff --git a/docs/examples/backups/create-archive.md b/docs/examples/backups/create-archive.md new file mode 100644 index 00000000..d73db2e2 --- /dev/null +++ b/docs/examples/backups/create-archive.md @@ -0,0 +1,18 @@ +```php +setEndpoint('https://.cloud.appwrite.io/v1') // Your API Endpoint + ->setProject('') // Your project ID + ->setKey(''); // Your secret API key + +$backups = new Backups($client); + +$result = $backups->createArchive( + services: [BackupServices::DATABASES()], + resourceId: '' // optional +);``` diff --git a/docs/examples/backups/create-policy.md b/docs/examples/backups/create-policy.md new file mode 100644 index 00000000..ea87f280 --- /dev/null +++ b/docs/examples/backups/create-policy.md @@ -0,0 +1,23 @@ +```php +setEndpoint('https://.cloud.appwrite.io/v1') // Your API Endpoint + ->setProject('') // Your project ID + ->setKey(''); // Your secret API key + +$backups = new Backups($client); + +$result = $backups->createPolicy( + policyId: '', + services: [BackupServices::DATABASES()], + retention: 1, + schedule: '', + name: '', // optional + resourceId: '', // optional + enabled: false // optional +);``` diff --git a/docs/examples/backups/create-restoration.md b/docs/examples/backups/create-restoration.md new file mode 100644 index 00000000..61d9e0b2 --- /dev/null +++ b/docs/examples/backups/create-restoration.md @@ -0,0 +1,20 @@ +```php +setEndpoint('https://.cloud.appwrite.io/v1') // Your API Endpoint + ->setProject('') // Your project ID + ->setKey(''); // Your secret API key + +$backups = new Backups($client); + +$result = $backups->createRestoration( + archiveId: '', + services: [BackupServices::DATABASES()], + newResourceId: '', // optional + newResourceName: '' // optional +);``` diff --git a/docs/examples/backups/delete-archive.md b/docs/examples/backups/delete-archive.md new file mode 100644 index 00000000..a6c3d332 --- /dev/null +++ b/docs/examples/backups/delete-archive.md @@ -0,0 +1,16 @@ +```php +setEndpoint('https://.cloud.appwrite.io/v1') // Your API Endpoint + ->setProject('') // Your project ID + ->setKey(''); // Your secret API key + +$backups = new Backups($client); + +$result = $backups->deleteArchive( + archiveId: '' +);``` diff --git a/docs/examples/backups/delete-policy.md b/docs/examples/backups/delete-policy.md new file mode 100644 index 00000000..3c6df8f4 --- /dev/null +++ b/docs/examples/backups/delete-policy.md @@ -0,0 +1,16 @@ +```php +setEndpoint('https://.cloud.appwrite.io/v1') // Your API Endpoint + ->setProject('') // Your project ID + ->setKey(''); // Your secret API key + +$backups = new Backups($client); + +$result = $backups->deletePolicy( + policyId: '' +);``` diff --git a/docs/examples/backups/get-archive.md b/docs/examples/backups/get-archive.md new file mode 100644 index 00000000..6fa9ea93 --- /dev/null +++ b/docs/examples/backups/get-archive.md @@ -0,0 +1,16 @@ +```php +setEndpoint('https://.cloud.appwrite.io/v1') // Your API Endpoint + ->setProject('') // Your project ID + ->setKey(''); // Your secret API key + +$backups = new Backups($client); + +$result = $backups->getArchive( + archiveId: '' +);``` diff --git a/docs/examples/backups/get-policy.md b/docs/examples/backups/get-policy.md new file mode 100644 index 00000000..e8ce5c8f --- /dev/null +++ b/docs/examples/backups/get-policy.md @@ -0,0 +1,16 @@ +```php +setEndpoint('https://.cloud.appwrite.io/v1') // Your API Endpoint + ->setProject('') // Your project ID + ->setKey(''); // Your secret API key + +$backups = new Backups($client); + +$result = $backups->getPolicy( + policyId: '' +);``` diff --git a/docs/examples/backups/get-restoration.md b/docs/examples/backups/get-restoration.md new file mode 100644 index 00000000..ed3e94ab --- /dev/null +++ b/docs/examples/backups/get-restoration.md @@ -0,0 +1,16 @@ +```php +setEndpoint('https://.cloud.appwrite.io/v1') // Your API Endpoint + ->setProject('') // Your project ID + ->setKey(''); // Your secret API key + +$backups = new Backups($client); + +$result = $backups->getRestoration( + restorationId: '' +);``` diff --git a/docs/examples/backups/list-archives.md b/docs/examples/backups/list-archives.md new file mode 100644 index 00000000..4060e3c0 --- /dev/null +++ b/docs/examples/backups/list-archives.md @@ -0,0 +1,16 @@ +```php +setEndpoint('https://.cloud.appwrite.io/v1') // Your API Endpoint + ->setProject('') // Your project ID + ->setKey(''); // Your secret API key + +$backups = new Backups($client); + +$result = $backups->listArchives( + queries: [] // optional +);``` diff --git a/docs/examples/backups/list-policies.md b/docs/examples/backups/list-policies.md new file mode 100644 index 00000000..a8b03316 --- /dev/null +++ b/docs/examples/backups/list-policies.md @@ -0,0 +1,16 @@ +```php +setEndpoint('https://.cloud.appwrite.io/v1') // Your API Endpoint + ->setProject('') // Your project ID + ->setKey(''); // Your secret API key + +$backups = new Backups($client); + +$result = $backups->listPolicies( + queries: [] // optional +);``` diff --git a/docs/examples/backups/list-restorations.md b/docs/examples/backups/list-restorations.md new file mode 100644 index 00000000..2c7132b2 --- /dev/null +++ b/docs/examples/backups/list-restorations.md @@ -0,0 +1,16 @@ +```php +setEndpoint('https://.cloud.appwrite.io/v1') // Your API Endpoint + ->setProject('') // Your project ID + ->setKey(''); // Your secret API key + +$backups = new Backups($client); + +$result = $backups->listRestorations( + queries: [] // optional +);``` diff --git a/docs/examples/backups/update-policy.md b/docs/examples/backups/update-policy.md new file mode 100644 index 00000000..fe53fa2b --- /dev/null +++ b/docs/examples/backups/update-policy.md @@ -0,0 +1,20 @@ +```php +setEndpoint('https://.cloud.appwrite.io/v1') // Your API Endpoint + ->setProject('') // Your project ID + ->setKey(''); // Your secret API key + +$backups = new Backups($client); + +$result = $backups->updatePolicy( + policyId: '', + name: '', // optional + retention: 1, // optional + schedule: '', // optional + enabled: false // optional +);``` diff --git a/docs/examples/databases/create-boolean-attribute.md b/docs/examples/databases/create-boolean-attribute.md index 805d0221..746db6be 100644 --- a/docs/examples/databases/create-boolean-attribute.md +++ b/docs/examples/databases/create-boolean-attribute.md @@ -1,3 +1,4 @@ +```php createBooleanAttribute( required: false, default: false, // optional array: false // optional -); \ No newline at end of file +);``` diff --git a/docs/examples/databases/create-collection.md b/docs/examples/databases/create-collection.md index aabfa033..a90e579b 100644 --- a/docs/examples/databases/create-collection.md +++ b/docs/examples/databases/create-collection.md @@ -1,3 +1,4 @@ +```php createCollection( enabled: false, // optional attributes: [], // optional indexes: [] // optional -); \ No newline at end of file +);``` diff --git a/docs/examples/databases/create-datetime-attribute.md b/docs/examples/databases/create-datetime-attribute.md index dd2fcecc..f7c38624 100644 --- a/docs/examples/databases/create-datetime-attribute.md +++ b/docs/examples/databases/create-datetime-attribute.md @@ -1,3 +1,4 @@ +```php createDatetimeAttribute( required: false, default: '', // optional array: false // optional -); \ No newline at end of file +);``` diff --git a/docs/examples/databases/create-document.md b/docs/examples/databases/create-document.md index 39fb26f8..f8e7e943 100644 --- a/docs/examples/databases/create-document.md +++ b/docs/examples/databases/create-document.md @@ -1,3 +1,4 @@ +```php createDocument( ], permissions: [Permission::read(Role::any())], // optional transactionId: '' // optional -); \ No newline at end of file +);``` diff --git a/docs/examples/databases/create-documents.md b/docs/examples/databases/create-documents.md index ced7a5a8..f4f153ae 100644 --- a/docs/examples/databases/create-documents.md +++ b/docs/examples/databases/create-documents.md @@ -1,3 +1,4 @@ +```php createDocuments( collectionId: '', documents: [], transactionId: '' // optional -); \ No newline at end of file +);``` diff --git a/docs/examples/databases/create-email-attribute.md b/docs/examples/databases/create-email-attribute.md index 1274a4b9..4f53b8ac 100644 --- a/docs/examples/databases/create-email-attribute.md +++ b/docs/examples/databases/create-email-attribute.md @@ -1,3 +1,4 @@ +```php createEmailAttribute( required: false, default: 'email@example.com', // optional array: false // optional -); \ No newline at end of file +);``` diff --git a/docs/examples/databases/create-enum-attribute.md b/docs/examples/databases/create-enum-attribute.md index 9abf2dfa..49eb90a5 100644 --- a/docs/examples/databases/create-enum-attribute.md +++ b/docs/examples/databases/create-enum-attribute.md @@ -1,3 +1,4 @@ +```php createEnumAttribute( required: false, default: '', // optional array: false // optional -); \ No newline at end of file +);``` diff --git a/docs/examples/databases/create-float-attribute.md b/docs/examples/databases/create-float-attribute.md index e6eecb52..60486bbb 100644 --- a/docs/examples/databases/create-float-attribute.md +++ b/docs/examples/databases/create-float-attribute.md @@ -1,3 +1,4 @@ +```php createFloatAttribute( max: null, // optional default: null, // optional array: false // optional -); \ No newline at end of file +);``` diff --git a/docs/examples/databases/create-index.md b/docs/examples/databases/create-index.md index 8dc2c889..39b3722e 100644 --- a/docs/examples/databases/create-index.md +++ b/docs/examples/databases/create-index.md @@ -1,3 +1,4 @@ +```php createIndex( attributes: [], orders: [OrderBy::ASC()], // optional lengths: [] // optional -); \ No newline at end of file +);``` diff --git a/docs/examples/databases/create-integer-attribute.md b/docs/examples/databases/create-integer-attribute.md index 1dbeefa5..e1c771fe 100644 --- a/docs/examples/databases/create-integer-attribute.md +++ b/docs/examples/databases/create-integer-attribute.md @@ -1,3 +1,4 @@ +```php createIntegerAttribute( max: null, // optional default: null, // optional array: false // optional -); \ No newline at end of file +);``` diff --git a/docs/examples/databases/create-ip-attribute.md b/docs/examples/databases/create-ip-attribute.md index f42717ca..b15fc386 100644 --- a/docs/examples/databases/create-ip-attribute.md +++ b/docs/examples/databases/create-ip-attribute.md @@ -1,3 +1,4 @@ +```php createIpAttribute( required: false, default: '', // optional array: false // optional -); \ No newline at end of file +);``` diff --git a/docs/examples/databases/create-line-attribute.md b/docs/examples/databases/create-line-attribute.md index 56d007c6..dd59e00b 100644 --- a/docs/examples/databases/create-line-attribute.md +++ b/docs/examples/databases/create-line-attribute.md @@ -1,3 +1,4 @@ +```php createLineAttribute( key: '', required: false, default: [[1, 2], [3, 4], [5, 6]] // optional -); \ No newline at end of file +);``` diff --git a/docs/examples/databases/create-longtext-attribute.md b/docs/examples/databases/create-longtext-attribute.md index bb97b18b..9c3b4a65 100644 --- a/docs/examples/databases/create-longtext-attribute.md +++ b/docs/examples/databases/create-longtext-attribute.md @@ -1,3 +1,4 @@ +```php createLongtextAttribute( required: false, default: '', // optional array: false // optional -); \ No newline at end of file +);``` diff --git a/docs/examples/databases/create-mediumtext-attribute.md b/docs/examples/databases/create-mediumtext-attribute.md index d225d95b..9c3a78f5 100644 --- a/docs/examples/databases/create-mediumtext-attribute.md +++ b/docs/examples/databases/create-mediumtext-attribute.md @@ -1,3 +1,4 @@ +```php createMediumtextAttribute( required: false, default: '', // optional array: false // optional -); \ No newline at end of file +);``` diff --git a/docs/examples/databases/create-operations.md b/docs/examples/databases/create-operations.md index 05038cb6..10b2e6c5 100644 --- a/docs/examples/databases/create-operations.md +++ b/docs/examples/databases/create-operations.md @@ -1,3 +1,4 @@ +```php createOperations( } } ] // optional -); \ No newline at end of file +);``` diff --git a/docs/examples/databases/create-point-attribute.md b/docs/examples/databases/create-point-attribute.md index dee08011..14ced405 100644 --- a/docs/examples/databases/create-point-attribute.md +++ b/docs/examples/databases/create-point-attribute.md @@ -1,3 +1,4 @@ +```php createPointAttribute( key: '', required: false, default: [1, 2] // optional -); \ No newline at end of file +);``` diff --git a/docs/examples/databases/create-polygon-attribute.md b/docs/examples/databases/create-polygon-attribute.md index d7455893..5886cf2c 100644 --- a/docs/examples/databases/create-polygon-attribute.md +++ b/docs/examples/databases/create-polygon-attribute.md @@ -1,3 +1,4 @@ +```php createPolygonAttribute( key: '', required: false, default: [[[1, 2], [3, 4], [5, 6], [1, 2]]] // optional -); \ No newline at end of file +);``` diff --git a/docs/examples/databases/create-relationship-attribute.md b/docs/examples/databases/create-relationship-attribute.md index 551fe17a..739b27e2 100644 --- a/docs/examples/databases/create-relationship-attribute.md +++ b/docs/examples/databases/create-relationship-attribute.md @@ -1,3 +1,4 @@ +```php createRelationshipAttribute( key: '', // optional twoWayKey: '', // optional onDelete: RelationMutate::CASCADE() // optional -); \ No newline at end of file +);``` diff --git a/docs/examples/databases/create-string-attribute.md b/docs/examples/databases/create-string-attribute.md index 5a4f72b6..e6da9507 100644 --- a/docs/examples/databases/create-string-attribute.md +++ b/docs/examples/databases/create-string-attribute.md @@ -1,3 +1,4 @@ +```php createStringAttribute( default: '', // optional array: false, // optional encrypt: false // optional -); \ No newline at end of file +);``` diff --git a/docs/examples/databases/create-text-attribute.md b/docs/examples/databases/create-text-attribute.md index 3b1316f4..b123b1bf 100644 --- a/docs/examples/databases/create-text-attribute.md +++ b/docs/examples/databases/create-text-attribute.md @@ -1,3 +1,4 @@ +```php createTextAttribute( required: false, default: '', // optional array: false // optional -); \ No newline at end of file +);``` diff --git a/docs/examples/databases/create-transaction.md b/docs/examples/databases/create-transaction.md index ea6faf73..9ca80288 100644 --- a/docs/examples/databases/create-transaction.md +++ b/docs/examples/databases/create-transaction.md @@ -1,3 +1,4 @@ +```php createTransaction( ttl: 60 // optional -); \ No newline at end of file +);``` diff --git a/docs/examples/databases/create-url-attribute.md b/docs/examples/databases/create-url-attribute.md index 6b9bc800..c1b432df 100644 --- a/docs/examples/databases/create-url-attribute.md +++ b/docs/examples/databases/create-url-attribute.md @@ -1,3 +1,4 @@ +```php createUrlAttribute( required: false, default: 'https://example.com', // optional array: false // optional -); \ No newline at end of file +);``` diff --git a/docs/examples/databases/create-varchar-attribute.md b/docs/examples/databases/create-varchar-attribute.md index 811e47b0..31a10287 100644 --- a/docs/examples/databases/create-varchar-attribute.md +++ b/docs/examples/databases/create-varchar-attribute.md @@ -1,3 +1,4 @@ +```php createVarcharAttribute( required: false, default: '', // optional array: false // optional -); \ No newline at end of file +);``` diff --git a/docs/examples/databases/create.md b/docs/examples/databases/create.md index 73c61887..867c31c2 100644 --- a/docs/examples/databases/create.md +++ b/docs/examples/databases/create.md @@ -1,3 +1,4 @@ +```php create( databaseId: '', name: '', enabled: false // optional -); \ No newline at end of file +);``` diff --git a/docs/examples/databases/decrement-document-attribute.md b/docs/examples/databases/decrement-document-attribute.md index dfb1873c..2c00e787 100644 --- a/docs/examples/databases/decrement-document-attribute.md +++ b/docs/examples/databases/decrement-document-attribute.md @@ -1,3 +1,4 @@ +```php decrementDocumentAttribute( value: null, // optional min: null, // optional transactionId: '' // optional -); \ No newline at end of file +);``` diff --git a/docs/examples/databases/delete-attribute.md b/docs/examples/databases/delete-attribute.md index 71b71626..cc777436 100644 --- a/docs/examples/databases/delete-attribute.md +++ b/docs/examples/databases/delete-attribute.md @@ -1,3 +1,4 @@ +```php deleteAttribute( databaseId: '', collectionId: '', key: '' -); \ No newline at end of file +);``` diff --git a/docs/examples/databases/delete-collection.md b/docs/examples/databases/delete-collection.md index 4e98dfdb..8419bc41 100644 --- a/docs/examples/databases/delete-collection.md +++ b/docs/examples/databases/delete-collection.md @@ -1,3 +1,4 @@ +```php deleteCollection( databaseId: '', collectionId: '' -); \ No newline at end of file +);``` diff --git a/docs/examples/databases/delete-document.md b/docs/examples/databases/delete-document.md index 6e4d7aa2..c0c620bc 100644 --- a/docs/examples/databases/delete-document.md +++ b/docs/examples/databases/delete-document.md @@ -1,3 +1,4 @@ +```php deleteDocument( collectionId: '', documentId: '', transactionId: '' // optional -); \ No newline at end of file +);``` diff --git a/docs/examples/databases/delete-documents.md b/docs/examples/databases/delete-documents.md index 3b2b0c79..124294dc 100644 --- a/docs/examples/databases/delete-documents.md +++ b/docs/examples/databases/delete-documents.md @@ -1,3 +1,4 @@ +```php deleteDocuments( collectionId: '', queries: [], // optional transactionId: '' // optional -); \ No newline at end of file +);``` diff --git a/docs/examples/databases/delete-index.md b/docs/examples/databases/delete-index.md index 79e476b6..d8106099 100644 --- a/docs/examples/databases/delete-index.md +++ b/docs/examples/databases/delete-index.md @@ -1,3 +1,4 @@ +```php deleteIndex( databaseId: '', collectionId: '', key: '' -); \ No newline at end of file +);``` diff --git a/docs/examples/databases/delete-transaction.md b/docs/examples/databases/delete-transaction.md index 0559aace..3e2db81e 100644 --- a/docs/examples/databases/delete-transaction.md +++ b/docs/examples/databases/delete-transaction.md @@ -1,3 +1,4 @@ +```php deleteTransaction( transactionId: '' -); \ No newline at end of file +);``` diff --git a/docs/examples/databases/delete.md b/docs/examples/databases/delete.md index c796b7c4..9d89cfbc 100644 --- a/docs/examples/databases/delete.md +++ b/docs/examples/databases/delete.md @@ -1,3 +1,4 @@ +```php delete( databaseId: '' -); \ No newline at end of file +);``` diff --git a/docs/examples/databases/get-attribute.md b/docs/examples/databases/get-attribute.md index ba82db40..4f3f7f77 100644 --- a/docs/examples/databases/get-attribute.md +++ b/docs/examples/databases/get-attribute.md @@ -1,3 +1,4 @@ +```php getAttribute( databaseId: '', collectionId: '', key: '' -); \ No newline at end of file +);``` diff --git a/docs/examples/databases/get-collection.md b/docs/examples/databases/get-collection.md index ecddab05..e3cccdf3 100644 --- a/docs/examples/databases/get-collection.md +++ b/docs/examples/databases/get-collection.md @@ -1,3 +1,4 @@ +```php getCollection( databaseId: '', collectionId: '' -); \ No newline at end of file +);``` diff --git a/docs/examples/databases/get-document.md b/docs/examples/databases/get-document.md index 834602d8..90f8760e 100644 --- a/docs/examples/databases/get-document.md +++ b/docs/examples/databases/get-document.md @@ -1,3 +1,4 @@ +```php getDocument( documentId: '', queries: [], // optional transactionId: '' // optional -); \ No newline at end of file +);``` diff --git a/docs/examples/databases/get-index.md b/docs/examples/databases/get-index.md index e9c63076..001fc6ed 100644 --- a/docs/examples/databases/get-index.md +++ b/docs/examples/databases/get-index.md @@ -1,3 +1,4 @@ +```php getIndex( databaseId: '', collectionId: '', key: '' -); \ No newline at end of file +);``` diff --git a/docs/examples/databases/get-transaction.md b/docs/examples/databases/get-transaction.md index 16ca28da..82b34ae6 100644 --- a/docs/examples/databases/get-transaction.md +++ b/docs/examples/databases/get-transaction.md @@ -1,3 +1,4 @@ +```php getTransaction( transactionId: '' -); \ No newline at end of file +);``` diff --git a/docs/examples/databases/get.md b/docs/examples/databases/get.md index 9aa63955..59a83bf9 100644 --- a/docs/examples/databases/get.md +++ b/docs/examples/databases/get.md @@ -1,3 +1,4 @@ +```php get( databaseId: '' -); \ No newline at end of file +);``` diff --git a/docs/examples/databases/increment-document-attribute.md b/docs/examples/databases/increment-document-attribute.md index 63162d32..8782cf7d 100644 --- a/docs/examples/databases/increment-document-attribute.md +++ b/docs/examples/databases/increment-document-attribute.md @@ -1,3 +1,4 @@ +```php incrementDocumentAttribute( value: null, // optional max: null, // optional transactionId: '' // optional -); \ No newline at end of file +);``` diff --git a/docs/examples/databases/list-attributes.md b/docs/examples/databases/list-attributes.md index e770292a..dac753db 100644 --- a/docs/examples/databases/list-attributes.md +++ b/docs/examples/databases/list-attributes.md @@ -1,3 +1,4 @@ +```php listAttributes( collectionId: '', queries: [], // optional total: false // optional -); \ No newline at end of file +);``` diff --git a/docs/examples/databases/list-collections.md b/docs/examples/databases/list-collections.md index c71866be..7f994e1d 100644 --- a/docs/examples/databases/list-collections.md +++ b/docs/examples/databases/list-collections.md @@ -1,3 +1,4 @@ +```php listCollections( queries: [], // optional search: '', // optional total: false // optional -); \ No newline at end of file +);``` diff --git a/docs/examples/databases/list-documents.md b/docs/examples/databases/list-documents.md index 8713327f..1ff26925 100644 --- a/docs/examples/databases/list-documents.md +++ b/docs/examples/databases/list-documents.md @@ -1,3 +1,4 @@ +```php listDocuments( queries: [], // optional transactionId: '', // optional total: false // optional -); \ No newline at end of file +);``` diff --git a/docs/examples/databases/list-indexes.md b/docs/examples/databases/list-indexes.md index a26ff7cf..1ebd2692 100644 --- a/docs/examples/databases/list-indexes.md +++ b/docs/examples/databases/list-indexes.md @@ -1,3 +1,4 @@ +```php listIndexes( collectionId: '', queries: [], // optional total: false // optional -); \ No newline at end of file +);``` diff --git a/docs/examples/databases/list-transactions.md b/docs/examples/databases/list-transactions.md index 858e905b..8990c74e 100644 --- a/docs/examples/databases/list-transactions.md +++ b/docs/examples/databases/list-transactions.md @@ -1,3 +1,4 @@ +```php listTransactions( queries: [] // optional -); \ No newline at end of file +);``` diff --git a/docs/examples/databases/list.md b/docs/examples/databases/list.md index f5baccc6..d439184a 100644 --- a/docs/examples/databases/list.md +++ b/docs/examples/databases/list.md @@ -1,3 +1,4 @@ +```php list( queries: [], // optional search: '', // optional total: false // optional -); \ No newline at end of file +);``` diff --git a/docs/examples/databases/update-boolean-attribute.md b/docs/examples/databases/update-boolean-attribute.md index 2e4bee72..f63e5f3f 100644 --- a/docs/examples/databases/update-boolean-attribute.md +++ b/docs/examples/databases/update-boolean-attribute.md @@ -1,3 +1,4 @@ +```php updateBooleanAttribute( required: false, default: false, newKey: '' // optional -); \ No newline at end of file +);``` diff --git a/docs/examples/databases/update-collection.md b/docs/examples/databases/update-collection.md index 78e0dfe5..79271f6d 100644 --- a/docs/examples/databases/update-collection.md +++ b/docs/examples/databases/update-collection.md @@ -1,3 +1,4 @@ +```php updateCollection( permissions: [Permission::read(Role::any())], // optional documentSecurity: false, // optional enabled: false // optional -); \ No newline at end of file +);``` diff --git a/docs/examples/databases/update-datetime-attribute.md b/docs/examples/databases/update-datetime-attribute.md index b1a03ec0..a1fb43f6 100644 --- a/docs/examples/databases/update-datetime-attribute.md +++ b/docs/examples/databases/update-datetime-attribute.md @@ -1,3 +1,4 @@ +```php updateDatetimeAttribute( required: false, default: '', newKey: '' // optional -); \ No newline at end of file +);``` diff --git a/docs/examples/databases/update-document.md b/docs/examples/databases/update-document.md index 5037d4bf..7a185451 100644 --- a/docs/examples/databases/update-document.md +++ b/docs/examples/databases/update-document.md @@ -1,3 +1,4 @@ +```php updateDocument( ], // optional permissions: [Permission::read(Role::any())], // optional transactionId: '' // optional -); \ No newline at end of file +);``` diff --git a/docs/examples/databases/update-documents.md b/docs/examples/databases/update-documents.md index 3a4aaad2..c29a467d 100644 --- a/docs/examples/databases/update-documents.md +++ b/docs/examples/databases/update-documents.md @@ -1,3 +1,4 @@ +```php updateDocuments( ], // optional queries: [], // optional transactionId: '' // optional -); \ No newline at end of file +);``` diff --git a/docs/examples/databases/update-email-attribute.md b/docs/examples/databases/update-email-attribute.md index dc9865f8..b4421d5e 100644 --- a/docs/examples/databases/update-email-attribute.md +++ b/docs/examples/databases/update-email-attribute.md @@ -1,3 +1,4 @@ +```php updateEmailAttribute( required: false, default: 'email@example.com', newKey: '' // optional -); \ No newline at end of file +);``` diff --git a/docs/examples/databases/update-enum-attribute.md b/docs/examples/databases/update-enum-attribute.md index f7cd0b7b..c2880f29 100644 --- a/docs/examples/databases/update-enum-attribute.md +++ b/docs/examples/databases/update-enum-attribute.md @@ -1,3 +1,4 @@ +```php updateEnumAttribute( required: false, default: '', newKey: '' // optional -); \ No newline at end of file +);``` diff --git a/docs/examples/databases/update-float-attribute.md b/docs/examples/databases/update-float-attribute.md index 51f6ec92..3ea48188 100644 --- a/docs/examples/databases/update-float-attribute.md +++ b/docs/examples/databases/update-float-attribute.md @@ -1,3 +1,4 @@ +```php updateFloatAttribute( min: null, // optional max: null, // optional newKey: '' // optional -); \ No newline at end of file +);``` diff --git a/docs/examples/databases/update-integer-attribute.md b/docs/examples/databases/update-integer-attribute.md index bdbd96ca..29b7ac6b 100644 --- a/docs/examples/databases/update-integer-attribute.md +++ b/docs/examples/databases/update-integer-attribute.md @@ -1,3 +1,4 @@ +```php updateIntegerAttribute( min: null, // optional max: null, // optional newKey: '' // optional -); \ No newline at end of file +);``` diff --git a/docs/examples/databases/update-ip-attribute.md b/docs/examples/databases/update-ip-attribute.md index 130cd0cc..c7490c5f 100644 --- a/docs/examples/databases/update-ip-attribute.md +++ b/docs/examples/databases/update-ip-attribute.md @@ -1,3 +1,4 @@ +```php updateIpAttribute( required: false, default: '', newKey: '' // optional -); \ No newline at end of file +);``` diff --git a/docs/examples/databases/update-line-attribute.md b/docs/examples/databases/update-line-attribute.md index 86b8f646..7cb7dabb 100644 --- a/docs/examples/databases/update-line-attribute.md +++ b/docs/examples/databases/update-line-attribute.md @@ -1,3 +1,4 @@ +```php updateLineAttribute( required: false, default: [[1, 2], [3, 4], [5, 6]], // optional newKey: '' // optional -); \ No newline at end of file +);``` diff --git a/docs/examples/databases/update-longtext-attribute.md b/docs/examples/databases/update-longtext-attribute.md index 6d5ade20..d9a217d2 100644 --- a/docs/examples/databases/update-longtext-attribute.md +++ b/docs/examples/databases/update-longtext-attribute.md @@ -1,3 +1,4 @@ +```php updateLongtextAttribute( required: false, default: '', newKey: '' // optional -); \ No newline at end of file +);``` diff --git a/docs/examples/databases/update-mediumtext-attribute.md b/docs/examples/databases/update-mediumtext-attribute.md index 7671c556..bae03412 100644 --- a/docs/examples/databases/update-mediumtext-attribute.md +++ b/docs/examples/databases/update-mediumtext-attribute.md @@ -1,3 +1,4 @@ +```php updateMediumtextAttribute( required: false, default: '', newKey: '' // optional -); \ No newline at end of file +);``` diff --git a/docs/examples/databases/update-point-attribute.md b/docs/examples/databases/update-point-attribute.md index cdff2265..1359ec90 100644 --- a/docs/examples/databases/update-point-attribute.md +++ b/docs/examples/databases/update-point-attribute.md @@ -1,3 +1,4 @@ +```php updatePointAttribute( required: false, default: [1, 2], // optional newKey: '' // optional -); \ No newline at end of file +);``` diff --git a/docs/examples/databases/update-polygon-attribute.md b/docs/examples/databases/update-polygon-attribute.md index c2736bd4..cf799969 100644 --- a/docs/examples/databases/update-polygon-attribute.md +++ b/docs/examples/databases/update-polygon-attribute.md @@ -1,3 +1,4 @@ +```php updatePolygonAttribute( required: false, default: [[[1, 2], [3, 4], [5, 6], [1, 2]]], // optional newKey: '' // optional -); \ No newline at end of file +);``` diff --git a/docs/examples/databases/update-relationship-attribute.md b/docs/examples/databases/update-relationship-attribute.md index a4d68887..824f1f71 100644 --- a/docs/examples/databases/update-relationship-attribute.md +++ b/docs/examples/databases/update-relationship-attribute.md @@ -1,3 +1,4 @@ +```php updateRelationshipAttribute( key: '', onDelete: RelationMutate::CASCADE(), // optional newKey: '' // optional -); \ No newline at end of file +);``` diff --git a/docs/examples/databases/update-string-attribute.md b/docs/examples/databases/update-string-attribute.md index e0c8f992..828dda47 100644 --- a/docs/examples/databases/update-string-attribute.md +++ b/docs/examples/databases/update-string-attribute.md @@ -1,3 +1,4 @@ +```php updateStringAttribute( default: '', size: 1, // optional newKey: '' // optional -); \ No newline at end of file +);``` diff --git a/docs/examples/databases/update-text-attribute.md b/docs/examples/databases/update-text-attribute.md index eef06699..8de8c78c 100644 --- a/docs/examples/databases/update-text-attribute.md +++ b/docs/examples/databases/update-text-attribute.md @@ -1,3 +1,4 @@ +```php updateTextAttribute( required: false, default: '', newKey: '' // optional -); \ No newline at end of file +);``` diff --git a/docs/examples/databases/update-transaction.md b/docs/examples/databases/update-transaction.md index 750eb861..13137b6b 100644 --- a/docs/examples/databases/update-transaction.md +++ b/docs/examples/databases/update-transaction.md @@ -1,3 +1,4 @@ +```php updateTransaction( transactionId: '', commit: false, // optional rollback: false // optional -); \ No newline at end of file +);``` diff --git a/docs/examples/databases/update-url-attribute.md b/docs/examples/databases/update-url-attribute.md index c2004638..461abf55 100644 --- a/docs/examples/databases/update-url-attribute.md +++ b/docs/examples/databases/update-url-attribute.md @@ -1,3 +1,4 @@ +```php updateUrlAttribute( required: false, default: 'https://example.com', newKey: '' // optional -); \ No newline at end of file +);``` diff --git a/docs/examples/databases/update-varchar-attribute.md b/docs/examples/databases/update-varchar-attribute.md index df983228..0c5dbbe8 100644 --- a/docs/examples/databases/update-varchar-attribute.md +++ b/docs/examples/databases/update-varchar-attribute.md @@ -1,3 +1,4 @@ +```php updateVarcharAttribute( default: '', size: 1, // optional newKey: '' // optional -); \ No newline at end of file +);``` diff --git a/docs/examples/databases/update.md b/docs/examples/databases/update.md index 06a92b34..67af71aa 100644 --- a/docs/examples/databases/update.md +++ b/docs/examples/databases/update.md @@ -1,3 +1,4 @@ +```php update( databaseId: '', name: '', // optional enabled: false // optional -); \ No newline at end of file +);``` diff --git a/docs/examples/databases/upsert-document.md b/docs/examples/databases/upsert-document.md index c4cee07e..9b01b8c2 100644 --- a/docs/examples/databases/upsert-document.md +++ b/docs/examples/databases/upsert-document.md @@ -1,3 +1,4 @@ +```php upsertDocument( ], // optional permissions: [Permission::read(Role::any())], // optional transactionId: '' // optional -); \ No newline at end of file +);``` diff --git a/docs/examples/databases/upsert-documents.md b/docs/examples/databases/upsert-documents.md index 06d3a319..5bc04d78 100644 --- a/docs/examples/databases/upsert-documents.md +++ b/docs/examples/databases/upsert-documents.md @@ -1,3 +1,4 @@ +```php upsertDocuments( collectionId: '', documents: [], transactionId: '' // optional -); \ No newline at end of file +);``` diff --git a/docs/examples/functions/create-deployment.md b/docs/examples/functions/create-deployment.md index 7e48b89c..cdee0ff9 100644 --- a/docs/examples/functions/create-deployment.md +++ b/docs/examples/functions/create-deployment.md @@ -1,3 +1,4 @@ +```php createDeployment( activate: false, entrypoint: '', // optional commands: '' // optional -); \ No newline at end of file +);``` diff --git a/docs/examples/functions/create-duplicate-deployment.md b/docs/examples/functions/create-duplicate-deployment.md index a898762c..0cf3a831 100644 --- a/docs/examples/functions/create-duplicate-deployment.md +++ b/docs/examples/functions/create-duplicate-deployment.md @@ -1,3 +1,4 @@ +```php createDuplicateDeployment( functionId: '', deploymentId: '', buildId: '' // optional -); \ No newline at end of file +);``` diff --git a/docs/examples/functions/create-execution.md b/docs/examples/functions/create-execution.md index 9c12e873..70a8fc06 100644 --- a/docs/examples/functions/create-execution.md +++ b/docs/examples/functions/create-execution.md @@ -1,3 +1,4 @@ +```php createExecution( method: ExecutionMethod::GET(), // optional headers: [], // optional scheduledAt: '' // optional -); \ No newline at end of file +);``` diff --git a/docs/examples/functions/create-template-deployment.md b/docs/examples/functions/create-template-deployment.md index a1272523..c6dae9a9 100644 --- a/docs/examples/functions/create-template-deployment.md +++ b/docs/examples/functions/create-template-deployment.md @@ -1,3 +1,4 @@ +```php createTemplateDeployment( type: TemplateReferenceType::COMMIT(), reference: '', activate: false // optional -); \ No newline at end of file +);``` diff --git a/docs/examples/functions/create-variable.md b/docs/examples/functions/create-variable.md index ec470d54..d860cb32 100644 --- a/docs/examples/functions/create-variable.md +++ b/docs/examples/functions/create-variable.md @@ -1,3 +1,4 @@ +```php createVariable( key: '', value: '', secret: false // optional -); \ No newline at end of file +);``` diff --git a/docs/examples/functions/create-vcs-deployment.md b/docs/examples/functions/create-vcs-deployment.md index f0442195..5ccab950 100644 --- a/docs/examples/functions/create-vcs-deployment.md +++ b/docs/examples/functions/create-vcs-deployment.md @@ -1,3 +1,4 @@ +```php createVcsDeployment( type: VCSReferenceType::BRANCH(), reference: '', activate: false // optional -); \ No newline at end of file +);``` diff --git a/docs/examples/functions/create.md b/docs/examples/functions/create.md index 0504e733..e921e999 100644 --- a/docs/examples/functions/create.md +++ b/docs/examples/functions/create.md @@ -1,3 +1,4 @@ +```php create( providerSilentMode: false, // optional providerRootDirectory: '', // optional specification: '' // optional -); \ No newline at end of file +);``` diff --git a/docs/examples/functions/delete-deployment.md b/docs/examples/functions/delete-deployment.md index 20285d76..96e78e3b 100644 --- a/docs/examples/functions/delete-deployment.md +++ b/docs/examples/functions/delete-deployment.md @@ -1,3 +1,4 @@ +```php deleteDeployment( functionId: '', deploymentId: '' -); \ No newline at end of file +);``` diff --git a/docs/examples/functions/delete-execution.md b/docs/examples/functions/delete-execution.md index e55a8b18..e95d2f70 100644 --- a/docs/examples/functions/delete-execution.md +++ b/docs/examples/functions/delete-execution.md @@ -1,3 +1,4 @@ +```php deleteExecution( functionId: '', executionId: '' -); \ No newline at end of file +);``` diff --git a/docs/examples/functions/delete-variable.md b/docs/examples/functions/delete-variable.md index e1fb391d..9be2e174 100644 --- a/docs/examples/functions/delete-variable.md +++ b/docs/examples/functions/delete-variable.md @@ -1,3 +1,4 @@ +```php deleteVariable( functionId: '', variableId: '' -); \ No newline at end of file +);``` diff --git a/docs/examples/functions/delete.md b/docs/examples/functions/delete.md index 9f87f5c9..d718bfbf 100644 --- a/docs/examples/functions/delete.md +++ b/docs/examples/functions/delete.md @@ -1,3 +1,4 @@ +```php delete( functionId: '' -); \ No newline at end of file +);``` diff --git a/docs/examples/functions/get-deployment-download.md b/docs/examples/functions/get-deployment-download.md index a06f97b6..73842f54 100644 --- a/docs/examples/functions/get-deployment-download.md +++ b/docs/examples/functions/get-deployment-download.md @@ -1,3 +1,4 @@ +```php getDeploymentDownload( functionId: '', deploymentId: '', type: DeploymentDownloadType::SOURCE() // optional -); \ No newline at end of file +);``` diff --git a/docs/examples/functions/get-deployment.md b/docs/examples/functions/get-deployment.md index 945933b2..f8d4a26e 100644 --- a/docs/examples/functions/get-deployment.md +++ b/docs/examples/functions/get-deployment.md @@ -1,3 +1,4 @@ +```php getDeployment( functionId: '', deploymentId: '' -); \ No newline at end of file +);``` diff --git a/docs/examples/functions/get-execution.md b/docs/examples/functions/get-execution.md index 7dfeeed0..f647a7fd 100644 --- a/docs/examples/functions/get-execution.md +++ b/docs/examples/functions/get-execution.md @@ -1,3 +1,4 @@ +```php getExecution( functionId: '', executionId: '' -); \ No newline at end of file +);``` diff --git a/docs/examples/functions/get-variable.md b/docs/examples/functions/get-variable.md index 4c8d3d6b..8d408643 100644 --- a/docs/examples/functions/get-variable.md +++ b/docs/examples/functions/get-variable.md @@ -1,3 +1,4 @@ +```php getVariable( functionId: '', variableId: '' -); \ No newline at end of file +);``` diff --git a/docs/examples/functions/get.md b/docs/examples/functions/get.md index ca2160f6..e5997ee2 100644 --- a/docs/examples/functions/get.md +++ b/docs/examples/functions/get.md @@ -1,3 +1,4 @@ +```php get( functionId: '' -); \ No newline at end of file +);``` diff --git a/docs/examples/functions/list-deployments.md b/docs/examples/functions/list-deployments.md index bf903185..bc46662a 100644 --- a/docs/examples/functions/list-deployments.md +++ b/docs/examples/functions/list-deployments.md @@ -1,3 +1,4 @@ +```php listDeployments( queries: [], // optional search: '', // optional total: false // optional -); \ No newline at end of file +);``` diff --git a/docs/examples/functions/list-executions.md b/docs/examples/functions/list-executions.md index 4a7c79cc..9948e862 100644 --- a/docs/examples/functions/list-executions.md +++ b/docs/examples/functions/list-executions.md @@ -1,3 +1,4 @@ +```php listExecutions( functionId: '', queries: [], // optional total: false // optional -); \ No newline at end of file +);``` diff --git a/docs/examples/functions/list-runtimes.md b/docs/examples/functions/list-runtimes.md index 6c77c426..320a9dc6 100644 --- a/docs/examples/functions/list-runtimes.md +++ b/docs/examples/functions/list-runtimes.md @@ -1,3 +1,4 @@ +```php listRuntimes(); +``` diff --git a/docs/examples/functions/list-specifications.md b/docs/examples/functions/list-specifications.md index eec5c33c..f5afe80b 100644 --- a/docs/examples/functions/list-specifications.md +++ b/docs/examples/functions/list-specifications.md @@ -1,3 +1,4 @@ +```php listSpecifications(); +``` diff --git a/docs/examples/functions/list-variables.md b/docs/examples/functions/list-variables.md index f85e8549..8867ad6c 100644 --- a/docs/examples/functions/list-variables.md +++ b/docs/examples/functions/list-variables.md @@ -1,3 +1,4 @@ +```php listVariables( functionId: '' -); \ No newline at end of file +);``` diff --git a/docs/examples/functions/list.md b/docs/examples/functions/list.md index 1646a06b..2dc45db0 100644 --- a/docs/examples/functions/list.md +++ b/docs/examples/functions/list.md @@ -1,3 +1,4 @@ +```php list( queries: [], // optional search: '', // optional total: false // optional -); \ No newline at end of file +);``` diff --git a/docs/examples/functions/update-deployment-status.md b/docs/examples/functions/update-deployment-status.md index de36d4e8..311645e5 100644 --- a/docs/examples/functions/update-deployment-status.md +++ b/docs/examples/functions/update-deployment-status.md @@ -1,3 +1,4 @@ +```php updateDeploymentStatus( functionId: '', deploymentId: '' -); \ No newline at end of file +);``` diff --git a/docs/examples/functions/update-function-deployment.md b/docs/examples/functions/update-function-deployment.md index 38ba026b..b1c0edb7 100644 --- a/docs/examples/functions/update-function-deployment.md +++ b/docs/examples/functions/update-function-deployment.md @@ -1,3 +1,4 @@ +```php updateFunctionDeployment( functionId: '', deploymentId: '' -); \ No newline at end of file +);``` diff --git a/docs/examples/functions/update-variable.md b/docs/examples/functions/update-variable.md index b15597a6..3a280697 100644 --- a/docs/examples/functions/update-variable.md +++ b/docs/examples/functions/update-variable.md @@ -1,3 +1,4 @@ +```php updateVariable( key: '', value: '', // optional secret: false // optional -); \ No newline at end of file +);``` diff --git a/docs/examples/functions/update.md b/docs/examples/functions/update.md index 1c3ff548..f9bdac11 100644 --- a/docs/examples/functions/update.md +++ b/docs/examples/functions/update.md @@ -1,3 +1,4 @@ +```php update( providerSilentMode: false, // optional providerRootDirectory: '', // optional specification: '' // optional -); \ No newline at end of file +);``` diff --git a/docs/examples/graphql/mutation.md b/docs/examples/graphql/mutation.md index c349bc2d..1e25bf73 100644 --- a/docs/examples/graphql/mutation.md +++ b/docs/examples/graphql/mutation.md @@ -1,3 +1,4 @@ +```php mutation( query: [] -); \ No newline at end of file +);``` diff --git a/docs/examples/graphql/query.md b/docs/examples/graphql/query.md index e6e277c2..90979942 100644 --- a/docs/examples/graphql/query.md +++ b/docs/examples/graphql/query.md @@ -1,3 +1,4 @@ +```php query( query: [] -); \ No newline at end of file +);``` diff --git a/docs/examples/health/get-antivirus.md b/docs/examples/health/get-antivirus.md index 47210646..7f57d8aa 100644 --- a/docs/examples/health/get-antivirus.md +++ b/docs/examples/health/get-antivirus.md @@ -1,3 +1,4 @@ +```php getAntivirus(); +``` diff --git a/docs/examples/health/get-cache.md b/docs/examples/health/get-cache.md index 2e81dae3..8443c64f 100644 --- a/docs/examples/health/get-cache.md +++ b/docs/examples/health/get-cache.md @@ -1,3 +1,4 @@ +```php getCache(); +``` diff --git a/docs/examples/health/get-certificate.md b/docs/examples/health/get-certificate.md index 408581be..d1d1fd1e 100644 --- a/docs/examples/health/get-certificate.md +++ b/docs/examples/health/get-certificate.md @@ -1,3 +1,4 @@ +```php getCertificate( domain: '' // optional -); \ No newline at end of file +);``` diff --git a/docs/examples/health/get-db.md b/docs/examples/health/get-db.md index cfec70e6..1682bcf3 100644 --- a/docs/examples/health/get-db.md +++ b/docs/examples/health/get-db.md @@ -1,3 +1,4 @@ +```php getDB(); +``` diff --git a/docs/examples/health/get-failed-jobs.md b/docs/examples/health/get-failed-jobs.md index 63bc1c83..85867635 100644 --- a/docs/examples/health/get-failed-jobs.md +++ b/docs/examples/health/get-failed-jobs.md @@ -1,3 +1,4 @@ +```php getFailedJobs( name: Name::V1DATABASE(), threshold: null // optional -); \ No newline at end of file +);``` diff --git a/docs/examples/health/get-pub-sub.md b/docs/examples/health/get-pub-sub.md index 1c346caa..97dc4b6f 100644 --- a/docs/examples/health/get-pub-sub.md +++ b/docs/examples/health/get-pub-sub.md @@ -1,3 +1,4 @@ +```php getPubSub(); +``` diff --git a/docs/examples/health/get-queue-audits.md b/docs/examples/health/get-queue-audits.md index cd51345c..2bfc32e8 100644 --- a/docs/examples/health/get-queue-audits.md +++ b/docs/examples/health/get-queue-audits.md @@ -1,3 +1,4 @@ +```php getQueueAudits( threshold: null // optional -); \ No newline at end of file +);``` diff --git a/docs/examples/health/get-queue-billing-project-aggregation.md b/docs/examples/health/get-queue-billing-project-aggregation.md new file mode 100644 index 00000000..e04fc2e5 --- /dev/null +++ b/docs/examples/health/get-queue-billing-project-aggregation.md @@ -0,0 +1,16 @@ +```php +setEndpoint('https://.cloud.appwrite.io/v1') // Your API Endpoint + ->setProject('') // Your project ID + ->setKey(''); // Your secret API key + +$health = new Health($client); + +$result = $health->getQueueBillingProjectAggregation( + threshold: null // optional +);``` diff --git a/docs/examples/health/get-queue-billing-team-aggregation.md b/docs/examples/health/get-queue-billing-team-aggregation.md new file mode 100644 index 00000000..37fa4d2c --- /dev/null +++ b/docs/examples/health/get-queue-billing-team-aggregation.md @@ -0,0 +1,16 @@ +```php +setEndpoint('https://.cloud.appwrite.io/v1') // Your API Endpoint + ->setProject('') // Your project ID + ->setKey(''); // Your secret API key + +$health = new Health($client); + +$result = $health->getQueueBillingTeamAggregation( + threshold: null // optional +);``` diff --git a/docs/examples/health/get-queue-builds.md b/docs/examples/health/get-queue-builds.md index 8c1f7743..607acb20 100644 --- a/docs/examples/health/get-queue-builds.md +++ b/docs/examples/health/get-queue-builds.md @@ -1,3 +1,4 @@ +```php getQueueBuilds( threshold: null // optional -); \ No newline at end of file +);``` diff --git a/docs/examples/health/get-queue-certificates.md b/docs/examples/health/get-queue-certificates.md index 92fb79a9..d70b6574 100644 --- a/docs/examples/health/get-queue-certificates.md +++ b/docs/examples/health/get-queue-certificates.md @@ -1,3 +1,4 @@ +```php getQueueCertificates( threshold: null // optional -); \ No newline at end of file +);``` diff --git a/docs/examples/health/get-queue-databases.md b/docs/examples/health/get-queue-databases.md index 745b4694..96bfb6fd 100644 --- a/docs/examples/health/get-queue-databases.md +++ b/docs/examples/health/get-queue-databases.md @@ -1,3 +1,4 @@ +```php getQueueDatabases( name: '', // optional threshold: null // optional -); \ No newline at end of file +);``` diff --git a/docs/examples/health/get-queue-deletes.md b/docs/examples/health/get-queue-deletes.md index d3952685..2b147f42 100644 --- a/docs/examples/health/get-queue-deletes.md +++ b/docs/examples/health/get-queue-deletes.md @@ -1,3 +1,4 @@ +```php getQueueDeletes( threshold: null // optional -); \ No newline at end of file +);``` diff --git a/docs/examples/health/get-queue-functions.md b/docs/examples/health/get-queue-functions.md index 1a5bea2b..d5b58442 100644 --- a/docs/examples/health/get-queue-functions.md +++ b/docs/examples/health/get-queue-functions.md @@ -1,3 +1,4 @@ +```php getQueueFunctions( threshold: null // optional -); \ No newline at end of file +);``` diff --git a/docs/examples/health/get-queue-logs.md b/docs/examples/health/get-queue-logs.md index cf5e3b9d..cb0125cb 100644 --- a/docs/examples/health/get-queue-logs.md +++ b/docs/examples/health/get-queue-logs.md @@ -1,3 +1,4 @@ +```php getQueueLogs( threshold: null // optional -); \ No newline at end of file +);``` diff --git a/docs/examples/health/get-queue-mails.md b/docs/examples/health/get-queue-mails.md index 132dfa68..56babd6c 100644 --- a/docs/examples/health/get-queue-mails.md +++ b/docs/examples/health/get-queue-mails.md @@ -1,3 +1,4 @@ +```php getQueueMails( threshold: null // optional -); \ No newline at end of file +);``` diff --git a/docs/examples/health/get-queue-messaging.md b/docs/examples/health/get-queue-messaging.md index fd5fdb1e..4539c5d9 100644 --- a/docs/examples/health/get-queue-messaging.md +++ b/docs/examples/health/get-queue-messaging.md @@ -1,3 +1,4 @@ +```php getQueueMessaging( threshold: null // optional -); \ No newline at end of file +);``` diff --git a/docs/examples/health/get-queue-migrations.md b/docs/examples/health/get-queue-migrations.md index 68110189..36b8d4b4 100644 --- a/docs/examples/health/get-queue-migrations.md +++ b/docs/examples/health/get-queue-migrations.md @@ -1,3 +1,4 @@ +```php getQueueMigrations( threshold: null // optional -); \ No newline at end of file +);``` diff --git a/docs/examples/health/get-queue-priority-builds.md b/docs/examples/health/get-queue-priority-builds.md new file mode 100644 index 00000000..b7a97a53 --- /dev/null +++ b/docs/examples/health/get-queue-priority-builds.md @@ -0,0 +1,16 @@ +```php +setEndpoint('https://.cloud.appwrite.io/v1') // Your API Endpoint + ->setProject('') // Your project ID + ->setKey(''); // Your secret API key + +$health = new Health($client); + +$result = $health->getQueuePriorityBuilds( + threshold: null // optional +);``` diff --git a/docs/examples/health/get-queue-region-manager.md b/docs/examples/health/get-queue-region-manager.md new file mode 100644 index 00000000..11b63f70 --- /dev/null +++ b/docs/examples/health/get-queue-region-manager.md @@ -0,0 +1,16 @@ +```php +setEndpoint('https://.cloud.appwrite.io/v1') // Your API Endpoint + ->setProject('') // Your project ID + ->setKey(''); // Your secret API key + +$health = new Health($client); + +$result = $health->getQueueRegionManager( + threshold: null // optional +);``` diff --git a/docs/examples/health/get-queue-stats-resources.md b/docs/examples/health/get-queue-stats-resources.md index d0bd6c05..da4cee7a 100644 --- a/docs/examples/health/get-queue-stats-resources.md +++ b/docs/examples/health/get-queue-stats-resources.md @@ -1,3 +1,4 @@ +```php getQueueStatsResources( threshold: null // optional -); \ No newline at end of file +);``` diff --git a/docs/examples/health/get-queue-threats.md b/docs/examples/health/get-queue-threats.md new file mode 100644 index 00000000..8ccfb0d6 --- /dev/null +++ b/docs/examples/health/get-queue-threats.md @@ -0,0 +1,16 @@ +```php +setEndpoint('https://.cloud.appwrite.io/v1') // Your API Endpoint + ->setProject('') // Your project ID + ->setKey(''); // Your secret API key + +$health = new Health($client); + +$result = $health->getQueueThreats( + threshold: null // optional +);``` diff --git a/docs/examples/health/get-queue-usage.md b/docs/examples/health/get-queue-usage.md index 627a85c8..dd35802b 100644 --- a/docs/examples/health/get-queue-usage.md +++ b/docs/examples/health/get-queue-usage.md @@ -1,3 +1,4 @@ +```php getQueueUsage( threshold: null // optional -); \ No newline at end of file +);``` diff --git a/docs/examples/health/get-queue-webhooks.md b/docs/examples/health/get-queue-webhooks.md index d6ccd7cd..d2877ce6 100644 --- a/docs/examples/health/get-queue-webhooks.md +++ b/docs/examples/health/get-queue-webhooks.md @@ -1,3 +1,4 @@ +```php getQueueWebhooks( threshold: null // optional -); \ No newline at end of file +);``` diff --git a/docs/examples/health/get-storage-local.md b/docs/examples/health/get-storage-local.md index 041d2495..d7524bad 100644 --- a/docs/examples/health/get-storage-local.md +++ b/docs/examples/health/get-storage-local.md @@ -1,3 +1,4 @@ +```php getStorageLocal(); +``` diff --git a/docs/examples/health/get-storage.md b/docs/examples/health/get-storage.md index 377416ed..2a109dec 100644 --- a/docs/examples/health/get-storage.md +++ b/docs/examples/health/get-storage.md @@ -1,3 +1,4 @@ +```php getStorage(); +``` diff --git a/docs/examples/health/get-time.md b/docs/examples/health/get-time.md index aa269934..559b1797 100644 --- a/docs/examples/health/get-time.md +++ b/docs/examples/health/get-time.md @@ -1,3 +1,4 @@ +```php getTime(); +``` diff --git a/docs/examples/health/get.md b/docs/examples/health/get.md index fec3e3f4..4b46ac2c 100644 --- a/docs/examples/health/get.md +++ b/docs/examples/health/get.md @@ -1,3 +1,4 @@ +```php get(); +``` diff --git a/docs/examples/locale/get.md b/docs/examples/locale/get.md index ef4c0432..8b204573 100644 --- a/docs/examples/locale/get.md +++ b/docs/examples/locale/get.md @@ -1,3 +1,4 @@ +```php get(); +``` diff --git a/docs/examples/locale/list-codes.md b/docs/examples/locale/list-codes.md index 273fad08..5c99bbf2 100644 --- a/docs/examples/locale/list-codes.md +++ b/docs/examples/locale/list-codes.md @@ -1,3 +1,4 @@ +```php listCodes(); +``` diff --git a/docs/examples/locale/list-continents.md b/docs/examples/locale/list-continents.md index e8c7ca46..1245b2ec 100644 --- a/docs/examples/locale/list-continents.md +++ b/docs/examples/locale/list-continents.md @@ -1,3 +1,4 @@ +```php listContinents(); +``` diff --git a/docs/examples/locale/list-countries-eu.md b/docs/examples/locale/list-countries-eu.md index c5dd1d2a..9744c8ea 100644 --- a/docs/examples/locale/list-countries-eu.md +++ b/docs/examples/locale/list-countries-eu.md @@ -1,3 +1,4 @@ +```php listCountriesEU(); +``` diff --git a/docs/examples/locale/list-countries-phones.md b/docs/examples/locale/list-countries-phones.md index 7585c107..df66061f 100644 --- a/docs/examples/locale/list-countries-phones.md +++ b/docs/examples/locale/list-countries-phones.md @@ -1,3 +1,4 @@ +```php listCountriesPhones(); +``` diff --git a/docs/examples/locale/list-countries.md b/docs/examples/locale/list-countries.md index 63a2e0b5..f4f96262 100644 --- a/docs/examples/locale/list-countries.md +++ b/docs/examples/locale/list-countries.md @@ -1,3 +1,4 @@ +```php listCountries(); +``` diff --git a/docs/examples/locale/list-currencies.md b/docs/examples/locale/list-currencies.md index d385018e..f4f1125a 100644 --- a/docs/examples/locale/list-currencies.md +++ b/docs/examples/locale/list-currencies.md @@ -1,3 +1,4 @@ +```php listCurrencies(); +``` diff --git a/docs/examples/locale/list-languages.md b/docs/examples/locale/list-languages.md index f0ca4d4f..b25fab64 100644 --- a/docs/examples/locale/list-languages.md +++ b/docs/examples/locale/list-languages.md @@ -1,3 +1,4 @@ +```php listLanguages(); +``` diff --git a/docs/examples/messaging/create-apns-provider.md b/docs/examples/messaging/create-apns-provider.md index 2ce4b7f9..768878ac 100644 --- a/docs/examples/messaging/create-apns-provider.md +++ b/docs/examples/messaging/create-apns-provider.md @@ -1,3 +1,4 @@ +```php createAPNSProvider( bundleId: '', // optional sandbox: false, // optional enabled: false // optional -); \ No newline at end of file +);``` diff --git a/docs/examples/messaging/create-email.md b/docs/examples/messaging/create-email.md index 9de24873..68f46f9e 100644 --- a/docs/examples/messaging/create-email.md +++ b/docs/examples/messaging/create-email.md @@ -1,3 +1,4 @@ +```php createEmail( draft: false, // optional html: false, // optional scheduledAt: '' // optional -); \ No newline at end of file +);``` diff --git a/docs/examples/messaging/create-fcm-provider.md b/docs/examples/messaging/create-fcm-provider.md index 8037c231..1ab3e983 100644 --- a/docs/examples/messaging/create-fcm-provider.md +++ b/docs/examples/messaging/create-fcm-provider.md @@ -1,3 +1,4 @@ +```php createFCMProvider( name: '', serviceAccountJSON: [], // optional enabled: false // optional -); \ No newline at end of file +);``` diff --git a/docs/examples/messaging/create-mailgun-provider.md b/docs/examples/messaging/create-mailgun-provider.md index 6c62ee88..ca0a3cb1 100644 --- a/docs/examples/messaging/create-mailgun-provider.md +++ b/docs/examples/messaging/create-mailgun-provider.md @@ -1,3 +1,4 @@ +```php createMailgunProvider( replyToName: '', // optional replyToEmail: 'email@example.com', // optional enabled: false // optional -); \ No newline at end of file +);``` diff --git a/docs/examples/messaging/create-msg-91-provider.md b/docs/examples/messaging/create-msg-91-provider.md index 1eb954a2..78998cf5 100644 --- a/docs/examples/messaging/create-msg-91-provider.md +++ b/docs/examples/messaging/create-msg-91-provider.md @@ -1,3 +1,4 @@ +```php createMsg91Provider( senderId: '', // optional authKey: '', // optional enabled: false // optional -); \ No newline at end of file +);``` diff --git a/docs/examples/messaging/create-push.md b/docs/examples/messaging/create-push.md index 614c758c..2673d48b 100644 --- a/docs/examples/messaging/create-push.md +++ b/docs/examples/messaging/create-push.md @@ -1,3 +1,4 @@ +```php createPush( contentAvailable: false, // optional critical: false, // optional priority: MessagePriority::NORMAL() // optional -); \ No newline at end of file +);``` diff --git a/docs/examples/messaging/create-resend-provider.md b/docs/examples/messaging/create-resend-provider.md index e66b0b82..e32ad9fc 100644 --- a/docs/examples/messaging/create-resend-provider.md +++ b/docs/examples/messaging/create-resend-provider.md @@ -1,3 +1,4 @@ +```php createResendProvider( replyToName: '', // optional replyToEmail: 'email@example.com', // optional enabled: false // optional -); \ No newline at end of file +);``` diff --git a/docs/examples/messaging/create-sendgrid-provider.md b/docs/examples/messaging/create-sendgrid-provider.md index 892d8563..38f213c4 100644 --- a/docs/examples/messaging/create-sendgrid-provider.md +++ b/docs/examples/messaging/create-sendgrid-provider.md @@ -1,3 +1,4 @@ +```php createSendgridProvider( replyToName: '', // optional replyToEmail: 'email@example.com', // optional enabled: false // optional -); \ No newline at end of file +);``` diff --git a/docs/examples/messaging/create-sms.md b/docs/examples/messaging/create-sms.md index 50623b5b..5f946dbc 100644 --- a/docs/examples/messaging/create-sms.md +++ b/docs/examples/messaging/create-sms.md @@ -1,3 +1,4 @@ +```php createSMS( targets: [], // optional draft: false, // optional scheduledAt: '' // optional -); \ No newline at end of file +);``` diff --git a/docs/examples/messaging/create-smtp-provider.md b/docs/examples/messaging/create-smtp-provider.md index 953bbcf4..05386125 100644 --- a/docs/examples/messaging/create-smtp-provider.md +++ b/docs/examples/messaging/create-smtp-provider.md @@ -1,3 +1,4 @@ +```php createSMTPProvider( replyToName: '', // optional replyToEmail: 'email@example.com', // optional enabled: false // optional -); \ No newline at end of file +);``` diff --git a/docs/examples/messaging/create-subscriber.md b/docs/examples/messaging/create-subscriber.md index 3516fa3d..f0d27831 100644 --- a/docs/examples/messaging/create-subscriber.md +++ b/docs/examples/messaging/create-subscriber.md @@ -1,3 +1,4 @@ +```php createSubscriber( topicId: '', subscriberId: '', targetId: '' -); \ No newline at end of file +);``` diff --git a/docs/examples/messaging/create-telesign-provider.md b/docs/examples/messaging/create-telesign-provider.md index 90069180..005e6d03 100644 --- a/docs/examples/messaging/create-telesign-provider.md +++ b/docs/examples/messaging/create-telesign-provider.md @@ -1,3 +1,4 @@ +```php createTelesignProvider( customerId: '', // optional apiKey: '', // optional enabled: false // optional -); \ No newline at end of file +);``` diff --git a/docs/examples/messaging/create-textmagic-provider.md b/docs/examples/messaging/create-textmagic-provider.md index 5215d526..262a9e2a 100644 --- a/docs/examples/messaging/create-textmagic-provider.md +++ b/docs/examples/messaging/create-textmagic-provider.md @@ -1,3 +1,4 @@ +```php createTextmagicProvider( username: '', // optional apiKey: '', // optional enabled: false // optional -); \ No newline at end of file +);``` diff --git a/docs/examples/messaging/create-topic.md b/docs/examples/messaging/create-topic.md index e94141cc..460168e4 100644 --- a/docs/examples/messaging/create-topic.md +++ b/docs/examples/messaging/create-topic.md @@ -1,3 +1,4 @@ +```php createTopic( topicId: '', name: '', subscribe: ["any"] // optional -); \ No newline at end of file +);``` diff --git a/docs/examples/messaging/create-twilio-provider.md b/docs/examples/messaging/create-twilio-provider.md index c3568286..f8ee4175 100644 --- a/docs/examples/messaging/create-twilio-provider.md +++ b/docs/examples/messaging/create-twilio-provider.md @@ -1,3 +1,4 @@ +```php createTwilioProvider( accountSid: '', // optional authToken: '', // optional enabled: false // optional -); \ No newline at end of file +);``` diff --git a/docs/examples/messaging/create-vonage-provider.md b/docs/examples/messaging/create-vonage-provider.md index adeacbc4..450cf9c5 100644 --- a/docs/examples/messaging/create-vonage-provider.md +++ b/docs/examples/messaging/create-vonage-provider.md @@ -1,3 +1,4 @@ +```php createVonageProvider( apiKey: '', // optional apiSecret: '', // optional enabled: false // optional -); \ No newline at end of file +);``` diff --git a/docs/examples/messaging/delete-provider.md b/docs/examples/messaging/delete-provider.md index f37d18b4..e0a63c15 100644 --- a/docs/examples/messaging/delete-provider.md +++ b/docs/examples/messaging/delete-provider.md @@ -1,3 +1,4 @@ +```php deleteProvider( providerId: '' -); \ No newline at end of file +);``` diff --git a/docs/examples/messaging/delete-subscriber.md b/docs/examples/messaging/delete-subscriber.md index f7a84259..9720ad07 100644 --- a/docs/examples/messaging/delete-subscriber.md +++ b/docs/examples/messaging/delete-subscriber.md @@ -1,3 +1,4 @@ +```php deleteSubscriber( topicId: '', subscriberId: '' -); \ No newline at end of file +);``` diff --git a/docs/examples/messaging/delete-topic.md b/docs/examples/messaging/delete-topic.md index 2ec899b1..90614515 100644 --- a/docs/examples/messaging/delete-topic.md +++ b/docs/examples/messaging/delete-topic.md @@ -1,3 +1,4 @@ +```php deleteTopic( topicId: '' -); \ No newline at end of file +);``` diff --git a/docs/examples/messaging/delete.md b/docs/examples/messaging/delete.md index 5781838b..15489058 100644 --- a/docs/examples/messaging/delete.md +++ b/docs/examples/messaging/delete.md @@ -1,3 +1,4 @@ +```php delete( messageId: '' -); \ No newline at end of file +);``` diff --git a/docs/examples/messaging/get-message.md b/docs/examples/messaging/get-message.md index cf922219..a1d2f026 100644 --- a/docs/examples/messaging/get-message.md +++ b/docs/examples/messaging/get-message.md @@ -1,3 +1,4 @@ +```php getMessage( messageId: '' -); \ No newline at end of file +);``` diff --git a/docs/examples/messaging/get-provider.md b/docs/examples/messaging/get-provider.md index d19f5c65..6353e54f 100644 --- a/docs/examples/messaging/get-provider.md +++ b/docs/examples/messaging/get-provider.md @@ -1,3 +1,4 @@ +```php getProvider( providerId: '' -); \ No newline at end of file +);``` diff --git a/docs/examples/messaging/get-subscriber.md b/docs/examples/messaging/get-subscriber.md index e2a0d7ef..d3a20e95 100644 --- a/docs/examples/messaging/get-subscriber.md +++ b/docs/examples/messaging/get-subscriber.md @@ -1,3 +1,4 @@ +```php getSubscriber( topicId: '', subscriberId: '' -); \ No newline at end of file +);``` diff --git a/docs/examples/messaging/get-topic.md b/docs/examples/messaging/get-topic.md index fc06cbbc..95ff3ff7 100644 --- a/docs/examples/messaging/get-topic.md +++ b/docs/examples/messaging/get-topic.md @@ -1,3 +1,4 @@ +```php getTopic( topicId: '' -); \ No newline at end of file +);``` diff --git a/docs/examples/messaging/list-message-logs.md b/docs/examples/messaging/list-message-logs.md index 4e0ab3ea..8bc5631c 100644 --- a/docs/examples/messaging/list-message-logs.md +++ b/docs/examples/messaging/list-message-logs.md @@ -1,3 +1,4 @@ +```php listMessageLogs( messageId: '', queries: [], // optional total: false // optional -); \ No newline at end of file +);``` diff --git a/docs/examples/messaging/list-messages.md b/docs/examples/messaging/list-messages.md index d66c64f5..fa6d57c3 100644 --- a/docs/examples/messaging/list-messages.md +++ b/docs/examples/messaging/list-messages.md @@ -1,3 +1,4 @@ +```php listMessages( queries: [], // optional search: '', // optional total: false // optional -); \ No newline at end of file +);``` diff --git a/docs/examples/messaging/list-provider-logs.md b/docs/examples/messaging/list-provider-logs.md index 8c8d7f1f..afc3df91 100644 --- a/docs/examples/messaging/list-provider-logs.md +++ b/docs/examples/messaging/list-provider-logs.md @@ -1,3 +1,4 @@ +```php listProviderLogs( providerId: '', queries: [], // optional total: false // optional -); \ No newline at end of file +);``` diff --git a/docs/examples/messaging/list-providers.md b/docs/examples/messaging/list-providers.md index da0910ec..281a5220 100644 --- a/docs/examples/messaging/list-providers.md +++ b/docs/examples/messaging/list-providers.md @@ -1,3 +1,4 @@ +```php listProviders( queries: [], // optional search: '', // optional total: false // optional -); \ No newline at end of file +);``` diff --git a/docs/examples/messaging/list-subscriber-logs.md b/docs/examples/messaging/list-subscriber-logs.md index 9e453a24..7a0e5ad7 100644 --- a/docs/examples/messaging/list-subscriber-logs.md +++ b/docs/examples/messaging/list-subscriber-logs.md @@ -1,3 +1,4 @@ +```php listSubscriberLogs( subscriberId: '', queries: [], // optional total: false // optional -); \ No newline at end of file +);``` diff --git a/docs/examples/messaging/list-subscribers.md b/docs/examples/messaging/list-subscribers.md index f21c788e..096a8f2e 100644 --- a/docs/examples/messaging/list-subscribers.md +++ b/docs/examples/messaging/list-subscribers.md @@ -1,3 +1,4 @@ +```php listSubscribers( queries: [], // optional search: '', // optional total: false // optional -); \ No newline at end of file +);``` diff --git a/docs/examples/messaging/list-targets.md b/docs/examples/messaging/list-targets.md index 03ffdbb2..0615d820 100644 --- a/docs/examples/messaging/list-targets.md +++ b/docs/examples/messaging/list-targets.md @@ -1,3 +1,4 @@ +```php listTargets( messageId: '', queries: [], // optional total: false // optional -); \ No newline at end of file +);``` diff --git a/docs/examples/messaging/list-topic-logs.md b/docs/examples/messaging/list-topic-logs.md index fae8eec9..d32d27ae 100644 --- a/docs/examples/messaging/list-topic-logs.md +++ b/docs/examples/messaging/list-topic-logs.md @@ -1,3 +1,4 @@ +```php listTopicLogs( topicId: '', queries: [], // optional total: false // optional -); \ No newline at end of file +);``` diff --git a/docs/examples/messaging/list-topics.md b/docs/examples/messaging/list-topics.md index b5d4c540..6386df17 100644 --- a/docs/examples/messaging/list-topics.md +++ b/docs/examples/messaging/list-topics.md @@ -1,3 +1,4 @@ +```php listTopics( queries: [], // optional search: '', // optional total: false // optional -); \ No newline at end of file +);``` diff --git a/docs/examples/messaging/update-apns-provider.md b/docs/examples/messaging/update-apns-provider.md index 161a1485..aa0e78f0 100644 --- a/docs/examples/messaging/update-apns-provider.md +++ b/docs/examples/messaging/update-apns-provider.md @@ -1,3 +1,4 @@ +```php updateAPNSProvider( teamId: '', // optional bundleId: '', // optional sandbox: false // optional -); \ No newline at end of file +);``` diff --git a/docs/examples/messaging/update-email.md b/docs/examples/messaging/update-email.md index dd0f645a..347f0306 100644 --- a/docs/examples/messaging/update-email.md +++ b/docs/examples/messaging/update-email.md @@ -1,3 +1,4 @@ +```php updateEmail( bcc: [], // optional scheduledAt: '', // optional attachments: [] // optional -); \ No newline at end of file +);``` diff --git a/docs/examples/messaging/update-fcm-provider.md b/docs/examples/messaging/update-fcm-provider.md index 0df2b93a..a9a54d1c 100644 --- a/docs/examples/messaging/update-fcm-provider.md +++ b/docs/examples/messaging/update-fcm-provider.md @@ -1,3 +1,4 @@ +```php updateFCMProvider( name: '', // optional enabled: false, // optional serviceAccountJSON: [] // optional -); \ No newline at end of file +);``` diff --git a/docs/examples/messaging/update-mailgun-provider.md b/docs/examples/messaging/update-mailgun-provider.md index c99ebc7d..6392e78b 100644 --- a/docs/examples/messaging/update-mailgun-provider.md +++ b/docs/examples/messaging/update-mailgun-provider.md @@ -1,3 +1,4 @@ +```php updateMailgunProvider( fromEmail: 'email@example.com', // optional replyToName: '', // optional replyToEmail: '' // optional -); \ No newline at end of file +);``` diff --git a/docs/examples/messaging/update-msg-91-provider.md b/docs/examples/messaging/update-msg-91-provider.md index f6f557cc..67b689c9 100644 --- a/docs/examples/messaging/update-msg-91-provider.md +++ b/docs/examples/messaging/update-msg-91-provider.md @@ -1,3 +1,4 @@ +```php updateMsg91Provider( templateId: '', // optional senderId: '', // optional authKey: '' // optional -); \ No newline at end of file +);``` diff --git a/docs/examples/messaging/update-push.md b/docs/examples/messaging/update-push.md index 0fea9a13..0b3f1bcb 100644 --- a/docs/examples/messaging/update-push.md +++ b/docs/examples/messaging/update-push.md @@ -1,3 +1,4 @@ +```php updatePush( contentAvailable: false, // optional critical: false, // optional priority: MessagePriority::NORMAL() // optional -); \ No newline at end of file +);``` diff --git a/docs/examples/messaging/update-resend-provider.md b/docs/examples/messaging/update-resend-provider.md index b3f1d1fd..ab60aaf3 100644 --- a/docs/examples/messaging/update-resend-provider.md +++ b/docs/examples/messaging/update-resend-provider.md @@ -1,3 +1,4 @@ +```php updateResendProvider( fromEmail: 'email@example.com', // optional replyToName: '', // optional replyToEmail: '' // optional -); \ No newline at end of file +);``` diff --git a/docs/examples/messaging/update-sendgrid-provider.md b/docs/examples/messaging/update-sendgrid-provider.md index b8473c16..e6e0391a 100644 --- a/docs/examples/messaging/update-sendgrid-provider.md +++ b/docs/examples/messaging/update-sendgrid-provider.md @@ -1,3 +1,4 @@ +```php updateSendgridProvider( fromEmail: 'email@example.com', // optional replyToName: '', // optional replyToEmail: '' // optional -); \ No newline at end of file +);``` diff --git a/docs/examples/messaging/update-sms.md b/docs/examples/messaging/update-sms.md index 92d3ebbe..3dc932ae 100644 --- a/docs/examples/messaging/update-sms.md +++ b/docs/examples/messaging/update-sms.md @@ -1,3 +1,4 @@ +```php updateSMS( content: '', // optional draft: false, // optional scheduledAt: '' // optional -); \ No newline at end of file +);``` diff --git a/docs/examples/messaging/update-smtp-provider.md b/docs/examples/messaging/update-smtp-provider.md index 495f3321..5701b3c2 100644 --- a/docs/examples/messaging/update-smtp-provider.md +++ b/docs/examples/messaging/update-smtp-provider.md @@ -1,3 +1,4 @@ +```php updateSMTPProvider( replyToName: '', // optional replyToEmail: '', // optional enabled: false // optional -); \ No newline at end of file +);``` diff --git a/docs/examples/messaging/update-telesign-provider.md b/docs/examples/messaging/update-telesign-provider.md index 29a54bfa..33fcbb30 100644 --- a/docs/examples/messaging/update-telesign-provider.md +++ b/docs/examples/messaging/update-telesign-provider.md @@ -1,3 +1,4 @@ +```php updateTelesignProvider( customerId: '', // optional apiKey: '', // optional from: '' // optional -); \ No newline at end of file +);``` diff --git a/docs/examples/messaging/update-textmagic-provider.md b/docs/examples/messaging/update-textmagic-provider.md index e6a1ed1a..96564c70 100644 --- a/docs/examples/messaging/update-textmagic-provider.md +++ b/docs/examples/messaging/update-textmagic-provider.md @@ -1,3 +1,4 @@ +```php updateTextmagicProvider( username: '', // optional apiKey: '', // optional from: '' // optional -); \ No newline at end of file +);``` diff --git a/docs/examples/messaging/update-topic.md b/docs/examples/messaging/update-topic.md index b1f9a32e..257e7544 100644 --- a/docs/examples/messaging/update-topic.md +++ b/docs/examples/messaging/update-topic.md @@ -1,3 +1,4 @@ +```php updateTopic( topicId: '', name: '', // optional subscribe: ["any"] // optional -); \ No newline at end of file +);``` diff --git a/docs/examples/messaging/update-twilio-provider.md b/docs/examples/messaging/update-twilio-provider.md index def821ad..c9bcfa9b 100644 --- a/docs/examples/messaging/update-twilio-provider.md +++ b/docs/examples/messaging/update-twilio-provider.md @@ -1,3 +1,4 @@ +```php updateTwilioProvider( accountSid: '', // optional authToken: '', // optional from: '' // optional -); \ No newline at end of file +);``` diff --git a/docs/examples/messaging/update-vonage-provider.md b/docs/examples/messaging/update-vonage-provider.md index 0841e284..112745e7 100644 --- a/docs/examples/messaging/update-vonage-provider.md +++ b/docs/examples/messaging/update-vonage-provider.md @@ -1,3 +1,4 @@ +```php updateVonageProvider( apiKey: '', // optional apiSecret: '', // optional from: '' // optional -); \ No newline at end of file +);``` diff --git a/docs/examples/sites/create-deployment.md b/docs/examples/sites/create-deployment.md index 30770b78..c890f118 100644 --- a/docs/examples/sites/create-deployment.md +++ b/docs/examples/sites/create-deployment.md @@ -1,3 +1,4 @@ +```php createDeployment( installCommand: '', // optional buildCommand: '', // optional outputDirectory: '' // optional -); \ No newline at end of file +);``` diff --git a/docs/examples/sites/create-duplicate-deployment.md b/docs/examples/sites/create-duplicate-deployment.md index 84f65cd0..97fb1f5d 100644 --- a/docs/examples/sites/create-duplicate-deployment.md +++ b/docs/examples/sites/create-duplicate-deployment.md @@ -1,3 +1,4 @@ +```php createDuplicateDeployment( siteId: '', deploymentId: '' -); \ No newline at end of file +);``` diff --git a/docs/examples/sites/create-template-deployment.md b/docs/examples/sites/create-template-deployment.md index 1661bbb4..05f039e7 100644 --- a/docs/examples/sites/create-template-deployment.md +++ b/docs/examples/sites/create-template-deployment.md @@ -1,3 +1,4 @@ +```php createTemplateDeployment( type: TemplateReferenceType::BRANCH(), reference: '', activate: false // optional -); \ No newline at end of file +);``` diff --git a/docs/examples/sites/create-variable.md b/docs/examples/sites/create-variable.md index 3097e193..fee3ae9d 100644 --- a/docs/examples/sites/create-variable.md +++ b/docs/examples/sites/create-variable.md @@ -1,3 +1,4 @@ +```php createVariable( key: '', value: '', secret: false // optional -); \ No newline at end of file +);``` diff --git a/docs/examples/sites/create-vcs-deployment.md b/docs/examples/sites/create-vcs-deployment.md index 015bf09d..d01747bc 100644 --- a/docs/examples/sites/create-vcs-deployment.md +++ b/docs/examples/sites/create-vcs-deployment.md @@ -1,3 +1,4 @@ +```php createVcsDeployment( type: VCSReferenceType::BRANCH(), reference: '', activate: false // optional -); \ No newline at end of file +);``` diff --git a/docs/examples/sites/create.md b/docs/examples/sites/create.md index 6f1fc5ac..9191261f 100644 --- a/docs/examples/sites/create.md +++ b/docs/examples/sites/create.md @@ -1,3 +1,4 @@ +```php create( providerSilentMode: false, // optional providerRootDirectory: '', // optional specification: '' // optional -); \ No newline at end of file +);``` diff --git a/docs/examples/sites/delete-deployment.md b/docs/examples/sites/delete-deployment.md index 4e24748c..97bb976e 100644 --- a/docs/examples/sites/delete-deployment.md +++ b/docs/examples/sites/delete-deployment.md @@ -1,3 +1,4 @@ +```php deleteDeployment( siteId: '', deploymentId: '' -); \ No newline at end of file +);``` diff --git a/docs/examples/sites/delete-log.md b/docs/examples/sites/delete-log.md index b6e30643..ed5b3c5b 100644 --- a/docs/examples/sites/delete-log.md +++ b/docs/examples/sites/delete-log.md @@ -1,3 +1,4 @@ +```php deleteLog( siteId: '', logId: '' -); \ No newline at end of file +);``` diff --git a/docs/examples/sites/delete-variable.md b/docs/examples/sites/delete-variable.md index 66325430..bdb2fbf5 100644 --- a/docs/examples/sites/delete-variable.md +++ b/docs/examples/sites/delete-variable.md @@ -1,3 +1,4 @@ +```php deleteVariable( siteId: '', variableId: '' -); \ No newline at end of file +);``` diff --git a/docs/examples/sites/delete.md b/docs/examples/sites/delete.md index 8e6363aa..c2965d4e 100644 --- a/docs/examples/sites/delete.md +++ b/docs/examples/sites/delete.md @@ -1,3 +1,4 @@ +```php delete( siteId: '' -); \ No newline at end of file +);``` diff --git a/docs/examples/sites/get-deployment-download.md b/docs/examples/sites/get-deployment-download.md index 61fad0bd..5582e964 100644 --- a/docs/examples/sites/get-deployment-download.md +++ b/docs/examples/sites/get-deployment-download.md @@ -1,3 +1,4 @@ +```php getDeploymentDownload( siteId: '', deploymentId: '', type: DeploymentDownloadType::SOURCE() // optional -); \ No newline at end of file +);``` diff --git a/docs/examples/sites/get-deployment.md b/docs/examples/sites/get-deployment.md index 19525d92..91f83678 100644 --- a/docs/examples/sites/get-deployment.md +++ b/docs/examples/sites/get-deployment.md @@ -1,3 +1,4 @@ +```php getDeployment( siteId: '', deploymentId: '' -); \ No newline at end of file +);``` diff --git a/docs/examples/sites/get-log.md b/docs/examples/sites/get-log.md index 5ceb2b91..a781d20f 100644 --- a/docs/examples/sites/get-log.md +++ b/docs/examples/sites/get-log.md @@ -1,3 +1,4 @@ +```php getLog( siteId: '', logId: '' -); \ No newline at end of file +);``` diff --git a/docs/examples/sites/get-variable.md b/docs/examples/sites/get-variable.md index 0cab412b..80b61eca 100644 --- a/docs/examples/sites/get-variable.md +++ b/docs/examples/sites/get-variable.md @@ -1,3 +1,4 @@ +```php getVariable( siteId: '', variableId: '' -); \ No newline at end of file +);``` diff --git a/docs/examples/sites/get.md b/docs/examples/sites/get.md index e5ec061b..c8f8c8e2 100644 --- a/docs/examples/sites/get.md +++ b/docs/examples/sites/get.md @@ -1,3 +1,4 @@ +```php get( siteId: '' -); \ No newline at end of file +);``` diff --git a/docs/examples/sites/list-deployments.md b/docs/examples/sites/list-deployments.md index bb49a5a9..82cee298 100644 --- a/docs/examples/sites/list-deployments.md +++ b/docs/examples/sites/list-deployments.md @@ -1,3 +1,4 @@ +```php listDeployments( queries: [], // optional search: '', // optional total: false // optional -); \ No newline at end of file +);``` diff --git a/docs/examples/sites/list-frameworks.md b/docs/examples/sites/list-frameworks.md index 87df92d9..74ea8821 100644 --- a/docs/examples/sites/list-frameworks.md +++ b/docs/examples/sites/list-frameworks.md @@ -1,3 +1,4 @@ +```php listFrameworks(); +``` diff --git a/docs/examples/sites/list-logs.md b/docs/examples/sites/list-logs.md index 3bc45408..5626bbb1 100644 --- a/docs/examples/sites/list-logs.md +++ b/docs/examples/sites/list-logs.md @@ -1,3 +1,4 @@ +```php listLogs( siteId: '', queries: [], // optional total: false // optional -); \ No newline at end of file +);``` diff --git a/docs/examples/sites/list-specifications.md b/docs/examples/sites/list-specifications.md index 42dae1b7..1a732b6a 100644 --- a/docs/examples/sites/list-specifications.md +++ b/docs/examples/sites/list-specifications.md @@ -1,3 +1,4 @@ +```php listSpecifications(); +``` diff --git a/docs/examples/sites/list-variables.md b/docs/examples/sites/list-variables.md index 36aad640..7b7ab117 100644 --- a/docs/examples/sites/list-variables.md +++ b/docs/examples/sites/list-variables.md @@ -1,3 +1,4 @@ +```php listVariables( siteId: '' -); \ No newline at end of file +);``` diff --git a/docs/examples/sites/list.md b/docs/examples/sites/list.md index d056e8d9..08c13146 100644 --- a/docs/examples/sites/list.md +++ b/docs/examples/sites/list.md @@ -1,3 +1,4 @@ +```php list( queries: [], // optional search: '', // optional total: false // optional -); \ No newline at end of file +);``` diff --git a/docs/examples/sites/update-deployment-status.md b/docs/examples/sites/update-deployment-status.md index 2714b357..06ffc751 100644 --- a/docs/examples/sites/update-deployment-status.md +++ b/docs/examples/sites/update-deployment-status.md @@ -1,3 +1,4 @@ +```php updateDeploymentStatus( siteId: '', deploymentId: '' -); \ No newline at end of file +);``` diff --git a/docs/examples/sites/update-site-deployment.md b/docs/examples/sites/update-site-deployment.md index 6e2614cb..bdac54d4 100644 --- a/docs/examples/sites/update-site-deployment.md +++ b/docs/examples/sites/update-site-deployment.md @@ -1,3 +1,4 @@ +```php updateSiteDeployment( siteId: '', deploymentId: '' -); \ No newline at end of file +);``` diff --git a/docs/examples/sites/update-variable.md b/docs/examples/sites/update-variable.md index 84bafe28..96518754 100644 --- a/docs/examples/sites/update-variable.md +++ b/docs/examples/sites/update-variable.md @@ -1,3 +1,4 @@ +```php updateVariable( key: '', value: '', // optional secret: false // optional -); \ No newline at end of file +);``` diff --git a/docs/examples/sites/update.md b/docs/examples/sites/update.md index d2a6c9d2..42d24fb1 100644 --- a/docs/examples/sites/update.md +++ b/docs/examples/sites/update.md @@ -1,3 +1,4 @@ +```php update( providerSilentMode: false, // optional providerRootDirectory: '', // optional specification: '' // optional -); \ No newline at end of file +);``` diff --git a/docs/examples/storage/create-bucket.md b/docs/examples/storage/create-bucket.md index 31840957..f00c2c7f 100644 --- a/docs/examples/storage/create-bucket.md +++ b/docs/examples/storage/create-bucket.md @@ -1,3 +1,4 @@ +```php createBucket( encryption: false, // optional antivirus: false, // optional transformations: false // optional -); \ No newline at end of file +);``` diff --git a/docs/examples/storage/create-file.md b/docs/examples/storage/create-file.md index 33bef045..62301b10 100644 --- a/docs/examples/storage/create-file.md +++ b/docs/examples/storage/create-file.md @@ -1,3 +1,4 @@ +```php createFile( fileId: '', file: InputFile::withPath('file.png'), permissions: [Permission::read(Role::any())] // optional -); \ No newline at end of file +);``` diff --git a/docs/examples/storage/delete-bucket.md b/docs/examples/storage/delete-bucket.md index 50adf35b..737f4e1d 100644 --- a/docs/examples/storage/delete-bucket.md +++ b/docs/examples/storage/delete-bucket.md @@ -1,3 +1,4 @@ +```php deleteBucket( bucketId: '' -); \ No newline at end of file +);``` diff --git a/docs/examples/storage/delete-file.md b/docs/examples/storage/delete-file.md index d4c45eb6..dd2c3a70 100644 --- a/docs/examples/storage/delete-file.md +++ b/docs/examples/storage/delete-file.md @@ -1,3 +1,4 @@ +```php deleteFile( bucketId: '', fileId: '' -); \ No newline at end of file +);``` diff --git a/docs/examples/storage/get-bucket.md b/docs/examples/storage/get-bucket.md index e62c43d2..f6449aec 100644 --- a/docs/examples/storage/get-bucket.md +++ b/docs/examples/storage/get-bucket.md @@ -1,3 +1,4 @@ +```php getBucket( bucketId: '' -); \ No newline at end of file +);``` diff --git a/docs/examples/storage/get-file-download.md b/docs/examples/storage/get-file-download.md index defefa59..f55376f0 100644 --- a/docs/examples/storage/get-file-download.md +++ b/docs/examples/storage/get-file-download.md @@ -1,3 +1,4 @@ +```php getFileDownload( bucketId: '', fileId: '', token: '' // optional -); \ No newline at end of file +);``` diff --git a/docs/examples/storage/get-file-preview.md b/docs/examples/storage/get-file-preview.md index aaa15a22..8964011b 100644 --- a/docs/examples/storage/get-file-preview.md +++ b/docs/examples/storage/get-file-preview.md @@ -1,3 +1,4 @@ +```php getFilePreview( background: '', // optional output: ImageFormat::JPG(), // optional token: '' // optional -); \ No newline at end of file +);``` diff --git a/docs/examples/storage/get-file-view.md b/docs/examples/storage/get-file-view.md index dfc84ca1..6a729dc8 100644 --- a/docs/examples/storage/get-file-view.md +++ b/docs/examples/storage/get-file-view.md @@ -1,3 +1,4 @@ +```php getFileView( bucketId: '', fileId: '', token: '' // optional -); \ No newline at end of file +);``` diff --git a/docs/examples/storage/get-file.md b/docs/examples/storage/get-file.md index 69641448..b498b604 100644 --- a/docs/examples/storage/get-file.md +++ b/docs/examples/storage/get-file.md @@ -1,3 +1,4 @@ +```php getFile( bucketId: '', fileId: '' -); \ No newline at end of file +);``` diff --git a/docs/examples/storage/list-buckets.md b/docs/examples/storage/list-buckets.md index 8b84a8bf..3b0d79d7 100644 --- a/docs/examples/storage/list-buckets.md +++ b/docs/examples/storage/list-buckets.md @@ -1,3 +1,4 @@ +```php listBuckets( queries: [], // optional search: '', // optional total: false // optional -); \ No newline at end of file +);``` diff --git a/docs/examples/storage/list-files.md b/docs/examples/storage/list-files.md index 309c87c1..77e78cde 100644 --- a/docs/examples/storage/list-files.md +++ b/docs/examples/storage/list-files.md @@ -1,3 +1,4 @@ +```php listFiles( queries: [], // optional search: '', // optional total: false // optional -); \ No newline at end of file +);``` diff --git a/docs/examples/storage/update-bucket.md b/docs/examples/storage/update-bucket.md index 15562578..c14e75c3 100644 --- a/docs/examples/storage/update-bucket.md +++ b/docs/examples/storage/update-bucket.md @@ -1,3 +1,4 @@ +```php updateBucket( encryption: false, // optional antivirus: false, // optional transformations: false // optional -); \ No newline at end of file +);``` diff --git a/docs/examples/storage/update-file.md b/docs/examples/storage/update-file.md index fc84f590..1e40a492 100644 --- a/docs/examples/storage/update-file.md +++ b/docs/examples/storage/update-file.md @@ -1,3 +1,4 @@ +```php updateFile( fileId: '', name: '', // optional permissions: [Permission::read(Role::any())] // optional -); \ No newline at end of file +);``` diff --git a/docs/examples/tablesdb/create-boolean-column.md b/docs/examples/tablesdb/create-boolean-column.md index 5f0a2de3..b6032a39 100644 --- a/docs/examples/tablesdb/create-boolean-column.md +++ b/docs/examples/tablesdb/create-boolean-column.md @@ -1,3 +1,4 @@ +```php createBooleanColumn( required: false, default: false, // optional array: false // optional -); \ No newline at end of file +);``` diff --git a/docs/examples/tablesdb/create-datetime-column.md b/docs/examples/tablesdb/create-datetime-column.md index 9ea8e8f4..9e9ad843 100644 --- a/docs/examples/tablesdb/create-datetime-column.md +++ b/docs/examples/tablesdb/create-datetime-column.md @@ -1,3 +1,4 @@ +```php createDatetimeColumn( required: false, default: '', // optional array: false // optional -); \ No newline at end of file +);``` diff --git a/docs/examples/tablesdb/create-email-column.md b/docs/examples/tablesdb/create-email-column.md index 64f3a082..f24aa050 100644 --- a/docs/examples/tablesdb/create-email-column.md +++ b/docs/examples/tablesdb/create-email-column.md @@ -1,3 +1,4 @@ +```php createEmailColumn( required: false, default: 'email@example.com', // optional array: false // optional -); \ No newline at end of file +);``` diff --git a/docs/examples/tablesdb/create-enum-column.md b/docs/examples/tablesdb/create-enum-column.md index 0506a336..95157424 100644 --- a/docs/examples/tablesdb/create-enum-column.md +++ b/docs/examples/tablesdb/create-enum-column.md @@ -1,3 +1,4 @@ +```php createEnumColumn( required: false, default: '', // optional array: false // optional -); \ No newline at end of file +);``` diff --git a/docs/examples/tablesdb/create-float-column.md b/docs/examples/tablesdb/create-float-column.md index 65a7f00f..c83abba7 100644 --- a/docs/examples/tablesdb/create-float-column.md +++ b/docs/examples/tablesdb/create-float-column.md @@ -1,3 +1,4 @@ +```php createFloatColumn( max: null, // optional default: null, // optional array: false // optional -); \ No newline at end of file +);``` diff --git a/docs/examples/tablesdb/create-index.md b/docs/examples/tablesdb/create-index.md index b56f5038..c91356f2 100644 --- a/docs/examples/tablesdb/create-index.md +++ b/docs/examples/tablesdb/create-index.md @@ -1,3 +1,4 @@ +```php createIndex( columns: [], orders: [OrderBy::ASC()], // optional lengths: [] // optional -); \ No newline at end of file +);``` diff --git a/docs/examples/tablesdb/create-integer-column.md b/docs/examples/tablesdb/create-integer-column.md index 4bf96e8b..a42c8710 100644 --- a/docs/examples/tablesdb/create-integer-column.md +++ b/docs/examples/tablesdb/create-integer-column.md @@ -1,3 +1,4 @@ +```php createIntegerColumn( max: null, // optional default: null, // optional array: false // optional -); \ No newline at end of file +);``` diff --git a/docs/examples/tablesdb/create-ip-column.md b/docs/examples/tablesdb/create-ip-column.md index ab0032e4..f40fe61d 100644 --- a/docs/examples/tablesdb/create-ip-column.md +++ b/docs/examples/tablesdb/create-ip-column.md @@ -1,3 +1,4 @@ +```php createIpColumn( required: false, default: '', // optional array: false // optional -); \ No newline at end of file +);``` diff --git a/docs/examples/tablesdb/create-line-column.md b/docs/examples/tablesdb/create-line-column.md index 69f2e667..c1d17b82 100644 --- a/docs/examples/tablesdb/create-line-column.md +++ b/docs/examples/tablesdb/create-line-column.md @@ -1,3 +1,4 @@ +```php createLineColumn( key: '', required: false, default: [[1, 2], [3, 4], [5, 6]] // optional -); \ No newline at end of file +);``` diff --git a/docs/examples/tablesdb/create-longtext-column.md b/docs/examples/tablesdb/create-longtext-column.md index 48c5747b..cb2bd85d 100644 --- a/docs/examples/tablesdb/create-longtext-column.md +++ b/docs/examples/tablesdb/create-longtext-column.md @@ -1,3 +1,4 @@ +```php createLongtextColumn( required: false, default: '', // optional array: false // optional -); \ No newline at end of file +);``` diff --git a/docs/examples/tablesdb/create-mediumtext-column.md b/docs/examples/tablesdb/create-mediumtext-column.md index f2472fbf..b17328c8 100644 --- a/docs/examples/tablesdb/create-mediumtext-column.md +++ b/docs/examples/tablesdb/create-mediumtext-column.md @@ -1,3 +1,4 @@ +```php createMediumtextColumn( required: false, default: '', // optional array: false // optional -); \ No newline at end of file +);``` diff --git a/docs/examples/tablesdb/create-operations.md b/docs/examples/tablesdb/create-operations.md index 429a0bb5..45ea4c92 100644 --- a/docs/examples/tablesdb/create-operations.md +++ b/docs/examples/tablesdb/create-operations.md @@ -1,3 +1,4 @@ +```php createOperations( } } ] // optional -); \ No newline at end of file +);``` diff --git a/docs/examples/tablesdb/create-point-column.md b/docs/examples/tablesdb/create-point-column.md index 006c9e00..bde57bc3 100644 --- a/docs/examples/tablesdb/create-point-column.md +++ b/docs/examples/tablesdb/create-point-column.md @@ -1,3 +1,4 @@ +```php createPointColumn( key: '', required: false, default: [1, 2] // optional -); \ No newline at end of file +);``` diff --git a/docs/examples/tablesdb/create-polygon-column.md b/docs/examples/tablesdb/create-polygon-column.md index 20fb2716..ee340f34 100644 --- a/docs/examples/tablesdb/create-polygon-column.md +++ b/docs/examples/tablesdb/create-polygon-column.md @@ -1,3 +1,4 @@ +```php createPolygonColumn( key: '', required: false, default: [[[1, 2], [3, 4], [5, 6], [1, 2]]] // optional -); \ No newline at end of file +);``` diff --git a/docs/examples/tablesdb/create-relationship-column.md b/docs/examples/tablesdb/create-relationship-column.md index 7f9a06cc..06dd6c0d 100644 --- a/docs/examples/tablesdb/create-relationship-column.md +++ b/docs/examples/tablesdb/create-relationship-column.md @@ -1,3 +1,4 @@ +```php createRelationshipColumn( key: '', // optional twoWayKey: '', // optional onDelete: RelationMutate::CASCADE() // optional -); \ No newline at end of file +);``` diff --git a/docs/examples/tablesdb/create-row.md b/docs/examples/tablesdb/create-row.md index 70666d52..fc253f2b 100644 --- a/docs/examples/tablesdb/create-row.md +++ b/docs/examples/tablesdb/create-row.md @@ -1,3 +1,4 @@ +```php createRow( ], permissions: [Permission::read(Role::any())], // optional transactionId: '' // optional -); \ No newline at end of file +);``` diff --git a/docs/examples/tablesdb/create-rows.md b/docs/examples/tablesdb/create-rows.md index 44c9c7d1..8c08fa57 100644 --- a/docs/examples/tablesdb/create-rows.md +++ b/docs/examples/tablesdb/create-rows.md @@ -1,3 +1,4 @@ +```php createRows( tableId: '', rows: [], transactionId: '' // optional -); \ No newline at end of file +);``` diff --git a/docs/examples/tablesdb/create-string-column.md b/docs/examples/tablesdb/create-string-column.md index 22fc7ccf..a4dd4dac 100644 --- a/docs/examples/tablesdb/create-string-column.md +++ b/docs/examples/tablesdb/create-string-column.md @@ -1,3 +1,4 @@ +```php createStringColumn( default: '', // optional array: false, // optional encrypt: false // optional -); \ No newline at end of file +);``` diff --git a/docs/examples/tablesdb/create-table.md b/docs/examples/tablesdb/create-table.md index aef39e54..fbe44767 100644 --- a/docs/examples/tablesdb/create-table.md +++ b/docs/examples/tablesdb/create-table.md @@ -1,3 +1,4 @@ +```php createTable( enabled: false, // optional columns: [], // optional indexes: [] // optional -); \ No newline at end of file +);``` diff --git a/docs/examples/tablesdb/create-text-column.md b/docs/examples/tablesdb/create-text-column.md index 00f1611b..833aa90a 100644 --- a/docs/examples/tablesdb/create-text-column.md +++ b/docs/examples/tablesdb/create-text-column.md @@ -1,3 +1,4 @@ +```php createTextColumn( required: false, default: '', // optional array: false // optional -); \ No newline at end of file +);``` diff --git a/docs/examples/tablesdb/create-transaction.md b/docs/examples/tablesdb/create-transaction.md index 32488185..6664c084 100644 --- a/docs/examples/tablesdb/create-transaction.md +++ b/docs/examples/tablesdb/create-transaction.md @@ -1,3 +1,4 @@ +```php createTransaction( ttl: 60 // optional -); \ No newline at end of file +);``` diff --git a/docs/examples/tablesdb/create-url-column.md b/docs/examples/tablesdb/create-url-column.md index fe25988a..ceb1dae6 100644 --- a/docs/examples/tablesdb/create-url-column.md +++ b/docs/examples/tablesdb/create-url-column.md @@ -1,3 +1,4 @@ +```php createUrlColumn( required: false, default: 'https://example.com', // optional array: false // optional -); \ No newline at end of file +);``` diff --git a/docs/examples/tablesdb/create-varchar-column.md b/docs/examples/tablesdb/create-varchar-column.md index bbd86508..25aa354e 100644 --- a/docs/examples/tablesdb/create-varchar-column.md +++ b/docs/examples/tablesdb/create-varchar-column.md @@ -1,3 +1,4 @@ +```php createVarcharColumn( required: false, default: '', // optional array: false // optional -); \ No newline at end of file +);``` diff --git a/docs/examples/tablesdb/create.md b/docs/examples/tablesdb/create.md index c3c4faaf..2265fc9b 100644 --- a/docs/examples/tablesdb/create.md +++ b/docs/examples/tablesdb/create.md @@ -1,3 +1,4 @@ +```php create( databaseId: '', name: '', enabled: false // optional -); \ No newline at end of file +);``` diff --git a/docs/examples/tablesdb/decrement-row-column.md b/docs/examples/tablesdb/decrement-row-column.md index ede258e8..0d01314a 100644 --- a/docs/examples/tablesdb/decrement-row-column.md +++ b/docs/examples/tablesdb/decrement-row-column.md @@ -1,3 +1,4 @@ +```php decrementRowColumn( value: null, // optional min: null, // optional transactionId: '' // optional -); \ No newline at end of file +);``` diff --git a/docs/examples/tablesdb/delete-column.md b/docs/examples/tablesdb/delete-column.md index dd99fabc..97cafced 100644 --- a/docs/examples/tablesdb/delete-column.md +++ b/docs/examples/tablesdb/delete-column.md @@ -1,3 +1,4 @@ +```php deleteColumn( databaseId: '', tableId: '', key: '' -); \ No newline at end of file +);``` diff --git a/docs/examples/tablesdb/delete-index.md b/docs/examples/tablesdb/delete-index.md index 1ef346fe..abad8248 100644 --- a/docs/examples/tablesdb/delete-index.md +++ b/docs/examples/tablesdb/delete-index.md @@ -1,3 +1,4 @@ +```php deleteIndex( databaseId: '', tableId: '', key: '' -); \ No newline at end of file +);``` diff --git a/docs/examples/tablesdb/delete-row.md b/docs/examples/tablesdb/delete-row.md index df87c507..05722a0c 100644 --- a/docs/examples/tablesdb/delete-row.md +++ b/docs/examples/tablesdb/delete-row.md @@ -1,3 +1,4 @@ +```php deleteRow( tableId: '', rowId: '', transactionId: '' // optional -); \ No newline at end of file +);``` diff --git a/docs/examples/tablesdb/delete-rows.md b/docs/examples/tablesdb/delete-rows.md index 79ed607c..934ea6b7 100644 --- a/docs/examples/tablesdb/delete-rows.md +++ b/docs/examples/tablesdb/delete-rows.md @@ -1,3 +1,4 @@ +```php deleteRows( tableId: '', queries: [], // optional transactionId: '' // optional -); \ No newline at end of file +);``` diff --git a/docs/examples/tablesdb/delete-table.md b/docs/examples/tablesdb/delete-table.md index 3cbb35de..acc711db 100644 --- a/docs/examples/tablesdb/delete-table.md +++ b/docs/examples/tablesdb/delete-table.md @@ -1,3 +1,4 @@ +```php deleteTable( databaseId: '', tableId: '' -); \ No newline at end of file +);``` diff --git a/docs/examples/tablesdb/delete-transaction.md b/docs/examples/tablesdb/delete-transaction.md index d1650158..2b0c7ff8 100644 --- a/docs/examples/tablesdb/delete-transaction.md +++ b/docs/examples/tablesdb/delete-transaction.md @@ -1,3 +1,4 @@ +```php deleteTransaction( transactionId: '' -); \ No newline at end of file +);``` diff --git a/docs/examples/tablesdb/delete.md b/docs/examples/tablesdb/delete.md index ea996e9b..1b2cc93a 100644 --- a/docs/examples/tablesdb/delete.md +++ b/docs/examples/tablesdb/delete.md @@ -1,3 +1,4 @@ +```php delete( databaseId: '' -); \ No newline at end of file +);``` diff --git a/docs/examples/tablesdb/get-column.md b/docs/examples/tablesdb/get-column.md index d1705a41..0be374fc 100644 --- a/docs/examples/tablesdb/get-column.md +++ b/docs/examples/tablesdb/get-column.md @@ -1,3 +1,4 @@ +```php getColumn( databaseId: '', tableId: '', key: '' -); \ No newline at end of file +);``` diff --git a/docs/examples/tablesdb/get-index.md b/docs/examples/tablesdb/get-index.md index 0d676481..5e79e708 100644 --- a/docs/examples/tablesdb/get-index.md +++ b/docs/examples/tablesdb/get-index.md @@ -1,3 +1,4 @@ +```php getIndex( databaseId: '', tableId: '', key: '' -); \ No newline at end of file +);``` diff --git a/docs/examples/tablesdb/get-row.md b/docs/examples/tablesdb/get-row.md index 4bbea559..f8871ffa 100644 --- a/docs/examples/tablesdb/get-row.md +++ b/docs/examples/tablesdb/get-row.md @@ -1,3 +1,4 @@ +```php getRow( rowId: '', queries: [], // optional transactionId: '' // optional -); \ No newline at end of file +);``` diff --git a/docs/examples/tablesdb/get-table.md b/docs/examples/tablesdb/get-table.md index ee8812f6..1bc01662 100644 --- a/docs/examples/tablesdb/get-table.md +++ b/docs/examples/tablesdb/get-table.md @@ -1,3 +1,4 @@ +```php getTable( databaseId: '', tableId: '' -); \ No newline at end of file +);``` diff --git a/docs/examples/tablesdb/get-transaction.md b/docs/examples/tablesdb/get-transaction.md index 146e7d19..fc4030f5 100644 --- a/docs/examples/tablesdb/get-transaction.md +++ b/docs/examples/tablesdb/get-transaction.md @@ -1,3 +1,4 @@ +```php getTransaction( transactionId: '' -); \ No newline at end of file +);``` diff --git a/docs/examples/tablesdb/get.md b/docs/examples/tablesdb/get.md index 07f70987..5dde28d8 100644 --- a/docs/examples/tablesdb/get.md +++ b/docs/examples/tablesdb/get.md @@ -1,3 +1,4 @@ +```php get( databaseId: '' -); \ No newline at end of file +);``` diff --git a/docs/examples/tablesdb/increment-row-column.md b/docs/examples/tablesdb/increment-row-column.md index 66bf2e84..5c6176ee 100644 --- a/docs/examples/tablesdb/increment-row-column.md +++ b/docs/examples/tablesdb/increment-row-column.md @@ -1,3 +1,4 @@ +```php incrementRowColumn( value: null, // optional max: null, // optional transactionId: '' // optional -); \ No newline at end of file +);``` diff --git a/docs/examples/tablesdb/list-columns.md b/docs/examples/tablesdb/list-columns.md index 49b4eba9..2ecf6542 100644 --- a/docs/examples/tablesdb/list-columns.md +++ b/docs/examples/tablesdb/list-columns.md @@ -1,3 +1,4 @@ +```php listColumns( tableId: '', queries: [], // optional total: false // optional -); \ No newline at end of file +);``` diff --git a/docs/examples/tablesdb/list-indexes.md b/docs/examples/tablesdb/list-indexes.md index ac466c74..17428fe1 100644 --- a/docs/examples/tablesdb/list-indexes.md +++ b/docs/examples/tablesdb/list-indexes.md @@ -1,3 +1,4 @@ +```php listIndexes( tableId: '', queries: [], // optional total: false // optional -); \ No newline at end of file +);``` diff --git a/docs/examples/tablesdb/list-rows.md b/docs/examples/tablesdb/list-rows.md index cdcc7964..710c7919 100644 --- a/docs/examples/tablesdb/list-rows.md +++ b/docs/examples/tablesdb/list-rows.md @@ -1,3 +1,4 @@ +```php listRows( queries: [], // optional transactionId: '', // optional total: false // optional -); \ No newline at end of file +);``` diff --git a/docs/examples/tablesdb/list-tables.md b/docs/examples/tablesdb/list-tables.md index b14e28c1..c74d5a15 100644 --- a/docs/examples/tablesdb/list-tables.md +++ b/docs/examples/tablesdb/list-tables.md @@ -1,3 +1,4 @@ +```php listTables( queries: [], // optional search: '', // optional total: false // optional -); \ No newline at end of file +);``` diff --git a/docs/examples/tablesdb/list-transactions.md b/docs/examples/tablesdb/list-transactions.md index 15095d6f..58b31a64 100644 --- a/docs/examples/tablesdb/list-transactions.md +++ b/docs/examples/tablesdb/list-transactions.md @@ -1,3 +1,4 @@ +```php listTransactions( queries: [] // optional -); \ No newline at end of file +);``` diff --git a/docs/examples/tablesdb/list.md b/docs/examples/tablesdb/list.md index 3d74dded..77da5528 100644 --- a/docs/examples/tablesdb/list.md +++ b/docs/examples/tablesdb/list.md @@ -1,3 +1,4 @@ +```php list( queries: [], // optional search: '', // optional total: false // optional -); \ No newline at end of file +);``` diff --git a/docs/examples/tablesdb/update-boolean-column.md b/docs/examples/tablesdb/update-boolean-column.md index 0c735167..8a7850fc 100644 --- a/docs/examples/tablesdb/update-boolean-column.md +++ b/docs/examples/tablesdb/update-boolean-column.md @@ -1,3 +1,4 @@ +```php updateBooleanColumn( required: false, default: false, newKey: '' // optional -); \ No newline at end of file +);``` diff --git a/docs/examples/tablesdb/update-datetime-column.md b/docs/examples/tablesdb/update-datetime-column.md index 52213c6e..4f994a5b 100644 --- a/docs/examples/tablesdb/update-datetime-column.md +++ b/docs/examples/tablesdb/update-datetime-column.md @@ -1,3 +1,4 @@ +```php updateDatetimeColumn( required: false, default: '', newKey: '' // optional -); \ No newline at end of file +);``` diff --git a/docs/examples/tablesdb/update-email-column.md b/docs/examples/tablesdb/update-email-column.md index d13de56b..8cd10d41 100644 --- a/docs/examples/tablesdb/update-email-column.md +++ b/docs/examples/tablesdb/update-email-column.md @@ -1,3 +1,4 @@ +```php updateEmailColumn( required: false, default: 'email@example.com', newKey: '' // optional -); \ No newline at end of file +);``` diff --git a/docs/examples/tablesdb/update-enum-column.md b/docs/examples/tablesdb/update-enum-column.md index d54c0b38..0dcf5747 100644 --- a/docs/examples/tablesdb/update-enum-column.md +++ b/docs/examples/tablesdb/update-enum-column.md @@ -1,3 +1,4 @@ +```php updateEnumColumn( required: false, default: '', newKey: '' // optional -); \ No newline at end of file +);``` diff --git a/docs/examples/tablesdb/update-float-column.md b/docs/examples/tablesdb/update-float-column.md index bb091abf..68a90df3 100644 --- a/docs/examples/tablesdb/update-float-column.md +++ b/docs/examples/tablesdb/update-float-column.md @@ -1,3 +1,4 @@ +```php updateFloatColumn( min: null, // optional max: null, // optional newKey: '' // optional -); \ No newline at end of file +);``` diff --git a/docs/examples/tablesdb/update-integer-column.md b/docs/examples/tablesdb/update-integer-column.md index 2436bc2c..ba7a781f 100644 --- a/docs/examples/tablesdb/update-integer-column.md +++ b/docs/examples/tablesdb/update-integer-column.md @@ -1,3 +1,4 @@ +```php updateIntegerColumn( min: null, // optional max: null, // optional newKey: '' // optional -); \ No newline at end of file +);``` diff --git a/docs/examples/tablesdb/update-ip-column.md b/docs/examples/tablesdb/update-ip-column.md index aa97752a..25a71601 100644 --- a/docs/examples/tablesdb/update-ip-column.md +++ b/docs/examples/tablesdb/update-ip-column.md @@ -1,3 +1,4 @@ +```php updateIpColumn( required: false, default: '', newKey: '' // optional -); \ No newline at end of file +);``` diff --git a/docs/examples/tablesdb/update-line-column.md b/docs/examples/tablesdb/update-line-column.md index 56a557cb..a7126a39 100644 --- a/docs/examples/tablesdb/update-line-column.md +++ b/docs/examples/tablesdb/update-line-column.md @@ -1,3 +1,4 @@ +```php updateLineColumn( required: false, default: [[1, 2], [3, 4], [5, 6]], // optional newKey: '' // optional -); \ No newline at end of file +);``` diff --git a/docs/examples/tablesdb/update-longtext-column.md b/docs/examples/tablesdb/update-longtext-column.md index 0ba81d67..aaccf927 100644 --- a/docs/examples/tablesdb/update-longtext-column.md +++ b/docs/examples/tablesdb/update-longtext-column.md @@ -1,3 +1,4 @@ +```php updateLongtextColumn( required: false, default: '', newKey: '' // optional -); \ No newline at end of file +);``` diff --git a/docs/examples/tablesdb/update-mediumtext-column.md b/docs/examples/tablesdb/update-mediumtext-column.md index 5ff64240..2b06e8d3 100644 --- a/docs/examples/tablesdb/update-mediumtext-column.md +++ b/docs/examples/tablesdb/update-mediumtext-column.md @@ -1,3 +1,4 @@ +```php updateMediumtextColumn( required: false, default: '', newKey: '' // optional -); \ No newline at end of file +);``` diff --git a/docs/examples/tablesdb/update-point-column.md b/docs/examples/tablesdb/update-point-column.md index abe8b737..0d137cea 100644 --- a/docs/examples/tablesdb/update-point-column.md +++ b/docs/examples/tablesdb/update-point-column.md @@ -1,3 +1,4 @@ +```php updatePointColumn( required: false, default: [1, 2], // optional newKey: '' // optional -); \ No newline at end of file +);``` diff --git a/docs/examples/tablesdb/update-polygon-column.md b/docs/examples/tablesdb/update-polygon-column.md index 2ff40115..5341610c 100644 --- a/docs/examples/tablesdb/update-polygon-column.md +++ b/docs/examples/tablesdb/update-polygon-column.md @@ -1,3 +1,4 @@ +```php updatePolygonColumn( required: false, default: [[[1, 2], [3, 4], [5, 6], [1, 2]]], // optional newKey: '' // optional -); \ No newline at end of file +);``` diff --git a/docs/examples/tablesdb/update-relationship-column.md b/docs/examples/tablesdb/update-relationship-column.md index cc2e2cca..4b153851 100644 --- a/docs/examples/tablesdb/update-relationship-column.md +++ b/docs/examples/tablesdb/update-relationship-column.md @@ -1,3 +1,4 @@ +```php updateRelationshipColumn( key: '', onDelete: RelationMutate::CASCADE(), // optional newKey: '' // optional -); \ No newline at end of file +);``` diff --git a/docs/examples/tablesdb/update-row.md b/docs/examples/tablesdb/update-row.md index 71916cd6..f0fd37d6 100644 --- a/docs/examples/tablesdb/update-row.md +++ b/docs/examples/tablesdb/update-row.md @@ -1,3 +1,4 @@ +```php updateRow( ], // optional permissions: [Permission::read(Role::any())], // optional transactionId: '' // optional -); \ No newline at end of file +);``` diff --git a/docs/examples/tablesdb/update-rows.md b/docs/examples/tablesdb/update-rows.md index a6892f81..baf98ecf 100644 --- a/docs/examples/tablesdb/update-rows.md +++ b/docs/examples/tablesdb/update-rows.md @@ -1,3 +1,4 @@ +```php updateRows( ], // optional queries: [], // optional transactionId: '' // optional -); \ No newline at end of file +);``` diff --git a/docs/examples/tablesdb/update-string-column.md b/docs/examples/tablesdb/update-string-column.md index eb1acc15..ff01707d 100644 --- a/docs/examples/tablesdb/update-string-column.md +++ b/docs/examples/tablesdb/update-string-column.md @@ -1,3 +1,4 @@ +```php updateStringColumn( default: '', size: 1, // optional newKey: '' // optional -); \ No newline at end of file +);``` diff --git a/docs/examples/tablesdb/update-table.md b/docs/examples/tablesdb/update-table.md index dc09f5f2..4409db26 100644 --- a/docs/examples/tablesdb/update-table.md +++ b/docs/examples/tablesdb/update-table.md @@ -1,3 +1,4 @@ +```php updateTable( permissions: [Permission::read(Role::any())], // optional rowSecurity: false, // optional enabled: false // optional -); \ No newline at end of file +);``` diff --git a/docs/examples/tablesdb/update-text-column.md b/docs/examples/tablesdb/update-text-column.md index 56aa217f..81fa0fec 100644 --- a/docs/examples/tablesdb/update-text-column.md +++ b/docs/examples/tablesdb/update-text-column.md @@ -1,3 +1,4 @@ +```php updateTextColumn( required: false, default: '', newKey: '' // optional -); \ No newline at end of file +);``` diff --git a/docs/examples/tablesdb/update-transaction.md b/docs/examples/tablesdb/update-transaction.md index fed3810b..512760bf 100644 --- a/docs/examples/tablesdb/update-transaction.md +++ b/docs/examples/tablesdb/update-transaction.md @@ -1,3 +1,4 @@ +```php updateTransaction( transactionId: '', commit: false, // optional rollback: false // optional -); \ No newline at end of file +);``` diff --git a/docs/examples/tablesdb/update-url-column.md b/docs/examples/tablesdb/update-url-column.md index b64b3024..6c055168 100644 --- a/docs/examples/tablesdb/update-url-column.md +++ b/docs/examples/tablesdb/update-url-column.md @@ -1,3 +1,4 @@ +```php updateUrlColumn( required: false, default: 'https://example.com', newKey: '' // optional -); \ No newline at end of file +);``` diff --git a/docs/examples/tablesdb/update-varchar-column.md b/docs/examples/tablesdb/update-varchar-column.md index 077e8c4f..ca4ba824 100644 --- a/docs/examples/tablesdb/update-varchar-column.md +++ b/docs/examples/tablesdb/update-varchar-column.md @@ -1,3 +1,4 @@ +```php updateVarcharColumn( default: '', size: 1, // optional newKey: '' // optional -); \ No newline at end of file +);``` diff --git a/docs/examples/tablesdb/update.md b/docs/examples/tablesdb/update.md index 0dcd0493..126b3caf 100644 --- a/docs/examples/tablesdb/update.md +++ b/docs/examples/tablesdb/update.md @@ -1,3 +1,4 @@ +```php update( databaseId: '', name: '', // optional enabled: false // optional -); \ No newline at end of file +);``` diff --git a/docs/examples/tablesdb/upsert-row.md b/docs/examples/tablesdb/upsert-row.md index e26c8255..5c4645ba 100644 --- a/docs/examples/tablesdb/upsert-row.md +++ b/docs/examples/tablesdb/upsert-row.md @@ -1,3 +1,4 @@ +```php upsertRow( ], // optional permissions: [Permission::read(Role::any())], // optional transactionId: '' // optional -); \ No newline at end of file +);``` diff --git a/docs/examples/tablesdb/upsert-rows.md b/docs/examples/tablesdb/upsert-rows.md index fb93df8b..6d9d6154 100644 --- a/docs/examples/tablesdb/upsert-rows.md +++ b/docs/examples/tablesdb/upsert-rows.md @@ -1,3 +1,4 @@ +```php upsertRows( tableId: '', rows: [], transactionId: '' // optional -); \ No newline at end of file +);``` diff --git a/docs/examples/teams/create-membership.md b/docs/examples/teams/create-membership.md index 53fb6eff..ddbddc38 100644 --- a/docs/examples/teams/create-membership.md +++ b/docs/examples/teams/create-membership.md @@ -1,8 +1,8 @@ +```php setEndpoint('https://.cloud.appwrite.io/v1') // Your API Endpoint @@ -13,10 +13,10 @@ $teams = new Teams($client); $result = $teams->createMembership( teamId: '', - roles: [Roles::ADMIN()], + roles: [], email: 'email@example.com', // optional userId: '', // optional phone: '+12065550100', // optional url: 'https://example.com', // optional name: '' // optional -); \ No newline at end of file +);``` diff --git a/docs/examples/teams/create.md b/docs/examples/teams/create.md index 643fa0eb..e0eef909 100644 --- a/docs/examples/teams/create.md +++ b/docs/examples/teams/create.md @@ -1,3 +1,4 @@ +```php create( teamId: '', name: '', roles: [] // optional -); \ No newline at end of file +);``` diff --git a/docs/examples/teams/delete-membership.md b/docs/examples/teams/delete-membership.md index 579b790c..096d69eb 100644 --- a/docs/examples/teams/delete-membership.md +++ b/docs/examples/teams/delete-membership.md @@ -1,3 +1,4 @@ +```php deleteMembership( teamId: '', membershipId: '' -); \ No newline at end of file +);``` diff --git a/docs/examples/teams/delete.md b/docs/examples/teams/delete.md index 9db4e7e9..e982d579 100644 --- a/docs/examples/teams/delete.md +++ b/docs/examples/teams/delete.md @@ -1,3 +1,4 @@ +```php delete( teamId: '' -); \ No newline at end of file +);``` diff --git a/docs/examples/teams/get-membership.md b/docs/examples/teams/get-membership.md index bd6cbe8b..c696fd0d 100644 --- a/docs/examples/teams/get-membership.md +++ b/docs/examples/teams/get-membership.md @@ -1,3 +1,4 @@ +```php getMembership( teamId: '', membershipId: '' -); \ No newline at end of file +);``` diff --git a/docs/examples/teams/get-prefs.md b/docs/examples/teams/get-prefs.md index fbade4fc..ea621f3a 100644 --- a/docs/examples/teams/get-prefs.md +++ b/docs/examples/teams/get-prefs.md @@ -1,3 +1,4 @@ +```php getPrefs( teamId: '' -); \ No newline at end of file +);``` diff --git a/docs/examples/teams/get.md b/docs/examples/teams/get.md index 0dafa8a5..b0a71242 100644 --- a/docs/examples/teams/get.md +++ b/docs/examples/teams/get.md @@ -1,3 +1,4 @@ +```php get( teamId: '' -); \ No newline at end of file +);``` diff --git a/docs/examples/teams/list-memberships.md b/docs/examples/teams/list-memberships.md index 5ff4736d..0b4fd915 100644 --- a/docs/examples/teams/list-memberships.md +++ b/docs/examples/teams/list-memberships.md @@ -1,3 +1,4 @@ +```php listMemberships( queries: [], // optional search: '', // optional total: false // optional -); \ No newline at end of file +);``` diff --git a/docs/examples/teams/list.md b/docs/examples/teams/list.md index 144b50d0..04fdc4fc 100644 --- a/docs/examples/teams/list.md +++ b/docs/examples/teams/list.md @@ -1,3 +1,4 @@ +```php list( queries: [], // optional search: '', // optional total: false // optional -); \ No newline at end of file +);``` diff --git a/docs/examples/teams/update-membership-status.md b/docs/examples/teams/update-membership-status.md index 5dbfd4cb..33f891c1 100644 --- a/docs/examples/teams/update-membership-status.md +++ b/docs/examples/teams/update-membership-status.md @@ -1,3 +1,4 @@ +```php updateMembershipStatus( membershipId: '', userId: '', secret: '' -); \ No newline at end of file +);``` diff --git a/docs/examples/teams/update-membership.md b/docs/examples/teams/update-membership.md index 0cdd13e1..0a251890 100644 --- a/docs/examples/teams/update-membership.md +++ b/docs/examples/teams/update-membership.md @@ -1,8 +1,8 @@ +```php setEndpoint('https://.cloud.appwrite.io/v1') // Your API Endpoint @@ -14,5 +14,5 @@ $teams = new Teams($client); $result = $teams->updateMembership( teamId: '', membershipId: '', - roles: [Roles::ADMIN()] -); \ No newline at end of file + roles: [] +);``` diff --git a/docs/examples/teams/update-name.md b/docs/examples/teams/update-name.md index bc13d924..eae3a3bf 100644 --- a/docs/examples/teams/update-name.md +++ b/docs/examples/teams/update-name.md @@ -1,3 +1,4 @@ +```php updateName( teamId: '', name: '' -); \ No newline at end of file +);``` diff --git a/docs/examples/teams/update-prefs.md b/docs/examples/teams/update-prefs.md index bd8d9de3..785f7ba9 100644 --- a/docs/examples/teams/update-prefs.md +++ b/docs/examples/teams/update-prefs.md @@ -1,3 +1,4 @@ +```php updatePrefs( teamId: '', prefs: [] -); \ No newline at end of file +);``` diff --git a/docs/examples/tokens/create-file-token.md b/docs/examples/tokens/create-file-token.md index e4f23021..d172c15e 100644 --- a/docs/examples/tokens/create-file-token.md +++ b/docs/examples/tokens/create-file-token.md @@ -1,3 +1,4 @@ +```php createFileToken( bucketId: '', fileId: '', expire: '' // optional -); \ No newline at end of file +);``` diff --git a/docs/examples/tokens/delete.md b/docs/examples/tokens/delete.md index 278be90b..d298ed3a 100644 --- a/docs/examples/tokens/delete.md +++ b/docs/examples/tokens/delete.md @@ -1,3 +1,4 @@ +```php delete( tokenId: '' -); \ No newline at end of file +);``` diff --git a/docs/examples/tokens/get.md b/docs/examples/tokens/get.md index e7b4e108..db117e6a 100644 --- a/docs/examples/tokens/get.md +++ b/docs/examples/tokens/get.md @@ -1,3 +1,4 @@ +```php get( tokenId: '' -); \ No newline at end of file +);``` diff --git a/docs/examples/tokens/list.md b/docs/examples/tokens/list.md index 212a443c..35512617 100644 --- a/docs/examples/tokens/list.md +++ b/docs/examples/tokens/list.md @@ -1,3 +1,4 @@ +```php list( fileId: '', queries: [], // optional total: false // optional -); \ No newline at end of file +);``` diff --git a/docs/examples/tokens/update.md b/docs/examples/tokens/update.md index ea95322a..07c37e36 100644 --- a/docs/examples/tokens/update.md +++ b/docs/examples/tokens/update.md @@ -1,3 +1,4 @@ +```php update( tokenId: '', expire: '' // optional -); \ No newline at end of file +);``` diff --git a/docs/examples/users/create-argon-2-user.md b/docs/examples/users/create-argon-2-user.md index a9166ef3..4813cd8b 100644 --- a/docs/examples/users/create-argon-2-user.md +++ b/docs/examples/users/create-argon-2-user.md @@ -1,3 +1,4 @@ +```php createArgon2User( email: 'email@example.com', password: 'password', name: '' // optional -); \ No newline at end of file +);``` diff --git a/docs/examples/users/create-bcrypt-user.md b/docs/examples/users/create-bcrypt-user.md index c9fd81e4..17a3c7ec 100644 --- a/docs/examples/users/create-bcrypt-user.md +++ b/docs/examples/users/create-bcrypt-user.md @@ -1,3 +1,4 @@ +```php createBcryptUser( email: 'email@example.com', password: 'password', name: '' // optional -); \ No newline at end of file +);``` diff --git a/docs/examples/users/create-jwt.md b/docs/examples/users/create-jwt.md index 1c1c6d40..9a22a606 100644 --- a/docs/examples/users/create-jwt.md +++ b/docs/examples/users/create-jwt.md @@ -1,3 +1,4 @@ +```php createJWT( userId: '', sessionId: '', // optional duration: 0 // optional -); \ No newline at end of file +);``` diff --git a/docs/examples/users/create-md-5-user.md b/docs/examples/users/create-md-5-user.md index 696cbbeb..85e97f75 100644 --- a/docs/examples/users/create-md-5-user.md +++ b/docs/examples/users/create-md-5-user.md @@ -1,3 +1,4 @@ +```php createMD5User( email: 'email@example.com', password: 'password', name: '' // optional -); \ No newline at end of file +);``` diff --git a/docs/examples/users/create-mfa-recovery-codes.md b/docs/examples/users/create-mfa-recovery-codes.md index ee96d2e2..23295475 100644 --- a/docs/examples/users/create-mfa-recovery-codes.md +++ b/docs/examples/users/create-mfa-recovery-codes.md @@ -1,3 +1,4 @@ +```php createMFARecoveryCodes( userId: '' -); \ No newline at end of file +);``` diff --git a/docs/examples/users/create-ph-pass-user.md b/docs/examples/users/create-ph-pass-user.md index d56c4651..0e9a62ff 100644 --- a/docs/examples/users/create-ph-pass-user.md +++ b/docs/examples/users/create-ph-pass-user.md @@ -1,3 +1,4 @@ +```php createPHPassUser( email: 'email@example.com', password: 'password', name: '' // optional -); \ No newline at end of file +);``` diff --git a/docs/examples/users/create-scrypt-modified-user.md b/docs/examples/users/create-scrypt-modified-user.md index f579efb5..22c18b1e 100644 --- a/docs/examples/users/create-scrypt-modified-user.md +++ b/docs/examples/users/create-scrypt-modified-user.md @@ -1,3 +1,4 @@ +```php createScryptModifiedUser( passwordSaltSeparator: '', passwordSignerKey: '', name: '' // optional -); \ No newline at end of file +);``` diff --git a/docs/examples/users/create-scrypt-user.md b/docs/examples/users/create-scrypt-user.md index b406b940..8ebc44dd 100644 --- a/docs/examples/users/create-scrypt-user.md +++ b/docs/examples/users/create-scrypt-user.md @@ -1,3 +1,4 @@ +```php createScryptUser( passwordParallel: null, passwordLength: null, name: '' // optional -); \ No newline at end of file +);``` diff --git a/docs/examples/users/create-session.md b/docs/examples/users/create-session.md index 1589315f..0279835a 100644 --- a/docs/examples/users/create-session.md +++ b/docs/examples/users/create-session.md @@ -1,3 +1,4 @@ +```php createSession( userId: '' -); \ No newline at end of file +);``` diff --git a/docs/examples/users/create-sha-user.md b/docs/examples/users/create-sha-user.md index 812bcd5e..924224bc 100644 --- a/docs/examples/users/create-sha-user.md +++ b/docs/examples/users/create-sha-user.md @@ -1,3 +1,4 @@ +```php createSHAUser( password: 'password', passwordVersion: PasswordHash::SHA1(), // optional name: '' // optional -); \ No newline at end of file +);``` diff --git a/docs/examples/users/create-target.md b/docs/examples/users/create-target.md index 57946a44..1000574f 100644 --- a/docs/examples/users/create-target.md +++ b/docs/examples/users/create-target.md @@ -1,3 +1,4 @@ +```php createTarget( identifier: '', providerId: '', // optional name: '' // optional -); \ No newline at end of file +);``` diff --git a/docs/examples/users/create-token.md b/docs/examples/users/create-token.md index 1b92f517..4519995f 100644 --- a/docs/examples/users/create-token.md +++ b/docs/examples/users/create-token.md @@ -1,3 +1,4 @@ +```php createToken( userId: '', length: 4, // optional expire: 60 // optional -); \ No newline at end of file +);``` diff --git a/docs/examples/users/create.md b/docs/examples/users/create.md index 595f24fb..ec9b6839 100644 --- a/docs/examples/users/create.md +++ b/docs/examples/users/create.md @@ -1,3 +1,4 @@ +```php create( phone: '+12065550100', // optional password: '', // optional name: '' // optional -); \ No newline at end of file +);``` diff --git a/docs/examples/users/delete-identity.md b/docs/examples/users/delete-identity.md index 26b71eea..b364358d 100644 --- a/docs/examples/users/delete-identity.md +++ b/docs/examples/users/delete-identity.md @@ -1,3 +1,4 @@ +```php deleteIdentity( identityId: '' -); \ No newline at end of file +);``` diff --git a/docs/examples/users/delete-mfa-authenticator.md b/docs/examples/users/delete-mfa-authenticator.md index f2f08ec1..15ca8e29 100644 --- a/docs/examples/users/delete-mfa-authenticator.md +++ b/docs/examples/users/delete-mfa-authenticator.md @@ -1,3 +1,4 @@ +```php deleteMFAAuthenticator( userId: '', type: AuthenticatorType::TOTP() -); \ No newline at end of file +);``` diff --git a/docs/examples/users/delete-session.md b/docs/examples/users/delete-session.md index 493cf53d..9786bde4 100644 --- a/docs/examples/users/delete-session.md +++ b/docs/examples/users/delete-session.md @@ -1,3 +1,4 @@ +```php deleteSession( userId: '', sessionId: '' -); \ No newline at end of file +);``` diff --git a/docs/examples/users/delete-sessions.md b/docs/examples/users/delete-sessions.md index cd6d11e1..236aeffe 100644 --- a/docs/examples/users/delete-sessions.md +++ b/docs/examples/users/delete-sessions.md @@ -1,3 +1,4 @@ +```php deleteSessions( userId: '' -); \ No newline at end of file +);``` diff --git a/docs/examples/users/delete-target.md b/docs/examples/users/delete-target.md index 0d85d3e4..6d915dbe 100644 --- a/docs/examples/users/delete-target.md +++ b/docs/examples/users/delete-target.md @@ -1,3 +1,4 @@ +```php deleteTarget( userId: '', targetId: '' -); \ No newline at end of file +);``` diff --git a/docs/examples/users/delete.md b/docs/examples/users/delete.md index 883156ec..faea96cf 100644 --- a/docs/examples/users/delete.md +++ b/docs/examples/users/delete.md @@ -1,3 +1,4 @@ +```php delete( userId: '' -); \ No newline at end of file +);``` diff --git a/docs/examples/users/get-mfa-recovery-codes.md b/docs/examples/users/get-mfa-recovery-codes.md index 7937e6ad..90aa08dd 100644 --- a/docs/examples/users/get-mfa-recovery-codes.md +++ b/docs/examples/users/get-mfa-recovery-codes.md @@ -1,3 +1,4 @@ +```php getMFARecoveryCodes( userId: '' -); \ No newline at end of file +);``` diff --git a/docs/examples/users/get-prefs.md b/docs/examples/users/get-prefs.md index 5e99e14b..931c5be8 100644 --- a/docs/examples/users/get-prefs.md +++ b/docs/examples/users/get-prefs.md @@ -1,3 +1,4 @@ +```php getPrefs( userId: '' -); \ No newline at end of file +);``` diff --git a/docs/examples/users/get-target.md b/docs/examples/users/get-target.md index 31baf3c8..1f3c0028 100644 --- a/docs/examples/users/get-target.md +++ b/docs/examples/users/get-target.md @@ -1,3 +1,4 @@ +```php getTarget( userId: '', targetId: '' -); \ No newline at end of file +);``` diff --git a/docs/examples/users/get.md b/docs/examples/users/get.md index 0ce39ae6..a777b73b 100644 --- a/docs/examples/users/get.md +++ b/docs/examples/users/get.md @@ -1,3 +1,4 @@ +```php get( userId: '' -); \ No newline at end of file +);``` diff --git a/docs/examples/users/list-identities.md b/docs/examples/users/list-identities.md index 9cdc5bce..37074100 100644 --- a/docs/examples/users/list-identities.md +++ b/docs/examples/users/list-identities.md @@ -1,3 +1,4 @@ +```php listIdentities( queries: [], // optional search: '', // optional total: false // optional -); \ No newline at end of file +);``` diff --git a/docs/examples/users/list-logs.md b/docs/examples/users/list-logs.md index 70155262..0d0464e2 100644 --- a/docs/examples/users/list-logs.md +++ b/docs/examples/users/list-logs.md @@ -1,3 +1,4 @@ +```php listLogs( userId: '', queries: [], // optional total: false // optional -); \ No newline at end of file +);``` diff --git a/docs/examples/users/list-memberships.md b/docs/examples/users/list-memberships.md index 9a37fea3..c9b3fb54 100644 --- a/docs/examples/users/list-memberships.md +++ b/docs/examples/users/list-memberships.md @@ -1,3 +1,4 @@ +```php listMemberships( queries: [], // optional search: '', // optional total: false // optional -); \ No newline at end of file +);``` diff --git a/docs/examples/users/list-mfa-factors.md b/docs/examples/users/list-mfa-factors.md index 5dae790c..c3cd0453 100644 --- a/docs/examples/users/list-mfa-factors.md +++ b/docs/examples/users/list-mfa-factors.md @@ -1,3 +1,4 @@ +```php listMFAFactors( userId: '' -); \ No newline at end of file +);``` diff --git a/docs/examples/users/list-sessions.md b/docs/examples/users/list-sessions.md index e657aa24..e4baa40c 100644 --- a/docs/examples/users/list-sessions.md +++ b/docs/examples/users/list-sessions.md @@ -1,3 +1,4 @@ +```php listSessions( userId: '', total: false // optional -); \ No newline at end of file +);``` diff --git a/docs/examples/users/list-targets.md b/docs/examples/users/list-targets.md index 435dbde0..3e33f9f4 100644 --- a/docs/examples/users/list-targets.md +++ b/docs/examples/users/list-targets.md @@ -1,3 +1,4 @@ +```php listTargets( userId: '', queries: [], // optional total: false // optional -); \ No newline at end of file +);``` diff --git a/docs/examples/users/list.md b/docs/examples/users/list.md index 6494f076..39d3189c 100644 --- a/docs/examples/users/list.md +++ b/docs/examples/users/list.md @@ -1,3 +1,4 @@ +```php list( queries: [], // optional search: '', // optional total: false // optional -); \ No newline at end of file +);``` diff --git a/docs/examples/users/update-email-verification.md b/docs/examples/users/update-email-verification.md index 636f1d24..b7a3a912 100644 --- a/docs/examples/users/update-email-verification.md +++ b/docs/examples/users/update-email-verification.md @@ -1,3 +1,4 @@ +```php updateEmailVerification( userId: '', emailVerification: false -); \ No newline at end of file +);``` diff --git a/docs/examples/users/update-email.md b/docs/examples/users/update-email.md index 21ec88b3..2710f496 100644 --- a/docs/examples/users/update-email.md +++ b/docs/examples/users/update-email.md @@ -1,3 +1,4 @@ +```php updateEmail( userId: '', email: 'email@example.com' -); \ No newline at end of file +);``` diff --git a/docs/examples/users/update-labels.md b/docs/examples/users/update-labels.md index 7d4ae5de..56be4fbc 100644 --- a/docs/examples/users/update-labels.md +++ b/docs/examples/users/update-labels.md @@ -1,3 +1,4 @@ +```php updateLabels( userId: '', labels: [] -); \ No newline at end of file +);``` diff --git a/docs/examples/users/update-mfa-recovery-codes.md b/docs/examples/users/update-mfa-recovery-codes.md index 8474755f..bee4d183 100644 --- a/docs/examples/users/update-mfa-recovery-codes.md +++ b/docs/examples/users/update-mfa-recovery-codes.md @@ -1,3 +1,4 @@ +```php updateMFARecoveryCodes( userId: '' -); \ No newline at end of file +);``` diff --git a/docs/examples/users/update-mfa.md b/docs/examples/users/update-mfa.md index c24916a6..9cac2ff9 100644 --- a/docs/examples/users/update-mfa.md +++ b/docs/examples/users/update-mfa.md @@ -1,3 +1,4 @@ +```php updateMFA( userId: '', mfa: false -); \ No newline at end of file +);``` diff --git a/docs/examples/users/update-name.md b/docs/examples/users/update-name.md index 09bb07cd..bce3d8c7 100644 --- a/docs/examples/users/update-name.md +++ b/docs/examples/users/update-name.md @@ -1,3 +1,4 @@ +```php updateName( userId: '', name: '' -); \ No newline at end of file +);``` diff --git a/docs/examples/users/update-password.md b/docs/examples/users/update-password.md index 6d58605d..69d93300 100644 --- a/docs/examples/users/update-password.md +++ b/docs/examples/users/update-password.md @@ -1,3 +1,4 @@ +```php updatePassword( userId: '', password: '' -); \ No newline at end of file +);``` diff --git a/docs/examples/users/update-phone-verification.md b/docs/examples/users/update-phone-verification.md index 019fb3f1..f94b1f84 100644 --- a/docs/examples/users/update-phone-verification.md +++ b/docs/examples/users/update-phone-verification.md @@ -1,3 +1,4 @@ +```php updatePhoneVerification( userId: '', phoneVerification: false -); \ No newline at end of file +);``` diff --git a/docs/examples/users/update-phone.md b/docs/examples/users/update-phone.md index 13bd41bf..c975eaf1 100644 --- a/docs/examples/users/update-phone.md +++ b/docs/examples/users/update-phone.md @@ -1,3 +1,4 @@ +```php updatePhone( userId: '', number: '+12065550100' -); \ No newline at end of file +);``` diff --git a/docs/examples/users/update-prefs.md b/docs/examples/users/update-prefs.md index 94912392..b276922c 100644 --- a/docs/examples/users/update-prefs.md +++ b/docs/examples/users/update-prefs.md @@ -1,3 +1,4 @@ +```php updatePrefs( userId: '', prefs: [] -); \ No newline at end of file +);``` diff --git a/docs/examples/users/update-status.md b/docs/examples/users/update-status.md index f29dc95e..1a8346c0 100644 --- a/docs/examples/users/update-status.md +++ b/docs/examples/users/update-status.md @@ -1,3 +1,4 @@ +```php updateStatus( userId: '', status: false -); \ No newline at end of file +);``` diff --git a/docs/examples/users/update-target.md b/docs/examples/users/update-target.md index 00ad27b9..89635691 100644 --- a/docs/examples/users/update-target.md +++ b/docs/examples/users/update-target.md @@ -1,3 +1,4 @@ +```php updateTarget( identifier: '', // optional providerId: '', // optional name: '' // optional -); \ No newline at end of file +);``` diff --git a/docs/health.md b/docs/health.md index a3818905..4532a8c1 100644 --- a/docs/health.md +++ b/docs/health.md @@ -62,6 +62,32 @@ GET https://cloud.appwrite.io/v1/health/queue/audits | threshold | integer | Queue size threshold. When hit (equal or higher), endpoint returns server error. Default value is 5000. | 5000 | +```http request +GET https://cloud.appwrite.io/v1/health/queue/billing-project-aggregation +``` + +** Get billing project aggregation queue. ** + +### Parameters + +| Field Name | Type | Description | Default | +| --- | --- | --- | --- | +| threshold | integer | Queue size threshold. When hit (equal or higher), endpoint returns server error. Default value is 5000. | 10000 | + + +```http request +GET https://cloud.appwrite.io/v1/health/queue/billing-team-aggregation +``` + +** Get billing team aggregation queue. ** + +### Parameters + +| Field Name | Type | Description | Default | +| --- | --- | --- | --- | +| threshold | integer | Queue size threshold. When hit (equal or higher), endpoint returns server error. Default value is 5000. | 10000 | + + ```http request GET https://cloud.appwrite.io/v1/health/queue/builds ``` @@ -75,6 +101,19 @@ GET https://cloud.appwrite.io/v1/health/queue/builds | threshold | integer | Queue size threshold. When hit (equal or higher), endpoint returns server error. Default value is 5000. | 5000 | +```http request +GET https://cloud.appwrite.io/v1/health/queue/builds-priority +``` + +** Get the priority builds queue size. ** + +### Parameters + +| Field Name | Type | Description | Default | +| --- | --- | --- | --- | +| threshold | integer | Queue size threshold. When hit (equal or higher), endpoint returns server error. Default value is 500. | 500 | + + ```http request GET https://cloud.appwrite.io/v1/health/queue/certificates ``` @@ -195,6 +234,19 @@ GET https://cloud.appwrite.io/v1/health/queue/migrations | threshold | integer | Queue size threshold. When hit (equal or higher), endpoint returns server error. Default value is 5000. | 5000 | +```http request +GET https://cloud.appwrite.io/v1/health/queue/region-manager +``` + +** Get region manager queue. ** + +### Parameters + +| Field Name | Type | Description | Default | +| --- | --- | --- | --- | +| threshold | integer | Queue size threshold. When hit (equal or higher), endpoint returns server error. Default value is 100. | 100 | + + ```http request GET https://cloud.appwrite.io/v1/health/queue/stats-resources ``` @@ -221,6 +273,19 @@ GET https://cloud.appwrite.io/v1/health/queue/stats-usage | threshold | integer | Queue size threshold. When hit (equal or higher), endpoint returns server error. Default value is 5000. | 5000 | +```http request +GET https://cloud.appwrite.io/v1/health/queue/threats +``` + +** Get threats queue. ** + +### Parameters + +| Field Name | Type | Description | Default | +| --- | --- | --- | --- | +| threshold | integer | Queue size threshold. When hit (equal or higher), endpoint returns server error. Default value is 100. | 100 | + + ```http request GET https://cloud.appwrite.io/v1/health/queue/webhooks ``` diff --git a/docs/storage.md b/docs/storage.md index 74960e35..c051c9b5 100644 --- a/docs/storage.md +++ b/docs/storage.md @@ -31,7 +31,7 @@ POST https://cloud.appwrite.io/v1/storage/buckets | permissions | array | An array of permission strings. By default, no user is granted with any permissions. [Learn more about permissions](https://appwrite.io/docs/permissions). | | | fileSecurity | boolean | Enables configuring permissions for individual file. A user needs one of file or bucket level permissions to access a file. [Learn more about permissions](https://appwrite.io/docs/permissions). | | | enabled | boolean | Is bucket enabled? When set to 'disabled', users cannot access the files in this bucket but Server SDKs with and API key can still access the bucket. No files are lost when this is toggled. | 1 | -| maximumFileSize | integer | Maximum file size allowed in bytes. Maximum allowed value is 30MB. | [] | +| maximumFileSize | integer | Maximum file size allowed in bytes. Maximum allowed value is 5GB. | [] | | allowedFileExtensions | array | Allowed file extensions. Maximum of 100 extensions are allowed, each 64 characters long. | [] | | compression | string | Compression algorithm chosen for compression. Can be one of none, [gzip](https://en.wikipedia.org/wiki/Gzip), or [zstd](https://en.wikipedia.org/wiki/Zstd), For file size above 20MB compression is skipped even if it's enabled | none | | encryption | boolean | Is encryption enabled? For file size above 20MB encryption is skipped even if it's enabled | 1 | @@ -67,7 +67,7 @@ PUT https://cloud.appwrite.io/v1/storage/buckets/{bucketId} | permissions | array | An array of permission strings. By default, the current permissions are inherited. [Learn more about permissions](https://appwrite.io/docs/permissions). | | | fileSecurity | boolean | Enables configuring permissions for individual file. A user needs one of file or bucket level permissions to access a file. [Learn more about permissions](https://appwrite.io/docs/permissions). | | | enabled | boolean | Is bucket enabled? When set to 'disabled', users cannot access the files in this bucket but Server SDKs with and API key can still access the bucket. No files are lost when this is toggled. | 1 | -| maximumFileSize | integer | Maximum file size allowed in bytes. Maximum allowed value is 30MB. | [] | +| maximumFileSize | integer | Maximum file size allowed in bytes. Maximum allowed value is 5GB. | [] | | allowedFileExtensions | array | Allowed file extensions. Maximum of 100 extensions are allowed, each 64 characters long. | [] | | compression | string | Compression algorithm chosen for compression. Can be one of none, [gzip](https://en.wikipedia.org/wiki/Gzip), or [zstd](https://en.wikipedia.org/wiki/Zstd), For file size above 20MB compression is skipped even if it's enabled | none | | encryption | boolean | Is encryption enabled? For file size above 20MB encryption is skipped even if it's enabled | 1 | diff --git a/src/Appwrite/Client.php b/src/Appwrite/Client.php index 8d8d89ed..8823ff0b 100644 --- a/src/Appwrite/Client.php +++ b/src/Appwrite/Client.php @@ -37,11 +37,11 @@ class Client */ protected array $headers = [ 'content-type' => '', - 'user-agent' => 'AppwritePHPSDK/20.0.0 ()', + 'user-agent' => 'AppwritePHPSDK/20.1.0 ()', 'x-sdk-name'=> 'PHP', 'x-sdk-platform'=> 'server', 'x-sdk-language'=> 'php', - 'x-sdk-version'=> '20.0.0', + 'x-sdk-version'=> '20.1.0', ]; /** diff --git a/src/Appwrite/Enums/BackupServices.php b/src/Appwrite/Enums/BackupServices.php new file mode 100644 index 00000000..8eb096d1 --- /dev/null +++ b/src/Appwrite/Enums/BackupServices.php @@ -0,0 +1,51 @@ +value = $value; + } + + public function __toString(): string + { + return $this->value; + } + + public function jsonSerialize(): string + { + return $this->value; + } + + public static function DATABASES(): BackupServices + { + if (!isset(self::$DATABASES)) { + self::$DATABASES = new BackupServices('databases'); + } + return self::$DATABASES; + } + public static function FUNCTIONS(): BackupServices + { + if (!isset(self::$FUNCTIONS)) { + self::$FUNCTIONS = new BackupServices('functions'); + } + return self::$FUNCTIONS; + } + public static function STORAGE(): BackupServices + { + if (!isset(self::$STORAGE)) { + self::$STORAGE = new BackupServices('storage'); + } + return self::$STORAGE; + } +} \ No newline at end of file diff --git a/src/Appwrite/Enums/BuildRuntime.php b/src/Appwrite/Enums/BuildRuntime.php index 08065137..a7fe12a5 100644 --- a/src/Appwrite/Enums/BuildRuntime.php +++ b/src/Appwrite/Enums/BuildRuntime.php @@ -28,9 +28,6 @@ class BuildRuntime implements JsonSerializable private static BuildRuntime $PYTHON312; private static BuildRuntime $PYTHONML311; private static BuildRuntime $PYTHONML312; - private static BuildRuntime $DENO121; - private static BuildRuntime $DENO124; - private static BuildRuntime $DENO135; private static BuildRuntime $DENO140; private static BuildRuntime $DENO146; private static BuildRuntime $DENO20; @@ -45,6 +42,7 @@ class BuildRuntime implements JsonSerializable private static BuildRuntime $DART35; private static BuildRuntime $DART38; private static BuildRuntime $DART39; + private static BuildRuntime $DART310; private static BuildRuntime $DOTNET60; private static BuildRuntime $DOTNET70; private static BuildRuntime $DOTNET80; @@ -73,6 +71,7 @@ class BuildRuntime implements JsonSerializable private static BuildRuntime $FLUTTER329; private static BuildRuntime $FLUTTER332; private static BuildRuntime $FLUTTER335; + private static BuildRuntime $FLUTTER338; private string $value; @@ -245,27 +244,6 @@ public static function PYTHONML312(): BuildRuntime } return self::$PYTHONML312; } - public static function DENO121(): BuildRuntime - { - if (!isset(self::$DENO121)) { - self::$DENO121 = new BuildRuntime('deno-1.21'); - } - return self::$DENO121; - } - public static function DENO124(): BuildRuntime - { - if (!isset(self::$DENO124)) { - self::$DENO124 = new BuildRuntime('deno-1.24'); - } - return self::$DENO124; - } - public static function DENO135(): BuildRuntime - { - if (!isset(self::$DENO135)) { - self::$DENO135 = new BuildRuntime('deno-1.35'); - } - return self::$DENO135; - } public static function DENO140(): BuildRuntime { if (!isset(self::$DENO140)) { @@ -364,6 +342,13 @@ public static function DART39(): BuildRuntime } return self::$DART39; } + public static function DART310(): BuildRuntime + { + if (!isset(self::$DART310)) { + self::$DART310 = new BuildRuntime('dart-3.10'); + } + return self::$DART310; + } public static function DOTNET60(): BuildRuntime { if (!isset(self::$DOTNET60)) { @@ -560,4 +545,11 @@ public static function FLUTTER335(): BuildRuntime } return self::$FLUTTER335; } + public static function FLUTTER338(): BuildRuntime + { + if (!isset(self::$FLUTTER338)) { + self::$FLUTTER338 = new BuildRuntime('flutter-3.38'); + } + return self::$FLUTTER338; + } } \ No newline at end of file diff --git a/src/Appwrite/Enums/Roles.php b/src/Appwrite/Enums/Roles.php deleted file mode 100644 index 635c725e..00000000 --- a/src/Appwrite/Enums/Roles.php +++ /dev/null @@ -1,51 +0,0 @@ -value = $value; - } - - public function __toString(): string - { - return $this->value; - } - - public function jsonSerialize(): string - { - return $this->value; - } - - public static function ADMIN(): Roles - { - if (!isset(self::$ADMIN)) { - self::$ADMIN = new Roles('admin'); - } - return self::$ADMIN; - } - public static function DEVELOPER(): Roles - { - if (!isset(self::$DEVELOPER)) { - self::$DEVELOPER = new Roles('developer'); - } - return self::$DEVELOPER; - } - public static function OWNER(): Roles - { - if (!isset(self::$OWNER)) { - self::$OWNER = new Roles('owner'); - } - return self::$OWNER; - } -} \ No newline at end of file diff --git a/src/Appwrite/Enums/Runtime.php b/src/Appwrite/Enums/Runtime.php index 75e78e51..0c5eeab7 100644 --- a/src/Appwrite/Enums/Runtime.php +++ b/src/Appwrite/Enums/Runtime.php @@ -28,9 +28,6 @@ class Runtime implements JsonSerializable private static Runtime $PYTHON312; private static Runtime $PYTHONML311; private static Runtime $PYTHONML312; - private static Runtime $DENO121; - private static Runtime $DENO124; - private static Runtime $DENO135; private static Runtime $DENO140; private static Runtime $DENO146; private static Runtime $DENO20; @@ -45,6 +42,7 @@ class Runtime implements JsonSerializable private static Runtime $DART35; private static Runtime $DART38; private static Runtime $DART39; + private static Runtime $DART310; private static Runtime $DOTNET60; private static Runtime $DOTNET70; private static Runtime $DOTNET80; @@ -73,6 +71,7 @@ class Runtime implements JsonSerializable private static Runtime $FLUTTER329; private static Runtime $FLUTTER332; private static Runtime $FLUTTER335; + private static Runtime $FLUTTER338; private string $value; @@ -245,27 +244,6 @@ public static function PYTHONML312(): Runtime } return self::$PYTHONML312; } - public static function DENO121(): Runtime - { - if (!isset(self::$DENO121)) { - self::$DENO121 = new Runtime('deno-1.21'); - } - return self::$DENO121; - } - public static function DENO124(): Runtime - { - if (!isset(self::$DENO124)) { - self::$DENO124 = new Runtime('deno-1.24'); - } - return self::$DENO124; - } - public static function DENO135(): Runtime - { - if (!isset(self::$DENO135)) { - self::$DENO135 = new Runtime('deno-1.35'); - } - return self::$DENO135; - } public static function DENO140(): Runtime { if (!isset(self::$DENO140)) { @@ -364,6 +342,13 @@ public static function DART39(): Runtime } return self::$DART39; } + public static function DART310(): Runtime + { + if (!isset(self::$DART310)) { + self::$DART310 = new Runtime('dart-3.10'); + } + return self::$DART310; + } public static function DOTNET60(): Runtime { if (!isset(self::$DOTNET60)) { @@ -560,4 +545,11 @@ public static function FLUTTER335(): Runtime } return self::$FLUTTER335; } + public static function FLUTTER338(): Runtime + { + if (!isset(self::$FLUTTER338)) { + self::$FLUTTER338 = new Runtime('flutter-3.38'); + } + return self::$FLUTTER338; + } } \ No newline at end of file diff --git a/src/Appwrite/Enums/Scopes.php b/src/Appwrite/Enums/Scopes.php index aa82645b..9634724c 100644 --- a/src/Appwrite/Enums/Scopes.php +++ b/src/Appwrite/Enums/Scopes.php @@ -61,6 +61,14 @@ class Scopes implements JsonSerializable private static Scopes $ASSISTANTREAD; private static Scopes $TOKENSREAD; private static Scopes $TOKENSWRITE; + private static Scopes $POLICIESWRITE; + private static Scopes $POLICIESREAD; + private static Scopes $ARCHIVESREAD; + private static Scopes $ARCHIVESWRITE; + private static Scopes $RESTORATIONSREAD; + private static Scopes $RESTORATIONSWRITE; + private static Scopes $DOMAINSREAD; + private static Scopes $DOMAINSWRITE; private string $value; @@ -464,4 +472,60 @@ public static function TOKENSWRITE(): Scopes } return self::$TOKENSWRITE; } + public static function POLICIESWRITE(): Scopes + { + if (!isset(self::$POLICIESWRITE)) { + self::$POLICIESWRITE = new Scopes('policies.write'); + } + return self::$POLICIESWRITE; + } + public static function POLICIESREAD(): Scopes + { + if (!isset(self::$POLICIESREAD)) { + self::$POLICIESREAD = new Scopes('policies.read'); + } + return self::$POLICIESREAD; + } + public static function ARCHIVESREAD(): Scopes + { + if (!isset(self::$ARCHIVESREAD)) { + self::$ARCHIVESREAD = new Scopes('archives.read'); + } + return self::$ARCHIVESREAD; + } + public static function ARCHIVESWRITE(): Scopes + { + if (!isset(self::$ARCHIVESWRITE)) { + self::$ARCHIVESWRITE = new Scopes('archives.write'); + } + return self::$ARCHIVESWRITE; + } + public static function RESTORATIONSREAD(): Scopes + { + if (!isset(self::$RESTORATIONSREAD)) { + self::$RESTORATIONSREAD = new Scopes('restorations.read'); + } + return self::$RESTORATIONSREAD; + } + public static function RESTORATIONSWRITE(): Scopes + { + if (!isset(self::$RESTORATIONSWRITE)) { + self::$RESTORATIONSWRITE = new Scopes('restorations.write'); + } + return self::$RESTORATIONSWRITE; + } + public static function DOMAINSREAD(): Scopes + { + if (!isset(self::$DOMAINSREAD)) { + self::$DOMAINSREAD = new Scopes('domains.read'); + } + return self::$DOMAINSREAD; + } + public static function DOMAINSWRITE(): Scopes + { + if (!isset(self::$DOMAINSWRITE)) { + self::$DOMAINSWRITE = new Scopes('domains.write'); + } + return self::$DOMAINSWRITE; + } } \ No newline at end of file diff --git a/src/Appwrite/Services/Backups.php b/src/Appwrite/Services/Backups.php new file mode 100644 index 00000000..bca41ac4 --- /dev/null +++ b/src/Appwrite/Services/Backups.php @@ -0,0 +1,411 @@ +client->call( + Client::METHOD_GET, + $apiPath, + $apiHeaders, + $apiParams + ); + } + + /** + * Create a new archive asynchronously for a project. + * + * @param array $services + * @param ?string $resourceId + * @throws AppwriteException + * @return array + */ + public function createArchive(array $services, ?string $resourceId = null): array + { + $apiPath = str_replace( + [], + [], + '/backups/archives' + ); + + $apiParams = []; + $apiParams['services'] = $services; + $apiParams['resourceId'] = $resourceId; + + $apiHeaders = []; + $apiHeaders['content-type'] = 'application/json'; + + return $this->client->call( + Client::METHOD_POST, + $apiPath, + $apiHeaders, + $apiParams + ); + } + + /** + * Get a backup archive using it's ID. + * + * @param string $archiveId + * @throws AppwriteException + * @return array + */ + public function getArchive(string $archiveId): array + { + $apiPath = str_replace( + ['{archiveId}'], + [$archiveId], + '/backups/archives/{archiveId}' + ); + + $apiParams = []; + $apiParams['archiveId'] = $archiveId; + + $apiHeaders = []; + + return $this->client->call( + Client::METHOD_GET, + $apiPath, + $apiHeaders, + $apiParams + ); + } + + /** + * Delete an existing archive for a project. + * + * @param string $archiveId + * @throws AppwriteException + * @return string + */ + public function deleteArchive(string $archiveId): string + { + $apiPath = str_replace( + ['{archiveId}'], + [$archiveId], + '/backups/archives/{archiveId}' + ); + + $apiParams = []; + $apiParams['archiveId'] = $archiveId; + + $apiHeaders = []; + $apiHeaders['content-type'] = 'application/json'; + + return $this->client->call( + Client::METHOD_DELETE, + $apiPath, + $apiHeaders, + $apiParams + ); + } + + /** + * List all policies for a project. + * + * @param ?array $queries + * @throws AppwriteException + * @return array + */ + public function listPolicies(?array $queries = null): array + { + $apiPath = str_replace( + [], + [], + '/backups/policies' + ); + + $apiParams = []; + + if (!is_null($queries)) { + $apiParams['queries'] = $queries; + } + + $apiHeaders = []; + + return $this->client->call( + Client::METHOD_GET, + $apiPath, + $apiHeaders, + $apiParams + ); + } + + /** + * Create a new backup policy. + * + * @param string $policyId + * @param array $services + * @param int $retention + * @param string $schedule + * @param ?string $name + * @param ?string $resourceId + * @param ?bool $enabled + * @throws AppwriteException + * @return array + */ + public function createPolicy(string $policyId, array $services, int $retention, string $schedule, ?string $name = null, ?string $resourceId = null, ?bool $enabled = null): array + { + $apiPath = str_replace( + [], + [], + '/backups/policies' + ); + + $apiParams = []; + $apiParams['policyId'] = $policyId; + $apiParams['services'] = $services; + $apiParams['retention'] = $retention; + $apiParams['schedule'] = $schedule; + + if (!is_null($name)) { + $apiParams['name'] = $name; + } + $apiParams['resourceId'] = $resourceId; + + if (!is_null($enabled)) { + $apiParams['enabled'] = $enabled; + } + + $apiHeaders = []; + $apiHeaders['content-type'] = 'application/json'; + + return $this->client->call( + Client::METHOD_POST, + $apiPath, + $apiHeaders, + $apiParams + ); + } + + /** + * Get a backup policy using it's ID. + * + * @param string $policyId + * @throws AppwriteException + * @return array + */ + public function getPolicy(string $policyId): array + { + $apiPath = str_replace( + ['{policyId}'], + [$policyId], + '/backups/policies/{policyId}' + ); + + $apiParams = []; + $apiParams['policyId'] = $policyId; + + $apiHeaders = []; + + return $this->client->call( + Client::METHOD_GET, + $apiPath, + $apiHeaders, + $apiParams + ); + } + + /** + * Update an existing policy using it's ID. + * + * @param string $policyId + * @param ?string $name + * @param ?int $retention + * @param ?string $schedule + * @param ?bool $enabled + * @throws AppwriteException + * @return array + */ + public function updatePolicy(string $policyId, ?string $name = null, ?int $retention = null, ?string $schedule = null, ?bool $enabled = null): array + { + $apiPath = str_replace( + ['{policyId}'], + [$policyId], + '/backups/policies/{policyId}' + ); + + $apiParams = []; + $apiParams['policyId'] = $policyId; + $apiParams['name'] = $name; + $apiParams['retention'] = $retention; + + if (!is_null($schedule)) { + $apiParams['schedule'] = $schedule; + } + $apiParams['enabled'] = $enabled; + + $apiHeaders = []; + $apiHeaders['content-type'] = 'application/json'; + + return $this->client->call( + Client::METHOD_PATCH, + $apiPath, + $apiHeaders, + $apiParams + ); + } + + /** + * Delete a policy using it's ID. + * + * @param string $policyId + * @throws AppwriteException + * @return string + */ + public function deletePolicy(string $policyId): string + { + $apiPath = str_replace( + ['{policyId}'], + [$policyId], + '/backups/policies/{policyId}' + ); + + $apiParams = []; + $apiParams['policyId'] = $policyId; + + $apiHeaders = []; + $apiHeaders['content-type'] = 'application/json'; + + return $this->client->call( + Client::METHOD_DELETE, + $apiPath, + $apiHeaders, + $apiParams + ); + } + + /** + * Create and trigger a new restoration for a backup on a project. + * + * @param string $archiveId + * @param array $services + * @param ?string $newResourceId + * @param ?string $newResourceName + * @throws AppwriteException + * @return array + */ + public function createRestoration(string $archiveId, array $services, ?string $newResourceId = null, ?string $newResourceName = null): array + { + $apiPath = str_replace( + [], + [], + '/backups/restoration' + ); + + $apiParams = []; + $apiParams['archiveId'] = $archiveId; + $apiParams['services'] = $services; + + if (!is_null($newResourceId)) { + $apiParams['newResourceId'] = $newResourceId; + } + + if (!is_null($newResourceName)) { + $apiParams['newResourceName'] = $newResourceName; + } + + $apiHeaders = []; + $apiHeaders['content-type'] = 'application/json'; + + return $this->client->call( + Client::METHOD_POST, + $apiPath, + $apiHeaders, + $apiParams + ); + } + + /** + * List all backup restorations for a project. + * + * @param ?array $queries + * @throws AppwriteException + * @return array + */ + public function listRestorations(?array $queries = null): array + { + $apiPath = str_replace( + [], + [], + '/backups/restorations' + ); + + $apiParams = []; + + if (!is_null($queries)) { + $apiParams['queries'] = $queries; + } + + $apiHeaders = []; + + return $this->client->call( + Client::METHOD_GET, + $apiPath, + $apiHeaders, + $apiParams + ); + } + + /** + * Get the current status of a backup restoration. + * + * @param string $restorationId + * @throws AppwriteException + * @return array + */ + public function getRestoration(string $restorationId): array + { + $apiPath = str_replace( + ['{restorationId}'], + [$restorationId], + '/backups/restorations/{restorationId}' + ); + + $apiParams = []; + $apiParams['restorationId'] = $restorationId; + + $apiHeaders = []; + + return $this->client->call( + Client::METHOD_GET, + $apiPath, + $apiHeaders, + $apiParams + ); + } +} \ No newline at end of file diff --git a/src/Appwrite/Services/Health.php b/src/Appwrite/Services/Health.php index c4a694b2..0644a0f6 100644 --- a/src/Appwrite/Services/Health.php +++ b/src/Appwrite/Services/Health.php @@ -209,6 +209,68 @@ public function getQueueAudits(?int $threshold = null): array ); } + /** + * Get billing project aggregation queue. + * + * @param ?int $threshold + * @throws AppwriteException + * @return array + */ + public function getQueueBillingProjectAggregation(?int $threshold = null): array + { + $apiPath = str_replace( + [], + [], + '/health/queue/billing-project-aggregation' + ); + + $apiParams = []; + + if (!is_null($threshold)) { + $apiParams['threshold'] = $threshold; + } + + $apiHeaders = []; + + return $this->client->call( + Client::METHOD_GET, + $apiPath, + $apiHeaders, + $apiParams + ); + } + + /** + * Get billing team aggregation queue. + * + * @param ?int $threshold + * @throws AppwriteException + * @return array + */ + public function getQueueBillingTeamAggregation(?int $threshold = null): array + { + $apiPath = str_replace( + [], + [], + '/health/queue/billing-team-aggregation' + ); + + $apiParams = []; + + if (!is_null($threshold)) { + $apiParams['threshold'] = $threshold; + } + + $apiHeaders = []; + + return $this->client->call( + Client::METHOD_GET, + $apiPath, + $apiHeaders, + $apiParams + ); + } + /** * Get the number of builds that are waiting to be processed in the Appwrite * internal queue server. @@ -241,6 +303,37 @@ public function getQueueBuilds(?int $threshold = null): array ); } + /** + * Get the priority builds queue size. + * + * @param ?int $threshold + * @throws AppwriteException + * @return array + */ + public function getQueuePriorityBuilds(?int $threshold = null): array + { + $apiPath = str_replace( + [], + [], + '/health/queue/builds-priority' + ); + + $apiParams = []; + + if (!is_null($threshold)) { + $apiParams['threshold'] = $threshold; + } + + $apiHeaders = []; + + return $this->client->call( + Client::METHOD_GET, + $apiPath, + $apiHeaders, + $apiParams + ); + } + /** * Get the number of certificates that are waiting to be issued against * [Letsencrypt](https://letsencrypt.org/) in the Appwrite internal queue @@ -537,6 +630,37 @@ public function getQueueMigrations(?int $threshold = null): array ); } + /** + * Get region manager queue. + * + * @param ?int $threshold + * @throws AppwriteException + * @return array + */ + public function getQueueRegionManager(?int $threshold = null): array + { + $apiPath = str_replace( + [], + [], + '/health/queue/region-manager' + ); + + $apiParams = []; + + if (!is_null($threshold)) { + $apiParams['threshold'] = $threshold; + } + + $apiHeaders = []; + + return $this->client->call( + Client::METHOD_GET, + $apiPath, + $apiHeaders, + $apiParams + ); + } + /** * Get the number of metrics that are waiting to be processed in the Appwrite * stats resources queue. @@ -601,6 +725,37 @@ public function getQueueUsage(?int $threshold = null): array ); } + /** + * Get threats queue. + * + * @param ?int $threshold + * @throws AppwriteException + * @return array + */ + public function getQueueThreats(?int $threshold = null): array + { + $apiPath = str_replace( + [], + [], + '/health/queue/threats' + ); + + $apiParams = []; + + if (!is_null($threshold)) { + $apiParams['threshold'] = $threshold; + } + + $apiHeaders = []; + + return $this->client->call( + Client::METHOD_GET, + $apiPath, + $apiHeaders, + $apiParams + ); + } + /** * Get the number of webhooks that are waiting to be processed in the Appwrite * internal queue server. diff --git a/src/Appwrite/Services/Teams.php b/src/Appwrite/Services/Teams.php index 99c5226a..3f3480e3 100644 --- a/src/Appwrite/Services/Teams.php +++ b/src/Appwrite/Services/Teams.php @@ -6,7 +6,6 @@ use Appwrite\Client; use Appwrite\Service; use Appwrite\InputFile; -use Appwrite\Enums\Roles; class Teams extends Service { diff --git a/tests/Appwrite/Services/BackupsTest.php b/tests/Appwrite/Services/BackupsTest.php new file mode 100644 index 00000000..c485ef76 --- /dev/null +++ b/tests/Appwrite/Services/BackupsTest.php @@ -0,0 +1,276 @@ +client = Mockery::mock(Client::class); + $this->backups = new Backups($this->client); + } + + public function testMethodListArchives(): void { + + $data = array( + "total" => 5, + "archives" => array()); + + $this->client + ->allows()->call(Mockery::any(), Mockery::any(), Mockery::any(), Mockery::any()) + ->andReturn($data); + + $response = $this->backups->listArchives( + ); + + $this->assertSame($data, $response); + } + + public function testMethodCreateArchive(): void { + + $data = array( + "\$id" => "5e5ea5c16897e", + "\$createdAt" => "2020-10-15T06:38:00.000+00:00", + "\$updatedAt" => "2020-10-15T06:38:00.000+00:00", + "policyId" => "did8jx6ws45jana098ab7", + "size" => 100000, + "status" => "completed", + "startedAt" => "2020-10-15T06:38:00.000+00:00", + "migrationId" => "did8jx6ws45jana098ab7", + "services" => array(), + "resources" => array()); + + $this->client + ->allows()->call(Mockery::any(), Mockery::any(), Mockery::any(), Mockery::any()) + ->andReturn($data); + + $response = $this->backups->createArchive( + array(BackupServices::DATABASES()) + ); + + $this->assertSame($data, $response); + } + + public function testMethodGetArchive(): void { + + $data = array( + "\$id" => "5e5ea5c16897e", + "\$createdAt" => "2020-10-15T06:38:00.000+00:00", + "\$updatedAt" => "2020-10-15T06:38:00.000+00:00", + "policyId" => "did8jx6ws45jana098ab7", + "size" => 100000, + "status" => "completed", + "startedAt" => "2020-10-15T06:38:00.000+00:00", + "migrationId" => "did8jx6ws45jana098ab7", + "services" => array(), + "resources" => array()); + + $this->client + ->allows()->call(Mockery::any(), Mockery::any(), Mockery::any(), Mockery::any()) + ->andReturn($data); + + $response = $this->backups->getArchive( + "" + ); + + $this->assertSame($data, $response); + } + + public function testMethodDeleteArchive(): void { + + $data = ''; + + $this->client + ->allows()->call(Mockery::any(), Mockery::any(), Mockery::any(), Mockery::any()) + ->andReturn($data); + + $response = $this->backups->deleteArchive( + "" + ); + + $this->assertSame($data, $response); + } + + public function testMethodListPolicies(): void { + + $data = array( + "total" => 5, + "policies" => array()); + + $this->client + ->allows()->call(Mockery::any(), Mockery::any(), Mockery::any(), Mockery::any()) + ->andReturn($data); + + $response = $this->backups->listPolicies( + ); + + $this->assertSame($data, $response); + } + + public function testMethodCreatePolicy(): void { + + $data = array( + "\$id" => "5e5ea5c16897e", + "name" => "Hourly backups", + "\$createdAt" => "2020-10-15T06:38:00.000+00:00", + "\$updatedAt" => "2020-10-15T06:38:00.000+00:00", + "services" => array(), + "resources" => array(), + "retention" => 7, + "schedule" => "0 * * * *", + "enabled" => true); + + $this->client + ->allows()->call(Mockery::any(), Mockery::any(), Mockery::any(), Mockery::any()) + ->andReturn($data); + + $response = $this->backups->createPolicy( + "", + array(BackupServices::DATABASES()), + 1, + "" + ); + + $this->assertSame($data, $response); + } + + public function testMethodGetPolicy(): void { + + $data = array( + "\$id" => "5e5ea5c16897e", + "name" => "Hourly backups", + "\$createdAt" => "2020-10-15T06:38:00.000+00:00", + "\$updatedAt" => "2020-10-15T06:38:00.000+00:00", + "services" => array(), + "resources" => array(), + "retention" => 7, + "schedule" => "0 * * * *", + "enabled" => true); + + $this->client + ->allows()->call(Mockery::any(), Mockery::any(), Mockery::any(), Mockery::any()) + ->andReturn($data); + + $response = $this->backups->getPolicy( + "" + ); + + $this->assertSame($data, $response); + } + + public function testMethodUpdatePolicy(): void { + + $data = array( + "\$id" => "5e5ea5c16897e", + "name" => "Hourly backups", + "\$createdAt" => "2020-10-15T06:38:00.000+00:00", + "\$updatedAt" => "2020-10-15T06:38:00.000+00:00", + "services" => array(), + "resources" => array(), + "retention" => 7, + "schedule" => "0 * * * *", + "enabled" => true); + + $this->client + ->allows()->call(Mockery::any(), Mockery::any(), Mockery::any(), Mockery::any()) + ->andReturn($data); + + $response = $this->backups->updatePolicy( + "" + ); + + $this->assertSame($data, $response); + } + + public function testMethodDeletePolicy(): void { + + $data = ''; + + $this->client + ->allows()->call(Mockery::any(), Mockery::any(), Mockery::any(), Mockery::any()) + ->andReturn($data); + + $response = $this->backups->deletePolicy( + "" + ); + + $this->assertSame($data, $response); + } + + public function testMethodCreateRestoration(): void { + + $data = array( + "\$id" => "5e5ea5c16897e", + "\$createdAt" => "2020-10-15T06:38:00.000+00:00", + "\$updatedAt" => "2020-10-15T06:38:00.000+00:00", + "archiveId" => "did8jx6ws45jana098ab7", + "policyId" => "did8jx6ws45jana098ab7", + "status" => "completed", + "startedAt" => "2020-10-15T06:38:00.000+00:00", + "migrationId" => "did8jx6ws45jana098ab7", + "services" => array(), + "resources" => array(), + "options" => "{databases.database[{oldId, newId, newName}]}"); + + $this->client + ->allows()->call(Mockery::any(), Mockery::any(), Mockery::any(), Mockery::any()) + ->andReturn($data); + + $response = $this->backups->createRestoration( + "", + array(BackupServices::DATABASES()) + ); + + $this->assertSame($data, $response); + } + + public function testMethodListRestorations(): void { + + $data = array( + "total" => 5, + "restorations" => array()); + + $this->client + ->allows()->call(Mockery::any(), Mockery::any(), Mockery::any(), Mockery::any()) + ->andReturn($data); + + $response = $this->backups->listRestorations( + ); + + $this->assertSame($data, $response); + } + + public function testMethodGetRestoration(): void { + + $data = array( + "\$id" => "5e5ea5c16897e", + "\$createdAt" => "2020-10-15T06:38:00.000+00:00", + "\$updatedAt" => "2020-10-15T06:38:00.000+00:00", + "archiveId" => "did8jx6ws45jana098ab7", + "policyId" => "did8jx6ws45jana098ab7", + "status" => "completed", + "startedAt" => "2020-10-15T06:38:00.000+00:00", + "migrationId" => "did8jx6ws45jana098ab7", + "services" => array(), + "resources" => array(), + "options" => "{databases.database[{oldId, newId, newName}]}"); + + $this->client + ->allows()->call(Mockery::any(), Mockery::any(), Mockery::any(), Mockery::any()) + ->andReturn($data); + + $response = $this->backups->getRestoration( + "" + ); + + $this->assertSame($data, $response); + } + +} diff --git a/tests/Appwrite/Services/DatabasesTest.php b/tests/Appwrite/Services/DatabasesTest.php index 23f2d44b..551944cb 100644 --- a/tests/Appwrite/Services/DatabasesTest.php +++ b/tests/Appwrite/Services/DatabasesTest.php @@ -44,7 +44,9 @@ public function testMethodCreate(): void { "\$createdAt" => "2020-10-15T06:38:00.000+00:00", "\$updatedAt" => "2020-10-15T06:38:00.000+00:00", "enabled" => true, - "type" => "legacy"); + "type" => "legacy", + "policies" => array(), + "archives" => array()); $this->client ->allows()->call(Mockery::any(), Mockery::any(), Mockery::any(), Mockery::any()) @@ -180,7 +182,9 @@ public function testMethodGet(): void { "\$createdAt" => "2020-10-15T06:38:00.000+00:00", "\$updatedAt" => "2020-10-15T06:38:00.000+00:00", "enabled" => true, - "type" => "legacy"); + "type" => "legacy", + "policies" => array(), + "archives" => array()); $this->client ->allows()->call(Mockery::any(), Mockery::any(), Mockery::any(), Mockery::any()) @@ -201,7 +205,9 @@ public function testMethodUpdate(): void { "\$createdAt" => "2020-10-15T06:38:00.000+00:00", "\$updatedAt" => "2020-10-15T06:38:00.000+00:00", "enabled" => true, - "type" => "legacy"); + "type" => "legacy", + "policies" => array(), + "archives" => array()); $this->client ->allows()->call(Mockery::any(), Mockery::any(), Mockery::any(), Mockery::any()) @@ -258,7 +264,9 @@ public function testMethodCreateCollection(): void { "enabled" => true, "documentSecurity" => true, "attributes" => array(), - "indexes" => array()); + "indexes" => array(), + "bytesMax" => 65535, + "bytesUsed" => 1500); $this->client ->allows()->call(Mockery::any(), Mockery::any(), Mockery::any(), Mockery::any()) @@ -285,7 +293,9 @@ public function testMethodGetCollection(): void { "enabled" => true, "documentSecurity" => true, "attributes" => array(), - "indexes" => array()); + "indexes" => array(), + "bytesMax" => 65535, + "bytesUsed" => 1500); $this->client ->allows()->call(Mockery::any(), Mockery::any(), Mockery::any(), Mockery::any()) @@ -311,7 +321,9 @@ public function testMethodUpdateCollection(): void { "enabled" => true, "documentSecurity" => true, "attributes" => array(), - "indexes" => array()); + "indexes" => array(), + "bytesMax" => 65535, + "bytesUsed" => 1500); $this->client ->allows()->call(Mockery::any(), Mockery::any(), Mockery::any(), Mockery::any()) diff --git a/tests/Appwrite/Services/HealthTest.php b/tests/Appwrite/Services/HealthTest.php index 28c637ca..bf501d92 100644 --- a/tests/Appwrite/Services/HealthTest.php +++ b/tests/Appwrite/Services/HealthTest.php @@ -133,6 +133,36 @@ public function testMethodGetQueueAudits(): void { $this->assertSame($data, $response); } + public function testMethodGetQueueBillingProjectAggregation(): void { + + $data = array( + "size" => 8); + + $this->client + ->allows()->call(Mockery::any(), Mockery::any(), Mockery::any(), Mockery::any()) + ->andReturn($data); + + $response = $this->health->getQueueBillingProjectAggregation( + ); + + $this->assertSame($data, $response); + } + + public function testMethodGetQueueBillingTeamAggregation(): void { + + $data = array( + "size" => 8); + + $this->client + ->allows()->call(Mockery::any(), Mockery::any(), Mockery::any(), Mockery::any()) + ->andReturn($data); + + $response = $this->health->getQueueBillingTeamAggregation( + ); + + $this->assertSame($data, $response); + } + public function testMethodGetQueueBuilds(): void { $data = array( @@ -148,6 +178,21 @@ public function testMethodGetQueueBuilds(): void { $this->assertSame($data, $response); } + public function testMethodGetQueuePriorityBuilds(): void { + + $data = array( + "size" => 8); + + $this->client + ->allows()->call(Mockery::any(), Mockery::any(), Mockery::any(), Mockery::any()) + ->andReturn($data); + + $response = $this->health->getQueuePriorityBuilds( + ); + + $this->assertSame($data, $response); + } + public function testMethodGetQueueCertificates(): void { $data = array( @@ -284,6 +329,21 @@ public function testMethodGetQueueMigrations(): void { $this->assertSame($data, $response); } + public function testMethodGetQueueRegionManager(): void { + + $data = array( + "size" => 8); + + $this->client + ->allows()->call(Mockery::any(), Mockery::any(), Mockery::any(), Mockery::any()) + ->andReturn($data); + + $response = $this->health->getQueueRegionManager( + ); + + $this->assertSame($data, $response); + } + public function testMethodGetQueueStatsResources(): void { $data = array( @@ -314,6 +374,21 @@ public function testMethodGetQueueUsage(): void { $this->assertSame($data, $response); } + public function testMethodGetQueueThreats(): void { + + $data = array( + "size" => 8); + + $this->client + ->allows()->call(Mockery::any(), Mockery::any(), Mockery::any(), Mockery::any()) + ->andReturn($data); + + $response = $this->health->getQueueThreats( + ); + + $this->assertSame($data, $response); + } + public function testMethodGetQueueWebhooks(): void { $data = array( diff --git a/tests/Appwrite/Services/TablesDBTest.php b/tests/Appwrite/Services/TablesDBTest.php index 38893c1d..fb91185a 100644 --- a/tests/Appwrite/Services/TablesDBTest.php +++ b/tests/Appwrite/Services/TablesDBTest.php @@ -44,7 +44,9 @@ public function testMethodCreate(): void { "\$createdAt" => "2020-10-15T06:38:00.000+00:00", "\$updatedAt" => "2020-10-15T06:38:00.000+00:00", "enabled" => true, - "type" => "legacy"); + "type" => "legacy", + "policies" => array(), + "archives" => array()); $this->client ->allows()->call(Mockery::any(), Mockery::any(), Mockery::any(), Mockery::any()) @@ -180,7 +182,9 @@ public function testMethodGet(): void { "\$createdAt" => "2020-10-15T06:38:00.000+00:00", "\$updatedAt" => "2020-10-15T06:38:00.000+00:00", "enabled" => true, - "type" => "legacy"); + "type" => "legacy", + "policies" => array(), + "archives" => array()); $this->client ->allows()->call(Mockery::any(), Mockery::any(), Mockery::any(), Mockery::any()) @@ -201,7 +205,9 @@ public function testMethodUpdate(): void { "\$createdAt" => "2020-10-15T06:38:00.000+00:00", "\$updatedAt" => "2020-10-15T06:38:00.000+00:00", "enabled" => true, - "type" => "legacy"); + "type" => "legacy", + "policies" => array(), + "archives" => array()); $this->client ->allows()->call(Mockery::any(), Mockery::any(), Mockery::any(), Mockery::any()) @@ -258,7 +264,9 @@ public function testMethodCreateTable(): void { "enabled" => true, "rowSecurity" => true, "columns" => array(), - "indexes" => array()); + "indexes" => array(), + "bytesMax" => 65535, + "bytesUsed" => 1500); $this->client ->allows()->call(Mockery::any(), Mockery::any(), Mockery::any(), Mockery::any()) @@ -285,7 +293,9 @@ public function testMethodGetTable(): void { "enabled" => true, "rowSecurity" => true, "columns" => array(), - "indexes" => array()); + "indexes" => array(), + "bytesMax" => 65535, + "bytesUsed" => 1500); $this->client ->allows()->call(Mockery::any(), Mockery::any(), Mockery::any(), Mockery::any()) @@ -311,7 +321,9 @@ public function testMethodUpdateTable(): void { "enabled" => true, "rowSecurity" => true, "columns" => array(), - "indexes" => array()); + "indexes" => array(), + "bytesMax" => 65535, + "bytesUsed" => 1500); $this->client ->allows()->call(Mockery::any(), Mockery::any(), Mockery::any(), Mockery::any()) diff --git a/tests/Appwrite/Services/TeamsTest.php b/tests/Appwrite/Services/TeamsTest.php index f9438d5a..d909af55 100644 --- a/tests/Appwrite/Services/TeamsTest.php +++ b/tests/Appwrite/Services/TeamsTest.php @@ -6,7 +6,6 @@ use Appwrite\InputFile; use Mockery; use PHPUnit\Framework\TestCase; -use Appwrite\Enums\Roles; final class TeamsTest extends TestCase { private $client; @@ -153,7 +152,7 @@ public function testMethodCreateMembership(): void { $response = $this->teams->createMembership( "", - array(Roles::ADMIN()) + array() ); $this->assertSame($data, $response); @@ -212,7 +211,7 @@ public function testMethodUpdateMembership(): void { $response = $this->teams->updateMembership( "", "", - array(Roles::ADMIN()) + array() ); $this->assertSame($data, $response);