Merge pull request #37 from appwrite/feat-push-params

Add new push message parameters

Author: christyjacob4

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.6.0-blue.svg?style=flat-square&v=1)
+![Version](https://img.shields.io/badge/api%20version-1.6.1-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/account.md

@@ -42,7 +42,7 @@ This endpoint can also be used to convert an anonymous account to a normal one,
 | email | string | User email. |  |
 | password | string | User password. Must be at least 8 chars. |  |
 
-## List Identities
+## List identities
 
 ```http request
 GET https://cloud.appwrite.io/v1/account/identities
@@ -106,7 +106,7 @@ PATCH https://cloud.appwrite.io/v1/account/mfa
 | --- | --- | --- | --- |
 | mfa | boolean | Enable or disable MFA. |  |
 
-## Create Authenticator
+## Create authenticator
 
 ```http request
 POST https://cloud.appwrite.io/v1/account/mfa/authenticators/{type}
@@ -120,7 +120,7 @@ POST https://cloud.appwrite.io/v1/account/mfa/authenticators/{type}
 | --- | --- | --- | --- |
 | type | string | **Required** Type of authenticator. Must be `totp` |  |
 
-## Verify Authenticator
+## Verify authenticator
 
 ```http request
 PUT https://cloud.appwrite.io/v1/account/mfa/authenticators/{type}
@@ -135,7 +135,7 @@ PUT https://cloud.appwrite.io/v1/account/mfa/authenticators/{type}
 | type | string | **Required** Type of authenticator. |  |
 | otp | string | Valid verification token. |  |
 
-## Delete Authenticator
+## Delete authenticator
 
 ```http request
 DELETE https://cloud.appwrite.io/v1/account/mfa/authenticators/{type}
@@ -149,7 +149,7 @@ DELETE https://cloud.appwrite.io/v1/account/mfa/authenticators/{type}
 | --- | --- | --- | --- |
 | type | string | **Required** Type of authenticator. |  |
 
-## Create MFA Challenge
+## Create MFA challenge
 
 ```http request
 POST https://cloud.appwrite.io/v1/account/mfa/challenge
@@ -163,7 +163,7 @@ POST https://cloud.appwrite.io/v1/account/mfa/challenge
 | --- | --- | --- | --- |
 | factor | string | Factor used for verification. Must be one of following: `email`, `phone`, `totp`, `recoveryCode`. |  |
 
-## Create MFA Challenge (confirmation)
+## Create MFA challenge (confirmation)
 
 ```http request
 PUT https://cloud.appwrite.io/v1/account/mfa/challenge
@@ -178,31 +178,31 @@ PUT https://cloud.appwrite.io/v1/account/mfa/challenge
 | challengeId | string | ID of the challenge. |  |
 | otp | string | Valid verification token. |  |
 
-## List Factors
+## List factors
 
 ```http request
 GET https://cloud.appwrite.io/v1/account/mfa/factors
 ```
 
 ** List the factors available on the account to be used as a MFA challange. **
 
-## Get MFA Recovery Codes
+## Get MFA recovery codes
 
 ```http request
 GET https://cloud.appwrite.io/v1/account/mfa/recovery-codes
 ```
 
 ** Get recovery codes that can be used as backup for MFA flow. Before getting codes, they must be generated using [createMfaRecoveryCodes](/docs/references/cloud/client-web/account#createMfaRecoveryCodes) method. An OTP challenge is required to read recovery codes. **
 
-## Create MFA Recovery Codes
+## Create MFA recovery codes
 
 ```http request
 POST https://cloud.appwrite.io/v1/account/mfa/recovery-codes
 ```
 
 ** Generate recovery codes as backup for MFA flow. It's recommended to generate and show then immediately after user successfully adds their authehticator. Recovery codes can be used as a MFA verification type in [createMfaChallenge](/docs/references/cloud/client-web/account#createMfaChallenge) method. **
 
-## Regenerate MFA Recovery Codes
+## Regenerate MFA recovery codes
 
 ```http request
 PATCH https://cloud.appwrite.io/v1/account/mfa/recovery-codes
@@ -469,7 +469,7 @@ A user is limited to 10 active sessions at a time by default. [Learn more about
 POST https://cloud.appwrite.io/v1/account/tokens/magic-url
 ```
 
-** Sends the user an email with a secret key for creating a session. If the provided user ID has not been registered, a new user will be created. When the user clicks the link in the email, the user is redirected back to the URL you provided with the secret key and userId values attached to the URL query string. Use the query string parameters to submit a request to the [POST /v1/account/sessions/token](https://appwrite.io/docs/references/cloud/client-web/account#createSession) endpoint to complete the login process. The link sent to the user's email address is valid for 1 hour. If you are on a mobile device you can leave the URL parameter empty, so that the login completion will be handled by your Appwrite instance by default.
+** Sends the user an email with a secret key for creating a session. If the provided user ID has not been registered, a new user will be created. When the user clicks the link in the email, the user is redirected back to the URL you provided with the secret key and userId values attached to the URL query string. Use the query string parameters to submit a request to the [POST /v1/account/sessions/token](https://appwrite.io/docs/references/cloud/client-web/account#createSession) endpoint to complete the login process. The link sent to the user's email address is valid for 1 hour.
 
 A user is limited to 10 active sessions at a time by default. [Learn more about session limits](https://appwrite.io/docs/authentication-security#limits).
  **

docs/examples/databases/update-string-attribute.md

@@ -16,6 +16,6 @@ $result = $databases->updateStringAttribute(
     key: '',
     required: false,
     default: '<DEFAULT>',
-    size: null, // optional
+    size: 1, // optional
     newKey: '' // optional
 );

docs/examples/messaging/create-push.md

@@ -12,8 +12,8 @@ $messaging = new Messaging($client);
 
 $result = $messaging->createPush(
     messageId: '<MESSAGE_ID>',
-    title: '<TITLE>',
-    body: '<BODY>',
+    title: '<TITLE>', // optional
+    body: '<BODY>', // optional
     topics: [], // optional
     users: [], // optional
     targets: [], // optional
@@ -24,7 +24,10 @@ $result = $messaging->createPush(
     sound: '<SOUND>', // optional
     color: '<COLOR>', // optional
     tag: '<TAG>', // optional
-    badge: '<BADGE>', // optional
+    badge: null, // optional
     draft: false, // optional
-    scheduledAt: '' // optional
+    scheduledAt: '', // optional
+    contentAvailable: false, // optional
+    critical: false, // optional
+    priority: MessagePriority::NORMAL() // optional
 );

docs/examples/messaging/update-push.md

@@ -26,5 +26,8 @@ $result = $messaging->updatePush(
     tag: '<TAG>', // optional
     badge: null, // optional
     draft: false, // optional
-    scheduledAt: '' // optional
+    scheduledAt: '', // optional
+    contentAvailable: false, // optional
+    critical: false, // optional
+    priority: MessagePriority::NORMAL() // optional
 );

docs/functions.md

@@ -48,7 +48,7 @@ POST https://cloud.appwrite.io/v1/functions
 | templateOwner | string | The name of the owner of the template. |  |
 | templateRootDirectory | string | Path to function code in the template repo. |  |
 | templateVersion | string | Version (tag) for the repo linked to the function template. |  |
-| specification | string | Runtime specification for the function and builds. | s-0.5vcpu-512mb |
+| specification | string | Runtime specification for the function and builds. | s-1vcpu-512mb |
 
 ## List runtimes
 
@@ -110,7 +110,7 @@ PUT https://cloud.appwrite.io/v1/functions/{functionId}
 | providerBranch | string | Production branch for the repo linked to the function |  |
 | providerSilentMode | boolean | Is the VCS (Version Control System) connection in silent mode for the repo linked to the function? In silent mode, comments will not be made on commits and pull requests. |  |
 | providerRootDirectory | string | Path to function code in the linked repo. |  |
-| specification | string | Runtime specification for the function and builds. | s-0.5vcpu-512mb |
+| specification | string | Runtime specification for the function and builds. | s-1vcpu-512mb |
 
 ## Delete function
 

docs/locale.md

@@ -10,7 +10,7 @@ GET https://cloud.appwrite.io/v1/locale
 
 ([IP Geolocation by DB-IP](https://db-ip.com)) **
 
-## List Locale Codes
+## List locale codes
 
 ```http request
 GET https://cloud.appwrite.io/v1/locale/codes

docs/messaging.md

@@ -84,16 +84,19 @@ POST https://cloud.appwrite.io/v1/messaging/messages/push
 | topics | array | List of Topic IDs. | [] |
 | users | array | List of User IDs. | [] |
 | targets | array | List of Targets IDs. | [] |
-| data | object | Additional Data for push notification. | {} |
+| data | object | Additional key-value pair data for push notification. | {} |
 | action | string | Action for push notification. |  |
 | image | string | Image for push notification. Must be a compound bucket ID to file ID of a jpeg, png, or bmp image in Appwrite Storage. It should be formatted as <BUCKET_ID>:<FILE_ID>. |  |
 | icon | string | Icon for push notification. Available only for Android and Web Platform. |  |
-| sound | string | Sound for push notification. Available only for Android and IOS Platform. |  |
+| sound | string | Sound for push notification. Available only for Android and iOS Platform. |  |
 | color | string | Color for push notification. Available only for Android Platform. |  |
 | tag | string | Tag for push notification. Available only for Android Platform. |  |
-| badge | string | Badge for push notification. Available only for IOS Platform. |  |
+| badge | integer | Badge for push notification. Available only for iOS Platform. | -1 |
 | draft | boolean | Is message a draft |  |
 | scheduledAt | string | Scheduled delivery time for message in [ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html) format. DateTime value must be in future. |  |
+| contentAvailable | boolean | If set to true, the notification will be delivered in the background. Available only for iOS Platform. |  |
+| critical | boolean | If set to true, the notification will be marked as critical. This requires the app to have the critical notification entitlement. Available only for iOS Platform. |  |
+| priority | string | Set the notification priority. "normal" will consider device state and may not deliver notifications immediately. "high" will always attempt to immediately deliver the notification. | high |
 
 ## Update push notification
 
@@ -124,6 +127,9 @@ PATCH https://cloud.appwrite.io/v1/messaging/messages/push/{messageId}
 | badge | integer | Badge for push notification. Available only for iOS platforms. |  |
 | draft | boolean | Is message a draft |  |
 | scheduledAt | string | Scheduled delivery time for message in [ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html) format. DateTime value must be in future. |  |
+| contentAvailable | boolean | If set to true, the notification will be delivered in the background. Available only for iOS Platform. |  |
+| critical | boolean | If set to true, the notification will be marked as critical. This requires the app to have the critical notification entitlement. Available only for iOS Platform. |  |
+| priority | string | Set the notification priority. "normal" will consider device battery state and may send notifications later. "high" will always attempt to immediately deliver the notification. |  |
 
 ## Create SMS
 

docs/storage.md

@@ -161,7 +161,7 @@ PUT https://cloud.appwrite.io/v1/storage/buckets/{bucketId}/files/{fileId}
 | name | string | Name of the file |  |
 | permissions | array | An array of permission string. By default, the current permissions are inherited. [Learn more about permissions](https://appwrite.io/docs/permissions). |  |
 
-## Delete File
+## Delete file
 
 ```http request
 DELETE https://cloud.appwrite.io/v1/storage/buckets/{bucketId}/files/{fileId}

docs/teams.md

@@ -80,7 +80,7 @@ DELETE https://cloud.appwrite.io/v1/teams/{teamId}
 GET https://cloud.appwrite.io/v1/teams/{teamId}/memberships
 ```
 
-** Use this endpoint to list a team's members using the team's ID. All team members have read access to this endpoint. **
+** Use this endpoint to list a team's members using the team's ID. All team members have read access to this endpoint. Hide sensitive attributes from the response by toggling membership privacy in the Console. **
 
 ### Parameters
 
@@ -123,7 +123,7 @@ Please note that to avoid a [Redirect Attack](https://github.com/OWASP/CheatShee
 GET https://cloud.appwrite.io/v1/teams/{teamId}/memberships/{membershipId}
 ```
 
-** Get a team member by the membership unique id. All team members have read access for this resource. **
+** Get a team member by the membership unique id. All team members have read access for this resource. Hide sensitive attributes from the response by toggling membership privacy in the Console. **
 
 ### Parameters