diff --git a/README.md b/README.md index ebf52e9..f71a37e 100644 --- a/README.md +++ b/README.md @@ -2,7 +2,7 @@ ![Swift Package Manager](https://img.shields.io/github/v/release/appwrite/sdk-for-apple.svg?color=green&style=flat-square) ![License](https://img.shields.io/github/license/appwrite/sdk-for-apple.svg?style=flat-square) -![Version](https://img.shields.io/badge/api%20version-1.4.2-blue.svg?style=flat-square) +![Version](https://img.shields.io/badge/api%20version-1.4.12-blue.svg?style=flat-square) [![Build Status](https://img.shields.io/travis/com/appwrite/sdk-generator?style=flat-square)](https://travis-ci.com/appwrite/sdk-generator) [![Twitter Account](https://img.shields.io/twitter/follow/appwrite?color=00acee&label=twitter&style=flat-square)](https://twitter.com/appwrite) [![Discord](https://img.shields.io/discord/564160730845151244?label=discord&style=flat-square)](https://appwrite.io/discord) @@ -31,7 +31,7 @@ Add the package to your `Package.swift` dependencies: ```swift dependencies: [ - .package(url: "git@github.com:appwrite/sdk-for-apple.git", from: "4.0.1"), + .package(url: "git@github.com:appwrite/sdk-for-apple.git", from: "4.0.2"), ], ``` diff --git a/Sources/Appwrite/Client.swift b/Sources/Appwrite/Client.swift index a923c30..7e60e94 100644 --- a/Sources/Appwrite/Client.swift +++ b/Sources/Appwrite/Client.swift @@ -23,7 +23,7 @@ open class Client { "x-sdk-name": "Apple", "x-sdk-platform": "client", "x-sdk-language": "apple", - "x-sdk-version": "4.0.1", + "x-sdk-version": "4.0.2", "X-Appwrite-Response-Format": "1.4.0" ] diff --git a/Sources/Appwrite/Query.swift b/Sources/Appwrite/Query.swift index 9fa9893..ce1415d 100644 --- a/Sources/Appwrite/Query.swift +++ b/Sources/Appwrite/Query.swift @@ -33,15 +33,15 @@ public class Query { } public static func between(_ attribute: String, start: Int, end: Int) -> String { - buildQueryWhere(attribute, is: "between", to: [start, end]) + "between(\"\(attribute)\", \(start), \(end))" } public static func between(_ attribute: String, start: Double, end: Double) -> String { - buildQueryWhere(attribute, is: "between", to: [start, end]) + "between(\"\(attribute)\", \(start), \(end))" } public static func between(_ attribute: String, start: String, end: String) -> String { - buildQueryWhere(attribute, is: "between", to: [start, end]) + "between(\"\(attribute)\", \"\(start)\", \"\(end)\")" } public static func startsWith(_ attribute: String, value: String) -> String { diff --git a/Sources/Appwrite/Services/Account.swift b/Sources/Appwrite/Services/Account.swift index ea4b8b9..f654ab4 100644 --- a/Sources/Appwrite/Services/Account.swift +++ b/Sources/Appwrite/Services/Account.swift @@ -8,7 +8,7 @@ import AppwriteModels open class Account: Service { /// - /// Get Account + /// Get account /// /// Get the currently logged in user. /// @@ -40,7 +40,7 @@ open class Account: Service { } /// - /// Get Account + /// Get account /// /// Get the currently logged in user. /// @@ -55,14 +55,15 @@ open class Account: Service { } /// - /// Create Account + /// Create account /// /// Use this endpoint to allow a new user to register a new account in your /// project. After the user registration completes successfully, you can use - /// the [/account/verfication](/docs/client/account#accountCreateVerification) + /// the + /// [/account/verfication](https://appwrite.io/docs/references/cloud/client-web/account#createVerification) /// route to start verifying the user email address. To allow the new user to /// login to their new account, you need to create a new [account - /// session](/docs/client/account#accountCreateSession). + /// session](https://appwrite.io/docs/references/cloud/client-web/account#createEmailSession). /// /// @param String userId /// @param String email @@ -105,14 +106,15 @@ open class Account: Service { } /// - /// Create Account + /// Create account /// /// Use this endpoint to allow a new user to register a new account in your /// project. After the user registration completes successfully, you can use - /// the [/account/verfication](/docs/client/account#accountCreateVerification) + /// the + /// [/account/verfication](https://appwrite.io/docs/references/cloud/client-web/account#createVerification) /// route to start verifying the user email address. To allow the new user to /// login to their new account, you need to create a new [account - /// session](/docs/client/account#accountCreateSession). + /// session](https://appwrite.io/docs/references/cloud/client-web/account#createEmailSession). /// /// @param String userId /// @param String email @@ -137,7 +139,7 @@ open class Account: Service { } /// - /// Update Email + /// Update email /// /// Update currently logged in user account email address. After changing user /// address, the user confirmation status will get reset. A new confirmation @@ -183,7 +185,7 @@ open class Account: Service { } /// - /// Update Email + /// Update email /// /// Update currently logged in user account email address. After changing user /// address, the user confirmation status will get reset. A new confirmation @@ -309,7 +311,7 @@ open class Account: Service { } /// - /// List Logs + /// List logs /// /// Get the list of latest security activity logs for the currently logged in /// user. Each log returns user IP address, location and date and time of log. @@ -345,7 +347,7 @@ open class Account: Service { } /// - /// Update Name + /// Update name /// /// Update currently logged in user account name. /// @@ -381,7 +383,7 @@ open class Account: Service { } /// - /// Update Name + /// Update name /// /// Update currently logged in user account name. /// @@ -399,7 +401,7 @@ open class Account: Service { } /// - /// Update Password + /// Update password /// /// Update currently logged in user password. For validation, user is required /// to pass in the new password, and the old password. For users created with @@ -440,7 +442,7 @@ open class Account: Service { } /// - /// Update Password + /// Update password /// /// Update currently logged in user password. For validation, user is required /// to pass in the new password, and the old password. For users created with @@ -463,12 +465,12 @@ open class Account: Service { } /// - /// Update Phone + /// Update phone /// /// Update the currently logged in user's phone number. After updating the /// phone number, the phone verification status will be reset. A confirmation /// SMS is not sent automatically, however you can use the [POST - /// /account/verification/phone](/docs/client/account#accountCreatePhoneVerification) + /// /account/verification/phone](https://appwrite.io/docs/references/cloud/client-web/account#createPhoneVerification) /// endpoint to send a confirmation SMS. /// /// @param String phone @@ -506,12 +508,12 @@ open class Account: Service { } /// - /// Update Phone + /// Update phone /// /// Update the currently logged in user's phone number. After updating the /// phone number, the phone verification status will be reset. A confirmation /// SMS is not sent automatically, however you can use the [POST - /// /account/verification/phone](/docs/client/account#accountCreatePhoneVerification) + /// /account/verification/phone](https://appwrite.io/docs/references/cloud/client-web/account#createPhoneVerification) /// endpoint to send a confirmation SMS. /// /// @param String phone @@ -531,7 +533,7 @@ open class Account: Service { } /// - /// Get Account Preferences + /// Get account preferences /// /// Get the preferences as a key-value object for the currently logged in user. /// @@ -563,7 +565,7 @@ open class Account: Service { } /// - /// Get Account Preferences + /// Get account preferences /// /// Get the preferences as a key-value object for the currently logged in user. /// @@ -578,7 +580,7 @@ open class Account: Service { } /// - /// Update Preferences + /// Update preferences /// /// Update currently logged in user account preferences. The object you pass is /// stored as is, and replaces any previous value. The maximum allowed prefs @@ -616,7 +618,7 @@ open class Account: Service { } /// - /// Update Preferences + /// Update preferences /// /// Update currently logged in user account preferences. The object you pass is /// stored as is, and replaces any previous value. The maximum allowed prefs @@ -636,16 +638,16 @@ open class Account: Service { } /// - /// Create Password Recovery + /// Create password recovery /// /// Sends the user an email with a temporary secret key for password reset. /// When the user clicks the confirmation link he is redirected back to your /// app password reset URL with the secret key and email address values /// attached to the URL query string. Use the query string params to submit a /// request to the [PUT - /// /account/recovery](/docs/client/account#accountUpdateRecovery) endpoint to - /// complete the process. The verification link sent to the user's email - /// address is valid for 1 hour. + /// /account/recovery](https://appwrite.io/docs/references/cloud/client-web/account#updateRecovery) + /// endpoint to complete the process. The verification link sent to the user's + /// email address is valid for 1 hour. /// /// @param String email /// @param String url @@ -681,12 +683,13 @@ open class Account: Service { } /// - /// Create Password Recovery (confirmation) + /// Create password recovery (confirmation) /// /// Use this endpoint to complete the user account password reset. Both the /// **userId** and **secret** arguments will be passed as query parameters to /// the redirect URL you have provided when sending your request to the [POST - /// /account/recovery](/docs/client/account#accountCreateRecovery) endpoint. + /// /account/recovery](https://appwrite.io/docs/references/cloud/client-web/account#createRecovery) + /// endpoint. /// /// 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) @@ -733,7 +736,7 @@ open class Account: Service { } /// - /// List Sessions + /// List sessions /// /// Get the list of active sessions across different devices for the currently /// logged in user. @@ -765,7 +768,7 @@ open class Account: Service { } /// - /// Delete Sessions + /// Delete sessions /// /// Delete all sessions from the user account and remove any sessions cookies /// from the end client. @@ -791,14 +794,15 @@ open class Account: Service { } /// - /// Create Anonymous Session + /// Create anonymous session /// /// Use this endpoint to allow a new user to register an anonymous account in /// your project. This route will also create a new session for the user. To /// allow the new user to convert an anonymous account to a normal account, you /// need to update its [email and - /// password](/docs/client/account#accountUpdateEmail) or create an [OAuth2 - /// session](/docs/client/account#accountCreateOAuth2Session). + /// password](https://appwrite.io/docs/references/cloud/client-web/account#updateEmail) + /// or create an [OAuth2 + /// session](https://appwrite.io/docs/references/cloud/client-web/account#CreateOAuth2Session). /// /// @throws Exception /// @return array @@ -827,13 +831,14 @@ open class Account: Service { } /// - /// Create Email Session + /// Create email session /// /// Allow the user to login into their account by providing a valid email and /// password combination. This route will create a new session for the user. /// /// A user is limited to 10 active sessions at a time by default. [Learn more - /// about session limits](/docs/authentication-security#limits). + /// about session + /// limits](https://appwrite.io/docs/authentication-security#limits). /// /// @param String email /// @param String password @@ -869,7 +874,7 @@ open class Account: Service { } /// - /// Create Magic URL session + /// Create magic URL session /// /// Sends the user an email with a secret key for creating a session. If the /// provided user ID has not been registered, a new user will be created. When @@ -877,14 +882,15 @@ open class Account: Service { /// URL you provided with the secret key and userId values attached to the URL /// query string. Use the query string parameters to submit a request to the /// [PUT - /// /account/sessions/magic-url](/docs/client/account#accountUpdateMagicURLSession) + /// /account/sessions/magic-url](https://appwrite.io/docs/references/cloud/client-web/account#updateMagicURLSession) /// endpoint to complete the login process. The link sent to the user's email /// address is valid for 1 hour. If you are on a mobile device you can leave /// the URL parameter empty, so that the login completion will be handled by /// your Appwrite instance by default. /// /// A user is limited to 10 active sessions at a time by default. [Learn more - /// about session limits](/docs/authentication-security#limits). + /// about session + /// limits](https://appwrite.io/docs/authentication-security#limits). /// /// /// @param String userId @@ -924,13 +930,13 @@ open class Account: Service { } /// - /// Create Magic URL session (confirmation) + /// Create magic URL session (confirmation) /// /// Use this endpoint to complete creating the session with the Magic URL. Both /// the **userId** and **secret** arguments will be passed as query parameters /// to the redirect URL you have provided when sending your request to the /// [POST - /// /account/sessions/magic-url](/docs/client/account#accountCreateMagicURLSession) + /// /account/sessions/magic-url](https://appwrite.io/docs/references/cloud/client-web/account#createMagicURLSession) /// endpoint. /// /// Please note that in order to avoid a [Redirect @@ -972,7 +978,7 @@ open class Account: Service { } /// - /// Create OAuth2 Session + /// Create OAuth2 session /// /// Allow the user to login to their account using the OAuth2 provider of their /// choice. Each OAuth2 provider should be enabled from the Appwrite console @@ -987,7 +993,8 @@ open class Account: Service { /// user. /// /// A user is limited to 10 active sessions at a time by default. [Learn more - /// about session limits](/docs/authentication-security#limits). + /// about session + /// limits](https://appwrite.io/docs/authentication-security#limits). /// /// /// @param String provider @@ -1029,17 +1036,18 @@ open class Account: Service { } /// - /// Create Phone session + /// Create phone session /// /// Sends the user an SMS with a secret key for creating a session. If the /// provided user ID has not be registered, a new user will be created. Use the /// returned user ID and secret and submit a request to the [PUT - /// /account/sessions/phone](/docs/client/account#accountUpdatePhoneSession) + /// /account/sessions/phone](https://appwrite.io/docs/references/cloud/client-web/account#updatePhoneSession) /// endpoint to complete the login process. The secret sent to the user's phone /// is valid for 15 minutes. /// /// A user is limited to 10 active sessions at a time by default. [Learn more - /// about session limits](/docs/authentication-security#limits). + /// about session + /// limits](https://appwrite.io/docs/authentication-security#limits). /// /// @param String userId /// @param String phone @@ -1075,11 +1083,11 @@ open class Account: Service { } /// - /// Create Phone Session (confirmation) + /// Create phone session (confirmation) /// /// Use this endpoint to complete creating a session with SMS. Use the /// **userId** from the - /// [createPhoneSession](/docs/client/account#accountCreatePhoneSession) + /// [createPhoneSession](https://appwrite.io/docs/references/cloud/client-web/account#createPhoneSession) /// endpoint and the **secret** received via SMS to successfully update and /// confirm the phone session. /// @@ -1117,7 +1125,7 @@ open class Account: Service { } /// - /// Get Session + /// Get session /// /// Use this endpoint to get a logged in user's session using a Session ID. /// Inputting 'current' will return the current session being used. @@ -1152,7 +1160,7 @@ open class Account: Service { } /// - /// Update OAuth Session (Refresh Tokens) + /// Update OAuth session (refresh tokens) /// /// Access tokens have limited lifespan and expire to mitigate security risks. /// If session was created using an OAuth provider, this route can be used to @@ -1188,12 +1196,13 @@ open class Account: Service { } /// - /// Delete Session + /// Delete session /// /// Logout the user. Use 'current' as the session ID to logout on this device, /// use a session ID to logout on another device. If you're looking to logout /// the user on all devices, use [Delete - /// Sessions](/docs/client/account#accountDeleteSessions) instead. + /// Sessions](https://appwrite.io/docs/references/cloud/client-web/account#deleteSessions) + /// instead. /// /// @param String sessionId /// @throws Exception @@ -1219,7 +1228,7 @@ open class Account: Service { } /// - /// Update Status + /// Update status /// /// Block the currently logged in user account. Behind the scene, the user /// record is not deleted but permanently blocked from any access. To @@ -1253,7 +1262,7 @@ open class Account: Service { } /// - /// Update Status + /// Update status /// /// Block the currently logged in user account. Behind the scene, the user /// record is not deleted but permanently blocked from any access. To @@ -1270,7 +1279,7 @@ open class Account: Service { } /// - /// Create Email Verification + /// Create email 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** @@ -1279,8 +1288,8 @@ open class Account: Service { /// should redirect the user back to 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/client/account#accountUpdateEmailVerification). The - /// verification link sent to the user's email address is valid for 7 days. + /// process](https://appwrite.io/docs/references/cloud/client-web/account#updateVerification). + /// The verification link sent to the user's email address is valid for 7 days. /// /// 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), @@ -1319,7 +1328,7 @@ open class Account: Service { } /// - /// Create Email Verification (confirmation) + /// Create email verification (confirmation) /// /// Use this endpoint to complete the user email verification process. Use both /// the **userId** and **secret** parameters that were attached to your app URL @@ -1360,14 +1369,16 @@ open class Account: Service { } /// - /// Create Phone Verification + /// Create phone verification /// /// Use this endpoint to send a verification SMS to the currently logged in /// user. This endpoint is meant for use after updating a user's phone number - /// using the [accountUpdatePhone](/docs/client/account#accountUpdatePhone) + /// using the + /// [accountUpdatePhone](https://appwrite.io/docs/references/cloud/client-web/account#updatePhone) /// endpoint. Learn more about how to [complete the verification - /// process](/docs/client/account#accountUpdatePhoneVerification). The - /// verification code sent to the user's phone number is valid for 15 minutes. + /// process](https://appwrite.io/docs/references/cloud/client-web/account#updatePhoneVerification). + /// The verification code sent to the user's phone number is valid for 15 + /// minutes. /// /// @throws Exception /// @return array @@ -1396,7 +1407,7 @@ open class Account: Service { } /// - /// Create Phone Verification (confirmation) + /// Create phone verification (confirmation) /// /// Use this endpoint to complete the user phone verification process. Use the /// **userId** and **secret** that were sent to your user's phone number to diff --git a/Sources/Appwrite/Services/Avatars.swift b/Sources/Appwrite/Services/Avatars.swift index ba87975..127eb3d 100644 --- a/Sources/Appwrite/Services/Avatars.swift +++ b/Sources/Appwrite/Services/Avatars.swift @@ -8,12 +8,13 @@ import AppwriteModels open class Avatars: Service { /// - /// Get Browser Icon + /// Get browser icon /// /// You can use this endpoint to show different browser icons to your users. /// The code argument receives the browser code as it appears in your user [GET - /// /account/sessions](/docs/client/account#accountGetSessions) endpoint. Use - /// width, height and quality arguments to change the output settings. + /// /account/sessions](https://appwrite.io/docs/references/cloud/client-web/account#getSessions) + /// endpoint. Use width, height and quality arguments to change the output + /// settings. /// /// When one dimension is specified and the other is 0, the image is scaled /// with preserved aspect ratio. If both dimensions are 0, the API provides an @@ -51,7 +52,7 @@ open class Avatars: Service { } /// - /// Get Credit Card Icon + /// Get credit card icon /// /// The credit card endpoint will return you the icon of the credit card /// provider you need. Use width, height and quality arguments to change the @@ -94,7 +95,7 @@ open class Avatars: Service { } /// - /// Get Favicon + /// Get favicon /// /// Use this endpoint to fetch the favorite icon (AKA favicon) of any remote /// website URL. @@ -122,12 +123,12 @@ open class Avatars: Service { } /// - /// Get Country Flag + /// Get country flag /// /// You can use this endpoint to show different country flags icons to your /// users. The code argument receives the 2 letter country code. Use width, /// height and quality arguments to change the output settings. Country codes - /// follow the [ISO 3166-1](http://en.wikipedia.org/wiki/ISO_3166-1) standard. + /// follow the [ISO 3166-1](https://en.wikipedia.org/wiki/ISO_3166-1) standard. /// /// When one dimension is specified and the other is 0, the image is scaled /// with preserved aspect ratio. If both dimensions are 0, the API provides an @@ -166,7 +167,7 @@ open class Avatars: Service { } /// - /// Get Image from URL + /// Get image from URL /// /// Use this endpoint to fetch a remote image URL and crop it to any image size /// you want. This endpoint is very useful if you need to crop and display @@ -207,7 +208,7 @@ open class Avatars: Service { } /// - /// Get User Initials + /// Get user initials /// /// Use this endpoint to show your user initials avatar icon on your website or /// app. By default, this route will try to print your logged-in user name or @@ -257,7 +258,7 @@ open class Avatars: Service { } /// - /// Get QR Code + /// Get QR code /// /// Converts a given plain text to a QR code image. You can use the query /// parameters to change the size and style of the resulting image. diff --git a/Sources/Appwrite/Services/Databases.swift b/Sources/Appwrite/Services/Databases.swift index 45d6105..0fcca79 100644 --- a/Sources/Appwrite/Services/Databases.swift +++ b/Sources/Appwrite/Services/Databases.swift @@ -8,7 +8,7 @@ import AppwriteModels open class Databases: Service { /// - /// List Documents + /// List documents /// /// Get a list of all the user's documents in a given collection. You can use /// the query params to filter your results. @@ -51,7 +51,7 @@ open class Databases: Service { } /// - /// List Documents + /// List documents /// /// Get a list of all the user's documents in a given collection. You can use /// the query params to filter your results. @@ -76,12 +76,12 @@ open class Databases: Service { } /// - /// Create Document + /// Create document /// /// Create a new Document. Before using this route, you should create a new /// collection resource using either a [server - /// integration](/docs/server/databases#databasesCreateCollection) API or - /// directly from your database console. + /// integration](https://appwrite.io/docs/server/databases#databasesCreateCollection) + /// API or directly from your database console. /// /// @param String databaseId /// @param String collectionId @@ -127,12 +127,12 @@ open class Databases: Service { } /// - /// Create Document + /// Create document /// /// Create a new Document. Before using this route, you should create a new /// collection resource using either a [server - /// integration](/docs/server/databases#databasesCreateCollection) API or - /// directly from your database console. + /// integration](https://appwrite.io/docs/server/databases#databasesCreateCollection) + /// API or directly from your database console. /// /// @param String databaseId /// @param String collectionId @@ -160,7 +160,7 @@ open class Databases: Service { } /// - /// Get Document + /// Get document /// /// Get a document by its unique ID. This endpoint response returns a JSON /// object with the document data. @@ -206,7 +206,7 @@ open class Databases: Service { } /// - /// Get Document + /// Get document /// /// Get a document by its unique ID. This endpoint response returns a JSON /// object with the document data. @@ -234,7 +234,7 @@ open class Databases: Service { } /// - /// Update Document + /// Update document /// /// Update a document by its unique ID. Using the patch method you can pass /// only specific fields that will get updated. @@ -283,7 +283,7 @@ open class Databases: Service { } /// - /// Update Document + /// Update document /// /// Update a document by its unique ID. Using the patch method you can pass /// only specific fields that will get updated. @@ -314,7 +314,7 @@ open class Databases: Service { } /// - /// Delete Document + /// Delete document /// /// Delete a document by its unique ID. /// diff --git a/Sources/Appwrite/Services/Functions.swift b/Sources/Appwrite/Services/Functions.swift index 82cc630..ad36e1d 100644 --- a/Sources/Appwrite/Services/Functions.swift +++ b/Sources/Appwrite/Services/Functions.swift @@ -8,7 +8,7 @@ import AppwriteModels open class Functions: Service { /// - /// List Executions + /// List executions /// /// Get a list of all the current user function execution logs. You can use the /// query params to filter your results. @@ -50,7 +50,7 @@ open class Functions: Service { } /// - /// Create Execution + /// Create execution /// /// Trigger a function execution. The returned object will return you the /// current execution status. You can ping the `Get Execution` endpoint to get @@ -103,7 +103,7 @@ open class Functions: Service { } /// - /// Get Execution + /// Get execution /// /// Get a function execution log by its unique ID. /// diff --git a/Sources/Appwrite/Services/Graphql.swift b/Sources/Appwrite/Services/Graphql.swift index 0b78e1a..4c89389 100644 --- a/Sources/Appwrite/Services/Graphql.swift +++ b/Sources/Appwrite/Services/Graphql.swift @@ -8,7 +8,7 @@ import AppwriteModels open class Graphql: Service { /// - /// GraphQL Endpoint + /// GraphQL endpoint /// /// Execute a GraphQL mutation. /// @@ -44,7 +44,7 @@ open class Graphql: Service { } /// - /// GraphQL Endpoint + /// GraphQL endpoint /// /// Execute a GraphQL mutation. /// diff --git a/Sources/Appwrite/Services/Locale.swift b/Sources/Appwrite/Services/Locale.swift index 716acb9..a64f8b3 100644 --- a/Sources/Appwrite/Services/Locale.swift +++ b/Sources/Appwrite/Services/Locale.swift @@ -8,7 +8,7 @@ import AppwriteModels open class Locale: Service { /// - /// Get User Locale + /// Get user locale /// /// Get the current user location based on IP. Returns an object with user /// country code, country name, continent name, continent code, ip address and @@ -76,7 +76,7 @@ open class Locale: Service { } /// - /// List Continents + /// List continents /// /// List of all continents. You can use the locale header to get the data in a /// supported language. @@ -108,7 +108,7 @@ open class Locale: Service { } /// - /// List Countries + /// List countries /// /// List of all countries. You can use the locale header to get the data in a /// supported language. @@ -140,7 +140,7 @@ open class Locale: Service { } /// - /// List EU Countries + /// List EU countries /// /// List of all countries that are currently members of the EU. You can use the /// locale header to get the data in a supported language. @@ -172,7 +172,7 @@ open class Locale: Service { } /// - /// List Countries Phone Codes + /// List countries phone codes /// /// List of all countries phone codes. You can use the locale header to get the /// data in a supported language. @@ -204,7 +204,7 @@ open class Locale: Service { } /// - /// List Currencies + /// List currencies /// /// List of all currencies, including currency symbol, name, plural, and /// decimal digits for all major and minor currencies. You can use the locale @@ -237,7 +237,7 @@ open class Locale: Service { } /// - /// List Languages + /// List languages /// /// List of all languages classified by ISO 639-1 including 2-letter code, name /// in English, and name in the respective language. diff --git a/Sources/Appwrite/Services/Storage.swift b/Sources/Appwrite/Services/Storage.swift index 36054a2..5acea34 100644 --- a/Sources/Appwrite/Services/Storage.swift +++ b/Sources/Appwrite/Services/Storage.swift @@ -8,7 +8,7 @@ import AppwriteModels open class Storage: Service { /// - /// List Files + /// List files /// /// Get a list of all the user files. You can use the query params to filter /// your results. @@ -50,12 +50,12 @@ open class Storage: Service { } /// - /// Create File + /// Create file /// /// Create a new file. Before using this route, you should create a new bucket /// resource using either a [server - /// integration](/docs/server/storage#storageCreateBucket) API or directly from - /// your Appwrite console. + /// integration](https://appwrite.io/docs/server/storage#storageCreateBucket) + /// API or directly from your Appwrite console. /// /// Larger files should be uploaded using multiple requests with the /// [content-range](https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/Content-Range) @@ -116,7 +116,7 @@ open class Storage: Service { } /// - /// Get File + /// Get file /// /// Get a file by its unique ID. This endpoint response returns a JSON object /// with the file metadata. @@ -154,7 +154,7 @@ open class Storage: Service { } /// - /// Update File + /// Update file /// /// Update a file by its unique ID. Only users with write permissions have /// access to update this resource. @@ -231,7 +231,7 @@ open class Storage: Service { } /// - /// Get File for Download + /// Get file for download /// /// Get a file content by its unique ID. The endpoint response return with a /// 'Content-Disposition: attachment' header that tells the browser to start @@ -260,7 +260,7 @@ open class Storage: Service { } /// - /// Get File Preview + /// Get file preview /// /// Get a file preview image. Currently, this method supports preview for image /// files (jpg, png, and gif), other supported formats, like pdf, docs, slides, @@ -326,7 +326,7 @@ open class Storage: Service { } /// - /// Get File for View + /// Get file for view /// /// Get a file content by its unique ID. This endpoint is similar to the /// download method but returns with no 'Content-Disposition: attachment' diff --git a/Sources/Appwrite/Services/Teams.swift b/Sources/Appwrite/Services/Teams.swift index 2b41859..7d783e2 100644 --- a/Sources/Appwrite/Services/Teams.swift +++ b/Sources/Appwrite/Services/Teams.swift @@ -8,7 +8,7 @@ import AppwriteModels open class Teams: Service { /// - /// List Teams + /// List teams /// /// Get a list of all the teams in which the current user is a member. You can /// use the parameters to filter your results. @@ -48,7 +48,7 @@ open class Teams: Service { } /// - /// List Teams + /// List teams /// /// Get a list of all the teams in which the current user is a member. You can /// use the parameters to filter your results. @@ -70,7 +70,7 @@ open class Teams: Service { } /// - /// Create Team + /// Create team /// /// Create a new team. The user who creates the team will automatically be /// assigned as the owner of the team. Only the users with the owner role can @@ -114,7 +114,7 @@ open class Teams: Service { } /// - /// Create Team + /// Create team /// /// Create a new team. The user who creates the team will automatically be /// assigned as the owner of the team. Only the users with the owner role can @@ -140,7 +140,7 @@ open class Teams: Service { } /// - /// Get Team + /// Get team /// /// Get a team by its ID. All team members have read access for this resource. /// @@ -175,7 +175,7 @@ open class Teams: Service { } /// - /// Get Team + /// Get team /// /// Get a team by its ID. All team members have read access for this resource. /// @@ -193,7 +193,7 @@ open class Teams: Service { } /// - /// Update Name + /// Update name /// /// Update the team's name by its unique ID. /// @@ -232,7 +232,7 @@ open class Teams: Service { } /// - /// Update Name + /// Update name /// /// Update the team's name by its unique ID. /// @@ -253,7 +253,7 @@ open class Teams: Service { } /// - /// Delete Team + /// Delete team /// /// Delete a team using its ID. Only team members with the owner role can /// delete the team. @@ -282,7 +282,7 @@ open class Teams: Service { } /// - /// List Team Memberships + /// List team memberships /// /// Use this endpoint to list a team's members using the team's ID. All team /// members have read access to this endpoint. @@ -324,7 +324,7 @@ open class Teams: Service { } /// - /// Create Team Membership + /// Create team membership /// /// Invite a new member to join your team. Provide an ID for existing users, or /// invite unregistered users using an email or phone number. If initiated from @@ -339,8 +339,8 @@ open class Teams: Service { /// /// Use the `url` parameter to redirect the user from the invitation email to /// your app. After the user is redirected, use the [Update Team Membership - /// Status](/docs/client/teams#teamsUpdateMembershipStatus) endpoint to allow - /// the user to accept the invitation to the team. + /// Status](https://appwrite.io/docs/references/cloud/client-web/teams#updateMembershipStatus) + /// endpoint to allow the user to accept the invitation to the team. /// /// Please note that to avoid a [Redirect /// Attack](https://github.com/OWASP/CheatSheetSeries/blob/master/cheatsheets/Unvalidated_Redirects_and_Forwards_Cheat_Sheet.md) @@ -397,7 +397,7 @@ open class Teams: Service { } /// - /// Get Team Membership + /// Get team membership /// /// Get a team member by the membership unique id. All team members have read /// access for this resource. @@ -435,11 +435,11 @@ open class Teams: Service { } /// - /// Update Membership + /// Update membership /// /// Modify the roles of a team member. Only team members with the owner role /// have access to this endpoint. Learn more about [roles and - /// permissions](/docs/permissions). + /// permissions](https://appwrite.io/docs/permissions). /// /// /// @param String teamId @@ -479,7 +479,7 @@ open class Teams: Service { } /// - /// Delete Team Membership + /// Delete team membership /// /// This endpoint allows a user to leave a team or for a team owner to delete /// the membership of any other team member. You can also use this endpoint to @@ -512,7 +512,7 @@ open class Teams: Service { } /// - /// Update Team Membership Status + /// Update team membership status /// /// Use this endpoint to allow a user to accept an invitation to join a team /// after being redirected back to your app from the invitation email received @@ -562,11 +562,11 @@ open class Teams: Service { } /// - /// Get Team Preferences + /// Get team preferences /// /// Get the team's shared preferences by its unique ID. If a preference doesn't /// need to be shared by all team members, prefer storing them in [user - /// preferences](/docs/client/account#accountGetPrefs). + /// preferences](https://appwrite.io/docs/references/cloud/client-web/account#getPrefs). /// /// @param String teamId /// @throws Exception @@ -599,11 +599,11 @@ open class Teams: Service { } /// - /// Get Team Preferences + /// Get team preferences /// /// Get the team's shared preferences by its unique ID. If a preference doesn't /// need to be shared by all team members, prefer storing them in [user - /// preferences](/docs/client/account#accountGetPrefs). + /// preferences](https://appwrite.io/docs/references/cloud/client-web/account#getPrefs). /// /// @param String teamId /// @throws Exception @@ -619,7 +619,7 @@ open class Teams: Service { } /// - /// Update Preferences + /// Update preferences /// /// Update the team's preferences by its unique ID. The object you pass is /// stored as is and replaces any previous value. The maximum allowed prefs @@ -660,7 +660,7 @@ open class Teams: Service { } /// - /// Update Preferences + /// Update preferences /// /// Update the team's preferences by its unique ID. The object you pass is /// stored as is and replaces any previous value. The maximum allowed prefs diff --git a/Sources/AppwriteModels/Document.swift b/Sources/AppwriteModels/Document.swift index 462091c..94069f9 100644 --- a/Sources/AppwriteModels/Document.swift +++ b/Sources/AppwriteModels/Document.swift @@ -19,7 +19,7 @@ public class Document { /// Document update date in ISO 8601 format. public let updatedAt: String - /// Document permissions. [Learn more about permissions](/docs/permissions). + /// Document permissions. [Learn more about permissions](https://appwrite.io/docs/permissions). public let permissions: [Any] /// Additional properties diff --git a/Sources/AppwriteModels/File.swift b/Sources/AppwriteModels/File.swift index 3555f23..04a5b89 100644 --- a/Sources/AppwriteModels/File.swift +++ b/Sources/AppwriteModels/File.swift @@ -16,7 +16,7 @@ public class File { /// File update date in ISO 8601 format. public let updatedAt: String - /// File permissions. [Learn more about permissions](/docs/permissions). + /// File permissions. [Learn more about permissions](https://appwrite.io/docs/permissions). public let permissions: [Any] /// File name.