feat: PHP SDK update for version 24.0.0

CHANGELOG.md

@@ -1,5 +1,21 @@
 # Change Log
 
+## 24.0.0
+
+* Breaking: Renamed `AuthMethod` enum to `ProjectAuthMethodId`
+* Breaking: Renamed `EmailTemplateType` to `ProjectEmailTemplateId` and `EmailTemplateLocale` to `ProjectEmailTemplateLocale`
+* Breaking: Renamed `ServiceId` to `ProjectServiceId`, `ProtocolId` to `ProjectProtocolId`, `Secure` to `ProjectSMTPSecure`, `ProjectPolicy` to `ProjectPolicyId`
+* Breaking: Replaced `Scopes` enum with `ProjectKeyScopes` for project key endpoints
+* Breaking: Removed `updateDenyCanonicalEmailPolicy`; replaced with `updateDenyAliasedEmailPolicy`, `updateDenyDisposableEmailPolicy`, and `updateDenyFreeEmailPolicy`
+* Breaking: Removed `AuthProvider` model; use new `ProjectOAuthProviderId` enum instead
+* Added: `Project::get` method to fetch current project details
+* Added: `Advisor`, `Presences`, and `Usage` services
+* Added: `Insight`, `Presence`, `Report`, `UsageEvent`, and `UsageGauge` models with list variants
+* Added: `ProjectAuthMethod`, `ProjectProtocol`, and `ProjectService` models
+* Added: `ProjectOAuthProviderId` and `ProjectOAuth2GooglePrompt` enums
+* Updated: `Project`, `Database`, and `OAuth2Google` model schemas
+* Updated: `X-Appwrite-Response-Format` header to `1.9.5`
+
 ## 23.1.1
 
 * Fixed: `Database` model `policies` and `archives` now hydrate as `BackupPolicy` / `BackupArchive` instead of `Index` / `Collection`

README.md

@@ -1,7 +1,7 @@
 # Appwrite PHP SDK
 
 ![License](https://img.shields.io/github/license/appwrite/sdk-for-php.svg?style=flat-square&v=1)
-![Version](https://img.shields.io/badge/api%20version-1.9.4-blue.svg?style=flat-square&v=1)
+![Version](https://img.shields.io/badge/api%20version-1.9.5-blue.svg?style=flat-square&v=1)
 [![Build Status](https://img.shields.io/travis/com/appwrite/sdk-generator?style=flat-square)](https://travis-ci.com/appwrite/sdk-generator)
 [![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)

docs/advisor.md

@@ -0,0 +1,76 @@
+# Advisor Service
+
+
+```http request
+GET https://cloud.appwrite.io/v1/reports
+```
+
+** Get a list of all the project's analyzer reports. You can use the query params to filter your results.
+ **
+
+### 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. You may filter on the following attributes: appId, type, targetType, target, analyzedAt | [] |
+| total | boolean | When set to false, the total count returned will be 0 and will not be calculated. | 1 |
+
+
+```http request
+GET https://cloud.appwrite.io/v1/reports/{reportId}
+```
+
+** Get an analyzer report by its unique ID. The response includes the report's metadata and the nested insights it produced.
+ **
+
+### Parameters
+
+| Field Name | Type | Description | Default |
+| --- | --- | --- | --- |
+| reportId | string | **Required** Report ID. |  |
+
+
+```http request
+DELETE https://cloud.appwrite.io/v1/reports/{reportId}
+```
+
+** Delete an analyzer report by its unique ID. Nested insights and CTA metadata are removed asynchronously by the deletes worker.
+ **
+
+### Parameters
+
+| Field Name | Type | Description | Default |
+| --- | --- | --- | --- |
+| reportId | string | **Required** Report ID. |  |
+
+
+```http request
+GET https://cloud.appwrite.io/v1/reports/{reportId}/insights
+```
+
+** List the insights produced under a single analyzer report. You can use the query params to filter your results further.
+ **
+
+### Parameters
+
+| Field Name | Type | Description | Default |
+| --- | --- | --- | --- |
+| reportId | string | **Required** Parent report ID. |  |
+| 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. You may filter on the following attributes: type, severity, status, resourceType, resourceId, parentResourceType, parentResourceId, analyzedAt, dismissedAt, dismissedBy | [] |
+| total | boolean | When set to false, the total count returned will be 0 and will not be calculated. | 1 |
+
+
+```http request
+GET https://cloud.appwrite.io/v1/reports/{reportId}/insights/{insightId}
+```
+
+** Get an insight by its unique ID, scoped to its parent report.
+ **
+
+### Parameters
+
+| Field Name | Type | Description | Default |
+| --- | --- | --- | --- |
+| reportId | string | **Required** Parent report ID. |  |
+| insightId | string | **Required** Insight ID. |  |
+

docs/examples/advisor/delete-report.md

@@ -0,0 +1,16 @@
+```php
+<?php
+
+use Appwrite\Client;
+use Appwrite\Services\Advisor;
+
+$client = (new Client())
+    ->setEndpoint('https://<REGION>.cloud.appwrite.io/v1') // Your API Endpoint
+    ->setProject('<YOUR_PROJECT_ID>') // Your project ID
+    ->setKey('<YOUR_API_KEY>'); // Your secret API key
+
+$advisor = new Advisor($client);
+
+$result = $advisor->deleteReport(
+    reportId: '<REPORT_ID>'
+);```

docs/examples/advisor/get-insight.md

@@ -0,0 +1,17 @@
+```php
+<?php
+
+use Appwrite\Client;
+use Appwrite\Services\Advisor;
+
+$client = (new Client())
+    ->setEndpoint('https://<REGION>.cloud.appwrite.io/v1') // Your API Endpoint
+    ->setProject('<YOUR_PROJECT_ID>') // Your project ID
+    ->setSession(''); // The user session to authenticate with
+
+$advisor = new Advisor($client);
+
+$result = $advisor->getInsight(
+    reportId: '<REPORT_ID>',
+    insightId: '<INSIGHT_ID>'
+);```

docs/examples/advisor/get-report.md

@@ -0,0 +1,16 @@
+```php
+<?php
+
+use Appwrite\Client;
+use Appwrite\Services\Advisor;
+
+$client = (new Client())
+    ->setEndpoint('https://<REGION>.cloud.appwrite.io/v1') // Your API Endpoint
+    ->setProject('<YOUR_PROJECT_ID>') // Your project ID
+    ->setSession(''); // The user session to authenticate with
+
+$advisor = new Advisor($client);
+
+$result = $advisor->getReport(
+    reportId: '<REPORT_ID>'
+);```

docs/examples/advisor/list-insights.md

@@ -0,0 +1,18 @@
+```php
+<?php
+
+use Appwrite\Client;
+use Appwrite\Services\Advisor;
+
+$client = (new Client())
+    ->setEndpoint('https://<REGION>.cloud.appwrite.io/v1') // Your API Endpoint
+    ->setProject('<YOUR_PROJECT_ID>') // Your project ID
+    ->setSession(''); // The user session to authenticate with
+
+$advisor = new Advisor($client);
+
+$result = $advisor->listInsights(
+    reportId: '<REPORT_ID>',
+    queries: [], // optional
+    total: false // optional
+);```

docs/examples/advisor/list-reports.md

@@ -0,0 +1,17 @@
+```php
+<?php
+
+use Appwrite\Client;
+use Appwrite\Services\Advisor;
+
+$client = (new Client())
+    ->setEndpoint('https://<REGION>.cloud.appwrite.io/v1') // Your API Endpoint
+    ->setProject('<YOUR_PROJECT_ID>') // Your project ID
+    ->setSession(''); // The user session to authenticate with
+
+$advisor = new Advisor($client);
+
+$result = $advisor->listReports(
+    queries: [], // optional
+    total: false // optional
+);```

docs/examples/presences/delete.md

@@ -0,0 +1,16 @@
+```php
+<?php
+
+use Appwrite\Client;
+use Appwrite\Services\Presences;
+
+$client = (new Client())
+    ->setEndpoint('https://<REGION>.cloud.appwrite.io/v1') // Your API Endpoint
+    ->setProject('<YOUR_PROJECT_ID>') // Your project ID
+    ->setKey('<YOUR_API_KEY>'); // Your secret API key
+
+$presences = new Presences($client);
+
+$result = $presences->delete(
+    presenceId: '<PRESENCE_ID>'
+);```

docs/examples/presences/get.md

@@ -0,0 +1,16 @@
+```php
+<?php
+
+use Appwrite\Client;
+use Appwrite\Services\Presences;
+
+$client = (new Client())
+    ->setEndpoint('https://<REGION>.cloud.appwrite.io/v1') // Your API Endpoint
+    ->setProject('<YOUR_PROJECT_ID>') // Your project ID
+    ->setKey('<YOUR_API_KEY>'); // Your secret API key
+
+$presences = new Presences($client);
+
+$result = $presences->get(
+    presenceId: '<PRESENCE_ID>'
+);```

docs/examples/presences/list.md

@@ -0,0 +1,18 @@
+```php
+<?php
+
+use Appwrite\Client;
+use Appwrite\Services\Presences;
+
+$client = (new Client())
+    ->setEndpoint('https://<REGION>.cloud.appwrite.io/v1') // Your API Endpoint
+    ->setProject('<YOUR_PROJECT_ID>') // Your project ID
+    ->setKey('<YOUR_API_KEY>'); // Your secret API key
+
+$presences = new Presences($client);
+
+$result = $presences->list(
+    queries: [], // optional
+    total: false, // optional
+    ttl: 0 // optional
+);```

docs/examples/presences/update-presence.md

@@ -0,0 +1,24 @@
+```php
+<?php
+
+use Appwrite\Client;
+use Appwrite\Services\Presences;
+use Appwrite\Permission;
+use Appwrite\Role;
+
+$client = (new Client())
+    ->setEndpoint('https://<REGION>.cloud.appwrite.io/v1') // Your API Endpoint
+    ->setProject('<YOUR_PROJECT_ID>') // Your project ID
+    ->setKey('<YOUR_API_KEY>'); // Your secret API key
+
+$presences = new Presences($client);
+
+$result = $presences->updatePresence(
+    presenceId: '<PRESENCE_ID>',
+    userId: '<USER_ID>',
+    status: '<STATUS>', // optional
+    expiresAt: '2020-10-15T06:38:00.000+00:00', // optional
+    metadata: [], // optional
+    permissions: [Permission::read(Role::any())], // optional
+    purge: false // optional
+);```

docs/examples/presences/upsert.md

@@ -0,0 +1,23 @@
+```php
+<?php
+
+use Appwrite\Client;
+use Appwrite\Services\Presences;
+use Appwrite\Permission;
+use Appwrite\Role;
+
+$client = (new Client())
+    ->setEndpoint('https://<REGION>.cloud.appwrite.io/v1') // Your API Endpoint
+    ->setProject('<YOUR_PROJECT_ID>') // Your project ID
+    ->setKey('<YOUR_API_KEY>'); // Your secret API key
+
+$presences = new Presences($client);
+
+$result = $presences->upsert(
+    presenceId: '<PRESENCE_ID>',
+    userId: '<USER_ID>',
+    status: '<STATUS>',
+    permissions: [Permission::read(Role::any())], // optional
+    expiresAt: '2020-10-15T06:38:00.000+00:00', // optional
+    metadata: [] // optional
+);```

docs/examples/project/create-ephemeral-key.md

@@ -3,7 +3,7 @@
 
 use Appwrite\Client;
 use Appwrite\Services\Project;
-use Appwrite\Enums\Scopes;
+use Appwrite\Enums\ProjectKeyScopes;
 
 $client = (new Client())
     ->setEndpoint('https://<REGION>.cloud.appwrite.io/v1') // Your API Endpoint
@@ -13,6 +13,6 @@ $client = (new Client())
 $project = new Project($client);
 
 $result = $project->createEphemeralKey(
-    scopes: [Scopes::PROJECTREAD()],
+    scopes: [ProjectKeyScopes::PROJECTREAD()],
     duration: 600
 );```

docs/examples/project/create-key.md

@@ -3,7 +3,7 @@
 
 use Appwrite\Client;
 use Appwrite\Services\Project;
-use Appwrite\Enums\Scopes;
+use Appwrite\Enums\ProjectKeyScopes;
 
 $client = (new Client())
     ->setEndpoint('https://<REGION>.cloud.appwrite.io/v1') // Your API Endpoint
@@ -15,6 +15,6 @@ $project = new Project($client);
 $result = $project->createKey(
     keyId: '<KEY_ID>',
     name: '<NAME>',
-    scopes: [Scopes::PROJECTREAD()],
+    scopes: [ProjectKeyScopes::PROJECTREAD()],
     expire: '2020-10-15T06:38:00.000+00:00' // optional
 );```

docs/examples/project/get-email-template.md

@@ -3,8 +3,8 @@
 
 use Appwrite\Client;
 use Appwrite\Services\Project;
-use Appwrite\Enums\EmailTemplateType;
-use Appwrite\Enums\EmailTemplateLocale;
+use Appwrite\Enums\ProjectEmailTemplateId;
+use Appwrite\Enums\ProjectEmailTemplateLocale;
 
 $client = (new Client())
     ->setEndpoint('https://<REGION>.cloud.appwrite.io/v1') // Your API Endpoint
@@ -14,6 +14,6 @@ $client = (new Client())
 $project = new Project($client);
 
 $result = $project->getEmailTemplate(
-    templateId: EmailTemplateType::VERIFICATION(),
-    locale: EmailTemplateLocale::AF() // optional
+    templateId: ProjectEmailTemplateId::VERIFICATION(),
+    locale: ProjectEmailTemplateLocale::AF() // optional
 );```

docs/examples/project/get-o-auth-2-provider.md

@@ -3,7 +3,7 @@
 
 use Appwrite\Client;
 use Appwrite\Services\Project;
-use Appwrite\Enums\OAuthProvider;
+use Appwrite\Enums\ProjectOAuthProviderId;
 
 $client = (new Client())
     ->setEndpoint('https://<REGION>.cloud.appwrite.io/v1') // Your API Endpoint
@@ -13,5 +13,5 @@ $client = (new Client())
 $project = new Project($client);
 
 $result = $project->getOAuth2Provider(
-    providerId: OAuthProvider::AMAZON()
+    providerId: ProjectOAuthProviderId::AMAZON()
 );```

docs/examples/project/get-policy.md

@@ -3,7 +3,7 @@
 
 use Appwrite\Client;
 use Appwrite\Services\Project;
-use Appwrite\Enums\ProjectPolicy;
+use Appwrite\Enums\ProjectPolicyId;
 
 $client = (new Client())
     ->setEndpoint('https://<REGION>.cloud.appwrite.io/v1') // Your API Endpoint
@@ -13,5 +13,5 @@ $client = (new Client())
 $project = new Project($client);
 
 $result = $project->getPolicy(
-    policyId: ProjectPolicy::PASSWORDDICTIONARY()
+    policyId: ProjectPolicyId::PASSWORDDICTIONARY()
 );```