CodeMirror/appwrite
1
0
Fork 0
mirror of synced 2024-06-29 03:30:34 +12:00
Code Issues Projects Releases Wiki Activity

Updated SDKs

Browse source
This commit is contained in:
eldadfux 2019-08-27 12:12:40 +03:00
parent 86c9b4dbfe
commit 1f6c0c6438
24 changed files with 56 additions and 65 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

6
app/sdks/js/README.md
View file

@ -1,9 +1,7 @@
# [Appwrite SDK for Javascript](https://appwrite.io)   [![Tweet](https://img.shields.io/twitter/url/http/shields.io.svg?style=social)](https://twitter.com/intent/tweet?text=Appwrite%20is%20a%20backend%20as%20a%20service%20for%20building%20web%20or%20mobile%20apps&url=http%3A%2F%2Fappwrite.io&via=appwrite_io&hashtags=JS%2Cjavascript%2Creactjs%2Cangular%2Cios%2Candroid)
![License](https://img.shields.io/github/license/appwrite/sdk-for-js.svg?v=1)
![Version](https://img.shields.io/badge/api%20version-0.1.3-blue.svg?v=1)
**WORK IN PROGRESS - NOT READY FOR USAGE**
![Version](https://img.shields.io/badge/api%20version-latest-blue.svg?v=1)
Appwrite backend as a service cuts up to 70% of the time and costs required for building a modern application. We abstract and simplify common development tasks behind a REST APIs, to help you develop your app in a fast and secure way. For full API documentation and tutorials go to [https://appwrite.io/docs](https://appwrite.io/docs)
@ -11,7 +9,7 @@ Appwrite backend as a service cuts up to 70% of the time and costs required for
![Appwrite](https://appwrite.io/images/github.png)
**API Version: 0.1.3**
**API Version: latest**
## Installation

2
app/sdks/js/package.json
View file

@ -2,7 +2,7 @@
"name": "appwrite",
"homepage": "https://appwrite.io/support",
"description": "Appwrite backend as a service cuts up to 70% of the time and costs required for building a modern application. We abstract and simplify common development tasks behind a REST APIs, to help you develop your app in a fast and secure way. For full API documentation and tutorials go to [https://appwrite.io/docs](https://appwrite.io/docs)",
"version": "v1.0.17",
"version": "v1.0.18",
"license": "BSD-3-Clause",
"main": "src/sdk.js",
"repository": {

18
app/sdks/js/src/sdk.js
View file

@ -138,7 +138,7 @@
globalParams.push({key: key, value: value});
};
addGlobalHeader('x-sdk-version', 'appwrite:javascript:v1.0.17');
addGlobalHeader('x-sdk-version', 'appwrite:javascript:v1.0.18');
addGlobalHeader('content-type', '');
/**
@ -943,12 +943,12 @@
},
/**
* Get image from and HTTP URL and crop to any size.
* Get Image from URL
*
* 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 a remote image
* or in cases, you want to make sure a 3rd party image is properly served
* using a TLS protocol.
* you want. This endpoint is very useful if you need to crop and display
* remote images in your app or in cases, you want to make sure a 3rd party
* image is properly served using a TLS protocol.
*
* @param {string} url
* @param {number} width
@ -2351,7 +2351,7 @@
},
/**
* Download File
* Get File for Download
*
* Get file content by its unique ID. The endpoint response return with a
* 'Content-Disposition: attachment' header that tells the browser to start
@ -2374,7 +2374,7 @@
},
/**
* Preview File
* Get File Preview
*
* Get file preview image. Currently, this method supports preview for image
* files (jpg, png, and gif), other supported formats, like pdf, docs, slides,
@ -2408,7 +2408,7 @@
},
/**
* View File
* Get File for View
*
* Get file content by its unique ID. This endpoint is similar to the download
* method but returns with no 'Content-Disposition: attachment' header.
@ -2662,7 +2662,7 @@
},
/**
* Create Team Membership (Resend Invitation Email)
* Create Team Membership (Resend)
*
* Use this endpoint to resend your invitation email for a user to join a
* team.

2
app/sdks/js/src/sdk.min.js vendored
View file

@ -1,5 +1,5 @@
(function(window){window.Appwrite=function(){let config={endpoint:'https://appwrite.test/v1',project:'',key:'',locale:'',mode:'',};let setEndpoint=function(endpoint){config.endpoint=endpoint;return this};let setProject=function(value){http.addGlobalHeader('X-Appwrite-Project',value);config.project=value;return this};let setKey=function(value){http.addGlobalHeader('X-Appwrite-Key',value);config.key=value;return this};let setLocale=function(value){http.addGlobalHeader('X-Appwrite-Locale',value);config.locale=value;return this};let setMode=function(value){http.addGlobalHeader('X-Appwrite-Mode',value);config.mode=value;return this};let http=function(document){let globalParams=[],globalHeaders=[];let addParam=function(url,param,value){let a=document.createElement('a'),regex=/(?:\?|&amp;|&)+([^=]+)(?:=([^&]*))*/g;let match,str=[];a.href=url;param=encodeURIComponent(param);while(match=regex.exec(a.search))if(param!==match[1])str.push(match[1]+(match[2]?"="+match[2]:""));str.push(param+(value?"="+encodeURIComponent(value):""));a.search=str.join("&");return a.href};let buildQuery=function(params){let str=[];for(let p in params){if(Array.isArray(params[p])){for(let index=0;index<params[p].length;index++){let param=params[p][index];str.push(encodeURIComponent(p+'[]')+"="+encodeURIComponent(param))}}else{str.push(encodeURIComponent(p)+"="+encodeURIComponent(params[p]))}}
return str.join("&")};let addGlobalHeader=function(key,value){globalHeaders[key]={key:key.toLowerCase(),value:value.toLowerCase()}};let addGlobalParam=function(key,value){globalParams.push({key:key,value:value})};addGlobalHeader('x-sdk-version','appwrite:javascript:v1.0.17');addGlobalHeader('content-type','');let call=function(method,path,headers={},params={},progress=null){let i;path=config.endpoint+path;if(-1===['GET','POST','PUT','DELETE','TRACE','HEAD','OPTIONS','CONNECT','PATCH'].indexOf(method)){throw new Error('var method must contain a valid HTTP method name')}
return str.join("&")};let addGlobalHeader=function(key,value){globalHeaders[key]={key:key.toLowerCase(),value:value.toLowerCase()}};let addGlobalParam=function(key,value){globalParams.push({key:key,value:value})};addGlobalHeader('x-sdk-version','appwrite:javascript:v1.0.18');addGlobalHeader('content-type','');let call=function(method,path,headers={},params={},progress=null){let i;path=config.endpoint+path;if(-1===['GET','POST','PUT','DELETE','TRACE','HEAD','OPTIONS','CONNECT','PATCH'].indexOf(method)){throw new Error('var method must contain a valid HTTP method name')}
if(typeof path!=='string'){throw new Error('var path must be of type string')}
if(typeof headers!=='object'){throw new Error('var headers must be of type object')}
for(i=0;i<globalParams.length;i++){path=addParam(path,globalParams[i].key,globalParams[i].value)}

6
app/sdks/node/README.md
View file

@ -1,9 +1,7 @@
# [Appwrite SDK for NodeJS](https://appwrite.io) &nbsp; [![Tweet](https://img.shields.io/twitter/url/http/shields.io.svg?style=social)](https://twitter.com/intent/tweet?text=Appwrite%20is%20a%20backend%20as%20a%20service%20for%20building%20web%20or%20mobile%20apps&url=http%3A%2F%2Fappwrite.io&via=appwrite_io&hashtags=JS%2Cjavascript%2Creactjs%2Cangular%2Cios%2Candroid)
![License](https://img.shields.io/github/license/appwrite/sdk-for-node.svg?v=1)
![Version](https://img.shields.io/badge/api%20version-0.1.3-blue.svg?v=1)
**WORK IN PROGRESS - NOT READY FOR USAGE**
![Version](https://img.shields.io/badge/api%20version-latest-blue.svg?v=1)
Appwrite backend as a service cuts up to 70% of the time and costs required for building a modern application. We abstract and simplify common development tasks behind a REST APIs, to help you develop your app in a fast and secure way. For full API documentation and tutorials go to [https://appwrite.io/docs](https://appwrite.io/docs)
@ -11,7 +9,7 @@ Appwrite backend as a service cuts up to 70% of the time and costs required for
![Appwrite](https://appwrite.io/images/github.png)
**API Version: 0.1.3**
**API Version: latest**
## Installation

2
app/sdks/node/lib/client.js
View file

@ -7,7 +7,7 @@ class Client {
this.endpoint = 'https://appwrite.test/v1';
this.headers = {
'content-type': '',
'x-sdk-version': 'appwrite:nodejs:v1.0.21',
'x-sdk-version': 'appwrite:nodejs:v1.0.22',
};
this.selfSigned = false;
}

8
app/sdks/node/lib/services/avatars.js
View file

@ -99,12 +99,12 @@ class Avatars extends Service {
}
/**
* Get image from and HTTP URL and crop to any size.
* Get Image from URL
*
* 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 a remote image
* or in cases, you want to make sure a 3rd party image is properly served
* using a TLS protocol.
* you want. This endpoint is very useful if you need to crop and display
* remote images in your app or in cases, you want to make sure a 3rd party
* image is properly served using a TLS protocol.
*
* @param string url
* @param number width

6
app/sdks/node/lib/services/storage.js
View file

@ -91,7 +91,7 @@ class Storage extends Service {
}
/**
* Download File
* Get File for Download
*
* Get file content by its unique ID. The endpoint response return with a
* 'Content-Disposition: attachment' header that tells the browser to start
@ -110,7 +110,7 @@ class Storage extends Service {
}
/**
* Preview File
* Get File Preview
*
* Get file preview image. Currently, this method supports preview for image
* files (jpg, png, and gif), other supported formats, like pdf, docs, slides,
@ -140,7 +140,7 @@ class Storage extends Service {
}
/**
* View File
* Get File for View
*
* Get file content by its unique ID. This endpoint is similar to the download
* method but returns with no 'Content-Disposition: attachment' header.

2
app/sdks/node/lib/services/teams.js
View file

@ -182,7 +182,7 @@ class Teams extends Service {
}
/**
* Create Team Membership (Resend Invitation Email)
* Create Team Membership (Resend)
*
* Use this endpoint to resend your invitation email for a user to join a
* team.

2
app/sdks/node/package.json
View file

@ -2,7 +2,7 @@
"name": "node-appwrite",
"homepage": "https://appwrite.io/support",
"description": "Appwrite backend as a service cuts up to 70% of the time and costs required for building a modern application. We abstract and simplify common development tasks behind a REST APIs, to help you develop your app in a fast and secure way. For full API documentation and tutorials go to [https://appwrite.io/docs](https://appwrite.io/docs)",
"version": "v1.0.21",
"version": "v1.0.22",
"license": "BSD-3-Clause",
"main": "index.js",
"repository": {

6
app/sdks/php/README.md
View file

@ -1,9 +1,7 @@
# [Appwrite SDK for PHP](https://appwrite.io) &nbsp; [![Tweet](https://img.shields.io/twitter/url/http/shields.io.svg?style=social)](https://twitter.com/intent/tweet?text=Appwrite%20is%20a%20backend%20as%20a%20service%20for%20building%20web%20or%20mobile%20apps&url=http%3A%2F%2Fappwrite.io&via=appwrite_io&hashtags=JS%2Cjavascript%2Creactjs%2Cangular%2Cios%2Candroid)
![License](https://img.shields.io/github/license/appwrite/sdk-for-php.svg?v=1)
![Version](https://img.shields.io/badge/api%20version-0.1.3-blue.svg?v=1)
**WORK IN PROGRESS - NOT READY FOR USAGE**
![Version](https://img.shields.io/badge/api%20version-latest-blue.svg?v=1)
Appwrite backend as a service cuts up to 70% of the time and costs required for building a modern application. We abstract and simplify common development tasks behind a REST APIs, to help you develop your app in a fast and secure way. For full API documentation and tutorials go to [https://appwrite.io/docs](https://appwrite.io/docs)
@ -11,7 +9,7 @@ Appwrite backend as a service cuts up to 70% of the time and costs required for
![Appwrite](https://appwrite.io/images/github.png)
**API Version: 0.1.3**
**API Version: latest**
## Installation

4
app/sdks/php/docs/avatars.md
View file

@ -65,13 +65,13 @@ GET https://appwrite.test/v1/avatars/flags/{code}
| height | integer | Image height. Pass an integer between 0 to 2000. Defaults to 100 | 100 |
| quality | integer | Image quality. Pass an integer between 0 to 100. Defaults to 100 | 100 |
## Get image from and HTTP URL and crop to any size.
## Get Image from URL
```http request
GET https://appwrite.test/v1/avatars/image
```
** 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 a remote image or in cases, you want to make sure a 3rd party image is properly served using a TLS protocol. **
** 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 cases, you want to make sure a 3rd party image is properly served using a TLS protocol. **
### Parameters

6
app/sdks/php/docs/storage.md
View file

@ -62,7 +62,7 @@ DELETE https://appwrite.test/v1/storage/files/{fileId}
| --- | --- | --- | --- |
| fileId | string | **Required** File unique ID. | |
## Download File
## Get File for Download
```http request
GET https://appwrite.test/v1/storage/files/{fileId}/download
@ -76,7 +76,7 @@ GET https://appwrite.test/v1/storage/files/{fileId}/download
| --- | --- | --- | --- |
| fileId | string | **Required** File unique ID. | |
## Preview File
## Get File Preview
```http request
GET https://appwrite.test/v1/storage/files/{fileId}/preview
@ -95,7 +95,7 @@ GET https://appwrite.test/v1/storage/files/{fileId}/preview
| background | string | Preview image background color. Only works with transparent images (png). Use a valid HEX color, no # is needed for prefix. | |
| output | string | Output format type (jpeg, jpg, png, gif and webp) | |
## View File
## Get File for View
```http request
GET https://appwrite.test/v1/storage/files/{fileId}/view

2
app/sdks/php/docs/teams.md
View file

@ -126,7 +126,7 @@ DELETE https://appwrite.test/v1/teams/{teamId}/memberships/{inviteId}
| teamId | string | **Required** Team unique ID. | |
| inviteId | string | **Required** Invite unique ID | |
## Create Team Membership (Resend Invitation Email)
## Create Team Membership (Resend)
```http request
POST https://appwrite.test/v1/teams/{teamId}/memberships/{inviteId}/resend

2
app/sdks/php/src/Appwrite/Client.php
View file

@ -37,7 +37,7 @@ class Client
*/
protected $headers = [
'content-type' => '',
'x-sdk-version' => 'appwrite:php:v1.0.4',
'x-sdk-version' => 'appwrite:php:v1.0.5',
];
/**

8
app/sdks/php/src/Appwrite/Services/Avatars.php
View file

@ -113,12 +113,12 @@ class Avatars extends Service
}
/**
* Get image from and HTTP URL and crop to any size.
* Get Image from URL
*
* 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 a remote image
* or in cases, you want to make sure a 3rd party image is properly served
* using a TLS protocol.
* you want. This endpoint is very useful if you need to crop and display
* remote images in your app or in cases, you want to make sure a 3rd party
* image is properly served using a TLS protocol.
*
* @param string $url
* @param integer $width

6
app/sdks/php/src/Appwrite/Services/Storage.php
View file

@ -106,7 +106,7 @@ class Storage extends Service
}
/**
* Download File
* Get File for Download
*
* Get file content by its unique ID. The endpoint response return with a
* 'Content-Disposition: attachment' header that tells the browser to start
@ -127,7 +127,7 @@ class Storage extends Service
}
/**
* Preview File
* Get File Preview
*
* Get file preview image. Currently, this method supports preview for image
* files (jpg, png, and gif), other supported formats, like pdf, docs, slides,
@ -159,7 +159,7 @@ class Storage extends Service
}
/**
* View File
* Get File for View
*
* Get file content by its unique ID. This endpoint is similar to the download
* method but returns with no 'Content-Disposition: attachment' header.

2
app/sdks/php/src/Appwrite/Services/Teams.php
View file

@ -204,7 +204,7 @@ class Teams extends Service
}
/**
* Create Team Membership (Resend Invitation Email)
* Create Team Membership (Resend)
*
* Use this endpoint to resend your invitation email for a user to join a
* team.

6
app/sdks/python/README.md
View file

@ -1,9 +1,7 @@
# [Appwrite SDK for Python](https://appwrite.io) &nbsp; [![Tweet](https://img.shields.io/twitter/url/http/shields.io.svg?style=social)](https://twitter.com/intent/tweet?text=Appwrite%20is%20a%20backend%20as%20a%20service%20for%20building%20web%20or%20mobile%20apps&url=http%3A%2F%2Fappwrite.io&via=appwrite_io&hashtags=JS%2Cjavascript%2Creactjs%2Cangular%2Cios%2Candroid)
![License](https://img.shields.io/github/license/appwrite/sdk-for-python.svg?v=1)
![Version](https://img.shields.io/badge/api%20version-0.1.3-blue.svg?v=1)
**WORK IN PROGRESS - NOT READY FOR USAGE**
![Version](https://img.shields.io/badge/api%20version-latest-blue.svg?v=1)
Appwrite backend as a service cuts up to 70% of the time and costs required for building a modern application. We abstract and simplify common development tasks behind a REST APIs, to help you develop your app in a fast and secure way. For full API documentation and tutorials go to [https://appwrite.io/docs](https://appwrite.io/docs)
@ -11,7 +9,7 @@ Appwrite backend as a service cuts up to 70% of the time and costs required for
![Appwrite](https://appwrite.io/images/github.png)
**API Version: 0.1.3**
**API Version: latest**
## Installation

2
app/sdks/python/appwrite/services/avatars.py
View file

@ -53,7 +53,7 @@ class Avatars(Service):
}, params)
def get_image(self, url, width=400, height=400):
"""Get image from and HTTP URL and crop to any size."""
"""Get Image from URL"""
params = {}
path = '/avatars/image'

6
app/sdks/python/appwrite/services/storage.py
View file

@ -53,7 +53,7 @@ class Storage(Service):
}, params)
def get_file_download(self, file_id):
"""Download File"""
"""Get File for Download"""
params = {}
path = '/storage/files/{fileId}/download'
@ -63,7 +63,7 @@ class Storage(Service):
}, params)
def get_file_preview(self, file_id, width=0, height=0, quality=100, background='', output=''):
"""Preview File"""
"""Get File Preview"""
params = {}
path = '/storage/files/{fileId}/preview'
@ -78,7 +78,7 @@ class Storage(Service):
}, params)
def get_file_view(self, file_id, as=''):
"""View File"""
"""Get File for View"""
params = {}
path = '/storage/files/{fileId}/view'

2
app/sdks/python/appwrite/services/teams.py
View file

@ -95,7 +95,7 @@ class Teams(Service):
}, params)
def create_team_membership_resend(self, team_id, invite_id, redirect):
"""Create Team Membership (Resend Invitation Email)"""
"""Create Team Membership (Resend)"""
params = {}
path = '/teams/{teamId}/memberships/{inviteId}/resend'

6
app/sdks/ruby/README.md
View file

@ -1,9 +1,7 @@
# [Appwrite SDK for Ruby](https://appwrite.io) &nbsp; [![Tweet](https://img.shields.io/twitter/url/http/shields.io.svg?style=social)](https://twitter.com/intent/tweet?text=Appwrite%20is%20a%20backend%20as%20a%20service%20for%20building%20web%20or%20mobile%20apps&url=http%3A%2F%2Fappwrite.io&via=appwrite_io&hashtags=JS%2Cjavascript%2Creactjs%2Cangular%2Cios%2Candroid)
![License](https://img.shields.io/github/license/appwrite/sdk-for-ruby.svg?v=1)
![Version](https://img.shields.io/badge/api%20version-0.1.3-blue.svg?v=1)
**WORK IN PROGRESS - NOT READY FOR USAGE**
![Version](https://img.shields.io/badge/api%20version-latest-blue.svg?v=1)
Appwrite backend as a service cuts up to 70% of the time and costs required for building a modern application. We abstract and simplify common development tasks behind a REST APIs, to help you develop your app in a fast and secure way. For full API documentation and tutorials go to [https://appwrite.io/docs](https://appwrite.io/docs)
@ -11,7 +9,7 @@ Appwrite backend as a service cuts up to 70% of the time and costs required for
![Appwrite](https://appwrite.io/images/github.png)
**API Version: 0.1.3**
**API Version: latest**
## Installation

9
app/tasks/sdks.php
View file

@ -38,7 +38,7 @@ $cli
$clients = [
'php' => [
'version' => 'v1.0.4',
'version' => 'v1.0.5',
'result' => __DIR__ . '/../sdks/php/',
'gitURL' => 'https://github.com/appwrite/sdk-for-php.git',
'gitRepo' => 'git@github.com:appwrite/sdk-for-php.git',
@ -46,7 +46,7 @@ $cli
'gitUserName' => 'appwrite',
],
'js' => [
'version' => 'v1.0.17',
'version' => 'v1.0.18',
'result' => __DIR__ . '/../sdks/js/',
'gitURL' => 'https://github.com/appwrite/sdk-for-js.git',
'gitRepo' => 'git@github.com:appwrite/sdk-for-js.git',
@ -54,7 +54,7 @@ $cli
'gitUserName' => 'appwrite',
],
'node' => [
'version' => 'v1.0.21',
'version' => 'v1.0.22',
'result' => __DIR__ . '/../sdks/node/',
'gitURL' => 'https://github.com/appwrite/sdk-for-node.git',
'gitRepo' => 'git@github.com:appwrite/sdk-for-node.git',
@ -146,7 +146,8 @@ THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS \"AS IS\" AN
->setShareURL('http://appwrite.io')
->setShareTags('JS,javascript,reactjs,angular,ios,android')
->setShareVia('appwrite_io')
->setWarning('**WORK IN PROGRESS - NOT READY FOR USAGE**')
//->setWarning('**WORK IN PROGRESS - NOT READY FOR USAGE**')
->setWarning('')
;
$target = __DIR__ . '/../sdks/git/' . $name;