Skip to content

Commit 181d299

Browse files
TorstenDittmannTorstenDittmann
committed
feat: support for 0.14.x
1 parent 9ca7a24 commit 181d299

18 files changed

+167
-105
lines changed

‎README.md

+2-2
Original file line numberDiff line numberDiff line change
@@ -1,12 +1,12 @@
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-0.13.0-blue.svg?style=flat-square&v=1)
4+
![Version](https://img.shields.io/badge/api%20version-0.14.0-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)
88

9-
**This SDK is compatible with Appwrite server version 0.13.x. For older versions, please check [previous releases](https://github.com/appwrite/sdk-for-php/releases).**
9+
**This SDK is compatible with Appwrite server version 0.14.x. For older versions, please check [previous releases](https://github.com/appwrite/sdk-for-php/releases).**
1010

1111
Appwrite is an open-source backend as a service server that abstract and simplify 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)
1212

‎docs/account.md

+11-9
Original file line numberDiff line numberDiff line change
@@ -8,14 +8,6 @@ GET https://HOSTNAME/v1/account
88

99
** Get currently logged in user data as JSON object. **
1010

11-
## Delete Account
12-
13-
```http request
14-
DELETE https://HOSTNAME/v1/account
15-
```
16-
17-
** Delete a currently logged in user account. Behind the scene, the user record is not deleted but permanently blocked from any access. This is done to avoid deleted accounts being overtaken by new users with the same email address. Any user-related resources like documents or storage files should be deleted separately. **
18-
1911
## Update Account Email
2012

2113
```http request
@@ -68,7 +60,7 @@ PATCH https://HOSTNAME/v1/account/name
6860
PATCH https://HOSTNAME/v1/account/password
6961
```
7062

71-
** Update currently logged in user password. For validation, user is required to pass in the new password, and the old password. For users created with OAuth and Team Invites, oldPassword is optional. **
63+
** Update currently logged in user password. For validation, user is required to pass in the new password, and the old password. For users created with OAuth, Team Invites and Magic URL, oldPassword is optional. **
7264

7365
### Parameters
7466

@@ -169,6 +161,8 @@ GET https://HOSTNAME/v1/account/sessions/{sessionId}
169161
PATCH https://HOSTNAME/v1/account/sessions/{sessionId}
170162
```
171163

164+
** Access tokens have limited lifespan and expire to mitigate security risks. If session was created using an OAuth provider, this route can be used to "refresh" the access token. **
165+
172166
### Parameters
173167

174168
| Field Name | Type | Description | Default |
@@ -190,6 +184,14 @@ DELETE https://HOSTNAME/v1/account/sessions/{sessionId}
190184
| --- | --- | --- | --- |
191185
| sessionId | string | **Required** Session ID. Use the string 'current' to delete the current device session. | |
192186

187+
## Update Account Status
188+
189+
```http request
190+
PATCH https://HOSTNAME/v1/account/status
191+
```
192+
193+
** Block the currently logged in user account. Behind the scene, the user record is not deleted but permanently blocked from any access. To completely delete a user, use the Users API instead. **
194+
193195
## Create Email Verification
194196

195197
```http request

‎docs/avatars.md

+24-9
Original file line numberDiff line numberDiff line change
@@ -6,7 +6,9 @@
66
GET https://HOSTNAME/v1/avatars/browsers/{code}
77
```
88

9-
** You can use this endpoint to show different browser icons to your users. The code argument receives the browser code as it appears in your user /account/sessions endpoint. Use width, height and quality arguments to change the output settings. **
9+
** You can use this endpoint to show different browser icons to your users. The code argument receives the browser code as it appears in your user [GET /account/sessions](/docs/client/account#accountGetSessions) endpoint. Use width, height and quality arguments to change the output settings.
10+
11+
When one dimension is specified and the other is 0, the image is scaled with preserved aspect ratio. If both dimensions are 0, the API provides an image at source quality. If dimensions are not specified, the default size of image returned is 100x100px. **
1012

1113
### Parameters
1214

@@ -23,7 +25,10 @@ GET https://HOSTNAME/v1/avatars/browsers/{code}
2325
GET https://HOSTNAME/v1/avatars/credit-cards/{code}
2426
```
2527

26-
** The credit card endpoint will return you the icon of the credit card provider you need. Use width, height and quality arguments to change the output settings. **
28+
** The credit card endpoint will return you the icon of the credit card provider you need. Use width, height and quality arguments to change the output settings.
29+
30+
When one dimension is specified and the other is 0, the image is scaled with preserved aspect ratio. If both dimensions are 0, the API provides an image at source quality. If dimensions are not specified, the default size of image returned is 100x100px.
31+
**
2732

2833
### Parameters
2934

@@ -55,7 +60,10 @@ GET https://HOSTNAME/v1/avatars/favicon
5560
GET https://HOSTNAME/v1/avatars/flags/{code}
5661
```
5762

58-
** You can use this endpoint to show different country flags icons to your users. The code argument receives the 2 letter country code. Use width, height and quality arguments to change the output settings. **
63+
** You can use this endpoint to show different country flags icons to your users. The code argument receives the 2 letter country code. Use width, height and quality arguments to change the output settings.
64+
65+
When one dimension is specified and the other is 0, the image is scaled with preserved aspect ratio. If both dimensions are 0, the API provides an image at source quality. If dimensions are not specified, the default size of image returned is 100x100px.
66+
**
5967

6068
### Parameters
6169

@@ -72,15 +80,18 @@ GET https://HOSTNAME/v1/avatars/flags/{code}
7280
GET https://HOSTNAME/v1/avatars/image
7381
```
7482

75-
** Use this endpoint to fetch a remote image URL and crop it to any image size you want. This endpoint is very useful if you need to crop and display remote images in your app or in case you want to make sure a 3rd party image is properly served using a TLS protocol. **
83+
** Use this endpoint to fetch a remote image URL and crop it to any image size you want. This endpoint is very useful if you need to crop and display remote images in your app or in case you want to make sure a 3rd party image is properly served using a TLS protocol.
84+
85+
When one dimension is specified and the other is 0, the image is scaled with preserved aspect ratio. If both dimensions are 0, the API provides an image at source quality. If dimensions are not specified, the default size of image returned is 400x400px.
86+
**
7687

7788
### Parameters
7889

7990
| Field Name | Type | Description | Default |
8091
| --- | --- | --- | --- |
8192
| url | string | **Required** Image URL which you want to crop. | |
82-
| width | integer | Resize preview image width, Pass an integer between 0 to 2000. | 400 |
83-
| height | integer | Resize preview image height, Pass an integer between 0 to 2000. | 400 |
93+
| width | integer | Resize preview image width, Pass an integer between 0 to 2000. Defaults to 400. | 400 |
94+
| height | integer | Resize preview image height, Pass an integer between 0 to 2000. Defaults to 400. | 400 |
8495

8596
## Get User Initials
8697

@@ -90,7 +101,10 @@ GET https://HOSTNAME/v1/avatars/initials
90101

91102
** Use this endpoint to show your user initials avatar icon on your website or app. By default, this route will try to print your logged-in user name or email initials. You can also overwrite the user name if you pass the 'name' parameter. If no name is given and no user is logged, an empty avatar will be returned.
92103

93-
You can use the color and background params to change the avatar colors. By default, a random theme will be selected. The random theme will persist for the user's initials when reloading the same theme will always return for the same initials. **
104+
You can use the color and background params to change the avatar colors. By default, a random theme will be selected. The random theme will persist for the user's initials when reloading the same theme will always return for the same initials.
105+
106+
When one dimension is specified and the other is 0, the image is scaled with preserved aspect ratio. If both dimensions are 0, the API provides an image at source quality. If dimensions are not specified, the default size of image returned is 100x100px.
107+
**
94108

95109
### Parameters
96110

@@ -108,14 +122,15 @@ You can use the color and background params to change the avatar colors. By defa
108122
GET https://HOSTNAME/v1/avatars/qr
109123
```
110124

111-
** Converts a given plain text to a QR code image. You can use the query parameters to change the size and style of the resulting image. **
125+
** Converts a given plain text to a QR code image. You can use the query parameters to change the size and style of the resulting image.
126+
**
112127

113128
### Parameters
114129

115130
| Field Name | Type | Description | Default |
116131
| --- | --- | --- | --- |
117132
| text | string | **Required** Plain text to be converted to QR code image. | |
118-
| size | integer | QR code size. Pass an integer between 0 to 1000. Defaults to 400. | 400 |
133+
| size | integer | QR code size. Pass an integer between 1 to 1000. Defaults to 400. | 400 |
119134
| margin | integer | Margin from edge. Pass an integer between 0 to 10. Defaults to 1. | 1 |
120135
| download | boolean | Return resulting image with 'Content-Disposition: attachment ' headers for the browser to start downloading it. Pass 0 for no header, or 1 for otherwise. Default value is set to 0. | |
121136

‎docs/database.md

+9-9
Original file line numberDiff line numberDiff line change
@@ -33,7 +33,7 @@ POST https://HOSTNAME/v1/database/collections
3333
| --- | --- | --- | --- |
3434
| collectionId | string | Unique Id. Choose your own unique ID or pass the string "unique()" to auto generate it. 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. | |
3535
| name | string | Collection name. Max length: 128 chars. | |
36-
| permission | string | Permissions type model to use for reading documents in this collection. You can use collection-level permission set once on the collection using the `read` and `write` params, or you can set document-level permission where each document read and write params will decide who has access to read and write to each document individually. [learn more about permissions](https://appwrite.io/docs/permissions) and get a full list of available permissions. | |
36+
| permission | string | Specifies the permissions model used in this collection, which accepts either 'collection' or 'document'. For 'collection' level permission, the permissions specified in read and write params are applied to all documents in the collection. For 'document' level permissions, read and write permissions are specified in each document. [learn more about permissions](https://appwrite.io/docs/permissions) and get a full list of available permissions. | |
3737
| read | array | An array of strings with read permissions. By default no user is granted with any read permissions. [learn more about permissions](https://appwrite.io/docs/permissions) and get a full list of available permissions. | |
3838
| write | array | An array of strings with write permissions. By default no user is granted with any write permissions. [learn more about permissions](https://appwrite.io/docs/permissions) and get a full list of available permissions. | |
3939

@@ -146,7 +146,7 @@ POST https://HOSTNAME/v1/database/collections/{collectionId}/attributes/enum
146146
| --- | --- | --- | --- |
147147
| collectionId | string | **Required** Collection ID. You can create a new collection using the Database service [server integration](https://appwrite.io/docs/server/database#createCollection). | |
148148
| key | string | Attribute Key. | |
149-
| elements | array | Array of elements in enumerated type. Uses length of longest element to determine size. | |
149+
| elements | array | Array of elements in enumerated type. Uses length of longest element to determine size. Maximum of 100 elements are allowed, each 1024 characters long. | |
150150
| required | boolean | Is attribute required? | |
151151
| default | string | Default value for attribute when not provided. Cannot be set when attribute is required. | |
152152
| array | boolean | Is attribute an array? | |
@@ -290,13 +290,13 @@ GET https://HOSTNAME/v1/database/collections/{collectionId}/documents
290290
| Field Name | Type | Description | Default |
291291
| --- | --- | --- | --- |
292292
| collectionId | string | **Required** Collection ID. You can create a new collection using the Database service [server integration](https://appwrite.io/docs/server/database#createCollection). | |
293-
| queries | array | Array of query strings. | [] |
293+
| queries | array | Array of query strings generated using the Query class provided by the SDK. [Learn more about queries](https://appwrite.io/docs/database#querying-documents). Maximum of 100 queries are allowed, each 128 characters long. | [] |
294294
| limit | integer | Maximum number of documents to return in response. By default will return maximum 25 results. Maximum of 100 results allowed per request. | 25 |
295295
| offset | integer | Offset value. The default value is 0. Use this value to manage pagination. [learn more about pagination](https://appwrite.io/docs/pagination) | 0 |
296296
| cursor | string | ID of the document used as the starting point for the query, excluding the document itself. Should be used for efficient pagination when working with large sets of data. [learn more about pagination](https://appwrite.io/docs/pagination) | |
297297
| cursorDirection | string | Direction of the cursor. | after |
298-
| orderAttributes | array | Array of attributes used to sort results. | [] |
299-
| orderTypes | array | Array of order directions for sorting attribtues. Possible values are DESC for descending order, or ASC for ascending order. | [] |
298+
| orderAttributes | array | Array of attributes used to sort results. Maximum of 100 order attributes are allowed, each 128 characters long. | [] |
299+
| orderTypes | array | Array of order directions for sorting attribtues. Possible values are DESC for descending order, or ASC for ascending order. Maximum of 100 order types are allowed. | [] |
300300

301301
## Create Document
302302

@@ -345,7 +345,7 @@ PATCH https://HOSTNAME/v1/database/collections/{collectionId}/documents/{documen
345345
| --- | --- | --- | --- |
346346
| collectionId | string | **Required** Collection ID. | |
347347
| documentId | string | **Required** Document ID. | |
348-
| data | object | Document data as JSON object. | {} |
348+
| data | object | Document data as JSON object. Include only attribute and value pairs to be updated. | {} |
349349
| read | array | An array of strings with read permissions. By default inherits the existing read permissions. [learn more about permissions](https://appwrite.io/docs/permissions) and get a full list of available permissions. | |
350350
| write | array | An array of strings with write permissions. By default inherits the existing write permissions. [learn more about permissions](https://appwrite.io/docs/permissions) and get a full list of available permissions. | |
351351

@@ -355,7 +355,7 @@ PATCH https://HOSTNAME/v1/database/collections/{collectionId}/documents/{documen
355355
DELETE https://HOSTNAME/v1/database/collections/{collectionId}/documents/{documentId}
356356
```
357357

358-
** Delete a document by its unique ID. This endpoint deletes only the parent documents, its attributes and relations to other documents. Child documents **will not** be deleted. **
358+
** Delete a document by its unique ID. **
359359

360360
### Parameters
361361

@@ -389,8 +389,8 @@ POST https://HOSTNAME/v1/database/collections/{collectionId}/indexes
389389
| collectionId | string | **Required** Collection ID. You can create a new collection using the Database service [server integration](https://appwrite.io/docs/server/database#createCollection). | |
390390
| key | string | Index Key. | |
391391
| type | string | Index type. | |
392-
| attributes | array | Array of attributes to index. | |
393-
| orders | array | Array of index orders. | [] |
392+
| attributes | array | Array of attributes to index. Maximum of 100 attributes are allowed, each 32 characters long. | |
393+
| orders | array | Array of index orders. Maximum of 100 orders are allowed. | [] |
394394

395395
## Get Index
396396

‎docs/examples/account/delete.md ‎docs/examples/account/update-status.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -13,4 +13,4 @@ $client
1313

1414
$account = new Account($client);
1515

16-
$result = $account->delete();
16+
$result = $account->updateStatus();

‎docs/examples/health/get-queue-usage.md ‎docs/examples/users/get-memberships.md

+3-3
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
<?php
22
33
use Appwrite\Client;
4-
use Appwrite\Services\Health;
4+
use Appwrite\Services\Users;
55
66
$client = new Client();
77
@@ -11,6 +11,6 @@ $client
1111
->setKey('919c2d18fb5d4...a2ae413da83346ad2') // Your secret API key
1212
;
1313

14-
$health = new Health($client);
14+
$users = new Users($client);
1515

16-
$result = $health->getQueueUsage();
16+
$result = $users->getMemberships('[USER_ID]');

‎docs/functions.md

+5-5
Original file line numberDiff line numberDiff line change
@@ -33,14 +33,14 @@ POST https://HOSTNAME/v1/functions
3333
| --- | --- | --- | --- |
3434
| functionId | string | Function ID. Choose your own unique ID or pass the string &quot;unique()&quot; to auto generate it. Valid chars are a-z, A-Z, 0-9, period, hyphen, and underscore. Can&#039;t start with a special char. Max length is 36 chars. | |
3535
| name | string | Function name. Max length: 128 chars. | |
36-
| execute | array | An array of strings with execution permissions. By default no user is granted with any execute permissions. [learn more about permissions](https://appwrite.io/docs/permissions) and get a full list of available permissions. | |
36+
| execute | array | An array of strings with execution permissions. By default no user is granted with any execute permissions. [learn more about permissions](https://appwrite.io/docs/permissions) and get a full list of available permissions. Maximum of 100 scopes are allowed, each 64 characters long. | |
3737
| runtime | string | Execution runtime. | |
3838
| vars | object | Key-value JSON object that will be passed to the function as environment variables. | {} |
39-
| events | array | Events list. | [] |
39+
| events | array | Events list. Maximum of 100 events are allowed. | [] |
4040
| schedule | string | Schedule CRON syntax. | |
4141
| timeout | integer | Function maximum execution time in seconds. | 15 |
4242

43-
## List the currently active function runtimes.
43+
## List runtimes
4444

4545
```http request
4646
GET https://HOSTNAME/v1/functions/runtimes
@@ -76,9 +76,9 @@ PUT https://HOSTNAME/v1/functions/{functionId}
7676
| --- | --- | --- | --- |
7777
| functionId | string | **Required** Function ID. | |
7878
| name | string | Function name. Max length: 128 chars. | |
79-
| execute | array | An array of strings with execution permissions. By default no user is granted with any execute permissions. [learn more about permissions](https://appwrite.io/docs/permissions) and get a full list of available permissions. | |
79+
| execute | array | An array of strings with execution permissions. By default no user is granted with any execute permissions. [learn more about permissions](https://appwrite.io/docs/permissions) and get a full list of available permissions. Maximum of 100 scopes are allowed, each 64 characters long. | |
8080
| vars | object | Key-value JSON object that will be passed to the function as environment variables. | {} |
81-
| events | array | Events list. | [] |
81+
| events | array | Events list. Maximum of 100 events are allowed. | [] |
8282
| schedule | string | Schedule CRON syntax. | |
8383
| timeout | integer | Maximum execution time in seconds. | 15 |
8484

‎docs/health.md

-8
Original file line numberDiff line numberDiff line change
@@ -54,14 +54,6 @@ GET https://HOSTNAME/v1/health/queue/logs
5454

5555
** Get the number of logs that are waiting to be processed in the Appwrite internal queue server. **
5656

57-
## Get Usage Queue
58-
59-
```http request
60-
GET https://HOSTNAME/v1/health/queue/usage
61-
```
62-
63-
** Get the number of usage stats that are waiting to be processed in the Appwrite internal queue server. **
64-
6557
## Get Webhooks Queue
6658

6759
```http request

0 commit comments

Comments
 (0)