feat: PHP SDK update for version 20.1.0

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<BrowserPermission>`).
@@ -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
+* Add `sequence` support to `Document` model

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)
 

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. |  |
+

docs/examples/account/create-anonymous-session.md

@@ -1,3 +1,4 @@
+```php
 <?php
 
 use Appwrite\Client;
@@ -11,3 +12,4 @@ $client = (new Client())
 $account = new Account($client);
 
 $result = $account->createAnonymousSession();
+```

docs/examples/account/create-email-password-session.md

@@ -1,3 +1,4 @@
+```php
 <?php
 
 use Appwrite\Client;
@@ -13,4 +14,4 @@ $account = new Account($client);
 $result = $account->createEmailPasswordSession(
     email: 'email@example.com',
     password: 'password'
-);
+);```

docs/examples/account/create-email-token.md

@@ -1,3 +1,4 @@
+```php
 <?php
 
 use Appwrite\Client;
@@ -14,4 +15,4 @@ $result = $account->createEmailToken(
     userId: '<USER_ID>',
     email: 'email@example.com',
     phrase: false // optional
-);
+);```

docs/examples/account/create-email-verification.md

@@ -1,3 +1,4 @@
+```php
 <?php
 
 use Appwrite\Client;
@@ -12,4 +13,4 @@ $account = new Account($client);
 
 $result = $account->createEmailVerification(
     url: 'https://example.com'
-);
+);```

docs/examples/account/create-jwt.md

@@ -1,3 +1,4 @@
+```php
 <?php
 
 use Appwrite\Client;
@@ -12,4 +13,4 @@ $account = new Account($client);
 
 $result = $account->createJWT(
     duration: 0 // optional
-);
+);```

docs/examples/account/create-magic-url-token.md

@@ -1,3 +1,4 @@
+```php
 <?php
 
 use Appwrite\Client;
@@ -15,4 +16,4 @@ $result = $account->createMagicURLToken(
     email: 'email@example.com',
     url: 'https://example.com', // optional
     phrase: false // optional
-);
+);```

docs/examples/account/create-mfa-authenticator.md

@@ -1,3 +1,4 @@
+```php
 <?php
 
 use Appwrite\Client;
@@ -13,4 +14,4 @@ $account = new Account($client);
 
 $result = $account->createMFAAuthenticator(
     type: AuthenticatorType::TOTP()
-);
+);```

docs/examples/account/create-mfa-challenge.md

@@ -1,3 +1,4 @@
+```php
 <?php
 
 use Appwrite\Client;
@@ -13,4 +14,4 @@ $account = new Account($client);
 
 $result = $account->createMFAChallenge(
     factor: AuthenticationFactor::EMAIL()
-);
+);```

docs/examples/account/create-mfa-recovery-codes.md

@@ -1,3 +1,4 @@
+```php
 <?php
 
 use Appwrite\Client;
@@ -11,3 +12,4 @@ $client = (new Client())
 $account = new Account($client);
 
 $result = $account->createMFARecoveryCodes();
+```

docs/examples/account/create-o-auth-2-token.md

@@ -1,3 +1,4 @@
+```php
 <?php
 
 use Appwrite\Client;
@@ -16,4 +17,4 @@ $result = $account->createOAuth2Token(
     success: 'https://example.com', // optional
     failure: 'https://example.com', // optional
     scopes: [] // optional
-);
+);```

docs/examples/account/create-phone-token.md

@@ -1,3 +1,4 @@
+```php
 <?php
 
 use Appwrite\Client;
@@ -13,4 +14,4 @@ $account = new Account($client);
 $result = $account->createPhoneToken(
     userId: '<USER_ID>',
     phone: '+12065550100'
-);
+);```

docs/examples/account/create-phone-verification.md

@@ -1,3 +1,4 @@
+```php
 <?php
 
 use Appwrite\Client;
@@ -11,3 +12,4 @@ $client = (new Client())
 $account = new Account($client);
 
 $result = $account->createPhoneVerification();
+```

docs/examples/account/create-recovery.md

@@ -1,3 +1,4 @@
+```php
 <?php
 
 use Appwrite\Client;
@@ -13,4 +14,4 @@ $account = new Account($client);
 $result = $account->createRecovery(
     email: 'email@example.com',
     url: 'https://example.com'
-);
+);```

docs/examples/account/create-session.md

@@ -1,3 +1,4 @@
+```php
 <?php
 
 use Appwrite\Client;
@@ -13,4 +14,4 @@ $account = new Account($client);
 $result = $account->createSession(
     userId: '<USER_ID>',
     secret: '<SECRET>'
-);
+);```

docs/examples/account/create-verification.md

@@ -1,3 +1,4 @@
+```php
 <?php
 
 use Appwrite\Client;
@@ -12,4 +13,4 @@ $account = new Account($client);
 
 $result = $account->createVerification(
     url: 'https://example.com'
-);
+);```

docs/examples/account/create.md

@@ -1,3 +1,4 @@
+```php
 <?php
 
 use Appwrite\Client;
@@ -15,4 +16,4 @@ $result = $account->create(
     email: 'email@example.com',
     password: '',
     name: '<NAME>' // optional
-);
+);```

docs/examples/account/delete-identity.md

@@ -1,3 +1,4 @@
+```php
 <?php
 
 use Appwrite\Client;
@@ -12,4 +13,4 @@ $account = new Account($client);
 
 $result = $account->deleteIdentity(
     identityId: '<IDENTITY_ID>'
-);
+);```