diff --git a/app/controllers/api/storage.php b/app/controllers/api/storage.php index ca3748b6f4..95e5147036 100644 --- a/app/controllers/api/storage.php +++ b/app/controllers/api/storage.php @@ -121,7 +121,7 @@ $utopia->get('/v1/storage/files') ->label('scope', 'files.read') ->label('sdk.platform', [APP_PLATFORM_CLIENT, APP_PLATFORM_SERVER]) ->label('sdk.namespace', 'storage') - ->label('sdk.method', 'list') + ->label('sdk.method', 'listFiles') ->label('sdk.description', '/docs/references/storage/list-files.md') ->param('search', '', function () { return new Text(256); }, 'Search term to filter your list results.', true) ->param('limit', 25, function () { return new Range(0, 100); }, 'Results limit value. By default will return maximum 25 results. Maximum of 100 results allowed per request.', true) @@ -154,7 +154,7 @@ $utopia->get('/v1/storage/files/:fileId') ->label('scope', 'files.read') ->label('sdk.platform', [APP_PLATFORM_CLIENT, APP_PLATFORM_SERVER]) ->label('sdk.namespace', 'storage') - ->label('sdk.method', 'get') + ->label('sdk.method', 'getFile') ->label('sdk.description', '/docs/references/storage/get-file.md') ->param('fileId', '', function () { return new UID(); }, 'File unique ID.') ->action( @@ -174,7 +174,7 @@ $utopia->get('/v1/storage/files/:fileId/preview') ->label('scope', 'files.read') ->label('sdk.platform', [APP_PLATFORM_CLIENT, APP_PLATFORM_SERVER]) ->label('sdk.namespace', 'storage') - ->label('sdk.method', 'getPreview') + ->label('sdk.method', 'getFilePreview') ->label('sdk.description', '/docs/references/storage/get-file-preview.md') ->label('sdk.response.type', 'image/*') ->param('fileId', '', function () { return new UID(); }, 'File unique ID') @@ -287,7 +287,7 @@ $utopia->get('/v1/storage/files/:fileId/download') ->label('scope', 'files.read') ->label('sdk.platform', [APP_PLATFORM_CLIENT, APP_PLATFORM_SERVER]) ->label('sdk.namespace', 'storage') - ->label('sdk.method', 'getDownload') + ->label('sdk.method', 'getFileDownload') ->label('sdk.description', '/docs/references/storage/get-file-download.md') ->label('sdk.response.type', '*') ->param('fileId', '', function () { return new UID(); }, 'File unique ID.') @@ -339,7 +339,7 @@ $utopia->get('/v1/storage/files/:fileId/view') ->label('scope', 'files.read') ->label('sdk.platform', [APP_PLATFORM_CLIENT, APP_PLATFORM_SERVER]) ->label('sdk.namespace', 'storage') - ->label('sdk.method', 'getView') + ->label('sdk.method', 'getFileView') ->label('sdk.description', '/docs/references/storage/get-file-view.md') ->label('sdk.response.type', '*') ->param('fileId', '', function () { return new UID(); }, 'File unique ID.') @@ -409,7 +409,7 @@ $utopia->post('/v1/storage/files') ->label('webhook', 'storage.files.create') ->label('sdk.platform', [APP_PLATFORM_CLIENT, APP_PLATFORM_SERVER]) ->label('sdk.namespace', 'storage') - ->label('sdk.method', 'create') + ->label('sdk.method', 'createFile') ->label('sdk.description', '/docs/references/storage/create-file.md') ->label('sdk.consumes', 'multipart/form-data') ->param('file', [], function () { return new File(); }, 'Binary Files.', false) @@ -543,7 +543,7 @@ $utopia->put('/v1/storage/files/:fileId') ->label('webhook', 'storage.files.update') ->label('sdk.platform', [APP_PLATFORM_CLIENT, APP_PLATFORM_SERVER]) ->label('sdk.namespace', 'storage') - ->label('sdk.method', 'update') + ->label('sdk.method', 'updateFile') ->label('sdk.description', '/docs/references/storage/update-file.md') ->param('fileId', '', function () { return new UID(); }, 'File unique ID.') ->param('read', [], function () { return new ArrayList(new Text(64)); }, 'An array of strings with read permissions. By default no user is granted with any read permissions. [learn more about permissions](/docs/permissions) and get a full list of available permissions.') @@ -588,7 +588,7 @@ $utopia->delete('/v1/storage/files/:fileId') ->label('webhook', 'storage.files.delete') ->label('sdk.platform', [APP_PLATFORM_CLIENT, APP_PLATFORM_SERVER]) ->label('sdk.namespace', 'storage') - ->label('sdk.method', 'delete') + ->label('sdk.method', 'deleteFile') ->label('sdk.description', '/docs/references/storage/delete-file.md') ->param('fileId', '', function () { return new UID(); }, 'File unique ID.') ->action( @@ -629,7 +629,7 @@ $utopia->get('/v1/storage/files/:fileId/scan') ->label('scope', 'god') ->label('sdk.platform', [APP_PLATFORM_CLIENT, APP_PLATFORM_SERVER]) ->label('sdk.namespace', 'storage') - ->label('sdk.method', 'getScan') + ->label('sdk.method', 'getFileScan') ->label('sdk.hide', true) ->param('fileId', '', function () { return new UID(); }, 'File unique ID.') ->param('storage', 'local', function () { return new WhiteList(['local']);}) diff --git a/app/sdks/dart/lib/services/storage.dart b/app/sdks/dart/lib/services/storage.dart index 8e333f689d..da71e7cad4 100644 --- a/app/sdks/dart/lib/services/storage.dart +++ b/app/sdks/dart/lib/services/storage.dart @@ -9,7 +9,7 @@ class Storage extends Service { /// Get a list of all the user files. You can use the query params to filter /// your results. On admin mode, this endpoint will return a list of all of the /// project files. [Learn more about different API modes](/docs/admin). - Future list({search = null, limit = 25, offset = null, orderType = 'ASC'}) async { + Future listFiles({search = null, limit = 25, offset = null, orderType = 'ASC'}) async { String path = '/storage/files'; Map params = { @@ -24,7 +24,7 @@ class Storage extends Service { /// Create a new file. The user who creates the file will automatically be /// assigned to read and write access unless he has passed custom values for /// read and write arguments. - Future create({file, read, write}) async { + Future createFile({file, read, write}) async { String path = '/storage/files'; Map params = { @@ -37,7 +37,7 @@ class Storage extends Service { } /// Get file by its unique ID. This endpoint response returns a JSON object /// with the file metadata. - Future get({fileId}) async { + Future getFile({fileId}) async { String path = '/storage/files/{fileId}'.replaceAll(RegExp('{fileId}'), fileId); Map params = { @@ -47,7 +47,7 @@ class Storage extends Service { } /// Update file by its unique ID. Only users with write permissions have access /// to update this resource. - Future update({fileId, read, write}) async { + Future updateFile({fileId, read, write}) async { String path = '/storage/files/{fileId}'.replaceAll(RegExp('{fileId}'), fileId); Map params = { @@ -59,7 +59,7 @@ class Storage extends Service { } /// Delete a file by its unique ID. Only users with write permissions have /// access to delete this resource. - Future delete({fileId}) async { + Future deleteFile({fileId}) async { String path = '/storage/files/{fileId}'.replaceAll(RegExp('{fileId}'), fileId); Map params = { @@ -70,7 +70,7 @@ class Storage extends Service { /// Get file content by its unique ID. The endpoint response return with a /// 'Content-Disposition: attachment' header that tells the browser to start /// downloading the file to user downloads directory. - Future getDownload({fileId}) async { + Future getFileDownload({fileId}) async { String path = '/storage/files/{fileId}/download'.replaceAll(RegExp('{fileId}'), fileId); Map params = { @@ -82,7 +82,7 @@ class Storage extends Service { /// files (jpg, png, and gif), other supported formats, like pdf, docs, slides, /// and spreadsheets, will return the file icon image. You can also pass query /// string arguments for cutting and resizing your preview image. - Future getPreview({fileId, width = null, height = null, quality = 100, background = null, output = null}) async { + Future getFilePreview({fileId, width = null, height = null, quality = 100, background = null, output = null}) async { String path = '/storage/files/{fileId}/preview'.replaceAll(RegExp('{fileId}'), fileId); Map params = { @@ -97,7 +97,7 @@ class Storage extends Service { } /// Get file content by its unique ID. This endpoint is similar to the download /// method but returns with no 'Content-Disposition: attachment' header. - Future getView({fileId, as = null}) async { + Future getFileView({fileId, as = null}) async { String path = '/storage/files/{fileId}/view'.replaceAll(RegExp('{fileId}'), fileId); Map params = { diff --git a/app/sdks/go/docs/examples/storage/create-file.md b/app/sdks/go/docs/examples/storage/create-file.md new file mode 100644 index 0000000000..167661e740 --- /dev/null +++ b/app/sdks/go/docs/examples/storage/create-file.md @@ -0,0 +1,25 @@ +package main + +import ( + "fmt" + "github.com/appwrite/sdk-for-go" +) + +func main() { + var client := appwrite.Client{} + + client.SetProject("") + client.SetKey("") + + var service := appwrite.Storage{ + client: &client + } + + var response, error := service.CreateFile(file, [], []) + + if error != nil { + panic(error) + } + + fmt.Println(response) +} \ No newline at end of file diff --git a/app/sdks/go/docs/examples/storage/delete-file.md b/app/sdks/go/docs/examples/storage/delete-file.md new file mode 100644 index 0000000000..58bdf43fc2 --- /dev/null +++ b/app/sdks/go/docs/examples/storage/delete-file.md @@ -0,0 +1,25 @@ +package main + +import ( + "fmt" + "github.com/appwrite/sdk-for-go" +) + +func main() { + var client := appwrite.Client{} + + client.SetProject("") + client.SetKey("") + + var service := appwrite.Storage{ + client: &client + } + + var response, error := service.DeleteFile("[FILE_ID]") + + if error != nil { + panic(error) + } + + fmt.Println(response) +} \ No newline at end of file diff --git a/app/sdks/go/docs/examples/storage/get-file-download.md b/app/sdks/go/docs/examples/storage/get-file-download.md new file mode 100644 index 0000000000..1ac2f94d4d --- /dev/null +++ b/app/sdks/go/docs/examples/storage/get-file-download.md @@ -0,0 +1,25 @@ +package main + +import ( + "fmt" + "github.com/appwrite/sdk-for-go" +) + +func main() { + var client := appwrite.Client{} + + client.SetProject("") + client.SetKey("") + + var service := appwrite.Storage{ + client: &client + } + + var response, error := service.GetFileDownload("[FILE_ID]") + + if error != nil { + panic(error) + } + + fmt.Println(response) +} \ No newline at end of file diff --git a/app/sdks/go/docs/examples/storage/get-file-preview.md b/app/sdks/go/docs/examples/storage/get-file-preview.md new file mode 100644 index 0000000000..6ee4a129cb --- /dev/null +++ b/app/sdks/go/docs/examples/storage/get-file-preview.md @@ -0,0 +1,25 @@ +package main + +import ( + "fmt" + "github.com/appwrite/sdk-for-go" +) + +func main() { + var client := appwrite.Client{} + + client.SetProject("") + client.SetKey("") + + var service := appwrite.Storage{ + client: &client + } + + var response, error := service.GetFilePreview("[FILE_ID]", 0, 0, 0, "", "jpg") + + if error != nil { + panic(error) + } + + fmt.Println(response) +} \ No newline at end of file diff --git a/app/sdks/go/docs/examples/storage/get-file-view.md b/app/sdks/go/docs/examples/storage/get-file-view.md new file mode 100644 index 0000000000..2a444aa6a5 --- /dev/null +++ b/app/sdks/go/docs/examples/storage/get-file-view.md @@ -0,0 +1,25 @@ +package main + +import ( + "fmt" + "github.com/appwrite/sdk-for-go" +) + +func main() { + var client := appwrite.Client{} + + client.SetProject("") + client.SetKey("") + + var service := appwrite.Storage{ + client: &client + } + + var response, error := service.GetFileView("[FILE_ID]", "pdf") + + if error != nil { + panic(error) + } + + fmt.Println(response) +} \ No newline at end of file diff --git a/app/sdks/go/docs/examples/storage/get-file.md b/app/sdks/go/docs/examples/storage/get-file.md new file mode 100644 index 0000000000..18ba1bd623 --- /dev/null +++ b/app/sdks/go/docs/examples/storage/get-file.md @@ -0,0 +1,25 @@ +package main + +import ( + "fmt" + "github.com/appwrite/sdk-for-go" +) + +func main() { + var client := appwrite.Client{} + + client.SetProject("") + client.SetKey("") + + var service := appwrite.Storage{ + client: &client + } + + var response, error := service.GetFile("[FILE_ID]") + + if error != nil { + panic(error) + } + + fmt.Println(response) +} \ No newline at end of file diff --git a/app/sdks/go/docs/examples/storage/list-files.md b/app/sdks/go/docs/examples/storage/list-files.md new file mode 100644 index 0000000000..78cf9379a3 --- /dev/null +++ b/app/sdks/go/docs/examples/storage/list-files.md @@ -0,0 +1,25 @@ +package main + +import ( + "fmt" + "github.com/appwrite/sdk-for-go" +) + +func main() { + var client := appwrite.Client{} + + client.SetProject("") + client.SetKey("") + + var service := appwrite.Storage{ + client: &client + } + + var response, error := service.ListFiles("[SEARCH]", 0, 0, "ASC") + + if error != nil { + panic(error) + } + + fmt.Println(response) +} \ No newline at end of file diff --git a/app/sdks/go/docs/examples/storage/update-file.md b/app/sdks/go/docs/examples/storage/update-file.md new file mode 100644 index 0000000000..4ef34d4d59 --- /dev/null +++ b/app/sdks/go/docs/examples/storage/update-file.md @@ -0,0 +1,25 @@ +package main + +import ( + "fmt" + "github.com/appwrite/sdk-for-go" +) + +func main() { + var client := appwrite.Client{} + + client.SetProject("") + client.SetKey("") + + var service := appwrite.Storage{ + client: &client + } + + var response, error := service.UpdateFile("[FILE_ID]", [], []) + + if error != nil { + panic(error) + } + + fmt.Println(response) +} \ No newline at end of file diff --git a/app/sdks/go/storage.go b/app/sdks/go/storage.go index 898fa7aa0e..7ede9c3255 100644 --- a/app/sdks/go/storage.go +++ b/app/sdks/go/storage.go @@ -17,10 +17,10 @@ func NewStorage(clt Client) Storage { return service } -// List get a list of all the user files. You can use the query params to +// ListFiles get a list of all the user files. You can use the query params to // filter your results. On admin mode, this endpoint will return a list of all // of the project files. [Learn more about different API modes](/docs/admin). -func (srv *Storage) List(Search string, Limit int, Offset int, OrderType string) (map[string]interface{}, error) { +func (srv *Storage) ListFiles(Search string, Limit int, Offset int, OrderType string) (map[string]interface{}, error) { path := "/storage/files" params := map[string]interface{}{ @@ -33,10 +33,10 @@ func (srv *Storage) List(Search string, Limit int, Offset int, OrderType string) return srv.client.Call("GET", path, nil, params) } -// Create create a new file. The user who creates the file will automatically -// be assigned to read and write access unless he has passed custom values for -// read and write arguments. -func (srv *Storage) Create(File string, Read []interface{}, Write []interface{}) (map[string]interface{}, error) { +// CreateFile create a new file. The user who creates the file will +// automatically be assigned to read and write access unless he has passed +// custom values for read and write arguments. +func (srv *Storage) CreateFile(File string, Read []interface{}, Write []interface{}) (map[string]interface{}, error) { path := "/storage/files" params := map[string]interface{}{ @@ -48,9 +48,9 @@ func (srv *Storage) Create(File string, Read []interface{}, Write []interface{}) return srv.client.Call("POST", path, nil, params) } -// Get get file by its unique ID. This endpoint response returns a JSON object -// with the file metadata. -func (srv *Storage) Get(FileId string) (map[string]interface{}, error) { +// GetFile get file by its unique ID. This endpoint response returns a JSON +// object with the file metadata. +func (srv *Storage) GetFile(FileId string) (map[string]interface{}, error) { r := strings.NewReplacer("{fileId}", FileId) path := r.Replace("/storage/files/{fileId}") @@ -60,9 +60,9 @@ func (srv *Storage) Get(FileId string) (map[string]interface{}, error) { return srv.client.Call("GET", path, nil, params) } -// Update update file by its unique ID. Only users with write permissions have -// access to update this resource. -func (srv *Storage) Update(FileId string, Read []interface{}, Write []interface{}) (map[string]interface{}, error) { +// UpdateFile update file by its unique ID. Only users with write permissions +// have access to update this resource. +func (srv *Storage) UpdateFile(FileId string, Read []interface{}, Write []interface{}) (map[string]interface{}, error) { r := strings.NewReplacer("{fileId}", FileId) path := r.Replace("/storage/files/{fileId}") @@ -74,9 +74,9 @@ func (srv *Storage) Update(FileId string, Read []interface{}, Write []interface{ return srv.client.Call("PUT", path, nil, params) } -// Delete delete a file by its unique ID. Only users with write permissions -// have access to delete this resource. -func (srv *Storage) Delete(FileId string) (map[string]interface{}, error) { +// DeleteFile delete a file by its unique ID. Only users with write +// permissions have access to delete this resource. +func (srv *Storage) DeleteFile(FileId string) (map[string]interface{}, error) { r := strings.NewReplacer("{fileId}", FileId) path := r.Replace("/storage/files/{fileId}") @@ -86,10 +86,10 @@ func (srv *Storage) Delete(FileId string) (map[string]interface{}, error) { return srv.client.Call("DELETE", path, nil, params) } -// GetDownload get file content by its unique ID. The endpoint response return -// with a 'Content-Disposition: attachment' header that tells the browser to -// start downloading the file to user downloads directory. -func (srv *Storage) GetDownload(FileId string) (map[string]interface{}, error) { +// GetFileDownload get file content by its unique ID. The endpoint response +// return with a 'Content-Disposition: attachment' header that tells the +// browser to start downloading the file to user downloads directory. +func (srv *Storage) GetFileDownload(FileId string) (map[string]interface{}, error) { r := strings.NewReplacer("{fileId}", FileId) path := r.Replace("/storage/files/{fileId}/download") @@ -99,12 +99,12 @@ func (srv *Storage) GetDownload(FileId string) (map[string]interface{}, error) { return srv.client.Call("GET", path, nil, params) } -// GetPreview get a file preview image. Currently, this method supports +// GetFilePreview get a file preview image. Currently, this method supports // preview for image files (jpg, png, and gif), other supported formats, like // pdf, docs, slides, and spreadsheets, will return the file icon image. You // can also pass query string arguments for cutting and resizing your preview // image. -func (srv *Storage) GetPreview(FileId string, Width int, Height int, Quality int, Background string, Output string) (map[string]interface{}, error) { +func (srv *Storage) GetFilePreview(FileId string, Width int, Height int, Quality int, Background string, Output string) (map[string]interface{}, error) { r := strings.NewReplacer("{fileId}", FileId) path := r.Replace("/storage/files/{fileId}/preview") @@ -119,10 +119,10 @@ func (srv *Storage) GetPreview(FileId string, Width int, Height int, Quality int return srv.client.Call("GET", path, nil, params) } -// GetView get file content by its unique ID. This endpoint is similar to the -// download method but returns with no 'Content-Disposition: attachment' +// GetFileView get file content by its unique ID. This endpoint is similar to +// the download method but returns with no 'Content-Disposition: attachment' // header. -func (srv *Storage) GetView(FileId string, As string) (map[string]interface{}, error) { +func (srv *Storage) GetFileView(FileId string, As string) (map[string]interface{}, error) { r := strings.NewReplacer("{fileId}", FileId) path := r.Replace("/storage/files/{fileId}/view") diff --git a/app/sdks/javascript/README.md b/app/sdks/javascript/README.md index 581527d4a0..62950c26fb 100644 --- a/app/sdks/javascript/README.md +++ b/app/sdks/javascript/README.md @@ -1,6 +1,6 @@ # Appwrite SDK for JavaScript -![License](https://img.shields.io/github/license/appwrite/sdk-for-js.svg?v=1) +![License](https://img.shields.io/github/license/appwrite/sdk-for-console.svg?v=1) ![Version](https://img.shields.io/badge/api%20version-0.4.0-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) @@ -28,7 +28,7 @@ import * as Appwrite from "appwrite"; To install with a CDN (content delivery network) add the following scripts to the bottom of your tag, but before you use any Appwrite services: ```html - + ``` diff --git a/app/sdks/javascript/docs/examples/account/create-verification.md b/app/sdks/javascript/docs/examples/account/create-verification.md new file mode 100644 index 0000000000..eebdfbf193 --- /dev/null +++ b/app/sdks/javascript/docs/examples/account/create-verification.md @@ -0,0 +1,14 @@ +let sdk = new Appwrite(); + +sdk + .setProject('') + .setKey('') +; + +let promise = sdk.account.createVerification('https://example.com'); + +promise.then(function (response) { + console.log(response); +}, function (error) { + console.log(error); +}); \ No newline at end of file diff --git a/app/sdks/javascript/docs/examples/account/delete-current-session.md b/app/sdks/javascript/docs/examples/account/delete-current-session.md index a0ba8e88f4..a3de8c066b 100644 --- a/app/sdks/javascript/docs/examples/account/delete-current-session.md +++ b/app/sdks/javascript/docs/examples/account/delete-current-session.md @@ -2,6 +2,7 @@ let sdk = new Appwrite(); sdk .setProject('') + .setKey('') ; let promise = sdk.account.deleteCurrentSession(); diff --git a/app/sdks/javascript/docs/examples/account/delete-session.md b/app/sdks/javascript/docs/examples/account/delete-session.md index 56562c9007..081e437249 100644 --- a/app/sdks/javascript/docs/examples/account/delete-session.md +++ b/app/sdks/javascript/docs/examples/account/delete-session.md @@ -2,6 +2,7 @@ let sdk = new Appwrite(); sdk .setProject('') + .setKey('') ; let promise = sdk.account.deleteSession('[ID]'); diff --git a/app/sdks/javascript/docs/examples/account/delete-sessions.md b/app/sdks/javascript/docs/examples/account/delete-sessions.md index acc78bcd3f..4b08d3a069 100644 --- a/app/sdks/javascript/docs/examples/account/delete-sessions.md +++ b/app/sdks/javascript/docs/examples/account/delete-sessions.md @@ -2,6 +2,7 @@ let sdk = new Appwrite(); sdk .setProject('') + .setKey('') ; let promise = sdk.account.deleteSessions(); diff --git a/app/sdks/javascript/docs/examples/account/delete.md b/app/sdks/javascript/docs/examples/account/delete.md index c199f0f719..588701f6ea 100644 --- a/app/sdks/javascript/docs/examples/account/delete.md +++ b/app/sdks/javascript/docs/examples/account/delete.md @@ -2,6 +2,7 @@ let sdk = new Appwrite(); sdk .setProject('') + .setKey('') ; let promise = sdk.account.delete(); diff --git a/app/sdks/javascript/docs/examples/account/get-logs.md b/app/sdks/javascript/docs/examples/account/get-logs.md index 5017e74507..80e20fedbd 100644 --- a/app/sdks/javascript/docs/examples/account/get-logs.md +++ b/app/sdks/javascript/docs/examples/account/get-logs.md @@ -2,6 +2,7 @@ let sdk = new Appwrite(); sdk .setProject('') + .setKey('') ; let promise = sdk.account.getLogs(); diff --git a/app/sdks/javascript/docs/examples/account/get-prefs.md b/app/sdks/javascript/docs/examples/account/get-prefs.md index 39f8950138..ceda268689 100644 --- a/app/sdks/javascript/docs/examples/account/get-prefs.md +++ b/app/sdks/javascript/docs/examples/account/get-prefs.md @@ -2,6 +2,7 @@ let sdk = new Appwrite(); sdk .setProject('') + .setKey('') ; let promise = sdk.account.getPrefs(); diff --git a/app/sdks/javascript/docs/examples/account/get-sessions.md b/app/sdks/javascript/docs/examples/account/get-sessions.md index 963400deeb..287530c060 100644 --- a/app/sdks/javascript/docs/examples/account/get-sessions.md +++ b/app/sdks/javascript/docs/examples/account/get-sessions.md @@ -2,6 +2,7 @@ let sdk = new Appwrite(); sdk .setProject('') + .setKey('') ; let promise = sdk.account.getSessions(); diff --git a/app/sdks/javascript/docs/examples/account/get.md b/app/sdks/javascript/docs/examples/account/get.md index 682e09fbd8..8c34362c2f 100644 --- a/app/sdks/javascript/docs/examples/account/get.md +++ b/app/sdks/javascript/docs/examples/account/get.md @@ -2,6 +2,7 @@ let sdk = new Appwrite(); sdk .setProject('') + .setKey('') ; let promise = sdk.account.get(); diff --git a/app/sdks/javascript/docs/examples/account/update-email.md b/app/sdks/javascript/docs/examples/account/update-email.md index e9fb9c9ed2..5f8fd724af 100644 --- a/app/sdks/javascript/docs/examples/account/update-email.md +++ b/app/sdks/javascript/docs/examples/account/update-email.md @@ -2,6 +2,7 @@ let sdk = new Appwrite(); sdk .setProject('') + .setKey('') ; let promise = sdk.account.updateEmail('email@example.com', 'password'); diff --git a/app/sdks/javascript/docs/examples/account/update-name.md b/app/sdks/javascript/docs/examples/account/update-name.md index 2e5531e4c3..d7ce7d14bc 100644 --- a/app/sdks/javascript/docs/examples/account/update-name.md +++ b/app/sdks/javascript/docs/examples/account/update-name.md @@ -2,6 +2,7 @@ let sdk = new Appwrite(); sdk .setProject('') + .setKey('') ; let promise = sdk.account.updateName('[NAME]'); diff --git a/app/sdks/javascript/docs/examples/account/update-password.md b/app/sdks/javascript/docs/examples/account/update-password.md index e4ddc7fc49..17332f42f8 100644 --- a/app/sdks/javascript/docs/examples/account/update-password.md +++ b/app/sdks/javascript/docs/examples/account/update-password.md @@ -2,6 +2,7 @@ let sdk = new Appwrite(); sdk .setProject('') + .setKey('') ; let promise = sdk.account.updatePassword('password', 'password'); diff --git a/app/sdks/javascript/docs/examples/account/update-prefs.md b/app/sdks/javascript/docs/examples/account/update-prefs.md index 9deb78a41f..af21c2e0e1 100644 --- a/app/sdks/javascript/docs/examples/account/update-prefs.md +++ b/app/sdks/javascript/docs/examples/account/update-prefs.md @@ -2,6 +2,7 @@ let sdk = new Appwrite(); sdk .setProject('') + .setKey('') ; let promise = sdk.account.updatePrefs(''); diff --git a/app/sdks/javascript/docs/examples/avatars/get-browser.md b/app/sdks/javascript/docs/examples/avatars/get-browser.md index 84c992621e..9535041b27 100644 --- a/app/sdks/javascript/docs/examples/avatars/get-browser.md +++ b/app/sdks/javascript/docs/examples/avatars/get-browser.md @@ -2,6 +2,7 @@ let sdk = new Appwrite(); sdk .setProject('') + .setKey('') ; let promise = sdk.avatars.getBrowser('aa'); diff --git a/app/sdks/javascript/docs/examples/avatars/get-credit-card.md b/app/sdks/javascript/docs/examples/avatars/get-credit-card.md index c9fb87edc7..aa65c29371 100644 --- a/app/sdks/javascript/docs/examples/avatars/get-credit-card.md +++ b/app/sdks/javascript/docs/examples/avatars/get-credit-card.md @@ -2,6 +2,7 @@ let sdk = new Appwrite(); sdk .setProject('') + .setKey('') ; let promise = sdk.avatars.getCreditCard('amex'); diff --git a/app/sdks/javascript/docs/examples/avatars/get-favicon.md b/app/sdks/javascript/docs/examples/avatars/get-favicon.md index 5876eb2b5a..f3a2ef8a93 100644 --- a/app/sdks/javascript/docs/examples/avatars/get-favicon.md +++ b/app/sdks/javascript/docs/examples/avatars/get-favicon.md @@ -2,6 +2,7 @@ let sdk = new Appwrite(); sdk .setProject('') + .setKey('') ; let promise = sdk.avatars.getFavicon('https://example.com'); diff --git a/app/sdks/javascript/docs/examples/avatars/get-flag.md b/app/sdks/javascript/docs/examples/avatars/get-flag.md index 694c6b399e..365740d137 100644 --- a/app/sdks/javascript/docs/examples/avatars/get-flag.md +++ b/app/sdks/javascript/docs/examples/avatars/get-flag.md @@ -2,6 +2,7 @@ let sdk = new Appwrite(); sdk .setProject('') + .setKey('') ; let promise = sdk.avatars.getFlag('af'); diff --git a/app/sdks/javascript/docs/examples/avatars/get-image.md b/app/sdks/javascript/docs/examples/avatars/get-image.md index b807ff734e..683cab2992 100644 --- a/app/sdks/javascript/docs/examples/avatars/get-image.md +++ b/app/sdks/javascript/docs/examples/avatars/get-image.md @@ -2,6 +2,7 @@ let sdk = new Appwrite(); sdk .setProject('') + .setKey('') ; let promise = sdk.avatars.getImage('https://example.com'); diff --git a/app/sdks/javascript/docs/examples/avatars/get-q-r.md b/app/sdks/javascript/docs/examples/avatars/get-q-r.md index e64d83a5c4..92e9fff3e0 100644 --- a/app/sdks/javascript/docs/examples/avatars/get-q-r.md +++ b/app/sdks/javascript/docs/examples/avatars/get-q-r.md @@ -2,6 +2,7 @@ let sdk = new Appwrite(); sdk .setProject('') + .setKey('') ; let promise = sdk.avatars.getQR('[TEXT]'); diff --git a/app/sdks/javascript/docs/examples/database/create-collection.md b/app/sdks/javascript/docs/examples/database/create-collection.md index a93fe45778..3614c816bb 100644 --- a/app/sdks/javascript/docs/examples/database/create-collection.md +++ b/app/sdks/javascript/docs/examples/database/create-collection.md @@ -2,6 +2,7 @@ let sdk = new Appwrite(); sdk .setProject('') + .setKey('') ; let promise = sdk.database.createCollection('[NAME]', [], [], []); diff --git a/app/sdks/javascript/docs/examples/database/create-document.md b/app/sdks/javascript/docs/examples/database/create-document.md index aa251ae2b2..615dd83a07 100644 --- a/app/sdks/javascript/docs/examples/database/create-document.md +++ b/app/sdks/javascript/docs/examples/database/create-document.md @@ -2,6 +2,7 @@ let sdk = new Appwrite(); sdk .setProject('') + .setKey('') ; let promise = sdk.database.createDocument('[COLLECTION_ID]', '{}', [], []); diff --git a/app/sdks/javascript/docs/examples/database/delete-collection.md b/app/sdks/javascript/docs/examples/database/delete-collection.md index 1a116c58b9..b9083d4ba7 100644 --- a/app/sdks/javascript/docs/examples/database/delete-collection.md +++ b/app/sdks/javascript/docs/examples/database/delete-collection.md @@ -2,6 +2,7 @@ let sdk = new Appwrite(); sdk .setProject('') + .setKey('') ; let promise = sdk.database.deleteCollection('[COLLECTION_ID]'); diff --git a/app/sdks/javascript/docs/examples/database/delete-document.md b/app/sdks/javascript/docs/examples/database/delete-document.md index 7dd7fc4db4..49bbeda2fb 100644 --- a/app/sdks/javascript/docs/examples/database/delete-document.md +++ b/app/sdks/javascript/docs/examples/database/delete-document.md @@ -2,6 +2,7 @@ let sdk = new Appwrite(); sdk .setProject('') + .setKey('') ; let promise = sdk.database.deleteDocument('[COLLECTION_ID]', '[DOCUMENT_ID]'); diff --git a/app/sdks/javascript/docs/examples/database/get-collection.md b/app/sdks/javascript/docs/examples/database/get-collection.md index abe8d482d4..b1423e4246 100644 --- a/app/sdks/javascript/docs/examples/database/get-collection.md +++ b/app/sdks/javascript/docs/examples/database/get-collection.md @@ -2,6 +2,7 @@ let sdk = new Appwrite(); sdk .setProject('') + .setKey('') ; let promise = sdk.database.getCollection('[COLLECTION_ID]'); diff --git a/app/sdks/javascript/docs/examples/database/get-document.md b/app/sdks/javascript/docs/examples/database/get-document.md index 1bcb5b00ac..ee8acc3b73 100644 --- a/app/sdks/javascript/docs/examples/database/get-document.md +++ b/app/sdks/javascript/docs/examples/database/get-document.md @@ -2,6 +2,7 @@ let sdk = new Appwrite(); sdk .setProject('') + .setKey('') ; let promise = sdk.database.getDocument('[COLLECTION_ID]', '[DOCUMENT_ID]'); diff --git a/app/sdks/javascript/docs/examples/database/list-collections.md b/app/sdks/javascript/docs/examples/database/list-collections.md index 3160903309..3b85bfa239 100644 --- a/app/sdks/javascript/docs/examples/database/list-collections.md +++ b/app/sdks/javascript/docs/examples/database/list-collections.md @@ -2,6 +2,7 @@ let sdk = new Appwrite(); sdk .setProject('') + .setKey('') ; let promise = sdk.database.listCollections(); diff --git a/app/sdks/javascript/docs/examples/database/list-documents.md b/app/sdks/javascript/docs/examples/database/list-documents.md index 68ce8d6c23..1fdf05b8ca 100644 --- a/app/sdks/javascript/docs/examples/database/list-documents.md +++ b/app/sdks/javascript/docs/examples/database/list-documents.md @@ -2,6 +2,7 @@ let sdk = new Appwrite(); sdk .setProject('') + .setKey('') ; let promise = sdk.database.listDocuments('[COLLECTION_ID]'); diff --git a/app/sdks/javascript/docs/examples/database/update-collection.md b/app/sdks/javascript/docs/examples/database/update-collection.md index 726c244c79..1dcf9dbef4 100644 --- a/app/sdks/javascript/docs/examples/database/update-collection.md +++ b/app/sdks/javascript/docs/examples/database/update-collection.md @@ -2,6 +2,7 @@ let sdk = new Appwrite(); sdk .setProject('') + .setKey('') ; let promise = sdk.database.updateCollection('[COLLECTION_ID]', '[NAME]', [], []); diff --git a/app/sdks/javascript/docs/examples/database/update-document.md b/app/sdks/javascript/docs/examples/database/update-document.md index 7809b97bfd..6d8dd8971f 100644 --- a/app/sdks/javascript/docs/examples/database/update-document.md +++ b/app/sdks/javascript/docs/examples/database/update-document.md @@ -2,6 +2,7 @@ let sdk = new Appwrite(); sdk .setProject('') + .setKey('') ; let promise = sdk.database.updateDocument('[COLLECTION_ID]', '[DOCUMENT_ID]', '{}', [], []); diff --git a/app/sdks/javascript/docs/examples/locale/get-continents.md b/app/sdks/javascript/docs/examples/locale/get-continents.md index a8de63eb91..28a6dfe61c 100644 --- a/app/sdks/javascript/docs/examples/locale/get-continents.md +++ b/app/sdks/javascript/docs/examples/locale/get-continents.md @@ -2,6 +2,7 @@ let sdk = new Appwrite(); sdk .setProject('') + .setKey('') ; let promise = sdk.locale.getContinents(); diff --git a/app/sdks/javascript/docs/examples/locale/get-countries-e-u.md b/app/sdks/javascript/docs/examples/locale/get-countries-e-u.md index 44ceffd7e7..ab7bdcd94f 100644 --- a/app/sdks/javascript/docs/examples/locale/get-countries-e-u.md +++ b/app/sdks/javascript/docs/examples/locale/get-countries-e-u.md @@ -2,6 +2,7 @@ let sdk = new Appwrite(); sdk .setProject('') + .setKey('') ; let promise = sdk.locale.getCountriesEU(); diff --git a/app/sdks/javascript/docs/examples/locale/get-countries-phones.md b/app/sdks/javascript/docs/examples/locale/get-countries-phones.md index afd084f5d4..ec47fb2f72 100644 --- a/app/sdks/javascript/docs/examples/locale/get-countries-phones.md +++ b/app/sdks/javascript/docs/examples/locale/get-countries-phones.md @@ -2,6 +2,7 @@ let sdk = new Appwrite(); sdk .setProject('') + .setKey('') ; let promise = sdk.locale.getCountriesPhones(); diff --git a/app/sdks/javascript/docs/examples/locale/get-countries.md b/app/sdks/javascript/docs/examples/locale/get-countries.md index 521195bfaa..e35a7c8d8a 100644 --- a/app/sdks/javascript/docs/examples/locale/get-countries.md +++ b/app/sdks/javascript/docs/examples/locale/get-countries.md @@ -2,6 +2,7 @@ let sdk = new Appwrite(); sdk .setProject('') + .setKey('') ; let promise = sdk.locale.getCountries(); diff --git a/app/sdks/javascript/docs/examples/locale/get-currencies.md b/app/sdks/javascript/docs/examples/locale/get-currencies.md index 8032307f86..58de4764d8 100644 --- a/app/sdks/javascript/docs/examples/locale/get-currencies.md +++ b/app/sdks/javascript/docs/examples/locale/get-currencies.md @@ -2,6 +2,7 @@ let sdk = new Appwrite(); sdk .setProject('') + .setKey('') ; let promise = sdk.locale.getCurrencies(); diff --git a/app/sdks/javascript/docs/examples/locale/get.md b/app/sdks/javascript/docs/examples/locale/get.md index 0a61e3ae6b..a69fa84f5a 100644 --- a/app/sdks/javascript/docs/examples/locale/get.md +++ b/app/sdks/javascript/docs/examples/locale/get.md @@ -2,6 +2,7 @@ let sdk = new Appwrite(); sdk .setProject('') + .setKey('') ; let promise = sdk.locale.get(); diff --git a/app/sdks/javascript/docs/examples/projects/create-key.md b/app/sdks/javascript/docs/examples/projects/create-key.md new file mode 100644 index 0000000000..b120df0831 --- /dev/null +++ b/app/sdks/javascript/docs/examples/projects/create-key.md @@ -0,0 +1,14 @@ +let sdk = new Appwrite(); + +sdk + .setProject('') + .setKey('') +; + +let promise = sdk.projects.createKey('[PROJECT_ID]', '[NAME]', []); + +promise.then(function (response) { + console.log(response); +}, function (error) { + console.log(error); +}); \ No newline at end of file diff --git a/app/sdks/javascript/docs/examples/projects/create-platform.md b/app/sdks/javascript/docs/examples/projects/create-platform.md new file mode 100644 index 0000000000..f6e371981b --- /dev/null +++ b/app/sdks/javascript/docs/examples/projects/create-platform.md @@ -0,0 +1,14 @@ +let sdk = new Appwrite(); + +sdk + .setProject('') + .setKey('') +; + +let promise = sdk.projects.createPlatform('[PROJECT_ID]', 'web', '[NAME]'); + +promise.then(function (response) { + console.log(response); +}, function (error) { + console.log(error); +}); \ No newline at end of file diff --git a/app/sdks/javascript/docs/examples/projects/create-task.md b/app/sdks/javascript/docs/examples/projects/create-task.md new file mode 100644 index 0000000000..8c035d232d --- /dev/null +++ b/app/sdks/javascript/docs/examples/projects/create-task.md @@ -0,0 +1,14 @@ +let sdk = new Appwrite(); + +sdk + .setProject('') + .setKey('') +; + +let promise = sdk.projects.createTask('[PROJECT_ID]', '[NAME]', 'play', '', 0, 'GET', 'https://example.com'); + +promise.then(function (response) { + console.log(response); +}, function (error) { + console.log(error); +}); \ No newline at end of file diff --git a/app/sdks/javascript/docs/examples/projects/create-webhook.md b/app/sdks/javascript/docs/examples/projects/create-webhook.md new file mode 100644 index 0000000000..2041909b10 --- /dev/null +++ b/app/sdks/javascript/docs/examples/projects/create-webhook.md @@ -0,0 +1,14 @@ +let sdk = new Appwrite(); + +sdk + .setProject('') + .setKey('') +; + +let promise = sdk.projects.createWebhook('[PROJECT_ID]', '[NAME]', [], '[URL]', 0); + +promise.then(function (response) { + console.log(response); +}, function (error) { + console.log(error); +}); \ No newline at end of file diff --git a/app/sdks/javascript/docs/examples/projects/create.md b/app/sdks/javascript/docs/examples/projects/create.md new file mode 100644 index 0000000000..35d825f677 --- /dev/null +++ b/app/sdks/javascript/docs/examples/projects/create.md @@ -0,0 +1,14 @@ +let sdk = new Appwrite(); + +sdk + .setProject('') + .setKey('') +; + +let promise = sdk.projects.create('[NAME]', '[TEAM_ID]'); + +promise.then(function (response) { + console.log(response); +}, function (error) { + console.log(error); +}); \ No newline at end of file diff --git a/app/sdks/javascript/docs/examples/projects/delete-key.md b/app/sdks/javascript/docs/examples/projects/delete-key.md new file mode 100644 index 0000000000..a4e5dfc8ad --- /dev/null +++ b/app/sdks/javascript/docs/examples/projects/delete-key.md @@ -0,0 +1,14 @@ +let sdk = new Appwrite(); + +sdk + .setProject('') + .setKey('') +; + +let promise = sdk.projects.deleteKey('[PROJECT_ID]', '[KEY_ID]'); + +promise.then(function (response) { + console.log(response); +}, function (error) { + console.log(error); +}); \ No newline at end of file diff --git a/app/sdks/javascript/docs/examples/projects/delete-platform.md b/app/sdks/javascript/docs/examples/projects/delete-platform.md new file mode 100644 index 0000000000..88f6ae4d30 --- /dev/null +++ b/app/sdks/javascript/docs/examples/projects/delete-platform.md @@ -0,0 +1,14 @@ +let sdk = new Appwrite(); + +sdk + .setProject('') + .setKey('') +; + +let promise = sdk.projects.deletePlatform('[PROJECT_ID]', '[PLATFORM_ID]'); + +promise.then(function (response) { + console.log(response); +}, function (error) { + console.log(error); +}); \ No newline at end of file diff --git a/app/sdks/javascript/docs/examples/projects/delete-task.md b/app/sdks/javascript/docs/examples/projects/delete-task.md new file mode 100644 index 0000000000..5e20417eaf --- /dev/null +++ b/app/sdks/javascript/docs/examples/projects/delete-task.md @@ -0,0 +1,14 @@ +let sdk = new Appwrite(); + +sdk + .setProject('') + .setKey('') +; + +let promise = sdk.projects.deleteTask('[PROJECT_ID]', '[TASK_ID]'); + +promise.then(function (response) { + console.log(response); +}, function (error) { + console.log(error); +}); \ No newline at end of file diff --git a/app/sdks/javascript/docs/examples/projects/delete-webhook.md b/app/sdks/javascript/docs/examples/projects/delete-webhook.md new file mode 100644 index 0000000000..36d3ae8b83 --- /dev/null +++ b/app/sdks/javascript/docs/examples/projects/delete-webhook.md @@ -0,0 +1,14 @@ +let sdk = new Appwrite(); + +sdk + .setProject('') + .setKey('') +; + +let promise = sdk.projects.deleteWebhook('[PROJECT_ID]', '[WEBHOOK_ID]'); + +promise.then(function (response) { + console.log(response); +}, function (error) { + console.log(error); +}); \ No newline at end of file diff --git a/app/sdks/javascript/docs/examples/projects/delete.md b/app/sdks/javascript/docs/examples/projects/delete.md new file mode 100644 index 0000000000..f1c98f1487 --- /dev/null +++ b/app/sdks/javascript/docs/examples/projects/delete.md @@ -0,0 +1,14 @@ +let sdk = new Appwrite(); + +sdk + .setProject('') + .setKey('') +; + +let promise = sdk.projects.delete('[PROJECT_ID]'); + +promise.then(function (response) { + console.log(response); +}, function (error) { + console.log(error); +}); \ No newline at end of file diff --git a/app/sdks/javascript/docs/examples/projects/get-key.md b/app/sdks/javascript/docs/examples/projects/get-key.md new file mode 100644 index 0000000000..c62792dc32 --- /dev/null +++ b/app/sdks/javascript/docs/examples/projects/get-key.md @@ -0,0 +1,14 @@ +let sdk = new Appwrite(); + +sdk + .setProject('') + .setKey('') +; + +let promise = sdk.projects.getKey('[PROJECT_ID]', '[KEY_ID]'); + +promise.then(function (response) { + console.log(response); +}, function (error) { + console.log(error); +}); \ No newline at end of file diff --git a/app/sdks/javascript/docs/examples/projects/get-platform.md b/app/sdks/javascript/docs/examples/projects/get-platform.md new file mode 100644 index 0000000000..2bdceda0af --- /dev/null +++ b/app/sdks/javascript/docs/examples/projects/get-platform.md @@ -0,0 +1,14 @@ +let sdk = new Appwrite(); + +sdk + .setProject('') + .setKey('') +; + +let promise = sdk.projects.getPlatform('[PROJECT_ID]', '[PLATFORM_ID]'); + +promise.then(function (response) { + console.log(response); +}, function (error) { + console.log(error); +}); \ No newline at end of file diff --git a/app/sdks/javascript/docs/examples/projects/get-task.md b/app/sdks/javascript/docs/examples/projects/get-task.md new file mode 100644 index 0000000000..ab66126e37 --- /dev/null +++ b/app/sdks/javascript/docs/examples/projects/get-task.md @@ -0,0 +1,14 @@ +let sdk = new Appwrite(); + +sdk + .setProject('') + .setKey('') +; + +let promise = sdk.projects.getTask('[PROJECT_ID]', '[TASK_ID]'); + +promise.then(function (response) { + console.log(response); +}, function (error) { + console.log(error); +}); \ No newline at end of file diff --git a/app/sdks/javascript/docs/examples/projects/get-usage.md b/app/sdks/javascript/docs/examples/projects/get-usage.md new file mode 100644 index 0000000000..2554533143 --- /dev/null +++ b/app/sdks/javascript/docs/examples/projects/get-usage.md @@ -0,0 +1,14 @@ +let sdk = new Appwrite(); + +sdk + .setProject('') + .setKey('') +; + +let promise = sdk.projects.getUsage('[PROJECT_ID]'); + +promise.then(function (response) { + console.log(response); +}, function (error) { + console.log(error); +}); \ No newline at end of file diff --git a/app/sdks/javascript/docs/examples/projects/get-webhook.md b/app/sdks/javascript/docs/examples/projects/get-webhook.md new file mode 100644 index 0000000000..f98be87cde --- /dev/null +++ b/app/sdks/javascript/docs/examples/projects/get-webhook.md @@ -0,0 +1,14 @@ +let sdk = new Appwrite(); + +sdk + .setProject('') + .setKey('') +; + +let promise = sdk.projects.getWebhook('[PROJECT_ID]', '[WEBHOOK_ID]'); + +promise.then(function (response) { + console.log(response); +}, function (error) { + console.log(error); +}); \ No newline at end of file diff --git a/app/sdks/javascript/docs/examples/projects/get.md b/app/sdks/javascript/docs/examples/projects/get.md new file mode 100644 index 0000000000..783e73368d --- /dev/null +++ b/app/sdks/javascript/docs/examples/projects/get.md @@ -0,0 +1,14 @@ +let sdk = new Appwrite(); + +sdk + .setProject('') + .setKey('') +; + +let promise = sdk.projects.get('[PROJECT_ID]'); + +promise.then(function (response) { + console.log(response); +}, function (error) { + console.log(error); +}); \ No newline at end of file diff --git a/app/sdks/javascript/docs/examples/projects/list-keys.md b/app/sdks/javascript/docs/examples/projects/list-keys.md new file mode 100644 index 0000000000..58b7743df6 --- /dev/null +++ b/app/sdks/javascript/docs/examples/projects/list-keys.md @@ -0,0 +1,14 @@ +let sdk = new Appwrite(); + +sdk + .setProject('') + .setKey('') +; + +let promise = sdk.projects.listKeys('[PROJECT_ID]'); + +promise.then(function (response) { + console.log(response); +}, function (error) { + console.log(error); +}); \ No newline at end of file diff --git a/app/sdks/javascript/docs/examples/projects/list-platforms.md b/app/sdks/javascript/docs/examples/projects/list-platforms.md new file mode 100644 index 0000000000..3e64d8698c --- /dev/null +++ b/app/sdks/javascript/docs/examples/projects/list-platforms.md @@ -0,0 +1,14 @@ +let sdk = new Appwrite(); + +sdk + .setProject('') + .setKey('') +; + +let promise = sdk.projects.listPlatforms('[PROJECT_ID]'); + +promise.then(function (response) { + console.log(response); +}, function (error) { + console.log(error); +}); \ No newline at end of file diff --git a/app/sdks/javascript/docs/examples/projects/list-tasks.md b/app/sdks/javascript/docs/examples/projects/list-tasks.md new file mode 100644 index 0000000000..5e85a64f35 --- /dev/null +++ b/app/sdks/javascript/docs/examples/projects/list-tasks.md @@ -0,0 +1,14 @@ +let sdk = new Appwrite(); + +sdk + .setProject('') + .setKey('') +; + +let promise = sdk.projects.listTasks('[PROJECT_ID]'); + +promise.then(function (response) { + console.log(response); +}, function (error) { + console.log(error); +}); \ No newline at end of file diff --git a/app/sdks/javascript/docs/examples/projects/list-webhooks.md b/app/sdks/javascript/docs/examples/projects/list-webhooks.md new file mode 100644 index 0000000000..a77ca5e7de --- /dev/null +++ b/app/sdks/javascript/docs/examples/projects/list-webhooks.md @@ -0,0 +1,14 @@ +let sdk = new Appwrite(); + +sdk + .setProject('') + .setKey('') +; + +let promise = sdk.projects.listWebhooks('[PROJECT_ID]'); + +promise.then(function (response) { + console.log(response); +}, function (error) { + console.log(error); +}); \ No newline at end of file diff --git a/app/sdks/javascript/docs/examples/projects/list.md b/app/sdks/javascript/docs/examples/projects/list.md new file mode 100644 index 0000000000..d703219e00 --- /dev/null +++ b/app/sdks/javascript/docs/examples/projects/list.md @@ -0,0 +1,14 @@ +let sdk = new Appwrite(); + +sdk + .setProject('') + .setKey('') +; + +let promise = sdk.projects.list(); + +promise.then(function (response) { + console.log(response); +}, function (error) { + console.log(error); +}); \ No newline at end of file diff --git a/app/sdks/javascript/docs/examples/projects/update-key.md b/app/sdks/javascript/docs/examples/projects/update-key.md new file mode 100644 index 0000000000..32cecac287 --- /dev/null +++ b/app/sdks/javascript/docs/examples/projects/update-key.md @@ -0,0 +1,14 @@ +let sdk = new Appwrite(); + +sdk + .setProject('') + .setKey('') +; + +let promise = sdk.projects.updateKey('[PROJECT_ID]', '[KEY_ID]', '[NAME]', []); + +promise.then(function (response) { + console.log(response); +}, function (error) { + console.log(error); +}); \ No newline at end of file diff --git a/app/sdks/javascript/docs/examples/projects/update-o-auth.md b/app/sdks/javascript/docs/examples/projects/update-o-auth.md new file mode 100644 index 0000000000..d3aa11079b --- /dev/null +++ b/app/sdks/javascript/docs/examples/projects/update-o-auth.md @@ -0,0 +1,14 @@ +let sdk = new Appwrite(); + +sdk + .setProject('') + .setKey('') +; + +let promise = sdk.projects.updateOAuth('[PROJECT_ID]', 'bitbucket'); + +promise.then(function (response) { + console.log(response); +}, function (error) { + console.log(error); +}); \ No newline at end of file diff --git a/app/sdks/javascript/docs/examples/projects/update-platform.md b/app/sdks/javascript/docs/examples/projects/update-platform.md new file mode 100644 index 0000000000..e5936795f4 --- /dev/null +++ b/app/sdks/javascript/docs/examples/projects/update-platform.md @@ -0,0 +1,14 @@ +let sdk = new Appwrite(); + +sdk + .setProject('') + .setKey('') +; + +let promise = sdk.projects.updatePlatform('[PROJECT_ID]', '[PLATFORM_ID]', '[NAME]'); + +promise.then(function (response) { + console.log(response); +}, function (error) { + console.log(error); +}); \ No newline at end of file diff --git a/app/sdks/javascript/docs/examples/projects/update-task.md b/app/sdks/javascript/docs/examples/projects/update-task.md new file mode 100644 index 0000000000..e0cd73f285 --- /dev/null +++ b/app/sdks/javascript/docs/examples/projects/update-task.md @@ -0,0 +1,14 @@ +let sdk = new Appwrite(); + +sdk + .setProject('') + .setKey('') +; + +let promise = sdk.projects.updateTask('[PROJECT_ID]', '[TASK_ID]', '[NAME]', 'play', '', 0, 'GET', 'https://example.com'); + +promise.then(function (response) { + console.log(response); +}, function (error) { + console.log(error); +}); \ No newline at end of file diff --git a/app/sdks/javascript/docs/examples/projects/update-webhook.md b/app/sdks/javascript/docs/examples/projects/update-webhook.md new file mode 100644 index 0000000000..923bd74a09 --- /dev/null +++ b/app/sdks/javascript/docs/examples/projects/update-webhook.md @@ -0,0 +1,14 @@ +let sdk = new Appwrite(); + +sdk + .setProject('') + .setKey('') +; + +let promise = sdk.projects.updateWebhook('[PROJECT_ID]', '[WEBHOOK_ID]', '[NAME]', [], '[URL]', 0); + +promise.then(function (response) { + console.log(response); +}, function (error) { + console.log(error); +}); \ No newline at end of file diff --git a/app/sdks/javascript/docs/examples/projects/update.md b/app/sdks/javascript/docs/examples/projects/update.md new file mode 100644 index 0000000000..80e34b5155 --- /dev/null +++ b/app/sdks/javascript/docs/examples/projects/update.md @@ -0,0 +1,14 @@ +let sdk = new Appwrite(); + +sdk + .setProject('') + .setKey('') +; + +let promise = sdk.projects.update('[PROJECT_ID]', '[NAME]'); + +promise.then(function (response) { + console.log(response); +}, function (error) { + console.log(error); +}); \ No newline at end of file diff --git a/app/sdks/javascript/docs/examples/storage/create-file.md b/app/sdks/javascript/docs/examples/storage/create-file.md new file mode 100644 index 0000000000..4062cb1481 --- /dev/null +++ b/app/sdks/javascript/docs/examples/storage/create-file.md @@ -0,0 +1,14 @@ +let sdk = new Appwrite(); + +sdk + .setProject('') + .setKey('') +; + +let promise = sdk.storage.createFile(document.getElementById('uploader').files[0], [], []); + +promise.then(function (response) { + console.log(response); +}, function (error) { + console.log(error); +}); \ No newline at end of file diff --git a/app/sdks/javascript/docs/examples/storage/delete-file.md b/app/sdks/javascript/docs/examples/storage/delete-file.md new file mode 100644 index 0000000000..222e683139 --- /dev/null +++ b/app/sdks/javascript/docs/examples/storage/delete-file.md @@ -0,0 +1,14 @@ +let sdk = new Appwrite(); + +sdk + .setProject('') + .setKey('') +; + +let promise = sdk.storage.deleteFile('[FILE_ID]'); + +promise.then(function (response) { + console.log(response); +}, function (error) { + console.log(error); +}); \ No newline at end of file diff --git a/app/sdks/javascript/docs/examples/storage/get-file-download.md b/app/sdks/javascript/docs/examples/storage/get-file-download.md new file mode 100644 index 0000000000..f311d8b27b --- /dev/null +++ b/app/sdks/javascript/docs/examples/storage/get-file-download.md @@ -0,0 +1,14 @@ +let sdk = new Appwrite(); + +sdk + .setProject('') + .setKey('') +; + +let promise = sdk.storage.getFileDownload('[FILE_ID]'); + +promise.then(function (response) { + console.log(response); +}, function (error) { + console.log(error); +}); \ No newline at end of file diff --git a/app/sdks/javascript/docs/examples/storage/get-file-preview.md b/app/sdks/javascript/docs/examples/storage/get-file-preview.md new file mode 100644 index 0000000000..fadbd697f1 --- /dev/null +++ b/app/sdks/javascript/docs/examples/storage/get-file-preview.md @@ -0,0 +1,14 @@ +let sdk = new Appwrite(); + +sdk + .setProject('') + .setKey('') +; + +let promise = sdk.storage.getFilePreview('[FILE_ID]'); + +promise.then(function (response) { + console.log(response); +}, function (error) { + console.log(error); +}); \ No newline at end of file diff --git a/app/sdks/javascript/docs/examples/storage/get-file-view.md b/app/sdks/javascript/docs/examples/storage/get-file-view.md new file mode 100644 index 0000000000..13625a363b --- /dev/null +++ b/app/sdks/javascript/docs/examples/storage/get-file-view.md @@ -0,0 +1,14 @@ +let sdk = new Appwrite(); + +sdk + .setProject('') + .setKey('') +; + +let promise = sdk.storage.getFileView('[FILE_ID]'); + +promise.then(function (response) { + console.log(response); +}, function (error) { + console.log(error); +}); \ No newline at end of file diff --git a/app/sdks/javascript/docs/examples/storage/get-file.md b/app/sdks/javascript/docs/examples/storage/get-file.md new file mode 100644 index 0000000000..717612d601 --- /dev/null +++ b/app/sdks/javascript/docs/examples/storage/get-file.md @@ -0,0 +1,14 @@ +let sdk = new Appwrite(); + +sdk + .setProject('') + .setKey('') +; + +let promise = sdk.storage.getFile('[FILE_ID]'); + +promise.then(function (response) { + console.log(response); +}, function (error) { + console.log(error); +}); \ No newline at end of file diff --git a/app/sdks/javascript/docs/examples/storage/list-files.md b/app/sdks/javascript/docs/examples/storage/list-files.md new file mode 100644 index 0000000000..8be53c7773 --- /dev/null +++ b/app/sdks/javascript/docs/examples/storage/list-files.md @@ -0,0 +1,14 @@ +let sdk = new Appwrite(); + +sdk + .setProject('') + .setKey('') +; + +let promise = sdk.storage.listFiles(); + +promise.then(function (response) { + console.log(response); +}, function (error) { + console.log(error); +}); \ No newline at end of file diff --git a/app/sdks/javascript/docs/examples/storage/update-file.md b/app/sdks/javascript/docs/examples/storage/update-file.md new file mode 100644 index 0000000000..4e9f264b3e --- /dev/null +++ b/app/sdks/javascript/docs/examples/storage/update-file.md @@ -0,0 +1,14 @@ +let sdk = new Appwrite(); + +sdk + .setProject('') + .setKey('') +; + +let promise = sdk.storage.updateFile('[FILE_ID]', [], []); + +promise.then(function (response) { + console.log(response); +}, function (error) { + console.log(error); +}); \ No newline at end of file diff --git a/app/sdks/javascript/docs/examples/teams/create-membership.md b/app/sdks/javascript/docs/examples/teams/create-membership.md index 349b229d0d..906cbf7df3 100644 --- a/app/sdks/javascript/docs/examples/teams/create-membership.md +++ b/app/sdks/javascript/docs/examples/teams/create-membership.md @@ -2,6 +2,7 @@ let sdk = new Appwrite(); sdk .setProject('') + .setKey('') ; let promise = sdk.teams.createMembership('[TEAM_ID]', 'email@example.com', [], 'https://example.com'); diff --git a/app/sdks/javascript/docs/examples/teams/create.md b/app/sdks/javascript/docs/examples/teams/create.md index 635aafc160..3af6a8fdfb 100644 --- a/app/sdks/javascript/docs/examples/teams/create.md +++ b/app/sdks/javascript/docs/examples/teams/create.md @@ -2,6 +2,7 @@ let sdk = new Appwrite(); sdk .setProject('') + .setKey('') ; let promise = sdk.teams.create('[NAME]'); diff --git a/app/sdks/javascript/docs/examples/teams/delete-membership.md b/app/sdks/javascript/docs/examples/teams/delete-membership.md index 4b3f29ae86..079607d47c 100644 --- a/app/sdks/javascript/docs/examples/teams/delete-membership.md +++ b/app/sdks/javascript/docs/examples/teams/delete-membership.md @@ -2,6 +2,7 @@ let sdk = new Appwrite(); sdk .setProject('') + .setKey('') ; let promise = sdk.teams.deleteMembership('[TEAM_ID]', '[INVITE_ID]'); diff --git a/app/sdks/javascript/docs/examples/teams/delete.md b/app/sdks/javascript/docs/examples/teams/delete.md index f9ac0b3a98..80e207257a 100644 --- a/app/sdks/javascript/docs/examples/teams/delete.md +++ b/app/sdks/javascript/docs/examples/teams/delete.md @@ -2,6 +2,7 @@ let sdk = new Appwrite(); sdk .setProject('') + .setKey('') ; let promise = sdk.teams.delete('[TEAM_ID]'); diff --git a/app/sdks/javascript/docs/examples/teams/get-memberships.md b/app/sdks/javascript/docs/examples/teams/get-memberships.md index 456ee074df..868ddb7aac 100644 --- a/app/sdks/javascript/docs/examples/teams/get-memberships.md +++ b/app/sdks/javascript/docs/examples/teams/get-memberships.md @@ -2,6 +2,7 @@ let sdk = new Appwrite(); sdk .setProject('') + .setKey('') ; let promise = sdk.teams.getMemberships('[TEAM_ID]'); diff --git a/app/sdks/javascript/docs/examples/teams/get.md b/app/sdks/javascript/docs/examples/teams/get.md index c61fb5b89a..2262edd0a4 100644 --- a/app/sdks/javascript/docs/examples/teams/get.md +++ b/app/sdks/javascript/docs/examples/teams/get.md @@ -2,6 +2,7 @@ let sdk = new Appwrite(); sdk .setProject('') + .setKey('') ; let promise = sdk.teams.get('[TEAM_ID]'); diff --git a/app/sdks/javascript/docs/examples/teams/list.md b/app/sdks/javascript/docs/examples/teams/list.md index 3944cce2e0..43e64b8a81 100644 --- a/app/sdks/javascript/docs/examples/teams/list.md +++ b/app/sdks/javascript/docs/examples/teams/list.md @@ -2,6 +2,7 @@ let sdk = new Appwrite(); sdk .setProject('') + .setKey('') ; let promise = sdk.teams.list(); diff --git a/app/sdks/javascript/docs/examples/teams/update.md b/app/sdks/javascript/docs/examples/teams/update.md index f2d028d896..d24894bb2e 100644 --- a/app/sdks/javascript/docs/examples/teams/update.md +++ b/app/sdks/javascript/docs/examples/teams/update.md @@ -2,6 +2,7 @@ let sdk = new Appwrite(); sdk .setProject('') + .setKey('') ; let promise = sdk.teams.update('[TEAM_ID]', '[NAME]'); diff --git a/app/sdks/javascript/docs/examples/users/create.md b/app/sdks/javascript/docs/examples/users/create.md new file mode 100644 index 0000000000..9ac8eeff72 --- /dev/null +++ b/app/sdks/javascript/docs/examples/users/create.md @@ -0,0 +1,14 @@ +let sdk = new Appwrite(); + +sdk + .setProject('') + .setKey('') +; + +let promise = sdk.users.create('email@example.com', 'password'); + +promise.then(function (response) { + console.log(response); +}, function (error) { + console.log(error); +}); \ No newline at end of file diff --git a/app/sdks/javascript/docs/examples/users/delete-session.md b/app/sdks/javascript/docs/examples/users/delete-session.md new file mode 100644 index 0000000000..c9747a4cfc --- /dev/null +++ b/app/sdks/javascript/docs/examples/users/delete-session.md @@ -0,0 +1,14 @@ +let sdk = new Appwrite(); + +sdk + .setProject('') + .setKey('') +; + +let promise = sdk.users.deleteSession('[USER_ID]', '[SESSION_ID]'); + +promise.then(function (response) { + console.log(response); +}, function (error) { + console.log(error); +}); \ No newline at end of file diff --git a/app/sdks/javascript/docs/examples/users/delete-sessions.md b/app/sdks/javascript/docs/examples/users/delete-sessions.md new file mode 100644 index 0000000000..c0c0d3683b --- /dev/null +++ b/app/sdks/javascript/docs/examples/users/delete-sessions.md @@ -0,0 +1,14 @@ +let sdk = new Appwrite(); + +sdk + .setProject('') + .setKey('') +; + +let promise = sdk.users.deleteSessions('[USER_ID]'); + +promise.then(function (response) { + console.log(response); +}, function (error) { + console.log(error); +}); \ No newline at end of file diff --git a/app/sdks/javascript/docs/examples/users/get-logs.md b/app/sdks/javascript/docs/examples/users/get-logs.md new file mode 100644 index 0000000000..0c53367aa8 --- /dev/null +++ b/app/sdks/javascript/docs/examples/users/get-logs.md @@ -0,0 +1,14 @@ +let sdk = new Appwrite(); + +sdk + .setProject('') + .setKey('') +; + +let promise = sdk.users.getLogs('[USER_ID]'); + +promise.then(function (response) { + console.log(response); +}, function (error) { + console.log(error); +}); \ No newline at end of file diff --git a/app/sdks/javascript/docs/examples/users/get-prefs.md b/app/sdks/javascript/docs/examples/users/get-prefs.md new file mode 100644 index 0000000000..cf979ad265 --- /dev/null +++ b/app/sdks/javascript/docs/examples/users/get-prefs.md @@ -0,0 +1,14 @@ +let sdk = new Appwrite(); + +sdk + .setProject('') + .setKey('') +; + +let promise = sdk.users.getPrefs('[USER_ID]'); + +promise.then(function (response) { + console.log(response); +}, function (error) { + console.log(error); +}); \ No newline at end of file diff --git a/app/sdks/javascript/docs/examples/users/get-sessions.md b/app/sdks/javascript/docs/examples/users/get-sessions.md new file mode 100644 index 0000000000..1260680564 --- /dev/null +++ b/app/sdks/javascript/docs/examples/users/get-sessions.md @@ -0,0 +1,14 @@ +let sdk = new Appwrite(); + +sdk + .setProject('') + .setKey('') +; + +let promise = sdk.users.getSessions('[USER_ID]'); + +promise.then(function (response) { + console.log(response); +}, function (error) { + console.log(error); +}); \ No newline at end of file diff --git a/app/sdks/javascript/docs/examples/users/get.md b/app/sdks/javascript/docs/examples/users/get.md new file mode 100644 index 0000000000..0c92b1f593 --- /dev/null +++ b/app/sdks/javascript/docs/examples/users/get.md @@ -0,0 +1,14 @@ +let sdk = new Appwrite(); + +sdk + .setProject('') + .setKey('') +; + +let promise = sdk.users.get('[USER_ID]'); + +promise.then(function (response) { + console.log(response); +}, function (error) { + console.log(error); +}); \ No newline at end of file diff --git a/app/sdks/javascript/docs/examples/users/list.md b/app/sdks/javascript/docs/examples/users/list.md new file mode 100644 index 0000000000..2add615b19 --- /dev/null +++ b/app/sdks/javascript/docs/examples/users/list.md @@ -0,0 +1,14 @@ +let sdk = new Appwrite(); + +sdk + .setProject('') + .setKey('') +; + +let promise = sdk.users.list(); + +promise.then(function (response) { + console.log(response); +}, function (error) { + console.log(error); +}); \ No newline at end of file diff --git a/app/sdks/javascript/docs/examples/users/update-prefs.md b/app/sdks/javascript/docs/examples/users/update-prefs.md new file mode 100644 index 0000000000..9ffaf75a4f --- /dev/null +++ b/app/sdks/javascript/docs/examples/users/update-prefs.md @@ -0,0 +1,14 @@ +let sdk = new Appwrite(); + +sdk + .setProject('') + .setKey('') +; + +let promise = sdk.users.updatePrefs('[USER_ID]', ''); + +promise.then(function (response) { + console.log(response); +}, function (error) { + console.log(error); +}); \ No newline at end of file diff --git a/app/sdks/javascript/docs/examples/users/update-status.md b/app/sdks/javascript/docs/examples/users/update-status.md new file mode 100644 index 0000000000..afd66aed2e --- /dev/null +++ b/app/sdks/javascript/docs/examples/users/update-status.md @@ -0,0 +1,14 @@ +let sdk = new Appwrite(); + +sdk + .setProject('') + .setKey('') +; + +let promise = sdk.users.updateStatus('[USER_ID]', '1'); + +promise.then(function (response) { + console.log(response); +}, function (error) { + console.log(error); +}); \ No newline at end of file diff --git a/app/sdks/javascript/package.json b/app/sdks/javascript/package.json index e718733189..d4be0c0d03 100644 --- a/app/sdks/javascript/package.json +++ b/app/sdks/javascript/package.json @@ -2,12 +2,12 @@ "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": "1.0.28", + "version": "1.0.0", "license": "BSD-3-Clause", "main": "src/sdk.js", "repository": { "type": "git", - "url": "https://github.com/appwrite/sdk-for-js" + "url": "https://github.com/appwrite/sdk-for-console" }, "devDependencies": {}, "dependencies": {} diff --git a/app/sdks/javascript/src/sdk.js b/app/sdks/javascript/src/sdk.js index 69927295fd..74ffdc2e4f 100644 --- a/app/sdks/javascript/src/sdk.js +++ b/app/sdks/javascript/src/sdk.js @@ -139,7 +139,7 @@ globalParams.push({key: key, value: value}); }; - addGlobalHeader('x-sdk-version', 'appwrite:javascript:1.0.28'); + addGlobalHeader('x-sdk-version', 'appwrite:javascript:1.0.0'); addGlobalHeader('content-type', ''); /** @@ -862,6 +862,46 @@ }, payload); }, + /** + * Create Verification + * + * Use this endpoint to send a verification message to your user email address + * to confirm they are the valid owners of that address. Both the **userId** + * and **secret** arguments will be passed as query parameters to the URL you + * have provider to be attached to the verification email. The provided URL + * should redirect the user back for your app and allow you to complete the + * verification process by verifying both the **userId** and **secret** + * parameters. Learn more about how to [complete the verification + * process](/docs/account#updateAccountVerification). + * + * Please note that in order to avoid a [Redirect + * Attack](https://github.com/OWASP/CheatSheetSeries/blob/master/cheatsheets/Unvalidated_Redirects_and_Forwards_Cheat_Sheet.md) + * the only valid redirect URLs are the ones from domains you have set when + * adding your platforms in the console interface. + * + * @param {string} url + * @throws {Error} + * @return {Promise} + */ + createVerification: function(url) { + if(url === undefined) { + throw new Error('Missing required parameter: "url"'); + } + + let path = '/account/verification'; + + let payload = {}; + + if(url) { + payload['url'] = url; + } + + return http + .post(path, { + 'content-type': 'application/json', + }, payload); + }, + /** * Updated Verification * @@ -1742,6 +1782,1139 @@ } }; + let projects = { + + /** + * List Projects + * + * + * @throws {Error} + * @return {Promise} + */ + list: function() { + let path = '/projects'; + + let payload = {}; + + return http + .get(path, { + 'content-type': 'application/json', + }, payload); + }, + + /** + * Create Project + * + * + * @param {string} name + * @param {string} teamId + * @param {string} description + * @param {string} logo + * @param {string} url + * @param {string} legalName + * @param {string} legalCountry + * @param {string} legalState + * @param {string} legalCity + * @param {string} legalAddress + * @param {string} legalTaxId + * @throws {Error} + * @return {Promise} + */ + create: function(name, teamId, description = '', logo = '', url = '', legalName = '', legalCountry = '', legalState = '', legalCity = '', legalAddress = '', legalTaxId = '') { + if(name === undefined) { + throw new Error('Missing required parameter: "name"'); + } + + if(teamId === undefined) { + throw new Error('Missing required parameter: "teamId"'); + } + + let path = '/projects'; + + let payload = {}; + + if(name) { + payload['name'] = name; + } + + if(teamId) { + payload['teamId'] = teamId; + } + + if(description) { + payload['description'] = description; + } + + if(logo) { + payload['logo'] = logo; + } + + if(url) { + payload['url'] = url; + } + + if(legalName) { + payload['legalName'] = legalName; + } + + if(legalCountry) { + payload['legalCountry'] = legalCountry; + } + + if(legalState) { + payload['legalState'] = legalState; + } + + if(legalCity) { + payload['legalCity'] = legalCity; + } + + if(legalAddress) { + payload['legalAddress'] = legalAddress; + } + + if(legalTaxId) { + payload['legalTaxId'] = legalTaxId; + } + + return http + .post(path, { + 'content-type': 'application/json', + }, payload); + }, + + /** + * Get Project + * + * + * @param {string} projectId + * @throws {Error} + * @return {Promise} + */ + get: function(projectId) { + if(projectId === undefined) { + throw new Error('Missing required parameter: "projectId"'); + } + + let path = '/projects/{projectId}'.replace(new RegExp('{projectId}', 'g'), projectId); + + let payload = {}; + + return http + .get(path, { + 'content-type': 'application/json', + }, payload); + }, + + /** + * Update Project + * + * + * @param {string} projectId + * @param {string} name + * @param {string} description + * @param {string} logo + * @param {string} url + * @param {string} legalName + * @param {string} legalCountry + * @param {string} legalState + * @param {string} legalCity + * @param {string} legalAddress + * @param {string} legalTaxId + * @throws {Error} + * @return {Promise} + */ + update: function(projectId, name, description = '', logo = '', url = '', legalName = '', legalCountry = '', legalState = '', legalCity = '', legalAddress = '', legalTaxId = '') { + if(projectId === undefined) { + throw new Error('Missing required parameter: "projectId"'); + } + + if(name === undefined) { + throw new Error('Missing required parameter: "name"'); + } + + let path = '/projects/{projectId}'.replace(new RegExp('{projectId}', 'g'), projectId); + + let payload = {}; + + if(name) { + payload['name'] = name; + } + + if(description) { + payload['description'] = description; + } + + if(logo) { + payload['logo'] = logo; + } + + if(url) { + payload['url'] = url; + } + + if(legalName) { + payload['legalName'] = legalName; + } + + if(legalCountry) { + payload['legalCountry'] = legalCountry; + } + + if(legalState) { + payload['legalState'] = legalState; + } + + if(legalCity) { + payload['legalCity'] = legalCity; + } + + if(legalAddress) { + payload['legalAddress'] = legalAddress; + } + + if(legalTaxId) { + payload['legalTaxId'] = legalTaxId; + } + + return http + .patch(path, { + 'content-type': 'application/json', + }, payload); + }, + + /** + * Delete Project + * + * + * @param {string} projectId + * @throws {Error} + * @return {Promise} + */ + delete: function(projectId) { + if(projectId === undefined) { + throw new Error('Missing required parameter: "projectId"'); + } + + let path = '/projects/{projectId}'.replace(new RegExp('{projectId}', 'g'), projectId); + + let payload = {}; + + return http + .delete(path, { + 'content-type': 'application/json', + }, payload); + }, + + /** + * List Keys + * + * + * @param {string} projectId + * @throws {Error} + * @return {Promise} + */ + listKeys: function(projectId) { + if(projectId === undefined) { + throw new Error('Missing required parameter: "projectId"'); + } + + let path = '/projects/{projectId}/keys'.replace(new RegExp('{projectId}', 'g'), projectId); + + let payload = {}; + + return http + .get(path, { + 'content-type': 'application/json', + }, payload); + }, + + /** + * Create Key + * + * + * @param {string} projectId + * @param {string} name + * @param {array} scopes + * @throws {Error} + * @return {Promise} + */ + createKey: function(projectId, name, scopes) { + if(projectId === undefined) { + throw new Error('Missing required parameter: "projectId"'); + } + + if(name === undefined) { + throw new Error('Missing required parameter: "name"'); + } + + if(scopes === undefined) { + throw new Error('Missing required parameter: "scopes"'); + } + + let path = '/projects/{projectId}/keys'.replace(new RegExp('{projectId}', 'g'), projectId); + + let payload = {}; + + if(name) { + payload['name'] = name; + } + + if(scopes) { + payload['scopes'] = scopes; + } + + return http + .post(path, { + 'content-type': 'application/json', + }, payload); + }, + + /** + * Get Key + * + * + * @param {string} projectId + * @param {string} keyId + * @throws {Error} + * @return {Promise} + */ + getKey: function(projectId, keyId) { + if(projectId === undefined) { + throw new Error('Missing required parameter: "projectId"'); + } + + if(keyId === undefined) { + throw new Error('Missing required parameter: "keyId"'); + } + + let path = '/projects/{projectId}/keys/{keyId}'.replace(new RegExp('{projectId}', 'g'), projectId).replace(new RegExp('{keyId}', 'g'), keyId); + + let payload = {}; + + return http + .get(path, { + 'content-type': 'application/json', + }, payload); + }, + + /** + * Update Key + * + * + * @param {string} projectId + * @param {string} keyId + * @param {string} name + * @param {array} scopes + * @throws {Error} + * @return {Promise} + */ + updateKey: function(projectId, keyId, name, scopes) { + if(projectId === undefined) { + throw new Error('Missing required parameter: "projectId"'); + } + + if(keyId === undefined) { + throw new Error('Missing required parameter: "keyId"'); + } + + if(name === undefined) { + throw new Error('Missing required parameter: "name"'); + } + + if(scopes === undefined) { + throw new Error('Missing required parameter: "scopes"'); + } + + let path = '/projects/{projectId}/keys/{keyId}'.replace(new RegExp('{projectId}', 'g'), projectId).replace(new RegExp('{keyId}', 'g'), keyId); + + let payload = {}; + + if(name) { + payload['name'] = name; + } + + if(scopes) { + payload['scopes'] = scopes; + } + + return http + .put(path, { + 'content-type': 'application/json', + }, payload); + }, + + /** + * Delete Key + * + * + * @param {string} projectId + * @param {string} keyId + * @throws {Error} + * @return {Promise} + */ + deleteKey: function(projectId, keyId) { + if(projectId === undefined) { + throw new Error('Missing required parameter: "projectId"'); + } + + if(keyId === undefined) { + throw new Error('Missing required parameter: "keyId"'); + } + + let path = '/projects/{projectId}/keys/{keyId}'.replace(new RegExp('{projectId}', 'g'), projectId).replace(new RegExp('{keyId}', 'g'), keyId); + + let payload = {}; + + return http + .delete(path, { + 'content-type': 'application/json', + }, payload); + }, + + /** + * Update Project OAuth + * + * + * @param {string} projectId + * @param {string} provider + * @param {string} appId + * @param {string} secret + * @throws {Error} + * @return {Promise} + */ + updateOAuth: function(projectId, provider, appId = '', secret = '') { + if(projectId === undefined) { + throw new Error('Missing required parameter: "projectId"'); + } + + if(provider === undefined) { + throw new Error('Missing required parameter: "provider"'); + } + + let path = '/projects/{projectId}/oauth'.replace(new RegExp('{projectId}', 'g'), projectId); + + let payload = {}; + + if(provider) { + payload['provider'] = provider; + } + + if(appId) { + payload['appId'] = appId; + } + + if(secret) { + payload['secret'] = secret; + } + + return http + .patch(path, { + 'content-type': 'application/json', + }, payload); + }, + + /** + * List Platforms + * + * + * @param {string} projectId + * @throws {Error} + * @return {Promise} + */ + listPlatforms: function(projectId) { + if(projectId === undefined) { + throw new Error('Missing required parameter: "projectId"'); + } + + let path = '/projects/{projectId}/platforms'.replace(new RegExp('{projectId}', 'g'), projectId); + + let payload = {}; + + return http + .get(path, { + 'content-type': 'application/json', + }, payload); + }, + + /** + * Create Platform + * + * + * @param {string} projectId + * @param {string} type + * @param {string} name + * @param {string} key + * @param {string} store + * @param {string} url + * @throws {Error} + * @return {Promise} + */ + createPlatform: function(projectId, type, name, key = '', store = '', url = '') { + if(projectId === undefined) { + throw new Error('Missing required parameter: "projectId"'); + } + + if(type === undefined) { + throw new Error('Missing required parameter: "type"'); + } + + if(name === undefined) { + throw new Error('Missing required parameter: "name"'); + } + + let path = '/projects/{projectId}/platforms'.replace(new RegExp('{projectId}', 'g'), projectId); + + let payload = {}; + + if(type) { + payload['type'] = type; + } + + if(name) { + payload['name'] = name; + } + + if(key) { + payload['key'] = key; + } + + if(store) { + payload['store'] = store; + } + + if(url) { + payload['url'] = url; + } + + return http + .post(path, { + 'content-type': 'application/json', + }, payload); + }, + + /** + * Get Platform + * + * + * @param {string} projectId + * @param {string} platformId + * @throws {Error} + * @return {Promise} + */ + getPlatform: function(projectId, platformId) { + if(projectId === undefined) { + throw new Error('Missing required parameter: "projectId"'); + } + + if(platformId === undefined) { + throw new Error('Missing required parameter: "platformId"'); + } + + let path = '/projects/{projectId}/platforms/{platformId}'.replace(new RegExp('{projectId}', 'g'), projectId).replace(new RegExp('{platformId}', 'g'), platformId); + + let payload = {}; + + return http + .get(path, { + 'content-type': 'application/json', + }, payload); + }, + + /** + * Update Platform + * + * + * @param {string} projectId + * @param {string} platformId + * @param {string} name + * @param {string} key + * @param {string} store + * @param {string} url + * @throws {Error} + * @return {Promise} + */ + updatePlatform: function(projectId, platformId, name, key = '', store = '', url = '') { + if(projectId === undefined) { + throw new Error('Missing required parameter: "projectId"'); + } + + if(platformId === undefined) { + throw new Error('Missing required parameter: "platformId"'); + } + + if(name === undefined) { + throw new Error('Missing required parameter: "name"'); + } + + let path = '/projects/{projectId}/platforms/{platformId}'.replace(new RegExp('{projectId}', 'g'), projectId).replace(new RegExp('{platformId}', 'g'), platformId); + + let payload = {}; + + if(name) { + payload['name'] = name; + } + + if(key) { + payload['key'] = key; + } + + if(store) { + payload['store'] = store; + } + + if(url) { + payload['url'] = url; + } + + return http + .put(path, { + 'content-type': 'application/json', + }, payload); + }, + + /** + * Delete Platform + * + * + * @param {string} projectId + * @param {string} platformId + * @throws {Error} + * @return {Promise} + */ + deletePlatform: function(projectId, platformId) { + if(projectId === undefined) { + throw new Error('Missing required parameter: "projectId"'); + } + + if(platformId === undefined) { + throw new Error('Missing required parameter: "platformId"'); + } + + let path = '/projects/{projectId}/platforms/{platformId}'.replace(new RegExp('{projectId}', 'g'), projectId).replace(new RegExp('{platformId}', 'g'), platformId); + + let payload = {}; + + return http + .delete(path, { + 'content-type': 'application/json', + }, payload); + }, + + /** + * List Tasks + * + * + * @param {string} projectId + * @throws {Error} + * @return {Promise} + */ + listTasks: function(projectId) { + if(projectId === undefined) { + throw new Error('Missing required parameter: "projectId"'); + } + + let path = '/projects/{projectId}/tasks'.replace(new RegExp('{projectId}', 'g'), projectId); + + let payload = {}; + + return http + .get(path, { + 'content-type': 'application/json', + }, payload); + }, + + /** + * Create Task + * + * + * @param {string} projectId + * @param {string} name + * @param {string} status + * @param {string} schedule + * @param {number} security + * @param {string} httpMethod + * @param {string} httpUrl + * @param {array} httpHeaders + * @param {string} httpUser + * @param {string} httpPass + * @throws {Error} + * @return {Promise} + */ + createTask: function(projectId, name, status, schedule, security, httpMethod, httpUrl, httpHeaders = [], httpUser = '', httpPass = '') { + if(projectId === undefined) { + throw new Error('Missing required parameter: "projectId"'); + } + + if(name === undefined) { + throw new Error('Missing required parameter: "name"'); + } + + if(status === undefined) { + throw new Error('Missing required parameter: "status"'); + } + + if(schedule === undefined) { + throw new Error('Missing required parameter: "schedule"'); + } + + if(security === undefined) { + throw new Error('Missing required parameter: "security"'); + } + + if(httpMethod === undefined) { + throw new Error('Missing required parameter: "httpMethod"'); + } + + if(httpUrl === undefined) { + throw new Error('Missing required parameter: "httpUrl"'); + } + + let path = '/projects/{projectId}/tasks'.replace(new RegExp('{projectId}', 'g'), projectId); + + let payload = {}; + + if(name) { + payload['name'] = name; + } + + if(status) { + payload['status'] = status; + } + + if(schedule) { + payload['schedule'] = schedule; + } + + if(security) { + payload['security'] = security; + } + + if(httpMethod) { + payload['httpMethod'] = httpMethod; + } + + if(httpUrl) { + payload['httpUrl'] = httpUrl; + } + + if(httpHeaders) { + payload['httpHeaders'] = httpHeaders; + } + + if(httpUser) { + payload['httpUser'] = httpUser; + } + + if(httpPass) { + payload['httpPass'] = httpPass; + } + + return http + .post(path, { + 'content-type': 'application/json', + }, payload); + }, + + /** + * Get Task + * + * + * @param {string} projectId + * @param {string} taskId + * @throws {Error} + * @return {Promise} + */ + getTask: function(projectId, taskId) { + if(projectId === undefined) { + throw new Error('Missing required parameter: "projectId"'); + } + + if(taskId === undefined) { + throw new Error('Missing required parameter: "taskId"'); + } + + let path = '/projects/{projectId}/tasks/{taskId}'.replace(new RegExp('{projectId}', 'g'), projectId).replace(new RegExp('{taskId}', 'g'), taskId); + + let payload = {}; + + return http + .get(path, { + 'content-type': 'application/json', + }, payload); + }, + + /** + * Update Task + * + * + * @param {string} projectId + * @param {string} taskId + * @param {string} name + * @param {string} status + * @param {string} schedule + * @param {number} security + * @param {string} httpMethod + * @param {string} httpUrl + * @param {array} httpHeaders + * @param {string} httpUser + * @param {string} httpPass + * @throws {Error} + * @return {Promise} + */ + updateTask: function(projectId, taskId, name, status, schedule, security, httpMethod, httpUrl, httpHeaders = [], httpUser = '', httpPass = '') { + if(projectId === undefined) { + throw new Error('Missing required parameter: "projectId"'); + } + + if(taskId === undefined) { + throw new Error('Missing required parameter: "taskId"'); + } + + if(name === undefined) { + throw new Error('Missing required parameter: "name"'); + } + + if(status === undefined) { + throw new Error('Missing required parameter: "status"'); + } + + if(schedule === undefined) { + throw new Error('Missing required parameter: "schedule"'); + } + + if(security === undefined) { + throw new Error('Missing required parameter: "security"'); + } + + if(httpMethod === undefined) { + throw new Error('Missing required parameter: "httpMethod"'); + } + + if(httpUrl === undefined) { + throw new Error('Missing required parameter: "httpUrl"'); + } + + let path = '/projects/{projectId}/tasks/{taskId}'.replace(new RegExp('{projectId}', 'g'), projectId).replace(new RegExp('{taskId}', 'g'), taskId); + + let payload = {}; + + if(name) { + payload['name'] = name; + } + + if(status) { + payload['status'] = status; + } + + if(schedule) { + payload['schedule'] = schedule; + } + + if(security) { + payload['security'] = security; + } + + if(httpMethod) { + payload['httpMethod'] = httpMethod; + } + + if(httpUrl) { + payload['httpUrl'] = httpUrl; + } + + if(httpHeaders) { + payload['httpHeaders'] = httpHeaders; + } + + if(httpUser) { + payload['httpUser'] = httpUser; + } + + if(httpPass) { + payload['httpPass'] = httpPass; + } + + return http + .put(path, { + 'content-type': 'application/json', + }, payload); + }, + + /** + * Delete Task + * + * + * @param {string} projectId + * @param {string} taskId + * @throws {Error} + * @return {Promise} + */ + deleteTask: function(projectId, taskId) { + if(projectId === undefined) { + throw new Error('Missing required parameter: "projectId"'); + } + + if(taskId === undefined) { + throw new Error('Missing required parameter: "taskId"'); + } + + let path = '/projects/{projectId}/tasks/{taskId}'.replace(new RegExp('{projectId}', 'g'), projectId).replace(new RegExp('{taskId}', 'g'), taskId); + + let payload = {}; + + return http + .delete(path, { + 'content-type': 'application/json', + }, payload); + }, + + /** + * Get Project + * + * + * @param {string} projectId + * @throws {Error} + * @return {Promise} + */ + getUsage: function(projectId) { + if(projectId === undefined) { + throw new Error('Missing required parameter: "projectId"'); + } + + let path = '/projects/{projectId}/usage'.replace(new RegExp('{projectId}', 'g'), projectId); + + let payload = {}; + + return http + .get(path, { + 'content-type': 'application/json', + }, payload); + }, + + /** + * List Webhooks + * + * + * @param {string} projectId + * @throws {Error} + * @return {Promise} + */ + listWebhooks: function(projectId) { + if(projectId === undefined) { + throw new Error('Missing required parameter: "projectId"'); + } + + let path = '/projects/{projectId}/webhooks'.replace(new RegExp('{projectId}', 'g'), projectId); + + let payload = {}; + + return http + .get(path, { + 'content-type': 'application/json', + }, payload); + }, + + /** + * Create Webhook + * + * + * @param {string} projectId + * @param {string} name + * @param {array} events + * @param {string} url + * @param {number} security + * @param {string} httpUser + * @param {string} httpPass + * @throws {Error} + * @return {Promise} + */ + createWebhook: function(projectId, name, events, url, security, httpUser = '', httpPass = '') { + if(projectId === undefined) { + throw new Error('Missing required parameter: "projectId"'); + } + + if(name === undefined) { + throw new Error('Missing required parameter: "name"'); + } + + if(events === undefined) { + throw new Error('Missing required parameter: "events"'); + } + + if(url === undefined) { + throw new Error('Missing required parameter: "url"'); + } + + if(security === undefined) { + throw new Error('Missing required parameter: "security"'); + } + + let path = '/projects/{projectId}/webhooks'.replace(new RegExp('{projectId}', 'g'), projectId); + + let payload = {}; + + if(name) { + payload['name'] = name; + } + + if(events) { + payload['events'] = events; + } + + if(url) { + payload['url'] = url; + } + + if(security) { + payload['security'] = security; + } + + if(httpUser) { + payload['httpUser'] = httpUser; + } + + if(httpPass) { + payload['httpPass'] = httpPass; + } + + return http + .post(path, { + 'content-type': 'application/json', + }, payload); + }, + + /** + * Get Webhook + * + * + * @param {string} projectId + * @param {string} webhookId + * @throws {Error} + * @return {Promise} + */ + getWebhook: function(projectId, webhookId) { + if(projectId === undefined) { + throw new Error('Missing required parameter: "projectId"'); + } + + if(webhookId === undefined) { + throw new Error('Missing required parameter: "webhookId"'); + } + + let path = '/projects/{projectId}/webhooks/{webhookId}'.replace(new RegExp('{projectId}', 'g'), projectId).replace(new RegExp('{webhookId}', 'g'), webhookId); + + let payload = {}; + + return http + .get(path, { + 'content-type': 'application/json', + }, payload); + }, + + /** + * Update Webhook + * + * + * @param {string} projectId + * @param {string} webhookId + * @param {string} name + * @param {array} events + * @param {string} url + * @param {number} security + * @param {string} httpUser + * @param {string} httpPass + * @throws {Error} + * @return {Promise} + */ + updateWebhook: function(projectId, webhookId, name, events, url, security, httpUser = '', httpPass = '') { + if(projectId === undefined) { + throw new Error('Missing required parameter: "projectId"'); + } + + if(webhookId === undefined) { + throw new Error('Missing required parameter: "webhookId"'); + } + + if(name === undefined) { + throw new Error('Missing required parameter: "name"'); + } + + if(events === undefined) { + throw new Error('Missing required parameter: "events"'); + } + + if(url === undefined) { + throw new Error('Missing required parameter: "url"'); + } + + if(security === undefined) { + throw new Error('Missing required parameter: "security"'); + } + + let path = '/projects/{projectId}/webhooks/{webhookId}'.replace(new RegExp('{projectId}', 'g'), projectId).replace(new RegExp('{webhookId}', 'g'), webhookId); + + let payload = {}; + + if(name) { + payload['name'] = name; + } + + if(events) { + payload['events'] = events; + } + + if(url) { + payload['url'] = url; + } + + if(security) { + payload['security'] = security; + } + + if(httpUser) { + payload['httpUser'] = httpUser; + } + + if(httpPass) { + payload['httpPass'] = httpPass; + } + + return http + .put(path, { + 'content-type': 'application/json', + }, payload); + }, + + /** + * Delete Webhook + * + * + * @param {string} projectId + * @param {string} webhookId + * @throws {Error} + * @return {Promise} + */ + deleteWebhook: function(projectId, webhookId) { + if(projectId === undefined) { + throw new Error('Missing required parameter: "projectId"'); + } + + if(webhookId === undefined) { + throw new Error('Missing required parameter: "webhookId"'); + } + + let path = '/projects/{projectId}/webhooks/{webhookId}'.replace(new RegExp('{projectId}', 'g'), projectId).replace(new RegExp('{webhookId}', 'g'), webhookId); + + let payload = {}; + + return http + .delete(path, { + 'content-type': 'application/json', + }, payload); + } + }; + let storage = { /** @@ -1758,7 +2931,7 @@ * @throws {Error} * @return {Promise} */ - list: function(search = '', limit = 25, offset = 0, orderType = 'ASC') { + listFiles: function(search = '', limit = 25, offset = 0, orderType = 'ASC') { let path = '/storage/files'; let payload = {}; @@ -1798,7 +2971,7 @@ * @throws {Error} * @return {Promise} */ - create: function(file, read, write) { + createFile: function(file, read, write) { if(file === undefined) { throw new Error('Missing required parameter: "file"'); } @@ -1843,7 +3016,7 @@ * @throws {Error} * @return {Promise} */ - get: function(fileId) { + getFile: function(fileId) { if(fileId === undefined) { throw new Error('Missing required parameter: "fileId"'); } @@ -1870,7 +3043,7 @@ * @throws {Error} * @return {Promise} */ - update: function(fileId, read, write) { + updateFile: function(fileId, read, write) { if(fileId === undefined) { throw new Error('Missing required parameter: "fileId"'); } @@ -1911,7 +3084,7 @@ * @throws {Error} * @return {Promise} */ - delete: function(fileId) { + deleteFile: function(fileId) { if(fileId === undefined) { throw new Error('Missing required parameter: "fileId"'); } @@ -1937,7 +3110,7 @@ * @throws {Error} * @return {Promise} */ - getDownload: function(fileId) { + getFileDownload: function(fileId) { if(fileId === undefined) { throw new Error('Missing required parameter: "fileId"'); } @@ -1969,7 +3142,7 @@ * @throws {Error} * @return {Promise} */ - getPreview: function(fileId, width = 0, height = 0, quality = 100, background = '', output = '') { + getFilePreview: function(fileId, width = 0, height = 0, quality = 100, background = '', output = '') { if(fileId === undefined) { throw new Error('Missing required parameter: "fileId"'); } @@ -2015,7 +3188,7 @@ * @throws {Error} * @return {Promise} */ - getView: function(fileId, as = '') { + getFileView: function(fileId, as = '') { if(fileId === undefined) { throw new Error('Missing required parameter: "fileId"'); } @@ -2383,6 +3556,311 @@ } }; + let users = { + + /** + * List Users + * + * Get a list of all the project users. You can use the query params to filter + * your results. + * + * @param {string} search + * @param {number} limit + * @param {number} offset + * @param {string} orderType + * @throws {Error} + * @return {Promise} + */ + list: function(search = '', limit = 25, offset = 0, orderType = 'ASC') { + let path = '/users'; + + let payload = {}; + + if(search) { + payload['search'] = search; + } + + if(limit) { + payload['limit'] = limit; + } + + if(offset) { + payload['offset'] = offset; + } + + if(orderType) { + payload['orderType'] = orderType; + } + + return http + .get(path, { + 'content-type': 'application/json', + }, payload); + }, + + /** + * Create User + * + * Create a new user. + * + * @param {string} email + * @param {string} password + * @param {string} name + * @throws {Error} + * @return {Promise} + */ + create: function(email, password, name = '') { + if(email === undefined) { + throw new Error('Missing required parameter: "email"'); + } + + if(password === undefined) { + throw new Error('Missing required parameter: "password"'); + } + + let path = '/users'; + + let payload = {}; + + if(email) { + payload['email'] = email; + } + + if(password) { + payload['password'] = password; + } + + if(name) { + payload['name'] = name; + } + + return http + .post(path, { + 'content-type': 'application/json', + }, payload); + }, + + /** + * Get User + * + * Get user by its unique ID. + * + * @param {string} userId + * @throws {Error} + * @return {Promise} + */ + get: function(userId) { + if(userId === undefined) { + throw new Error('Missing required parameter: "userId"'); + } + + let path = '/users/{userId}'.replace(new RegExp('{userId}', 'g'), userId); + + let payload = {}; + + return http + .get(path, { + 'content-type': 'application/json', + }, payload); + }, + + /** + * Get User Logs + * + * Get user activity logs list by its unique ID. + * + * @param {string} userId + * @throws {Error} + * @return {Promise} + */ + getLogs: function(userId) { + if(userId === undefined) { + throw new Error('Missing required parameter: "userId"'); + } + + let path = '/users/{userId}/logs'.replace(new RegExp('{userId}', 'g'), userId); + + let payload = {}; + + return http + .get(path, { + 'content-type': 'application/json', + }, payload); + }, + + /** + * Get User Preferences + * + * Get user preferences by its unique ID. + * + * @param {string} userId + * @throws {Error} + * @return {Promise} + */ + getPrefs: function(userId) { + if(userId === undefined) { + throw new Error('Missing required parameter: "userId"'); + } + + let path = '/users/{userId}/prefs'.replace(new RegExp('{userId}', 'g'), userId); + + let payload = {}; + + return http + .get(path, { + 'content-type': 'application/json', + }, payload); + }, + + /** + * Update User Preferences + * + * Update user preferences by its unique ID. You can pass only the specific + * settings you wish to update. + * + * @param {string} userId + * @param {string} prefs + * @throws {Error} + * @return {Promise} + */ + updatePrefs: function(userId, prefs) { + if(userId === undefined) { + throw new Error('Missing required parameter: "userId"'); + } + + if(prefs === undefined) { + throw new Error('Missing required parameter: "prefs"'); + } + + let path = '/users/{userId}/prefs'.replace(new RegExp('{userId}', 'g'), userId); + + let payload = {}; + + if(prefs) { + payload['prefs'] = prefs; + } + + return http + .patch(path, { + 'content-type': 'application/json', + }, payload); + }, + + /** + * Get User Sessions + * + * Get user sessions list by its unique ID. + * + * @param {string} userId + * @throws {Error} + * @return {Promise} + */ + getSessions: function(userId) { + if(userId === undefined) { + throw new Error('Missing required parameter: "userId"'); + } + + let path = '/users/{userId}/sessions'.replace(new RegExp('{userId}', 'g'), userId); + + let payload = {}; + + return http + .get(path, { + 'content-type': 'application/json', + }, payload); + }, + + /** + * Delete User Sessions + * + * Delete all user sessions by its unique ID. + * + * @param {string} userId + * @throws {Error} + * @return {Promise} + */ + deleteSessions: function(userId) { + if(userId === undefined) { + throw new Error('Missing required parameter: "userId"'); + } + + let path = '/users/{userId}/sessions'.replace(new RegExp('{userId}', 'g'), userId); + + let payload = {}; + + return http + .delete(path, { + 'content-type': 'application/json', + }, payload); + }, + + /** + * Delete User Session + * + * Delete user sessions by its unique ID. + * + * @param {string} userId + * @param {string} sessionId + * @throws {Error} + * @return {Promise} + */ + deleteSession: function(userId, sessionId) { + if(userId === undefined) { + throw new Error('Missing required parameter: "userId"'); + } + + if(sessionId === undefined) { + throw new Error('Missing required parameter: "sessionId"'); + } + + let path = '/users/{userId}/sessions/:session'.replace(new RegExp('{userId}', 'g'), userId); + + let payload = {}; + + if(sessionId) { + payload['sessionId'] = sessionId; + } + + return http + .delete(path, { + 'content-type': 'application/json', + }, payload); + }, + + /** + * Update User Status + * + * Update user status by its unique ID. + * + * @param {string} userId + * @param {string} status + * @throws {Error} + * @return {Promise} + */ + updateStatus: function(userId, status) { + if(userId === undefined) { + throw new Error('Missing required parameter: "userId"'); + } + + if(status === undefined) { + throw new Error('Missing required parameter: "status"'); + } + + let path = '/users/{userId}/status'.replace(new RegExp('{userId}', 'g'), userId); + + let payload = {}; + + if(status) { + payload['status'] = status; + } + + return http + .patch(path, { + 'content-type': 'application/json', + }, payload); + } + }; + return { setEndpoint: setEndpoint, setProject: setProject, @@ -2393,8 +3871,10 @@ avatars: avatars, database: database, locale: locale, + projects: projects, storage: storage, - teams: teams + teams: teams, + users: users }; }; diff --git a/app/sdks/javascript/src/sdk.min.js b/app/sdks/javascript/src/sdk.min.js index 633f0f4684..495ad1181a 100644 --- a/app/sdks/javascript/src/sdk.min.js +++ b/app/sdks/javascript/src/sdk.min.js @@ -1,5 +1,5 @@ (function(window){'use strict';window.Appwrite=function(){let config={endpoint:'https://appwrite.io/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=/(?:\?|&|&)+([^=]+)(?:=([^&]*))*/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;indexsetProject('') + ->setKey('') +; + +$storage = new Storage($client); + +$result = $storage->createFile(new \CURLFile('/path/to/file.png', 'image/png', 'file.png'), [], []); \ No newline at end of file diff --git a/app/sdks/php/docs/examples/storage/delete-file.md b/app/sdks/php/docs/examples/storage/delete-file.md new file mode 100644 index 0000000000..74448e5a7c --- /dev/null +++ b/app/sdks/php/docs/examples/storage/delete-file.md @@ -0,0 +1,15 @@ +setProject('') + ->setKey('') +; + +$storage = new Storage($client); + +$result = $storage->deleteFile('[FILE_ID]'); \ No newline at end of file diff --git a/app/sdks/php/docs/examples/storage/get-file-download.md b/app/sdks/php/docs/examples/storage/get-file-download.md new file mode 100644 index 0000000000..3a6db00081 --- /dev/null +++ b/app/sdks/php/docs/examples/storage/get-file-download.md @@ -0,0 +1,15 @@ +setProject('') + ->setKey('') +; + +$storage = new Storage($client); + +$result = $storage->getFileDownload('[FILE_ID]'); \ No newline at end of file diff --git a/app/sdks/php/docs/examples/storage/get-file-preview.md b/app/sdks/php/docs/examples/storage/get-file-preview.md new file mode 100644 index 0000000000..8b02bdd2a9 --- /dev/null +++ b/app/sdks/php/docs/examples/storage/get-file-preview.md @@ -0,0 +1,15 @@ +setProject('') + ->setKey('') +; + +$storage = new Storage($client); + +$result = $storage->getFilePreview('[FILE_ID]'); \ No newline at end of file diff --git a/app/sdks/php/docs/examples/storage/get-file-view.md b/app/sdks/php/docs/examples/storage/get-file-view.md new file mode 100644 index 0000000000..59cc25bc74 --- /dev/null +++ b/app/sdks/php/docs/examples/storage/get-file-view.md @@ -0,0 +1,15 @@ +setProject('') + ->setKey('') +; + +$storage = new Storage($client); + +$result = $storage->getFileView('[FILE_ID]'); \ No newline at end of file diff --git a/app/sdks/php/docs/examples/storage/get-file.md b/app/sdks/php/docs/examples/storage/get-file.md new file mode 100644 index 0000000000..63fa59b40a --- /dev/null +++ b/app/sdks/php/docs/examples/storage/get-file.md @@ -0,0 +1,15 @@ +setProject('') + ->setKey('') +; + +$storage = new Storage($client); + +$result = $storage->getFile('[FILE_ID]'); \ No newline at end of file diff --git a/app/sdks/php/docs/examples/storage/list-files.md b/app/sdks/php/docs/examples/storage/list-files.md new file mode 100644 index 0000000000..434e1fe70d --- /dev/null +++ b/app/sdks/php/docs/examples/storage/list-files.md @@ -0,0 +1,15 @@ +setProject('') + ->setKey('') +; + +$storage = new Storage($client); + +$result = $storage->listFiles(); \ No newline at end of file diff --git a/app/sdks/php/docs/examples/storage/update-file.md b/app/sdks/php/docs/examples/storage/update-file.md new file mode 100644 index 0000000000..637870a7a6 --- /dev/null +++ b/app/sdks/php/docs/examples/storage/update-file.md @@ -0,0 +1,15 @@ +setProject('') + ->setKey('') +; + +$storage = new Storage($client); + +$result = $storage->updateFile('[FILE_ID]', [], []); \ No newline at end of file diff --git a/app/sdks/php/src/Appwrite/Services/Storage.php b/app/sdks/php/src/Appwrite/Services/Storage.php index c4931f9227..09b74fbf8f 100644 --- a/app/sdks/php/src/Appwrite/Services/Storage.php +++ b/app/sdks/php/src/Appwrite/Services/Storage.php @@ -22,7 +22,7 @@ class Storage extends Service * @throws Exception * @return array */ - public function list(string $search = '', int $limit = 25, int $offset = 0, string $orderType = 'ASC'):array + public function listFiles(string $search = '', int $limit = 25, int $offset = 0, string $orderType = 'ASC'):array { $path = str_replace([], [], '/storage/files'); $params = []; @@ -50,7 +50,7 @@ class Storage extends Service * @throws Exception * @return array */ - public function create(\CurlFile $file, array $read, array $write):array + public function createFile(\CurlFile $file, array $read, array $write):array { $path = str_replace([], [], '/storage/files'); $params = []; @@ -74,7 +74,7 @@ class Storage extends Service * @throws Exception * @return array */ - public function get(string $fileId):array + public function getFile(string $fileId):array { $path = str_replace(['{fileId}'], [$fileId], '/storage/files/{fileId}'); $params = []; @@ -97,7 +97,7 @@ class Storage extends Service * @throws Exception * @return array */ - public function update(string $fileId, array $read, array $write):array + public function updateFile(string $fileId, array $read, array $write):array { $path = str_replace(['{fileId}'], [$fileId], '/storage/files/{fileId}'); $params = []; @@ -120,7 +120,7 @@ class Storage extends Service * @throws Exception * @return array */ - public function delete(string $fileId):array + public function deleteFile(string $fileId):array { $path = str_replace(['{fileId}'], [$fileId], '/storage/files/{fileId}'); $params = []; @@ -142,7 +142,7 @@ class Storage extends Service * @throws Exception * @return array */ - public function getDownload(string $fileId):array + public function getFileDownload(string $fileId):array { $path = str_replace(['{fileId}'], [$fileId], '/storage/files/{fileId}/download'); $params = []; @@ -170,7 +170,7 @@ class Storage extends Service * @throws Exception * @return array */ - public function getPreview(string $fileId, int $width = 0, int $height = 0, int $quality = 100, string $background = '', string $output = ''):array + public function getFilePreview(string $fileId, int $width = 0, int $height = 0, int $quality = 100, string $background = '', string $output = ''):array { $path = str_replace(['{fileId}'], [$fileId], '/storage/files/{fileId}/preview'); $params = []; @@ -197,7 +197,7 @@ class Storage extends Service * @throws Exception * @return array */ - public function getView(string $fileId, string $as = ''):array + public function getFileView(string $fileId, string $as = ''):array { $path = str_replace(['{fileId}'], [$fileId], '/storage/files/{fileId}/view'); $params = []; diff --git a/app/sdks/python/appwrite/services/storage.py b/app/sdks/python/appwrite/services/storage.py index 8423be06e0..7e2a986f6e 100644 --- a/app/sdks/python/appwrite/services/storage.py +++ b/app/sdks/python/appwrite/services/storage.py @@ -6,7 +6,7 @@ class Storage(Service): def __init__(self, client): super(Storage, self).__init__(client) - def list(self, search='', limit=25, offset=0, order_type='ASC'): + def list_files(self, search='', limit=25, offset=0, order_type='ASC'): """List Files""" params = {} @@ -20,7 +20,7 @@ class Storage(Service): 'content-type': 'application/json', }, params) - def create(self, file, read, write): + def create_file(self, file, read, write): """Create File""" params = {} @@ -33,7 +33,7 @@ class Storage(Service): 'content-type': 'multipart/form-data', }, params) - def get(self, file_id): + def get_file(self, file_id): """Get File""" params = {} @@ -44,7 +44,7 @@ class Storage(Service): 'content-type': 'application/json', }, params) - def update(self, file_id, read, write): + def update_file(self, file_id, read, write): """Update File""" params = {} @@ -57,7 +57,7 @@ class Storage(Service): 'content-type': 'application/json', }, params) - def delete(self, file_id): + def delete_file(self, file_id): """Delete File""" params = {} @@ -68,7 +68,7 @@ class Storage(Service): 'content-type': 'application/json', }, params) - def get_download(self, file_id): + def get_file_download(self, file_id): """Get File for Download""" params = {} @@ -79,7 +79,7 @@ class Storage(Service): 'content-type': 'application/json', }, params) - def get_preview(self, file_id, width=0, height=0, quality=100, background='', output=''): + def get_file_preview(self, file_id, width=0, height=0, quality=100, background='', output=''): """Get File Preview""" params = {} @@ -95,7 +95,7 @@ class Storage(Service): 'content-type': 'application/json', }, params) - def get_view(self, file_id, xas=''): + def get_file_view(self, file_id, xas=''): """Get File for View""" params = {} diff --git a/app/sdks/python/docs/examples/storage/create-file.md b/app/sdks/python/docs/examples/storage/create-file.md new file mode 100644 index 0000000000..9ef2aacd18 --- /dev/null +++ b/app/sdks/python/docs/examples/storage/create-file.md @@ -0,0 +1,13 @@ +from appwrite.client import Client +from appwrite.services.storage import Storage + +client = Client() + +(client + .set_project('') + .set_key('') +) + +storage = Storage(client) + +result = storage.create_file(document.getElementById('uploader').files[0], {}, {}) diff --git a/app/sdks/python/docs/examples/storage/delete-file.md b/app/sdks/python/docs/examples/storage/delete-file.md new file mode 100644 index 0000000000..7dbf229d28 --- /dev/null +++ b/app/sdks/python/docs/examples/storage/delete-file.md @@ -0,0 +1,13 @@ +from appwrite.client import Client +from appwrite.services.storage import Storage + +client = Client() + +(client + .set_project('') + .set_key('') +) + +storage = Storage(client) + +result = storage.delete_file('[FILE_ID]') diff --git a/app/sdks/python/docs/examples/storage/get-file-download.md b/app/sdks/python/docs/examples/storage/get-file-download.md new file mode 100644 index 0000000000..cbe8f97b41 --- /dev/null +++ b/app/sdks/python/docs/examples/storage/get-file-download.md @@ -0,0 +1,13 @@ +from appwrite.client import Client +from appwrite.services.storage import Storage + +client = Client() + +(client + .set_project('') + .set_key('') +) + +storage = Storage(client) + +result = storage.get_file_download('[FILE_ID]') diff --git a/app/sdks/python/docs/examples/storage/get-file-preview.md b/app/sdks/python/docs/examples/storage/get-file-preview.md new file mode 100644 index 0000000000..7d8ffc854e --- /dev/null +++ b/app/sdks/python/docs/examples/storage/get-file-preview.md @@ -0,0 +1,13 @@ +from appwrite.client import Client +from appwrite.services.storage import Storage + +client = Client() + +(client + .set_project('') + .set_key('') +) + +storage = Storage(client) + +result = storage.get_file_preview('[FILE_ID]') diff --git a/app/sdks/python/docs/examples/storage/get-file-view.md b/app/sdks/python/docs/examples/storage/get-file-view.md new file mode 100644 index 0000000000..72f0ec5731 --- /dev/null +++ b/app/sdks/python/docs/examples/storage/get-file-view.md @@ -0,0 +1,13 @@ +from appwrite.client import Client +from appwrite.services.storage import Storage + +client = Client() + +(client + .set_project('') + .set_key('') +) + +storage = Storage(client) + +result = storage.get_file_view('[FILE_ID]') diff --git a/app/sdks/python/docs/examples/storage/get-file.md b/app/sdks/python/docs/examples/storage/get-file.md new file mode 100644 index 0000000000..7146cbdb94 --- /dev/null +++ b/app/sdks/python/docs/examples/storage/get-file.md @@ -0,0 +1,13 @@ +from appwrite.client import Client +from appwrite.services.storage import Storage + +client = Client() + +(client + .set_project('') + .set_key('') +) + +storage = Storage(client) + +result = storage.get_file('[FILE_ID]') diff --git a/app/sdks/python/docs/examples/storage/list-files.md b/app/sdks/python/docs/examples/storage/list-files.md new file mode 100644 index 0000000000..175b3c3a5f --- /dev/null +++ b/app/sdks/python/docs/examples/storage/list-files.md @@ -0,0 +1,13 @@ +from appwrite.client import Client +from appwrite.services.storage import Storage + +client = Client() + +(client + .set_project('') + .set_key('') +) + +storage = Storage(client) + +result = storage.list_files() diff --git a/app/sdks/python/docs/examples/storage/update-file.md b/app/sdks/python/docs/examples/storage/update-file.md new file mode 100644 index 0000000000..b32f8e7ad0 --- /dev/null +++ b/app/sdks/python/docs/examples/storage/update-file.md @@ -0,0 +1,13 @@ +from appwrite.client import Client +from appwrite.services.storage import Storage + +client = Client() + +(client + .set_project('') + .set_key('') +) + +storage = Storage(client) + +result = storage.update_file('[FILE_ID]', {}, {}) diff --git a/app/sdks/ruby/lib/appwrite/services/storage.rb b/app/sdks/ruby/lib/appwrite/services/storage.rb index ea56e484d8..2fe1a5762f 100644 --- a/app/sdks/ruby/lib/appwrite/services/storage.rb +++ b/app/sdks/ruby/lib/appwrite/services/storage.rb @@ -1,7 +1,7 @@ module Appwrite class Storage < Service - def list(search: '', limit: 25, offset: 0, order_type: 'ASC') + def list_files(search: '', limit: 25, offset: 0, order_type: 'ASC') path = '/storage/files' params = { @@ -16,7 +16,7 @@ module Appwrite }, params); end - def create(file:, read:, write:) + def create_file(file:, read:, write:) path = '/storage/files' params = { @@ -30,7 +30,7 @@ module Appwrite }, params); end - def get(file_id:) + def get_file(file_id:) path = '/storage/files/{fileId}' .gsub('{file_id}', file_id) @@ -42,7 +42,7 @@ module Appwrite }, params); end - def update(file_id:, read:, write:) + def update_file(file_id:, read:, write:) path = '/storage/files/{fileId}' .gsub('{file_id}', file_id) @@ -56,7 +56,7 @@ module Appwrite }, params); end - def delete(file_id:) + def delete_file(file_id:) path = '/storage/files/{fileId}' .gsub('{file_id}', file_id) @@ -68,7 +68,7 @@ module Appwrite }, params); end - def get_download(file_id:) + def get_file_download(file_id:) path = '/storage/files/{fileId}/download' .gsub('{file_id}', file_id) @@ -80,7 +80,7 @@ module Appwrite }, params); end - def get_preview(file_id:, width: 0, height: 0, quality: 100, background: '', output: '') + def get_file_preview(file_id:, width: 0, height: 0, quality: 100, background: '', output: '') path = '/storage/files/{fileId}/preview' .gsub('{file_id}', file_id) @@ -97,7 +97,7 @@ module Appwrite }, params); end - def get_view(file_id:, as: '') + def get_file_view(file_id:, as: '') path = '/storage/files/{fileId}/view' .gsub('{file_id}', file_id) diff --git a/app/views/console/comps/header.phtml b/app/views/console/comps/header.phtml index 1814ccfffc..005b9c67e4 100644 --- a/app/views/console/comps/header.phtml +++ b/app/views/console/comps/header.phtml @@ -101,7 +101,7 @@
diff --git a/app/views/console/database/collection.phtml b/app/views/console/database/collection.phtml index 46f1d2fc3d..1460851179 100644 --- a/app/views/console/database/collection.phtml +++ b/app/views/console/database/collection.phtml @@ -29,7 +29,7 @@ $collection = $this->getParam('collection', []); data-scope="sdk" data-success="alert,trigger,reset" data-success-param-alert-text="Created document successfully" - data-success-param-trigger-events="document-create,modal-close" + data-success-param-trigger-events="database.createCollection,modal-close" data-failure="alert" data-failure-param-alert-text="Failed to create document" data-failure-param-alert-classname="error"> @@ -64,7 +64,7 @@ $collection = $this->getParam('collection', []);
getParam('graph', false);

@@ -102,7 +102,7 @@ $graph = $this->getParam('graph', false); data-confirm="Are you sure you want to delete this platform?" data-success="alert,trigger" data-success-param-alert-text="Deleted platform successfully" - data-success-param-trigger-events="platform-delete" + data-success-param-trigger-events="projects.deletePlatform" data-failure="alert" data-failure-param-alert-text="Failed to delete platform" data-failure-param-alert-classname="error"> @@ -161,7 +161,7 @@ $graph = $this->getParam('graph', false); data-event="submit" data-success="alert,trigger,reset" data-success-param-alert-text="Created new platform successfully" - data-success-param-trigger-events="platform-create,modal-close" + data-success-param-trigger-events="projects.createPlatform,modal-close" data-failure="alert" data-failure-param-alert-text="Failed to create platform" data-failure-param-alert-classname="error"> @@ -196,7 +196,7 @@ $graph = $this->getParam('graph', false); data-event="submit" data-success="alert,trigger" data-success-param-alert-text="Updated platform successfully" - data-success-param-trigger-events="platform-update,modal-close" + data-success-param-trigger-events="projects.updatePlatform,modal-close" data-failure="alert" data-failure-param-alert-text="Failed to update platform" data-failure-param-alert-classname="error"> diff --git a/app/views/console/index.phtml b/app/views/console/index.phtml index 5eab8a44e7..aae64c8119 100644 --- a/app/views/console/index.phtml +++ b/app/views/console/index.phtml @@ -21,10 +21,10 @@ $home = $this->getParam('home', '');
+ data-success-param-trigger-events="projects.list">