Skip to content

Commit 18f68a9

Browse files
committed
feat: SDK update for version 1.9.1
1 parent 38546dd commit 18f68a9

223 files changed

Lines changed: 14461 additions & 3198 deletions

File tree

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

.github/ISSUE_TEMPLATE/bug.yaml

Lines changed: 0 additions & 82 deletions
This file was deleted.

.github/ISSUE_TEMPLATE/documentation.yaml

Lines changed: 0 additions & 32 deletions
This file was deleted.

.github/ISSUE_TEMPLATE/feature.yaml

Lines changed: 0 additions & 40 deletions
This file was deleted.

.github/workflows/autoclose.yml

Lines changed: 0 additions & 11 deletions
This file was deleted.

CHANGELOG.md

Lines changed: 15 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,20 @@
11
# Change Log
22

3+
## 23.0.0
4+
5+
* [BREAKING] Renamed Webhook model fields: `security``tls`, `httpUser``authUsername`, `httpPass``authPassword`, `signatureKey``secret`
6+
* [BREAKING] Renamed Webhook service parameters to match: `security``tls`, `httpUser``authUsername`, `httpPass``authPassword`
7+
* Added `secret` parameter to Webhook create and update methods
8+
* Added `x` OAuth provider to `OAuthProvider` enum
9+
* Added `userType` field to `Log` model
10+
* Added `purge` parameter to `updateCollection` and `updateTable` for cache invalidation
11+
* Added Project service: platform CRUD, key CRUD, protocol/service status management
12+
* Added new models: `Key`, `KeyList`, `PlatformAndroid`, `PlatformApple`, `PlatformLinux`, `PlatformList`, and others
13+
* Added new enums: `PlatformType`, `ProtocolId`, `ServiceId`
14+
* Updated `BuildRuntime`, `Runtime`, `Scopes` enums with new values
15+
* Updated `X-Appwrite-Response-Format` header to `1.9.1`
16+
* Updated TTL description for list caching in Databases and TablesDB
17+
318
## 22.0.0
419

520
* [BREAKING] Raised minimum PHP version from 8.0 to 8.2

README.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
# Appwrite PHP SDK
22

33
![License](https://img.shields.io/github/license/appwrite/sdk-for-php.svg?style=flat-square&v=1)
4-
![Version](https://img.shields.io/badge/api%20version-1.9.0-blue.svg?style=flat-square&v=1)
4+
![Version](https://img.shields.io/badge/api%20version-1.9.1-blue.svg?style=flat-square&v=1)
55
[![Build Status](https://img.shields.io/travis/com/appwrite/sdk-generator?style=flat-square)](https://travis-ci.com/appwrite/sdk-generator)
66
[![Twitter Account](https://img.shields.io/twitter/follow/appwrite?color=00acee&label=twitter&style=flat-square)](https://twitter.com/appwrite)
77
[![Discord](https://img.shields.io/discord/564160730845151244?label=discord&style=flat-square)](https://appwrite.io/discord)

docs/account.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -565,7 +565,7 @@ A user is limited to 10 active sessions at a time by default. [Learn more about
565565

566566
| Field Name | Type | Description | Default |
567567
| --- | --- | --- | --- |
568-
| provider | string | **Required** OAuth2 Provider. Currently, supported providers are: amazon, apple, auth0, authentik, autodesk, bitbucket, bitly, box, dailymotion, discord, disqus, dropbox, etsy, facebook, figma, github, gitlab, google, linkedin, microsoft, notion, oidc, okta, paypal, paypalSandbox, podio, salesforce, slack, spotify, stripe, tradeshift, tradeshiftBox, twitch, wordpress, yahoo, yammer, yandex, zoho, zoom. | |
568+
| provider | string | **Required** OAuth2 Provider. Currently, supported providers are: amazon, apple, auth0, authentik, autodesk, bitbucket, bitly, box, dailymotion, discord, disqus, dropbox, etsy, facebook, figma, github, gitlab, google, linkedin, microsoft, notion, oidc, okta, paypal, paypalSandbox, podio, salesforce, slack, spotify, stripe, tradeshift, tradeshiftBox, twitch, wordpress, x, yahoo, yammer, yandex, zoho, zoom. | |
569569
| success | string | URL to redirect back to your app after a successful login attempt. Only URLs from hostnames in your project's platform list are allowed. This requirement helps to prevent an [open redirect](https://cheatsheetseries.owasp.org/cheatsheets/Unvalidated_Redirects_and_Forwards_Cheat_Sheet.html) attack against your project API. | |
570570
| failure | string | URL to redirect back to your app after a failed login attempt. Only URLs from hostnames in your project's platform list are allowed. This requirement helps to prevent an [open redirect](https://cheatsheetseries.owasp.org/cheatsheets/Unvalidated_Redirects_and_Forwards_Cheat_Sheet.html) attack against your project API. | |
571571
| scopes | array | A list of custom OAuth2 scopes. Check each provider internal docs for a list of supported scopes. Maximum of 100 scopes are allowed, each 4096 characters long. | [] |

docs/databases.md

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -220,6 +220,7 @@ PUT https://cloud.appwrite.io/v1/databases/{databaseId}/collections/{collectionI
220220
| permissions | array | An array of permission strings. By default, the current permissions are inherited. [Learn more about permissions](https://appwrite.io/docs/permissions). | |
221221
| documentSecurity | boolean | Enables configuring permissions for individual documents. A user needs one of document or collection level permissions to access a document. [Learn more about permissions](https://appwrite.io/docs/permissions). | |
222222
| enabled | boolean | Is collection enabled? When set to 'disabled', users cannot access the collection but Server SDKs with and API key can still read and write to the collection. No data is lost when this is toggled. | 1 |
223+
| purge | boolean | When true, purge all cached list responses for this collection as part of the update. Use this to force readers to see fresh data immediately instead of waiting for the cache TTL to expire. | |
223224

224225

225226
```http request
@@ -951,7 +952,7 @@ GET https://cloud.appwrite.io/v1/databases/{databaseId}/collections/{collectionI
951952
| 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. | [] |
952953
| transactionId | string | Transaction ID to read uncommitted changes within the transaction. | |
953954
| total | boolean | When set to false, the total count returned will be 0 and will not be calculated. | 1 |
954-
| ttl | integer | TTL (seconds) for cached responses when caching is enabled for select queries. Must be between 0 and 86400 (24 hours). | 0 |
955+
| ttl | integer | TTL (seconds) for caching list responses. Responses are stored in an in-memory key-value cache, keyed per project, collection, schema version (attributes and indexes), caller authorization roles, and the exact query — so users with different permissions never share cached entries. Schema changes invalidate cached entries automatically; document writes do not, so choose a TTL you are comfortable serving as stale data. Set to 0 to disable caching. Must be between 0 and 86400 (24 hours). | 0 |
955956

956957

957958
```http request

docs/examples/databases/update-collection.md

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -19,5 +19,6 @@ $result = $databases->updateCollection(
1919
name: '<NAME>', // optional
2020
permissions: [Permission::read(Role::any())], // optional
2121
documentSecurity: false, // optional
22-
enabled: false // optional
22+
enabled: false, // optional
23+
purge: false // optional
2324
);```
Lines changed: 18 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,18 @@
1+
```php
2+
<?php
3+
4+
use Appwrite\Client;
5+
use Appwrite\Services\Project;
6+
7+
$client = (new Client())
8+
->setEndpoint('https://<REGION>.cloud.appwrite.io/v1') // Your API Endpoint
9+
->setProject('<YOUR_PROJECT_ID>') // Your project ID
10+
->setKey('<YOUR_API_KEY>'); // Your secret API key
11+
12+
$project = new Project($client);
13+
14+
$result = $project->createAndroidPlatform(
15+
platformId: '<PLATFORM_ID>',
16+
name: '<NAME>',
17+
applicationId: '<APPLICATION_ID>'
18+
);```

0 commit comments

Comments
 (0)