Skip to content

Commit a19b754

Browse files
committed
Add update attribute parameters
1 parent af59393 commit a19b754

File tree

293 files changed

+4979
-4276
lines changed

Some content is hidden

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

293 files changed

+4979
-4276
lines changed

README.md

Lines changed: 2 additions & 2 deletions
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-1.5.7-blue.svg?style=flat-square&v=1)
4+
![Version](https://img.shields.io/badge/api%20version-1.6.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 1.5.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 1.6.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

Lines changed: 5 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -73,7 +73,7 @@ DELETE https://cloud.appwrite.io/v1/account/identities/{identityId}
7373
## Create JWT
7474

7575
```http request
76-
POST https://cloud.appwrite.io/v1/account/jwt
76+
POST https://cloud.appwrite.io/v1/account/jwts
7777
```
7878

7979
** Use this endpoint to create a JSON Web Token. You can use the resulting JWT to authenticate on behalf of the current user when working with the Appwrite server-side API and SDKs. The JWT secret is valid for 15 minutes from its creation and will be invalid if the user will logout in that time frame. **
@@ -106,7 +106,7 @@ PATCH https://cloud.appwrite.io/v1/account/mfa
106106
| --- | --- | --- | --- |
107107
| mfa | boolean | Enable or disable MFA. | |
108108

109-
## Add Authenticator
109+
## Create Authenticator
110110

111111
```http request
112112
POST https://cloud.appwrite.io/v1/account/mfa/authenticators/{type}
@@ -126,7 +126,7 @@ POST https://cloud.appwrite.io/v1/account/mfa/authenticators/{type}
126126
PUT https://cloud.appwrite.io/v1/account/mfa/authenticators/{type}
127127
```
128128

129-
** Verify an authenticator app after adding it using the [add authenticator](/docs/references/cloud/client-web/account#createMfaAuthenticator) method. add **
129+
** Verify an authenticator app after adding it using the [add authenticator](/docs/references/cloud/client-web/account#createMfaAuthenticator) method. **
130130

131131
### Parameters
132132

@@ -148,9 +148,8 @@ DELETE https://cloud.appwrite.io/v1/account/mfa/authenticators/{type}
148148
| Field Name | Type | Description | Default |
149149
| --- | --- | --- | --- |
150150
| type | string | **Required** Type of authenticator. | |
151-
| otp | string | Valid verification token. | |
152151

153-
## Create 2FA Challenge
152+
## Create MFA Challenge
154153

155154
```http request
156155
POST https://cloud.appwrite.io/v1/account/mfa/challenge
@@ -562,7 +561,7 @@ POST https://cloud.appwrite.io/v1/account/verification/phone
562561

563562
** Use this endpoint to send a verification SMS to the currently logged in user. This endpoint is meant for use after updating a user's phone number using the [accountUpdatePhone](https://appwrite.io/docs/references/cloud/client-web/account#updatePhone) endpoint. Learn more about how to [complete the verification process](https://appwrite.io/docs/references/cloud/client-web/account#updatePhoneVerification). The verification code sent to the user's phone number is valid for 15 minutes. **
564563

565-
## Create phone verification (confirmation)
564+
## Update phone verification (confirmation)
566565

567566
```http request
568567
PUT https://cloud.appwrite.io/v1/account/verification/phone

docs/avatars.md

Lines changed: 4 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -46,7 +46,8 @@ GET https://cloud.appwrite.io/v1/avatars/favicon
4646
```
4747

4848
** Use this endpoint to fetch the favorite icon (AKA favicon) of any remote website URL.
49-
**
49+
50+
This endpoint does not follow HTTP redirects. **
5051

5152
### Parameters
5253

@@ -83,7 +84,8 @@ GET https://cloud.appwrite.io/v1/avatars/image
8384
** 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.
8485

8586
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-
**
87+
88+
This endpoint does not follow HTTP redirects. **
8789

8890
### Parameters
8991

docs/databases.md

Lines changed: 11 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -213,6 +213,7 @@ PATCH https://cloud.appwrite.io/v1/databases/{databaseId}/collections/{collectio
213213
| key | string | **Required** Attribute Key. | |
214214
| required | boolean | Is attribute required? | |
215215
| default | boolean | Default value for attribute when not provided. Cannot be set when attribute is required. | |
216+
| newKey | string | New attribute key. | |
216217

217218
## Create datetime attribute
218219

@@ -250,6 +251,7 @@ PATCH https://cloud.appwrite.io/v1/databases/{databaseId}/collections/{collectio
250251
| key | string | **Required** Attribute Key. | |
251252
| required | boolean | Is attribute required? | |
252253
| default | string | Default value for attribute when not provided. Cannot be set when attribute is required. | |
254+
| newKey | string | New attribute key. | |
253255

254256
## Create email attribute
255257

@@ -289,6 +291,7 @@ PATCH https://cloud.appwrite.io/v1/databases/{databaseId}/collections/{collectio
289291
| key | string | **Required** Attribute Key. | |
290292
| required | boolean | Is attribute required? | |
291293
| default | string | Default value for attribute when not provided. Cannot be set when attribute is required. | |
294+
| newKey | string | New attribute key. | |
292295

293296
## Create enum attribute
294297

@@ -330,6 +333,7 @@ PATCH https://cloud.appwrite.io/v1/databases/{databaseId}/collections/{collectio
330333
| elements | array | Array of elements in enumerated type. Uses length of longest element to determine size. Maximum of 100 elements are allowed, each 255 characters long. | |
331334
| required | boolean | Is attribute required? | |
332335
| default | string | Default value for attribute when not provided. Cannot be set when attribute is required. | |
336+
| newKey | string | New attribute key. | |
333337

334338
## Create float attribute
335339

@@ -373,6 +377,7 @@ PATCH https://cloud.appwrite.io/v1/databases/{databaseId}/collections/{collectio
373377
| min | number | Minimum value to enforce on new documents | |
374378
| max | number | Maximum value to enforce on new documents | |
375379
| default | number | Default value for attribute when not provided. Cannot be set when attribute is required. | |
380+
| newKey | string | New attribute key. | |
376381

377382
## Create integer attribute
378383

@@ -416,6 +421,7 @@ PATCH https://cloud.appwrite.io/v1/databases/{databaseId}/collections/{collectio
416421
| min | integer | Minimum value to enforce on new documents | |
417422
| max | integer | Maximum value to enforce on new documents | |
418423
| default | integer | Default value for attribute when not provided. Cannot be set when attribute is required. | |
424+
| newKey | string | New attribute key. | |
419425

420426
## Create IP address attribute
421427

@@ -455,6 +461,7 @@ PATCH https://cloud.appwrite.io/v1/databases/{databaseId}/collections/{collectio
455461
| key | string | **Required** Attribute Key. | |
456462
| required | boolean | Is attribute required? | |
457463
| default | string | Default value for attribute when not provided. Cannot be set when attribute is required. | |
464+
| newKey | string | New attribute key. | |
458465

459466
## Create relationship attribute
460467

@@ -518,6 +525,8 @@ PATCH https://cloud.appwrite.io/v1/databases/{databaseId}/collections/{collectio
518525
| key | string | **Required** Attribute Key. | |
519526
| required | boolean | Is attribute required? | |
520527
| default | string | Default value for attribute when not provided. Cannot be set when attribute is required. | |
528+
| size | integer | Maximum size of the string attribute. | |
529+
| newKey | string | New attribute key. | |
521530

522531
## Create URL attribute
523532

@@ -557,6 +566,7 @@ PATCH https://cloud.appwrite.io/v1/databases/{databaseId}/collections/{collectio
557566
| key | string | **Required** Attribute Key. | |
558567
| required | boolean | Is attribute required? | |
559568
| default | string | Default value for attribute when not provided. Cannot be set when attribute is required. | |
569+
| newKey | string | New attribute key. | |
560570

561571
## Get attribute
562572

@@ -607,6 +617,7 @@ PATCH https://cloud.appwrite.io/v1/databases/{databaseId}/collections/{collectio
607617
| collectionId | string | **Required** Collection ID. You can create a new collection using the Database service [server integration](https://appwrite.io/docs/server/databases#databasesCreateCollection). | |
608618
| key | string | **Required** Attribute Key. | |
609619
| onDelete | string | Constraints option | |
620+
| newKey | string | New attribute key. | |
610621

611622
## List documents
612623

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

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -5,7 +5,7 @@ use Appwrite\Services\Account;
55
66
$client = (new Client())
77
->setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint
8-
->setProject('5df5acd0d48c2'); // Your project ID
8+
->setProject('<YOUR_PROJECT_ID>'); // Your project ID
99

1010
$account = new Account($client);
1111

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

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -5,7 +5,7 @@ use Appwrite\Services\Account;
55
66
$client = (new Client())
77
->setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint
8-
->setProject('5df5acd0d48c2'); // Your project ID
8+
->setProject('<YOUR_PROJECT_ID>'); // Your project ID
99

1010
$account = new Account($client);
1111

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

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -5,7 +5,7 @@ use Appwrite\Services\Account;
55
66
$client = (new Client())
77
->setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint
8-
->setProject('5df5acd0d48c2'); // Your project ID
8+
->setProject('<YOUR_PROJECT_ID>'); // Your project ID
99

1010
$account = new Account($client);
1111

docs/examples/account/create-j-w-t.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -5,7 +5,7 @@ use Appwrite\Services\Account;
55
66
$client = (new Client())
77
->setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint
8-
->setProject('5df5acd0d48c2'); // Your project ID
8+
->setProject('<YOUR_PROJECT_ID>'); // Your project ID
99

1010
$account = new Account($client);
1111

docs/examples/account/create-magic-u-r-l-token.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -5,7 +5,7 @@ use Appwrite\Services\Account;
55
66
$client = (new Client())
77
->setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint
8-
->setProject('5df5acd0d48c2'); // Your project ID
8+
->setProject('<YOUR_PROJECT_ID>'); // Your project ID
99

1010
$account = new Account($client);
1111

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

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -6,7 +6,7 @@ use Appwrite\Enums\AuthenticatorType;
66
77
$client = (new Client())
88
->setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint
9-
->setProject('5df5acd0d48c2') // Your project ID
9+
->setProject('<YOUR_PROJECT_ID>') // Your project ID
1010
->setSession(''); // The user session to authenticate with
1111

1212
$account = new Account($client);

0 commit comments

Comments
 (0)