You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@camel.apache.org by da...@apache.org on 2020/09/17 13:01:09 UTC
[camel] 04/04: CAMEL-15478: Docs include method table
This is an automated email from the ASF dual-hosted git repository.
davsclaus pushed a commit to branch api
in repository https://gitbox.apache.org/repos/asf/camel.git
commit 378b199d54c5bef73e370d68db6f01366e5407ba
Author: Claus Ibsen <cl...@gmail.com>
AuthorDate: Thu Sep 17 15:00:33 2020 +0200
CAMEL-15478: Docs include method table
---
.../src/main/docs/as2-component.adoc | 59 +-
.../camel/component/box/api/BoxFilesManager.java | 19 +-
.../box/BoxFilesManagerEndpointConfiguration.java | 4 +-
.../org/apache/camel/component/box/box.json | 4 +-
.../src/main/docs/box-component.adoc | 320 ++-
.../src/main/docs/braintree-component.adoc | 631 ++++-
.../src/main/docs/fhir-component.adoc | 501 +++-
.../src/main/docs/google-calendar-component.adoc | 312 ++-
.../docs/google-calendar-stream-component.adoc | 312 ++-
.../src/main/docs/google-drive-component.adoc | 530 +++-
.../src/main/docs/google-mail-component.adoc | 330 ++-
.../main/docs/google-mail-stream-component.adoc | 330 ++-
.../src/main/docs/google-sheets-component.adoc | 107 +-
.../main/docs/google-sheets-stream-component.adoc | 107 +-
.../src/main/docs/olingo2-component.adoc | 58 +-
.../src/main/docs/olingo4-component.adoc | 62 +-
.../src/main/docs/twilio-component.adoc | 2552 +++++++++++++++-----
.../src/main/docs/zendesk-component.adoc | 1177 ++++++---
18 files changed, 5816 insertions(+), 1599 deletions(-)
diff --git a/components/camel-as2/camel-as2-component/src/main/docs/as2-component.adoc b/components/camel-as2/camel-as2-component/src/main/docs/as2-component.adoc
index f46a51c..1b845c5 100644
--- a/components/camel-as2/camel-as2-component/src/main/docs/as2-component.adoc
+++ b/components/camel-as2/camel-as2-component/src/main/docs/as2-component.adoc
@@ -159,18 +159,35 @@ The following lists each API name and method and its additional parameters.
==== client
-The client has 1 API method(s) which is represented by the following method signatures
+The client API has 1 method(s) which is represented by the following method signatures
(an API method may have multiple signatures due to overloading):
+[source,java]
----
-org.apache.http.protocol.HttpCoreContext send(String ediMessage, String requestUri, String subject, String from, String as2From, String as2To, org.apache.camel.component.as2.api.AS2MessageStructure as2MessageStructure, org.apache.http.entity.ContentType ediMessageContentType, String ediMessageTransferEncoding, org.apache.camel.component.as2.api.AS2SignatureAlgorithm signingAlgorithm, java.security.cert.Certificate[] signingCertificateChain, java.security.PrivateKey signingPrivateKey, org [...]
+org.apache.http.protocol.HttpCoreContext send(String ediMessage, String requestUri, String subject, String from, String as2From, String as2To, org.apache.camel.component.as2.api.AS2MessageStructure as2MessageStructure, org.apache.http.entity.ContentType ediMessageContentType, String ediMessageTransferEncoding, org.apache.camel.component.as2.api.AS2SignatureAlgorithm signingAlgorithm, java.security.cert.Certificate[] signingCertificateChain, java.security.PrivateKey signingPrivateKey, org [...]
+
+----
+
+The client API is defined in the syntax as follows:
+
+----
+as2:client/methodName?[parameters]
----
-The API methods has the following set of options listed in the following table:
-[width="100%",cols="1,2,5,2",options="header"]
+The 1 method(s) is listed in the table below.
+(API methods can have a shorthand alias name which can be used in the syntax instead of the name)
+
+[width="100%",cols="2,2,6",options="header"]
+|===
+| Method | Alias | Description
+| *send* | | Send ediMessage to trading partner
|===
-| Method | Name | Description | Type
+
+The client API method(s) has the following set of parameters listed in the table below:
+[width="100%",cols="2,2,4,2",options="header"]
+|===
+| Method | Parameter | Description | Type
| send | *as2From* | AS2 name of sender | String
| send | *as2MessageStructure* | The structure of AS2 to send; see AS2MessageStructure | AS2MessageStructure
| send | *as2To* | AS2 name of recipient | String
@@ -190,26 +207,48 @@ The API methods has the following set of options listed in the following table:
| send | *subject* | Message subject | String
|===
+In addition to the parameters above, the client API can also use from the 49 endpoint query option
+which is listed in the _Query Parameters_ section.
==== server
-The server has 1 API method(s) which is represented by the following method signatures
+The server API has 1 method(s) which is represented by the following method signatures
(an API method may have multiple signatures due to overloading):
+[source,java]
----
-void listen(String requestUriPattern, org.apache.http.protocol.HttpRequestHandler handler)
+
+void listen(String requestUriPattern, org.apache.http.protocol.HttpRequestHandler handler);
----
-The API methods has the following set of options listed in the following table:
-[width="100%",cols="1,2,5,2",options="header"]
+The server API is defined in the syntax as follows:
+
+----
+as2:server/methodName?[parameters]
+----
+
+The 1 method(s) is listed in the table below.
+(API methods can have a shorthand alias name which can be used in the syntax instead of the name)
+
+[width="100%",cols="2,2,6",options="header"]
|===
-| Method | Name | Description | Type
+| Method | Alias | Description
+| *listen* | |
+|===
+
+The server API method(s) has the following set of parameters listed in the table below:
+[width="100%",cols="2,2,4,2",options="header"]
+|===
+| Method | Parameter | Description | Type
| listen | *requestUriPattern* | | String
|===
+
+In addition to the parameters above, the server API can also use from the 49 endpoint query option
+which is listed in the _Query Parameters_ section.
// endpoint options: END
diff --git a/components/camel-box/camel-box-api/src/main/java/org/apache/camel/component/box/api/BoxFilesManager.java b/components/camel-box/camel-box-api/src/main/java/org/apache/camel/component/box/api/BoxFilesManager.java
index 756d509..ece5280 100644
--- a/components/camel-box/camel-box-api/src/main/java/org/apache/camel/component/box/api/BoxFilesManager.java
+++ b/components/camel-box/camel-box-api/src/main/java/org/apache/camel/component/box/api/BoxFilesManager.java
@@ -624,16 +624,17 @@ public class BoxFilesManager {
}
/**
- * Get an expiring URL for creating an embedded preview session. The URL will expire after 60 seconds and the
- * preview session will expire after 60 minutes.
+ * Retrieves a thumbnail, or smaller image representation, of this file. Sizes of 32x32, 64x64, 128x128, and 256x256
+ * can be returned in the .png format and sizes of 32x32, 94x94, 160x160, and 320x320 can be returned in the .jpg
+ * format.
*
- * @param fileId - the id of the file to get preview link on.
- * @param fileType - either PNG of JPG.
- * @param minWidth - minimum width.
- * @param minHeight - minimum height.
- * @param maxWidth - maximum width.
- * @param maxHeight - maximum height.
- * @return The byte array of the thumbnail image.
+ * @param fileId - the id of the file to get thumbnail.
+ * @param fileType either PNG of JPG
+ * @param minWidth minimum width
+ * @param minHeight minimum height
+ * @param maxWidth maximum width
+ * @param maxHeight maximum height
+ * @return the byte array of the thumbnail image
*/
public byte[] getFileThumbnail(
String fileId, BoxFile.ThumbnailFileType fileType, Integer minWidth,
diff --git a/components/camel-box/camel-box-component/src/generated/java/org/apache/camel/component/box/BoxFilesManagerEndpointConfiguration.java b/components/camel-box/camel-box-component/src/generated/java/org/apache/camel/component/box/BoxFilesManagerEndpointConfiguration.java
index c8cf48b..63ea1c4 100644
--- a/components/camel-box/camel-box-component/src/generated/java/org/apache/camel/component/box/BoxFilesManagerEndpointConfiguration.java
+++ b/components/camel-box/camel-box-component/src/generated/java/org/apache/camel/component/box/BoxFilesManagerEndpointConfiguration.java
@@ -15,7 +15,7 @@ import org.apache.camel.spi.UriParams;
* Camel endpoint configuration for {@link org.apache.camel.component.box.api.BoxFilesManager}.
*/
@ApiParams(apiName = "files", description = "Provides operations to manage Box files",
- apiMethods = {@ApiMethod(methodName = "checkUpload", description="Does a pre-verification before upload, to check if the filename already exists or if there is permission to upload", signatures={"void checkUpload(String fileName, String parentFolderId, Long size)"}), @ApiMethod(methodName = "copyFile", description="Copy file to destination folder while optionally giving it a new name", signatures={"com.box.sdk.BoxFile copyFile(String fileId, String destinationFolderId, String [...]
+ apiMethods = {@ApiMethod(methodName = "checkUpload", description="Does a pre-verification before upload, to check if the filename already exists or if there is permission to upload", signatures={"void checkUpload(String fileName, String parentFolderId, Long size)"}), @ApiMethod(methodName = "copyFile", description="Copy file to destination folder while optionally giving it a new name", signatures={"com.box.sdk.BoxFile copyFile(String fileId, String destinationFolderId, String [...]
@UriParams
@Configurer
public final class BoxFilesManagerEndpointConfiguration extends BoxConfiguration {
@@ -41,7 +41,7 @@ public final class BoxFilesManagerEndpointConfiguration extends BoxConfiguration
@ApiParam(apiMethods = {@ApiMethod(methodName = "uploadNewFileVersion", description="A stream containing contents of the file to upload")})
private java.io.InputStream fileContent;
@UriParam
- @ApiParam(apiMethods = {@ApiMethod(methodName = "copyFile", description="The id of file to copy"), @ApiMethod(methodName = "createFileMetadata", description="The id of the file to create metadata for"), @ApiMethod(methodName = "createFileSharedLink", description="The id of the file to create shared link on"), @ApiMethod(methodName = "deleteFile", description="The id of file to delete"), @ApiMethod(methodName = "deleteFileMetadata", description="The id of file to delete"), @ApiMethod( [...]
+ @ApiParam(apiMethods = {@ApiMethod(methodName = "copyFile", description="The id of file to copy"), @ApiMethod(methodName = "createFileMetadata", description="The id of the file to create metadata for"), @ApiMethod(methodName = "createFileSharedLink", description="The id of the file to create shared link on"), @ApiMethod(methodName = "deleteFile", description="The id of file to delete"), @ApiMethod(methodName = "deleteFileMetadata", description="The id of file to delete"), @ApiMethod( [...]
private String fileId;
@UriParam
@ApiParam(apiMethods = {@ApiMethod(methodName = "checkUpload", description="The name to give the uploaded file"), @ApiMethod(methodName = "uploadFile", description="The name to give the uploaded file")})
diff --git a/components/camel-box/camel-box-component/src/generated/resources/org/apache/camel/component/box/box.json b/components/camel-box/camel-box-component/src/generated/resources/org/apache/camel/component/box/box.json
index ac4a4e3..0073e72 100644
--- a/components/camel-box/camel-box-component/src/generated/resources/org/apache/camel/component/box/box.json
+++ b/components/camel-box/camel-box-component/src/generated/resources/org/apache/camel/component/box/box.json
@@ -86,7 +86,7 @@
"userPassword": { "kind": "parameter", "displayName": "User Password", "group": "security", "label": "security", "required": false, "type": "string", "javaType": "java.lang.String", "deprecated": false, "secret": true, "configurationClass": "org.apache.camel.component.box.BoxConfiguration", "configurationField": "configuration", "description": "Box user password, MUST be provided if authSecureStorage is not set, or returns null on first call" }
},
"apis": {
- "files": { "aliases": [ "uploadFile=upload", "downloadFile=download", "copyFile=copy", "moveFile=move", "renameFile=rename", "createFileSharedLink=link", "deleteFile=delete", "uploadNewFileVersion=uploadVersion", "promoteFileVersion=promoteVersion", "getFileVersions=versions", "downloadPreviousFileVersion=downloadVersion", "deleteFileVersion=deleteVersion", "getFileInfo=info", "updateFileInfo=updateInfo", "createFileMetadata=createMetadata", "getFileMetadata=metadata", "updateFileMet [...]
+ "files": { "aliases": [ "uploadFile=upload", "downloadFile=download", "copyFile=copy", "moveFile=move", "renameFile=rename", "createFileSharedLink=link", "deleteFile=delete", "uploadNewFileVersion=uploadVersion", "promoteFileVersion=promoteVersion", "getFileVersions=versions", "downloadPreviousFileVersion=downloadVersion", "deleteFileVersion=deleteVersion", "getFileInfo=info", "updateFileInfo=updateInfo", "createFileMetadata=createMetadata", "getFileMetadata=metadata", "updateFileMet [...]
"search": { "aliases": [ "searchFolder=search" ], "methods": { "searchFolder": { "description": "Search folder and all descendant folders using the given query", "signatures": [ "java.util.Collection<com.box.sdk.BoxItem> searchFolder(String folderId, String query)" ] } } },
"comments": { "aliases": [ "addFileComment=add", "changeCommentMessage=updateMessage", "deleteComment=delete", "getCommentInfo=info", "getFileComments=comments", "replyToComment=reply" ], "methods": { "addFileComment": { "description": "Add comment to file", "signatures": [ "com.box.sdk.BoxFile addFileComment(String fileId, String message)" ] }, "changeCommentMessage": { "description": "Change comment message", "signatures": [ "com.box.sdk.BoxComment changeCommentMessage(String comme [...]
"event-logs": { "aliases": [ "getEnterpriseEvents=events" ], "methods": { "getEnterpriseEvents": { "description": "Create an event stream with optional starting initial position and add listener that will be notified when an event is received", "signatures": [ "java.util.List<com.box.sdk.BoxEvent> getEnterpriseEvents(String position, java.util.Date after, java.util.Date before, com.box.sdk.BoxEvent$Type[] types)" ] } } },
@@ -98,7 +98,7 @@
"folders": { "aliases": [ "getRootFolder=root", "createFolder=create", "copyFolder=copy", "moveFolder=move", "renameFolder=rename", "createFolderSharedLink=link", "deleteFolder=delete", "getFolder=folder", "getFolderInfo=info", "getFolderItems=items", "updateFolderInfo=updateInfo" ], "methods": { "copyFolder": { "description": "Copy folder to destination folder while optionally giving it a new name", "signatures": [ "com.box.sdk.BoxFolder copyFolder(String folderId, String destinatio [...]
},
"apiProperties": {
- "files": { "methods": { "checkUpload": { "properties": { "fileName": { "kind": "parameter", "displayName": "File Name", "group": "common", "label": "", "required": false, "type": "string", "javaType": "java.lang.String", "deprecated": false, "secret": false, "description": "The name to give the uploaded file" }, "parentFolderId": { "kind": "parameter", "displayName": "Parent Folder Id", "group": "common", "label": "", "required": false, "type": "string", "javaType": "java.lang.String [...]
+ "files": { "methods": { "checkUpload": { "properties": { "fileName": { "kind": "parameter", "displayName": "File Name", "group": "common", "label": "", "required": false, "type": "string", "javaType": "java.lang.String", "deprecated": false, "secret": false, "description": "The name to give the uploaded file" }, "parentFolderId": { "kind": "parameter", "displayName": "Parent Folder Id", "group": "common", "label": "", "required": false, "type": "string", "javaType": "java.lang.String [...]
"search": { "methods": { "searchFolder": { "properties": { "folderId": { "kind": "parameter", "displayName": "Folder Id", "group": "common", "label": "", "required": false, "type": "string", "javaType": "java.lang.String", "deprecated": false, "secret": false, "description": "The id of folder searched" }, "query": { "kind": "parameter", "displayName": "Query", "group": "common", "label": "", "required": false, "type": "string", "javaType": "java.lang.String", "deprecated": false, "se [...]
"comments": { "methods": { "addFileComment": { "properties": { "fileId": { "kind": "parameter", "displayName": "File Id", "group": "common", "label": "", "required": false, "type": "string", "javaType": "java.lang.String", "deprecated": false, "secret": false, "description": "The id of file" }, "message": { "kind": "parameter", "displayName": "Message", "group": "common", "label": "", "required": false, "type": "string", "javaType": "java.lang.String", "deprecated": false, "secret": [...]
"event-logs": { "methods": { "getEnterpriseEvents": { "properties": { "after": { "kind": "parameter", "displayName": "After", "group": "common", "label": "", "required": false, "type": "string", "javaType": "java.util.Date", "deprecated": false, "secret": false, "description": "The lower bound on the timestamp of the events returned" }, "before": { "kind": "parameter", "displayName": "Before", "group": "common", "label": "", "required": false, "type": "string", "javaType": "java.util [...]
diff --git a/components/camel-box/camel-box-component/src/main/docs/box-component.adoc b/components/camel-box/camel-box-component/src/main/docs/box-component.adoc
index b84e07d..9cdd134 100644
--- a/components/camel-box/camel-box-component/src/main/docs/box-component.adoc
+++ b/components/camel-box/camel-box-component/src/main/docs/box-component.adoc
@@ -169,7 +169,7 @@ The following lists each API name and method and its additional parameters.
==== files
-The files has 22 API method(s) which is represented by the following method signatures
+The files API has 22 method(s) which is represented by the following method signatures
(an API method may have multiple signatures due to overloading):
[source,java]
@@ -221,10 +221,46 @@ com.box.sdk.BoxFile uploadNewFileVersion(String fileId, java.io.InputStream file
----
-The API methods has the following set of options listed in the following table:
-[width="100%",cols="1,2,5,2",options="header"]
-|===
-| Method | Name | Description | Type
+The files API is defined in the syntax as follows:
+
+----
+box:files/methodName?[parameters]
+----
+
+The 22 method(s) is listed in the table below.
+(API methods can have a shorthand alias name which can be used in the syntax instead of the name)
+
+[width="100%",cols="2,2,6",options="header"]
+|===
+| Method | Alias | Description
+| *checkUpload* | canUpload | Does a pre-verification before upload, to check if the filename already exists or if there is permission to upload
+| *copyFile* | copy | Copy file to destination folder while optionally giving it a new name
+| *createFileMetadata* | createMetadata | Create metadata for file in either the global properties template or the specified template type
+| *createFileSharedLink* | link | Create a shared link to file
+| *deleteFile* | delete | Delete the file
+| *deleteFileMetadata* | deleteMetadata | Delete the file properties metadata
+| *deleteFileVersion* | deleteVersion | Delete a file version
+| *downloadFile* | download | Download a file
+| *downloadPreviousFileVersion* | downloadVersion | Download a previous version of file
+| *getDownloadURL* | url | Get an expiring URL for downloading a file directly from Box
+| *getFileInfo* | info | Get file information
+| *getFileMetadata* | metadata | Gets the file properties metadata
+| *getFilePreviewLink* | | Get an expiring URL for creating an embedded preview session
+| *getFileThumbnail* | thumbnail | Retrieves a thumbnail, or smaller image representation, of this file
+| *getFileVersions* | versions | Get any previous versions of file
+| *moveFile* | move | Move file to destination folder while optionally giving it a new name
+| *promoteFileVersion* | promoteVersion | Promote a previous version of file
+| *renameFile* | rename | Rename file giving it the name newName
+| *updateFileInfo* | updateInfo | Update file information
+| *updateFileMetadata* | updateMetadata | Update the file properties metadata
+| *uploadFile* | upload | Upload a new file to parent folder
+| *uploadNewFileVersion* | uploadVersion | Upload a new version of file
+|===
+
+The files API method(s) has the following set of parameters listed in the table below:
+[width="100%",cols="2,2,4,2",options="header"]
+|===
+| Method | Parameter | Description | Type
| checkUpload | *fileName* | The name to give the uploaded file | String
| checkUpload | *parentFolderId* | The id of parent folder | String
| checkUpload | *size* | The size of the file's content used for monitoring the upload's progress | Long
@@ -257,7 +293,7 @@ The API methods has the following set of options listed in the following table:
| getFileMetadata | *fileId* | The id of the file to retrieve metadata for | String
| getFileMetadata | *typeName* | The metadata template type name; if null the global properties template type is used. | String
| getFilePreviewLink | *fileId* | The id of the file to get preview link on | String
-| getFileThumbnail | *fileId* | The id of the file to get preview link on | String
+| getFileThumbnail | *fileId* | The id of the file to get thumbnail | String
| getFileThumbnail | *fileType* | Either PNG of JPG | ThumbnailFileType
| getFileThumbnail | *maxHeight* | Maximum height | Integer
| getFileThumbnail | *maxWidth* | Maximum width | Integer
@@ -290,13 +326,15 @@ The API methods has the following set of options listed in the following table:
| uploadNewFileVersion | *modified* | The content modified date that will be given to the uploaded file | Date
|===
+In addition to the parameters above, the files API can also use from the 38 endpoint query option
+which is listed in the _Query Parameters_ section.
==== search
-The search has 1 API method(s) which is represented by the following method signatures
+The search API has 1 method(s) which is represented by the following method signatures
(an API method may have multiple signatures due to overloading):
[source,java]
@@ -306,21 +344,38 @@ java.util.Collection<com.box.sdk.BoxItem> searchFolder(String folderId, String q
----
-The API methods has the following set of options listed in the following table:
-[width="100%",cols="1,2,5,2",options="header"]
+The search API is defined in the syntax as follows:
+
+----
+box:search/methodName?[parameters]
+----
+
+The 1 method(s) is listed in the table below.
+(API methods can have a shorthand alias name which can be used in the syntax instead of the name)
+
+[width="100%",cols="2,2,6",options="header"]
|===
-| Method | Name | Description | Type
+| Method | Alias | Description
+| *searchFolder* | search | Search folder and all descendant folders using the given query
+|===
+
+The search API method(s) has the following set of parameters listed in the table below:
+[width="100%",cols="2,2,4,2",options="header"]
+|===
+| Method | Parameter | Description | Type
| searchFolder | *folderId* | The id of folder searched | String
| searchFolder | *query* | The search query | String
|===
+In addition to the parameters above, the search API can also use from the 38 endpoint query option
+which is listed in the _Query Parameters_ section.
==== comments
-The comments has 6 API method(s) which is represented by the following method signatures
+The comments API has 6 method(s) which is represented by the following method signatures
(an API method may have multiple signatures due to overloading):
[source,java]
@@ -340,10 +395,30 @@ com.box.sdk.BoxComment replyToComment(String commentId, String message);
----
-The API methods has the following set of options listed in the following table:
-[width="100%",cols="1,2,5,2",options="header"]
+The comments API is defined in the syntax as follows:
+
+----
+box:comments/methodName?[parameters]
+----
+
+The 6 method(s) is listed in the table below.
+(API methods can have a shorthand alias name which can be used in the syntax instead of the name)
+
+[width="100%",cols="2,2,6",options="header"]
|===
-| Method | Name | Description | Type
+| Method | Alias | Description
+| *addFileComment* | add | Add comment to file
+| *changeCommentMessage* | updateMessage | Change comment message
+| *deleteComment* | delete | Delete comment
+| *getCommentInfo* | info | Get comment information
+| *getFileComments* | comments | Get a list of any comments on this file
+| *replyToComment* | reply | Reply to a comment
+|===
+
+The comments API method(s) has the following set of parameters listed in the table below:
+[width="100%",cols="2,2,4,2",options="header"]
+|===
+| Method | Parameter | Description | Type
| addFileComment | *fileId* | The id of file | String
| addFileComment | *message* | The comment's message | String
| changeCommentMessage | *commentId* | The id of comment to change | String
@@ -355,13 +430,15 @@ The API methods has the following set of options listed in the following table:
| replyToComment | *message* | The message for the reply | String
|===
+In addition to the parameters above, the comments API can also use from the 38 endpoint query option
+which is listed in the _Query Parameters_ section.
==== event-logs
-The event-logs has 1 API method(s) which is represented by the following method signatures
+The event-logs API has 1 method(s) which is represented by the following method signatures
(an API method may have multiple signatures due to overloading):
[source,java]
@@ -371,23 +448,40 @@ java.util.List<com.box.sdk.BoxEvent> getEnterpriseEvents(String position, java.u
----
-The API methods has the following set of options listed in the following table:
-[width="100%",cols="1,2,5,2",options="header"]
+The event-logs API is defined in the syntax as follows:
+
+----
+box:event-logs/methodName?[parameters]
+----
+
+The 1 method(s) is listed in the table below.
+(API methods can have a shorthand alias name which can be used in the syntax instead of the name)
+
+[width="100%",cols="2,2,6",options="header"]
+|===
+| Method | Alias | Description
+| *getEnterpriseEvents* | events | Create an event stream with optional starting initial position and add listener that will be notified when an event is received
|===
-| Method | Name | Description | Type
+
+The event-logs API method(s) has the following set of parameters listed in the table below:
+[width="100%",cols="2,2,4,2",options="header"]
+|===
+| Method | Parameter | Description | Type
| getEnterpriseEvents | *after* | The lower bound on the timestamp of the events returned | Date
| getEnterpriseEvents | *before* | The upper bound on the timestamp of the events returned | Date
| getEnterpriseEvents | *position* | The starting position of the event stream. May be null in which case all events within bounds returned. | String
| getEnterpriseEvents | *types* | An optional list of event types to filter by | Type[]
|===
+In addition to the parameters above, the event-logs API can also use from the 38 endpoint query option
+which is listed in the _Query Parameters_ section.
==== collaborations
-The collaborations has 6 API method(s) which is represented by the following method signatures
+The collaborations API has 6 method(s) which is represented by the following method signatures
(an API method may have multiple signatures due to overloading):
[source,java]
@@ -407,10 +501,30 @@ com.box.sdk.BoxCollaboration updateCollaborationInfo(String collaborationId, com
----
-The API methods has the following set of options listed in the following table:
-[width="100%",cols="1,2,5,2",options="header"]
+The collaborations API is defined in the syntax as follows:
+
+----
+box:collaborations/methodName?[parameters]
+----
+
+The 6 method(s) is listed in the table below.
+(API methods can have a shorthand alias name which can be used in the syntax instead of the name)
+
+[width="100%",cols="2,2,6",options="header"]
+|===
+| Method | Alias | Description
+| *addFolderCollaboration* | add | Add a collaboration to this folder
+| *addFolderCollaborationByEmail* | addByEmail | Add a collaboration to this folder
+| *deleteCollaboration* | delete | Delete collaboration
+| *getCollaborationInfo* | info | Get collaboration information
+| *getFolderCollaborations* | collaborations | Get information about all of the collaborations for folder
+| *updateCollaborationInfo* | updateInfo | Update collaboration information
|===
-| Method | Name | Description | Type
+
+The collaborations API method(s) has the following set of parameters listed in the table below:
+[width="100%",cols="2,2,4,2",options="header"]
+|===
+| Method | Parameter | Description | Type
| addFolderCollaboration | *collaborator* | The collaborator to add | BoxCollaborator
| addFolderCollaboration | *folderId* | The id of folder to add collaboration to | String
| addFolderCollaboration | *role* | The role of the collaborator | Role
@@ -424,13 +538,15 @@ The API methods has the following set of options listed in the following table:
| updateCollaborationInfo | *info* | | Info
|===
+In addition to the parameters above, the collaborations API can also use from the 38 endpoint query option
+which is listed in the _Query Parameters_ section.
==== tasks
-The tasks has 9 API method(s) which is represented by the following method signatures
+The tasks API has 9 method(s) which is represented by the following method signatures
(an API method may have multiple signatures due to overloading):
[source,java]
@@ -456,10 +572,33 @@ com.box.sdk.BoxTask updateTaskInfo(String taskId, com.box.sdk.BoxTask.Info info)
----
-The API methods has the following set of options listed in the following table:
-[width="100%",cols="1,2,5,2",options="header"]
+The tasks API is defined in the syntax as follows:
+
+----
+box:tasks/methodName?[parameters]
+----
+
+The 9 method(s) is listed in the table below.
+(API methods can have a shorthand alias name which can be used in the syntax instead of the name)
+
+[width="100%",cols="2,2,6",options="header"]
+|===
+| Method | Alias | Description
+| *addAssignmentToTask* | addAssignment | Add assignment for task
+| *addFileTask* | add | Add task to file
+| *deleteTask* | delete | Delete task
+| *deleteTaskAssignment* | deleteAssignment | Delete task assignment
+| *getFileTasks* | tasks | Get a list of any tasks on file
+| *getTaskAssignmentInfo* | assignmentInfo | Get task assignment information
+| *getTaskAssignments* | assignments | Get a list of any assignments for task
+| *getTaskInfo* | info | Get task information
+| *updateTaskInfo* | updateInfo | Update task information
+|===
+
+The tasks API method(s) has the following set of parameters listed in the table below:
+[width="100%",cols="2,2,4,2",options="header"]
|===
-| Method | Name | Description | Type
+| Method | Parameter | Description | Type
| addAssignmentToTask | *assignTo* | The user to assign to task | BoxUser
| addAssignmentToTask | *taskId* | The id of task to add assignment for | String
| addFileTask | *action* | The action the task assignee will be prompted to do | Action
@@ -476,13 +615,15 @@ The API methods has the following set of options listed in the following table:
| updateTaskInfo | *taskId* | The id of task | String
|===
+In addition to the parameters above, the tasks API can also use from the 38 endpoint query option
+which is listed in the _Query Parameters_ section.
==== events
-The events has 1 API method(s) which is represented by the following method signatures
+The events API has 1 method(s) which is represented by the following method signatures
(an API method may have multiple signatures due to overloading):
[source,java]
@@ -492,20 +633,37 @@ void listen(com.box.sdk.EventListener listener, Long startingPosition);
----
-The API methods has the following set of options listed in the following table:
-[width="100%",cols="1,2,5,2",options="header"]
+The events API is defined in the syntax as follows:
+
+----
+box:events/methodName?[parameters]
+----
+
+The 1 method(s) is listed in the table below.
+(API methods can have a shorthand alias name which can be used in the syntax instead of the name)
+
+[width="100%",cols="2,2,6",options="header"]
+|===
+| Method | Alias | Description
+| *listen* | | Create an event stream with optional starting initial position and add listener that will be notified when an event is received
|===
-| Method | Name | Description | Type
+
+The events API method(s) has the following set of parameters listed in the table below:
+[width="100%",cols="2,2,4,2",options="header"]
+|===
+| Method | Parameter | Description | Type
| listen | *startingPosition* | The starting position of the event stream | Long
|===
+In addition to the parameters above, the events API can also use from the 38 endpoint query option
+which is listed in the _Query Parameters_ section.
==== groups
-The groups has 9 API method(s) which is represented by the following method signatures
+The groups API has 9 method(s) which is represented by the following method signatures
(an API method may have multiple signatures due to overloading):
[source,java]
@@ -531,10 +689,33 @@ com.box.sdk.BoxGroupMembership updateGroupMembershipInfo(String groupMembershipI
----
-The API methods has the following set of options listed in the following table:
-[width="100%",cols="1,2,5,2",options="header"]
+The groups API is defined in the syntax as follows:
+
+----
+box:groups/methodName?[parameters]
+----
+
+The 9 method(s) is listed in the table below.
+(API methods can have a shorthand alias name which can be used in the syntax instead of the name)
+
+[width="100%",cols="2,2,6",options="header"]
+|===
+| Method | Alias | Description
+| *addGroupMembership* | addMembership | Add a member to group with the specified role
+| *createGroup* | create | Create a new group with a specified name and optional additional parameters
+| *deleteGroup* | delete | Delete group
+| *deleteGroupMembership* | deleteMembership | Delete group membership
+| *getGroupInfo* | info | Get group information
+| *getGroupMembershipInfo* | membershipInfo | Get group membership information
+| *getGroupMemberships* | memberships | Get information about all of the group memberships for this group
+| *updateGroupInfo* | | Update group information
+| *updateGroupMembershipInfo* | updateMembershipInfo | Update group membership information
|===
-| Method | Name | Description | Type
+
+The groups API method(s) has the following set of parameters listed in the table below:
+[width="100%",cols="2,2,4,2",options="header"]
+|===
+| Method | Parameter | Description | Type
| addGroupMembership | *groupId* | The id of group | String
| addGroupMembership | *role* | The role of the user in this group. Can be null to assign the default role. | Role
| addGroupMembership | *userId* | The id of user to be added to group | String
@@ -555,13 +736,15 @@ The API methods has the following set of options listed in the following table:
| updateGroupMembershipInfo | *info* | The updated information | Info
|===
+In addition to the parameters above, the groups API can also use from the 38 endpoint query option
+which is listed in the _Query Parameters_ section.
==== users
-The users has 10 API method(s) which is represented by the following method signatures
+The users API has 10 method(s) which is represented by the following method signatures
(an API method may have multiple signatures due to overloading):
[source,java]
@@ -589,10 +772,34 @@ com.box.sdk.BoxUser updateUserInfo(String userId, com.box.sdk.BoxUser.Info info)
----
-The API methods has the following set of options listed in the following table:
-[width="100%",cols="1,2,5,2",options="header"]
+The users API is defined in the syntax as follows:
+
+----
+box:users/methodName?[parameters]
+----
+
+The 10 method(s) is listed in the table below.
+(API methods can have a shorthand alias name which can be used in the syntax instead of the name)
+
+[width="100%",cols="2,2,6",options="header"]
+|===
+| Method | Alias | Description
+| *addUserEmailAlias* | addEmailAlias | Add a new email alias to user's account
+| *createAppUser* | create | Provision a new app user in an enterprise with additional user information using Box Developer Edition
+| *createEnterpriseUser* | create | Provision a new user in an enterprise with additional user information
+| *deleteUser* | delete | Delete user from an enterprise account
+| *deleteUserEmailAlias* | deleteEmailAlias | Delete an email alias from user's account
+| *getAllEnterpriseOrExternalUsers* | users | Get any managed users that match the filter term as well as any external users that match the filter term
+| *getUserEmailAlias* | emailAlias | Get a collection of all the email aliases for user
+| *getUserInfo* | info | Get user information
+| *moveFolderToUser* | | Move root folder for specified user to current user
+| *updateUserInfo* | updateInfo | Update user information
+|===
+
+The users API method(s) has the following set of parameters listed in the table below:
+[width="100%",cols="2,2,4,2",options="header"]
|===
-| Method | Name | Description | Type
+| Method | Parameter | Description | Type
| addUserEmailAlias | *email* | The email address to add as an alias | String
| addUserEmailAlias | *userId* | The id of user | String
| createAppUser | *name* | The name of the user | String
@@ -615,13 +822,15 @@ The API methods has the following set of options listed in the following table:
| updateUserInfo | *userId* | The id of user to update | String
|===
+In addition to the parameters above, the users API can also use from the 38 endpoint query option
+which is listed in the _Query Parameters_ section.
==== folders
-The folders has 10 API method(s) which is represented by the following method signatures
+The folders API has 10 method(s) which is represented by the following method signatures
(an API method may have multiple signatures due to overloading):
[source,java]
@@ -651,10 +860,34 @@ com.box.sdk.BoxFolder updateFolderInfo(String folderId, com.box.sdk.BoxFolder.In
----
-The API methods has the following set of options listed in the following table:
-[width="100%",cols="1,2,5,2",options="header"]
+The folders API is defined in the syntax as follows:
+
+----
+box:folders/methodName?[parameters]
+----
+
+The 10 method(s) is listed in the table below.
+(API methods can have a shorthand alias name which can be used in the syntax instead of the name)
+
+[width="100%",cols="2,2,6",options="header"]
|===
-| Method | Name | Description | Type
+| Method | Alias | Description
+| *copyFolder* | copy | Copy folder to destination folder while optionally giving it a new name
+| *createFolder* | create | Create a folder specified by path from parent folder with given parentFolderId, creating intermediate directories as required
+| *createFolderSharedLink* | link | Create a shared link to folder
+| *deleteFolder* | delete | Delete folder
+| *getFolder* | folder | Return the Box folder referenced by path
+| *getFolderInfo* | info | Get folder information
+| *getFolderItems* | items | Returns a specific range of child items in folder and specifies which fields of each item to retrieve
+| *moveFolder* | move | Move folder to destination folder while optionally giving it a new name
+| *renameFolder* | rename | Rename folder giving it the name newName
+| *updateFolderInfo* | updateInfo | Update folder information
+|===
+
+The folders API method(s) has the following set of parameters listed in the table below:
+[width="100%",cols="2,2,4,2",options="header"]
+|===
+| Method | Parameter | Description | Type
| copyFolder | *destinationFolderId* | The id of the destination folder | String
| copyFolder | *folderId* | The id of folder to copy | String
| copyFolder | *newName* | The new name for copied folder; if newName is null, the copied folder has same name as the original. | String
@@ -681,6 +914,9 @@ The API methods has the following set of options listed in the following table:
| updateFolderInfo | *folderId* | The id of folder to update | String
| updateFolderInfo | *info* | The updated information | Info
|===
+
+In addition to the parameters above, the folders API can also use from the 38 endpoint query option
+which is listed in the _Query Parameters_ section.
// endpoint options: END
== URI format
diff --git a/components/camel-braintree/src/main/docs/braintree-component.adoc b/components/camel-braintree/src/main/docs/braintree-component.adoc
index 08a1747..a2645d3 100644
--- a/components/camel-braintree/src/main/docs/braintree-component.adoc
+++ b/components/camel-braintree/src/main/docs/braintree-component.adoc
@@ -142,73 +142,146 @@ The following lists each API name and method and its additional parameters.
==== paymentMethodNonce
-The paymentMethodNonce has 2 API method(s) which is represented by the following method signatures
+The paymentMethodNonce API has 2 method(s) which is represented by the following method signatures
(an API method may have multiple signatures due to overloading):
+[source,java]
----
-com.braintreegateway.Result<com.braintreegateway.PaymentMethodNonce> create(String paymentMethodToken)
-com.braintreegateway.Result<com.braintreegateway.PaymentMethodNonce> create(com.braintreegateway.PaymentMethodNonceRequest request)
-com.braintreegateway.PaymentMethodNonce find(String paymentMethodNonce)
+
+com.braintreegateway.Result<com.braintreegateway.PaymentMethodNonce> create(String paymentMethodToken);
+
+com.braintreegateway.Result<com.braintreegateway.PaymentMethodNonce> create(com.braintreegateway.PaymentMethodNonceRequest request);
+
+com.braintreegateway.PaymentMethodNonce find(String paymentMethodNonce);
+
+----
+
+The paymentMethodNonce API is defined in the syntax as follows:
----
+braintree:paymentMethodNonce/methodName?[parameters]
+----
+
+The 2 method(s) is listed in the table below.
+(API methods can have a shorthand alias name which can be used in the syntax instead of the name)
+
+[width="100%",cols="2,2,6",options="header"]
+|===
+| Method | Alias | Description
+| *create* | |
+| *find* | |
+|===
-The API methods has the following set of options listed in the following table:
-[width="100%",cols="1,2,5,2",options="header"]
+The paymentMethodNonce API method(s) has the following set of parameters listed in the table below:
+[width="100%",cols="2,2,4,2",options="header"]
|===
-| Method | Name | Description | Type
+| Method | Parameter | Description | Type
| create | *paymentMethodToken* | | String
| create | *request* | | PaymentMethodNonceRequest
| find | *paymentMethodNonce* | | String
|===
+In addition to the parameters above, the paymentMethodNonce API can also use from the 34 endpoint query option
+which is listed in the _Query Parameters_ section.
==== documentUpload
-The documentUpload has 1 API method(s) which is represented by the following method signatures
+The documentUpload API has 1 method(s) which is represented by the following method signatures
(an API method may have multiple signatures due to overloading):
+[source,java]
+----
+
+com.braintreegateway.Result<com.braintreegateway.DocumentUpload> create(com.braintreegateway.DocumentUploadRequest request);
+
----
-com.braintreegateway.Result<com.braintreegateway.DocumentUpload> create(com.braintreegateway.DocumentUploadRequest request)
+
+The documentUpload API is defined in the syntax as follows:
----
+braintree:documentUpload/methodName?[parameters]
+----
+
+The 1 method(s) is listed in the table below.
+(API methods can have a shorthand alias name which can be used in the syntax instead of the name)
+
+[width="100%",cols="2,2,6",options="header"]
+|===
+| Method | Alias | Description
+| *create* | |
+|===
-The API methods has the following set of options listed in the following table:
-[width="100%",cols="1,2,5,2",options="header"]
+The documentUpload API method(s) has the following set of parameters listed in the table below:
+[width="100%",cols="2,2,4,2",options="header"]
|===
-| Method | Name | Description | Type
+| Method | Parameter | Description | Type
| create | *request* | | DocumentUploadRequest
|===
+In addition to the parameters above, the documentUpload API can also use from the 34 endpoint query option
+which is listed in the _Query Parameters_ section.
==== subscription
-The subscription has 7 API method(s) which is represented by the following method signatures
+The subscription API has 7 method(s) which is represented by the following method signatures
(an API method may have multiple signatures due to overloading):
+[source,java]
----
-com.braintreegateway.Result<com.braintreegateway.Subscription> cancel(String id)
-com.braintreegateway.Result<com.braintreegateway.Subscription> create(com.braintreegateway.SubscriptionRequest request)
-com.braintreegateway.Result<com.braintreegateway.Subscription> delete(String customerId, String id)
-com.braintreegateway.Subscription find(String id)
-com.braintreegateway.Result<com.braintreegateway.Transaction> retryCharge(String subscriptionId)
-com.braintreegateway.Result<com.braintreegateway.Transaction> retryCharge(String subscriptionId, Boolean submitForSettlement)
-com.braintreegateway.Result<com.braintreegateway.Transaction> retryCharge(String subscriptionId, java.math.BigDecimal amount)
-com.braintreegateway.Result<com.braintreegateway.Transaction> retryCharge(String subscriptionId, java.math.BigDecimal amount, Boolean submitForSettlement)
-com.braintreegateway.ResourceCollection<com.braintreegateway.Subscription> search(com.braintreegateway.SubscriptionSearchRequest searchRequest)
-com.braintreegateway.Result<com.braintreegateway.Subscription> update(String id, com.braintreegateway.SubscriptionRequest request)
+
+com.braintreegateway.Result<com.braintreegateway.Subscription> cancel(String id);
+
+com.braintreegateway.Result<com.braintreegateway.Subscription> create(com.braintreegateway.SubscriptionRequest request);
+
+com.braintreegateway.Result<com.braintreegateway.Subscription> delete(String customerId, String id);
+
+com.braintreegateway.Subscription find(String id);
+
+com.braintreegateway.Result<com.braintreegateway.Transaction> retryCharge(String subscriptionId);
+
+com.braintreegateway.Result<com.braintreegateway.Transaction> retryCharge(String subscriptionId, Boolean submitForSettlement);
+
+com.braintreegateway.Result<com.braintreegateway.Transaction> retryCharge(String subscriptionId, java.math.BigDecimal amount);
+
+com.braintreegateway.Result<com.braintreegateway.Transaction> retryCharge(String subscriptionId, java.math.BigDecimal amount, Boolean submitForSettlement);
+
+com.braintreegateway.ResourceCollection<com.braintreegateway.Subscription> search(com.braintreegateway.SubscriptionSearchRequest searchRequest);
+
+com.braintreegateway.Result<com.braintreegateway.Subscription> update(String id, com.braintreegateway.SubscriptionRequest request);
----
-The API methods has the following set of options listed in the following table:
-[width="100%",cols="1,2,5,2",options="header"]
+The subscription API is defined in the syntax as follows:
+
+----
+braintree:subscription/methodName?[parameters]
+----
+
+The 7 method(s) is listed in the table below.
+(API methods can have a shorthand alias name which can be used in the syntax instead of the name)
+
+[width="100%",cols="2,2,6",options="header"]
+|===
+| Method | Alias | Description
+| *cancel* | | Cancels the Subscription with the given id
+| *create* | | Creates a Subscription
+| *delete* | |
+| *find* | | Finds a Subscription by id
+| *retryCharge* | |
+| *search* | | Search for a Subscription
+| *update* | | Updates a Subscription
|===
-| Method | Name | Description | Type
+
+The subscription API method(s) has the following set of parameters listed in the table below:
+[width="100%",cols="2,2,4,2",options="header"]
+|===
+| Method | Parameter | Description | Type
| cancel | *id* | Of the Subscription to cancel | String
| create | *request* | The request | SubscriptionRequest
| delete | *customerId* | | String
@@ -222,32 +295,65 @@ The API methods has the following set of options listed in the following table:
| update | *request* | The request | SubscriptionRequest
|===
+In addition to the parameters above, the subscription API can also use from the 34 endpoint query option
+which is listed in the _Query Parameters_ section.
==== dispute
-The dispute has 7 API method(s) which is represented by the following method signatures
+The dispute API has 7 method(s) which is represented by the following method signatures
(an API method may have multiple signatures due to overloading):
+[source,java]
+----
+
+com.braintreegateway.Result<com.braintreegateway.Dispute> accept(String id);
+
+com.braintreegateway.Result<com.braintreegateway.DisputeEvidence> addFileEvidence(String disputeId, String documentId);
+
+com.braintreegateway.Result<com.braintreegateway.DisputeEvidence> addFileEvidence(String disputeId, com.braintreegateway.FileEvidenceRequest fileEvidenceRequest);
+
+com.braintreegateway.Result<com.braintreegateway.DisputeEvidence> addTextEvidence(String id, String content);
+
+com.braintreegateway.Result<com.braintreegateway.DisputeEvidence> addTextEvidence(String id, com.braintreegateway.TextEvidenceRequest textEvidenceRequest);
+
+com.braintreegateway.Result<com.braintreegateway.Dispute> finalize(String id);
+
+com.braintreegateway.Dispute find(String id);
+
+com.braintreegateway.Result<com.braintreegateway.Dispute> removeEvidence(String disputeId, String evidenceId);
+
+com.braintreegateway.PaginatedCollection<com.braintreegateway.Dispute> search(com.braintreegateway.DisputeSearchRequest query);
+
----
-com.braintreegateway.Result<com.braintreegateway.Dispute> accept(String id)
-com.braintreegateway.Result<com.braintreegateway.DisputeEvidence> addFileEvidence(String disputeId, String documentId)
-com.braintreegateway.Result<com.braintreegateway.DisputeEvidence> addFileEvidence(String disputeId, com.braintreegateway.FileEvidenceRequest fileEvidenceRequest)
-com.braintreegateway.Result<com.braintreegateway.DisputeEvidence> addTextEvidence(String id, String content)
-com.braintreegateway.Result<com.braintreegateway.DisputeEvidence> addTextEvidence(String id, com.braintreegateway.TextEvidenceRequest textEvidenceRequest)
-com.braintreegateway.Result<com.braintreegateway.Dispute> finalize(String id)
-com.braintreegateway.Dispute find(String id)
-com.braintreegateway.Result<com.braintreegateway.Dispute> removeEvidence(String disputeId, String evidenceId)
-com.braintreegateway.PaginatedCollection<com.braintreegateway.Dispute> search(com.braintreegateway.DisputeSearchRequest query)
+
+The dispute API is defined in the syntax as follows:
----
+braintree:dispute/methodName?[parameters]
+----
+
+The 7 method(s) is listed in the table below.
+(API methods can have a shorthand alias name which can be used in the syntax instead of the name)
+
+[width="100%",cols="2,2,6",options="header"]
+|===
+| Method | Alias | Description
+| *accept* | | Accept a Dispute, given a dispute ID
+| *addFileEvidence* | | Add File Evidence to a Dispute, given an ID and a FileEvidenceRequest File evidence request
+| *addTextEvidence* | | Add Text Evidence to a Dispute, given an ID and content
+| *finalize* | | Finalize a Dispute, given an ID
+| *find* | | Returns a Dispute, given an ID
+| *removeEvidence* | | Remove Evidence from a Dispute, given an ID and a DisputeEvidence ID
+| *search* | | Finds all Disputes that match the query
+|===
-The API methods has the following set of options listed in the following table:
-[width="100%",cols="1,2,5,2",options="header"]
+The dispute API method(s) has the following set of parameters listed in the table below:
+[width="100%",cols="2,2,4,2",options="header"]
|===
-| Method | Name | Description | Type
+| Method | Parameter | Description | Type
| accept | *id* | The dispute id to accept | String
| addFileEvidence | *disputeId* | The dispute id to add text evidence to | String
| addFileEvidence | *documentId* | The document id of a previously uploaded document | String
@@ -262,50 +368,95 @@ The API methods has the following set of options listed in the following table:
| search | *query* | The query for what disputes to find | DisputeSearchRequest
|===
+In addition to the parameters above, the dispute API can also use from the 34 endpoint query option
+which is listed in the _Query Parameters_ section.
==== settlementBatchSummary
-The settlementBatchSummary has 1 API method(s) which is represented by the following method signatures
+The settlementBatchSummary API has 1 method(s) which is represented by the following method signatures
(an API method may have multiple signatures due to overloading):
+[source,java]
+----
+
+com.braintreegateway.Result<com.braintreegateway.SettlementBatchSummary> generate(java.util.Calendar settlementDate);
+
+com.braintreegateway.Result<com.braintreegateway.SettlementBatchSummary> generate(java.util.Calendar settlementDate, String groupByCustomField);
+
----
-com.braintreegateway.Result<com.braintreegateway.SettlementBatchSummary> generate(java.util.Calendar settlementDate)
-com.braintreegateway.Result<com.braintreegateway.SettlementBatchSummary> generate(java.util.Calendar settlementDate, String groupByCustomField)
+The settlementBatchSummary API is defined in the syntax as follows:
+
+----
+braintree:settlementBatchSummary/methodName?[parameters]
----
-The API methods has the following set of options listed in the following table:
-[width="100%",cols="1,2,5,2",options="header"]
+The 1 method(s) is listed in the table below.
+(API methods can have a shorthand alias name which can be used in the syntax instead of the name)
+
+[width="100%",cols="2,2,6",options="header"]
+|===
+| Method | Alias | Description
+| *generate* | |
+|===
+
+The settlementBatchSummary API method(s) has the following set of parameters listed in the table below:
+[width="100%",cols="2,2,4,2",options="header"]
|===
-| Method | Name | Description | Type
+| Method | Parameter | Description | Type
| generate | *groupByCustomField* | | String
| generate | *settlementDate* | | Calendar
|===
+In addition to the parameters above, the settlementBatchSummary API can also use from the 34 endpoint query option
+which is listed in the _Query Parameters_ section.
==== address
-The address has 4 API method(s) which is represented by the following method signatures
+The address API has 4 method(s) which is represented by the following method signatures
(an API method may have multiple signatures due to overloading):
+[source,java]
----
-com.braintreegateway.Result<com.braintreegateway.Address> create(String customerId, com.braintreegateway.AddressRequest request)
-com.braintreegateway.Result<com.braintreegateway.Address> delete(String customerId, String id)
-com.braintreegateway.Address find(String customerId, String id)
-com.braintreegateway.Result<com.braintreegateway.Address> update(String customerId, String id, com.braintreegateway.AddressRequest request)
+
+com.braintreegateway.Result<com.braintreegateway.Address> create(String customerId, com.braintreegateway.AddressRequest request);
+
+com.braintreegateway.Result<com.braintreegateway.Address> delete(String customerId, String id);
+
+com.braintreegateway.Address find(String customerId, String id);
+
+com.braintreegateway.Result<com.braintreegateway.Address> update(String customerId, String id, com.braintreegateway.AddressRequest request);
----
-The API methods has the following set of options listed in the following table:
-[width="100%",cols="1,2,5,2",options="header"]
+The address API is defined in the syntax as follows:
+
+----
+braintree:address/methodName?[parameters]
+----
+
+The 4 method(s) is listed in the table below.
+(API methods can have a shorthand alias name which can be used in the syntax instead of the name)
+
+[width="100%",cols="2,2,6",options="header"]
+|===
+| Method | Alias | Description
+| *create* | | Creates an Address for a Customer
+| *delete* | | Deletes a Customer's Address
+| *find* | | Finds a Customer's Address
+| *update* | | Updates a Customer's Address
+|===
+
+The address API method(s) has the following set of parameters listed in the table below:
+[width="100%",cols="2,2,4,2",options="header"]
|===
-| Method | Name | Description | Type
+| Method | Parameter | Description | Type
| create | *customerId* | The id of the Customer | String
| create | *request* | The request object | AddressRequest
| delete | *customerId* | The id of the Customer | String
@@ -317,90 +468,182 @@ The API methods has the following set of options listed in the following table:
| update | *request* | The request object containing the AddressRequest parameters | AddressRequest
|===
+In addition to the parameters above, the address API can also use from the 34 endpoint query option
+which is listed in the _Query Parameters_ section.
==== webhookNotification
-The webhookNotification has 2 API method(s) which is represented by the following method signatures
+The webhookNotification API has 2 method(s) which is represented by the following method signatures
(an API method may have multiple signatures due to overloading):
+[source,java]
----
-com.braintreegateway.WebhookNotification parse(String signature, String payload)
-String verify(String challenge)
+com.braintreegateway.WebhookNotification parse(String signature, String payload);
+
+String verify(String challenge);
+
+----
+
+The webhookNotification API is defined in the syntax as follows:
+
+----
+braintree:webhookNotification/methodName?[parameters]
----
-The API methods has the following set of options listed in the following table:
-[width="100%",cols="1,2,5,2",options="header"]
+The 2 method(s) is listed in the table below.
+(API methods can have a shorthand alias name which can be used in the syntax instead of the name)
+
+[width="100%",cols="2,2,6",options="header"]
+|===
+| Method | Alias | Description
+| *parse* | |
+| *verify* | |
+|===
+
+The webhookNotification API method(s) has the following set of parameters listed in the table below:
+[width="100%",cols="2,2,4,2",options="header"]
|===
-| Method | Name | Description | Type
+| Method | Parameter | Description | Type
| parse | *payload* | | String
| parse | *signature* | | String
| verify | *challenge* | | String
|===
+In addition to the parameters above, the webhookNotification API can also use from the 34 endpoint query option
+which is listed in the _Query Parameters_ section.
==== creditCardVerification
-The creditCardVerification has 3 API method(s) which is represented by the following method signatures
+The creditCardVerification API has 3 method(s) which is represented by the following method signatures
(an API method may have multiple signatures due to overloading):
+[source,java]
----
-com.braintreegateway.Result<com.braintreegateway.CreditCardVerification> create(com.braintreegateway.CreditCardVerificationRequest request)
-com.braintreegateway.CreditCardVerification find(String id)
-com.braintreegateway.ResourceCollection<com.braintreegateway.CreditCardVerification> search(com.braintreegateway.CreditCardVerificationSearchRequest query)
+com.braintreegateway.Result<com.braintreegateway.CreditCardVerification> create(com.braintreegateway.CreditCardVerificationRequest request);
+
+com.braintreegateway.CreditCardVerification find(String id);
+
+com.braintreegateway.ResourceCollection<com.braintreegateway.CreditCardVerification> search(com.braintreegateway.CreditCardVerificationSearchRequest query);
+
+----
+
+The creditCardVerification API is defined in the syntax as follows:
+
+----
+braintree:creditCardVerification/methodName?[parameters]
----
-The API methods has the following set of options listed in the following table:
-[width="100%",cols="1,2,5,2",options="header"]
+The 3 method(s) is listed in the table below.
+(API methods can have a shorthand alias name which can be used in the syntax instead of the name)
+
+[width="100%",cols="2,2,6",options="header"]
+|===
+| Method | Alias | Description
+| *create* | |
+| *find* | |
+| *search* | |
+|===
+
+The creditCardVerification API method(s) has the following set of parameters listed in the table below:
+[width="100%",cols="2,2,4,2",options="header"]
|===
-| Method | Name | Description | Type
+| Method | Parameter | Description | Type
| create | *request* | | CreditCardVerificationRequest
| find | *id* | | String
| search | *query* | | CreditCardVerificationSearchRequest
|===
+In addition to the parameters above, the creditCardVerification API can also use from the 34 endpoint query option
+which is listed in the _Query Parameters_ section.
==== transaction
-The transaction has 13 API method(s) which is represented by the following method signatures
+The transaction API has 13 method(s) which is represented by the following method signatures
(an API method may have multiple signatures due to overloading):
+[source,java]
----
-com.braintreegateway.Result<com.braintreegateway.Transaction> cancelRelease(String id)
-com.braintreegateway.Result<com.braintreegateway.Transaction> cloneTransaction(String id, com.braintreegateway.TransactionCloneRequest request)
-com.braintreegateway.Result<com.braintreegateway.Transaction> credit(com.braintreegateway.TransactionRequest request)
-com.braintreegateway.Transaction find(String id)
-com.braintreegateway.Result<com.braintreegateway.Transaction> holdInEscrow(String id)
-com.braintreegateway.Result<com.braintreegateway.Transaction> refund(String id)
-com.braintreegateway.Result<com.braintreegateway.Transaction> refund(String id, com.braintreegateway.TransactionRefundRequest request)
-com.braintreegateway.Result<com.braintreegateway.Transaction> refund(String id, java.math.BigDecimal amount)
-com.braintreegateway.Result<com.braintreegateway.Transaction> releaseFromEscrow(String id)
-com.braintreegateway.Result<com.braintreegateway.Transaction> sale(com.braintreegateway.TransactionRequest request)
-com.braintreegateway.ResourceCollection<com.braintreegateway.Transaction> search(com.braintreegateway.TransactionSearchRequest query)
-com.braintreegateway.Result<com.braintreegateway.Transaction> submitForPartialSettlement(String id, com.braintreegateway.TransactionRequest request)
-com.braintreegateway.Result<com.braintreegateway.Transaction> submitForPartialSettlement(String id, java.math.BigDecimal amount)
-com.braintreegateway.Result<com.braintreegateway.Transaction> submitForSettlement(String id)
-com.braintreegateway.Result<com.braintreegateway.Transaction> submitForSettlement(String id, com.braintreegateway.TransactionRequest request)
-com.braintreegateway.Result<com.braintreegateway.Transaction> submitForSettlement(String id, java.math.BigDecimal amount)
-com.braintreegateway.Result<com.braintreegateway.Transaction> updateDetails(String id, com.braintreegateway.TransactionRequest request)
-com.braintreegateway.Result<com.braintreegateway.Transaction> voidTransaction(String id)
+
+com.braintreegateway.Result<com.braintreegateway.Transaction> cancelRelease(String id);
+
+com.braintreegateway.Result<com.braintreegateway.Transaction> cloneTransaction(String id, com.braintreegateway.TransactionCloneRequest request);
+
+com.braintreegateway.Result<com.braintreegateway.Transaction> credit(com.braintreegateway.TransactionRequest request);
+
+com.braintreegateway.Transaction find(String id);
+
+com.braintreegateway.Result<com.braintreegateway.Transaction> holdInEscrow(String id);
+
+com.braintreegateway.Result<com.braintreegateway.Transaction> refund(String id);
+
+com.braintreegateway.Result<com.braintreegateway.Transaction> refund(String id, com.braintreegateway.TransactionRefundRequest request);
+
+com.braintreegateway.Result<com.braintreegateway.Transaction> refund(String id, java.math.BigDecimal amount);
+
+com.braintreegateway.Result<com.braintreegateway.Transaction> releaseFromEscrow(String id);
+
+com.braintreegateway.Result<com.braintreegateway.Transaction> sale(com.braintreegateway.TransactionRequest request);
+
+com.braintreegateway.ResourceCollection<com.braintreegateway.Transaction> search(com.braintreegateway.TransactionSearchRequest query);
+
+com.braintreegateway.Result<com.braintreegateway.Transaction> submitForPartialSettlement(String id, com.braintreegateway.TransactionRequest request);
+
+com.braintreegateway.Result<com.braintreegateway.Transaction> submitForPartialSettlement(String id, java.math.BigDecimal amount);
+
+com.braintreegateway.Result<com.braintreegateway.Transaction> submitForSettlement(String id);
+
+com.braintreegateway.Result<com.braintreegateway.Transaction> submitForSettlement(String id, com.braintreegateway.TransactionRequest request);
+
+com.braintreegateway.Result<com.braintreegateway.Transaction> submitForSettlement(String id, java.math.BigDecimal amount);
+
+com.braintreegateway.Result<com.braintreegateway.Transaction> updateDetails(String id, com.braintreegateway.TransactionRequest request);
+
+com.braintreegateway.Result<com.braintreegateway.Transaction> voidTransaction(String id);
----
-The API methods has the following set of options listed in the following table:
-[width="100%",cols="1,2,5,2",options="header"]
+The transaction API is defined in the syntax as follows:
+
+----
+braintree:transaction/methodName?[parameters]
+----
+
+The 13 method(s) is listed in the table below.
+(API methods can have a shorthand alias name which can be used in the syntax instead of the name)
+
+[width="100%",cols="2,2,6",options="header"]
+|===
+| Method | Alias | Description
+| *cancelRelease* | | Cancels a pending release of a transaction with the given id from escrow
+| *cloneTransaction* | |
+| *credit* | | Creates a credit Transaction
+| *find* | | Finds a Transaction by id
+| *holdInEscrow* | | Holds the transaction with the given id for escrow
+| *refund* | | Refunds all or part of a previous sale Transaction
+| *releaseFromEscrow* | | Submits the transaction with the given id for release
+| *sale* | | Creates a sale Transaction
+| *search* | | Finds all Transactions that match the query and returns a ResourceCollection
+| *submitForPartialSettlement* | | Submits a partial settlement transaction for the given id
+| *submitForSettlement* | | Submits the transaction with the given id to be settled along with a TransactionRequest object
+| *updateDetails* | | Updates details for a transaction that has been submitted for settlement
+| *voidTransaction* | | Voids the transaction with the given id
+|===
+
+The transaction API method(s) has the following set of parameters listed in the table below:
+[width="100%",cols="2,2,4,2",options="header"]
|===
-| Method | Name | Description | Type
+| Method | Parameter | Description | Type
| cancelRelease | *id* | Of the transaction to cancel release from escrow of | String
| cloneTransaction | *cloneRequest* | | TransactionCloneRequest
| cloneTransaction | *id* | | String
@@ -424,52 +667,102 @@ The API methods has the following set of options listed in the following table:
| voidTransaction | *id* | Of the transaction to void | String
|===
+In addition to the parameters above, the transaction API can also use from the 34 endpoint query option
+which is listed in the _Query Parameters_ section.
==== report
-The report has 1 API method(s) which is represented by the following method signatures
+The report API has 1 method(s) which is represented by the following method signatures
(an API method may have multiple signatures due to overloading):
+[source,java]
----
-com.braintreegateway.Result<com.braintreegateway.TransactionLevelFeeReport> transactionLevelFees(com.braintreegateway.TransactionLevelFeeReportRequest request)
+com.braintreegateway.Result<com.braintreegateway.TransactionLevelFeeReport> transactionLevelFees(com.braintreegateway.TransactionLevelFeeReportRequest request);
+
+----
+
+The report API is defined in the syntax as follows:
+
+----
+braintree:report/methodName?[parameters]
----
-The API methods has the following set of options listed in the following table:
-[width="100%",cols="1,2,5,2",options="header"]
+The 1 method(s) is listed in the table below.
+(API methods can have a shorthand alias name which can be used in the syntax instead of the name)
+
+[width="100%",cols="2,2,6",options="header"]
|===
-| Method | Name | Description | Type
+| Method | Alias | Description
+| *transactionLevelFees* | | Retrieves a Transaction-Level Fee Report
+|===
+
+The report API method(s) has the following set of parameters listed in the table below:
+[width="100%",cols="2,2,4,2",options="header"]
+|===
+| Method | Parameter | Description | Type
| transactionLevelFees | *request* | The request | TransactionLevelFeeReportRequest
|===
+In addition to the parameters above, the report API can also use from the 34 endpoint query option
+which is listed in the _Query Parameters_ section.
==== paymentMethod
-The paymentMethod has 6 API method(s) which is represented by the following method signatures
+The paymentMethod API has 6 method(s) which is represented by the following method signatures
(an API method may have multiple signatures due to overloading):
+[source,java]
----
-com.braintreegateway.Result<com.braintreegateway.? extends PaymentMethod> create(com.braintreegateway.PaymentMethodRequest request)
-com.braintreegateway.Result<com.braintreegateway.? extends PaymentMethod> delete(String token)
-com.braintreegateway.Result<com.braintreegateway.? extends PaymentMethod> delete(String token, com.braintreegateway.PaymentMethodDeleteRequest request)
-com.braintreegateway.PaymentMethod find(String token)
-com.braintreegateway.Result<com.braintreegateway.PaymentMethodNonce> grant(String token)
-com.braintreegateway.Result<com.braintreegateway.PaymentMethodNonce> grant(String token, com.braintreegateway.PaymentMethodGrantRequest grantRequest)
-com.braintreegateway.Result<com.braintreegateway.? extends PaymentMethod> revoke(String token)
-com.braintreegateway.Result<com.braintreegateway.? extends PaymentMethod> update(String token, com.braintreegateway.PaymentMethodRequest request)
+
+com.braintreegateway.Result<com.braintreegateway.? extends PaymentMethod> create(com.braintreegateway.PaymentMethodRequest request);
+
+com.braintreegateway.Result<com.braintreegateway.? extends PaymentMethod> delete(String token);
+
+com.braintreegateway.Result<com.braintreegateway.? extends PaymentMethod> delete(String token, com.braintreegateway.PaymentMethodDeleteRequest request);
+
+com.braintreegateway.PaymentMethod find(String token);
+
+com.braintreegateway.Result<com.braintreegateway.PaymentMethodNonce> grant(String token);
+
+com.braintreegateway.Result<com.braintreegateway.PaymentMethodNonce> grant(String token, com.braintreegateway.PaymentMethodGrantRequest grantRequest);
+
+com.braintreegateway.Result<com.braintreegateway.? extends PaymentMethod> revoke(String token);
+
+com.braintreegateway.Result<com.braintreegateway.? extends PaymentMethod> update(String token, com.braintreegateway.PaymentMethodRequest request);
----
-The API methods has the following set of options listed in the following table:
-[width="100%",cols="1,2,5,2",options="header"]
+The paymentMethod API is defined in the syntax as follows:
+
+----
+braintree:paymentMethod/methodName?[parameters]
+----
+
+The 6 method(s) is listed in the table below.
+(API methods can have a shorthand alias name which can be used in the syntax instead of the name)
+
+[width="100%",cols="2,2,6",options="header"]
+|===
+| Method | Alias | Description
+| *create* | |
+| *delete* | |
+| *find* | |
+| *grant* | |
+| *revoke* | |
+| *update* | |
|===
-| Method | Name | Description | Type
+
+The paymentMethod API method(s) has the following set of parameters listed in the table below:
+[width="100%",cols="2,2,4,2",options="header"]
+|===
+| Method | Parameter | Description | Type
| create | *request* | | PaymentMethodRequest
| delete | *deleteRequest* | | PaymentMethodDeleteRequest
| delete | *token* | | String
@@ -481,50 +774,97 @@ The API methods has the following set of options listed in the following table:
| update | *token* | | String
|===
+In addition to the parameters above, the paymentMethod API can also use from the 34 endpoint query option
+which is listed in the _Query Parameters_ section.
==== clientToken
-The clientToken has 1 API method(s) which is represented by the following method signatures
+The clientToken API has 1 method(s) which is represented by the following method signatures
(an API method may have multiple signatures due to overloading):
+[source,java]
----
-String generate()
-String generate(com.braintreegateway.ClientTokenRequest request)
+
+String generate();
+
+String generate(com.braintreegateway.ClientTokenRequest request);
----
-The API methods has the following set of options listed in the following table:
-[width="100%",cols="1,2,5,2",options="header"]
+The clientToken API is defined in the syntax as follows:
+
+----
+braintree:clientToken/methodName?[parameters]
+----
+
+The 1 method(s) is listed in the table below.
+(API methods can have a shorthand alias name which can be used in the syntax instead of the name)
+
+[width="100%",cols="2,2,6",options="header"]
+|===
+| Method | Alias | Description
+| *generate* | |
+|===
+
+The clientToken API method(s) has the following set of parameters listed in the table below:
+[width="100%",cols="2,2,4,2",options="header"]
|===
-| Method | Name | Description | Type
+| Method | Parameter | Description | Type
| generate | *request* | | ClientTokenRequest
|===
+In addition to the parameters above, the clientToken API can also use from the 34 endpoint query option
+which is listed in the _Query Parameters_ section.
==== merchantAccount
-The merchantAccount has 5 API method(s) which is represented by the following method signatures
+The merchantAccount API has 5 method(s) which is represented by the following method signatures
(an API method may have multiple signatures due to overloading):
+[source,java]
+----
+
+com.braintreegateway.Result<com.braintreegateway.MerchantAccount> create(com.braintreegateway.MerchantAccountRequest request);
+
+com.braintreegateway.Result<com.braintreegateway.MerchantAccount> createForCurrency(com.braintreegateway.MerchantAccountCreateForCurrencyRequest request);
+
+com.braintreegateway.PaginatedResult<com.braintreegateway.MerchantAccount> fetchMerchantAccounts(int page);
+
+com.braintreegateway.MerchantAccount find(String id);
+
+com.braintreegateway.Result<com.braintreegateway.MerchantAccount> update(String id, com.braintreegateway.MerchantAccountRequest request);
+
----
-com.braintreegateway.Result<com.braintreegateway.MerchantAccount> create(com.braintreegateway.MerchantAccountRequest request)
-com.braintreegateway.Result<com.braintreegateway.MerchantAccount> createForCurrency(com.braintreegateway.MerchantAccountCreateForCurrencyRequest request)
-com.braintreegateway.PaginatedResult<com.braintreegateway.MerchantAccount> fetchMerchantAccounts(int page)
-com.braintreegateway.MerchantAccount find(String id)
-com.braintreegateway.Result<com.braintreegateway.MerchantAccount> update(String id, com.braintreegateway.MerchantAccountRequest request)
+
+The merchantAccount API is defined in the syntax as follows:
----
+braintree:merchantAccount/methodName?[parameters]
+----
+
+The 5 method(s) is listed in the table below.
+(API methods can have a shorthand alias name which can be used in the syntax instead of the name)
+
+[width="100%",cols="2,2,6",options="header"]
+|===
+| Method | Alias | Description
+| *create* | |
+| *createForCurrency* | |
+| *fetchMerchantAccounts* | |
+| *find* | |
+| *update* | |
+|===
-The API methods has the following set of options listed in the following table:
-[width="100%",cols="1,2,5,2",options="header"]
+The merchantAccount API method(s) has the following set of parameters listed in the table below:
+[width="100%",cols="2,2,4,2",options="header"]
|===
-| Method | Name | Description | Type
+| Method | Parameter | Description | Type
| create | *request* | | MerchantAccountRequest
| createForCurrency | *currencyRequest* | | MerchantAccountCreateForCurrencyRequest
| fetchMerchantAccounts | *page* | | Integer
@@ -533,29 +873,57 @@ The API methods has the following set of options listed in the following table:
| update | *request* | | MerchantAccountRequest
|===
+In addition to the parameters above, the merchantAccount API can also use from the 34 endpoint query option
+which is listed in the _Query Parameters_ section.
==== customer
-The customer has 5 API method(s) which is represented by the following method signatures
+The customer API has 5 method(s) which is represented by the following method signatures
(an API method may have multiple signatures due to overloading):
+[source,java]
----
-com.braintreegateway.Result<com.braintreegateway.Customer> create(com.braintreegateway.CustomerRequest request)
-com.braintreegateway.Result<com.braintreegateway.Customer> delete(String id)
-com.braintreegateway.Customer find(String id)
-com.braintreegateway.Customer find(String id, String associationFilterId)
-com.braintreegateway.ResourceCollection<com.braintreegateway.Customer> search(com.braintreegateway.CustomerSearchRequest query)
-com.braintreegateway.Result<com.braintreegateway.Customer> update(String id, com.braintreegateway.CustomerRequest request)
+com.braintreegateway.Result<com.braintreegateway.Customer> create(com.braintreegateway.CustomerRequest request);
+
+com.braintreegateway.Result<com.braintreegateway.Customer> delete(String id);
+
+com.braintreegateway.Customer find(String id);
+
+com.braintreegateway.Customer find(String id, String associationFilterId);
+
+com.braintreegateway.ResourceCollection<com.braintreegateway.Customer> search(com.braintreegateway.CustomerSearchRequest query);
+
+com.braintreegateway.Result<com.braintreegateway.Customer> update(String id, com.braintreegateway.CustomerRequest request);
+
+----
+
+The customer API is defined in the syntax as follows:
+
+----
+braintree:customer/methodName?[parameters]
----
-The API methods has the following set of options listed in the following table:
-[width="100%",cols="1,2,5,2",options="header"]
+The 5 method(s) is listed in the table below.
+(API methods can have a shorthand alias name which can be used in the syntax instead of the name)
+
+[width="100%",cols="2,2,6",options="header"]
+|===
+| Method | Alias | Description
+| *create* | | Creates a Customer
+| *delete* | | Deletes a Customer by id
+| *find* | | Finds a Customer by id
+| *search* | | Finds all Transactions that match the query and returns a ResourceCollection
+| *update* | | Updates a Customer
|===
-| Method | Name | Description | Type
+
+The customer API method(s) has the following set of parameters listed in the table below:
+[width="100%",cols="2,2,4,2",options="header"]
+|===
+| Method | Parameter | Description | Type
| create | *request* | The request | CustomerRequest
| delete | *id* | The id of the Customer | String
| find | *associationFilterId* | The id of the association filter to use | String
@@ -564,6 +932,9 @@ The API methods has the following set of options listed in the following table:
| update | *id* | The id of the Customer | String
| update | *request* | The request | CustomerRequest
|===
+
+In addition to the parameters above, the customer API can also use from the 34 endpoint query option
+which is listed in the _Query Parameters_ section.
// endpoint options: END
== Producer Endpoints:
diff --git a/components/camel-fhir/camel-fhir-component/src/main/docs/fhir-component.adoc b/components/camel-fhir/camel-fhir-component/src/main/docs/fhir-component.adoc
index dc15e5c..90ccba4 100644
--- a/components/camel-fhir/camel-fhir-component/src/main/docs/fhir-component.adoc
+++ b/components/camel-fhir/camel-fhir-component/src/main/docs/fhir-component.adoc
@@ -185,23 +185,46 @@ The following lists each API name and method and its additional parameters.
==== update
-The update has 2 API method(s) which is represented by the following method signatures
+The update API has 2 method(s) which is represented by the following method signatures
(an API method may have multiple signatures due to overloading):
+[source,java]
----
-ca.uhn.fhir.rest.api.MethodOutcome resource(String resourceAsString, String stringId, ca.uhn.fhir.rest.api.PreferReturnEnum preferReturn, java.util.Map<org.apache.camel.component.fhir.api.ExtraParameters, Object> extraParameters)
-ca.uhn.fhir.rest.api.MethodOutcome resource(String resourceAsString, org.hl7.fhir.instance.model.api.IIdType id, ca.uhn.fhir.rest.api.PreferReturnEnum preferReturn, java.util.Map<org.apache.camel.component.fhir.api.ExtraParameters, Object> extraParameters)
-ca.uhn.fhir.rest.api.MethodOutcome resource(org.hl7.fhir.instance.model.api.IBaseResource resource, String stringId, ca.uhn.fhir.rest.api.PreferReturnEnum preferReturn, java.util.Map<org.apache.camel.component.fhir.api.ExtraParameters, Object> extraParameters)
-ca.uhn.fhir.rest.api.MethodOutcome resource(org.hl7.fhir.instance.model.api.IBaseResource resource, org.hl7.fhir.instance.model.api.IIdType id, ca.uhn.fhir.rest.api.PreferReturnEnum preferReturn, java.util.Map<org.apache.camel.component.fhir.api.ExtraParameters, Object> extraParameters)
-ca.uhn.fhir.rest.api.MethodOutcome resourceBySearchUrl(String resourceAsString, String url, ca.uhn.fhir.rest.api.PreferReturnEnum preferReturn, java.util.Map<org.apache.camel.component.fhir.api.ExtraParameters, Object> extraParameters)
-ca.uhn.fhir.rest.api.MethodOutcome resourceBySearchUrl(org.hl7.fhir.instance.model.api.IBaseResource resource, String url, ca.uhn.fhir.rest.api.PreferReturnEnum preferReturn, java.util.Map<org.apache.camel.component.fhir.api.ExtraParameters, Object> extraParameters)
+ca.uhn.fhir.rest.api.MethodOutcome resource(String resourceAsString, String stringId, ca.uhn.fhir.rest.api.PreferReturnEnum preferReturn, java.util.Map<org.apache.camel.component.fhir.api.ExtraParameters, Object> extraParameters);
+
+ca.uhn.fhir.rest.api.MethodOutcome resource(String resourceAsString, org.hl7.fhir.instance.model.api.IIdType id, ca.uhn.fhir.rest.api.PreferReturnEnum preferReturn, java.util.Map<org.apache.camel.component.fhir.api.ExtraParameters, Object> extraParameters);
+
+ca.uhn.fhir.rest.api.MethodOutcome resource(org.hl7.fhir.instance.model.api.IBaseResource resource, String stringId, ca.uhn.fhir.rest.api.PreferReturnEnum preferReturn, java.util.Map<org.apache.camel.component.fhir.api.ExtraParameters, Object> extraParameters);
+
+ca.uhn.fhir.rest.api.MethodOutcome resource(org.hl7.fhir.instance.model.api.IBaseResource resource, org.hl7.fhir.instance.model.api.IIdType id, ca.uhn.fhir.rest.api.PreferReturnEnum preferReturn, java.util.Map<org.apache.camel.component.fhir.api.ExtraParameters, Object> extraParameters);
+
+ca.uhn.fhir.rest.api.MethodOutcome resourceBySearchUrl(String resourceAsString, String url, ca.uhn.fhir.rest.api.PreferReturnEnum preferReturn, java.util.Map<org.apache.camel.component.fhir.api.ExtraParameters, Object> extraParameters);
+
+ca.uhn.fhir.rest.api.MethodOutcome resourceBySearchUrl(org.hl7.fhir.instance.model.api.IBaseResource resource, String url, ca.uhn.fhir.rest.api.PreferReturnEnum preferReturn, java.util.Map<org.apache.camel.component.fhir.api.ExtraParameters, Object> extraParameters);
+
+----
+
+The update API is defined in the syntax as follows:
+
+----
+fhir:update/methodName?[parameters]
----
-The API methods has the following set of options listed in the following table:
-[width="100%",cols="1,2,5,2",options="header"]
+The 2 method(s) is listed in the table below.
+(API methods can have a shorthand alias name which can be used in the syntax instead of the name)
+
+[width="100%",cols="2,2,6",options="header"]
+|===
+| Method | Alias | Description
+| *resource* | |
+| *resourceBySearchUrl* | |
|===
-| Method | Name | Description | Type
+
+The update API method(s) has the following set of parameters listed in the table below:
+[width="100%",cols="2,2,4,2",options="header"]
+|===
+| Method | Parameter | Description | Type
| resource | *extraParameters* | | Map
| resource | *id* | | IIdType
| resource | *preferReturn* | | PreferReturnEnum
@@ -215,25 +238,45 @@ The API methods has the following set of options listed in the following table:
| resourceBySearchUrl | *url* | | String
|===
+In addition to the parameters above, the update API can also use from the 46 endpoint query option
+which is listed in the _Query Parameters_ section.
==== create
-The create has 1 API method(s) which is represented by the following method signatures
+The create API has 1 method(s) which is represented by the following method signatures
(an API method may have multiple signatures due to overloading):
+[source,java]
+----
+
+ca.uhn.fhir.rest.api.MethodOutcome resource(String resourceAsString, String url, ca.uhn.fhir.rest.api.PreferReturnEnum preferReturn, java.util.Map<org.apache.camel.component.fhir.api.ExtraParameters, Object> extraParameters);
+
+ca.uhn.fhir.rest.api.MethodOutcome resource(org.hl7.fhir.instance.model.api.IBaseResource resource, String url, ca.uhn.fhir.rest.api.PreferReturnEnum preferReturn, java.util.Map<org.apache.camel.component.fhir.api.ExtraParameters, Object> extraParameters);
+
----
-ca.uhn.fhir.rest.api.MethodOutcome resource(String resourceAsString, String url, ca.uhn.fhir.rest.api.PreferReturnEnum preferReturn, java.util.Map<org.apache.camel.component.fhir.api.ExtraParameters, Object> extraParameters)
-ca.uhn.fhir.rest.api.MethodOutcome resource(org.hl7.fhir.instance.model.api.IBaseResource resource, String url, ca.uhn.fhir.rest.api.PreferReturnEnum preferReturn, java.util.Map<org.apache.camel.component.fhir.api.ExtraParameters, Object> extraParameters)
+The create API is defined in the syntax as follows:
+
+----
+fhir:create/methodName?[parameters]
----
-The API methods has the following set of options listed in the following table:
-[width="100%",cols="1,2,5,2",options="header"]
+The 1 method(s) is listed in the table below.
+(API methods can have a shorthand alias name which can be used in the syntax instead of the name)
+
+[width="100%",cols="2,2,6",options="header"]
+|===
+| Method | Alias | Description
+| *resource* | | Creates a IBaseResource on the server
|===
-| Method | Name | Description | Type
+
+The create API method(s) has the following set of parameters listed in the table below:
+[width="100%",cols="2,2,4,2",options="header"]
+|===
+| Method | Parameter | Description | Type
| resource | *extraParameters* | See ExtraParameters for a full list of parameters that can be passed, may be NULL | Map
| resource | *preferReturn* | Add a Prefer header to the request, which requests that the server include or suppress the resource body as a part of the result. If a resource is returned by the server it will be parsed an accessible to the client via MethodOutcome#getResource() , may be null | PreferReturnEnum
| resource | *resource* | The resource to create | IBaseResource
@@ -241,52 +284,99 @@ The API methods has the following set of options listed in the following table:
| resource | *url* | The search URL to use. The format of this URL should be of the form ResourceTypeParameters, for example: Patientname=Smith&identifier=13.2.4.11.4%7C847366, may be null | String
|===
+In addition to the parameters above, the create API can also use from the 46 endpoint query option
+which is listed in the _Query Parameters_ section.
==== validate
-The validate has 1 API method(s) which is represented by the following method signatures
+The validate API has 1 method(s) which is represented by the following method signatures
(an API method may have multiple signatures due to overloading):
+[source,java]
+----
+
+ca.uhn.fhir.rest.api.MethodOutcome resource(String resourceAsString, java.util.Map<org.apache.camel.component.fhir.api.ExtraParameters, Object> extraParameters);
+
+ca.uhn.fhir.rest.api.MethodOutcome resource(org.hl7.fhir.instance.model.api.IBaseResource resource, java.util.Map<org.apache.camel.component.fhir.api.ExtraParameters, Object> extraParameters);
+
----
-ca.uhn.fhir.rest.api.MethodOutcome resource(String resourceAsString, java.util.Map<org.apache.camel.component.fhir.api.ExtraParameters, Object> extraParameters)
-ca.uhn.fhir.rest.api.MethodOutcome resource(org.hl7.fhir.instance.model.api.IBaseResource resource, java.util.Map<org.apache.camel.component.fhir.api.ExtraParameters, Object> extraParameters)
+The validate API is defined in the syntax as follows:
+
+----
+fhir:validate/methodName?[parameters]
----
-The API methods has the following set of options listed in the following table:
-[width="100%",cols="1,2,5,2",options="header"]
+The 1 method(s) is listed in the table below.
+(API methods can have a shorthand alias name which can be used in the syntax instead of the name)
+
+[width="100%",cols="2,2,6",options="header"]
+|===
+| Method | Alias | Description
+| *resource* | |
|===
-| Method | Name | Description | Type
+
+The validate API method(s) has the following set of parameters listed in the table below:
+[width="100%",cols="2,2,4,2",options="header"]
+|===
+| Method | Parameter | Description | Type
| resource | *extraParameters* | | Map
| resource | *resource* | | IBaseResource
| resource | *resourceAsString* | | String
|===
+In addition to the parameters above, the validate API can also use from the 46 endpoint query option
+which is listed in the _Query Parameters_ section.
==== operation
-The operation has 5 API method(s) which is represented by the following method signatures
+The operation API has 5 method(s) which is represented by the following method signatures
(an API method may have multiple signatures due to overloading):
+[source,java]
----
-org.hl7.fhir.instance.model.api.IBaseResource onInstance(org.hl7.fhir.instance.model.api.IIdType id, String name, org.hl7.fhir.instance.model.api.IBaseParameters parameters, Class<org.hl7.fhir.instance.model.api.IBaseParameters> outputParameterType, boolean useHttpGet, Class<org.hl7.fhir.instance.model.api.IBaseResource> returnType, java.util.Map<org.apache.camel.component.fhir.api.ExtraParameters, Object> extraParameters)
-org.hl7.fhir.instance.model.api.IBaseResource onInstanceVersion(org.hl7.fhir.instance.model.api.IIdType id, String name, org.hl7.fhir.instance.model.api.IBaseParameters parameters, Class<org.hl7.fhir.instance.model.api.IBaseParameters> outputParameterType, boolean useHttpGet, Class<org.hl7.fhir.instance.model.api.IBaseResource> returnType, java.util.Map<org.apache.camel.component.fhir.api.ExtraParameters, Object> extraParameters)
-org.hl7.fhir.instance.model.api.IBaseResource onServer(String name, org.hl7.fhir.instance.model.api.IBaseParameters parameters, Class<org.hl7.fhir.instance.model.api.IBaseParameters> outputParameterType, boolean useHttpGet, Class<org.hl7.fhir.instance.model.api.IBaseResource> returnType, java.util.Map<org.apache.camel.component.fhir.api.ExtraParameters, Object> extraParameters)
-org.hl7.fhir.instance.model.api.IBaseResource onType(Class<org.hl7.fhir.instance.model.api.IBaseResource> resourceType, String name, org.hl7.fhir.instance.model.api.IBaseParameters parameters, Class<org.hl7.fhir.instance.model.api.IBaseParameters> outputParameterType, boolean useHttpGet, Class<org.hl7.fhir.instance.model.api.IBaseResource> returnType, java.util.Map<org.apache.camel.component.fhir.api.ExtraParameters, Object> extraParameters)
-org.hl7.fhir.instance.model.api.IBaseBundle processMessage(String respondToUri, org.hl7.fhir.instance.model.api.IBaseBundle msgBundle, boolean asynchronous, Class<org.hl7.fhir.instance.model.api.IBaseBundle> responseClass, java.util.Map<org.apache.camel.component.fhir.api.ExtraParameters, Object> extraParameters)
+
+org.hl7.fhir.instance.model.api.IBaseResource onInstance(org.hl7.fhir.instance.model.api.IIdType id, String name, org.hl7.fhir.instance.model.api.IBaseParameters parameters, Class<org.hl7.fhir.instance.model.api.IBaseParameters> outputParameterType, boolean useHttpGet, Class<org.hl7.fhir.instance.model.api.IBaseResource> returnType, java.util.Map<org.apache.camel.component.fhir.api.ExtraParameters, Object> extraParameters);
+
+org.hl7.fhir.instance.model.api.IBaseResource onInstanceVersion(org.hl7.fhir.instance.model.api.IIdType id, String name, org.hl7.fhir.instance.model.api.IBaseParameters parameters, Class<org.hl7.fhir.instance.model.api.IBaseParameters> outputParameterType, boolean useHttpGet, Class<org.hl7.fhir.instance.model.api.IBaseResource> returnType, java.util.Map<org.apache.camel.component.fhir.api.ExtraParameters, Object> extraParameters);
+
+org.hl7.fhir.instance.model.api.IBaseResource onServer(String name, org.hl7.fhir.instance.model.api.IBaseParameters parameters, Class<org.hl7.fhir.instance.model.api.IBaseParameters> outputParameterType, boolean useHttpGet, Class<org.hl7.fhir.instance.model.api.IBaseResource> returnType, java.util.Map<org.apache.camel.component.fhir.api.ExtraParameters, Object> extraParameters);
+
+org.hl7.fhir.instance.model.api.IBaseResource onType(Class<org.hl7.fhir.instance.model.api.IBaseResource> resourceType, String name, org.hl7.fhir.instance.model.api.IBaseParameters parameters, Class<org.hl7.fhir.instance.model.api.IBaseParameters> outputParameterType, boolean useHttpGet, Class<org.hl7.fhir.instance.model.api.IBaseResource> returnType, java.util.Map<org.apache.camel.component.fhir.api.ExtraParameters, Object> extraParameters);
+
+org.hl7.fhir.instance.model.api.IBaseBundle processMessage(String respondToUri, org.hl7.fhir.instance.model.api.IBaseBundle msgBundle, boolean asynchronous, Class<org.hl7.fhir.instance.model.api.IBaseBundle> responseClass, java.util.Map<org.apache.camel.component.fhir.api.ExtraParameters, Object> extraParameters);
----
-The API methods has the following set of options listed in the following table:
-[width="100%",cols="1,2,5,2",options="header"]
+The operation API is defined in the syntax as follows:
+
+----
+fhir:operation/methodName?[parameters]
+----
+
+The 5 method(s) is listed in the table below.
+(API methods can have a shorthand alias name which can be used in the syntax instead of the name)
+
+[width="100%",cols="2,2,6",options="header"]
|===
-| Method | Name | Description | Type
+| Method | Alias | Description
+| *onInstance* | | Perform the operation across all versions of a specific resource (by ID and type) on the server
+| *onInstanceVersion* | | This operation operates on a specific version of a resource
+| *onServer* | | Perform the operation across all versions of all resources of all types on the server
+| *onType* | | Perform the operation across all versions of all resources of the given type on the server
+| *processMessage* | | This operation is called $process-message as defined by the FHIR specification
+|===
+
+The operation API method(s) has the following set of parameters listed in the table below:
+[width="100%",cols="2,2,4,2",options="header"]
+|===
+| Method | Parameter | Description | Type
| onInstance | *extraParameters* | See ExtraParameters for a full list of parameters that can be passed, may be NULL | Map
| onInstance | *id* | Resource (version will be stripped) | IIdType
| onInstance | *name* | Operation name | String
@@ -321,70 +411,130 @@ The API methods has the following set of options listed in the following table:
| processMessage | *responseClass* | The response class | Class
|===
+In addition to the parameters above, the operation API can also use from the 46 endpoint query option
+which is listed in the _Query Parameters_ section.
==== search
-The search has 1 API method(s) which is represented by the following method signatures
+The search API has 1 method(s) which is represented by the following method signatures
(an API method may have multiple signatures due to overloading):
+[source,java]
----
-org.hl7.fhir.instance.model.api.IBaseBundle searchByUrl(String url, java.util.Map<org.apache.camel.component.fhir.api.ExtraParameters, Object> extraParameters)
+
+org.hl7.fhir.instance.model.api.IBaseBundle searchByUrl(String url, java.util.Map<org.apache.camel.component.fhir.api.ExtraParameters, Object> extraParameters);
----
-The API methods has the following set of options listed in the following table:
-[width="100%",cols="1,2,5,2",options="header"]
+The search API is defined in the syntax as follows:
+
+----
+fhir:search/methodName?[parameters]
+----
+
+The 1 method(s) is listed in the table below.
+(API methods can have a shorthand alias name which can be used in the syntax instead of the name)
+
+[width="100%",cols="2,2,6",options="header"]
+|===
+| Method | Alias | Description
+| *searchByUrl* | | Perform a search directly by URL
|===
-| Method | Name | Description | Type
+
+The search API method(s) has the following set of parameters listed in the table below:
+[width="100%",cols="2,2,4,2",options="header"]
+|===
+| Method | Parameter | Description | Type
| searchByUrl | *extraParameters* | See ExtraParameters for a full list of parameters that can be passed, may be NULL | Map
| searchByUrl | *url* | The URL to search for. Note that this URL may be complete (e.g. \http://example.com/base/Patientname=foo) in which case the client's base URL will be ignored. Or it can be relative (e.g. Patientname=foo) in which case the client's base URL will be used. | String
|===
+In addition to the parameters above, the search API can also use from the 46 endpoint query option
+which is listed in the _Query Parameters_ section.
==== capabilities
-The capabilities has 1 API method(s) which is represented by the following method signatures
+The capabilities API has 1 method(s) which is represented by the following method signatures
(an API method may have multiple signatures due to overloading):
+[source,java]
+----
+
+org.hl7.fhir.instance.model.api.IBaseConformance ofType(Class<org.hl7.fhir.instance.model.api.IBaseConformance> type, java.util.Map<org.apache.camel.component.fhir.api.ExtraParameters, Object> extraParameters);
+
----
-org.hl7.fhir.instance.model.api.IBaseConformance ofType(Class<org.hl7.fhir.instance.model.api.IBaseConformance> type, java.util.Map<org.apache.camel.component.fhir.api.ExtraParameters, Object> extraParameters)
+The capabilities API is defined in the syntax as follows:
+
+----
+fhir:capabilities/methodName?[parameters]
----
-The API methods has the following set of options listed in the following table:
-[width="100%",cols="1,2,5,2",options="header"]
+The 1 method(s) is listed in the table below.
+(API methods can have a shorthand alias name which can be used in the syntax instead of the name)
+
+[width="100%",cols="2,2,6",options="header"]
+|===
+| Method | Alias | Description
+| *ofType* | | Retrieve the conformance statement using the given model type
+|===
+
+The capabilities API method(s) has the following set of parameters listed in the table below:
+[width="100%",cols="2,2,4,2",options="header"]
|===
-| Method | Name | Description | Type
+| Method | Parameter | Description | Type
| ofType | *extraParameters* | See ExtraParameters for a full list of parameters that can be passed, may be NULL | Map
| ofType | *type* | The model type | Class
|===
+In addition to the parameters above, the capabilities API can also use from the 46 endpoint query option
+which is listed in the _Query Parameters_ section.
==== patch
-The patch has 2 API method(s) which is represented by the following method signatures
+The patch API has 2 method(s) which is represented by the following method signatures
(an API method may have multiple signatures due to overloading):
+[source,java]
----
-ca.uhn.fhir.rest.api.MethodOutcome patchById(String patchBody, String stringId, ca.uhn.fhir.rest.api.PreferReturnEnum preferReturn, java.util.Map<org.apache.camel.component.fhir.api.ExtraParameters, Object> extraParameters)
-ca.uhn.fhir.rest.api.MethodOutcome patchById(String patchBody, org.hl7.fhir.instance.model.api.IIdType id, ca.uhn.fhir.rest.api.PreferReturnEnum preferReturn, java.util.Map<org.apache.camel.component.fhir.api.ExtraParameters, Object> extraParameters)
-ca.uhn.fhir.rest.api.MethodOutcome patchByUrl(String patchBody, String url, ca.uhn.fhir.rest.api.PreferReturnEnum preferReturn, java.util.Map<org.apache.camel.component.fhir.api.ExtraParameters, Object> extraParameters)
+
+ca.uhn.fhir.rest.api.MethodOutcome patchById(String patchBody, String stringId, ca.uhn.fhir.rest.api.PreferReturnEnum preferReturn, java.util.Map<org.apache.camel.component.fhir.api.ExtraParameters, Object> extraParameters);
+
+ca.uhn.fhir.rest.api.MethodOutcome patchById(String patchBody, org.hl7.fhir.instance.model.api.IIdType id, ca.uhn.fhir.rest.api.PreferReturnEnum preferReturn, java.util.Map<org.apache.camel.component.fhir.api.ExtraParameters, Object> extraParameters);
+
+ca.uhn.fhir.rest.api.MethodOutcome patchByUrl(String patchBody, String url, ca.uhn.fhir.rest.api.PreferReturnEnum preferReturn, java.util.Map<org.apache.camel.component.fhir.api.ExtraParameters, Object> extraParameters);
----
-The API methods has the following set of options listed in the following table:
-[width="100%",cols="1,2,5,2",options="header"]
+The patch API is defined in the syntax as follows:
+
+----
+fhir:patch/methodName?[parameters]
+----
+
+The 2 method(s) is listed in the table below.
+(API methods can have a shorthand alias name which can be used in the syntax instead of the name)
+
+[width="100%",cols="2,2,6",options="header"]
|===
-| Method | Name | Description | Type
+| Method | Alias | Description
+| *patchById* | | Applies the patch to the given resource ID
+| *patchByUrl* | | Specifies that the update should be performed as a conditional create against a given search URL
+|===
+
+The patch API method(s) has the following set of parameters listed in the table below:
+[width="100%",cols="2,2,4,2",options="header"]
+|===
+| Method | Parameter | Description | Type
| patchById | *extraParameters* | See ExtraParameters for a full list of parameters that can be passed, may be NULL | Map
| patchById | *id* | The resource ID to patch | IIdType
| patchById | *patchBody* | The body of the patch document serialized in either XML or JSON which conforms to \http://jsonpatch.com/ or \http://tools.ietf.org/html/rfc5261 | String
@@ -396,28 +546,55 @@ The API methods has the following set of options listed in the following table:
| patchByUrl | *url* | The search URL to use. The format of this URL should be of the form ResourceTypeParameters, for example: Patientname=Smith&identifier=13.2.4.11.4%7C847366 | String
|===
+In addition to the parameters above, the patch API can also use from the 46 endpoint query option
+which is listed in the _Query Parameters_ section.
==== meta
-The meta has 5 API method(s) which is represented by the following method signatures
+The meta API has 5 method(s) which is represented by the following method signatures
(an API method may have multiple signatures due to overloading):
+[source,java]
----
-org.hl7.fhir.instance.model.api.IBaseMetaType add(org.hl7.fhir.instance.model.api.IBaseMetaType meta, org.hl7.fhir.instance.model.api.IIdType id, java.util.Map<org.apache.camel.component.fhir.api.ExtraParameters, Object> extraParameters)
-org.hl7.fhir.instance.model.api.IBaseMetaType delete(org.hl7.fhir.instance.model.api.IBaseMetaType meta, org.hl7.fhir.instance.model.api.IIdType id, java.util.Map<org.apache.camel.component.fhir.api.ExtraParameters, Object> extraParameters)
-org.hl7.fhir.instance.model.api.IBaseMetaType getFromResource(Class<org.hl7.fhir.instance.model.api.IBaseMetaType> metaType, org.hl7.fhir.instance.model.api.IIdType id, java.util.Map<org.apache.camel.component.fhir.api.ExtraParameters, Object> extraParameters)
-org.hl7.fhir.instance.model.api.IBaseMetaType getFromServer(Class<org.hl7.fhir.instance.model.api.IBaseMetaType> metaType, java.util.Map<org.apache.camel.component.fhir.api.ExtraParameters, Object> extraParameters)
-org.hl7.fhir.instance.model.api.IBaseMetaType getFromType(Class<org.hl7.fhir.instance.model.api.IBaseMetaType> metaType, String resourceType, java.util.Map<org.apache.camel.component.fhir.api.ExtraParameters, Object> extraParameters)
+org.hl7.fhir.instance.model.api.IBaseMetaType add(org.hl7.fhir.instance.model.api.IBaseMetaType meta, org.hl7.fhir.instance.model.api.IIdType id, java.util.Map<org.apache.camel.component.fhir.api.ExtraParameters, Object> extraParameters);
+
+org.hl7.fhir.instance.model.api.IBaseMetaType delete(org.hl7.fhir.instance.model.api.IBaseMetaType meta, org.hl7.fhir.instance.model.api.IIdType id, java.util.Map<org.apache.camel.component.fhir.api.ExtraParameters, Object> extraParameters);
+
+org.hl7.fhir.instance.model.api.IBaseMetaType getFromResource(Class<org.hl7.fhir.instance.model.api.IBaseMetaType> metaType, org.hl7.fhir.instance.model.api.IIdType id, java.util.Map<org.apache.camel.component.fhir.api.ExtraParameters, Object> extraParameters);
+
+org.hl7.fhir.instance.model.api.IBaseMetaType getFromServer(Class<org.hl7.fhir.instance.model.api.IBaseMetaType> metaType, java.util.Map<org.apache.camel.component.fhir.api.ExtraParameters, Object> extraParameters);
+
+org.hl7.fhir.instance.model.api.IBaseMetaType getFromType(Class<org.hl7.fhir.instance.model.api.IBaseMetaType> metaType, String resourceType, java.util.Map<org.apache.camel.component.fhir.api.ExtraParameters, Object> extraParameters);
+
+----
+
+The meta API is defined in the syntax as follows:
+
+----
+fhir:meta/methodName?[parameters]
----
-The API methods has the following set of options listed in the following table:
-[width="100%",cols="1,2,5,2",options="header"]
+The 5 method(s) is listed in the table below.
+(API methods can have a shorthand alias name which can be used in the syntax instead of the name)
+
+[width="100%",cols="2,2,6",options="header"]
+|===
+| Method | Alias | Description
+| *add* | | Add the elements in the given metadata to the already existing set (do not remove any)
+| *delete* | | Delete the elements in the given metadata from the given id
+| *getFromResource* | | Fetch the current metadata from a specific resource
+| *getFromServer* | | Fetch the current metadata from the whole Server
+| *getFromType* | | Fetch the current metadata from a specific type
|===
-| Method | Name | Description | Type
+
+The meta API method(s) has the following set of parameters listed in the table below:
+[width="100%",cols="2,2,4,2",options="header"]
+|===
+| Method | Parameter | Description | Type
| add | *extraParameters* | See ExtraParameters for a full list of parameters that can be passed, may be NULL | Map
| add | *id* | The id | IIdType
| add | *meta* | The IBaseMetaType class | IBaseMetaType
@@ -434,26 +611,49 @@ The API methods has the following set of options listed in the following table:
| getFromType | *resourceType* | The resource type e.g Patient | String
|===
+In addition to the parameters above, the meta API can also use from the 46 endpoint query option
+which is listed in the _Query Parameters_ section.
==== history
-The history has 3 API method(s) which is represented by the following method signatures
+The history API has 3 method(s) which is represented by the following method signatures
(an API method may have multiple signatures due to overloading):
+[source,java]
----
-org.hl7.fhir.instance.model.api.IBaseBundle onInstance(org.hl7.fhir.instance.model.api.IIdType id, Class<org.hl7.fhir.instance.model.api.IBaseBundle> returnType, Integer count, java.util.Date cutoff, org.hl7.fhir.instance.model.api.IPrimitiveType<java.util.Date> iCutoff, java.util.Map<org.apache.camel.component.fhir.api.ExtraParameters, Object> extraParameters)
-org.hl7.fhir.instance.model.api.IBaseBundle onServer(Class<org.hl7.fhir.instance.model.api.IBaseBundle> returnType, Integer count, java.util.Date cutoff, org.hl7.fhir.instance.model.api.IPrimitiveType<java.util.Date> iCutoff, java.util.Map<org.apache.camel.component.fhir.api.ExtraParameters, Object> extraParameters)
-org.hl7.fhir.instance.model.api.IBaseBundle onType(Class<org.hl7.fhir.instance.model.api.IBaseResource> resourceType, Class<org.hl7.fhir.instance.model.api.IBaseBundle> returnType, Integer count, java.util.Date cutoff, org.hl7.fhir.instance.model.api.IPrimitiveType<java.util.Date> iCutoff, java.util.Map<org.apache.camel.component.fhir.api.ExtraParameters, Object> extraParameters)
+org.hl7.fhir.instance.model.api.IBaseBundle onInstance(org.hl7.fhir.instance.model.api.IIdType id, Class<org.hl7.fhir.instance.model.api.IBaseBundle> returnType, Integer count, java.util.Date cutoff, org.hl7.fhir.instance.model.api.IPrimitiveType<java.util.Date> iCutoff, java.util.Map<org.apache.camel.component.fhir.api.ExtraParameters, Object> extraParameters);
+
+org.hl7.fhir.instance.model.api.IBaseBundle onServer(Class<org.hl7.fhir.instance.model.api.IBaseBundle> returnType, Integer count, java.util.Date cutoff, org.hl7.fhir.instance.model.api.IPrimitiveType<java.util.Date> iCutoff, java.util.Map<org.apache.camel.component.fhir.api.ExtraParameters, Object> extraParameters);
+
+org.hl7.fhir.instance.model.api.IBaseBundle onType(Class<org.hl7.fhir.instance.model.api.IBaseResource> resourceType, Class<org.hl7.fhir.instance.model.api.IBaseBundle> returnType, Integer count, java.util.Date cutoff, org.hl7.fhir.instance.model.api.IPrimitiveType<java.util.Date> iCutoff, java.util.Map<org.apache.camel.component.fhir.api.ExtraParameters, Object> extraParameters);
+
+----
+
+The history API is defined in the syntax as follows:
+
+----
+fhir:history/methodName?[parameters]
----
-The API methods has the following set of options listed in the following table:
-[width="100%",cols="1,2,5,2",options="header"]
+The 3 method(s) is listed in the table below.
+(API methods can have a shorthand alias name which can be used in the syntax instead of the name)
+
+[width="100%",cols="2,2,6",options="header"]
+|===
+| Method | Alias | Description
+| *onInstance* | | Perform the operation across all versions of a specific resource (by ID and type) on the server
+| *onServer* | | Perform the operation across all versions of all resources of all types on the server
+| *onType* | | Perform the operation across all versions of all resources of the given type on the server
|===
-| Method | Name | Description | Type
+
+The history API method(s) has the following set of parameters listed in the table below:
+[width="100%",cols="2,2,4,2",options="header"]
+|===
+| Method | Parameter | Description | Type
| onInstance | *count* | Request that the server return only up to theCount number of resources, may be NULL | Integer
| onInstance | *cutoff* | Request that the server return only resource versions that were created at or after the given time (inclusive), may be NULL | Date
| onInstance | *extraParameters* | See ExtraParameters for a full list of parameters that can be passed, may be NULL | Map
@@ -473,26 +673,49 @@ The API methods has the following set of options listed in the following table:
| onType | *returnType* | Request that the method return a Bundle resource (such as ca.uhn.fhir.model.dstu2.resource.Bundle). Use this method if you are accessing a DSTU2 server. | Class
|===
+In addition to the parameters above, the history API can also use from the 46 endpoint query option
+which is listed in the _Query Parameters_ section.
==== load-page
-The load-page has 3 API method(s) which is represented by the following method signatures
+The load-page API has 3 method(s) which is represented by the following method signatures
(an API method may have multiple signatures due to overloading):
+[source,java]
----
-org.hl7.fhir.instance.model.api.IBaseBundle byUrl(String url, Class<org.hl7.fhir.instance.model.api.IBaseBundle> returnType, java.util.Map<org.apache.camel.component.fhir.api.ExtraParameters, Object> extraParameters)
-org.hl7.fhir.instance.model.api.IBaseBundle next(org.hl7.fhir.instance.model.api.IBaseBundle bundle, java.util.Map<org.apache.camel.component.fhir.api.ExtraParameters, Object> extraParameters)
-org.hl7.fhir.instance.model.api.IBaseBundle previous(org.hl7.fhir.instance.model.api.IBaseBundle bundle, java.util.Map<org.apache.camel.component.fhir.api.ExtraParameters, Object> extraParameters)
+
+org.hl7.fhir.instance.model.api.IBaseBundle byUrl(String url, Class<org.hl7.fhir.instance.model.api.IBaseBundle> returnType, java.util.Map<org.apache.camel.component.fhir.api.ExtraParameters, Object> extraParameters);
+
+org.hl7.fhir.instance.model.api.IBaseBundle next(org.hl7.fhir.instance.model.api.IBaseBundle bundle, java.util.Map<org.apache.camel.component.fhir.api.ExtraParameters, Object> extraParameters);
+
+org.hl7.fhir.instance.model.api.IBaseBundle previous(org.hl7.fhir.instance.model.api.IBaseBundle bundle, java.util.Map<org.apache.camel.component.fhir.api.ExtraParameters, Object> extraParameters);
----
-The API methods has the following set of options listed in the following table:
-[width="100%",cols="1,2,5,2",options="header"]
+The load-page API is defined in the syntax as follows:
+
+----
+fhir:load-page/methodName?[parameters]
+----
+
+The 3 method(s) is listed in the table below.
+(API methods can have a shorthand alias name which can be used in the syntax instead of the name)
+
+[width="100%",cols="2,2,6",options="header"]
+|===
+| Method | Alias | Description
+| *byUrl* | | Load a page of results using the given URL and bundle type and return a DSTU1 Atom bundle
+| *next* | | Load the next page of results using the link with relation next in the bundle
+| *previous* | | Load the previous page of results using the link with relation prev in the bundle
+|===
+
+The load-page API method(s) has the following set of parameters listed in the table below:
+[width="100%",cols="2,2,4,2",options="header"]
|===
-| Method | Name | Description | Type
+| Method | Parameter | Description | Type
| byUrl | *extraParameters* | See ExtraParameters for a full list of parameters that can be passed, may be NULL | Map
| byUrl | *returnType* | The return type | Class
| byUrl | *url* | The search url | String
@@ -502,26 +725,48 @@ The API methods has the following set of options listed in the following table:
| previous | *extraParameters* | See ExtraParameters for a full list of parameters that can be passed, may be NULL | Map
|===
+In addition to the parameters above, the load-page API can also use from the 46 endpoint query option
+which is listed in the _Query Parameters_ section.
==== transaction
-The transaction has 2 API method(s) which is represented by the following method signatures
+The transaction API has 2 method(s) which is represented by the following method signatures
(an API method may have multiple signatures due to overloading):
+[source,java]
+----
+
+String withBundle(String stringBundle, java.util.Map<org.apache.camel.component.fhir.api.ExtraParameters, Object> extraParameters);
+
+org.hl7.fhir.instance.model.api.IBaseBundle withBundle(org.hl7.fhir.instance.model.api.IBaseBundle bundle, java.util.Map<org.apache.camel.component.fhir.api.ExtraParameters, Object> extraParameters);
+
+java.util.List<org.hl7.fhir.instance.model.api.IBaseResource> withResources(java.util.List<org.hl7.fhir.instance.model.api.IBaseResource> resources, java.util.Map<org.apache.camel.component.fhir.api.ExtraParameters, Object> extraParameters);
+
----
-String withBundle(String stringBundle, java.util.Map<org.apache.camel.component.fhir.api.ExtraParameters, Object> extraParameters)
-org.hl7.fhir.instance.model.api.IBaseBundle withBundle(org.hl7.fhir.instance.model.api.IBaseBundle bundle, java.util.Map<org.apache.camel.component.fhir.api.ExtraParameters, Object> extraParameters)
-java.util.List<org.hl7.fhir.instance.model.api.IBaseResource> withResources(java.util.List<org.hl7.fhir.instance.model.api.IBaseResource> resources, java.util.Map<org.apache.camel.component.fhir.api.ExtraParameters, Object> extraParameters)
+The transaction API is defined in the syntax as follows:
+
+----
+fhir:transaction/methodName?[parameters]
----
-The API methods has the following set of options listed in the following table:
-[width="100%",cols="1,2,5,2",options="header"]
+The 2 method(s) is listed in the table below.
+(API methods can have a shorthand alias name which can be used in the syntax instead of the name)
+
+[width="100%",cols="2,2,6",options="header"]
+|===
+| Method | Alias | Description
+| *withBundle* | | Use the given raw text (should be a Bundle resource) as the transaction input
+| *withResources* | | Use a list of resources as the transaction input
+|===
+
+The transaction API method(s) has the following set of parameters listed in the table below:
+[width="100%",cols="2,2,4,2",options="header"]
|===
-| Method | Name | Description | Type
+| Method | Parameter | Description | Type
| withBundle | *bundle* | Bundle to use in the transaction | IBaseBundle
| withBundle | *extraParameters* | See ExtraParameters for a full list of parameters that can be passed, may be NULL | Map
| withBundle | *stringBundle* | Bundle to use in the transaction | String
@@ -529,33 +774,62 @@ The API methods has the following set of options listed in the following table:
| withResources | *resources* | Resources to use in the transaction | List
|===
+In addition to the parameters above, the transaction API can also use from the 46 endpoint query option
+which is listed in the _Query Parameters_ section.
==== read
-The read has 2 API method(s) which is represented by the following method signatures
+The read API has 2 method(s) which is represented by the following method signatures
(an API method may have multiple signatures due to overloading):
+[source,java]
+----
+
+org.hl7.fhir.instance.model.api.IBaseResource resourceById(Class<org.hl7.fhir.instance.model.api.IBaseResource> resource, Long longId, String ifVersionMatches, Boolean returnNull, org.hl7.fhir.instance.model.api.IBaseResource returnResource, Boolean throwError, java.util.Map<org.apache.camel.component.fhir.api.ExtraParameters, Object> extraParameters);
+
+org.hl7.fhir.instance.model.api.IBaseResource resourceById(Class<org.hl7.fhir.instance.model.api.IBaseResource> resource, String stringId, String version, String ifVersionMatches, Boolean returnNull, org.hl7.fhir.instance.model.api.IBaseResource returnResource, Boolean throwError, java.util.Map<org.apache.camel.component.fhir.api.ExtraParameters, Object> extraParameters);
+
+org.hl7.fhir.instance.model.api.IBaseResource resourceById(Class<org.hl7.fhir.instance.model.api.IBaseResource> resource, org.hl7.fhir.instance.model.api.IIdType id, String ifVersionMatches, Boolean returnNull, org.hl7.fhir.instance.model.api.IBaseResource returnResource, Boolean throwError, java.util.Map<org.apache.camel.component.fhir.api.ExtraParameters, Object> extraParameters);
+
+org.hl7.fhir.instance.model.api.IBaseResource resourceById(String resourceClass, Long longId, String ifVersionMatches, Boolean returnNull, org.hl7.fhir.instance.model.api.IBaseResource returnResource, Boolean throwError, java.util.Map<org.apache.camel.component.fhir.api.ExtraParameters, Object> extraParameters);
+
+org.hl7.fhir.instance.model.api.IBaseResource resourceById(String resourceClass, String stringId, String ifVersionMatches, String version, Boolean returnNull, org.hl7.fhir.instance.model.api.IBaseResource returnResource, Boolean throwError, java.util.Map<org.apache.camel.component.fhir.api.ExtraParameters, Object> extraParameters);
+
+org.hl7.fhir.instance.model.api.IBaseResource resourceById(String resourceClass, org.hl7.fhir.instance.model.api.IIdType id, String ifVersionMatches, Boolean returnNull, org.hl7.fhir.instance.model.api.IBaseResource returnResource, Boolean throwError, java.util.Map<org.apache.camel.component.fhir.api.ExtraParameters, Object> extraParameters);
+
+org.hl7.fhir.instance.model.api.IBaseResource resourceByUrl(Class<org.hl7.fhir.instance.model.api.IBaseResource> resource, String url, String ifVersionMatches, Boolean returnNull, org.hl7.fhir.instance.model.api.IBaseResource returnResource, Boolean throwError, java.util.Map<org.apache.camel.component.fhir.api.ExtraParameters, Object> extraParameters);
+
+org.hl7.fhir.instance.model.api.IBaseResource resourceByUrl(Class<org.hl7.fhir.instance.model.api.IBaseResource> resource, org.hl7.fhir.instance.model.api.IIdType iUrl, String ifVersionMatches, Boolean returnNull, org.hl7.fhir.instance.model.api.IBaseResource returnResource, Boolean throwError, java.util.Map<org.apache.camel.component.fhir.api.ExtraParameters, Object> extraParameters);
+
+org.hl7.fhir.instance.model.api.IBaseResource resourceByUrl(String resourceClass, String url, String ifVersionMatches, Boolean returnNull, org.hl7.fhir.instance.model.api.IBaseResource returnResource, Boolean throwError, java.util.Map<org.apache.camel.component.fhir.api.ExtraParameters, Object> extraParameters);
+
+org.hl7.fhir.instance.model.api.IBaseResource resourceByUrl(String resourceClass, org.hl7.fhir.instance.model.api.IIdType iUrl, String ifVersionMatches, Boolean returnNull, org.hl7.fhir.instance.model.api.IBaseResource returnResource, Boolean throwError, java.util.Map<org.apache.camel.component.fhir.api.ExtraParameters, Object> extraParameters);
+
----
-org.hl7.fhir.instance.model.api.IBaseResource resourceById(Class<org.hl7.fhir.instance.model.api.IBaseResource> resource, Long longId, String ifVersionMatches, Boolean returnNull, org.hl7.fhir.instance.model.api.IBaseResource returnResource, Boolean throwError, java.util.Map<org.apache.camel.component.fhir.api.ExtraParameters, Object> extraParameters)
-org.hl7.fhir.instance.model.api.IBaseResource resourceById(Class<org.hl7.fhir.instance.model.api.IBaseResource> resource, String stringId, String version, String ifVersionMatches, Boolean returnNull, org.hl7.fhir.instance.model.api.IBaseResource returnResource, Boolean throwError, java.util.Map<org.apache.camel.component.fhir.api.ExtraParameters, Object> extraParameters)
-org.hl7.fhir.instance.model.api.IBaseResource resourceById(Class<org.hl7.fhir.instance.model.api.IBaseResource> resource, org.hl7.fhir.instance.model.api.IIdType id, String ifVersionMatches, Boolean returnNull, org.hl7.fhir.instance.model.api.IBaseResource returnResource, Boolean throwError, java.util.Map<org.apache.camel.component.fhir.api.ExtraParameters, Object> extraParameters)
-org.hl7.fhir.instance.model.api.IBaseResource resourceById(String resourceClass, Long longId, String ifVersionMatches, Boolean returnNull, org.hl7.fhir.instance.model.api.IBaseResource returnResource, Boolean throwError, java.util.Map<org.apache.camel.component.fhir.api.ExtraParameters, Object> extraParameters)
-org.hl7.fhir.instance.model.api.IBaseResource resourceById(String resourceClass, String stringId, String ifVersionMatches, String version, Boolean returnNull, org.hl7.fhir.instance.model.api.IBaseResource returnResource, Boolean throwError, java.util.Map<org.apache.camel.component.fhir.api.ExtraParameters, Object> extraParameters)
-org.hl7.fhir.instance.model.api.IBaseResource resourceById(String resourceClass, org.hl7.fhir.instance.model.api.IIdType id, String ifVersionMatches, Boolean returnNull, org.hl7.fhir.instance.model.api.IBaseResource returnResource, Boolean throwError, java.util.Map<org.apache.camel.component.fhir.api.ExtraParameters, Object> extraParameters)
-org.hl7.fhir.instance.model.api.IBaseResource resourceByUrl(Class<org.hl7.fhir.instance.model.api.IBaseResource> resource, String url, String ifVersionMatches, Boolean returnNull, org.hl7.fhir.instance.model.api.IBaseResource returnResource, Boolean throwError, java.util.Map<org.apache.camel.component.fhir.api.ExtraParameters, Object> extraParameters)
-org.hl7.fhir.instance.model.api.IBaseResource resourceByUrl(Class<org.hl7.fhir.instance.model.api.IBaseResource> resource, org.hl7.fhir.instance.model.api.IIdType iUrl, String ifVersionMatches, Boolean returnNull, org.hl7.fhir.instance.model.api.IBaseResource returnResource, Boolean throwError, java.util.Map<org.apache.camel.component.fhir.api.ExtraParameters, Object> extraParameters)
-org.hl7.fhir.instance.model.api.IBaseResource resourceByUrl(String resourceClass, String url, String ifVersionMatches, Boolean returnNull, org.hl7.fhir.instance.model.api.IBaseResource returnResource, Boolean throwError, java.util.Map<org.apache.camel.component.fhir.api.ExtraParameters, Object> extraParameters)
-org.hl7.fhir.instance.model.api.IBaseResource resourceByUrl(String resourceClass, org.hl7.fhir.instance.model.api.IIdType iUrl, String ifVersionMatches, Boolean returnNull, org.hl7.fhir.instance.model.api.IBaseResource returnResource, Boolean throwError, java.util.Map<org.apache.camel.component.fhir.api.ExtraParameters, Object> extraParameters)
+The read API is defined in the syntax as follows:
+
+----
+fhir:read/methodName?[parameters]
----
-The API methods has the following set of options listed in the following table:
-[width="100%",cols="1,2,5,2",options="header"]
+The 2 method(s) is listed in the table below.
+(API methods can have a shorthand alias name which can be used in the syntax instead of the name)
+
+[width="100%",cols="2,2,6",options="header"]
+|===
+| Method | Alias | Description
+| *resourceById* | |
+| *resourceByUrl* | |
+|===
+
+The read API method(s) has the following set of parameters listed in the table below:
+[width="100%",cols="2,2,4,2",options="header"]
|===
-| Method | Name | Description | Type
+| Method | Parameter | Description | Type
| resourceById | *extraParameters* | | Map
| resourceById | *id* | | IIdType
| resourceById | *ifVersionMatches* | | String
@@ -578,27 +852,51 @@ The API methods has the following set of options listed in the following table:
| resourceByUrl | *url* | | String
|===
+In addition to the parameters above, the read API can also use from the 46 endpoint query option
+which is listed in the _Query Parameters_ section.
==== delete
-The delete has 3 API method(s) which is represented by the following method signatures
+The delete API has 3 method(s) which is represented by the following method signatures
(an API method may have multiple signatures due to overloading):
+[source,java]
----
-org.hl7.fhir.instance.model.api.IBaseOperationOutcome resource(org.hl7.fhir.instance.model.api.IBaseResource resource, java.util.Map<org.apache.camel.component.fhir.api.ExtraParameters, Object> extraParameters)
-org.hl7.fhir.instance.model.api.IBaseOperationOutcome resourceById(String type, String stringId, java.util.Map<org.apache.camel.component.fhir.api.ExtraParameters, Object> extraParameters)
-org.hl7.fhir.instance.model.api.IBaseOperationOutcome resourceById(org.hl7.fhir.instance.model.api.IIdType id, java.util.Map<org.apache.camel.component.fhir.api.ExtraParameters, Object> extraParameters)
-org.hl7.fhir.instance.model.api.IBaseOperationOutcome resourceConditionalByUrl(String url, java.util.Map<org.apache.camel.component.fhir.api.ExtraParameters, Object> extraParameters)
+
+org.hl7.fhir.instance.model.api.IBaseOperationOutcome resource(org.hl7.fhir.instance.model.api.IBaseResource resource, java.util.Map<org.apache.camel.component.fhir.api.ExtraParameters, Object> extraParameters);
+
+org.hl7.fhir.instance.model.api.IBaseOperationOutcome resourceById(String type, String stringId, java.util.Map<org.apache.camel.component.fhir.api.ExtraParameters, Object> extraParameters);
+
+org.hl7.fhir.instance.model.api.IBaseOperationOutcome resourceById(org.hl7.fhir.instance.model.api.IIdType id, java.util.Map<org.apache.camel.component.fhir.api.ExtraParameters, Object> extraParameters);
+
+org.hl7.fhir.instance.model.api.IBaseOperationOutcome resourceConditionalByUrl(String url, java.util.Map<org.apache.camel.component.fhir.api.ExtraParameters, Object> extraParameters);
----
-The API methods has the following set of options listed in the following table:
-[width="100%",cols="1,2,5,2",options="header"]
+The delete API is defined in the syntax as follows:
+
+----
+fhir:delete/methodName?[parameters]
+----
+
+The 3 method(s) is listed in the table below.
+(API methods can have a shorthand alias name which can be used in the syntax instead of the name)
+
+[width="100%",cols="2,2,6",options="header"]
|===
-| Method | Name | Description | Type
+| Method | Alias | Description
+| *resource* | | Deletes the given resource
+| *resourceById* | | Deletes the resource by resource type e
+| *resourceConditionalByUrl* | | Specifies that the delete should be performed as a conditional delete against a given search URL
+|===
+
+The delete API method(s) has the following set of parameters listed in the table below:
+[width="100%",cols="2,2,4,2",options="header"]
+|===
+| Method | Parameter | Description | Type
| resource | *extraParameters* | See ExtraParameters for a full list of parameters that can be passed, may be NULL | Map
| resource | *resource* | The IBaseResource to delete | IBaseResource
| resourceById | *extraParameters* | See ExtraParameters for a full list of parameters that can be passed, may be NULL | Map
@@ -608,6 +906,9 @@ The API methods has the following set of options listed in the following table:
| resourceConditionalByUrl | *extraParameters* | See ExtraParameters for a full list of parameters that can be passed, may be NULL | Map
| resourceConditionalByUrl | *url* | The search URL to use. The format of this URL should be of the form ResourceTypeParameters, for example: Patientname=Smith&identifier=13.2.4.11.4%7C847366 | String
|===
+
+In addition to the parameters above, the delete API can also use from the 46 endpoint query option
+which is listed in the _Query Parameters_ section.
// endpoint options: END
include::camel-spring-boot::page$fhir-starter.adoc[]
diff --git a/components/camel-google-calendar/src/main/docs/google-calendar-component.adoc b/components/camel-google-calendar/src/main/docs/google-calendar-component.adoc
index 435dfef..5864b34 100644
--- a/components/camel-google-calendar/src/main/docs/google-calendar-component.adoc
+++ b/components/camel-google-calendar/src/main/docs/google-calendar-component.adoc
@@ -156,72 +156,149 @@ The following lists each API name and method and its additional parameters.
==== settings
-The settings has 2 API method(s) which is represented by the following method signatures
+The settings API has 2 method(s) which is represented by the following method signatures
(an API method may have multiple signatures due to overloading):
+[source,java]
----
-com.google.api.services.calendar.Calendar$Settings$Get get(String setting)
-com.google.api.services.calendar.Calendar$Settings$Watch watch(com.google.api.services.calendar.model.Channel content)
+com.google.api.services.calendar.Calendar.Settings.Get get(String setting);
+
+com.google.api.services.calendar.Calendar.Settings.Watch watch(com.google.api.services.calendar.model.Channel content);
+
+----
+
+The settings API is defined in the syntax as follows:
+
+----
+google-calendar:settings/methodName?[parameters]
----
-The API methods has the following set of options listed in the following table:
-[width="100%",cols="1,2,5,2",options="header"]
+The 2 method(s) is listed in the table below.
+(API methods can have a shorthand alias name which can be used in the syntax instead of the name)
+
+[width="100%",cols="2,2,6",options="header"]
+|===
+| Method | Alias | Description
+| *get* | | Returns a single user setting
+| *watch* | | Watch for changes to Settings resources
+|===
+
+The settings API method(s) has the following set of parameters listed in the table below:
+[width="100%",cols="2,2,4,2",options="header"]
|===
-| Method | Name | Description | Type
+| Method | Parameter | Description | Type
| get | *setting* | The id of the user setting | String
| watch | *contentChannel* | The com.google.api.services.calendar.model.Channel | Channel
|===
+In addition to the parameters above, the settings API can also use from the 32 endpoint query option
+which is listed in the _Query Parameters_ section.
==== freebusy
-The freebusy has 1 API method(s) which is represented by the following method signatures
+The freebusy API has 1 method(s) which is represented by the following method signatures
(an API method may have multiple signatures due to overloading):
+[source,java]
----
-com.google.api.services.calendar.Calendar$Freebusy$Query query(com.google.api.services.calendar.model.FreeBusyRequest content)
+
+com.google.api.services.calendar.Calendar.Freebusy.Query query(com.google.api.services.calendar.model.FreeBusyRequest content);
----
-The API methods has the following set of options listed in the following table:
-[width="100%",cols="1,2,5,2",options="header"]
+The freebusy API is defined in the syntax as follows:
+
+----
+google-calendar:freebusy/methodName?[parameters]
+----
+
+The 1 method(s) is listed in the table below.
+(API methods can have a shorthand alias name which can be used in the syntax instead of the name)
+
+[width="100%",cols="2,2,6",options="header"]
+|===
+| Method | Alias | Description
+| *query* | | Returns free/busy information for a set of calendars
|===
-| Method | Name | Description | Type
+
+The freebusy API method(s) has the following set of parameters listed in the table below:
+[width="100%",cols="2,2,4,2",options="header"]
+|===
+| Method | Parameter | Description | Type
| query | *content* | The com.google.api.services.calendar.model.FreeBusyRequest | FreeBusyRequest
|===
+In addition to the parameters above, the freebusy API can also use from the 32 endpoint query option
+which is listed in the _Query Parameters_ section.
==== events
-The events has 11 API method(s) which is represented by the following method signatures
+The events API has 11 method(s) which is represented by the following method signatures
(an API method may have multiple signatures due to overloading):
+[source,java]
+----
+
+com.google.api.services.calendar.Calendar.Events.CalendarImport calendarImport(String calendarId, com.google.api.services.calendar.model.Event content);
+
+com.google.api.services.calendar.Calendar.Events.Delete delete(String calendarId, String eventId);
+
+com.google.api.services.calendar.Calendar.Events.Get get(String calendarId, String eventId);
+
+com.google.api.services.calendar.Calendar.Events.Insert insert(String calendarId, com.google.api.services.calendar.model.Event content);
+
+com.google.api.services.calendar.Calendar.Events.Instances instances(String calendarId, String eventId);
+
+com.google.api.services.calendar.Calendar.Events.List list(String calendarId);
+
+com.google.api.services.calendar.Calendar.Events.Move move(String calendarId, String eventId, String destination);
+
+com.google.api.services.calendar.Calendar.Events.Patch patch(String calendarId, String eventId, com.google.api.services.calendar.model.Event content);
+
+com.google.api.services.calendar.Calendar.Events.QuickAdd quickAdd(String calendarId, String text);
+
+com.google.api.services.calendar.Calendar.Events.Update update(String calendarId, String eventId, com.google.api.services.calendar.model.Event content);
+
+com.google.api.services.calendar.Calendar.Events.Watch watch(String calendarId, com.google.api.services.calendar.model.Channel content);
+
----
-com.google.api.services.calendar.Calendar$Events$CalendarImport calendarImport(String calendarId, com.google.api.services.calendar.model.Event content)
-com.google.api.services.calendar.Calendar$Events$Delete delete(String calendarId, String eventId)
-com.google.api.services.calendar.Calendar$Events$Get get(String calendarId, String eventId)
-com.google.api.services.calendar.Calendar$Events$Insert insert(String calendarId, com.google.api.services.calendar.model.Event content)
-com.google.api.services.calendar.Calendar$Events$Instances instances(String calendarId, String eventId)
-com.google.api.services.calendar.Calendar$Events$List list(String calendarId)
-com.google.api.services.calendar.Calendar$Events$Move move(String calendarId, String eventId, String destination)
-com.google.api.services.calendar.Calendar$Events$Patch patch(String calendarId, String eventId, com.google.api.services.calendar.model.Event content)
-com.google.api.services.calendar.Calendar$Events$QuickAdd quickAdd(String calendarId, String text)
-com.google.api.services.calendar.Calendar$Events$Update update(String calendarId, String eventId, com.google.api.services.calendar.model.Event content)
-com.google.api.services.calendar.Calendar$Events$Watch watch(String calendarId, com.google.api.services.calendar.model.Channel content)
+The events API is defined in the syntax as follows:
+
+----
+google-calendar:events/methodName?[parameters]
----
-The API methods has the following set of options listed in the following table:
-[width="100%",cols="1,2,5,2",options="header"]
+The 11 method(s) is listed in the table below.
+(API methods can have a shorthand alias name which can be used in the syntax instead of the name)
+
+[width="100%",cols="2,2,6",options="header"]
|===
-| Method | Name | Description | Type
+| Method | Alias | Description
+| *calendarImport* | | Imports an event
+| *delete* | | Deletes an event
+| *get* | | Returns an event
+| *insert* | | Creates an event
+| *instances* | | Returns instances of the specified recurring event
+| *list* | | Returns events on the specified calendar
+| *move* | | Moves an event to another calendar, i
+| *patch* | | Updates an event
+| *quickAdd* | | Creates an event based on a simple text string
+| *update* | | Updates an event
+| *watch* | | Watch for changes to Events resources
+|===
+
+The events API method(s) has the following set of parameters listed in the table below:
+[width="100%",cols="2,2,4,2",options="header"]
+|===
+| Method | Parameter | Description | Type
| calendarImport | *calendarId* | Calendar identifier. To retrieve calendar IDs call the calendarList.list method. If you want to access the primary calendar of the currently logged in user, use the primary keyword. | String
| calendarImport | *content* | The com.google.api.services.calendar.model.Event | Event
| delete | *calendarId* | Calendar identifier. To retrieve calendar IDs call the calendarList.list method. If you want to access the primary calendar of the currently logged in user, use the primary keyword. | String
@@ -248,51 +325,101 @@ The API methods has the following set of options listed in the following table:
| watch | *contentChannel* | The com.google.api.services.calendar.model.Channel | Channel
|===
+In addition to the parameters above, the events API can also use from the 32 endpoint query option
+which is listed in the _Query Parameters_ section.
==== channels
-The channels has 1 API method(s) which is represented by the following method signatures
+The channels API has 1 method(s) which is represented by the following method signatures
(an API method may have multiple signatures due to overloading):
+[source,java]
----
-com.google.api.services.calendar.Calendar$Channels$Stop stop(com.google.api.services.calendar.model.Channel content)
+
+com.google.api.services.calendar.Calendar.Channels.Stop stop(com.google.api.services.calendar.model.Channel content);
----
-The API methods has the following set of options listed in the following table:
-[width="100%",cols="1,2,5,2",options="header"]
+The channels API is defined in the syntax as follows:
+
+----
+google-calendar:channels/methodName?[parameters]
+----
+
+The 1 method(s) is listed in the table below.
+(API methods can have a shorthand alias name which can be used in the syntax instead of the name)
+
+[width="100%",cols="2,2,6",options="header"]
|===
-| Method | Name | Description | Type
+| Method | Alias | Description
+| *stop* | | Stop watching resources through this channel
+|===
+
+The channels API method(s) has the following set of parameters listed in the table below:
+[width="100%",cols="2,2,4,2",options="header"]
+|===
+| Method | Parameter | Description | Type
| stop | *contentChannel* | The com.google.api.services.calendar.model.Channel | Channel
|===
+In addition to the parameters above, the channels API can also use from the 32 endpoint query option
+which is listed in the _Query Parameters_ section.
==== acl
-The acl has 7 API method(s) which is represented by the following method signatures
+The acl API has 7 method(s) which is represented by the following method signatures
(an API method may have multiple signatures due to overloading):
+[source,java]
+----
+
+com.google.api.services.calendar.Calendar.Acl.Delete delete(String calendarId, String ruleId);
+
+com.google.api.services.calendar.Calendar.Acl.Get get(String calendarId, String ruleId);
+
+com.google.api.services.calendar.Calendar.Acl.Insert insert(String calendarId, com.google.api.services.calendar.model.AclRule content);
+
+com.google.api.services.calendar.Calendar.Acl.List list(String calendarId);
+
+com.google.api.services.calendar.Calendar.Acl.Patch patch(String calendarId, String ruleId, com.google.api.services.calendar.model.AclRule content);
+
+com.google.api.services.calendar.Calendar.Acl.Update update(String calendarId, String ruleId, com.google.api.services.calendar.model.AclRule content);
+
+com.google.api.services.calendar.Calendar.Acl.Watch watch(String calendarId, com.google.api.services.calendar.model.Channel content);
+
----
-com.google.api.services.calendar.Calendar$Acl$Delete delete(String calendarId, String ruleId)
-com.google.api.services.calendar.Calendar$Acl$Get get(String calendarId, String ruleId)
-com.google.api.services.calendar.Calendar$Acl$Insert insert(String calendarId, com.google.api.services.calendar.model.AclRule content)
-com.google.api.services.calendar.Calendar$Acl$List list(String calendarId)
-com.google.api.services.calendar.Calendar$Acl$Patch patch(String calendarId, String ruleId, com.google.api.services.calendar.model.AclRule content)
-com.google.api.services.calendar.Calendar$Acl$Update update(String calendarId, String ruleId, com.google.api.services.calendar.model.AclRule content)
-com.google.api.services.calendar.Calendar$Acl$Watch watch(String calendarId, com.google.api.services.calendar.model.Channel content)
+The acl API is defined in the syntax as follows:
+
+----
+google-calendar:acl/methodName?[parameters]
----
-The API methods has the following set of options listed in the following table:
-[width="100%",cols="1,2,5,2",options="header"]
+The 7 method(s) is listed in the table below.
+(API methods can have a shorthand alias name which can be used in the syntax instead of the name)
+
+[width="100%",cols="2,2,6",options="header"]
+|===
+| Method | Alias | Description
+| *delete* | | Deletes an access control rule
+| *get* | | Returns an access control rule
+| *insert* | | Creates an access control rule
+| *list* | | Returns the rules in the access control list for the calendar
+| *patch* | | Updates an access control rule
+| *update* | | Updates an access control rule
+| *watch* | | Watch for changes to ACL resources
+|===
+
+The acl API method(s) has the following set of parameters listed in the table below:
+[width="100%",cols="2,2,4,2",options="header"]
|===
-| Method | Name | Description | Type
+| Method | Parameter | Description | Type
| delete | *calendarId* | Calendar identifier. To retrieve calendar IDs call the calendarList.list method. If you want to access the primary calendar of the currently logged in user, use the primary keyword. | String
| delete | *ruleId* | ACL rule identifier | String
| get | *calendarId* | Calendar identifier. To retrieve calendar IDs call the calendarList.list method. If you want to access the primary calendar of the currently logged in user, use the primary keyword. | String
@@ -310,29 +437,58 @@ The API methods has the following set of options listed in the following table:
| watch | *contentChannel* | The com.google.api.services.calendar.model.Channel | Channel
|===
+In addition to the parameters above, the acl API can also use from the 32 endpoint query option
+which is listed in the _Query Parameters_ section.
==== calendars
-The calendars has 6 API method(s) which is represented by the following method signatures
+The calendars API has 6 method(s) which is represented by the following method signatures
(an API method may have multiple signatures due to overloading):
+[source,java]
----
-com.google.api.services.calendar.Calendar$Calendars$Clear clear(String calendarId)
-com.google.api.services.calendar.Calendar$Calendars$Delete delete(String calendarId)
-com.google.api.services.calendar.Calendar$Calendars$Get get(String calendarId)
-com.google.api.services.calendar.Calendar$Calendars$Insert insert(com.google.api.services.calendar.model.Calendar content)
-com.google.api.services.calendar.Calendar$Calendars$Patch patch(String calendarId, com.google.api.services.calendar.model.Calendar content)
-com.google.api.services.calendar.Calendar$Calendars$Update update(String calendarId, com.google.api.services.calendar.model.Calendar content)
+
+com.google.api.services.calendar.Calendar.Calendars.Clear clear(String calendarId);
+
+com.google.api.services.calendar.Calendar.Calendars.Delete delete(String calendarId);
+
+com.google.api.services.calendar.Calendar.Calendars.Get get(String calendarId);
+
+com.google.api.services.calendar.Calendar.Calendars.Insert insert(com.google.api.services.calendar.model.Calendar content);
+
+com.google.api.services.calendar.Calendar.Calendars.Patch patch(String calendarId, com.google.api.services.calendar.model.Calendar content);
+
+com.google.api.services.calendar.Calendar.Calendars.Update update(String calendarId, com.google.api.services.calendar.model.Calendar content);
----
-The API methods has the following set of options listed in the following table:
-[width="100%",cols="1,2,5,2",options="header"]
+The calendars API is defined in the syntax as follows:
+
+----
+google-calendar:calendars/methodName?[parameters]
+----
+
+The 6 method(s) is listed in the table below.
+(API methods can have a shorthand alias name which can be used in the syntax instead of the name)
+
+[width="100%",cols="2,2,6",options="header"]
+|===
+| Method | Alias | Description
+| *clear* | | Clears a primary calendar
+| *delete* | | Deletes a secondary calendar
+| *get* | | Returns metadata for a calendar
+| *insert* | | Creates a secondary calendar
+| *patch* | | Updates metadata for a calendar
+| *update* | | Updates metadata for a calendar
|===
-| Method | Name | Description | Type
+
+The calendars API method(s) has the following set of parameters listed in the table below:
+[width="100%",cols="2,2,4,2",options="header"]
+|===
+| Method | Parameter | Description | Type
| clear | *calendarId* | Calendar identifier. To retrieve calendar IDs call the calendarList.list method. If you want to access the primary calendar of the currently logged in user, use the primary keyword. | String
| delete | *calendarId* | Calendar identifier. To retrieve calendar IDs call the calendarList.list method. If you want to access the primary calendar of the currently logged in user, use the primary keyword. | String
| get | *calendarId* | Calendar identifier. To retrieve calendar IDs call the calendarList.list method. If you want to access the primary calendar of the currently logged in user, use the primary keyword. | String
@@ -343,29 +499,58 @@ The API methods has the following set of options listed in the following table:
| update | *content* | The com.google.api.services.calendar.model.Calendar | Calendar
|===
+In addition to the parameters above, the calendars API can also use from the 32 endpoint query option
+which is listed in the _Query Parameters_ section.
==== list
-The list has 6 API method(s) which is represented by the following method signatures
+The list API has 6 method(s) which is represented by the following method signatures
(an API method may have multiple signatures due to overloading):
+[source,java]
+----
+
+com.google.api.services.calendar.Calendar.CalendarList.Delete delete(String calendarId);
+
+com.google.api.services.calendar.Calendar.CalendarList.Get get(String calendarId);
+
+com.google.api.services.calendar.Calendar.CalendarList.Insert insert(com.google.api.services.calendar.model.CalendarListEntry content);
+
+com.google.api.services.calendar.Calendar.CalendarList.Patch patch(String calendarId, com.google.api.services.calendar.model.CalendarListEntry content);
+
+com.google.api.services.calendar.Calendar.CalendarList.Update update(String calendarId, com.google.api.services.calendar.model.CalendarListEntry content);
+
+com.google.api.services.calendar.Calendar.CalendarList.Watch watch(com.google.api.services.calendar.model.Channel content);
+
----
-com.google.api.services.calendar.Calendar$CalendarList$Delete delete(String calendarId)
-com.google.api.services.calendar.Calendar$CalendarList$Get get(String calendarId)
-com.google.api.services.calendar.Calendar$CalendarList$Insert insert(com.google.api.services.calendar.model.CalendarListEntry content)
-com.google.api.services.calendar.Calendar$CalendarList$Patch patch(String calendarId, com.google.api.services.calendar.model.CalendarListEntry content)
-com.google.api.services.calendar.Calendar$CalendarList$Update update(String calendarId, com.google.api.services.calendar.model.CalendarListEntry content)
-com.google.api.services.calendar.Calendar$CalendarList$Watch watch(com.google.api.services.calendar.model.Channel content)
+The list API is defined in the syntax as follows:
+
+----
+google-calendar:list/methodName?[parameters]
----
-The API methods has the following set of options listed in the following table:
-[width="100%",cols="1,2,5,2",options="header"]
+The 6 method(s) is listed in the table below.
+(API methods can have a shorthand alias name which can be used in the syntax instead of the name)
+
+[width="100%",cols="2,2,6",options="header"]
+|===
+| Method | Alias | Description
+| *delete* | | Deletes an entry on the user's calendar list
+| *get* | | Returns an entry on the user's calendar list
+| *insert* | | Adds an entry to the user's calendar list
+| *patch* | | Updates an entry on the user's calendar list
+| *update* | | Updates an entry on the user's calendar list
+| *watch* | | Watch for changes to CalendarList resources
|===
-| Method | Name | Description | Type
+
+The list API method(s) has the following set of parameters listed in the table below:
+[width="100%",cols="2,2,4,2",options="header"]
+|===
+| Method | Parameter | Description | Type
| delete | *calendarId* | Calendar identifier. To retrieve calendar IDs call the calendarList.list method. If you want to access the primary calendar of the currently logged in user, use the primary keyword. | String
| get | *calendarId* | Calendar identifier. To retrieve calendar IDs call the calendarList.list method. If you want to access the primary calendar of the currently logged in user, use the primary keyword. | String
| insert | *content* | The com.google.api.services.calendar.model.CalendarListEntry | CalendarListEntry
@@ -375,6 +560,9 @@ The API methods has the following set of options listed in the following table:
| update | *content* | The com.google.api.services.calendar.model.CalendarListEntry | CalendarListEntry
| watch | *contentChannel* | The com.google.api.services.calendar.model.Channel | Channel
|===
+
+In addition to the parameters above, the list API can also use from the 32 endpoint query option
+which is listed in the _Query Parameters_ section.
// endpoint options: END
diff --git a/components/camel-google-calendar/src/main/docs/google-calendar-stream-component.adoc b/components/camel-google-calendar/src/main/docs/google-calendar-stream-component.adoc
index becaa95..008018c 100644
--- a/components/camel-google-calendar/src/main/docs/google-calendar-stream-component.adoc
+++ b/components/camel-google-calendar/src/main/docs/google-calendar-stream-component.adoc
@@ -159,72 +159,149 @@ The following lists each API name and method and its additional parameters.
==== settings
-The settings has 2 API method(s) which is represented by the following method signatures
+The settings API has 2 method(s) which is represented by the following method signatures
(an API method may have multiple signatures due to overloading):
+[source,java]
----
-com.google.api.services.calendar.Calendar$Settings$Get get(String setting)
-com.google.api.services.calendar.Calendar$Settings$Watch watch(com.google.api.services.calendar.model.Channel content)
+com.google.api.services.calendar.Calendar.Settings.Get get(String setting);
+
+com.google.api.services.calendar.Calendar.Settings.Watch watch(com.google.api.services.calendar.model.Channel content);
+
+----
+
+The settings API is defined in the syntax as follows:
+
+----
+google-calendar-stream:settings/methodName?[parameters]
----
-The API methods has the following set of options listed in the following table:
-[width="100%",cols="1,2,5,2",options="header"]
+The 2 method(s) is listed in the table below.
+(API methods can have a shorthand alias name which can be used in the syntax instead of the name)
+
+[width="100%",cols="2,2,6",options="header"]
+|===
+| Method | Alias | Description
+| *get* | | Returns a single user setting
+| *watch* | | Watch for changes to Settings resources
+|===
+
+The settings API method(s) has the following set of parameters listed in the table below:
+[width="100%",cols="2,2,4,2",options="header"]
|===
-| Method | Name | Description | Type
+| Method | Parameter | Description | Type
| get | *setting* | The id of the user setting | String
| watch | *contentChannel* | The com.google.api.services.calendar.model.Channel | Channel
|===
+In addition to the parameters above, the settings API can also use from the 32 endpoint query option
+which is listed in the _Query Parameters_ section.
==== freebusy
-The freebusy has 1 API method(s) which is represented by the following method signatures
+The freebusy API has 1 method(s) which is represented by the following method signatures
(an API method may have multiple signatures due to overloading):
+[source,java]
----
-com.google.api.services.calendar.Calendar$Freebusy$Query query(com.google.api.services.calendar.model.FreeBusyRequest content)
+
+com.google.api.services.calendar.Calendar.Freebusy.Query query(com.google.api.services.calendar.model.FreeBusyRequest content);
----
-The API methods has the following set of options listed in the following table:
-[width="100%",cols="1,2,5,2",options="header"]
+The freebusy API is defined in the syntax as follows:
+
+----
+google-calendar-stream:freebusy/methodName?[parameters]
+----
+
+The 1 method(s) is listed in the table below.
+(API methods can have a shorthand alias name which can be used in the syntax instead of the name)
+
+[width="100%",cols="2,2,6",options="header"]
+|===
+| Method | Alias | Description
+| *query* | | Returns free/busy information for a set of calendars
|===
-| Method | Name | Description | Type
+
+The freebusy API method(s) has the following set of parameters listed in the table below:
+[width="100%",cols="2,2,4,2",options="header"]
+|===
+| Method | Parameter | Description | Type
| query | *content* | The com.google.api.services.calendar.model.FreeBusyRequest | FreeBusyRequest
|===
+In addition to the parameters above, the freebusy API can also use from the 32 endpoint query option
+which is listed in the _Query Parameters_ section.
==== events
-The events has 11 API method(s) which is represented by the following method signatures
+The events API has 11 method(s) which is represented by the following method signatures
(an API method may have multiple signatures due to overloading):
+[source,java]
----
-com.google.api.services.calendar.Calendar$Events$CalendarImport calendarImport(String calendarId, com.google.api.services.calendar.model.Event content)
-com.google.api.services.calendar.Calendar$Events$Delete delete(String calendarId, String eventId)
-com.google.api.services.calendar.Calendar$Events$Get get(String calendarId, String eventId)
-com.google.api.services.calendar.Calendar$Events$Insert insert(String calendarId, com.google.api.services.calendar.model.Event content)
-com.google.api.services.calendar.Calendar$Events$Instances instances(String calendarId, String eventId)
-com.google.api.services.calendar.Calendar$Events$List list(String calendarId)
-com.google.api.services.calendar.Calendar$Events$Move move(String calendarId, String eventId, String destination)
-com.google.api.services.calendar.Calendar$Events$Patch patch(String calendarId, String eventId, com.google.api.services.calendar.model.Event content)
-com.google.api.services.calendar.Calendar$Events$QuickAdd quickAdd(String calendarId, String text)
-com.google.api.services.calendar.Calendar$Events$Update update(String calendarId, String eventId, com.google.api.services.calendar.model.Event content)
-com.google.api.services.calendar.Calendar$Events$Watch watch(String calendarId, com.google.api.services.calendar.model.Channel content)
+com.google.api.services.calendar.Calendar.Events.CalendarImport calendarImport(String calendarId, com.google.api.services.calendar.model.Event content);
+
+com.google.api.services.calendar.Calendar.Events.Delete delete(String calendarId, String eventId);
+
+com.google.api.services.calendar.Calendar.Events.Get get(String calendarId, String eventId);
+
+com.google.api.services.calendar.Calendar.Events.Insert insert(String calendarId, com.google.api.services.calendar.model.Event content);
+
+com.google.api.services.calendar.Calendar.Events.Instances instances(String calendarId, String eventId);
+
+com.google.api.services.calendar.Calendar.Events.List list(String calendarId);
+
+com.google.api.services.calendar.Calendar.Events.Move move(String calendarId, String eventId, String destination);
+
+com.google.api.services.calendar.Calendar.Events.Patch patch(String calendarId, String eventId, com.google.api.services.calendar.model.Event content);
+
+com.google.api.services.calendar.Calendar.Events.QuickAdd quickAdd(String calendarId, String text);
+
+com.google.api.services.calendar.Calendar.Events.Update update(String calendarId, String eventId, com.google.api.services.calendar.model.Event content);
+
+com.google.api.services.calendar.Calendar.Events.Watch watch(String calendarId, com.google.api.services.calendar.model.Channel content);
+
+----
+
+The events API is defined in the syntax as follows:
+
+----
+google-calendar-stream:events/methodName?[parameters]
----
-The API methods has the following set of options listed in the following table:
-[width="100%",cols="1,2,5,2",options="header"]
+The 11 method(s) is listed in the table below.
+(API methods can have a shorthand alias name which can be used in the syntax instead of the name)
+
+[width="100%",cols="2,2,6",options="header"]
+|===
+| Method | Alias | Description
+| *calendarImport* | | Imports an event
+| *delete* | | Deletes an event
+| *get* | | Returns an event
+| *insert* | | Creates an event
+| *instances* | | Returns instances of the specified recurring event
+| *list* | | Returns events on the specified calendar
+| *move* | | Moves an event to another calendar, i
+| *patch* | | Updates an event
+| *quickAdd* | | Creates an event based on a simple text string
+| *update* | | Updates an event
+| *watch* | | Watch for changes to Events resources
+|===
+
+The events API method(s) has the following set of parameters listed in the table below:
+[width="100%",cols="2,2,4,2",options="header"]
|===
-| Method | Name | Description | Type
+| Method | Parameter | Description | Type
| calendarImport | *calendarId* | Calendar identifier. To retrieve calendar IDs call the calendarList.list method. If you want to access the primary calendar of the currently logged in user, use the primary keyword. | String
| calendarImport | *content* | The com.google.api.services.calendar.model.Event | Event
| delete | *calendarId* | Calendar identifier. To retrieve calendar IDs call the calendarList.list method. If you want to access the primary calendar of the currently logged in user, use the primary keyword. | String
@@ -251,51 +328,101 @@ The API methods has the following set of options listed in the following table:
| watch | *contentChannel* | The com.google.api.services.calendar.model.Channel | Channel
|===
+In addition to the parameters above, the events API can also use from the 32 endpoint query option
+which is listed in the _Query Parameters_ section.
==== channels
-The channels has 1 API method(s) which is represented by the following method signatures
+The channels API has 1 method(s) which is represented by the following method signatures
(an API method may have multiple signatures due to overloading):
+[source,java]
+----
+
+com.google.api.services.calendar.Calendar.Channels.Stop stop(com.google.api.services.calendar.model.Channel content);
+
----
-com.google.api.services.calendar.Calendar$Channels$Stop stop(com.google.api.services.calendar.model.Channel content)
+
+The channels API is defined in the syntax as follows:
----
+google-calendar-stream:channels/methodName?[parameters]
+----
+
+The 1 method(s) is listed in the table below.
+(API methods can have a shorthand alias name which can be used in the syntax instead of the name)
+
+[width="100%",cols="2,2,6",options="header"]
+|===
+| Method | Alias | Description
+| *stop* | | Stop watching resources through this channel
+|===
-The API methods has the following set of options listed in the following table:
-[width="100%",cols="1,2,5,2",options="header"]
+The channels API method(s) has the following set of parameters listed in the table below:
+[width="100%",cols="2,2,4,2",options="header"]
|===
-| Method | Name | Description | Type
+| Method | Parameter | Description | Type
| stop | *contentChannel* | The com.google.api.services.calendar.model.Channel | Channel
|===
+In addition to the parameters above, the channels API can also use from the 32 endpoint query option
+which is listed in the _Query Parameters_ section.
==== acl
-The acl has 7 API method(s) which is represented by the following method signatures
+The acl API has 7 method(s) which is represented by the following method signatures
(an API method may have multiple signatures due to overloading):
+[source,java]
----
-com.google.api.services.calendar.Calendar$Acl$Delete delete(String calendarId, String ruleId)
-com.google.api.services.calendar.Calendar$Acl$Get get(String calendarId, String ruleId)
-com.google.api.services.calendar.Calendar$Acl$Insert insert(String calendarId, com.google.api.services.calendar.model.AclRule content)
-com.google.api.services.calendar.Calendar$Acl$List list(String calendarId)
-com.google.api.services.calendar.Calendar$Acl$Patch patch(String calendarId, String ruleId, com.google.api.services.calendar.model.AclRule content)
-com.google.api.services.calendar.Calendar$Acl$Update update(String calendarId, String ruleId, com.google.api.services.calendar.model.AclRule content)
-com.google.api.services.calendar.Calendar$Acl$Watch watch(String calendarId, com.google.api.services.calendar.model.Channel content)
+
+com.google.api.services.calendar.Calendar.Acl.Delete delete(String calendarId, String ruleId);
+
+com.google.api.services.calendar.Calendar.Acl.Get get(String calendarId, String ruleId);
+
+com.google.api.services.calendar.Calendar.Acl.Insert insert(String calendarId, com.google.api.services.calendar.model.AclRule content);
+
+com.google.api.services.calendar.Calendar.Acl.List list(String calendarId);
+
+com.google.api.services.calendar.Calendar.Acl.Patch patch(String calendarId, String ruleId, com.google.api.services.calendar.model.AclRule content);
+
+com.google.api.services.calendar.Calendar.Acl.Update update(String calendarId, String ruleId, com.google.api.services.calendar.model.AclRule content);
+
+com.google.api.services.calendar.Calendar.Acl.Watch watch(String calendarId, com.google.api.services.calendar.model.Channel content);
----
-The API methods has the following set of options listed in the following table:
-[width="100%",cols="1,2,5,2",options="header"]
+The acl API is defined in the syntax as follows:
+
+----
+google-calendar-stream:acl/methodName?[parameters]
+----
+
+The 7 method(s) is listed in the table below.
+(API methods can have a shorthand alias name which can be used in the syntax instead of the name)
+
+[width="100%",cols="2,2,6",options="header"]
+|===
+| Method | Alias | Description
+| *delete* | | Deletes an access control rule
+| *get* | | Returns an access control rule
+| *insert* | | Creates an access control rule
+| *list* | | Returns the rules in the access control list for the calendar
+| *patch* | | Updates an access control rule
+| *update* | | Updates an access control rule
+| *watch* | | Watch for changes to ACL resources
|===
-| Method | Name | Description | Type
+
+The acl API method(s) has the following set of parameters listed in the table below:
+[width="100%",cols="2,2,4,2",options="header"]
+|===
+| Method | Parameter | Description | Type
| delete | *calendarId* | Calendar identifier. To retrieve calendar IDs call the calendarList.list method. If you want to access the primary calendar of the currently logged in user, use the primary keyword. | String
| delete | *ruleId* | ACL rule identifier | String
| get | *calendarId* | Calendar identifier. To retrieve calendar IDs call the calendarList.list method. If you want to access the primary calendar of the currently logged in user, use the primary keyword. | String
@@ -313,29 +440,58 @@ The API methods has the following set of options listed in the following table:
| watch | *contentChannel* | The com.google.api.services.calendar.model.Channel | Channel
|===
+In addition to the parameters above, the acl API can also use from the 32 endpoint query option
+which is listed in the _Query Parameters_ section.
==== calendars
-The calendars has 6 API method(s) which is represented by the following method signatures
+The calendars API has 6 method(s) which is represented by the following method signatures
(an API method may have multiple signatures due to overloading):
+[source,java]
----
-com.google.api.services.calendar.Calendar$Calendars$Clear clear(String calendarId)
-com.google.api.services.calendar.Calendar$Calendars$Delete delete(String calendarId)
-com.google.api.services.calendar.Calendar$Calendars$Get get(String calendarId)
-com.google.api.services.calendar.Calendar$Calendars$Insert insert(com.google.api.services.calendar.model.Calendar content)
-com.google.api.services.calendar.Calendar$Calendars$Patch patch(String calendarId, com.google.api.services.calendar.model.Calendar content)
-com.google.api.services.calendar.Calendar$Calendars$Update update(String calendarId, com.google.api.services.calendar.model.Calendar content)
+
+com.google.api.services.calendar.Calendar.Calendars.Clear clear(String calendarId);
+
+com.google.api.services.calendar.Calendar.Calendars.Delete delete(String calendarId);
+
+com.google.api.services.calendar.Calendar.Calendars.Get get(String calendarId);
+
+com.google.api.services.calendar.Calendar.Calendars.Insert insert(com.google.api.services.calendar.model.Calendar content);
+
+com.google.api.services.calendar.Calendar.Calendars.Patch patch(String calendarId, com.google.api.services.calendar.model.Calendar content);
+
+com.google.api.services.calendar.Calendar.Calendars.Update update(String calendarId, com.google.api.services.calendar.model.Calendar content);
----
-The API methods has the following set of options listed in the following table:
-[width="100%",cols="1,2,5,2",options="header"]
+The calendars API is defined in the syntax as follows:
+
+----
+google-calendar-stream:calendars/methodName?[parameters]
+----
+
+The 6 method(s) is listed in the table below.
+(API methods can have a shorthand alias name which can be used in the syntax instead of the name)
+
+[width="100%",cols="2,2,6",options="header"]
+|===
+| Method | Alias | Description
+| *clear* | | Clears a primary calendar
+| *delete* | | Deletes a secondary calendar
+| *get* | | Returns metadata for a calendar
+| *insert* | | Creates a secondary calendar
+| *patch* | | Updates metadata for a calendar
+| *update* | | Updates metadata for a calendar
|===
-| Method | Name | Description | Type
+
+The calendars API method(s) has the following set of parameters listed in the table below:
+[width="100%",cols="2,2,4,2",options="header"]
+|===
+| Method | Parameter | Description | Type
| clear | *calendarId* | Calendar identifier. To retrieve calendar IDs call the calendarList.list method. If you want to access the primary calendar of the currently logged in user, use the primary keyword. | String
| delete | *calendarId* | Calendar identifier. To retrieve calendar IDs call the calendarList.list method. If you want to access the primary calendar of the currently logged in user, use the primary keyword. | String
| get | *calendarId* | Calendar identifier. To retrieve calendar IDs call the calendarList.list method. If you want to access the primary calendar of the currently logged in user, use the primary keyword. | String
@@ -346,29 +502,58 @@ The API methods has the following set of options listed in the following table:
| update | *content* | The com.google.api.services.calendar.model.Calendar | Calendar
|===
+In addition to the parameters above, the calendars API can also use from the 32 endpoint query option
+which is listed in the _Query Parameters_ section.
==== list
-The list has 6 API method(s) which is represented by the following method signatures
+The list API has 6 method(s) which is represented by the following method signatures
(an API method may have multiple signatures due to overloading):
+[source,java]
+----
+
+com.google.api.services.calendar.Calendar.CalendarList.Delete delete(String calendarId);
+
+com.google.api.services.calendar.Calendar.CalendarList.Get get(String calendarId);
+
+com.google.api.services.calendar.Calendar.CalendarList.Insert insert(com.google.api.services.calendar.model.CalendarListEntry content);
+
+com.google.api.services.calendar.Calendar.CalendarList.Patch patch(String calendarId, com.google.api.services.calendar.model.CalendarListEntry content);
+
+com.google.api.services.calendar.Calendar.CalendarList.Update update(String calendarId, com.google.api.services.calendar.model.CalendarListEntry content);
+
+com.google.api.services.calendar.Calendar.CalendarList.Watch watch(com.google.api.services.calendar.model.Channel content);
+
----
-com.google.api.services.calendar.Calendar$CalendarList$Delete delete(String calendarId)
-com.google.api.services.calendar.Calendar$CalendarList$Get get(String calendarId)
-com.google.api.services.calendar.Calendar$CalendarList$Insert insert(com.google.api.services.calendar.model.CalendarListEntry content)
-com.google.api.services.calendar.Calendar$CalendarList$Patch patch(String calendarId, com.google.api.services.calendar.model.CalendarListEntry content)
-com.google.api.services.calendar.Calendar$CalendarList$Update update(String calendarId, com.google.api.services.calendar.model.CalendarListEntry content)
-com.google.api.services.calendar.Calendar$CalendarList$Watch watch(com.google.api.services.calendar.model.Channel content)
+
+The list API is defined in the syntax as follows:
----
+google-calendar-stream:list/methodName?[parameters]
+----
+
+The 6 method(s) is listed in the table below.
+(API methods can have a shorthand alias name which can be used in the syntax instead of the name)
+
+[width="100%",cols="2,2,6",options="header"]
+|===
+| Method | Alias | Description
+| *delete* | | Deletes an entry on the user's calendar list
+| *get* | | Returns an entry on the user's calendar list
+| *insert* | | Adds an entry to the user's calendar list
+| *patch* | | Updates an entry on the user's calendar list
+| *update* | | Updates an entry on the user's calendar list
+| *watch* | | Watch for changes to CalendarList resources
+|===
-The API methods has the following set of options listed in the following table:
-[width="100%",cols="1,2,5,2",options="header"]
+The list API method(s) has the following set of parameters listed in the table below:
+[width="100%",cols="2,2,4,2",options="header"]
|===
-| Method | Name | Description | Type
+| Method | Parameter | Description | Type
| delete | *calendarId* | Calendar identifier. To retrieve calendar IDs call the calendarList.list method. If you want to access the primary calendar of the currently logged in user, use the primary keyword. | String
| get | *calendarId* | Calendar identifier. To retrieve calendar IDs call the calendarList.list method. If you want to access the primary calendar of the currently logged in user, use the primary keyword. | String
| insert | *content* | The com.google.api.services.calendar.model.CalendarListEntry | CalendarListEntry
@@ -378,6 +563,9 @@ The API methods has the following set of options listed in the following table:
| update | *content* | The com.google.api.services.calendar.model.CalendarListEntry | CalendarListEntry
| watch | *contentChannel* | The com.google.api.services.calendar.model.Channel | Channel
|===
+
+In addition to the parameters above, the list API can also use from the 32 endpoint query option
+which is listed in the _Query Parameters_ section.
// endpoint options: END
diff --git a/components/camel-google-drive/src/main/docs/google-drive-component.adoc b/components/camel-google-drive/src/main/docs/google-drive-component.adoc
index 557a3e6..3dd3a66 100644
--- a/components/camel-google-drive/src/main/docs/google-drive-component.adoc
+++ b/components/camel-google-drive/src/main/docs/google-drive-component.adoc
@@ -178,43 +178,87 @@ The following lists each API name and method and its additional parameters.
==== drive-channels
-The drive-channels has 1 API method(s) which is represented by the following method signatures
+The drive-channels API has 1 method(s) which is represented by the following method signatures
(an API method may have multiple signatures due to overloading):
+[source,java]
----
-com.google.api.services.drive.Drive$Channels$Stop stop(com.google.api.services.drive.model.Channel content)
+com.google.api.services.drive.Drive.Channels.Stop stop(com.google.api.services.drive.model.Channel content);
+
+----
+
+The drive-channels API is defined in the syntax as follows:
+
+----
+google-drive:drive-channels/methodName?[parameters]
----
-The API methods has the following set of options listed in the following table:
-[width="100%",cols="1,2,5,2",options="header"]
+The 1 method(s) is listed in the table below.
+(API methods can have a shorthand alias name which can be used in the syntax instead of the name)
+
+[width="100%",cols="2,2,6",options="header"]
+|===
+| Method | Alias | Description
+| *stop* | | Stop watching resources through this channel
|===
-| Method | Name | Description | Type
+
+The drive-channels API method(s) has the following set of parameters listed in the table below:
+[width="100%",cols="2,2,4,2",options="header"]
+|===
+| Method | Parameter | Description | Type
| stop | *contentChannel* | The com.google.api.services.drive.model.Channel | Channel
|===
+In addition to the parameters above, the drive-channels API can also use from the 30 endpoint query option
+which is listed in the _Query Parameters_ section.
==== drive-revisions
-The drive-revisions has 5 API method(s) which is represented by the following method signatures
+The drive-revisions API has 5 method(s) which is represented by the following method signatures
(an API method may have multiple signatures due to overloading):
+[source,java]
+----
+
+com.google.api.services.drive.Drive.Revisions.Delete delete(String fileId, String revisionId);
+
+com.google.api.services.drive.Drive.Revisions.Get get(String fileId, String revisionId);
+
+com.google.api.services.drive.Drive.Revisions.List list(String fileId);
+
+com.google.api.services.drive.Drive.Revisions.Patch patch(String fileId, String revisionId, com.google.api.services.drive.model.Revision content);
+
+com.google.api.services.drive.Drive.Revisions.Update update(String fileId, String revisionId, com.google.api.services.drive.model.Revision content);
+
----
-com.google.api.services.drive.Drive$Revisions$Delete delete(String fileId, String revisionId)
-com.google.api.services.drive.Drive$Revisions$Get get(String fileId, String revisionId)
-com.google.api.services.drive.Drive$Revisions$List list(String fileId)
-com.google.api.services.drive.Drive$Revisions$Patch patch(String fileId, String revisionId, com.google.api.services.drive.model.Revision content)
-com.google.api.services.drive.Drive$Revisions$Update update(String fileId, String revisionId, com.google.api.services.drive.model.Revision content)
+The drive-revisions API is defined in the syntax as follows:
+
+----
+google-drive:drive-revisions/methodName?[parameters]
----
-The API methods has the following set of options listed in the following table:
-[width="100%",cols="1,2,5,2",options="header"]
+The 5 method(s) is listed in the table below.
+(API methods can have a shorthand alias name which can be used in the syntax instead of the name)
+
+[width="100%",cols="2,2,6",options="header"]
+|===
+| Method | Alias | Description
+| *delete* | | Removes a revision
+| *get* | | Gets a specific revision
+| *list* | | Lists a file's revisions
+| *patch* | | Updates a revision
+| *update* | | Updates a revision
|===
-| Method | Name | Description | Type
+
+The drive-revisions API method(s) has the following set of parameters listed in the table below:
+[width="100%",cols="2,2,4,2",options="header"]
+|===
+| Method | Parameter | Description | Type
| delete | *fileId* | The ID of the file | String
| delete | *revisionId* | The ID of the revision | String
| get | *fileId* | The ID of the file | String
@@ -228,29 +272,58 @@ The API methods has the following set of options listed in the following table:
| update | *revisionId* | The ID for the revision | String
|===
+In addition to the parameters above, the drive-revisions API can also use from the 30 endpoint query option
+which is listed in the _Query Parameters_ section.
==== drive-replies
-The drive-replies has 6 API method(s) which is represented by the following method signatures
+The drive-replies API has 6 method(s) which is represented by the following method signatures
(an API method may have multiple signatures due to overloading):
+[source,java]
----
-com.google.api.services.drive.Drive$Replies$Delete delete(String fileId, String commentId, String replyId)
-com.google.api.services.drive.Drive$Replies$Get get(String fileId, String commentId, String replyId)
-com.google.api.services.drive.Drive$Replies$Insert insert(String fileId, String commentId, com.google.api.services.drive.model.CommentReply content)
-com.google.api.services.drive.Drive$Replies$List list(String fileId, String commentId)
-com.google.api.services.drive.Drive$Replies$Patch patch(String fileId, String commentId, String replyId, com.google.api.services.drive.model.CommentReply content)
-com.google.api.services.drive.Drive$Replies$Update update(String fileId, String commentId, String replyId, com.google.api.services.drive.model.CommentReply content)
+
+com.google.api.services.drive.Drive.Replies.Delete delete(String fileId, String commentId, String replyId);
+
+com.google.api.services.drive.Drive.Replies.Get get(String fileId, String commentId, String replyId);
+
+com.google.api.services.drive.Drive.Replies.Insert insert(String fileId, String commentId, com.google.api.services.drive.model.CommentReply content);
+
+com.google.api.services.drive.Drive.Replies.List list(String fileId, String commentId);
+
+com.google.api.services.drive.Drive.Replies.Patch patch(String fileId, String commentId, String replyId, com.google.api.services.drive.model.CommentReply content);
+
+com.google.api.services.drive.Drive.Replies.Update update(String fileId, String commentId, String replyId, com.google.api.services.drive.model.CommentReply content);
----
-The API methods has the following set of options listed in the following table:
-[width="100%",cols="1,2,5,2",options="header"]
+The drive-replies API is defined in the syntax as follows:
+
+----
+google-drive:drive-replies/methodName?[parameters]
+----
+
+The 6 method(s) is listed in the table below.
+(API methods can have a shorthand alias name which can be used in the syntax instead of the name)
+
+[width="100%",cols="2,2,6",options="header"]
|===
-| Method | Name | Description | Type
+| Method | Alias | Description
+| *delete* | | Deletes a reply
+| *get* | | Gets a reply
+| *insert* | | Creates a new reply to the given comment
+| *list* | | Lists all of the replies to a comment
+| *patch* | | Updates an existing reply
+| *update* | | Updates an existing reply
+|===
+
+The drive-replies API method(s) has the following set of parameters listed in the table below:
+[width="100%",cols="2,2,4,2",options="header"]
+|===
+| Method | Parameter | Description | Type
| delete | *commentId* | The ID of the comment | String
| delete | *fileId* | The ID of the file | String
| delete | *replyId* | The ID of the reply | String
@@ -272,30 +345,61 @@ The API methods has the following set of options listed in the following table:
| update | *replyId* | The ID of the reply | String
|===
+In addition to the parameters above, the drive-replies API can also use from the 30 endpoint query option
+which is listed in the _Query Parameters_ section.
==== drive-permissions
-The drive-permissions has 7 API method(s) which is represented by the following method signatures
+The drive-permissions API has 7 method(s) which is represented by the following method signatures
(an API method may have multiple signatures due to overloading):
+[source,java]
+----
+
+com.google.api.services.drive.Drive.Permissions.Delete delete(String fileId, String permissionId);
+
+com.google.api.services.drive.Drive.Permissions.Get get(String fileId, String permissionId);
+
+com.google.api.services.drive.Drive.Permissions.GetIdForEmail getIdForEmail(String email);
+
+com.google.api.services.drive.Drive.Permissions.Insert insert(String fileId, com.google.api.services.drive.model.Permission content);
+
+com.google.api.services.drive.Drive.Permissions.List list(String fileId);
+
+com.google.api.services.drive.Drive.Permissions.Patch patch(String fileId, String permissionId, com.google.api.services.drive.model.Permission content);
+
+com.google.api.services.drive.Drive.Permissions.Update update(String fileId, String permissionId, com.google.api.services.drive.model.Permission content);
+
----
-com.google.api.services.drive.Drive$Permissions$Delete delete(String fileId, String permissionId)
-com.google.api.services.drive.Drive$Permissions$Get get(String fileId, String permissionId)
-com.google.api.services.drive.Drive$Permissions$GetIdForEmail getIdForEmail(String email)
-com.google.api.services.drive.Drive$Permissions$Insert insert(String fileId, com.google.api.services.drive.model.Permission content)
-com.google.api.services.drive.Drive$Permissions$List list(String fileId)
-com.google.api.services.drive.Drive$Permissions$Patch patch(String fileId, String permissionId, com.google.api.services.drive.model.Permission content)
-com.google.api.services.drive.Drive$Permissions$Update update(String fileId, String permissionId, com.google.api.services.drive.model.Permission content)
+The drive-permissions API is defined in the syntax as follows:
+
+----
+google-drive:drive-permissions/methodName?[parameters]
----
-The API methods has the following set of options listed in the following table:
-[width="100%",cols="1,2,5,2",options="header"]
+The 7 method(s) is listed in the table below.
+(API methods can have a shorthand alias name which can be used in the syntax instead of the name)
+
+[width="100%",cols="2,2,6",options="header"]
+|===
+| Method | Alias | Description
+| *delete* | | Deletes a permission from a file or Team Drive
+| *get* | | Gets a permission by ID
+| *getIdForEmail* | | Returns the permission ID for an email address
+| *insert* | | Inserts a permission for a file or Team Drive
+| *list* | | Lists a file's or Team Drive's permissions
+| *patch* | | Updates a permission using patch semantics
+| *update* | | Updates a permission
+|===
+
+The drive-permissions API method(s) has the following set of parameters listed in the table below:
+[width="100%",cols="2,2,4,2",options="header"]
|===
-| Method | Name | Description | Type
+| Method | Parameter | Description | Type
| delete | *fileId* | The ID for the file or Team Drive | String
| delete | *permissionId* | The ID for the permission | String
| get | *fileId* | The ID for the file or Team Drive | String
@@ -312,27 +416,52 @@ The API methods has the following set of options listed in the following table:
| update | *permissionId* | The ID for the permission | String
|===
+In addition to the parameters above, the drive-permissions API can also use from the 30 endpoint query option
+which is listed in the _Query Parameters_ section.
==== drive-parents
-The drive-parents has 4 API method(s) which is represented by the following method signatures
+The drive-parents API has 4 method(s) which is represented by the following method signatures
(an API method may have multiple signatures due to overloading):
+[source,java]
+----
+
+com.google.api.services.drive.Drive.Parents.Delete delete(String fileId, String parentId);
+
+com.google.api.services.drive.Drive.Parents.Get get(String fileId, String parentId);
+
+com.google.api.services.drive.Drive.Parents.Insert insert(String fileId, com.google.api.services.drive.model.ParentReference content);
+
+com.google.api.services.drive.Drive.Parents.List list(String fileId);
+
----
-com.google.api.services.drive.Drive$Parents$Delete delete(String fileId, String parentId)
-com.google.api.services.drive.Drive$Parents$Get get(String fileId, String parentId)
-com.google.api.services.drive.Drive$Parents$Insert insert(String fileId, com.google.api.services.drive.model.ParentReference content)
-com.google.api.services.drive.Drive$Parents$List list(String fileId)
+The drive-parents API is defined in the syntax as follows:
+
+----
+google-drive:drive-parents/methodName?[parameters]
----
-The API methods has the following set of options listed in the following table:
-[width="100%",cols="1,2,5,2",options="header"]
+The 4 method(s) is listed in the table below.
+(API methods can have a shorthand alias name which can be used in the syntax instead of the name)
+
+[width="100%",cols="2,2,6",options="header"]
+|===
+| Method | Alias | Description
+| *delete* | | Removes a parent from a file
+| *get* | | Gets a specific parent reference
+| *insert* | | Adds a parent folder for a file
+| *list* | | Lists a file's parents
|===
-| Method | Name | Description | Type
+
+The drive-parents API method(s) has the following set of parameters listed in the table below:
+[width="100%",cols="2,2,4,2",options="header"]
+|===
+| Method | Parameter | Description | Type
| delete | *fileId* | The ID of the file | String
| delete | *parentId* | The ID of the parent | String
| get | *fileId* | The ID of the file | String
@@ -342,73 +471,142 @@ The API methods has the following set of options listed in the following table:
| list | *fileId* | The ID of the file | String
|===
+In addition to the parameters above, the drive-parents API can also use from the 30 endpoint query option
+which is listed in the _Query Parameters_ section.
==== drive-apps
-The drive-apps has 1 API method(s) which is represented by the following method signatures
+The drive-apps API has 1 method(s) which is represented by the following method signatures
(an API method may have multiple signatures due to overloading):
+[source,java]
+----
+
+com.google.api.services.drive.Drive.Apps.Get get(String appId);
+
----
-com.google.api.services.drive.Drive$Apps$Get get(String appId)
+
+The drive-apps API is defined in the syntax as follows:
----
+google-drive:drive-apps/methodName?[parameters]
+----
+
+The 1 method(s) is listed in the table below.
+(API methods can have a shorthand alias name which can be used in the syntax instead of the name)
-The API methods has the following set of options listed in the following table:
-[width="100%",cols="1,2,5,2",options="header"]
+[width="100%",cols="2,2,6",options="header"]
|===
-| Method | Name | Description | Type
+| Method | Alias | Description
+| *get* | | Gets a specific app
+|===
+
+The drive-apps API method(s) has the following set of parameters listed in the table below:
+[width="100%",cols="2,2,4,2",options="header"]
+|===
+| Method | Parameter | Description | Type
| get | *appId* | The ID of the app | String
|===
+In addition to the parameters above, the drive-apps API can also use from the 30 endpoint query option
+which is listed in the _Query Parameters_ section.
==== drive-changes
-The drive-changes has 2 API method(s) which is represented by the following method signatures
+The drive-changes API has 2 method(s) which is represented by the following method signatures
(an API method may have multiple signatures due to overloading):
+[source,java]
----
-com.google.api.services.drive.Drive$Changes$Get get(String changeId)
-com.google.api.services.drive.Drive$Changes$Watch watch(com.google.api.services.drive.model.Channel content)
+com.google.api.services.drive.Drive.Changes.Get get(String changeId);
+
+com.google.api.services.drive.Drive.Changes.Watch watch(com.google.api.services.drive.model.Channel content);
+
+----
+
+The drive-changes API is defined in the syntax as follows:
+
+----
+google-drive:drive-changes/methodName?[parameters]
----
-The API methods has the following set of options listed in the following table:
-[width="100%",cols="1,2,5,2",options="header"]
+The 2 method(s) is listed in the table below.
+(API methods can have a shorthand alias name which can be used in the syntax instead of the name)
+
+[width="100%",cols="2,2,6",options="header"]
+|===
+| Method | Alias | Description
+| *get* | | Deprecated - Use changes
+| *watch* | | Subscribe to changes for a user
|===
-| Method | Name | Description | Type
+
+The drive-changes API method(s) has the following set of parameters listed in the table below:
+[width="100%",cols="2,2,4,2",options="header"]
+|===
+| Method | Parameter | Description | Type
| get | *changeId* | The ID of the change | String
| watch | *contentChannel* | The com.google.api.services.drive.model.Channel | Channel
|===
+In addition to the parameters above, the drive-changes API can also use from the 30 endpoint query option
+which is listed in the _Query Parameters_ section.
==== drive-comments
-The drive-comments has 6 API method(s) which is represented by the following method signatures
+The drive-comments API has 6 method(s) which is represented by the following method signatures
(an API method may have multiple signatures due to overloading):
+[source,java]
+----
+
+com.google.api.services.drive.Drive.Comments.Delete delete(String fileId, String commentId);
+
+com.google.api.services.drive.Drive.Comments.Get get(String fileId, String commentId);
+
+com.google.api.services.drive.Drive.Comments.Insert insert(String fileId, com.google.api.services.drive.model.Comment content);
+
+com.google.api.services.drive.Drive.Comments.List list(String fileId);
+
+com.google.api.services.drive.Drive.Comments.Patch patch(String fileId, String commentId, com.google.api.services.drive.model.Comment content);
+
+com.google.api.services.drive.Drive.Comments.Update update(String fileId, String commentId, com.google.api.services.drive.model.Comment content);
+
----
-com.google.api.services.drive.Drive$Comments$Delete delete(String fileId, String commentId)
-com.google.api.services.drive.Drive$Comments$Get get(String fileId, String commentId)
-com.google.api.services.drive.Drive$Comments$Insert insert(String fileId, com.google.api.services.drive.model.Comment content)
-com.google.api.services.drive.Drive$Comments$List list(String fileId)
-com.google.api.services.drive.Drive$Comments$Patch patch(String fileId, String commentId, com.google.api.services.drive.model.Comment content)
-com.google.api.services.drive.Drive$Comments$Update update(String fileId, String commentId, com.google.api.services.drive.model.Comment content)
+
+The drive-comments API is defined in the syntax as follows:
----
+google-drive:drive-comments/methodName?[parameters]
+----
+
+The 6 method(s) is listed in the table below.
+(API methods can have a shorthand alias name which can be used in the syntax instead of the name)
-The API methods has the following set of options listed in the following table:
-[width="100%",cols="1,2,5,2",options="header"]
+[width="100%",cols="2,2,6",options="header"]
|===
-| Method | Name | Description | Type
+| Method | Alias | Description
+| *delete* | | Deletes a comment
+| *get* | | Gets a comment by ID
+| *insert* | | Creates a new comment on the given file
+| *list* | | Lists a file's comments
+| *patch* | | Updates an existing comment
+| *update* | | Updates an existing comment
+|===
+
+The drive-comments API method(s) has the following set of parameters listed in the table below:
+[width="100%",cols="2,2,4,2",options="header"]
+|===
+| Method | Parameter | Description | Type
| delete | *commentId* | The ID of the comment | String
| delete | *fileId* | The ID of the file | String
| get | *commentId* | The ID of the comment | String
@@ -424,29 +622,58 @@ The API methods has the following set of options listed in the following table:
| update | *fileId* | The ID of the file | String
|===
+In addition to the parameters above, the drive-comments API can also use from the 30 endpoint query option
+which is listed in the _Query Parameters_ section.
==== drive-properties
-The drive-properties has 6 API method(s) which is represented by the following method signatures
+The drive-properties API has 6 method(s) which is represented by the following method signatures
(an API method may have multiple signatures due to overloading):
+[source,java]
----
-com.google.api.services.drive.Drive$Properties$Delete delete(String fileId, String propertyKey)
-com.google.api.services.drive.Drive$Properties$Get get(String fileId, String propertyKey)
-com.google.api.services.drive.Drive$Properties$Insert insert(String fileId, com.google.api.services.drive.model.Property content)
-com.google.api.services.drive.Drive$Properties$List list(String fileId)
-com.google.api.services.drive.Drive$Properties$Patch patch(String fileId, String propertyKey, com.google.api.services.drive.model.Property content)
-com.google.api.services.drive.Drive$Properties$Update update(String fileId, String propertyKey, com.google.api.services.drive.model.Property content)
+com.google.api.services.drive.Drive.Properties.Delete delete(String fileId, String propertyKey);
+
+com.google.api.services.drive.Drive.Properties.Get get(String fileId, String propertyKey);
+
+com.google.api.services.drive.Drive.Properties.Insert insert(String fileId, com.google.api.services.drive.model.Property content);
+
+com.google.api.services.drive.Drive.Properties.List list(String fileId);
+
+com.google.api.services.drive.Drive.Properties.Patch patch(String fileId, String propertyKey, com.google.api.services.drive.model.Property content);
+
+com.google.api.services.drive.Drive.Properties.Update update(String fileId, String propertyKey, com.google.api.services.drive.model.Property content);
+
+----
+
+The drive-properties API is defined in the syntax as follows:
+
+----
+google-drive:drive-properties/methodName?[parameters]
----
-The API methods has the following set of options listed in the following table:
-[width="100%",cols="1,2,5,2",options="header"]
+The 6 method(s) is listed in the table below.
+(API methods can have a shorthand alias name which can be used in the syntax instead of the name)
+
+[width="100%",cols="2,2,6",options="header"]
+|===
+| Method | Alias | Description
+| *delete* | | Deletes a property
+| *get* | | Gets a property by its key
+| *insert* | | Adds a property to a file, or updates it if it already exists
+| *list* | | Lists a file's properties
+| *patch* | | Updates a property, or adds it if it doesn't exist
+| *update* | | Updates a property, or adds it if it doesn't exist
|===
-| Method | Name | Description | Type
+
+The drive-properties API method(s) has the following set of parameters listed in the table below:
+[width="100%",cols="2,2,4,2",options="header"]
+|===
+| Method | Parameter | Description | Type
| delete | *fileId* | The ID of the file | String
| delete | *propertyKey* | The key of the property | String
| get | *fileId* | The ID of the file | String
@@ -462,52 +689,99 @@ The API methods has the following set of options listed in the following table:
| update | *propertyKey* | The key of the property | String
|===
+In addition to the parameters above, the drive-properties API can also use from the 30 endpoint query option
+which is listed in the _Query Parameters_ section.
==== drive-realtime
-The drive-realtime has 2 API method(s) which is represented by the following method signatures
+The drive-realtime API has 2 method(s) which is represented by the following method signatures
(an API method may have multiple signatures due to overloading):
+[source,java]
----
-com.google.api.services.drive.Drive$Realtime$Get get(String fileId)
-com.google.api.services.drive.Drive$Realtime$Update update(String fileId)
-com.google.api.services.drive.Drive$Realtime$Update update(String fileId, com.google.api.client.http.AbstractInputStreamContent mediaContent)
+com.google.api.services.drive.Drive.Realtime.Get get(String fileId);
+
+com.google.api.services.drive.Drive.Realtime.Update update(String fileId);
+
+com.google.api.services.drive.Drive.Realtime.Update update(String fileId, com.google.api.client.http.AbstractInputStreamContent mediaContent);
+
+----
+
+The drive-realtime API is defined in the syntax as follows:
+
+----
+google-drive:drive-realtime/methodName?[parameters]
----
-The API methods has the following set of options listed in the following table:
-[width="100%",cols="1,2,5,2",options="header"]
+The 2 method(s) is listed in the table below.
+(API methods can have a shorthand alias name which can be used in the syntax instead of the name)
+
+[width="100%",cols="2,2,6",options="header"]
+|===
+| Method | Alias | Description
+| *get* | | Exports the contents of the Realtime API data model associated with this file as JSON
+| *update* | | Overwrites the Realtime API data model associated with this file with the provided JSON data model
|===
-| Method | Name | Description | Type
+
+The drive-realtime API method(s) has the following set of parameters listed in the table below:
+[width="100%",cols="2,2,4,2",options="header"]
+|===
+| Method | Parameter | Description | Type
| get | *fileId* | The ID of the file that the Realtime API data model is associated with | String
| update | *fileId* | The ID of the file that the Realtime API data model is associated with | String
| update | *mediaContent* | The media HTTP content or null if none | AbstractInputStreamContent
|===
+In addition to the parameters above, the drive-realtime API can also use from the 30 endpoint query option
+which is listed in the _Query Parameters_ section.
==== drive-children
-The drive-children has 4 API method(s) which is represented by the following method signatures
+The drive-children API has 4 method(s) which is represented by the following method signatures
(an API method may have multiple signatures due to overloading):
+[source,java]
----
-com.google.api.services.drive.Drive$Children$Delete delete(String folderId, String childId)
-com.google.api.services.drive.Drive$Children$Get get(String folderId, String childId)
-com.google.api.services.drive.Drive$Children$Insert insert(String folderId, com.google.api.services.drive.model.ChildReference content)
-com.google.api.services.drive.Drive$Children$List list(String folderId)
+
+com.google.api.services.drive.Drive.Children.Delete delete(String folderId, String childId);
+
+com.google.api.services.drive.Drive.Children.Get get(String folderId, String childId);
+
+com.google.api.services.drive.Drive.Children.Insert insert(String folderId, com.google.api.services.drive.model.ChildReference content);
+
+com.google.api.services.drive.Drive.Children.List list(String folderId);
----
-The API methods has the following set of options listed in the following table:
-[width="100%",cols="1,2,5,2",options="header"]
+The drive-children API is defined in the syntax as follows:
+
+----
+google-drive:drive-children/methodName?[parameters]
+----
+
+The 4 method(s) is listed in the table below.
+(API methods can have a shorthand alias name which can be used in the syntax instead of the name)
+
+[width="100%",cols="2,2,6",options="header"]
|===
-| Method | Name | Description | Type
+| Method | Alias | Description
+| *delete* | | Removes a child from a folder
+| *get* | | Gets a specific child reference
+| *insert* | | Inserts a file into a folder
+| *list* | | Lists a folder's children
+|===
+
+The drive-children API method(s) has the following set of parameters listed in the table below:
+[width="100%",cols="2,2,4,2",options="header"]
+|===
+| Method | Parameter | Description | Type
| delete | *childId* | The ID of the child | String
| delete | *folderId* | The ID of the folder | String
| get | *childId* | The ID of the child | String
@@ -517,36 +791,77 @@ The API methods has the following set of options listed in the following table:
| list | *folderId* | The ID of the folder | String
|===
+In addition to the parameters above, the drive-children API can also use from the 30 endpoint query option
+which is listed in the _Query Parameters_ section.
==== drive-files
-The drive-files has 11 API method(s) which is represented by the following method signatures
+The drive-files API has 11 method(s) which is represented by the following method signatures
(an API method may have multiple signatures due to overloading):
+[source,java]
+----
+
+com.google.api.services.drive.Drive.Files.Copy copy(String fileId, com.google.api.services.drive.model.File content);
+
+com.google.api.services.drive.Drive.Files.Delete delete(String fileId);
+
+com.google.api.services.drive.Drive.Files.Export export(String fileId, String mimeType);
+
+com.google.api.services.drive.Drive.Files.Get get(String fileId);
+
+com.google.api.services.drive.Drive.Files.Insert insert(com.google.api.services.drive.model.File content);
+
+com.google.api.services.drive.Drive.Files.Insert insert(com.google.api.services.drive.model.File content, com.google.api.client.http.AbstractInputStreamContent mediaContent);
+
+com.google.api.services.drive.Drive.Files.Patch patch(String fileId, com.google.api.services.drive.model.File content);
+
+com.google.api.services.drive.Drive.Files.Touch touch(String fileId);
+
+com.google.api.services.drive.Drive.Files.Trash trash(String fileId);
+
+com.google.api.services.drive.Drive.Files.Untrash untrash(String fileId);
+
+com.google.api.services.drive.Drive.Files.Update update(String fileId, com.google.api.services.drive.model.File content);
+
+com.google.api.services.drive.Drive.Files.Update update(String fileId, com.google.api.services.drive.model.File content, com.google.api.client.http.AbstractInputStreamContent mediaContent);
+
+com.google.api.services.drive.Drive.Files.Watch watch(String fileId, com.google.api.services.drive.model.Channel content);
+
----
-com.google.api.services.drive.Drive$Files$Copy copy(String fileId, com.google.api.services.drive.model.File content)
-com.google.api.services.drive.Drive$Files$Delete delete(String fileId)
-com.google.api.services.drive.Drive$Files$Export export(String fileId, String mimeType)
-com.google.api.services.drive.Drive$Files$Get get(String fileId)
-com.google.api.services.drive.Drive$Files$Insert insert(com.google.api.services.drive.model.File content)
-com.google.api.services.drive.Drive$Files$Insert insert(com.google.api.services.drive.model.File content, com.google.api.client.http.AbstractInputStreamContent mediaContent)
-com.google.api.services.drive.Drive$Files$Patch patch(String fileId, com.google.api.services.drive.model.File content)
-com.google.api.services.drive.Drive$Files$Touch touch(String fileId)
-com.google.api.services.drive.Drive$Files$Trash trash(String fileId)
-com.google.api.services.drive.Drive$Files$Untrash untrash(String fileId)
-com.google.api.services.drive.Drive$Files$Update update(String fileId, com.google.api.services.drive.model.File content)
-com.google.api.services.drive.Drive$Files$Update update(String fileId, com.google.api.services.drive.model.File content, com.google.api.client.http.AbstractInputStreamContent mediaContent)
-com.google.api.services.drive.Drive$Files$Watch watch(String fileId, com.google.api.services.drive.model.Channel content)
+
+The drive-files API is defined in the syntax as follows:
----
+google-drive:drive-files/methodName?[parameters]
+----
+
+The 11 method(s) is listed in the table below.
+(API methods can have a shorthand alias name which can be used in the syntax instead of the name)
-The API methods has the following set of options listed in the following table:
-[width="100%",cols="1,2,5,2",options="header"]
+[width="100%",cols="2,2,6",options="header"]
|===
-| Method | Name | Description | Type
+| Method | Alias | Description
+| *copy* | | Creates a copy of the specified file
+| *delete* | | Permanently deletes a file by ID
+| *export* | | Exports a Google Doc to the requested MIME type and returns the exported content
+| *get* | | Gets a file's metadata by ID
+| *insert* | | Insert a new file
+| *patch* | | Updates file metadata and/or content
+| *touch* | | Set the file's updated time to the current server time
+| *trash* | | Moves a file to the trash
+| *untrash* | | Restores a file from the trash
+| *update* | | Updates file metadata and/or content
+| *watch* | | Subscribe to changes on a file
+|===
+
+The drive-files API method(s) has the following set of parameters listed in the table below:
+[width="100%",cols="2,2,4,2",options="header"]
+|===
+| Method | Parameter | Description | Type
| copy | *content* | The com.google.api.services.drive.model.File | File
| copy | *fileId* | The ID of the file to copy | String
| delete | *fileId* | The ID of the file to delete | String
@@ -566,6 +881,9 @@ The API methods has the following set of options listed in the following table:
| watch | *contentChannel* | The com.google.api.services.drive.model.Channel | Channel
| watch | *fileId* | The ID for the file in question | String
|===
+
+In addition to the parameters above, the drive-files API can also use from the 30 endpoint query option
+which is listed in the _Query Parameters_ section.
// endpoint options: END
diff --git a/components/camel-google-mail/src/main/docs/google-mail-component.adoc b/components/camel-google-mail/src/main/docs/google-mail-component.adoc
index 34a188f..04ed35b 100644
--- a/components/camel-google-mail/src/main/docs/google-mail-component.adoc
+++ b/components/camel-google-mail/src/main/docs/google-mail-component.adoc
@@ -166,49 +166,99 @@ The following lists each API name and method and its additional parameters.
==== users
-The users has 3 API method(s) which is represented by the following method signatures
+The users API has 3 method(s) which is represented by the following method signatures
(an API method may have multiple signatures due to overloading):
+[source,java]
----
-com.google.api.services.gmail.Gmail$Users$GetProfile getProfile(String userId)
-com.google.api.services.gmail.Gmail$Users$Stop stop(String userId)
-com.google.api.services.gmail.Gmail$Users$Watch watch(String userId, com.google.api.services.gmail.model.WatchRequest content)
+com.google.api.services.gmail.Gmail.Users.GetProfile getProfile(String userId);
+
+com.google.api.services.gmail.Gmail.Users.Stop stop(String userId);
+
+com.google.api.services.gmail.Gmail.Users.Watch watch(String userId, com.google.api.services.gmail.model.WatchRequest content);
+
+----
+
+The users API is defined in the syntax as follows:
+
+----
+google-mail:users/methodName?[parameters]
----
-The API methods has the following set of options listed in the following table:
-[width="100%",cols="1,2,5,2",options="header"]
+The 3 method(s) is listed in the table below.
+(API methods can have a shorthand alias name which can be used in the syntax instead of the name)
+
+[width="100%",cols="2,2,6",options="header"]
+|===
+| Method | Alias | Description
+| *getProfile* | | Gets the current user's Gmail profile
+| *stop* | | Stop receiving push notifications for the given user mailbox
+| *watch* | | Set up or update a push notification watch on the given user mailbox
+|===
+
+The users API method(s) has the following set of parameters listed in the table below:
+[width="100%",cols="2,2,4,2",options="header"]
|===
-| Method | Name | Description | Type
+| Method | Parameter | Description | Type
| getProfile | *userId* | The user's email address. The special value me can be used to indicate the authenticated user. default: me | String
| stop | *userId* | The user's email address. The special value me can be used to indicate the authenticated user. default: me | String
| watch | *content* | The com.google.api.services.gmail.model.WatchRequest | WatchRequest
| watch | *userId* | The user's email address. The special value me can be used to indicate the authenticated user. default: me | String
|===
+In addition to the parameters above, the users API can also use from the 28 endpoint query option
+which is listed in the _Query Parameters_ section.
==== threads
-The threads has 6 API method(s) which is represented by the following method signatures
+The threads API has 6 method(s) which is represented by the following method signatures
(an API method may have multiple signatures due to overloading):
+[source,java]
----
-com.google.api.services.gmail.Gmail$Users$Threads$Delete delete(String userId, String id)
-com.google.api.services.gmail.Gmail$Users$Threads$Get get(String userId, String id)
-com.google.api.services.gmail.Gmail$Users$Threads$List list(String userId)
-com.google.api.services.gmail.Gmail$Users$Threads$Modify modify(String userId, String id, com.google.api.services.gmail.model.ModifyThreadRequest content)
-com.google.api.services.gmail.Gmail$Users$Threads$Trash trash(String userId, String id)
-com.google.api.services.gmail.Gmail$Users$Threads$Untrash untrash(String userId, String id)
+com.google.api.services.gmail.Gmail.Users.Threads.Delete delete(String userId, String id);
+
+com.google.api.services.gmail.Gmail.Users.Threads.Get get(String userId, String id);
+
+com.google.api.services.gmail.Gmail.Users.Threads.List list(String userId);
+
+com.google.api.services.gmail.Gmail.Users.Threads.Modify modify(String userId, String id, com.google.api.services.gmail.model.ModifyThreadRequest content);
+
+com.google.api.services.gmail.Gmail.Users.Threads.Trash trash(String userId, String id);
+
+com.google.api.services.gmail.Gmail.Users.Threads.Untrash untrash(String userId, String id);
+
+----
+
+The threads API is defined in the syntax as follows:
+
+----
+google-mail:threads/methodName?[parameters]
----
-The API methods has the following set of options listed in the following table:
-[width="100%",cols="1,2,5,2",options="header"]
+The 6 method(s) is listed in the table below.
+(API methods can have a shorthand alias name which can be used in the syntax instead of the name)
+
+[width="100%",cols="2,2,6",options="header"]
+|===
+| Method | Alias | Description
+| *delete* | | Immediately and permanently deletes the specified thread
+| *get* | | Gets the specified thread
+| *list* | | Lists the threads in the user's mailbox
+| *modify* | | Modifies the labels applied to the thread
+| *trash* | | Moves the specified thread to the trash
+| *untrash* | | Removes the specified thread from the trash
+|===
+
+The threads API method(s) has the following set of parameters listed in the table below:
+[width="100%",cols="2,2,4,2",options="header"]
|===
-| Method | Name | Description | Type
+| Method | Parameter | Description | Type
| delete | *id* | ID of the Thread to delete | String
| delete | *userId* | The user's email address. The special value me can be used to indicate the authenticated user. default: me | String
| get | *id* | The ID of the thread to retrieve | String
@@ -223,32 +273,64 @@ The API methods has the following set of options listed in the following table:
| untrash | *userId* | The user's email address. The special value me can be used to indicate the authenticated user. default: me | String
|===
+In addition to the parameters above, the threads API can also use from the 28 endpoint query option
+which is listed in the _Query Parameters_ section.
==== drafts
-The drafts has 6 API method(s) which is represented by the following method signatures
+The drafts API has 6 method(s) which is represented by the following method signatures
(an API method may have multiple signatures due to overloading):
+[source,java]
----
-com.google.api.services.gmail.Gmail$Users$Drafts$Create create(String userId, com.google.api.services.gmail.model.Draft content)
-com.google.api.services.gmail.Gmail$Users$Drafts$Create create(String userId, com.google.api.services.gmail.model.Draft content, com.google.api.client.http.AbstractInputStreamContent mediaContent)
-com.google.api.services.gmail.Gmail$Users$Drafts$Delete delete(String userId, String id)
-com.google.api.services.gmail.Gmail$Users$Drafts$Get get(String userId, String id)
-com.google.api.services.gmail.Gmail$Users$Drafts$List list(String userId)
-com.google.api.services.gmail.Gmail$Users$Drafts$Send send(String userId, com.google.api.services.gmail.model.Draft content)
-com.google.api.services.gmail.Gmail$Users$Drafts$Send send(String userId, com.google.api.services.gmail.model.Draft content, com.google.api.client.http.AbstractInputStreamContent mediaContent)
-com.google.api.services.gmail.Gmail$Users$Drafts$Update update(String userId, String id, com.google.api.services.gmail.model.Draft content)
-com.google.api.services.gmail.Gmail$Users$Drafts$Update update(String userId, String id, com.google.api.services.gmail.model.Draft content, com.google.api.client.http.AbstractInputStreamContent mediaContent)
+
+com.google.api.services.gmail.Gmail.Users.Drafts.Create create(String userId, com.google.api.services.gmail.model.Draft content);
+
+com.google.api.services.gmail.Gmail.Users.Drafts.Create create(String userId, com.google.api.services.gmail.model.Draft content, com.google.api.client.http.AbstractInputStreamContent mediaContent);
+
+com.google.api.services.gmail.Gmail.Users.Drafts.Delete delete(String userId, String id);
+
+com.google.api.services.gmail.Gmail.Users.Drafts.Get get(String userId, String id);
+
+com.google.api.services.gmail.Gmail.Users.Drafts.List list(String userId);
+
+com.google.api.services.gmail.Gmail.Users.Drafts.Send send(String userId, com.google.api.services.gmail.model.Draft content);
+
+com.google.api.services.gmail.Gmail.Users.Drafts.Send send(String userId, com.google.api.services.gmail.model.Draft content, com.google.api.client.http.AbstractInputStreamContent mediaContent);
+
+com.google.api.services.gmail.Gmail.Users.Drafts.Update update(String userId, String id, com.google.api.services.gmail.model.Draft content);
+
+com.google.api.services.gmail.Gmail.Users.Drafts.Update update(String userId, String id, com.google.api.services.gmail.model.Draft content, com.google.api.client.http.AbstractInputStreamContent mediaContent);
+
+----
+
+The drafts API is defined in the syntax as follows:
----
+google-mail:drafts/methodName?[parameters]
+----
+
+The 6 method(s) is listed in the table below.
+(API methods can have a shorthand alias name which can be used in the syntax instead of the name)
+
+[width="100%",cols="2,2,6",options="header"]
+|===
+| Method | Alias | Description
+| *create* | | Creates a new draft with the DRAFT label
+| *delete* | | Immediately and permanently deletes the specified draft
+| *get* | | Gets the specified draft
+| *list* | | Lists the drafts in the user's mailbox
+| *send* | | Sends the specified, existing draft to the recipients in the To, Cc, and Bcc headers
+| *update* | | Replaces a draft's content
+|===
-The API methods has the following set of options listed in the following table:
-[width="100%",cols="1,2,5,2",options="header"]
+The drafts API method(s) has the following set of parameters listed in the table below:
+[width="100%",cols="2,2,4,2",options="header"]
|===
-| Method | Name | Description | Type
+| Method | Parameter | Description | Type
| create | *content* | The com.google.api.services.gmail.model.Draft media metadata or null if none | Draft
| create | *mediaContent* | The media HTTP content or null if none | AbstractInputStreamContent
| create | *userId* | The user's email address. The special value me can be used to indicate the authenticated user. default: me | String
@@ -266,29 +348,58 @@ The API methods has the following set of options listed in the following table:
| update | *userId* | The user's email address. The special value me can be used to indicate the authenticated user. default: me | String
|===
+In addition to the parameters above, the drafts API can also use from the 28 endpoint query option
+which is listed in the _Query Parameters_ section.
==== labels
-The labels has 6 API method(s) which is represented by the following method signatures
+The labels API has 6 method(s) which is represented by the following method signatures
(an API method may have multiple signatures due to overloading):
+[source,java]
----
-com.google.api.services.gmail.Gmail$Users$Labels$Create create(String userId, com.google.api.services.gmail.model.Label content)
-com.google.api.services.gmail.Gmail$Users$Labels$Delete delete(String userId, String id)
-com.google.api.services.gmail.Gmail$Users$Labels$Get get(String userId, String id)
-com.google.api.services.gmail.Gmail$Users$Labels$List list(String userId)
-com.google.api.services.gmail.Gmail$Users$Labels$Patch patch(String userId, String id, com.google.api.services.gmail.model.Label content)
-com.google.api.services.gmail.Gmail$Users$Labels$Update update(String userId, String id, com.google.api.services.gmail.model.Label content)
+
+com.google.api.services.gmail.Gmail.Users.Labels.Create create(String userId, com.google.api.services.gmail.model.Label content);
+
+com.google.api.services.gmail.Gmail.Users.Labels.Delete delete(String userId, String id);
+
+com.google.api.services.gmail.Gmail.Users.Labels.Get get(String userId, String id);
+
+com.google.api.services.gmail.Gmail.Users.Labels.List list(String userId);
+
+com.google.api.services.gmail.Gmail.Users.Labels.Patch patch(String userId, String id, com.google.api.services.gmail.model.Label content);
+
+com.google.api.services.gmail.Gmail.Users.Labels.Update update(String userId, String id, com.google.api.services.gmail.model.Label content);
----
-The API methods has the following set of options listed in the following table:
-[width="100%",cols="1,2,5,2",options="header"]
+The labels API is defined in the syntax as follows:
+
+----
+google-mail:labels/methodName?[parameters]
+----
+
+The 6 method(s) is listed in the table below.
+(API methods can have a shorthand alias name which can be used in the syntax instead of the name)
+
+[width="100%",cols="2,2,6",options="header"]
+|===
+| Method | Alias | Description
+| *create* | | Creates a new label
+| *delete* | | Immediately and permanently deletes the specified label and removes it from any messages and threads that it is applied to
+| *get* | | Gets the specified label
+| *list* | | Lists all labels in the user's mailbox
+| *patch* | | Updates the specified label
+| *update* | | Updates the specified label
+|===
+
+The labels API method(s) has the following set of parameters listed in the table below:
+[width="100%",cols="2,2,4,2",options="header"]
|===
-| Method | Name | Description | Type
+| Method | Parameter | Description | Type
| create | *content* | The com.google.api.services.gmail.model.Label | Label
| create | *userId* | The user's email address. The special value me can be used to indicate the authenticated user. default: me | String
| delete | *id* | The ID of the label to delete | String
@@ -304,81 +415,161 @@ The API methods has the following set of options listed in the following table:
| update | *userId* | The user's email address. The special value me can be used to indicate the authenticated user. default: me | String
|===
+In addition to the parameters above, the labels API can also use from the 28 endpoint query option
+which is listed in the _Query Parameters_ section.
==== history
-The history has 1 API method(s) which is represented by the following method signatures
+The history API has 1 method(s) which is represented by the following method signatures
(an API method may have multiple signatures due to overloading):
+[source,java]
+----
+
+com.google.api.services.gmail.Gmail.Users.History.List list(String userId);
+
----
-com.google.api.services.gmail.Gmail$Users$History$List list(String userId)
+The history API is defined in the syntax as follows:
+
+----
+google-mail:history/methodName?[parameters]
----
-The API methods has the following set of options listed in the following table:
-[width="100%",cols="1,2,5,2",options="header"]
+The 1 method(s) is listed in the table below.
+(API methods can have a shorthand alias name which can be used in the syntax instead of the name)
+
+[width="100%",cols="2,2,6",options="header"]
+|===
+| Method | Alias | Description
+| *list* | | Lists the history of all changes to the given mailbox
+|===
+
+The history API method(s) has the following set of parameters listed in the table below:
+[width="100%",cols="2,2,4,2",options="header"]
|===
-| Method | Name | Description | Type
+| Method | Parameter | Description | Type
| list | *userId* | The user's email address. The special value me can be used to indicate the authenticated user. default: me | String
|===
+In addition to the parameters above, the history API can also use from the 28 endpoint query option
+which is listed in the _Query Parameters_ section.
==== attachments
-The attachments has 1 API method(s) which is represented by the following method signatures
+The attachments API has 1 method(s) which is represented by the following method signatures
(an API method may have multiple signatures due to overloading):
+[source,java]
+----
+
+com.google.api.services.gmail.Gmail.Users.Messages.Attachments.Get get(String userId, String messageId, String id);
+
----
-com.google.api.services.gmail.Gmail$Users$Messages$Attachments$Get get(String userId, String messageId, String id)
+The attachments API is defined in the syntax as follows:
+
+----
+google-mail:attachments/methodName?[parameters]
----
-The API methods has the following set of options listed in the following table:
-[width="100%",cols="1,2,5,2",options="header"]
+The 1 method(s) is listed in the table below.
+(API methods can have a shorthand alias name which can be used in the syntax instead of the name)
+
+[width="100%",cols="2,2,6",options="header"]
+|===
+| Method | Alias | Description
+| *get* | | Gets the specified message attachment
+|===
+
+The attachments API method(s) has the following set of parameters listed in the table below:
+[width="100%",cols="2,2,4,2",options="header"]
|===
-| Method | Name | Description | Type
+| Method | Parameter | Description | Type
| get | *id* | The ID of the attachment | String
| get | *messageId* | The ID of the message containing the attachment | String
| get | *userId* | The user's email address. The special value me can be used to indicate the authenticated user. default: me | String
|===
+In addition to the parameters above, the attachments API can also use from the 28 endpoint query option
+which is listed in the _Query Parameters_ section.
==== messages
-The messages has 11 API method(s) which is represented by the following method signatures
+The messages API has 11 method(s) which is represented by the following method signatures
(an API method may have multiple signatures due to overloading):
+[source,java]
+----
+
+com.google.api.services.gmail.Gmail.Users.Messages.BatchDelete batchDelete(String userId, com.google.api.services.gmail.model.BatchDeleteMessagesRequest content);
+
+com.google.api.services.gmail.Gmail.Users.Messages.BatchModify batchModify(String userId, com.google.api.services.gmail.model.BatchModifyMessagesRequest content);
+
+com.google.api.services.gmail.Gmail.Users.Messages.Delete delete(String userId, String id);
+
+com.google.api.services.gmail.Gmail.Users.Messages.Get get(String userId, String id);
+
+com.google.api.services.gmail.Gmail.Users.Messages.GmailImport gmailImport(String userId, com.google.api.services.gmail.model.Message content);
+
+com.google.api.services.gmail.Gmail.Users.Messages.GmailImport gmailImport(String userId, com.google.api.services.gmail.model.Message content, com.google.api.client.http.AbstractInputStreamContent mediaContent);
+
+com.google.api.services.gmail.Gmail.Users.Messages.Insert insert(String userId, com.google.api.services.gmail.model.Message content);
+
+com.google.api.services.gmail.Gmail.Users.Messages.Insert insert(String userId, com.google.api.services.gmail.model.Message content, com.google.api.client.http.AbstractInputStreamContent mediaContent);
+
+com.google.api.services.gmail.Gmail.Users.Messages.List list(String userId);
+
+com.google.api.services.gmail.Gmail.Users.Messages.Modify modify(String userId, String id, com.google.api.services.gmail.model.ModifyMessageRequest content);
+
+com.google.api.services.gmail.Gmail.Users.Messages.Send send(String userId, com.google.api.services.gmail.model.Message content);
+
+com.google.api.services.gmail.Gmail.Users.Messages.Send send(String userId, com.google.api.services.gmail.model.Message content, com.google.api.client.http.AbstractInputStreamContent mediaContent);
+
+com.google.api.services.gmail.Gmail.Users.Messages.Trash trash(String userId, String id);
+
+com.google.api.services.gmail.Gmail.Users.Messages.Untrash untrash(String userId, String id);
+
----
-com.google.api.services.gmail.Gmail$Users$Messages$BatchDelete batchDelete(String userId, com.google.api.services.gmail.model.BatchDeleteMessagesRequest content)
-com.google.api.services.gmail.Gmail$Users$Messages$BatchModify batchModify(String userId, com.google.api.services.gmail.model.BatchModifyMessagesRequest content)
-com.google.api.services.gmail.Gmail$Users$Messages$Delete delete(String userId, String id)
-com.google.api.services.gmail.Gmail$Users$Messages$Get get(String userId, String id)
-com.google.api.services.gmail.Gmail$Users$Messages$GmailImport gmailImport(String userId, com.google.api.services.gmail.model.Message content)
-com.google.api.services.gmail.Gmail$Users$Messages$GmailImport gmailImport(String userId, com.google.api.services.gmail.model.Message content, com.google.api.client.http.AbstractInputStreamContent mediaContent)
-com.google.api.services.gmail.Gmail$Users$Messages$Insert insert(String userId, com.google.api.services.gmail.model.Message content)
-com.google.api.services.gmail.Gmail$Users$Messages$Insert insert(String userId, com.google.api.services.gmail.model.Message content, com.google.api.client.http.AbstractInputStreamContent mediaContent)
-com.google.api.services.gmail.Gmail$Users$Messages$List list(String userId)
-com.google.api.services.gmail.Gmail$Users$Messages$Modify modify(String userId, String id, com.google.api.services.gmail.model.ModifyMessageRequest content)
-com.google.api.services.gmail.Gmail$Users$Messages$Send send(String userId, com.google.api.services.gmail.model.Message content)
-com.google.api.services.gmail.Gmail$Users$Messages$Send send(String userId, com.google.api.services.gmail.model.Message content, com.google.api.client.http.AbstractInputStreamContent mediaContent)
-com.google.api.services.gmail.Gmail$Users$Messages$Trash trash(String userId, String id)
-com.google.api.services.gmail.Gmail$Users$Messages$Untrash untrash(String userId, String id)
+
+The messages API is defined in the syntax as follows:
----
+google-mail:messages/methodName?[parameters]
+----
+
+The 11 method(s) is listed in the table below.
+(API methods can have a shorthand alias name which can be used in the syntax instead of the name)
+
+[width="100%",cols="2,2,6",options="header"]
+|===
+| Method | Alias | Description
+| *batchDelete* | | Deletes many messages by message ID
+| *batchModify* | | Modifies the labels on the specified messages
+| *delete* | | Immediately and permanently deletes the specified message
+| *get* | | Gets the specified message
+| *gmailImport* | | Imports a message into only this user's mailbox, with standard email delivery scanning and classification similar to receiving via SMTP
+| *insert* | | Directly inserts a message into only this user's mailbox similar to IMAP APPEND, bypassing most scanning and classification
+| *list* | | Lists the messages in the user's mailbox
+| *modify* | | Modifies the labels on the specified message
+| *send* | | Sends the specified message to the recipients in the To, Cc, and Bcc headers
+| *trash* | | Moves the specified message to the trash
+| *untrash* | | Removes the specified message from the trash
+|===
-The API methods has the following set of options listed in the following table:
-[width="100%",cols="1,2,5,2",options="header"]
+The messages API method(s) has the following set of parameters listed in the table below:
+[width="100%",cols="2,2,4,2",options="header"]
|===
-| Method | Name | Description | Type
+| Method | Parameter | Description | Type
| batchDelete | *batchDeleteMessagesRequest* | The com.google.api.services.gmail.model.BatchDeleteMessagesRequest | BatchDeleteMessagesRequest
| batchDelete | *userId* | The user's email address. The special value me can be used to indicate the authenticated user. default: me | String
| batchModify | *batchModifyMessagesRequest* | The com.google.api.services.gmail.model.BatchModifyMessagesRequest | BatchModifyMessagesRequest
@@ -405,6 +596,9 @@ The API methods has the following set of options listed in the following table:
| untrash | *id* | The ID of the message to remove from Trash | String
| untrash | *userId* | The user's email address. The special value me can be used to indicate the authenticated user. default: me | String
|===
+
+In addition to the parameters above, the messages API can also use from the 28 endpoint query option
+which is listed in the _Query Parameters_ section.
// endpoint options: END
diff --git a/components/camel-google-mail/src/main/docs/google-mail-stream-component.adoc b/components/camel-google-mail/src/main/docs/google-mail-stream-component.adoc
index a357f2c..506d6fc 100644
--- a/components/camel-google-mail/src/main/docs/google-mail-stream-component.adoc
+++ b/components/camel-google-mail/src/main/docs/google-mail-stream-component.adoc
@@ -153,49 +153,99 @@ The following lists each API name and method and its additional parameters.
==== users
-The users has 3 API method(s) which is represented by the following method signatures
+The users API has 3 method(s) which is represented by the following method signatures
(an API method may have multiple signatures due to overloading):
+[source,java]
----
-com.google.api.services.gmail.Gmail$Users$GetProfile getProfile(String userId)
-com.google.api.services.gmail.Gmail$Users$Stop stop(String userId)
-com.google.api.services.gmail.Gmail$Users$Watch watch(String userId, com.google.api.services.gmail.model.WatchRequest content)
+
+com.google.api.services.gmail.Gmail.Users.GetProfile getProfile(String userId);
+
+com.google.api.services.gmail.Gmail.Users.Stop stop(String userId);
+
+com.google.api.services.gmail.Gmail.Users.Watch watch(String userId, com.google.api.services.gmail.model.WatchRequest content);
----
-The API methods has the following set of options listed in the following table:
-[width="100%",cols="1,2,5,2",options="header"]
+The users API is defined in the syntax as follows:
+
+----
+google-mail-stream:users/methodName?[parameters]
+----
+
+The 3 method(s) is listed in the table below.
+(API methods can have a shorthand alias name which can be used in the syntax instead of the name)
+
+[width="100%",cols="2,2,6",options="header"]
+|===
+| Method | Alias | Description
+| *getProfile* | | Gets the current user's Gmail profile
+| *stop* | | Stop receiving push notifications for the given user mailbox
+| *watch* | | Set up or update a push notification watch on the given user mailbox
|===
-| Method | Name | Description | Type
+
+The users API method(s) has the following set of parameters listed in the table below:
+[width="100%",cols="2,2,4,2",options="header"]
+|===
+| Method | Parameter | Description | Type
| getProfile | *userId* | The user's email address. The special value me can be used to indicate the authenticated user. default: me | String
| stop | *userId* | The user's email address. The special value me can be used to indicate the authenticated user. default: me | String
| watch | *content* | The com.google.api.services.gmail.model.WatchRequest | WatchRequest
| watch | *userId* | The user's email address. The special value me can be used to indicate the authenticated user. default: me | String
|===
+In addition to the parameters above, the users API can also use from the 30 endpoint query option
+which is listed in the _Query Parameters_ section.
==== threads
-The threads has 6 API method(s) which is represented by the following method signatures
+The threads API has 6 method(s) which is represented by the following method signatures
(an API method may have multiple signatures due to overloading):
+[source,java]
+----
+
+com.google.api.services.gmail.Gmail.Users.Threads.Delete delete(String userId, String id);
+
+com.google.api.services.gmail.Gmail.Users.Threads.Get get(String userId, String id);
+
+com.google.api.services.gmail.Gmail.Users.Threads.List list(String userId);
+
+com.google.api.services.gmail.Gmail.Users.Threads.Modify modify(String userId, String id, com.google.api.services.gmail.model.ModifyThreadRequest content);
+
+com.google.api.services.gmail.Gmail.Users.Threads.Trash trash(String userId, String id);
+
+com.google.api.services.gmail.Gmail.Users.Threads.Untrash untrash(String userId, String id);
+
----
-com.google.api.services.gmail.Gmail$Users$Threads$Delete delete(String userId, String id)
-com.google.api.services.gmail.Gmail$Users$Threads$Get get(String userId, String id)
-com.google.api.services.gmail.Gmail$Users$Threads$List list(String userId)
-com.google.api.services.gmail.Gmail$Users$Threads$Modify modify(String userId, String id, com.google.api.services.gmail.model.ModifyThreadRequest content)
-com.google.api.services.gmail.Gmail$Users$Threads$Trash trash(String userId, String id)
-com.google.api.services.gmail.Gmail$Users$Threads$Untrash untrash(String userId, String id)
+The threads API is defined in the syntax as follows:
+
+----
+google-mail-stream:threads/methodName?[parameters]
----
-The API methods has the following set of options listed in the following table:
-[width="100%",cols="1,2,5,2",options="header"]
+The 6 method(s) is listed in the table below.
+(API methods can have a shorthand alias name which can be used in the syntax instead of the name)
+
+[width="100%",cols="2,2,6",options="header"]
+|===
+| Method | Alias | Description
+| *delete* | | Immediately and permanently deletes the specified thread
+| *get* | | Gets the specified thread
+| *list* | | Lists the threads in the user's mailbox
+| *modify* | | Modifies the labels applied to the thread
+| *trash* | | Moves the specified thread to the trash
+| *untrash* | | Removes the specified thread from the trash
+|===
+
+The threads API method(s) has the following set of parameters listed in the table below:
+[width="100%",cols="2,2,4,2",options="header"]
|===
-| Method | Name | Description | Type
+| Method | Parameter | Description | Type
| delete | *id* | ID of the Thread to delete | String
| delete | *userId* | The user's email address. The special value me can be used to indicate the authenticated user. default: me | String
| get | *id* | The ID of the thread to retrieve | String
@@ -210,32 +260,64 @@ The API methods has the following set of options listed in the following table:
| untrash | *userId* | The user's email address. The special value me can be used to indicate the authenticated user. default: me | String
|===
+In addition to the parameters above, the threads API can also use from the 30 endpoint query option
+which is listed in the _Query Parameters_ section.
==== drafts
-The drafts has 6 API method(s) which is represented by the following method signatures
+The drafts API has 6 method(s) which is represented by the following method signatures
(an API method may have multiple signatures due to overloading):
+[source,java]
+----
+
+com.google.api.services.gmail.Gmail.Users.Drafts.Create create(String userId, com.google.api.services.gmail.model.Draft content);
+
+com.google.api.services.gmail.Gmail.Users.Drafts.Create create(String userId, com.google.api.services.gmail.model.Draft content, com.google.api.client.http.AbstractInputStreamContent mediaContent);
+
+com.google.api.services.gmail.Gmail.Users.Drafts.Delete delete(String userId, String id);
+
+com.google.api.services.gmail.Gmail.Users.Drafts.Get get(String userId, String id);
+
+com.google.api.services.gmail.Gmail.Users.Drafts.List list(String userId);
+
+com.google.api.services.gmail.Gmail.Users.Drafts.Send send(String userId, com.google.api.services.gmail.model.Draft content);
+
+com.google.api.services.gmail.Gmail.Users.Drafts.Send send(String userId, com.google.api.services.gmail.model.Draft content, com.google.api.client.http.AbstractInputStreamContent mediaContent);
+
+com.google.api.services.gmail.Gmail.Users.Drafts.Update update(String userId, String id, com.google.api.services.gmail.model.Draft content);
+
+com.google.api.services.gmail.Gmail.Users.Drafts.Update update(String userId, String id, com.google.api.services.gmail.model.Draft content, com.google.api.client.http.AbstractInputStreamContent mediaContent);
+
----
-com.google.api.services.gmail.Gmail$Users$Drafts$Create create(String userId, com.google.api.services.gmail.model.Draft content)
-com.google.api.services.gmail.Gmail$Users$Drafts$Create create(String userId, com.google.api.services.gmail.model.Draft content, com.google.api.client.http.AbstractInputStreamContent mediaContent)
-com.google.api.services.gmail.Gmail$Users$Drafts$Delete delete(String userId, String id)
-com.google.api.services.gmail.Gmail$Users$Drafts$Get get(String userId, String id)
-com.google.api.services.gmail.Gmail$Users$Drafts$List list(String userId)
-com.google.api.services.gmail.Gmail$Users$Drafts$Send send(String userId, com.google.api.services.gmail.model.Draft content)
-com.google.api.services.gmail.Gmail$Users$Drafts$Send send(String userId, com.google.api.services.gmail.model.Draft content, com.google.api.client.http.AbstractInputStreamContent mediaContent)
-com.google.api.services.gmail.Gmail$Users$Drafts$Update update(String userId, String id, com.google.api.services.gmail.model.Draft content)
-com.google.api.services.gmail.Gmail$Users$Drafts$Update update(String userId, String id, com.google.api.services.gmail.model.Draft content, com.google.api.client.http.AbstractInputStreamContent mediaContent)
+The drafts API is defined in the syntax as follows:
+
+----
+google-mail-stream:drafts/methodName?[parameters]
----
-The API methods has the following set of options listed in the following table:
-[width="100%",cols="1,2,5,2",options="header"]
+The 6 method(s) is listed in the table below.
+(API methods can have a shorthand alias name which can be used in the syntax instead of the name)
+
+[width="100%",cols="2,2,6",options="header"]
+|===
+| Method | Alias | Description
+| *create* | | Creates a new draft with the DRAFT label
+| *delete* | | Immediately and permanently deletes the specified draft
+| *get* | | Gets the specified draft
+| *list* | | Lists the drafts in the user's mailbox
+| *send* | | Sends the specified, existing draft to the recipients in the To, Cc, and Bcc headers
+| *update* | | Replaces a draft's content
|===
-| Method | Name | Description | Type
+
+The drafts API method(s) has the following set of parameters listed in the table below:
+[width="100%",cols="2,2,4,2",options="header"]
+|===
+| Method | Parameter | Description | Type
| create | *content* | The com.google.api.services.gmail.model.Draft media metadata or null if none | Draft
| create | *mediaContent* | The media HTTP content or null if none | AbstractInputStreamContent
| create | *userId* | The user's email address. The special value me can be used to indicate the authenticated user. default: me | String
@@ -253,29 +335,58 @@ The API methods has the following set of options listed in the following table:
| update | *userId* | The user's email address. The special value me can be used to indicate the authenticated user. default: me | String
|===
+In addition to the parameters above, the drafts API can also use from the 30 endpoint query option
+which is listed in the _Query Parameters_ section.
==== labels
-The labels has 6 API method(s) which is represented by the following method signatures
+The labels API has 6 method(s) which is represented by the following method signatures
(an API method may have multiple signatures due to overloading):
+[source,java]
+----
+
+com.google.api.services.gmail.Gmail.Users.Labels.Create create(String userId, com.google.api.services.gmail.model.Label content);
+
+com.google.api.services.gmail.Gmail.Users.Labels.Delete delete(String userId, String id);
+
+com.google.api.services.gmail.Gmail.Users.Labels.Get get(String userId, String id);
+
+com.google.api.services.gmail.Gmail.Users.Labels.List list(String userId);
+
+com.google.api.services.gmail.Gmail.Users.Labels.Patch patch(String userId, String id, com.google.api.services.gmail.model.Label content);
+
+com.google.api.services.gmail.Gmail.Users.Labels.Update update(String userId, String id, com.google.api.services.gmail.model.Label content);
+
----
-com.google.api.services.gmail.Gmail$Users$Labels$Create create(String userId, com.google.api.services.gmail.model.Label content)
-com.google.api.services.gmail.Gmail$Users$Labels$Delete delete(String userId, String id)
-com.google.api.services.gmail.Gmail$Users$Labels$Get get(String userId, String id)
-com.google.api.services.gmail.Gmail$Users$Labels$List list(String userId)
-com.google.api.services.gmail.Gmail$Users$Labels$Patch patch(String userId, String id, com.google.api.services.gmail.model.Label content)
-com.google.api.services.gmail.Gmail$Users$Labels$Update update(String userId, String id, com.google.api.services.gmail.model.Label content)
+The labels API is defined in the syntax as follows:
+
+----
+google-mail-stream:labels/methodName?[parameters]
----
-The API methods has the following set of options listed in the following table:
-[width="100%",cols="1,2,5,2",options="header"]
+The 6 method(s) is listed in the table below.
+(API methods can have a shorthand alias name which can be used in the syntax instead of the name)
+
+[width="100%",cols="2,2,6",options="header"]
+|===
+| Method | Alias | Description
+| *create* | | Creates a new label
+| *delete* | | Immediately and permanently deletes the specified label and removes it from any messages and threads that it is applied to
+| *get* | | Gets the specified label
+| *list* | | Lists all labels in the user's mailbox
+| *patch* | | Updates the specified label
+| *update* | | Updates the specified label
|===
-| Method | Name | Description | Type
+
+The labels API method(s) has the following set of parameters listed in the table below:
+[width="100%",cols="2,2,4,2",options="header"]
+|===
+| Method | Parameter | Description | Type
| create | *content* | The com.google.api.services.gmail.model.Label | Label
| create | *userId* | The user's email address. The special value me can be used to indicate the authenticated user. default: me | String
| delete | *id* | The ID of the label to delete | String
@@ -291,81 +402,161 @@ The API methods has the following set of options listed in the following table:
| update | *userId* | The user's email address. The special value me can be used to indicate the authenticated user. default: me | String
|===
+In addition to the parameters above, the labels API can also use from the 30 endpoint query option
+which is listed in the _Query Parameters_ section.
==== history
-The history has 1 API method(s) which is represented by the following method signatures
+The history API has 1 method(s) which is represented by the following method signatures
(an API method may have multiple signatures due to overloading):
+[source,java]
+----
+
+com.google.api.services.gmail.Gmail.Users.History.List list(String userId);
+
----
-com.google.api.services.gmail.Gmail$Users$History$List list(String userId)
+
+The history API is defined in the syntax as follows:
----
+google-mail-stream:history/methodName?[parameters]
+----
+
+The 1 method(s) is listed in the table below.
+(API methods can have a shorthand alias name which can be used in the syntax instead of the name)
-The API methods has the following set of options listed in the following table:
-[width="100%",cols="1,2,5,2",options="header"]
+[width="100%",cols="2,2,6",options="header"]
|===
-| Method | Name | Description | Type
+| Method | Alias | Description
+| *list* | | Lists the history of all changes to the given mailbox
+|===
+
+The history API method(s) has the following set of parameters listed in the table below:
+[width="100%",cols="2,2,4,2",options="header"]
+|===
+| Method | Parameter | Description | Type
| list | *userId* | The user's email address. The special value me can be used to indicate the authenticated user. default: me | String
|===
+In addition to the parameters above, the history API can also use from the 30 endpoint query option
+which is listed in the _Query Parameters_ section.
==== attachments
-The attachments has 1 API method(s) which is represented by the following method signatures
+The attachments API has 1 method(s) which is represented by the following method signatures
(an API method may have multiple signatures due to overloading):
+[source,java]
----
-com.google.api.services.gmail.Gmail$Users$Messages$Attachments$Get get(String userId, String messageId, String id)
+
+com.google.api.services.gmail.Gmail.Users.Messages.Attachments.Get get(String userId, String messageId, String id);
----
-The API methods has the following set of options listed in the following table:
-[width="100%",cols="1,2,5,2",options="header"]
+The attachments API is defined in the syntax as follows:
+
+----
+google-mail-stream:attachments/methodName?[parameters]
+----
+
+The 1 method(s) is listed in the table below.
+(API methods can have a shorthand alias name which can be used in the syntax instead of the name)
+
+[width="100%",cols="2,2,6",options="header"]
+|===
+| Method | Alias | Description
+| *get* | | Gets the specified message attachment
+|===
+
+The attachments API method(s) has the following set of parameters listed in the table below:
+[width="100%",cols="2,2,4,2",options="header"]
|===
-| Method | Name | Description | Type
+| Method | Parameter | Description | Type
| get | *id* | The ID of the attachment | String
| get | *messageId* | The ID of the message containing the attachment | String
| get | *userId* | The user's email address. The special value me can be used to indicate the authenticated user. default: me | String
|===
+In addition to the parameters above, the attachments API can also use from the 30 endpoint query option
+which is listed in the _Query Parameters_ section.
==== messages
-The messages has 11 API method(s) which is represented by the following method signatures
+The messages API has 11 method(s) which is represented by the following method signatures
(an API method may have multiple signatures due to overloading):
+[source,java]
+----
+
+com.google.api.services.gmail.Gmail.Users.Messages.BatchDelete batchDelete(String userId, com.google.api.services.gmail.model.BatchDeleteMessagesRequest content);
+
+com.google.api.services.gmail.Gmail.Users.Messages.BatchModify batchModify(String userId, com.google.api.services.gmail.model.BatchModifyMessagesRequest content);
+
+com.google.api.services.gmail.Gmail.Users.Messages.Delete delete(String userId, String id);
+
+com.google.api.services.gmail.Gmail.Users.Messages.Get get(String userId, String id);
+
+com.google.api.services.gmail.Gmail.Users.Messages.GmailImport gmailImport(String userId, com.google.api.services.gmail.model.Message content);
+
+com.google.api.services.gmail.Gmail.Users.Messages.GmailImport gmailImport(String userId, com.google.api.services.gmail.model.Message content, com.google.api.client.http.AbstractInputStreamContent mediaContent);
+
+com.google.api.services.gmail.Gmail.Users.Messages.Insert insert(String userId, com.google.api.services.gmail.model.Message content);
+
+com.google.api.services.gmail.Gmail.Users.Messages.Insert insert(String userId, com.google.api.services.gmail.model.Message content, com.google.api.client.http.AbstractInputStreamContent mediaContent);
+
+com.google.api.services.gmail.Gmail.Users.Messages.List list(String userId);
+
+com.google.api.services.gmail.Gmail.Users.Messages.Modify modify(String userId, String id, com.google.api.services.gmail.model.ModifyMessageRequest content);
+
+com.google.api.services.gmail.Gmail.Users.Messages.Send send(String userId, com.google.api.services.gmail.model.Message content);
+
+com.google.api.services.gmail.Gmail.Users.Messages.Send send(String userId, com.google.api.services.gmail.model.Message content, com.google.api.client.http.AbstractInputStreamContent mediaContent);
+
+com.google.api.services.gmail.Gmail.Users.Messages.Trash trash(String userId, String id);
+
+com.google.api.services.gmail.Gmail.Users.Messages.Untrash untrash(String userId, String id);
+
----
-com.google.api.services.gmail.Gmail$Users$Messages$BatchDelete batchDelete(String userId, com.google.api.services.gmail.model.BatchDeleteMessagesRequest content)
-com.google.api.services.gmail.Gmail$Users$Messages$BatchModify batchModify(String userId, com.google.api.services.gmail.model.BatchModifyMessagesRequest content)
-com.google.api.services.gmail.Gmail$Users$Messages$Delete delete(String userId, String id)
-com.google.api.services.gmail.Gmail$Users$Messages$Get get(String userId, String id)
-com.google.api.services.gmail.Gmail$Users$Messages$GmailImport gmailImport(String userId, com.google.api.services.gmail.model.Message content)
-com.google.api.services.gmail.Gmail$Users$Messages$GmailImport gmailImport(String userId, com.google.api.services.gmail.model.Message content, com.google.api.client.http.AbstractInputStreamContent mediaContent)
-com.google.api.services.gmail.Gmail$Users$Messages$Insert insert(String userId, com.google.api.services.gmail.model.Message content)
-com.google.api.services.gmail.Gmail$Users$Messages$Insert insert(String userId, com.google.api.services.gmail.model.Message content, com.google.api.client.http.AbstractInputStreamContent mediaContent)
-com.google.api.services.gmail.Gmail$Users$Messages$List list(String userId)
-com.google.api.services.gmail.Gmail$Users$Messages$Modify modify(String userId, String id, com.google.api.services.gmail.model.ModifyMessageRequest content)
-com.google.api.services.gmail.Gmail$Users$Messages$Send send(String userId, com.google.api.services.gmail.model.Message content)
-com.google.api.services.gmail.Gmail$Users$Messages$Send send(String userId, com.google.api.services.gmail.model.Message content, com.google.api.client.http.AbstractInputStreamContent mediaContent)
-com.google.api.services.gmail.Gmail$Users$Messages$Trash trash(String userId, String id)
-com.google.api.services.gmail.Gmail$Users$Messages$Untrash untrash(String userId, String id)
+
+The messages API is defined in the syntax as follows:
----
+google-mail-stream:messages/methodName?[parameters]
+----
+
+The 11 method(s) is listed in the table below.
+(API methods can have a shorthand alias name which can be used in the syntax instead of the name)
+
+[width="100%",cols="2,2,6",options="header"]
+|===
+| Method | Alias | Description
+| *batchDelete* | | Deletes many messages by message ID
+| *batchModify* | | Modifies the labels on the specified messages
+| *delete* | | Immediately and permanently deletes the specified message
+| *get* | | Gets the specified message
+| *gmailImport* | | Imports a message into only this user's mailbox, with standard email delivery scanning and classification similar to receiving via SMTP
+| *insert* | | Directly inserts a message into only this user's mailbox similar to IMAP APPEND, bypassing most scanning and classification
+| *list* | | Lists the messages in the user's mailbox
+| *modify* | | Modifies the labels on the specified message
+| *send* | | Sends the specified message to the recipients in the To, Cc, and Bcc headers
+| *trash* | | Moves the specified message to the trash
+| *untrash* | | Removes the specified message from the trash
+|===
-The API methods has the following set of options listed in the following table:
-[width="100%",cols="1,2,5,2",options="header"]
+The messages API method(s) has the following set of parameters listed in the table below:
+[width="100%",cols="2,2,4,2",options="header"]
|===
-| Method | Name | Description | Type
+| Method | Parameter | Description | Type
| batchDelete | *batchDeleteMessagesRequest* | The com.google.api.services.gmail.model.BatchDeleteMessagesRequest | BatchDeleteMessagesRequest
| batchDelete | *userId* | The user's email address. The special value me can be used to indicate the authenticated user. default: me | String
| batchModify | *batchModifyMessagesRequest* | The com.google.api.services.gmail.model.BatchModifyMessagesRequest | BatchModifyMessagesRequest
@@ -392,6 +583,9 @@ The API methods has the following set of options listed in the following table:
| untrash | *id* | The ID of the message to remove from Trash | String
| untrash | *userId* | The user's email address. The special value me can be used to indicate the authenticated user. default: me | String
|===
+
+In addition to the parameters above, the messages API can also use from the 30 endpoint query option
+which is listed in the _Query Parameters_ section.
// endpoint options: END
diff --git a/components/camel-google-sheets/src/main/docs/google-sheets-component.adoc b/components/camel-google-sheets/src/main/docs/google-sheets-component.adoc
index 3f30a7f..31837c7 100644
--- a/components/camel-google-sheets/src/main/docs/google-sheets-component.adoc
+++ b/components/camel-google-sheets/src/main/docs/google-sheets-component.adoc
@@ -162,21 +162,44 @@ The following lists each API name and method and its additional parameters.
==== spreadsheets
-The spreadsheets has 4 API method(s) which is represented by the following method signatures
+The spreadsheets API has 4 method(s) which is represented by the following method signatures
(an API method may have multiple signatures due to overloading):
+[source,java]
----
-com.google.api.services.sheets.v4.Sheets$Spreadsheets$BatchUpdate batchUpdate(String spreadsheetId, com.google.api.services.sheets.v4.model.BatchUpdateSpreadsheetRequest content)
-com.google.api.services.sheets.v4.Sheets$Spreadsheets$Create create(com.google.api.services.sheets.v4.model.Spreadsheet content)
-com.google.api.services.sheets.v4.Sheets$Spreadsheets$Get get(String spreadsheetId)
-com.google.api.services.sheets.v4.Sheets$Spreadsheets$GetByDataFilter getByDataFilter(String spreadsheetId, com.google.api.services.sheets.v4.model.GetSpreadsheetByDataFilterRequest content)
+com.google.api.services.sheets.v4.Sheets.Spreadsheets.BatchUpdate batchUpdate(String spreadsheetId, com.google.api.services.sheets.v4.model.BatchUpdateSpreadsheetRequest content);
+
+com.google.api.services.sheets.v4.Sheets.Spreadsheets.Create create(com.google.api.services.sheets.v4.model.Spreadsheet content);
+
+com.google.api.services.sheets.v4.Sheets.Spreadsheets.Get get(String spreadsheetId);
+
+com.google.api.services.sheets.v4.Sheets.Spreadsheets.GetByDataFilter getByDataFilter(String spreadsheetId, com.google.api.services.sheets.v4.model.GetSpreadsheetByDataFilterRequest content);
+
+----
+
+The spreadsheets API is defined in the syntax as follows:
+
+----
+google-sheets:spreadsheets/methodName?[parameters]
----
-The API methods has the following set of options listed in the following table:
-[width="100%",cols="1,2,5,2",options="header"]
+The 4 method(s) is listed in the table below.
+(API methods can have a shorthand alias name which can be used in the syntax instead of the name)
+
+[width="100%",cols="2,2,6",options="header"]
+|===
+| Method | Alias | Description
+| *batchUpdate* | | Applies one or more updates to the spreadsheet
+| *create* | | Creates a spreadsheet, returning the newly created spreadsheet
+| *get* | | Returns the spreadsheet at the given ID
+| *getByDataFilter* | | Returns the spreadsheet at the given ID
+|===
+
+The spreadsheets API method(s) has the following set of parameters listed in the table below:
+[width="100%",cols="2,2,4,2",options="header"]
|===
-| Method | Name | Description | Type
+| Method | Parameter | Description | Type
| batchUpdate | *batchUpdateSpreadsheetRequest* | The com.google.api.services.sheets.v4.model.BatchUpdateSpreadsheetRequest | BatchUpdateSpreadsheetRequest
| batchUpdate | *spreadsheetId* | The spreadsheet to apply the updates to | String
| create | *content* | The com.google.api.services.sheets.v4.model.Spreadsheet | Spreadsheet
@@ -185,33 +208,70 @@ The API methods has the following set of options listed in the following table:
| getByDataFilter | *spreadsheetId* | The spreadsheet to request | String
|===
+In addition to the parameters above, the spreadsheets API can also use from the 28 endpoint query option
+which is listed in the _Query Parameters_ section.
==== data
-The data has 10 API method(s) which is represented by the following method signatures
+The data API has 10 method(s) which is represented by the following method signatures
(an API method may have multiple signatures due to overloading):
+[source,java]
----
-com.google.api.services.sheets.v4.Sheets$Spreadsheets$Values$Append append(String spreadsheetId, String range, com.google.api.services.sheets.v4.model.ValueRange content)
-com.google.api.services.sheets.v4.Sheets$Spreadsheets$Values$BatchClear batchClear(String spreadsheetId, com.google.api.services.sheets.v4.model.BatchClearValuesRequest content)
-com.google.api.services.sheets.v4.Sheets$Spreadsheets$Values$BatchClearByDataFilter batchClearByDataFilter(String spreadsheetId, com.google.api.services.sheets.v4.model.BatchClearValuesByDataFilterRequest content)
-com.google.api.services.sheets.v4.Sheets$Spreadsheets$Values$BatchGet batchGet(String spreadsheetId)
-com.google.api.services.sheets.v4.Sheets$Spreadsheets$Values$BatchGetByDataFilter batchGetByDataFilter(String spreadsheetId, com.google.api.services.sheets.v4.model.BatchGetValuesByDataFilterRequest content)
-com.google.api.services.sheets.v4.Sheets$Spreadsheets$Values$BatchUpdate batchUpdate(String spreadsheetId, com.google.api.services.sheets.v4.model.BatchUpdateValuesRequest content)
-com.google.api.services.sheets.v4.Sheets$Spreadsheets$Values$BatchUpdateByDataFilter batchUpdateByDataFilter(String spreadsheetId, com.google.api.services.sheets.v4.model.BatchUpdateValuesByDataFilterRequest content)
-com.google.api.services.sheets.v4.Sheets$Spreadsheets$Values$Clear clear(String spreadsheetId, String range, com.google.api.services.sheets.v4.model.ClearValuesRequest content)
-com.google.api.services.sheets.v4.Sheets$Spreadsheets$Values$Get get(String spreadsheetId, String range)
-com.google.api.services.sheets.v4.Sheets$Spreadsheets$Values$Update update(String spreadsheetId, String range, com.google.api.services.sheets.v4.model.ValueRange content)
+
+com.google.api.services.sheets.v4.Sheets.Spreadsheets.Values.Append append(String spreadsheetId, String range, com.google.api.services.sheets.v4.model.ValueRange content);
+
+com.google.api.services.sheets.v4.Sheets.Spreadsheets.Values.BatchClear batchClear(String spreadsheetId, com.google.api.services.sheets.v4.model.BatchClearValuesRequest content);
+
+com.google.api.services.sheets.v4.Sheets.Spreadsheets.Values.BatchClearByDataFilter batchClearByDataFilter(String spreadsheetId, com.google.api.services.sheets.v4.model.BatchClearValuesByDataFilterRequest content);
+
+com.google.api.services.sheets.v4.Sheets.Spreadsheets.Values.BatchGet batchGet(String spreadsheetId);
+
+com.google.api.services.sheets.v4.Sheets.Spreadsheets.Values.BatchGetByDataFilter batchGetByDataFilter(String spreadsheetId, com.google.api.services.sheets.v4.model.BatchGetValuesByDataFilterRequest content);
+
+com.google.api.services.sheets.v4.Sheets.Spreadsheets.Values.BatchUpdate batchUpdate(String spreadsheetId, com.google.api.services.sheets.v4.model.BatchUpdateValuesRequest content);
+
+com.google.api.services.sheets.v4.Sheets.Spreadsheets.Values.BatchUpdateByDataFilter batchUpdateByDataFilter(String spreadsheetId, com.google.api.services.sheets.v4.model.BatchUpdateValuesByDataFilterRequest content);
+
+com.google.api.services.sheets.v4.Sheets.Spreadsheets.Values.Clear clear(String spreadsheetId, String range, com.google.api.services.sheets.v4.model.ClearValuesRequest content);
+
+com.google.api.services.sheets.v4.Sheets.Spreadsheets.Values.Get get(String spreadsheetId, String range);
+
+com.google.api.services.sheets.v4.Sheets.Spreadsheets.Values.Update update(String spreadsheetId, String range, com.google.api.services.sheets.v4.model.ValueRange content);
----
-The API methods has the following set of options listed in the following table:
-[width="100%",cols="1,2,5,2",options="header"]
+The data API is defined in the syntax as follows:
+
+----
+google-sheets:data/methodName?[parameters]
+----
+
+The 10 method(s) is listed in the table below.
+(API methods can have a shorthand alias name which can be used in the syntax instead of the name)
+
+[width="100%",cols="2,2,6",options="header"]
+|===
+| Method | Alias | Description
+| *append* | | Appends values to a spreadsheet
+| *batchClear* | | Clears one or more ranges of values from a spreadsheet
+| *batchClearByDataFilter* | | Clears one or more ranges of values from a spreadsheet
+| *batchGet* | | Returns one or more ranges of values from a spreadsheet
+| *batchGetByDataFilter* | | Returns one or more ranges of values that match the specified data filters
+| *batchUpdate* | | Sets values in one or more ranges of a spreadsheet
+| *batchUpdateByDataFilter* | | Sets values in one or more ranges of a spreadsheet
+| *clear* | | Clears values from a spreadsheet
+| *get* | | Returns a range of values from a spreadsheet
+| *update* | | Sets values in a range of a spreadsheet
|===
-| Method | Name | Description | Type
+
+The data API method(s) has the following set of parameters listed in the table below:
+[width="100%",cols="2,2,4,2",options="header"]
+|===
+| Method | Parameter | Description | Type
| append | *range* | The A1 notation of a range to search for a logical table of data. Values will be appended after the last row of the table. | String
| append | *spreadsheetId* | The ID of the spreadsheet to update | String
| append | *values* | The com.google.api.services.sheets.v4.model.ValueRange | ValueRange
@@ -235,6 +295,9 @@ The API methods has the following set of options listed in the following table:
| update | *spreadsheetId* | The ID of the spreadsheet to update | String
| update | *values* | The com.google.api.services.sheets.v4.model.ValueRange | ValueRange
|===
+
+In addition to the parameters above, the data API can also use from the 28 endpoint query option
+which is listed in the _Query Parameters_ section.
// endpoint options: END
diff --git a/components/camel-google-sheets/src/main/docs/google-sheets-stream-component.adoc b/components/camel-google-sheets/src/main/docs/google-sheets-stream-component.adoc
index 15d7323..8e18fc6 100644
--- a/components/camel-google-sheets/src/main/docs/google-sheets-stream-component.adoc
+++ b/components/camel-google-sheets/src/main/docs/google-sheets-stream-component.adoc
@@ -163,21 +163,44 @@ The following lists each API name and method and its additional parameters.
==== spreadsheets
-The spreadsheets has 4 API method(s) which is represented by the following method signatures
+The spreadsheets API has 4 method(s) which is represented by the following method signatures
(an API method may have multiple signatures due to overloading):
+[source,java]
----
-com.google.api.services.sheets.v4.Sheets$Spreadsheets$BatchUpdate batchUpdate(String spreadsheetId, com.google.api.services.sheets.v4.model.BatchUpdateSpreadsheetRequest content)
-com.google.api.services.sheets.v4.Sheets$Spreadsheets$Create create(com.google.api.services.sheets.v4.model.Spreadsheet content)
-com.google.api.services.sheets.v4.Sheets$Spreadsheets$Get get(String spreadsheetId)
-com.google.api.services.sheets.v4.Sheets$Spreadsheets$GetByDataFilter getByDataFilter(String spreadsheetId, com.google.api.services.sheets.v4.model.GetSpreadsheetByDataFilterRequest content)
+com.google.api.services.sheets.v4.Sheets.Spreadsheets.BatchUpdate batchUpdate(String spreadsheetId, com.google.api.services.sheets.v4.model.BatchUpdateSpreadsheetRequest content);
+
+com.google.api.services.sheets.v4.Sheets.Spreadsheets.Create create(com.google.api.services.sheets.v4.model.Spreadsheet content);
+
+com.google.api.services.sheets.v4.Sheets.Spreadsheets.Get get(String spreadsheetId);
+
+com.google.api.services.sheets.v4.Sheets.Spreadsheets.GetByDataFilter getByDataFilter(String spreadsheetId, com.google.api.services.sheets.v4.model.GetSpreadsheetByDataFilterRequest content);
+
+----
+
+The spreadsheets API is defined in the syntax as follows:
+
+----
+google-sheets-stream:spreadsheets/methodName?[parameters]
----
-The API methods has the following set of options listed in the following table:
-[width="100%",cols="1,2,5,2",options="header"]
+The 4 method(s) is listed in the table below.
+(API methods can have a shorthand alias name which can be used in the syntax instead of the name)
+
+[width="100%",cols="2,2,6",options="header"]
+|===
+| Method | Alias | Description
+| *batchUpdate* | | Applies one or more updates to the spreadsheet
+| *create* | | Creates a spreadsheet, returning the newly created spreadsheet
+| *get* | | Returns the spreadsheet at the given ID
+| *getByDataFilter* | | Returns the spreadsheet at the given ID
+|===
+
+The spreadsheets API method(s) has the following set of parameters listed in the table below:
+[width="100%",cols="2,2,4,2",options="header"]
|===
-| Method | Name | Description | Type
+| Method | Parameter | Description | Type
| batchUpdate | *batchUpdateSpreadsheetRequest* | The com.google.api.services.sheets.v4.model.BatchUpdateSpreadsheetRequest | BatchUpdateSpreadsheetRequest
| batchUpdate | *spreadsheetId* | The spreadsheet to apply the updates to | String
| create | *content* | The com.google.api.services.sheets.v4.model.Spreadsheet | Spreadsheet
@@ -186,33 +209,70 @@ The API methods has the following set of options listed in the following table:
| getByDataFilter | *spreadsheetId* | The spreadsheet to request | String
|===
+In addition to the parameters above, the spreadsheets API can also use from the 34 endpoint query option
+which is listed in the _Query Parameters_ section.
==== data
-The data has 10 API method(s) which is represented by the following method signatures
+The data API has 10 method(s) which is represented by the following method signatures
(an API method may have multiple signatures due to overloading):
+[source,java]
----
-com.google.api.services.sheets.v4.Sheets$Spreadsheets$Values$Append append(String spreadsheetId, String range, com.google.api.services.sheets.v4.model.ValueRange content)
-com.google.api.services.sheets.v4.Sheets$Spreadsheets$Values$BatchClear batchClear(String spreadsheetId, com.google.api.services.sheets.v4.model.BatchClearValuesRequest content)
-com.google.api.services.sheets.v4.Sheets$Spreadsheets$Values$BatchClearByDataFilter batchClearByDataFilter(String spreadsheetId, com.google.api.services.sheets.v4.model.BatchClearValuesByDataFilterRequest content)
-com.google.api.services.sheets.v4.Sheets$Spreadsheets$Values$BatchGet batchGet(String spreadsheetId)
-com.google.api.services.sheets.v4.Sheets$Spreadsheets$Values$BatchGetByDataFilter batchGetByDataFilter(String spreadsheetId, com.google.api.services.sheets.v4.model.BatchGetValuesByDataFilterRequest content)
-com.google.api.services.sheets.v4.Sheets$Spreadsheets$Values$BatchUpdate batchUpdate(String spreadsheetId, com.google.api.services.sheets.v4.model.BatchUpdateValuesRequest content)
-com.google.api.services.sheets.v4.Sheets$Spreadsheets$Values$BatchUpdateByDataFilter batchUpdateByDataFilter(String spreadsheetId, com.google.api.services.sheets.v4.model.BatchUpdateValuesByDataFilterRequest content)
-com.google.api.services.sheets.v4.Sheets$Spreadsheets$Values$Clear clear(String spreadsheetId, String range, com.google.api.services.sheets.v4.model.ClearValuesRequest content)
-com.google.api.services.sheets.v4.Sheets$Spreadsheets$Values$Get get(String spreadsheetId, String range)
-com.google.api.services.sheets.v4.Sheets$Spreadsheets$Values$Update update(String spreadsheetId, String range, com.google.api.services.sheets.v4.model.ValueRange content)
+
+com.google.api.services.sheets.v4.Sheets.Spreadsheets.Values.Append append(String spreadsheetId, String range, com.google.api.services.sheets.v4.model.ValueRange content);
+
+com.google.api.services.sheets.v4.Sheets.Spreadsheets.Values.BatchClear batchClear(String spreadsheetId, com.google.api.services.sheets.v4.model.BatchClearValuesRequest content);
+
+com.google.api.services.sheets.v4.Sheets.Spreadsheets.Values.BatchClearByDataFilter batchClearByDataFilter(String spreadsheetId, com.google.api.services.sheets.v4.model.BatchClearValuesByDataFilterRequest content);
+
+com.google.api.services.sheets.v4.Sheets.Spreadsheets.Values.BatchGet batchGet(String spreadsheetId);
+
+com.google.api.services.sheets.v4.Sheets.Spreadsheets.Values.BatchGetByDataFilter batchGetByDataFilter(String spreadsheetId, com.google.api.services.sheets.v4.model.BatchGetValuesByDataFilterRequest content);
+
+com.google.api.services.sheets.v4.Sheets.Spreadsheets.Values.BatchUpdate batchUpdate(String spreadsheetId, com.google.api.services.sheets.v4.model.BatchUpdateValuesRequest content);
+
+com.google.api.services.sheets.v4.Sheets.Spreadsheets.Values.BatchUpdateByDataFilter batchUpdateByDataFilter(String spreadsheetId, com.google.api.services.sheets.v4.model.BatchUpdateValuesByDataFilterRequest content);
+
+com.google.api.services.sheets.v4.Sheets.Spreadsheets.Values.Clear clear(String spreadsheetId, String range, com.google.api.services.sheets.v4.model.ClearValuesRequest content);
+
+com.google.api.services.sheets.v4.Sheets.Spreadsheets.Values.Get get(String spreadsheetId, String range);
+
+com.google.api.services.sheets.v4.Sheets.Spreadsheets.Values.Update update(String spreadsheetId, String range, com.google.api.services.sheets.v4.model.ValueRange content);
+
+----
+
+The data API is defined in the syntax as follows:
----
+google-sheets-stream:data/methodName?[parameters]
+----
+
+The 10 method(s) is listed in the table below.
+(API methods can have a shorthand alias name which can be used in the syntax instead of the name)
-The API methods has the following set of options listed in the following table:
-[width="100%",cols="1,2,5,2",options="header"]
+[width="100%",cols="2,2,6",options="header"]
|===
-| Method | Name | Description | Type
+| Method | Alias | Description
+| *append* | | Appends values to a spreadsheet
+| *batchClear* | | Clears one or more ranges of values from a spreadsheet
+| *batchClearByDataFilter* | | Clears one or more ranges of values from a spreadsheet
+| *batchGet* | | Returns one or more ranges of values from a spreadsheet
+| *batchGetByDataFilter* | | Returns one or more ranges of values that match the specified data filters
+| *batchUpdate* | | Sets values in one or more ranges of a spreadsheet
+| *batchUpdateByDataFilter* | | Sets values in one or more ranges of a spreadsheet
+| *clear* | | Clears values from a spreadsheet
+| *get* | | Returns a range of values from a spreadsheet
+| *update* | | Sets values in a range of a spreadsheet
+|===
+
+The data API method(s) has the following set of parameters listed in the table below:
+[width="100%",cols="2,2,4,2",options="header"]
+|===
+| Method | Parameter | Description | Type
| append | *range* | The A1 notation of a range to search for a logical table of data. Values will be appended after the last row of the table. | String
| append | *spreadsheetId* | The ID of the spreadsheet to update | String
| append | *values* | The com.google.api.services.sheets.v4.model.ValueRange | ValueRange
@@ -236,6 +296,9 @@ The API methods has the following set of options listed in the following table:
| update | *spreadsheetId* | The ID of the spreadsheet to update | String
| update | *values* | The com.google.api.services.sheets.v4.model.ValueRange | ValueRange
|===
+
+In addition to the parameters above, the data API can also use from the 34 endpoint query option
+which is listed in the _Query Parameters_ section.
// endpoint options: END
diff --git a/components/camel-olingo2/camel-olingo2-component/src/main/docs/olingo2-component.adoc b/components/camel-olingo2/camel-olingo2-component/src/main/docs/olingo2-component.adoc
index c28edd8..211c8a1 100644
--- a/components/camel-olingo2/camel-olingo2-component/src/main/docs/olingo2-component.adoc
+++ b/components/camel-olingo2/camel-olingo2-component/src/main/docs/olingo2-component.adoc
@@ -167,25 +167,56 @@ The following lists each API name and method and its additional parameters.
==== DEFAULT
-The DEFAULT has 8 API method(s) which is represented by the following method signatures
+The DEFAULT API has 8 method(s) which is represented by the following method signatures
(an API method may have multiple signatures due to overloading):
+[source,java]
+----
+
+void batch(org.apache.olingo.odata2.api.edm.Edm edm, java.util.Map<String, String> endpointHttpHeaders, Object data, org.apache.camel.component.olingo2.api.Olingo2ResponseHandler<java.util.List<org.apache.camel.component.olingo2.api.batch.Olingo2BatchResponse>> responseHandler);
+
+void create(org.apache.olingo.odata2.api.edm.Edm edm, String resourcePath, java.util.Map<String, String> endpointHttpHeaders, Object data, org.apache.camel.component.olingo2.api.Olingo2ResponseHandler responseHandler);
+
+void delete(String resourcePath, java.util.Map<String, String> endpointHttpHeaders, org.apache.camel.component.olingo2.api.Olingo2ResponseHandler<org.apache.olingo.odata2.api.commons.HttpStatusCodes> responseHandler);
+
+void merge(org.apache.olingo.odata2.api.edm.Edm edm, String resourcePath, java.util.Map<String, String> endpointHttpHeaders, Object data, org.apache.camel.component.olingo2.api.Olingo2ResponseHandler responseHandler);
+
+void patch(org.apache.olingo.odata2.api.edm.Edm edm, String resourcePath, java.util.Map<String, String> endpointHttpHeaders, Object data, org.apache.camel.component.olingo2.api.Olingo2ResponseHandler responseHandler);
+
+void read(org.apache.olingo.odata2.api.edm.Edm edm, String resourcePath, java.util.Map<String, String> queryParams, java.util.Map<String, String> endpointHttpHeaders, org.apache.camel.component.olingo2.api.Olingo2ResponseHandler responseHandler);
+
+void update(org.apache.olingo.odata2.api.edm.Edm edm, String resourcePath, java.util.Map<String, String> endpointHttpHeaders, Object data, org.apache.camel.component.olingo2.api.Olingo2ResponseHandler responseHandler);
+
+void uread(org.apache.olingo.odata2.api.edm.Edm edm, String resourcePath, java.util.Map<String, String> queryParams, java.util.Map<String, String> endpointHttpHeaders, org.apache.camel.component.olingo2.api.Olingo2ResponseHandler<java.io.InputStream> responseHandler);
+
----
-void batch(org.apache.olingo.odata2.api.edm.Edm edm, java.util.Map<String, String> endpointHttpHeaders, Object data, org.apache.camel.component.olingo2.api.Olingo2ResponseHandler<java.util.List<org.apache.camel.component.olingo2.api.batch.Olingo2BatchResponse>> responseHandler)
-void create(org.apache.olingo.odata2.api.edm.Edm edm, String resourcePath, java.util.Map<String, String> endpointHttpHeaders, Object data, org.apache.camel.component.olingo2.api.Olingo2ResponseHandler responseHandler)
-void delete(String resourcePath, java.util.Map<String, String> endpointHttpHeaders, org.apache.camel.component.olingo2.api.Olingo2ResponseHandler<org.apache.olingo.odata2.api.commons.HttpStatusCodes> responseHandler)
-void merge(org.apache.olingo.odata2.api.edm.Edm edm, String resourcePath, java.util.Map<String, String> endpointHttpHeaders, Object data, org.apache.camel.component.olingo2.api.Olingo2ResponseHandler responseHandler)
-void patch(org.apache.olingo.odata2.api.edm.Edm edm, String resourcePath, java.util.Map<String, String> endpointHttpHeaders, Object data, org.apache.camel.component.olingo2.api.Olingo2ResponseHandler responseHandler)
-void read(org.apache.olingo.odata2.api.edm.Edm edm, String resourcePath, java.util.Map<String, String> queryParams, java.util.Map<String, String> endpointHttpHeaders, org.apache.camel.component.olingo2.api.Olingo2ResponseHandler responseHandler)
-void update(org.apache.olingo.odata2.api.edm.Edm edm, String resourcePath, java.util.Map<String, String> endpointHttpHeaders, Object data, org.apache.camel.component.olingo2.api.Olingo2ResponseHandler responseHandler)
-void uread(org.apache.olingo.odata2.api.edm.Edm edm, String resourcePath, java.util.Map<String, String> queryParams, java.util.Map<String, String> endpointHttpHeaders, org.apache.camel.component.olingo2.api.Olingo2ResponseHandler<java.io.InputStream> responseHandler)
+
+The DEFAULT API is defined in the syntax as follows:
----
+olingo2:DEFAULT/methodName?[parameters]
+----
+
+The 8 method(s) is listed in the table below.
+(API methods can have a shorthand alias name which can be used in the syntax instead of the name)
-The API methods has the following set of options listed in the following table:
-[width="100%",cols="1,2,5,2",options="header"]
+[width="100%",cols="2,2,6",options="header"]
|===
-| Method | Name | Description | Type
+| Method | Alias | Description
+| *batch* | | Executes a batch request
+| *create* | | Creates a new OData resource
+| *delete* | | Deletes an OData resource and invokes callback with org
+| *merge* | | Patches/merges an OData resource using HTTP MERGE
+| *patch* | | Patches/merges an OData resource using HTTP PATCH
+| *read* | | Reads an OData resource and invokes callback with appropriate result
+| *update* | | Updates an OData resource
+| *uread* | | Reads an OData resource and invokes callback with the unparsed input stream
+|===
+
+The DEFAULT API method(s) has the following set of parameters listed in the table below:
+[width="100%",cols="2,2,4,2",options="header"]
+|===
+| Method | Parameter | Description | Type
| batch | *data* | Ordered org.apache.camel.component.olingo2.api.batch.Olingo2BatchRequest list | Object
| batch | *edm* | Service Edm | Edm
| batch | *endpointHttpHeaders* | HTTP Headers to add/override the component versions | Map
@@ -224,6 +255,9 @@ The API methods has the following set of options listed in the following table:
| uread | *resourcePath* | OData Resource path | String
| uread | *responseHandler* | Callback handler | Olingo2ResponseHandler
|===
+
+In addition to the parameters above, the DEFAULT API can also use from the 36 endpoint query option
+which is listed in the _Query Parameters_ section.
// endpoint options: END
== Producer Endpoints
diff --git a/components/camel-olingo4/camel-olingo4-component/src/main/docs/olingo4-component.adoc b/components/camel-olingo4/camel-olingo4-component/src/main/docs/olingo4-component.adoc
index f3a66b1..5a56fe9 100644
--- a/components/camel-olingo4/camel-olingo4-component/src/main/docs/olingo4-component.adoc
+++ b/components/camel-olingo4/camel-olingo4-component/src/main/docs/olingo4-component.adoc
@@ -164,26 +164,59 @@ The following lists each API name and method and its additional parameters.
==== DEFAULT
-The DEFAULT has 9 API method(s) which is represented by the following method signatures
+The DEFAULT API has 9 method(s) which is represented by the following method signatures
(an API method may have multiple signatures due to overloading):
+[source,java]
----
-void action(org.apache.olingo.commons.api.edm.Edm edm, String resourcePath, java.util.Map<String, String> endpointHttpHeaders, Object data, org.apache.camel.component.olingo4.api.Olingo4ResponseHandler responseHandler)
-void batch(org.apache.olingo.commons.api.edm.Edm edm, java.util.Map<String, String> endpointHttpHeaders, Object data, org.apache.camel.component.olingo4.api.Olingo4ResponseHandler<java.util.List<org.apache.camel.component.olingo4.api.batch.Olingo4BatchResponse>> responseHandler)
-void create(org.apache.olingo.commons.api.edm.Edm edm, String resourcePath, java.util.Map<String, String> endpointHttpHeaders, Object data, org.apache.camel.component.olingo4.api.Olingo4ResponseHandler responseHandler)
-void delete(String resourcePath, java.util.Map<String, String> endpointHttpHeaders, org.apache.camel.component.olingo4.api.Olingo4ResponseHandler<org.apache.olingo.commons.api.http.HttpStatusCode> responseHandler)
-void merge(org.apache.olingo.commons.api.edm.Edm edm, String resourcePath, java.util.Map<String, String> endpointHttpHeaders, Object data, org.apache.camel.component.olingo4.api.Olingo4ResponseHandler responseHandler)
-void patch(org.apache.olingo.commons.api.edm.Edm edm, String resourcePath, java.util.Map<String, String> endpointHttpHeaders, Object data, org.apache.camel.component.olingo4.api.Olingo4ResponseHandler responseHandler)
-void read(org.apache.olingo.commons.api.edm.Edm edm, String resourcePath, java.util.Map<String, String> queryParams, java.util.Map<String, String> endpointHttpHeaders, org.apache.camel.component.olingo4.api.Olingo4ResponseHandler responseHandler)
-void update(org.apache.olingo.commons.api.edm.Edm edm, String resourcePath, java.util.Map<String, String> endpointHttpHeaders, Object data, org.apache.camel.component.olingo4.api.Olingo4ResponseHandler responseHandler)
-void uread(org.apache.olingo.commons.api.edm.Edm edm, String resourcePath, java.util.Map<String, String> queryParams, java.util.Map<String, String> endpointHttpHeaders, org.apache.camel.component.olingo4.api.Olingo4ResponseHandler<java.io.InputStream> responseHandler)
+
+void action(org.apache.olingo.commons.api.edm.Edm edm, String resourcePath, java.util.Map<String, String> endpointHttpHeaders, Object data, org.apache.camel.component.olingo4.api.Olingo4ResponseHandler responseHandler);
+
+void batch(org.apache.olingo.commons.api.edm.Edm edm, java.util.Map<String, String> endpointHttpHeaders, Object data, org.apache.camel.component.olingo4.api.Olingo4ResponseHandler<java.util.List<org.apache.camel.component.olingo4.api.batch.Olingo4BatchResponse>> responseHandler);
+
+void create(org.apache.olingo.commons.api.edm.Edm edm, String resourcePath, java.util.Map<String, String> endpointHttpHeaders, Object data, org.apache.camel.component.olingo4.api.Olingo4ResponseHandler responseHandler);
+
+void delete(String resourcePath, java.util.Map<String, String> endpointHttpHeaders, org.apache.camel.component.olingo4.api.Olingo4ResponseHandler<org.apache.olingo.commons.api.http.HttpStatusCode> responseHandler);
+
+void merge(org.apache.olingo.commons.api.edm.Edm edm, String resourcePath, java.util.Map<String, String> endpointHttpHeaders, Object data, org.apache.camel.component.olingo4.api.Olingo4ResponseHandler responseHandler);
+
+void patch(org.apache.olingo.commons.api.edm.Edm edm, String resourcePath, java.util.Map<String, String> endpointHttpHeaders, Object data, org.apache.camel.component.olingo4.api.Olingo4ResponseHandler responseHandler);
+
+void read(org.apache.olingo.commons.api.edm.Edm edm, String resourcePath, java.util.Map<String, String> queryParams, java.util.Map<String, String> endpointHttpHeaders, org.apache.camel.component.olingo4.api.Olingo4ResponseHandler responseHandler);
+
+void update(org.apache.olingo.commons.api.edm.Edm edm, String resourcePath, java.util.Map<String, String> endpointHttpHeaders, Object data, org.apache.camel.component.olingo4.api.Olingo4ResponseHandler responseHandler);
+
+void uread(org.apache.olingo.commons.api.edm.Edm edm, String resourcePath, java.util.Map<String, String> queryParams, java.util.Map<String, String> endpointHttpHeaders, org.apache.camel.component.olingo4.api.Olingo4ResponseHandler<java.io.InputStream> responseHandler);
----
-The API methods has the following set of options listed in the following table:
-[width="100%",cols="1,2,5,2",options="header"]
+The DEFAULT API is defined in the syntax as follows:
+
+----
+olingo4:DEFAULT/methodName?[parameters]
+----
+
+The 9 method(s) is listed in the table below.
+(API methods can have a shorthand alias name which can be used in the syntax instead of the name)
+
+[width="100%",cols="2,2,6",options="header"]
|===
-| Method | Name | Description | Type
+| Method | Alias | Description
+| *action* | | Calls a OData action
+| *batch* | | Executes a batch request
+| *create* | | Creates a new OData resource
+| *delete* | | Deletes an OData resource and invokes callback with org
+| *merge* | | Patches/merges an OData resource using HTTP MERGE
+| *patch* | | Patches/merges an OData resource using HTTP PATCH
+| *read* | | Reads an OData resource and invokes callback with appropriate result
+| *update* | | Updates an OData resource
+| *uread* | | Reads an OData resource and invokes callback with the unparsed input stream
+|===
+
+The DEFAULT API method(s) has the following set of parameters listed in the table below:
+[width="100%",cols="2,2,4,2",options="header"]
+|===
+| Method | Parameter | Description | Type
| action | *data* | Action data | Object
| action | *edm* | Service Edm | Edm
| action | *endpointHttpHeaders* | HTTP Headers to add/override the component versions | Map
@@ -227,6 +260,9 @@ The API methods has the following set of options listed in the following table:
| uread | *resourcePath* | OData Resource path | String
| uread | *responseHandler* | Callback handler | Olingo4ResponseHandler
|===
+
+In addition to the parameters above, the DEFAULT API can also use from the 34 endpoint query option
+which is listed in the _Query Parameters_ section.
// endpoint options: END
== Producer Endpoints
diff --git a/components/camel-twilio/src/main/docs/twilio-component.adoc b/components/camel-twilio/src/main/docs/twilio-component.adoc
index 0347baa..eeb3f0d 100644
--- a/components/camel-twilio/src/main/docs/twilio-component.adoc
+++ b/components/camel-twilio/src/main/docs/twilio-component.adoc
@@ -117,23 +117,47 @@ The following lists each API name and method and its additional parameters.
==== recording-add-on-result-payload
-The recording-add-on-result-payload has 3 API method(s) which is represented by the following method signatures
+The recording-add-on-result-payload API has 3 method(s) which is represented by the following method signatures
(an API method may have multiple signatures due to overloading):
+[source,java]
----
-com.twilio.rest.api.v2010.account.recording.addonresult.PayloadDeleter deleter(String pathAccountSid, String pathReferenceSid, String pathAddOnResultSid, String pathSid)
-com.twilio.rest.api.v2010.account.recording.addonresult.PayloadDeleter deleter(String pathReferenceSid, String pathAddOnResultSid, String pathSid)
-com.twilio.rest.api.v2010.account.recording.addonresult.PayloadFetcher fetcher(String pathAccountSid, String pathReferenceSid, String pathAddOnResultSid, String pathSid)
-com.twilio.rest.api.v2010.account.recording.addonresult.PayloadFetcher fetcher(String pathReferenceSid, String pathAddOnResultSid, String pathSid)
-com.twilio.rest.api.v2010.account.recording.addonresult.PayloadReader reader(String pathAccountSid, String pathReferenceSid, String pathAddOnResultSid)
-com.twilio.rest.api.v2010.account.recording.addonresult.PayloadReader reader(String pathReferenceSid, String pathAddOnResultSid)
+com.twilio.rest.api.v2010.account.recording.addonresult.PayloadDeleter deleter(String pathAccountSid, String pathReferenceSid, String pathAddOnResultSid, String pathSid);
+
+com.twilio.rest.api.v2010.account.recording.addonresult.PayloadDeleter deleter(String pathReferenceSid, String pathAddOnResultSid, String pathSid);
+
+com.twilio.rest.api.v2010.account.recording.addonresult.PayloadFetcher fetcher(String pathAccountSid, String pathReferenceSid, String pathAddOnResultSid, String pathSid);
+
+com.twilio.rest.api.v2010.account.recording.addonresult.PayloadFetcher fetcher(String pathReferenceSid, String pathAddOnResultSid, String pathSid);
+
+com.twilio.rest.api.v2010.account.recording.addonresult.PayloadReader reader(String pathAccountSid, String pathReferenceSid, String pathAddOnResultSid);
+
+com.twilio.rest.api.v2010.account.recording.addonresult.PayloadReader reader(String pathReferenceSid, String pathAddOnResultSid);
+
+----
+
+The recording-add-on-result-payload API is defined in the syntax as follows:
+
+----
+twilio:recording-add-on-result-payload/methodName?[parameters]
----
-The API methods has the following set of options listed in the following table:
-[width="100%",cols="1,2,5,2",options="header"]
+The 3 method(s) is listed in the table below.
+(API methods can have a shorthand alias name which can be used in the syntax instead of the name)
+
+[width="100%",cols="2,2,6",options="header"]
+|===
+| Method | Alias | Description
+| *deleter* | delete | Create a PayloadDeleter to execute delete
+| *fetcher* | fetch | Create a PayloadFetcher to execute fetch
+| *reader* | read | Create a PayloadReader to execute read
+|===
+
+The recording-add-on-result-payload API method(s) has the following set of parameters listed in the table below:
+[width="100%",cols="2,2,4,2",options="header"]
|===
-| Method | Name | Description | Type
+| Method | Parameter | Description | Type
| deleter | *pathAccountSid* | The SID of the Account that created the resources to delete | String
| deleter | *pathAddOnResultSid* | The SID of the AddOnResult to which the payloads to delete belongs | String
| deleter | *pathReferenceSid* | The SID of the recording to which the AddOnResult resource that contains the payloads to delete belongs | String
@@ -147,78 +171,150 @@ The API methods has the following set of options listed in the following table:
| reader | *pathReferenceSid* | The SID of the recording to which the AddOnResult resource that contains the payloads to delete belongs | String
|===
+In addition to the parameters above, the recording-add-on-result-payload API can also use from the 23 endpoint query option
+which is listed in the _Query Parameters_ section.
==== usage-record-today
-The usage-record-today has 1 API method(s) which is represented by the following method signatures
+The usage-record-today API has 1 method(s) which is represented by the following method signatures
(an API method may have multiple signatures due to overloading):
+[source,java]
+----
+
+com.twilio.rest.api.v2010.account.usage.record.TodayReader reader();
+
+com.twilio.rest.api.v2010.account.usage.record.TodayReader reader(String pathAccountSid);
+
----
-com.twilio.rest.api.v2010.account.usage.record.TodayReader reader()
-com.twilio.rest.api.v2010.account.usage.record.TodayReader reader(String pathAccountSid)
+The usage-record-today API is defined in the syntax as follows:
+
+----
+twilio:usage-record-today/methodName?[parameters]
----
-The API methods has the following set of options listed in the following table:
-[width="100%",cols="1,2,5,2",options="header"]
+The 1 method(s) is listed in the table below.
+(API methods can have a shorthand alias name which can be used in the syntax instead of the name)
+
+[width="100%",cols="2,2,6",options="header"]
+|===
+| Method | Alias | Description
+| *reader* | read | Create a TodayReader to execute read
+|===
+
+The usage-record-today API method(s) has the following set of parameters listed in the table below:
+[width="100%",cols="2,2,4,2",options="header"]
|===
-| Method | Name | Description | Type
+| Method | Parameter | Description | Type
| reader | *pathAccountSid* | The SID of the Account that created the resources to read | String
|===
+In addition to the parameters above, the usage-record-today API can also use from the 23 endpoint query option
+which is listed in the _Query Parameters_ section.
==== available-phone-number-country-local
-The available-phone-number-country-local has 1 API method(s) which is represented by the following method signatures
+The available-phone-number-country-local API has 1 method(s) which is represented by the following method signatures
(an API method may have multiple signatures due to overloading):
+[source,java]
----
-com.twilio.rest.api.v2010.account.availablephonenumbercountry.LocalReader reader(String pathAccountSid, String pathCountryCode)
-com.twilio.rest.api.v2010.account.availablephonenumbercountry.LocalReader reader(String pathCountryCode)
+com.twilio.rest.api.v2010.account.availablephonenumbercountry.LocalReader reader(String pathAccountSid, String pathCountryCode);
+
+com.twilio.rest.api.v2010.account.availablephonenumbercountry.LocalReader reader(String pathCountryCode);
+
+----
+
+The available-phone-number-country-local API is defined in the syntax as follows:
+
+----
+twilio:available-phone-number-country-local/methodName?[parameters]
----
-The API methods has the following set of options listed in the following table:
-[width="100%",cols="1,2,5,2",options="header"]
+The 1 method(s) is listed in the table below.
+(API methods can have a shorthand alias name which can be used in the syntax instead of the name)
+
+[width="100%",cols="2,2,6",options="header"]
+|===
+| Method | Alias | Description
+| *reader* | read | Create a LocalReader to execute read
+|===
+
+The available-phone-number-country-local API method(s) has the following set of parameters listed in the table below:
+[width="100%",cols="2,2,4,2",options="header"]
|===
-| Method | Name | Description | Type
+| Method | Parameter | Description | Type
| reader | *pathAccountSid* | The SID of the Account requesting the AvailablePhoneNumber resources | String
| reader | *pathCountryCode* | The ISO Country code of the country from which to read phone numbers | String
|===
+In addition to the parameters above, the available-phone-number-country-local API can also use from the 23 endpoint query option
+which is listed in the _Query Parameters_ section.
==== call-recording
-The call-recording has 5 API method(s) which is represented by the following method signatures
+The call-recording API has 5 method(s) which is represented by the following method signatures
(an API method may have multiple signatures due to overloading):
+[source,java]
+----
+
+com.twilio.rest.api.v2010.account.call.RecordingCreator creator(String pathAccountSid, String pathCallSid);
+
+com.twilio.rest.api.v2010.account.call.RecordingCreator creator(String pathCallSid);
+
+com.twilio.rest.api.v2010.account.call.RecordingDeleter deleter(String pathAccountSid, String pathCallSid, String pathSid);
+
+com.twilio.rest.api.v2010.account.call.RecordingDeleter deleter(String pathCallSid, String pathSid);
+
+com.twilio.rest.api.v2010.account.call.RecordingFetcher fetcher(String pathAccountSid, String pathCallSid, String pathSid);
+
+com.twilio.rest.api.v2010.account.call.RecordingFetcher fetcher(String pathCallSid, String pathSid);
+
+com.twilio.rest.api.v2010.account.call.RecordingReader reader(String pathAccountSid, String pathCallSid);
+
+com.twilio.rest.api.v2010.account.call.RecordingReader reader(String pathCallSid);
+
+com.twilio.rest.api.v2010.account.call.RecordingUpdater updater(String pathAccountSid, String pathCallSid, String pathSid, com.twilio.rest.api.v2010.account.call.Recording.Status status);
+
+com.twilio.rest.api.v2010.account.call.RecordingUpdater updater(String pathCallSid, String pathSid, com.twilio.rest.api.v2010.account.call.Recording.Status status);
+
----
-com.twilio.rest.api.v2010.account.call.RecordingCreator creator(String pathAccountSid, String pathCallSid)
-com.twilio.rest.api.v2010.account.call.RecordingCreator creator(String pathCallSid)
-com.twilio.rest.api.v2010.account.call.RecordingDeleter deleter(String pathAccountSid, String pathCallSid, String pathSid)
-com.twilio.rest.api.v2010.account.call.RecordingDeleter deleter(String pathCallSid, String pathSid)
-com.twilio.rest.api.v2010.account.call.RecordingFetcher fetcher(String pathAccountSid, String pathCallSid, String pathSid)
-com.twilio.rest.api.v2010.account.call.RecordingFetcher fetcher(String pathCallSid, String pathSid)
-com.twilio.rest.api.v2010.account.call.RecordingReader reader(String pathAccountSid, String pathCallSid)
-com.twilio.rest.api.v2010.account.call.RecordingReader reader(String pathCallSid)
-com.twilio.rest.api.v2010.account.call.RecordingUpdater updater(String pathAccountSid, String pathCallSid, String pathSid, com.twilio.rest.api.v2010.account.call.Recording$Status status)
-com.twilio.rest.api.v2010.account.call.RecordingUpdater updater(String pathCallSid, String pathSid, com.twilio.rest.api.v2010.account.call.Recording$Status status)
+The call-recording API is defined in the syntax as follows:
+
+----
+twilio:call-recording/methodName?[parameters]
----
-The API methods has the following set of options listed in the following table:
-[width="100%",cols="1,2,5,2",options="header"]
+The 5 method(s) is listed in the table below.
+(API methods can have a shorthand alias name which can be used in the syntax instead of the name)
+
+[width="100%",cols="2,2,6",options="header"]
+|===
+| Method | Alias | Description
+| *creator* | create | Create a RecordingCreator to execute create
+| *deleter* | delete | Create a RecordingDeleter to execute delete
+| *fetcher* | fetch | Create a RecordingFetcher to execute fetch
+| *reader* | read | Create a RecordingReader to execute read
+| *updater* | update | Create a RecordingUpdater to execute update
+|===
+
+The call-recording API method(s) has the following set of parameters listed in the table below:
+[width="100%",cols="2,2,4,2",options="header"]
|===
-| Method | Name | Description | Type
+| Method | Parameter | Description | Type
| creator | *pathAccountSid* | The SID of the Account that will create the resource | String
| creator | *pathCallSid* | The SID of the Call to associate the resource with | String
| deleter | *pathAccountSid* | The SID of the Account that created the resources to delete | String
@@ -235,29 +331,55 @@ The API methods has the following set of options listed in the following table:
| updater | *status* | The new status of the recording | Status
|===
+In addition to the parameters above, the call-recording API can also use from the 23 endpoint query option
+which is listed in the _Query Parameters_ section.
==== queue-member
-The queue-member has 3 API method(s) which is represented by the following method signatures
+The queue-member API has 3 method(s) which is represented by the following method signatures
(an API method may have multiple signatures due to overloading):
+[source,java]
+----
+
+com.twilio.rest.api.v2010.account.queue.MemberFetcher fetcher(String pathAccountSid, String pathQueueSid, String pathCallSid);
+
+com.twilio.rest.api.v2010.account.queue.MemberFetcher fetcher(String pathQueueSid, String pathCallSid);
+
+com.twilio.rest.api.v2010.account.queue.MemberReader reader(String pathAccountSid, String pathQueueSid);
+
+com.twilio.rest.api.v2010.account.queue.MemberReader reader(String pathQueueSid);
+
+com.twilio.rest.api.v2010.account.queue.MemberUpdater updater(String pathAccountSid, String pathQueueSid, String pathCallSid, java.net.URI url);
+
+com.twilio.rest.api.v2010.account.queue.MemberUpdater updater(String pathQueueSid, String pathCallSid, java.net.URI url);
+
----
-com.twilio.rest.api.v2010.account.queue.MemberFetcher fetcher(String pathAccountSid, String pathQueueSid, String pathCallSid)
-com.twilio.rest.api.v2010.account.queue.MemberFetcher fetcher(String pathQueueSid, String pathCallSid)
-com.twilio.rest.api.v2010.account.queue.MemberReader reader(String pathAccountSid, String pathQueueSid)
-com.twilio.rest.api.v2010.account.queue.MemberReader reader(String pathQueueSid)
-com.twilio.rest.api.v2010.account.queue.MemberUpdater updater(String pathAccountSid, String pathQueueSid, String pathCallSid, java.net.URI url)
-com.twilio.rest.api.v2010.account.queue.MemberUpdater updater(String pathQueueSid, String pathCallSid, java.net.URI url)
+The queue-member API is defined in the syntax as follows:
+
+----
+twilio:queue-member/methodName?[parameters]
----
-The API methods has the following set of options listed in the following table:
-[width="100%",cols="1,2,5,2",options="header"]
+The 3 method(s) is listed in the table below.
+(API methods can have a shorthand alias name which can be used in the syntax instead of the name)
+
+[width="100%",cols="2,2,6",options="header"]
+|===
+| Method | Alias | Description
+| *fetcher* | fetch | Create a MemberFetcher to execute fetch
+| *reader* | read | Create a MemberReader to execute read
+| *updater* | update | Create a MemberUpdater to execute update
+|===
+
+The queue-member API method(s) has the following set of parameters listed in the table below:
+[width="100%",cols="2,2,4,2",options="header"]
|===
-| Method | Name | Description | Type
+| Method | Parameter | Description | Type
| fetcher | *pathAccountSid* | The SID of the Account that created the resource(s) to fetch | String
| fetcher | *pathCallSid* | The Call SID of the resource(s) to fetch | String
| fetcher | *pathQueueSid* | The SID of the Queue in which to find the members | String
@@ -269,33 +391,65 @@ The API methods has the following set of options listed in the following table:
| updater | *url* | The absolute URL of the Queue resource | URI
|===
+In addition to the parameters above, the queue-member API can also use from the 23 endpoint query option
+which is listed in the _Query Parameters_ section.
==== usage-trigger
-The usage-trigger has 5 API method(s) which is represented by the following method signatures
+The usage-trigger API has 5 method(s) which is represented by the following method signatures
(an API method may have multiple signatures due to overloading):
+[source,java]
+----
+
+com.twilio.rest.api.v2010.account.usage.TriggerCreator creator(String pathAccountSid, java.net.URI callbackUrl, String triggerValue, com.twilio.rest.api.v2010.account.usage.Trigger.UsageCategory usageCategory);
+
+com.twilio.rest.api.v2010.account.usage.TriggerCreator creator(java.net.URI callbackUrl, String triggerValue, com.twilio.rest.api.v2010.account.usage.Trigger.UsageCategory usageCategory);
+
+com.twilio.rest.api.v2010.account.usage.TriggerDeleter deleter(String pathAccountSid, String pathSid);
+
+com.twilio.rest.api.v2010.account.usage.TriggerDeleter deleter(String pathSid);
+
+com.twilio.rest.api.v2010.account.usage.TriggerFetcher fetcher(String pathAccountSid, String pathSid);
+
+com.twilio.rest.api.v2010.account.usage.TriggerFetcher fetcher(String pathSid);
+
+com.twilio.rest.api.v2010.account.usage.TriggerReader reader();
+
+com.twilio.rest.api.v2010.account.usage.TriggerReader reader(String pathAccountSid);
+
+com.twilio.rest.api.v2010.account.usage.TriggerUpdater updater(String pathAccountSid, String pathSid);
+
+com.twilio.rest.api.v2010.account.usage.TriggerUpdater updater(String pathSid);
+
----
-com.twilio.rest.api.v2010.account.usage.TriggerCreator creator(String pathAccountSid, java.net.URI callbackUrl, String triggerValue, com.twilio.rest.api.v2010.account.usage.Trigger$UsageCategory usageCategory)
-com.twilio.rest.api.v2010.account.usage.TriggerCreator creator(java.net.URI callbackUrl, String triggerValue, com.twilio.rest.api.v2010.account.usage.Trigger$UsageCategory usageCategory)
-com.twilio.rest.api.v2010.account.usage.TriggerDeleter deleter(String pathAccountSid, String pathSid)
-com.twilio.rest.api.v2010.account.usage.TriggerDeleter deleter(String pathSid)
-com.twilio.rest.api.v2010.account.usage.TriggerFetcher fetcher(String pathAccountSid, String pathSid)
-com.twilio.rest.api.v2010.account.usage.TriggerFetcher fetcher(String pathSid)
-com.twilio.rest.api.v2010.account.usage.TriggerReader reader()
-com.twilio.rest.api.v2010.account.usage.TriggerReader reader(String pathAccountSid)
-com.twilio.rest.api.v2010.account.usage.TriggerUpdater updater(String pathAccountSid, String pathSid)
-com.twilio.rest.api.v2010.account.usage.TriggerUpdater updater(String pathSid)
+The usage-trigger API is defined in the syntax as follows:
+
+----
+twilio:usage-trigger/methodName?[parameters]
----
-The API methods has the following set of options listed in the following table:
-[width="100%",cols="1,2,5,2",options="header"]
+The 5 method(s) is listed in the table below.
+(API methods can have a shorthand alias name which can be used in the syntax instead of the name)
+
+[width="100%",cols="2,2,6",options="header"]
+|===
+| Method | Alias | Description
+| *creator* | create | Create a TriggerCreator to execute create
+| *deleter* | delete | Create a TriggerDeleter to execute delete
+| *fetcher* | fetch | Create a TriggerFetcher to execute fetch
+| *reader* | read | Create a TriggerReader to execute read
+| *updater* | update | Create a TriggerUpdater to execute update
+|===
+
+The usage-trigger API method(s) has the following set of parameters listed in the table below:
+[width="100%",cols="2,2,4,2",options="header"]
|===
-| Method | Name | Description | Type
+| Method | Parameter | Description | Type
| creator | *callbackUrl* | The URL we call when the trigger fires | URI
| creator | *pathAccountSid* | The SID of the Account that will create the resource | String
| creator | *triggerValue* | The usage value at which the trigger should fire | String
@@ -309,73 +463,139 @@ The API methods has the following set of options listed in the following table:
| updater | *pathSid* | The unique string that identifies the resource | String
|===
+In addition to the parameters above, the usage-trigger API can also use from the 23 endpoint query option
+which is listed in the _Query Parameters_ section.
==== usage-record-last-month
-The usage-record-last-month has 1 API method(s) which is represented by the following method signatures
+The usage-record-last-month API has 1 method(s) which is represented by the following method signatures
(an API method may have multiple signatures due to overloading):
+[source,java]
+----
+
+com.twilio.rest.api.v2010.account.usage.record.LastMonthReader reader();
+
+com.twilio.rest.api.v2010.account.usage.record.LastMonthReader reader(String pathAccountSid);
+
----
-com.twilio.rest.api.v2010.account.usage.record.LastMonthReader reader()
-com.twilio.rest.api.v2010.account.usage.record.LastMonthReader reader(String pathAccountSid)
+The usage-record-last-month API is defined in the syntax as follows:
+
+----
+twilio:usage-record-last-month/methodName?[parameters]
----
-The API methods has the following set of options listed in the following table:
-[width="100%",cols="1,2,5,2",options="header"]
+The 1 method(s) is listed in the table below.
+(API methods can have a shorthand alias name which can be used in the syntax instead of the name)
+
+[width="100%",cols="2,2,6",options="header"]
+|===
+| Method | Alias | Description
+| *reader* | read | Create a LastMonthReader to execute read
+|===
+
+The usage-record-last-month API method(s) has the following set of parameters listed in the table below:
+[width="100%",cols="2,2,4,2",options="header"]
|===
-| Method | Name | Description | Type
+| Method | Parameter | Description | Type
| reader | *pathAccountSid* | The SID of the Account that created the resources to read | String
|===
+In addition to the parameters above, the usage-record-last-month API can also use from the 23 endpoint query option
+which is listed in the _Query Parameters_ section.
==== usage-record-all-time
-The usage-record-all-time has 1 API method(s) which is represented by the following method signatures
+The usage-record-all-time API has 1 method(s) which is represented by the following method signatures
(an API method may have multiple signatures due to overloading):
+[source,java]
+----
+
+com.twilio.rest.api.v2010.account.usage.record.AllTimeReader reader();
+
+com.twilio.rest.api.v2010.account.usage.record.AllTimeReader reader(String pathAccountSid);
+
----
-com.twilio.rest.api.v2010.account.usage.record.AllTimeReader reader()
-com.twilio.rest.api.v2010.account.usage.record.AllTimeReader reader(String pathAccountSid)
+The usage-record-all-time API is defined in the syntax as follows:
+
+----
+twilio:usage-record-all-time/methodName?[parameters]
----
-The API methods has the following set of options listed in the following table:
-[width="100%",cols="1,2,5,2",options="header"]
+The 1 method(s) is listed in the table below.
+(API methods can have a shorthand alias name which can be used in the syntax instead of the name)
+
+[width="100%",cols="2,2,6",options="header"]
+|===
+| Method | Alias | Description
+| *reader* | read | Create a AllTimeReader to execute read
+|===
+
+The usage-record-all-time API method(s) has the following set of parameters listed in the table below:
+[width="100%",cols="2,2,4,2",options="header"]
|===
-| Method | Name | Description | Type
+| Method | Parameter | Description | Type
| reader | *pathAccountSid* | The SID of the Account that created the resources to read | String
|===
+In addition to the parameters above, the usage-record-all-time API can also use from the 23 endpoint query option
+which is listed in the _Query Parameters_ section.
==== recording-transcription
-The recording-transcription has 3 API method(s) which is represented by the following method signatures
+The recording-transcription API has 3 method(s) which is represented by the following method signatures
(an API method may have multiple signatures due to overloading):
+[source,java]
+----
+
+com.twilio.rest.api.v2010.account.recording.TranscriptionDeleter deleter(String pathAccountSid, String pathRecordingSid, String pathSid);
+
+com.twilio.rest.api.v2010.account.recording.TranscriptionDeleter deleter(String pathRecordingSid, String pathSid);
+
+com.twilio.rest.api.v2010.account.recording.TranscriptionFetcher fetcher(String pathAccountSid, String pathRecordingSid, String pathSid);
+
+com.twilio.rest.api.v2010.account.recording.TranscriptionFetcher fetcher(String pathRecordingSid, String pathSid);
+
+com.twilio.rest.api.v2010.account.recording.TranscriptionReader reader(String pathAccountSid, String pathRecordingSid);
+
+com.twilio.rest.api.v2010.account.recording.TranscriptionReader reader(String pathRecordingSid);
+
----
-com.twilio.rest.api.v2010.account.recording.TranscriptionDeleter deleter(String pathAccountSid, String pathRecordingSid, String pathSid)
-com.twilio.rest.api.v2010.account.recording.TranscriptionDeleter deleter(String pathRecordingSid, String pathSid)
-com.twilio.rest.api.v2010.account.recording.TranscriptionFetcher fetcher(String pathAccountSid, String pathRecordingSid, String pathSid)
-com.twilio.rest.api.v2010.account.recording.TranscriptionFetcher fetcher(String pathRecordingSid, String pathSid)
-com.twilio.rest.api.v2010.account.recording.TranscriptionReader reader(String pathAccountSid, String pathRecordingSid)
-com.twilio.rest.api.v2010.account.recording.TranscriptionReader reader(String pathRecordingSid)
+The recording-transcription API is defined in the syntax as follows:
+
+----
+twilio:recording-transcription/methodName?[parameters]
----
-The API methods has the following set of options listed in the following table:
-[width="100%",cols="1,2,5,2",options="header"]
+The 3 method(s) is listed in the table below.
+(API methods can have a shorthand alias name which can be used in the syntax instead of the name)
+
+[width="100%",cols="2,2,6",options="header"]
+|===
+| Method | Alias | Description
+| *deleter* | delete | Create a TranscriptionDeleter to execute delete
+| *fetcher* | fetch | Create a TranscriptionFetcher to execute fetch
+| *reader* | read | Create a TranscriptionReader to execute read
+|===
+
+The recording-transcription API method(s) has the following set of parameters listed in the table below:
+[width="100%",cols="2,2,4,2",options="header"]
|===
-| Method | Name | Description | Type
+| Method | Parameter | Description | Type
| deleter | *pathAccountSid* | The SID of the Account that created the resources to delete | String
| deleter | *pathRecordingSid* | The SID of the recording that created the transcription to delete | String
| deleter | *pathSid* | The unique string that identifies the resource | String
@@ -386,39 +606,77 @@ The API methods has the following set of options listed in the following table:
| reader | *pathRecordingSid* | The SID of the recording that created the transcription to delete | String
|===
+In addition to the parameters above, the recording-transcription API can also use from the 23 endpoint query option
+which is listed in the _Query Parameters_ section.
==== message
-The message has 5 API method(s) which is represented by the following method signatures
+The message API has 5 method(s) which is represented by the following method signatures
(an API method may have multiple signatures due to overloading):
+[source,java]
+----
+
+com.twilio.rest.api.v2010.account.MessageCreator creator(String pathAccountSid, com.twilio.type.PhoneNumber to, String messagingServiceSid, String body);
+
+com.twilio.rest.api.v2010.account.MessageCreator creator(String pathAccountSid, com.twilio.type.PhoneNumber to, String messagingServiceSid, java.util.List<java.net.URI> mediaUrl);
+
+com.twilio.rest.api.v2010.account.MessageCreator creator(String pathAccountSid, com.twilio.type.PhoneNumber to, com.twilio.type.PhoneNumber from, String body);
+
+com.twilio.rest.api.v2010.account.MessageCreator creator(String pathAccountSid, com.twilio.type.PhoneNumber to, com.twilio.type.PhoneNumber from, java.util.List<java.net.URI> mediaUrl);
+
+com.twilio.rest.api.v2010.account.MessageCreator creator(com.twilio.type.PhoneNumber to, String messagingServiceSid, String body);
+
+com.twilio.rest.api.v2010.account.MessageCreator creator(com.twilio.type.PhoneNumber to, String messagingServiceSid, java.util.List<java.net.URI> mediaUrl);
+
+com.twilio.rest.api.v2010.account.MessageCreator creator(com.twilio.type.PhoneNumber to, com.twilio.type.PhoneNumber from, String body);
+
+com.twilio.rest.api.v2010.account.MessageCreator creator(com.twilio.type.PhoneNumber to, com.twilio.type.PhoneNumber from, java.util.List<java.net.URI> mediaUrl);
+
+com.twilio.rest.api.v2010.account.MessageDeleter deleter(String pathAccountSid, String pathSid);
+
+com.twilio.rest.api.v2010.account.MessageDeleter deleter(String pathSid);
+
+com.twilio.rest.api.v2010.account.MessageFetcher fetcher(String pathAccountSid, String pathSid);
+
+com.twilio.rest.api.v2010.account.MessageFetcher fetcher(String pathSid);
+
+com.twilio.rest.api.v2010.account.MessageReader reader();
+
+com.twilio.rest.api.v2010.account.MessageReader reader(String pathAccountSid);
+
+com.twilio.rest.api.v2010.account.MessageUpdater updater(String pathAccountSid, String pathSid, String body);
+
+com.twilio.rest.api.v2010.account.MessageUpdater updater(String pathSid, String body);
+
----
-com.twilio.rest.api.v2010.account.MessageCreator creator(String pathAccountSid, com.twilio.type.PhoneNumber to, String messagingServiceSid, String body)
-com.twilio.rest.api.v2010.account.MessageCreator creator(String pathAccountSid, com.twilio.type.PhoneNumber to, String messagingServiceSid, java.util.List<java.net.URI> mediaUrl)
-com.twilio.rest.api.v2010.account.MessageCreator creator(String pathAccountSid, com.twilio.type.PhoneNumber to, com.twilio.type.PhoneNumber from, String body)
-com.twilio.rest.api.v2010.account.MessageCreator creator(String pathAccountSid, com.twilio.type.PhoneNumber to, com.twilio.type.PhoneNumber from, java.util.List<java.net.URI> mediaUrl)
-com.twilio.rest.api.v2010.account.MessageCreator creator(com.twilio.type.PhoneNumber to, String messagingServiceSid, String body)
-com.twilio.rest.api.v2010.account.MessageCreator creator(com.twilio.type.PhoneNumber to, String messagingServiceSid, java.util.List<java.net.URI> mediaUrl)
-com.twilio.rest.api.v2010.account.MessageCreator creator(com.twilio.type.PhoneNumber to, com.twilio.type.PhoneNumber from, String body)
-com.twilio.rest.api.v2010.account.MessageCreator creator(com.twilio.type.PhoneNumber to, com.twilio.type.PhoneNumber from, java.util.List<java.net.URI> mediaUrl)
-com.twilio.rest.api.v2010.account.MessageDeleter deleter(String pathAccountSid, String pathSid)
-com.twilio.rest.api.v2010.account.MessageDeleter deleter(String pathSid)
-com.twilio.rest.api.v2010.account.MessageFetcher fetcher(String pathAccountSid, String pathSid)
-com.twilio.rest.api.v2010.account.MessageFetcher fetcher(String pathSid)
-com.twilio.rest.api.v2010.account.MessageReader reader()
-com.twilio.rest.api.v2010.account.MessageReader reader(String pathAccountSid)
-com.twilio.rest.api.v2010.account.MessageUpdater updater(String pathAccountSid, String pathSid, String body)
-com.twilio.rest.api.v2010.account.MessageUpdater updater(String pathSid, String body)
+The message API is defined in the syntax as follows:
+
+----
+twilio:message/methodName?[parameters]
----
-The API methods has the following set of options listed in the following table:
-[width="100%",cols="1,2,5,2",options="header"]
+The 5 method(s) is listed in the table below.
+(API methods can have a shorthand alias name which can be used in the syntax instead of the name)
+
+[width="100%",cols="2,2,6",options="header"]
+|===
+| Method | Alias | Description
+| *creator* | create | Create a MessageCreator to execute create
+| *deleter* | delete | Create a MessageDeleter to execute delete
+| *fetcher* | fetch | Create a MessageFetcher to execute fetch
+| *reader* | read | Create a MessageReader to execute read
+| *updater* | update | Create a MessageUpdater to execute update
+|===
+
+The message API method(s) has the following set of parameters listed in the table below:
+[width="100%",cols="2,2,4,2",options="header"]
|===
-| Method | Name | Description | Type
+| Method | Parameter | Description | Type
| creator | *body* | The text of the message you want to send. Can be up to 1,600 characters in length. | String
| creator | *from* | The phone number that initiated the message | PhoneNumber
| creator | *mediaUrl* | The URL of the media to send with the message | List
@@ -435,29 +693,55 @@ The API methods has the following set of options listed in the following table:
| updater | *pathSid* | The unique string that identifies the resource | String
|===
+In addition to the parameters above, the message API can also use from the 23 endpoint query option
+which is listed in the _Query Parameters_ section.
==== call-feedback-summary
-The call-feedback-summary has 3 API method(s) which is represented by the following method signatures
+The call-feedback-summary API has 3 method(s) which is represented by the following method signatures
(an API method may have multiple signatures due to overloading):
+[source,java]
+----
+
+com.twilio.rest.api.v2010.account.call.FeedbackSummaryCreator creator(String pathAccountSid, org.joda.time.LocalDate startDate, org.joda.time.LocalDate endDate);
+
+com.twilio.rest.api.v2010.account.call.FeedbackSummaryCreator creator(org.joda.time.LocalDate startDate, org.joda.time.LocalDate endDate);
+
+com.twilio.rest.api.v2010.account.call.FeedbackSummaryDeleter deleter(String pathAccountSid, String pathSid);
+
+com.twilio.rest.api.v2010.account.call.FeedbackSummaryDeleter deleter(String pathSid);
+
+com.twilio.rest.api.v2010.account.call.FeedbackSummaryFetcher fetcher(String pathAccountSid, String pathSid);
+
+com.twilio.rest.api.v2010.account.call.FeedbackSummaryFetcher fetcher(String pathSid);
+
----
-com.twilio.rest.api.v2010.account.call.FeedbackSummaryCreator creator(String pathAccountSid, org.joda.time.LocalDate startDate, org.joda.time.LocalDate endDate)
-com.twilio.rest.api.v2010.account.call.FeedbackSummaryCreator creator(org.joda.time.LocalDate startDate, org.joda.time.LocalDate endDate)
-com.twilio.rest.api.v2010.account.call.FeedbackSummaryDeleter deleter(String pathAccountSid, String pathSid)
-com.twilio.rest.api.v2010.account.call.FeedbackSummaryDeleter deleter(String pathSid)
-com.twilio.rest.api.v2010.account.call.FeedbackSummaryFetcher fetcher(String pathAccountSid, String pathSid)
-com.twilio.rest.api.v2010.account.call.FeedbackSummaryFetcher fetcher(String pathSid)
+The call-feedback-summary API is defined in the syntax as follows:
+
+----
+twilio:call-feedback-summary/methodName?[parameters]
----
-The API methods has the following set of options listed in the following table:
-[width="100%",cols="1,2,5,2",options="header"]
+The 3 method(s) is listed in the table below.
+(API methods can have a shorthand alias name which can be used in the syntax instead of the name)
+
+[width="100%",cols="2,2,6",options="header"]
+|===
+| Method | Alias | Description
+| *creator* | create | Create a FeedbackSummaryCreator to execute create
+| *deleter* | delete | Create a FeedbackSummaryDeleter to execute delete
+| *fetcher* | fetch | Create a FeedbackSummaryFetcher to execute fetch
+|===
+
+The call-feedback-summary API method(s) has the following set of parameters listed in the table below:
+[width="100%",cols="2,2,4,2",options="header"]
|===
-| Method | Name | Description | Type
+| Method | Parameter | Description | Type
| creator | *endDate* | Only include feedback given on or before this date | LocalDate
| creator | *pathAccountSid* | The unique sid that identifies this account | String
| creator | *startDate* | Only include feedback given on or after this date | LocalDate
@@ -467,33 +751,65 @@ The API methods has the following set of options listed in the following table:
| fetcher | *pathSid* | A string that uniquely identifies this feedback summary resource | String
|===
+In addition to the parameters above, the call-feedback-summary API can also use from the 23 endpoint query option
+which is listed in the _Query Parameters_ section.
==== sip-credential-list-credential
-The sip-credential-list-credential has 5 API method(s) which is represented by the following method signatures
+The sip-credential-list-credential API has 5 method(s) which is represented by the following method signatures
(an API method may have multiple signatures due to overloading):
+[source,java]
+----
+
+com.twilio.rest.api.v2010.account.sip.credentiallist.CredentialCreator creator(String pathAccountSid, String pathCredentialListSid, String username, String password);
+
+com.twilio.rest.api.v2010.account.sip.credentiallist.CredentialCreator creator(String pathCredentialListSid, String username, String password);
+
+com.twilio.rest.api.v2010.account.sip.credentiallist.CredentialDeleter deleter(String pathAccountSid, String pathCredentialListSid, String pathSid);
+
+com.twilio.rest.api.v2010.account.sip.credentiallist.CredentialDeleter deleter(String pathCredentialListSid, String pathSid);
+
+com.twilio.rest.api.v2010.account.sip.credentiallist.CredentialFetcher fetcher(String pathAccountSid, String pathCredentialListSid, String pathSid);
+
+com.twilio.rest.api.v2010.account.sip.credentiallist.CredentialFetcher fetcher(String pathCredentialListSid, String pathSid);
+
+com.twilio.rest.api.v2010.account.sip.credentiallist.CredentialReader reader(String pathAccountSid, String pathCredentialListSid);
+
+com.twilio.rest.api.v2010.account.sip.credentiallist.CredentialReader reader(String pathCredentialListSid);
+
+com.twilio.rest.api.v2010.account.sip.credentiallist.CredentialUpdater updater(String pathAccountSid, String pathCredentialListSid, String pathSid);
+
+com.twilio.rest.api.v2010.account.sip.credentiallist.CredentialUpdater updater(String pathCredentialListSid, String pathSid);
+
----
-com.twilio.rest.api.v2010.account.sip.credentiallist.CredentialCreator creator(String pathAccountSid, String pathCredentialListSid, String username, String password)
-com.twilio.rest.api.v2010.account.sip.credentiallist.CredentialCreator creator(String pathCredentialListSid, String username, String password)
-com.twilio.rest.api.v2010.account.sip.credentiallist.CredentialDeleter deleter(String pathAccountSid, String pathCredentialListSid, String pathSid)
-com.twilio.rest.api.v2010.account.sip.credentiallist.CredentialDeleter deleter(String pathCredentialListSid, String pathSid)
-com.twilio.rest.api.v2010.account.sip.credentiallist.CredentialFetcher fetcher(String pathAccountSid, String pathCredentialListSid, String pathSid)
-com.twilio.rest.api.v2010.account.sip.credentiallist.CredentialFetcher fetcher(String pathCredentialListSid, String pathSid)
-com.twilio.rest.api.v2010.account.sip.credentiallist.CredentialReader reader(String pathAccountSid, String pathCredentialListSid)
-com.twilio.rest.api.v2010.account.sip.credentiallist.CredentialReader reader(String pathCredentialListSid)
-com.twilio.rest.api.v2010.account.sip.credentiallist.CredentialUpdater updater(String pathAccountSid, String pathCredentialListSid, String pathSid)
-com.twilio.rest.api.v2010.account.sip.credentiallist.CredentialUpdater updater(String pathCredentialListSid, String pathSid)
+The sip-credential-list-credential API is defined in the syntax as follows:
+
+----
+twilio:sip-credential-list-credential/methodName?[parameters]
----
-The API methods has the following set of options listed in the following table:
-[width="100%",cols="1,2,5,2",options="header"]
+The 5 method(s) is listed in the table below.
+(API methods can have a shorthand alias name which can be used in the syntax instead of the name)
+
+[width="100%",cols="2,2,6",options="header"]
+|===
+| Method | Alias | Description
+| *creator* | create | Create a CredentialCreator to execute create
+| *deleter* | delete | Create a CredentialDeleter to execute delete
+| *fetcher* | fetch | Create a CredentialFetcher to execute fetch
+| *reader* | read | Create a CredentialReader to execute read
+| *updater* | update | Create a CredentialUpdater to execute update
+|===
+
+The sip-credential-list-credential API method(s) has the following set of parameters listed in the table below:
+[width="100%",cols="2,2,4,2",options="header"]
|===
-| Method | Name | Description | Type
+| Method | Parameter | Description | Type
| creator | *password* | The password will not be returned in the response | String
| creator | *pathAccountSid* | The unique id of the Account that is responsible for this resource | String
| creator | *pathCredentialListSid* | The unique id that identifies the credential list to include the created credential | String
@@ -511,57 +827,111 @@ The API methods has the following set of options listed in the following table:
| updater | *pathSid* | The unique id that identifies the resource to update | String
|===
+In addition to the parameters above, the sip-credential-list-credential API can also use from the 23 endpoint query option
+which is listed in the _Query Parameters_ section.
==== new-key
-The new-key has 1 API method(s) which is represented by the following method signatures
+The new-key API has 1 method(s) which is represented by the following method signatures
(an API method may have multiple signatures due to overloading):
+[source,java]
+----
+
+com.twilio.rest.api.v2010.account.NewKeyCreator creator();
+
+com.twilio.rest.api.v2010.account.NewKeyCreator creator(String pathAccountSid);
+
----
-com.twilio.rest.api.v2010.account.NewKeyCreator creator()
-com.twilio.rest.api.v2010.account.NewKeyCreator creator(String pathAccountSid)
+The new-key API is defined in the syntax as follows:
+
+----
+twilio:new-key/methodName?[parameters]
----
-The API methods has the following set of options listed in the following table:
-[width="100%",cols="1,2,5,2",options="header"]
+The 1 method(s) is listed in the table below.
+(API methods can have a shorthand alias name which can be used in the syntax instead of the name)
+
+[width="100%",cols="2,2,6",options="header"]
+|===
+| Method | Alias | Description
+| *creator* | create | Create a NewKeyCreator to execute create
+|===
+
+The new-key API method(s) has the following set of parameters listed in the table below:
+[width="100%",cols="2,2,4,2",options="header"]
|===
-| Method | Name | Description | Type
+| Method | Parameter | Description | Type
| creator | *pathAccountSid* | The SID of the Account that will be responsible for the new Key resource | String
|===
+In addition to the parameters above, the new-key API can also use from the 23 endpoint query option
+which is listed in the _Query Parameters_ section.
==== incoming-phone-number
-The incoming-phone-number has 5 API method(s) which is represented by the following method signatures
+The incoming-phone-number API has 5 method(s) which is represented by the following method signatures
(an API method may have multiple signatures due to overloading):
+[source,java]
+----
+
+com.twilio.rest.api.v2010.account.IncomingPhoneNumberCreator creator(String areaCode);
+
+com.twilio.rest.api.v2010.account.IncomingPhoneNumberCreator creator(String pathAccountSid, String areaCode);
+
+com.twilio.rest.api.v2010.account.IncomingPhoneNumberCreator creator(String pathAccountSid, com.twilio.type.PhoneNumber phoneNumber);
+
+com.twilio.rest.api.v2010.account.IncomingPhoneNumberCreator creator(com.twilio.type.PhoneNumber phoneNumber);
+
+com.twilio.rest.api.v2010.account.IncomingPhoneNumberDeleter deleter(String pathAccountSid, String pathSid);
+
+com.twilio.rest.api.v2010.account.IncomingPhoneNumberDeleter deleter(String pathSid);
+
+com.twilio.rest.api.v2010.account.IncomingPhoneNumberFetcher fetcher(String pathAccountSid, String pathSid);
+
+com.twilio.rest.api.v2010.account.IncomingPhoneNumberFetcher fetcher(String pathSid);
+
+com.twilio.rest.api.v2010.account.IncomingPhoneNumberReader reader();
+
+com.twilio.rest.api.v2010.account.IncomingPhoneNumberReader reader(String pathAccountSid);
+
+com.twilio.rest.api.v2010.account.IncomingPhoneNumberUpdater updater(String pathAccountSid, String pathSid);
+
+com.twilio.rest.api.v2010.account.IncomingPhoneNumberUpdater updater(String pathSid);
+
----
-com.twilio.rest.api.v2010.account.IncomingPhoneNumberCreator creator(String areaCode)
-com.twilio.rest.api.v2010.account.IncomingPhoneNumberCreator creator(String pathAccountSid, String areaCode)
-com.twilio.rest.api.v2010.account.IncomingPhoneNumberCreator creator(String pathAccountSid, com.twilio.type.PhoneNumber phoneNumber)
-com.twilio.rest.api.v2010.account.IncomingPhoneNumberCreator creator(com.twilio.type.PhoneNumber phoneNumber)
-com.twilio.rest.api.v2010.account.IncomingPhoneNumberDeleter deleter(String pathAccountSid, String pathSid)
-com.twilio.rest.api.v2010.account.IncomingPhoneNumberDeleter deleter(String pathSid)
-com.twilio.rest.api.v2010.account.IncomingPhoneNumberFetcher fetcher(String pathAccountSid, String pathSid)
-com.twilio.rest.api.v2010.account.IncomingPhoneNumberFetcher fetcher(String pathSid)
-com.twilio.rest.api.v2010.account.IncomingPhoneNumberReader reader()
-com.twilio.rest.api.v2010.account.IncomingPhoneNumberReader reader(String pathAccountSid)
-com.twilio.rest.api.v2010.account.IncomingPhoneNumberUpdater updater(String pathAccountSid, String pathSid)
-com.twilio.rest.api.v2010.account.IncomingPhoneNumberUpdater updater(String pathSid)
+The incoming-phone-number API is defined in the syntax as follows:
+
+----
+twilio:incoming-phone-number/methodName?[parameters]
----
-The API methods has the following set of options listed in the following table:
-[width="100%",cols="1,2,5,2",options="header"]
+The 5 method(s) is listed in the table below.
+(API methods can have a shorthand alias name which can be used in the syntax instead of the name)
+
+[width="100%",cols="2,2,6",options="header"]
+|===
+| Method | Alias | Description
+| *creator* | create | Create a IncomingPhoneNumberCreator to execute create
+| *deleter* | delete | Create a IncomingPhoneNumberDeleter to execute delete
+| *fetcher* | fetch | Create a IncomingPhoneNumberFetcher to execute fetch
+| *reader* | read | Create a IncomingPhoneNumberReader to execute read
+| *updater* | update | Create a IncomingPhoneNumberUpdater to execute update
+|===
+
+The incoming-phone-number API method(s) has the following set of parameters listed in the table below:
+[width="100%",cols="2,2,4,2",options="header"]
|===
-| Method | Name | Description | Type
+| Method | Parameter | Description | Type
| creator | *areaCode* | The desired area code for the new phone number | String
| creator | *pathAccountSid* | The SID of the Account that will create the resource | String
| creator | *phoneNumber* | The phone number to purchase in E.164 format | PhoneNumber
@@ -574,27 +944,50 @@ The API methods has the following set of options listed in the following table:
| updater | *pathSid* | The unique string that identifies the resource | String
|===
+In addition to the parameters above, the incoming-phone-number API can also use from the 23 endpoint query option
+which is listed in the _Query Parameters_ section.
==== call-notification
-The call-notification has 2 API method(s) which is represented by the following method signatures
+The call-notification API has 2 method(s) which is represented by the following method signatures
(an API method may have multiple signatures due to overloading):
+[source,java]
+----
+
+com.twilio.rest.api.v2010.account.call.NotificationFetcher fetcher(String pathAccountSid, String pathCallSid, String pathSid);
+
+com.twilio.rest.api.v2010.account.call.NotificationFetcher fetcher(String pathCallSid, String pathSid);
+
+com.twilio.rest.api.v2010.account.call.NotificationReader reader(String pathAccountSid, String pathCallSid);
+
+com.twilio.rest.api.v2010.account.call.NotificationReader reader(String pathCallSid);
+
----
-com.twilio.rest.api.v2010.account.call.NotificationFetcher fetcher(String pathAccountSid, String pathCallSid, String pathSid)
-com.twilio.rest.api.v2010.account.call.NotificationFetcher fetcher(String pathCallSid, String pathSid)
-com.twilio.rest.api.v2010.account.call.NotificationReader reader(String pathAccountSid, String pathCallSid)
-com.twilio.rest.api.v2010.account.call.NotificationReader reader(String pathCallSid)
+The call-notification API is defined in the syntax as follows:
+
+----
+twilio:call-notification/methodName?[parameters]
----
-The API methods has the following set of options listed in the following table:
-[width="100%",cols="1,2,5,2",options="header"]
+The 2 method(s) is listed in the table below.
+(API methods can have a shorthand alias name which can be used in the syntax instead of the name)
+
+[width="100%",cols="2,2,6",options="header"]
+|===
+| Method | Alias | Description
+| *fetcher* | fetch | Create a NotificationFetcher to execute fetch
+| *reader* | read | Create a NotificationReader to execute read
+|===
+
+The call-notification API method(s) has the following set of parameters listed in the table below:
+[width="100%",cols="2,2,4,2",options="header"]
|===
-| Method | Name | Description | Type
+| Method | Parameter | Description | Type
| fetcher | *pathAccountSid* | The SID of the Account that created the resource to fetch | String
| fetcher | *pathCallSid* | The Call SID of the resource to fetch | String
| fetcher | *pathSid* | The unique string that identifies the resource | String
@@ -602,118 +995,224 @@ The API methods has the following set of options listed in the following table:
| reader | *pathCallSid* | The Call SID of the resource to fetch | String
|===
+In addition to the parameters above, the call-notification API can also use from the 23 endpoint query option
+which is listed in the _Query Parameters_ section.
==== validation-request
-The validation-request has 1 API method(s) which is represented by the following method signatures
+The validation-request API has 1 method(s) which is represented by the following method signatures
(an API method may have multiple signatures due to overloading):
+[source,java]
----
-com.twilio.rest.api.v2010.account.ValidationRequestCreator creator(String pathAccountSid, com.twilio.type.PhoneNumber phoneNumber)
-com.twilio.rest.api.v2010.account.ValidationRequestCreator creator(com.twilio.type.PhoneNumber phoneNumber)
+com.twilio.rest.api.v2010.account.ValidationRequestCreator creator(String pathAccountSid, com.twilio.type.PhoneNumber phoneNumber);
+
+com.twilio.rest.api.v2010.account.ValidationRequestCreator creator(com.twilio.type.PhoneNumber phoneNumber);
+
+----
+
+The validation-request API is defined in the syntax as follows:
+
+----
+twilio:validation-request/methodName?[parameters]
----
-The API methods has the following set of options listed in the following table:
-[width="100%",cols="1,2,5,2",options="header"]
+The 1 method(s) is listed in the table below.
+(API methods can have a shorthand alias name which can be used in the syntax instead of the name)
+
+[width="100%",cols="2,2,6",options="header"]
+|===
+| Method | Alias | Description
+| *creator* | create | Create a ValidationRequestCreator to execute create
+|===
+
+The validation-request API method(s) has the following set of parameters listed in the table below:
+[width="100%",cols="2,2,4,2",options="header"]
|===
-| Method | Name | Description | Type
+| Method | Parameter | Description | Type
| creator | *pathAccountSid* | The SID of the Account responsible for the new Caller ID | String
| creator | *phoneNumber* | The phone number to verify in E.164 format | PhoneNumber
|===
+In addition to the parameters above, the validation-request API can also use from the 23 endpoint query option
+which is listed in the _Query Parameters_ section.
==== usage-record-yesterday
-The usage-record-yesterday has 1 API method(s) which is represented by the following method signatures
+The usage-record-yesterday API has 1 method(s) which is represented by the following method signatures
(an API method may have multiple signatures due to overloading):
+[source,java]
+----
+
+com.twilio.rest.api.v2010.account.usage.record.YesterdayReader reader();
+
+com.twilio.rest.api.v2010.account.usage.record.YesterdayReader reader(String pathAccountSid);
+
----
-com.twilio.rest.api.v2010.account.usage.record.YesterdayReader reader()
-com.twilio.rest.api.v2010.account.usage.record.YesterdayReader reader(String pathAccountSid)
+The usage-record-yesterday API is defined in the syntax as follows:
+
+----
+twilio:usage-record-yesterday/methodName?[parameters]
----
-The API methods has the following set of options listed in the following table:
-[width="100%",cols="1,2,5,2",options="header"]
+The 1 method(s) is listed in the table below.
+(API methods can have a shorthand alias name which can be used in the syntax instead of the name)
+
+[width="100%",cols="2,2,6",options="header"]
+|===
+| Method | Alias | Description
+| *reader* | read | Create a YesterdayReader to execute read
+|===
+
+The usage-record-yesterday API method(s) has the following set of parameters listed in the table below:
+[width="100%",cols="2,2,4,2",options="header"]
|===
-| Method | Name | Description | Type
+| Method | Parameter | Description | Type
| reader | *pathAccountSid* | The SID of the Account that created the resources to read | String
|===
+In addition to the parameters above, the usage-record-yesterday API can also use from the 23 endpoint query option
+which is listed in the _Query Parameters_ section.
==== usage-record-this-month
-The usage-record-this-month has 1 API method(s) which is represented by the following method signatures
+The usage-record-this-month API has 1 method(s) which is represented by the following method signatures
(an API method may have multiple signatures due to overloading):
+[source,java]
+----
+
+com.twilio.rest.api.v2010.account.usage.record.ThisMonthReader reader();
+
+com.twilio.rest.api.v2010.account.usage.record.ThisMonthReader reader(String pathAccountSid);
+
----
-com.twilio.rest.api.v2010.account.usage.record.ThisMonthReader reader()
-com.twilio.rest.api.v2010.account.usage.record.ThisMonthReader reader(String pathAccountSid)
+The usage-record-this-month API is defined in the syntax as follows:
+
+----
+twilio:usage-record-this-month/methodName?[parameters]
----
-The API methods has the following set of options listed in the following table:
-[width="100%",cols="1,2,5,2",options="header"]
+The 1 method(s) is listed in the table below.
+(API methods can have a shorthand alias name which can be used in the syntax instead of the name)
+
+[width="100%",cols="2,2,6",options="header"]
+|===
+| Method | Alias | Description
+| *reader* | read | Create a ThisMonthReader to execute read
+|===
+
+The usage-record-this-month API method(s) has the following set of parameters listed in the table below:
+[width="100%",cols="2,2,4,2",options="header"]
|===
-| Method | Name | Description | Type
+| Method | Parameter | Description | Type
| reader | *pathAccountSid* | The SID of the Account that created the resources to read | String
|===
+In addition to the parameters above, the usage-record-this-month API can also use from the 23 endpoint query option
+which is listed in the _Query Parameters_ section.
==== new-signing-key
-The new-signing-key has 1 API method(s) which is represented by the following method signatures
+The new-signing-key API has 1 method(s) which is represented by the following method signatures
(an API method may have multiple signatures due to overloading):
+[source,java]
+----
+
+com.twilio.rest.api.v2010.account.NewSigningKeyCreator creator();
+
+com.twilio.rest.api.v2010.account.NewSigningKeyCreator creator(String pathAccountSid);
+
----
-com.twilio.rest.api.v2010.account.NewSigningKeyCreator creator()
-com.twilio.rest.api.v2010.account.NewSigningKeyCreator creator(String pathAccountSid)
+The new-signing-key API is defined in the syntax as follows:
+
+----
+twilio:new-signing-key/methodName?[parameters]
----
-The API methods has the following set of options listed in the following table:
-[width="100%",cols="1,2,5,2",options="header"]
+The 1 method(s) is listed in the table below.
+(API methods can have a shorthand alias name which can be used in the syntax instead of the name)
+
+[width="100%",cols="2,2,6",options="header"]
+|===
+| Method | Alias | Description
+| *creator* | create | Create a NewSigningKeyCreator to execute create
+|===
+
+The new-signing-key API method(s) has the following set of parameters listed in the table below:
+[width="100%",cols="2,2,4,2",options="header"]
|===
-| Method | Name | Description | Type
+| Method | Parameter | Description | Type
| creator | *pathAccountSid* | The SID of the Account that will be responsible for the new Key resource | String
|===
+In addition to the parameters above, the new-signing-key API can also use from the 23 endpoint query option
+which is listed in the _Query Parameters_ section.
==== conference
-The conference has 3 API method(s) which is represented by the following method signatures
+The conference API has 3 method(s) which is represented by the following method signatures
(an API method may have multiple signatures due to overloading):
+[source,java]
----
-com.twilio.rest.api.v2010.account.ConferenceFetcher fetcher(String pathAccountSid, String pathSid)
-com.twilio.rest.api.v2010.account.ConferenceFetcher fetcher(String pathSid)
-com.twilio.rest.api.v2010.account.ConferenceReader reader()
-com.twilio.rest.api.v2010.account.ConferenceReader reader(String pathAccountSid)
-com.twilio.rest.api.v2010.account.ConferenceUpdater updater(String pathAccountSid, String pathSid)
-com.twilio.rest.api.v2010.account.ConferenceUpdater updater(String pathSid)
+
+com.twilio.rest.api.v2010.account.ConferenceFetcher fetcher(String pathAccountSid, String pathSid);
+
+com.twilio.rest.api.v2010.account.ConferenceFetcher fetcher(String pathSid);
+
+com.twilio.rest.api.v2010.account.ConferenceReader reader();
+
+com.twilio.rest.api.v2010.account.ConferenceReader reader(String pathAccountSid);
+
+com.twilio.rest.api.v2010.account.ConferenceUpdater updater(String pathAccountSid, String pathSid);
+
+com.twilio.rest.api.v2010.account.ConferenceUpdater updater(String pathSid);
----
-The API methods has the following set of options listed in the following table:
-[width="100%",cols="1,2,5,2",options="header"]
+The conference API is defined in the syntax as follows:
+
+----
+twilio:conference/methodName?[parameters]
+----
+
+The 3 method(s) is listed in the table below.
+(API methods can have a shorthand alias name which can be used in the syntax instead of the name)
+
+[width="100%",cols="2,2,6",options="header"]
+|===
+| Method | Alias | Description
+| *fetcher* | fetch | Create a ConferenceFetcher to execute fetch
+| *reader* | read | Create a ConferenceReader to execute read
+| *updater* | update | Create a ConferenceUpdater to execute update
+|===
+
+The conference API method(s) has the following set of parameters listed in the table below:
+[width="100%",cols="2,2,4,2",options="header"]
|===
-| Method | Name | Description | Type
+| Method | Parameter | Description | Type
| fetcher | *pathAccountSid* | The SID of the Account that created the resource(s) to fetch | String
| fetcher | *pathSid* | The unique string that identifies this resource | String
| reader | *pathAccountSid* | The SID of the Account that created the resource(s) to read | String
@@ -721,55 +1220,107 @@ The API methods has the following set of options listed in the following table:
| updater | *pathSid* | The unique string that identifies this resource | String
|===
+In addition to the parameters above, the conference API can also use from the 23 endpoint query option
+which is listed in the _Query Parameters_ section.
==== usage-record-daily
-The usage-record-daily has 1 API method(s) which is represented by the following method signatures
+The usage-record-daily API has 1 method(s) which is represented by the following method signatures
(an API method may have multiple signatures due to overloading):
+[source,java]
+----
+
+com.twilio.rest.api.v2010.account.usage.record.DailyReader reader();
+
+com.twilio.rest.api.v2010.account.usage.record.DailyReader reader(String pathAccountSid);
+
----
-com.twilio.rest.api.v2010.account.usage.record.DailyReader reader()
-com.twilio.rest.api.v2010.account.usage.record.DailyReader reader(String pathAccountSid)
+The usage-record-daily API is defined in the syntax as follows:
+
+----
+twilio:usage-record-daily/methodName?[parameters]
----
-The API methods has the following set of options listed in the following table:
-[width="100%",cols="1,2,5,2",options="header"]
+The 1 method(s) is listed in the table below.
+(API methods can have a shorthand alias name which can be used in the syntax instead of the name)
+
+[width="100%",cols="2,2,6",options="header"]
+|===
+| Method | Alias | Description
+| *reader* | read | Create a DailyReader to execute read
|===
-| Method | Name | Description | Type
+
+The usage-record-daily API method(s) has the following set of parameters listed in the table below:
+[width="100%",cols="2,2,4,2",options="header"]
+|===
+| Method | Parameter | Description | Type
| reader | *pathAccountSid* | The SID of the Account that created the resources to read | String
|===
+In addition to the parameters above, the usage-record-daily API can also use from the 23 endpoint query option
+which is listed in the _Query Parameters_ section.
==== application
-The application has 5 API method(s) which is represented by the following method signatures
+The application API has 5 method(s) which is represented by the following method signatures
(an API method may have multiple signatures due to overloading):
+[source,java]
+----
+
+com.twilio.rest.api.v2010.account.ApplicationCreator creator();
+
+com.twilio.rest.api.v2010.account.ApplicationCreator creator(String pathAccountSid);
+
+com.twilio.rest.api.v2010.account.ApplicationDeleter deleter(String pathAccountSid, String pathSid);
+
+com.twilio.rest.api.v2010.account.ApplicationDeleter deleter(String pathSid);
+
+com.twilio.rest.api.v2010.account.ApplicationFetcher fetcher(String pathAccountSid, String pathSid);
+
+com.twilio.rest.api.v2010.account.ApplicationFetcher fetcher(String pathSid);
+
+com.twilio.rest.api.v2010.account.ApplicationReader reader();
+
+com.twilio.rest.api.v2010.account.ApplicationReader reader(String pathAccountSid);
+
+com.twilio.rest.api.v2010.account.ApplicationUpdater updater(String pathAccountSid, String pathSid);
+
+com.twilio.rest.api.v2010.account.ApplicationUpdater updater(String pathSid);
+
----
-com.twilio.rest.api.v2010.account.ApplicationCreator creator()
-com.twilio.rest.api.v2010.account.ApplicationCreator creator(String pathAccountSid)
-com.twilio.rest.api.v2010.account.ApplicationDeleter deleter(String pathAccountSid, String pathSid)
-com.twilio.rest.api.v2010.account.ApplicationDeleter deleter(String pathSid)
-com.twilio.rest.api.v2010.account.ApplicationFetcher fetcher(String pathAccountSid, String pathSid)
-com.twilio.rest.api.v2010.account.ApplicationFetcher fetcher(String pathSid)
-com.twilio.rest.api.v2010.account.ApplicationReader reader()
-com.twilio.rest.api.v2010.account.ApplicationReader reader(String pathAccountSid)
-com.twilio.rest.api.v2010.account.ApplicationUpdater updater(String pathAccountSid, String pathSid)
-com.twilio.rest.api.v2010.account.ApplicationUpdater updater(String pathSid)
+
+The application API is defined in the syntax as follows:
----
+twilio:application/methodName?[parameters]
+----
+
+The 5 method(s) is listed in the table below.
+(API methods can have a shorthand alias name which can be used in the syntax instead of the name)
-The API methods has the following set of options listed in the following table:
-[width="100%",cols="1,2,5,2",options="header"]
+[width="100%",cols="2,2,6",options="header"]
|===
-| Method | Name | Description | Type
+| Method | Alias | Description
+| *creator* | create | Create a ApplicationCreator to execute create
+| *deleter* | delete | Create a ApplicationDeleter to execute delete
+| *fetcher* | fetch | Create a ApplicationFetcher to execute fetch
+| *reader* | read | Create a ApplicationReader to execute read
+| *updater* | update | Create a ApplicationUpdater to execute update
+|===
+
+The application API method(s) has the following set of parameters listed in the table below:
+[width="100%",cols="2,2,4,2",options="header"]
+|===
+| Method | Parameter | Description | Type
| creator | *pathAccountSid* | The SID of the Account that will create the resource | String
| deleter | *pathAccountSid* | The SID of the Account that created the resources to delete | String
| deleter | *pathSid* | The unique string that identifies the resource | String
@@ -780,78 +1331,150 @@ The API methods has the following set of options listed in the following table:
| updater | *pathSid* | The unique string that identifies the resource | String
|===
+In addition to the parameters above, the application API can also use from the 23 endpoint query option
+which is listed in the _Query Parameters_ section.
==== usage-record
-The usage-record has 1 API method(s) which is represented by the following method signatures
+The usage-record API has 1 method(s) which is represented by the following method signatures
(an API method may have multiple signatures due to overloading):
+[source,java]
----
-com.twilio.rest.api.v2010.account.usage.RecordReader reader()
-com.twilio.rest.api.v2010.account.usage.RecordReader reader(String pathAccountSid)
+
+com.twilio.rest.api.v2010.account.usage.RecordReader reader();
+
+com.twilio.rest.api.v2010.account.usage.RecordReader reader(String pathAccountSid);
+
+----
+
+The usage-record API is defined in the syntax as follows:
----
+twilio:usage-record/methodName?[parameters]
+----
+
+The 1 method(s) is listed in the table below.
+(API methods can have a shorthand alias name which can be used in the syntax instead of the name)
+
+[width="100%",cols="2,2,6",options="header"]
+|===
+| Method | Alias | Description
+| *reader* | read | Create a RecordReader to execute read
+|===
-The API methods has the following set of options listed in the following table:
-[width="100%",cols="1,2,5,2",options="header"]
+The usage-record API method(s) has the following set of parameters listed in the table below:
+[width="100%",cols="2,2,4,2",options="header"]
|===
-| Method | Name | Description | Type
+| Method | Parameter | Description | Type
| reader | *pathAccountSid* | The SID of the Account that created the resources to read | String
|===
+In addition to the parameters above, the usage-record API can also use from the 23 endpoint query option
+which is listed in the _Query Parameters_ section.
==== available-phone-number-country-mobile
-The available-phone-number-country-mobile has 1 API method(s) which is represented by the following method signatures
+The available-phone-number-country-mobile API has 1 method(s) which is represented by the following method signatures
(an API method may have multiple signatures due to overloading):
+[source,java]
----
-com.twilio.rest.api.v2010.account.availablephonenumbercountry.MobileReader reader(String pathAccountSid, String pathCountryCode)
-com.twilio.rest.api.v2010.account.availablephonenumbercountry.MobileReader reader(String pathCountryCode)
+
+com.twilio.rest.api.v2010.account.availablephonenumbercountry.MobileReader reader(String pathAccountSid, String pathCountryCode);
+
+com.twilio.rest.api.v2010.account.availablephonenumbercountry.MobileReader reader(String pathCountryCode);
----
-The API methods has the following set of options listed in the following table:
-[width="100%",cols="1,2,5,2",options="header"]
+The available-phone-number-country-mobile API is defined in the syntax as follows:
+
+----
+twilio:available-phone-number-country-mobile/methodName?[parameters]
+----
+
+The 1 method(s) is listed in the table below.
+(API methods can have a shorthand alias name which can be used in the syntax instead of the name)
+
+[width="100%",cols="2,2,6",options="header"]
+|===
+| Method | Alias | Description
+| *reader* | read | Create a MobileReader to execute read
|===
-| Method | Name | Description | Type
+
+The available-phone-number-country-mobile API method(s) has the following set of parameters listed in the table below:
+[width="100%",cols="2,2,4,2",options="header"]
+|===
+| Method | Parameter | Description | Type
| reader | *pathAccountSid* | The SID of the Account requesting the AvailablePhoneNumber resources | String
| reader | *pathCountryCode* | The ISO Country code of the country from which to read phone numbers | String
|===
+In addition to the parameters above, the available-phone-number-country-mobile API can also use from the 23 endpoint query option
+which is listed in the _Query Parameters_ section.
==== conference-participant
-The conference-participant has 5 API method(s) which is represented by the following method signatures
+The conference-participant API has 5 method(s) which is represented by the following method signatures
(an API method may have multiple signatures due to overloading):
+[source,java]
----
-com.twilio.rest.api.v2010.account.conference.ParticipantCreator creator(String pathAccountSid, String pathConferenceSid, com.twilio.type.PhoneNumber from, com.twilio.type.PhoneNumber to)
-com.twilio.rest.api.v2010.account.conference.ParticipantCreator creator(String pathConferenceSid, com.twilio.type.PhoneNumber from, com.twilio.type.PhoneNumber to)
-com.twilio.rest.api.v2010.account.conference.ParticipantDeleter deleter(String pathAccountSid, String pathConferenceSid, String pathCallSid)
-com.twilio.rest.api.v2010.account.conference.ParticipantDeleter deleter(String pathConferenceSid, String pathCallSid)
-com.twilio.rest.api.v2010.account.conference.ParticipantFetcher fetcher(String pathAccountSid, String pathConferenceSid, String pathCallSid)
-com.twilio.rest.api.v2010.account.conference.ParticipantFetcher fetcher(String pathConferenceSid, String pathCallSid)
-com.twilio.rest.api.v2010.account.conference.ParticipantReader reader(String pathAccountSid, String pathConferenceSid)
-com.twilio.rest.api.v2010.account.conference.ParticipantReader reader(String pathConferenceSid)
-com.twilio.rest.api.v2010.account.conference.ParticipantUpdater updater(String pathAccountSid, String pathConferenceSid, String pathCallSid)
-com.twilio.rest.api.v2010.account.conference.ParticipantUpdater updater(String pathConferenceSid, String pathCallSid)
+
+com.twilio.rest.api.v2010.account.conference.ParticipantCreator creator(String pathAccountSid, String pathConferenceSid, com.twilio.type.PhoneNumber from, com.twilio.type.PhoneNumber to);
+
+com.twilio.rest.api.v2010.account.conference.ParticipantCreator creator(String pathConferenceSid, com.twilio.type.PhoneNumber from, com.twilio.type.PhoneNumber to);
+
+com.twilio.rest.api.v2010.account.conference.ParticipantDeleter deleter(String pathAccountSid, String pathConferenceSid, String pathCallSid);
+
+com.twilio.rest.api.v2010.account.conference.ParticipantDeleter deleter(String pathConferenceSid, String pathCallSid);
+
+com.twilio.rest.api.v2010.account.conference.ParticipantFetcher fetcher(String pathAccountSid, String pathConferenceSid, String pathCallSid);
+
+com.twilio.rest.api.v2010.account.conference.ParticipantFetcher fetcher(String pathConferenceSid, String pathCallSid);
+
+com.twilio.rest.api.v2010.account.conference.ParticipantReader reader(String pathAccountSid, String pathConferenceSid);
+
+com.twilio.rest.api.v2010.account.conference.ParticipantReader reader(String pathConferenceSid);
+
+com.twilio.rest.api.v2010.account.conference.ParticipantUpdater updater(String pathAccountSid, String pathConferenceSid, String pathCallSid);
+
+com.twilio.rest.api.v2010.account.conference.ParticipantUpdater updater(String pathConferenceSid, String pathCallSid);
----
-The API methods has the following set of options listed in the following table:
-[width="100%",cols="1,2,5,2",options="header"]
+The conference-participant API is defined in the syntax as follows:
+
+----
+twilio:conference-participant/methodName?[parameters]
+----
+
+The 5 method(s) is listed in the table below.
+(API methods can have a shorthand alias name which can be used in the syntax instead of the name)
+
+[width="100%",cols="2,2,6",options="header"]
|===
-| Method | Name | Description | Type
+| Method | Alias | Description
+| *creator* | create | Create a ParticipantCreator to execute create
+| *deleter* | delete | Create a ParticipantDeleter to execute delete
+| *fetcher* | fetch | Create a ParticipantFetcher to execute fetch
+| *reader* | read | Create a ParticipantReader to execute read
+| *updater* | update | Create a ParticipantUpdater to execute update
+|===
+
+The conference-participant API method(s) has the following set of parameters listed in the table below:
+[width="100%",cols="2,2,4,2",options="header"]
+|===
+| Method | Parameter | Description | Type
| creator | *from* | The phone number, Client identifier, or username portion of SIP address that made this call. | PhoneNumber
| creator | *pathAccountSid* | The SID of the Account that will create the resource | String
| creator | *pathConferenceSid* | The SID of the participant's conference | String
@@ -869,29 +1492,55 @@ The API methods has the following set of options listed in the following table:
| updater | *pathConferenceSid* | The SID of the participant's conference | String
|===
+In addition to the parameters above, the conference-participant API can also use from the 23 endpoint query option
+which is listed in the _Query Parameters_ section.
==== recording-add-on-result
-The recording-add-on-result has 3 API method(s) which is represented by the following method signatures
+The recording-add-on-result API has 3 method(s) which is represented by the following method signatures
(an API method may have multiple signatures due to overloading):
+[source,java]
+----
+
+com.twilio.rest.api.v2010.account.recording.AddOnResultDeleter deleter(String pathAccountSid, String pathReferenceSid, String pathSid);
+
+com.twilio.rest.api.v2010.account.recording.AddOnResultDeleter deleter(String pathReferenceSid, String pathSid);
+
+com.twilio.rest.api.v2010.account.recording.AddOnResultFetcher fetcher(String pathAccountSid, String pathReferenceSid, String pathSid);
+
+com.twilio.rest.api.v2010.account.recording.AddOnResultFetcher fetcher(String pathReferenceSid, String pathSid);
+
+com.twilio.rest.api.v2010.account.recording.AddOnResultReader reader(String pathAccountSid, String pathReferenceSid);
+
+com.twilio.rest.api.v2010.account.recording.AddOnResultReader reader(String pathReferenceSid);
+
----
-com.twilio.rest.api.v2010.account.recording.AddOnResultDeleter deleter(String pathAccountSid, String pathReferenceSid, String pathSid)
-com.twilio.rest.api.v2010.account.recording.AddOnResultDeleter deleter(String pathReferenceSid, String pathSid)
-com.twilio.rest.api.v2010.account.recording.AddOnResultFetcher fetcher(String pathAccountSid, String pathReferenceSid, String pathSid)
-com.twilio.rest.api.v2010.account.recording.AddOnResultFetcher fetcher(String pathReferenceSid, String pathSid)
-com.twilio.rest.api.v2010.account.recording.AddOnResultReader reader(String pathAccountSid, String pathReferenceSid)
-com.twilio.rest.api.v2010.account.recording.AddOnResultReader reader(String pathReferenceSid)
+The recording-add-on-result API is defined in the syntax as follows:
+
+----
+twilio:recording-add-on-result/methodName?[parameters]
----
-The API methods has the following set of options listed in the following table:
-[width="100%",cols="1,2,5,2",options="header"]
+The 3 method(s) is listed in the table below.
+(API methods can have a shorthand alias name which can be used in the syntax instead of the name)
+
+[width="100%",cols="2,2,6",options="header"]
+|===
+| Method | Alias | Description
+| *deleter* | delete | Create a AddOnResultDeleter to execute delete
+| *fetcher* | fetch | Create a AddOnResultFetcher to execute fetch
+| *reader* | read | Create a AddOnResultReader to execute read
+|===
+
+The recording-add-on-result API method(s) has the following set of parameters listed in the table below:
+[width="100%",cols="2,2,4,2",options="header"]
|===
-| Method | Name | Description | Type
+| Method | Parameter | Description | Type
| deleter | *pathAccountSid* | The SID of the Account that created the resources to delete | String
| deleter | *pathReferenceSid* | The SID of the recording to which the result to delete belongs | String
| deleter | *pathSid* | The unique string that identifies the resource to delete | String
@@ -902,57 +1551,109 @@ The API methods has the following set of options listed in the following table:
| reader | *pathReferenceSid* | The SID of the recording to which the result to delete belongs | String
|===
+In addition to the parameters above, the recording-add-on-result API can also use from the 23 endpoint query option
+which is listed in the _Query Parameters_ section.
==== notification
-The notification has 2 API method(s) which is represented by the following method signatures
+The notification API has 2 method(s) which is represented by the following method signatures
(an API method may have multiple signatures due to overloading):
+[source,java]
----
-com.twilio.rest.api.v2010.account.NotificationFetcher fetcher(String pathAccountSid, String pathSid)
-com.twilio.rest.api.v2010.account.NotificationFetcher fetcher(String pathSid)
-com.twilio.rest.api.v2010.account.NotificationReader reader()
-com.twilio.rest.api.v2010.account.NotificationReader reader(String pathAccountSid)
+com.twilio.rest.api.v2010.account.NotificationFetcher fetcher(String pathAccountSid, String pathSid);
+
+com.twilio.rest.api.v2010.account.NotificationFetcher fetcher(String pathSid);
+
+com.twilio.rest.api.v2010.account.NotificationReader reader();
+
+com.twilio.rest.api.v2010.account.NotificationReader reader(String pathAccountSid);
+
+----
+
+The notification API is defined in the syntax as follows:
+
+----
+twilio:notification/methodName?[parameters]
----
-The API methods has the following set of options listed in the following table:
-[width="100%",cols="1,2,5,2",options="header"]
+The 2 method(s) is listed in the table below.
+(API methods can have a shorthand alias name which can be used in the syntax instead of the name)
+
+[width="100%",cols="2,2,6",options="header"]
+|===
+| Method | Alias | Description
+| *fetcher* | fetch | Create a NotificationFetcher to execute fetch
+| *reader* | read | Create a NotificationReader to execute read
|===
-| Method | Name | Description | Type
+
+The notification API method(s) has the following set of parameters listed in the table below:
+[width="100%",cols="2,2,4,2",options="header"]
+|===
+| Method | Parameter | Description | Type
| fetcher | *pathAccountSid* | The SID of the Account that created the resource to fetch | String
| fetcher | *pathSid* | The unique string that identifies the resource | String
| reader | *pathAccountSid* | The SID of the Account that created the resources to read | String
|===
+In addition to the parameters above, the notification API can also use from the 23 endpoint query option
+which is listed in the _Query Parameters_ section.
==== sip-domain-ip-access-control-list-mapping
-The sip-domain-ip-access-control-list-mapping has 4 API method(s) which is represented by the following method signatures
+The sip-domain-ip-access-control-list-mapping API has 4 method(s) which is represented by the following method signatures
(an API method may have multiple signatures due to overloading):
+[source,java]
----
-com.twilio.rest.api.v2010.account.sip.domain.IpAccessControlListMappingCreator creator(String pathAccountSid, String pathDomainSid, String ipAccessControlListSid)
-com.twilio.rest.api.v2010.account.sip.domain.IpAccessControlListMappingCreator creator(String pathDomainSid, String ipAccessControlListSid)
-com.twilio.rest.api.v2010.account.sip.domain.IpAccessControlListMappingDeleter deleter(String pathAccountSid, String pathDomainSid, String pathSid)
-com.twilio.rest.api.v2010.account.sip.domain.IpAccessControlListMappingDeleter deleter(String pathDomainSid, String pathSid)
-com.twilio.rest.api.v2010.account.sip.domain.IpAccessControlListMappingFetcher fetcher(String pathAccountSid, String pathDomainSid, String pathSid)
-com.twilio.rest.api.v2010.account.sip.domain.IpAccessControlListMappingFetcher fetcher(String pathDomainSid, String pathSid)
-com.twilio.rest.api.v2010.account.sip.domain.IpAccessControlListMappingReader reader(String pathAccountSid, String pathDomainSid)
-com.twilio.rest.api.v2010.account.sip.domain.IpAccessControlListMappingReader reader(String pathDomainSid)
+
+com.twilio.rest.api.v2010.account.sip.domain.IpAccessControlListMappingCreator creator(String pathAccountSid, String pathDomainSid, String ipAccessControlListSid);
+
+com.twilio.rest.api.v2010.account.sip.domain.IpAccessControlListMappingCreator creator(String pathDomainSid, String ipAccessControlListSid);
+
+com.twilio.rest.api.v2010.account.sip.domain.IpAccessControlListMappingDeleter deleter(String pathAccountSid, String pathDomainSid, String pathSid);
+
+com.twilio.rest.api.v2010.account.sip.domain.IpAccessControlListMappingDeleter deleter(String pathDomainSid, String pathSid);
+
+com.twilio.rest.api.v2010.account.sip.domain.IpAccessControlListMappingFetcher fetcher(String pathAccountSid, String pathDomainSid, String pathSid);
+
+com.twilio.rest.api.v2010.account.sip.domain.IpAccessControlListMappingFetcher fetcher(String pathDomainSid, String pathSid);
+
+com.twilio.rest.api.v2010.account.sip.domain.IpAccessControlListMappingReader reader(String pathAccountSid, String pathDomainSid);
+
+com.twilio.rest.api.v2010.account.sip.domain.IpAccessControlListMappingReader reader(String pathDomainSid);
+
+----
+
+The sip-domain-ip-access-control-list-mapping API is defined in the syntax as follows:
----
+twilio:sip-domain-ip-access-control-list-mapping/methodName?[parameters]
+----
+
+The 4 method(s) is listed in the table below.
+(API methods can have a shorthand alias name which can be used in the syntax instead of the name)
-The API methods has the following set of options listed in the following table:
-[width="100%",cols="1,2,5,2",options="header"]
+[width="100%",cols="2,2,6",options="header"]
|===
-| Method | Name | Description | Type
+| Method | Alias | Description
+| *creator* | create | Create a IpAccessControlListMappingCreator to execute create
+| *deleter* | delete | Create a IpAccessControlListMappingDeleter to execute delete
+| *fetcher* | fetch | Create a IpAccessControlListMappingFetcher to execute fetch
+| *reader* | read | Create a IpAccessControlListMappingReader to execute read
+|===
+
+The sip-domain-ip-access-control-list-mapping API method(s) has the following set of parameters listed in the table below:
+[width="100%",cols="2,2,4,2",options="header"]
+|===
+| Method | Parameter | Description | Type
| creator | *ipAccessControlListSid* | The unique id of the IP access control list to map to the SIP domain | String
| creator | *pathAccountSid* | The unique id of the Account that is responsible for this resource | String
| creator | *pathDomainSid* | A string that uniquely identifies the SIP Domain | String
@@ -966,33 +1667,65 @@ The API methods has the following set of options listed in the following table:
| reader | *pathDomainSid* | A string that uniquely identifies the SIP Domain | String
|===
+In addition to the parameters above, the sip-domain-ip-access-control-list-mapping API can also use from the 23 endpoint query option
+which is listed in the _Query Parameters_ section.
==== sip-domain
-The sip-domain has 5 API method(s) which is represented by the following method signatures
+The sip-domain API has 5 method(s) which is represented by the following method signatures
(an API method may have multiple signatures due to overloading):
+[source,java]
----
-com.twilio.rest.api.v2010.account.sip.DomainCreator creator(String domainName)
-com.twilio.rest.api.v2010.account.sip.DomainCreator creator(String pathAccountSid, String domainName)
-com.twilio.rest.api.v2010.account.sip.DomainDeleter deleter(String pathAccountSid, String pathSid)
-com.twilio.rest.api.v2010.account.sip.DomainDeleter deleter(String pathSid)
-com.twilio.rest.api.v2010.account.sip.DomainFetcher fetcher(String pathAccountSid, String pathSid)
-com.twilio.rest.api.v2010.account.sip.DomainFetcher fetcher(String pathSid)
-com.twilio.rest.api.v2010.account.sip.DomainReader reader()
-com.twilio.rest.api.v2010.account.sip.DomainReader reader(String pathAccountSid)
-com.twilio.rest.api.v2010.account.sip.DomainUpdater updater(String pathAccountSid, String pathSid)
-com.twilio.rest.api.v2010.account.sip.DomainUpdater updater(String pathSid)
+
+com.twilio.rest.api.v2010.account.sip.DomainCreator creator(String domainName);
+
+com.twilio.rest.api.v2010.account.sip.DomainCreator creator(String pathAccountSid, String domainName);
+
+com.twilio.rest.api.v2010.account.sip.DomainDeleter deleter(String pathAccountSid, String pathSid);
+
+com.twilio.rest.api.v2010.account.sip.DomainDeleter deleter(String pathSid);
+
+com.twilio.rest.api.v2010.account.sip.DomainFetcher fetcher(String pathAccountSid, String pathSid);
+
+com.twilio.rest.api.v2010.account.sip.DomainFetcher fetcher(String pathSid);
+
+com.twilio.rest.api.v2010.account.sip.DomainReader reader();
+
+com.twilio.rest.api.v2010.account.sip.DomainReader reader(String pathAccountSid);
+
+com.twilio.rest.api.v2010.account.sip.DomainUpdater updater(String pathAccountSid, String pathSid);
+
+com.twilio.rest.api.v2010.account.sip.DomainUpdater updater(String pathSid);
----
-The API methods has the following set of options listed in the following table:
-[width="100%",cols="1,2,5,2",options="header"]
+The sip-domain API is defined in the syntax as follows:
+
+----
+twilio:sip-domain/methodName?[parameters]
+----
+
+The 5 method(s) is listed in the table below.
+(API methods can have a shorthand alias name which can be used in the syntax instead of the name)
+
+[width="100%",cols="2,2,6",options="header"]
+|===
+| Method | Alias | Description
+| *creator* | create | Create a DomainCreator to execute create
+| *deleter* | delete | Create a DomainDeleter to execute delete
+| *fetcher* | fetch | Create a DomainFetcher to execute fetch
+| *reader* | read | Create a DomainReader to execute read
+| *updater* | update | Create a DomainUpdater to execute update
+|===
+
+The sip-domain API method(s) has the following set of parameters listed in the table below:
+[width="100%",cols="2,2,4,2",options="header"]
|===
-| Method | Name | Description | Type
+| Method | Parameter | Description | Type
| creator | *domainName* | The unique address on Twilio to route SIP traffic | String
| creator | *pathAccountSid* | The SID of the Account that will create the resource | String
| deleter | *pathAccountSid* | The SID of the Account that created the resources to delete | String
@@ -1004,33 +1737,65 @@ The API methods has the following set of options listed in the following table:
| updater | *pathSid* | The unique string that identifies the resource | String
|===
+In addition to the parameters above, the sip-domain API can also use from the 23 endpoint query option
+which is listed in the _Query Parameters_ section.
==== address
-The address has 5 API method(s) which is represented by the following method signatures
+The address API has 5 method(s) which is represented by the following method signatures
(an API method may have multiple signatures due to overloading):
+[source,java]
+----
+
+com.twilio.rest.api.v2010.account.AddressCreator creator(String customerName, String street, String city, String region, String postalCode, String isoCountry);
+
+com.twilio.rest.api.v2010.account.AddressCreator creator(String pathAccountSid, String customerName, String street, String city, String region, String postalCode, String isoCountry);
+
+com.twilio.rest.api.v2010.account.AddressDeleter deleter(String pathAccountSid, String pathSid);
+
+com.twilio.rest.api.v2010.account.AddressDeleter deleter(String pathSid);
+
+com.twilio.rest.api.v2010.account.AddressFetcher fetcher(String pathAccountSid, String pathSid);
+
+com.twilio.rest.api.v2010.account.AddressFetcher fetcher(String pathSid);
+
+com.twilio.rest.api.v2010.account.AddressReader reader();
+
+com.twilio.rest.api.v2010.account.AddressReader reader(String pathAccountSid);
+
+com.twilio.rest.api.v2010.account.AddressUpdater updater(String pathAccountSid, String pathSid);
+
+com.twilio.rest.api.v2010.account.AddressUpdater updater(String pathSid);
+
----
-com.twilio.rest.api.v2010.account.AddressCreator creator(String customerName, String street, String city, String region, String postalCode, String isoCountry)
-com.twilio.rest.api.v2010.account.AddressCreator creator(String pathAccountSid, String customerName, String street, String city, String region, String postalCode, String isoCountry)
-com.twilio.rest.api.v2010.account.AddressDeleter deleter(String pathAccountSid, String pathSid)
-com.twilio.rest.api.v2010.account.AddressDeleter deleter(String pathSid)
-com.twilio.rest.api.v2010.account.AddressFetcher fetcher(String pathAccountSid, String pathSid)
-com.twilio.rest.api.v2010.account.AddressFetcher fetcher(String pathSid)
-com.twilio.rest.api.v2010.account.AddressReader reader()
-com.twilio.rest.api.v2010.account.AddressReader reader(String pathAccountSid)
-com.twilio.rest.api.v2010.account.AddressUpdater updater(String pathAccountSid, String pathSid)
-com.twilio.rest.api.v2010.account.AddressUpdater updater(String pathSid)
+The address API is defined in the syntax as follows:
+
+----
+twilio:address/methodName?[parameters]
----
-The API methods has the following set of options listed in the following table:
-[width="100%",cols="1,2,5,2",options="header"]
+The 5 method(s) is listed in the table below.
+(API methods can have a shorthand alias name which can be used in the syntax instead of the name)
+
+[width="100%",cols="2,2,6",options="header"]
|===
-| Method | Name | Description | Type
+| Method | Alias | Description
+| *creator* | create | Create a AddressCreator to execute create
+| *deleter* | delete | Create a AddressDeleter to execute delete
+| *fetcher* | fetch | Create a AddressFetcher to execute fetch
+| *reader* | read | Create a AddressReader to execute read
+| *updater* | update | Create a AddressUpdater to execute update
+|===
+
+The address API method(s) has the following set of parameters listed in the table below:
+[width="100%",cols="2,2,4,2",options="header"]
+|===
+| Method | Parameter | Description | Type
| creator | *city* | The city of the new address | String
| creator | *customerName* | The name to associate with the new address | String
| creator | *isoCountry* | The ISO country code of the new address | String
@@ -1047,29 +1812,55 @@ The API methods has the following set of options listed in the following table:
| updater | *pathSid* | The unique string that identifies the resource | String
|===
+In addition to the parameters above, the address API can also use from the 23 endpoint query option
+which is listed in the _Query Parameters_ section.
==== message-media
-The message-media has 3 API method(s) which is represented by the following method signatures
+The message-media API has 3 method(s) which is represented by the following method signatures
(an API method may have multiple signatures due to overloading):
+[source,java]
----
-com.twilio.rest.api.v2010.account.message.MediaDeleter deleter(String pathAccountSid, String pathMessageSid, String pathSid)
-com.twilio.rest.api.v2010.account.message.MediaDeleter deleter(String pathMessageSid, String pathSid)
-com.twilio.rest.api.v2010.account.message.MediaFetcher fetcher(String pathAccountSid, String pathMessageSid, String pathSid)
-com.twilio.rest.api.v2010.account.message.MediaFetcher fetcher(String pathMessageSid, String pathSid)
-com.twilio.rest.api.v2010.account.message.MediaReader reader(String pathAccountSid, String pathMessageSid)
-com.twilio.rest.api.v2010.account.message.MediaReader reader(String pathMessageSid)
+
+com.twilio.rest.api.v2010.account.message.MediaDeleter deleter(String pathAccountSid, String pathMessageSid, String pathSid);
+
+com.twilio.rest.api.v2010.account.message.MediaDeleter deleter(String pathMessageSid, String pathSid);
+
+com.twilio.rest.api.v2010.account.message.MediaFetcher fetcher(String pathAccountSid, String pathMessageSid, String pathSid);
+
+com.twilio.rest.api.v2010.account.message.MediaFetcher fetcher(String pathMessageSid, String pathSid);
+
+com.twilio.rest.api.v2010.account.message.MediaReader reader(String pathAccountSid, String pathMessageSid);
+
+com.twilio.rest.api.v2010.account.message.MediaReader reader(String pathMessageSid);
+
+----
+
+The message-media API is defined in the syntax as follows:
----
+twilio:message-media/methodName?[parameters]
+----
+
+The 3 method(s) is listed in the table below.
+(API methods can have a shorthand alias name which can be used in the syntax instead of the name)
-The API methods has the following set of options listed in the following table:
-[width="100%",cols="1,2,5,2",options="header"]
+[width="100%",cols="2,2,6",options="header"]
|===
-| Method | Name | Description | Type
+| Method | Alias | Description
+| *deleter* | delete | Create a MediaDeleter to execute delete
+| *fetcher* | fetch | Create a MediaFetcher to execute fetch
+| *reader* | read | Create a MediaReader to execute read
+|===
+
+The message-media API method(s) has the following set of parameters listed in the table below:
+[width="100%",cols="2,2,4,2",options="header"]
+|===
+| Method | Parameter | Description | Type
| deleter | *pathAccountSid* | The SID of the Account that created the resource(s) to delete | String
| deleter | *pathMessageSid* | The SID of the Message resource that this Media resource belongs to | String
| deleter | *pathSid* | The unique string that identifies this resource | String
@@ -1080,33 +1871,65 @@ The API methods has the following set of options listed in the following table:
| reader | *pathMessageSid* | The SID of the Message resource that this Media resource belongs to | String
|===
+In addition to the parameters above, the message-media API can also use from the 23 endpoint query option
+which is listed in the _Query Parameters_ section.
==== sip-ip-access-control-list-ip-address
-The sip-ip-access-control-list-ip-address has 5 API method(s) which is represented by the following method signatures
+The sip-ip-access-control-list-ip-address API has 5 method(s) which is represented by the following method signatures
(an API method may have multiple signatures due to overloading):
+[source,java]
----
-com.twilio.rest.api.v2010.account.sip.ipaccesscontrollist.IpAddressCreator creator(String pathAccountSid, String pathIpAccessControlListSid, String friendlyName, String ipAddress)
-com.twilio.rest.api.v2010.account.sip.ipaccesscontrollist.IpAddressCreator creator(String pathIpAccessControlListSid, String friendlyName, String ipAddress)
-com.twilio.rest.api.v2010.account.sip.ipaccesscontrollist.IpAddressDeleter deleter(String pathAccountSid, String pathIpAccessControlListSid, String pathSid)
-com.twilio.rest.api.v2010.account.sip.ipaccesscontrollist.IpAddressDeleter deleter(String pathIpAccessControlListSid, String pathSid)
-com.twilio.rest.api.v2010.account.sip.ipaccesscontrollist.IpAddressFetcher fetcher(String pathAccountSid, String pathIpAccessControlListSid, String pathSid)
-com.twilio.rest.api.v2010.account.sip.ipaccesscontrollist.IpAddressFetcher fetcher(String pathIpAccessControlListSid, String pathSid)
-com.twilio.rest.api.v2010.account.sip.ipaccesscontrollist.IpAddressReader reader(String pathAccountSid, String pathIpAccessControlListSid)
-com.twilio.rest.api.v2010.account.sip.ipaccesscontrollist.IpAddressReader reader(String pathIpAccessControlListSid)
-com.twilio.rest.api.v2010.account.sip.ipaccesscontrollist.IpAddressUpdater updater(String pathAccountSid, String pathIpAccessControlListSid, String pathSid)
-com.twilio.rest.api.v2010.account.sip.ipaccesscontrollist.IpAddressUpdater updater(String pathIpAccessControlListSid, String pathSid)
+com.twilio.rest.api.v2010.account.sip.ipaccesscontrollist.IpAddressCreator creator(String pathAccountSid, String pathIpAccessControlListSid, String friendlyName, String ipAddress);
+
+com.twilio.rest.api.v2010.account.sip.ipaccesscontrollist.IpAddressCreator creator(String pathIpAccessControlListSid, String friendlyName, String ipAddress);
+
+com.twilio.rest.api.v2010.account.sip.ipaccesscontrollist.IpAddressDeleter deleter(String pathAccountSid, String pathIpAccessControlListSid, String pathSid);
+
+com.twilio.rest.api.v2010.account.sip.ipaccesscontrollist.IpAddressDeleter deleter(String pathIpAccessControlListSid, String pathSid);
+
+com.twilio.rest.api.v2010.account.sip.ipaccesscontrollist.IpAddressFetcher fetcher(String pathAccountSid, String pathIpAccessControlListSid, String pathSid);
+
+com.twilio.rest.api.v2010.account.sip.ipaccesscontrollist.IpAddressFetcher fetcher(String pathIpAccessControlListSid, String pathSid);
+
+com.twilio.rest.api.v2010.account.sip.ipaccesscontrollist.IpAddressReader reader(String pathAccountSid, String pathIpAccessControlListSid);
+
+com.twilio.rest.api.v2010.account.sip.ipaccesscontrollist.IpAddressReader reader(String pathIpAccessControlListSid);
+
+com.twilio.rest.api.v2010.account.sip.ipaccesscontrollist.IpAddressUpdater updater(String pathAccountSid, String pathIpAccessControlListSid, String pathSid);
+
+com.twilio.rest.api.v2010.account.sip.ipaccesscontrollist.IpAddressUpdater updater(String pathIpAccessControlListSid, String pathSid);
+
+----
+
+The sip-ip-access-control-list-ip-address API is defined in the syntax as follows:
+
+----
+twilio:sip-ip-access-control-list-ip-address/methodName?[parameters]
----
-The API methods has the following set of options listed in the following table:
-[width="100%",cols="1,2,5,2",options="header"]
+The 5 method(s) is listed in the table below.
+(API methods can have a shorthand alias name which can be used in the syntax instead of the name)
+
+[width="100%",cols="2,2,6",options="header"]
+|===
+| Method | Alias | Description
+| *creator* | create | Create a IpAddressCreator to execute create
+| *deleter* | delete | Create a IpAddressDeleter to execute delete
+| *fetcher* | fetch | Create a IpAddressFetcher to execute fetch
+| *reader* | read | Create a IpAddressReader to execute read
+| *updater* | update | Create a IpAddressUpdater to execute update
+|===
+
+The sip-ip-access-control-list-ip-address API method(s) has the following set of parameters listed in the table below:
+[width="100%",cols="2,2,4,2",options="header"]
|===
-| Method | Name | Description | Type
+| Method | Parameter | Description | Type
| creator | *friendlyName* | A human readable descriptive text for this resource, up to 64 characters long. | String
| creator | *ipAddress* | An IP address in dotted decimal notation from which you want to accept traffic. Any SIP requests from this IP address will be allowed by Twilio. IPv4 only supported today. | String
| creator | *pathAccountSid* | The unique sid that identifies this account | String
@@ -1124,81 +1947,156 @@ The API methods has the following set of options listed in the following table:
| updater | *pathSid* | A string that identifies the IpAddress resource to update | String
|===
+In addition to the parameters above, the sip-ip-access-control-list-ip-address API can also use from the 23 endpoint query option
+which is listed in the _Query Parameters_ section.
==== available-phone-number-country
-The available-phone-number-country has 2 API method(s) which is represented by the following method signatures
+The available-phone-number-country API has 2 method(s) which is represented by the following method signatures
(an API method may have multiple signatures due to overloading):
+[source,java]
+----
+
+com.twilio.rest.api.v2010.account.AvailablePhoneNumberCountryFetcher fetcher(String pathAccountSid, String pathCountryCode);
+
+com.twilio.rest.api.v2010.account.AvailablePhoneNumberCountryFetcher fetcher(String pathCountryCode);
+
+com.twilio.rest.api.v2010.account.AvailablePhoneNumberCountryReader reader();
+
+com.twilio.rest.api.v2010.account.AvailablePhoneNumberCountryReader reader(String pathAccountSid);
+
----
-com.twilio.rest.api.v2010.account.AvailablePhoneNumberCountryFetcher fetcher(String pathAccountSid, String pathCountryCode)
-com.twilio.rest.api.v2010.account.AvailablePhoneNumberCountryFetcher fetcher(String pathCountryCode)
-com.twilio.rest.api.v2010.account.AvailablePhoneNumberCountryReader reader()
-com.twilio.rest.api.v2010.account.AvailablePhoneNumberCountryReader reader(String pathAccountSid)
+The available-phone-number-country API is defined in the syntax as follows:
+
+----
+twilio:available-phone-number-country/methodName?[parameters]
----
-The API methods has the following set of options listed in the following table:
-[width="100%",cols="1,2,5,2",options="header"]
+The 2 method(s) is listed in the table below.
+(API methods can have a shorthand alias name which can be used in the syntax instead of the name)
+
+[width="100%",cols="2,2,6",options="header"]
+|===
+| Method | Alias | Description
+| *fetcher* | fetch | Create a AvailablePhoneNumberCountryFetcher to execute fetch
+| *reader* | read | Create a AvailablePhoneNumberCountryReader to execute read
+|===
+
+The available-phone-number-country API method(s) has the following set of parameters listed in the table below:
+[width="100%",cols="2,2,4,2",options="header"]
|===
-| Method | Name | Description | Type
+| Method | Parameter | Description | Type
| fetcher | *pathAccountSid* | The SID of the Account requesting the available phone number Country resource | String
| fetcher | *pathCountryCode* | The ISO country code of the country to fetch available phone number information about | String
| reader | *pathAccountSid* | The SID of the Account requesting the available phone number Country resources | String
|===
+In addition to the parameters above, the available-phone-number-country API can also use from the 23 endpoint query option
+which is listed in the _Query Parameters_ section.
==== usage-record-yearly
-The usage-record-yearly has 1 API method(s) which is represented by the following method signatures
+The usage-record-yearly API has 1 method(s) which is represented by the following method signatures
(an API method may have multiple signatures due to overloading):
+[source,java]
----
-com.twilio.rest.api.v2010.account.usage.record.YearlyReader reader()
-com.twilio.rest.api.v2010.account.usage.record.YearlyReader reader(String pathAccountSid)
+
+com.twilio.rest.api.v2010.account.usage.record.YearlyReader reader();
+
+com.twilio.rest.api.v2010.account.usage.record.YearlyReader reader(String pathAccountSid);
----
-The API methods has the following set of options listed in the following table:
-[width="100%",cols="1,2,5,2",options="header"]
+The usage-record-yearly API is defined in the syntax as follows:
+
+----
+twilio:usage-record-yearly/methodName?[parameters]
+----
+
+The 1 method(s) is listed in the table below.
+(API methods can have a shorthand alias name which can be used in the syntax instead of the name)
+
+[width="100%",cols="2,2,6",options="header"]
|===
-| Method | Name | Description | Type
+| Method | Alias | Description
+| *reader* | read | Create a YearlyReader to execute read
+|===
+
+The usage-record-yearly API method(s) has the following set of parameters listed in the table below:
+[width="100%",cols="2,2,4,2",options="header"]
+|===
+| Method | Parameter | Description | Type
| reader | *pathAccountSid* | The SID of the Account that created the resources to read | String
|===
+In addition to the parameters above, the usage-record-yearly API can also use from the 23 endpoint query option
+which is listed in the _Query Parameters_ section.
==== queue
-The queue has 5 API method(s) which is represented by the following method signatures
+The queue API has 5 method(s) which is represented by the following method signatures
(an API method may have multiple signatures due to overloading):
+[source,java]
+----
+
+com.twilio.rest.api.v2010.account.QueueCreator creator(String friendlyName);
+
+com.twilio.rest.api.v2010.account.QueueCreator creator(String pathAccountSid, String friendlyName);
+
+com.twilio.rest.api.v2010.account.QueueDeleter deleter(String pathAccountSid, String pathSid);
+
+com.twilio.rest.api.v2010.account.QueueDeleter deleter(String pathSid);
+
+com.twilio.rest.api.v2010.account.QueueFetcher fetcher(String pathAccountSid, String pathSid);
+
+com.twilio.rest.api.v2010.account.QueueFetcher fetcher(String pathSid);
+
+com.twilio.rest.api.v2010.account.QueueReader reader();
+
+com.twilio.rest.api.v2010.account.QueueReader reader(String pathAccountSid);
+
+com.twilio.rest.api.v2010.account.QueueUpdater updater(String pathAccountSid, String pathSid);
+
+com.twilio.rest.api.v2010.account.QueueUpdater updater(String pathSid);
+
----
-com.twilio.rest.api.v2010.account.QueueCreator creator(String friendlyName)
-com.twilio.rest.api.v2010.account.QueueCreator creator(String pathAccountSid, String friendlyName)
-com.twilio.rest.api.v2010.account.QueueDeleter deleter(String pathAccountSid, String pathSid)
-com.twilio.rest.api.v2010.account.QueueDeleter deleter(String pathSid)
-com.twilio.rest.api.v2010.account.QueueFetcher fetcher(String pathAccountSid, String pathSid)
-com.twilio.rest.api.v2010.account.QueueFetcher fetcher(String pathSid)
-com.twilio.rest.api.v2010.account.QueueReader reader()
-com.twilio.rest.api.v2010.account.QueueReader reader(String pathAccountSid)
-com.twilio.rest.api.v2010.account.QueueUpdater updater(String pathAccountSid, String pathSid)
-com.twilio.rest.api.v2010.account.QueueUpdater updater(String pathSid)
+The queue API is defined in the syntax as follows:
+
+----
+twilio:queue/methodName?[parameters]
----
-The API methods has the following set of options listed in the following table:
-[width="100%",cols="1,2,5,2",options="header"]
+The 5 method(s) is listed in the table below.
+(API methods can have a shorthand alias name which can be used in the syntax instead of the name)
+
+[width="100%",cols="2,2,6",options="header"]
+|===
+| Method | Alias | Description
+| *creator* | create | Create a QueueCreator to execute create
+| *deleter* | delete | Create a QueueDeleter to execute delete
+| *fetcher* | fetch | Create a QueueFetcher to execute fetch
+| *reader* | read | Create a QueueReader to execute read
+| *updater* | update | Create a QueueUpdater to execute update
|===
-| Method | Name | Description | Type
+
+The queue API method(s) has the following set of parameters listed in the table below:
+[width="100%",cols="2,2,4,2",options="header"]
+|===
+| Method | Parameter | Description | Type
| creator | *friendlyName* | A string to describe this resource | String
| creator | *pathAccountSid* | The SID of the Account that will create the resource | String
| deleter | *pathAccountSid* | The SID of the Account that created the resource(s) to delete | String
@@ -1210,29 +2108,55 @@ The API methods has the following set of options listed in the following table:
| updater | *pathSid* | The unique string that identifies this resource | String
|===
+In addition to the parameters above, the queue API can also use from the 23 endpoint query option
+which is listed in the _Query Parameters_ section.
==== transcription
-The transcription has 3 API method(s) which is represented by the following method signatures
+The transcription API has 3 method(s) which is represented by the following method signatures
(an API method may have multiple signatures due to overloading):
+[source,java]
----
-com.twilio.rest.api.v2010.account.TranscriptionDeleter deleter(String pathAccountSid, String pathSid)
-com.twilio.rest.api.v2010.account.TranscriptionDeleter deleter(String pathSid)
-com.twilio.rest.api.v2010.account.TranscriptionFetcher fetcher(String pathAccountSid, String pathSid)
-com.twilio.rest.api.v2010.account.TranscriptionFetcher fetcher(String pathSid)
-com.twilio.rest.api.v2010.account.TranscriptionReader reader()
-com.twilio.rest.api.v2010.account.TranscriptionReader reader(String pathAccountSid)
+
+com.twilio.rest.api.v2010.account.TranscriptionDeleter deleter(String pathAccountSid, String pathSid);
+
+com.twilio.rest.api.v2010.account.TranscriptionDeleter deleter(String pathSid);
+
+com.twilio.rest.api.v2010.account.TranscriptionFetcher fetcher(String pathAccountSid, String pathSid);
+
+com.twilio.rest.api.v2010.account.TranscriptionFetcher fetcher(String pathSid);
+
+com.twilio.rest.api.v2010.account.TranscriptionReader reader();
+
+com.twilio.rest.api.v2010.account.TranscriptionReader reader(String pathAccountSid);
----
-The API methods has the following set of options listed in the following table:
-[width="100%",cols="1,2,5,2",options="header"]
+The transcription API is defined in the syntax as follows:
+
+----
+twilio:transcription/methodName?[parameters]
+----
+
+The 3 method(s) is listed in the table below.
+(API methods can have a shorthand alias name which can be used in the syntax instead of the name)
+
+[width="100%",cols="2,2,6",options="header"]
|===
-| Method | Name | Description | Type
+| Method | Alias | Description
+| *deleter* | delete | Create a TranscriptionDeleter to execute delete
+| *fetcher* | fetch | Create a TranscriptionFetcher to execute fetch
+| *reader* | read | Create a TranscriptionReader to execute read
+|===
+
+The transcription API method(s) has the following set of parameters listed in the table below:
+[width="100%",cols="2,2,4,2",options="header"]
+|===
+| Method | Parameter | Description | Type
| deleter | *pathAccountSid* | The SID of the Account that created the resources to delete | String
| deleter | *pathSid* | The unique string that identifies the resource | String
| fetcher | *pathAccountSid* | The SID of the Account that created the resource to fetch | String
@@ -1240,31 +2164,60 @@ The API methods has the following set of options listed in the following table:
| reader | *pathAccountSid* | The SID of the Account that created the resources to read | String
|===
+In addition to the parameters above, the transcription API can also use from the 23 endpoint query option
+which is listed in the _Query Parameters_ section.
==== sip-domain-credential-list-mapping
-The sip-domain-credential-list-mapping has 4 API method(s) which is represented by the following method signatures
+The sip-domain-credential-list-mapping API has 4 method(s) which is represented by the following method signatures
(an API method may have multiple signatures due to overloading):
+[source,java]
----
-com.twilio.rest.api.v2010.account.sip.domain.CredentialListMappingCreator creator(String pathAccountSid, String pathDomainSid, String credentialListSid)
-com.twilio.rest.api.v2010.account.sip.domain.CredentialListMappingCreator creator(String pathDomainSid, String credentialListSid)
-com.twilio.rest.api.v2010.account.sip.domain.CredentialListMappingDeleter deleter(String pathAccountSid, String pathDomainSid, String pathSid)
-com.twilio.rest.api.v2010.account.sip.domain.CredentialListMappingDeleter deleter(String pathDomainSid, String pathSid)
-com.twilio.rest.api.v2010.account.sip.domain.CredentialListMappingFetcher fetcher(String pathAccountSid, String pathDomainSid, String pathSid)
-com.twilio.rest.api.v2010.account.sip.domain.CredentialListMappingFetcher fetcher(String pathDomainSid, String pathSid)
-com.twilio.rest.api.v2010.account.sip.domain.CredentialListMappingReader reader(String pathAccountSid, String pathDomainSid)
-com.twilio.rest.api.v2010.account.sip.domain.CredentialListMappingReader reader(String pathDomainSid)
+
+com.twilio.rest.api.v2010.account.sip.domain.CredentialListMappingCreator creator(String pathAccountSid, String pathDomainSid, String credentialListSid);
+
+com.twilio.rest.api.v2010.account.sip.domain.CredentialListMappingCreator creator(String pathDomainSid, String credentialListSid);
+
+com.twilio.rest.api.v2010.account.sip.domain.CredentialListMappingDeleter deleter(String pathAccountSid, String pathDomainSid, String pathSid);
+
+com.twilio.rest.api.v2010.account.sip.domain.CredentialListMappingDeleter deleter(String pathDomainSid, String pathSid);
+
+com.twilio.rest.api.v2010.account.sip.domain.CredentialListMappingFetcher fetcher(String pathAccountSid, String pathDomainSid, String pathSid);
+
+com.twilio.rest.api.v2010.account.sip.domain.CredentialListMappingFetcher fetcher(String pathDomainSid, String pathSid);
+
+com.twilio.rest.api.v2010.account.sip.domain.CredentialListMappingReader reader(String pathAccountSid, String pathDomainSid);
+
+com.twilio.rest.api.v2010.account.sip.domain.CredentialListMappingReader reader(String pathDomainSid);
----
-The API methods has the following set of options listed in the following table:
-[width="100%",cols="1,2,5,2",options="header"]
+The sip-domain-credential-list-mapping API is defined in the syntax as follows:
+
+----
+twilio:sip-domain-credential-list-mapping/methodName?[parameters]
+----
+
+The 4 method(s) is listed in the table below.
+(API methods can have a shorthand alias name which can be used in the syntax instead of the name)
+
+[width="100%",cols="2,2,6",options="header"]
|===
-| Method | Name | Description | Type
+| Method | Alias | Description
+| *creator* | create | Create a CredentialListMappingCreator to execute create
+| *deleter* | delete | Create a CredentialListMappingDeleter to execute delete
+| *fetcher* | fetch | Create a CredentialListMappingFetcher to execute fetch
+| *reader* | read | Create a CredentialListMappingReader to execute read
+|===
+
+The sip-domain-credential-list-mapping API method(s) has the following set of parameters listed in the table below:
+[width="100%",cols="2,2,4,2",options="header"]
+|===
+| Method | Parameter | Description | Type
| creator | *credentialListSid* | A string that identifies the CredentialList resource to map to the SIP domain | String
| creator | *pathAccountSid* | The unique sid that identifies this account | String
| creator | *pathDomainSid* | A string that identifies the SIP Domain for which the CredentialList resource will be mapped | String
@@ -1278,29 +2231,55 @@ The API methods has the following set of options listed in the following table:
| reader | *pathDomainSid* | A string that identifies the SIP Domain for which the CredentialList resource will be mapped | String
|===
+In addition to the parameters above, the sip-domain-credential-list-mapping API can also use from the 23 endpoint query option
+which is listed in the _Query Parameters_ section.
==== call-feedback
-The call-feedback has 3 API method(s) which is represented by the following method signatures
-(an API method may have multiple signatures due to overloading):
+The call-feedback API has 3 method(s) which is represented by the following method signatures
+(an API method may have multiple signatures due to overloading):
+
+[source,java]
+----
+
+com.twilio.rest.api.v2010.account.call.FeedbackCreator creator(String pathAccountSid, String pathCallSid, Integer qualityScore);
+
+com.twilio.rest.api.v2010.account.call.FeedbackCreator creator(String pathCallSid, Integer qualityScore);
+
+com.twilio.rest.api.v2010.account.call.FeedbackFetcher fetcher(String pathAccountSid, String pathCallSid);
+
+com.twilio.rest.api.v2010.account.call.FeedbackFetcher fetcher(String pathCallSid);
+
+com.twilio.rest.api.v2010.account.call.FeedbackUpdater updater(String pathAccountSid, String pathCallSid, Integer qualityScore);
+
+com.twilio.rest.api.v2010.account.call.FeedbackUpdater updater(String pathCallSid, Integer qualityScore);
----
-com.twilio.rest.api.v2010.account.call.FeedbackCreator creator(String pathAccountSid, String pathCallSid, Integer qualityScore)
-com.twilio.rest.api.v2010.account.call.FeedbackCreator creator(String pathCallSid, Integer qualityScore)
-com.twilio.rest.api.v2010.account.call.FeedbackFetcher fetcher(String pathAccountSid, String pathCallSid)
-com.twilio.rest.api.v2010.account.call.FeedbackFetcher fetcher(String pathCallSid)
-com.twilio.rest.api.v2010.account.call.FeedbackUpdater updater(String pathAccountSid, String pathCallSid, Integer qualityScore)
-com.twilio.rest.api.v2010.account.call.FeedbackUpdater updater(String pathCallSid, Integer qualityScore)
+
+The call-feedback API is defined in the syntax as follows:
----
+twilio:call-feedback/methodName?[parameters]
+----
+
+The 3 method(s) is listed in the table below.
+(API methods can have a shorthand alias name which can be used in the syntax instead of the name)
-The API methods has the following set of options listed in the following table:
-[width="100%",cols="1,2,5,2",options="header"]
+[width="100%",cols="2,2,6",options="header"]
|===
-| Method | Name | Description | Type
+| Method | Alias | Description
+| *creator* | create | Create a FeedbackCreator to execute create
+| *fetcher* | fetch | Create a FeedbackFetcher to execute fetch
+| *updater* | update | Create a FeedbackUpdater to execute update
+|===
+
+The call-feedback API method(s) has the following set of parameters listed in the table below:
+[width="100%",cols="2,2,4,2",options="header"]
+|===
+| Method | Parameter | Description | Type
| creator | *pathAccountSid* | The unique sid that identifies this account | String
| creator | *pathCallSid* | The call sid that uniquely identifies the call | String
| creator | *qualityScore* | The call quality expressed as an integer from 1 to 5 | Integer
@@ -1311,31 +2290,60 @@ The API methods has the following set of options listed in the following table:
| updater | *qualityScore* | The call quality expressed as an integer from 1 to 5 | Integer
|===
+In addition to the parameters above, the call-feedback API can also use from the 23 endpoint query option
+which is listed in the _Query Parameters_ section.
==== key
-The key has 4 API method(s) which is represented by the following method signatures
+The key API has 4 method(s) which is represented by the following method signatures
(an API method may have multiple signatures due to overloading):
+[source,java]
+----
+
+com.twilio.rest.api.v2010.account.KeyDeleter deleter(String pathAccountSid, String pathSid);
+
+com.twilio.rest.api.v2010.account.KeyDeleter deleter(String pathSid);
+
+com.twilio.rest.api.v2010.account.KeyFetcher fetcher(String pathAccountSid, String pathSid);
+
+com.twilio.rest.api.v2010.account.KeyFetcher fetcher(String pathSid);
+
+com.twilio.rest.api.v2010.account.KeyReader reader();
+
+com.twilio.rest.api.v2010.account.KeyReader reader(String pathAccountSid);
+
+com.twilio.rest.api.v2010.account.KeyUpdater updater(String pathAccountSid, String pathSid);
+
+com.twilio.rest.api.v2010.account.KeyUpdater updater(String pathSid);
+
----
-com.twilio.rest.api.v2010.account.KeyDeleter deleter(String pathAccountSid, String pathSid)
-com.twilio.rest.api.v2010.account.KeyDeleter deleter(String pathSid)
-com.twilio.rest.api.v2010.account.KeyFetcher fetcher(String pathAccountSid, String pathSid)
-com.twilio.rest.api.v2010.account.KeyFetcher fetcher(String pathSid)
-com.twilio.rest.api.v2010.account.KeyReader reader()
-com.twilio.rest.api.v2010.account.KeyReader reader(String pathAccountSid)
-com.twilio.rest.api.v2010.account.KeyUpdater updater(String pathAccountSid, String pathSid)
-com.twilio.rest.api.v2010.account.KeyUpdater updater(String pathSid)
+
+The key API is defined in the syntax as follows:
----
+twilio:key/methodName?[parameters]
+----
+
+The 4 method(s) is listed in the table below.
+(API methods can have a shorthand alias name which can be used in the syntax instead of the name)
-The API methods has the following set of options listed in the following table:
-[width="100%",cols="1,2,5,2",options="header"]
+[width="100%",cols="2,2,6",options="header"]
|===
-| Method | Name | Description | Type
+| Method | Alias | Description
+| *deleter* | delete | Create a KeyDeleter to execute delete
+| *fetcher* | fetch | Create a KeyFetcher to execute fetch
+| *reader* | read | Create a KeyReader to execute read
+| *updater* | update | Create a KeyUpdater to execute update
+|===
+
+The key API method(s) has the following set of parameters listed in the table below:
+[width="100%",cols="2,2,4,2",options="header"]
+|===
+| Method | Parameter | Description | Type
| deleter | *pathAccountSid* | The SID of the Account that created the resources to delete | String
| deleter | *pathSid* | The unique string that identifies the resource | String
| fetcher | *pathAccountSid* | The SID of the Account that created the resource to fetch | String
@@ -1345,77 +2353,146 @@ The API methods has the following set of options listed in the following table:
| updater | *pathSid* | The unique string that identifies the resource | String
|===
+In addition to the parameters above, the key API can also use from the 23 endpoint query option
+which is listed in the _Query Parameters_ section.
==== incoming-phone-number-toll-free
-The incoming-phone-number-toll-free has 2 API method(s) which is represented by the following method signatures
+The incoming-phone-number-toll-free API has 2 method(s) which is represented by the following method signatures
(an API method may have multiple signatures due to overloading):
+[source,java]
+----
+
+com.twilio.rest.api.v2010.account.incomingphonenumber.TollFreeCreator creator(String pathAccountSid, com.twilio.type.PhoneNumber phoneNumber);
+
+com.twilio.rest.api.v2010.account.incomingphonenumber.TollFreeCreator creator(com.twilio.type.PhoneNumber phoneNumber);
+
+com.twilio.rest.api.v2010.account.incomingphonenumber.TollFreeReader reader();
+
+com.twilio.rest.api.v2010.account.incomingphonenumber.TollFreeReader reader(String pathAccountSid);
+
----
-com.twilio.rest.api.v2010.account.incomingphonenumber.TollFreeCreator creator(String pathAccountSid, com.twilio.type.PhoneNumber phoneNumber)
-com.twilio.rest.api.v2010.account.incomingphonenumber.TollFreeCreator creator(com.twilio.type.PhoneNumber phoneNumber)
-com.twilio.rest.api.v2010.account.incomingphonenumber.TollFreeReader reader()
-com.twilio.rest.api.v2010.account.incomingphonenumber.TollFreeReader reader(String pathAccountSid)
+
+The incoming-phone-number-toll-free API is defined in the syntax as follows:
----
+twilio:incoming-phone-number-toll-free/methodName?[parameters]
+----
+
+The 2 method(s) is listed in the table below.
+(API methods can have a shorthand alias name which can be used in the syntax instead of the name)
-The API methods has the following set of options listed in the following table:
-[width="100%",cols="1,2,5,2",options="header"]
+[width="100%",cols="2,2,6",options="header"]
|===
-| Method | Name | Description | Type
+| Method | Alias | Description
+| *creator* | create | Create a TollFreeCreator to execute create
+| *reader* | read | Create a TollFreeReader to execute read
+|===
+
+The incoming-phone-number-toll-free API method(s) has the following set of parameters listed in the table below:
+[width="100%",cols="2,2,4,2",options="header"]
+|===
+| Method | Parameter | Description | Type
| creator | *pathAccountSid* | The SID of the Account that will create the resource | String
| creator | *phoneNumber* | The phone number to purchase in E.164 format | PhoneNumber
| reader | *pathAccountSid* | The SID of the Account that created the resources to read | String
|===
+In addition to the parameters above, the incoming-phone-number-toll-free API can also use from the 23 endpoint query option
+which is listed in the _Query Parameters_ section.
==== token
-The token has 1 API method(s) which is represented by the following method signatures
+The token API has 1 method(s) which is represented by the following method signatures
(an API method may have multiple signatures due to overloading):
+[source,java]
+----
+
+com.twilio.rest.api.v2010.account.TokenCreator creator();
+
+com.twilio.rest.api.v2010.account.TokenCreator creator(String pathAccountSid);
+
----
-com.twilio.rest.api.v2010.account.TokenCreator creator()
-com.twilio.rest.api.v2010.account.TokenCreator creator(String pathAccountSid)
+
+The token API is defined in the syntax as follows:
----
+twilio:token/methodName?[parameters]
+----
+
+The 1 method(s) is listed in the table below.
+(API methods can have a shorthand alias name which can be used in the syntax instead of the name)
+
+[width="100%",cols="2,2,6",options="header"]
+|===
+| Method | Alias | Description
+| *creator* | create | Create a TokenCreator to execute create
+|===
-The API methods has the following set of options listed in the following table:
-[width="100%",cols="1,2,5,2",options="header"]
+The token API method(s) has the following set of parameters listed in the table below:
+[width="100%",cols="2,2,4,2",options="header"]
|===
-| Method | Name | Description | Type
+| Method | Parameter | Description | Type
| creator | *pathAccountSid* | The SID of the Account that will create the resource | String
|===
+In addition to the parameters above, the token API can also use from the 23 endpoint query option
+which is listed in the _Query Parameters_ section.
==== short-code
-The short-code has 3 API method(s) which is represented by the following method signatures
+The short-code API has 3 method(s) which is represented by the following method signatures
(an API method may have multiple signatures due to overloading):
+[source,java]
+----
+
+com.twilio.rest.api.v2010.account.ShortCodeFetcher fetcher(String pathAccountSid, String pathSid);
+
+com.twilio.rest.api.v2010.account.ShortCodeFetcher fetcher(String pathSid);
+
+com.twilio.rest.api.v2010.account.ShortCodeReader reader();
+
+com.twilio.rest.api.v2010.account.ShortCodeReader reader(String pathAccountSid);
+
+com.twilio.rest.api.v2010.account.ShortCodeUpdater updater(String pathAccountSid, String pathSid);
+
+com.twilio.rest.api.v2010.account.ShortCodeUpdater updater(String pathSid);
+
----
-com.twilio.rest.api.v2010.account.ShortCodeFetcher fetcher(String pathAccountSid, String pathSid)
-com.twilio.rest.api.v2010.account.ShortCodeFetcher fetcher(String pathSid)
-com.twilio.rest.api.v2010.account.ShortCodeReader reader()
-com.twilio.rest.api.v2010.account.ShortCodeReader reader(String pathAccountSid)
-com.twilio.rest.api.v2010.account.ShortCodeUpdater updater(String pathAccountSid, String pathSid)
-com.twilio.rest.api.v2010.account.ShortCodeUpdater updater(String pathSid)
+
+The short-code API is defined in the syntax as follows:
----
+twilio:short-code/methodName?[parameters]
+----
+
+The 3 method(s) is listed in the table below.
+(API methods can have a shorthand alias name which can be used in the syntax instead of the name)
-The API methods has the following set of options listed in the following table:
-[width="100%",cols="1,2,5,2",options="header"]
+[width="100%",cols="2,2,6",options="header"]
|===
-| Method | Name | Description | Type
+| Method | Alias | Description
+| *fetcher* | fetch | Create a ShortCodeFetcher to execute fetch
+| *reader* | read | Create a ShortCodeReader to execute read
+| *updater* | update | Create a ShortCodeUpdater to execute update
+|===
+
+The short-code API method(s) has the following set of parameters listed in the table below:
+[width="100%",cols="2,2,4,2",options="header"]
+|===
+| Method | Parameter | Description | Type
| fetcher | *pathAccountSid* | The SID of the Account that created the resource(s) to fetch | String
| fetcher | *pathSid* | The unique string that identifies this resource | String
| reader | *pathAccountSid* | The SID of the Account that created the resource(s) to read | String
@@ -1423,78 +2500,150 @@ The API methods has the following set of options listed in the following table:
| updater | *pathSid* | The unique string that identifies this resource | String
|===
+In addition to the parameters above, the short-code API can also use from the 23 endpoint query option
+which is listed in the _Query Parameters_ section.
==== available-phone-number-country-toll-free
-The available-phone-number-country-toll-free has 1 API method(s) which is represented by the following method signatures
+The available-phone-number-country-toll-free API has 1 method(s) which is represented by the following method signatures
(an API method may have multiple signatures due to overloading):
+[source,java]
+----
+
+com.twilio.rest.api.v2010.account.availablephonenumbercountry.TollFreeReader reader(String pathAccountSid, String pathCountryCode);
+
+com.twilio.rest.api.v2010.account.availablephonenumbercountry.TollFreeReader reader(String pathCountryCode);
+
----
-com.twilio.rest.api.v2010.account.availablephonenumbercountry.TollFreeReader reader(String pathAccountSid, String pathCountryCode)
-com.twilio.rest.api.v2010.account.availablephonenumbercountry.TollFreeReader reader(String pathCountryCode)
+
+The available-phone-number-country-toll-free API is defined in the syntax as follows:
----
+twilio:available-phone-number-country-toll-free/methodName?[parameters]
+----
+
+The 1 method(s) is listed in the table below.
+(API methods can have a shorthand alias name which can be used in the syntax instead of the name)
+
+[width="100%",cols="2,2,6",options="header"]
+|===
+| Method | Alias | Description
+| *reader* | read | Create a TollFreeReader to execute read
+|===
-The API methods has the following set of options listed in the following table:
-[width="100%",cols="1,2,5,2",options="header"]
+The available-phone-number-country-toll-free API method(s) has the following set of parameters listed in the table below:
+[width="100%",cols="2,2,4,2",options="header"]
|===
-| Method | Name | Description | Type
+| Method | Parameter | Description | Type
| reader | *pathAccountSid* | The SID of the Account requesting the AvailablePhoneNumber resources | String
| reader | *pathCountryCode* | The ISO Country code of the country from which to read phone numbers | String
|===
+In addition to the parameters above, the available-phone-number-country-toll-free API can also use from the 23 endpoint query option
+which is listed in the _Query Parameters_ section.
==== usage-record-monthly
-The usage-record-monthly has 1 API method(s) which is represented by the following method signatures
+The usage-record-monthly API has 1 method(s) which is represented by the following method signatures
(an API method may have multiple signatures due to overloading):
+[source,java]
+----
+
+com.twilio.rest.api.v2010.account.usage.record.MonthlyReader reader();
+
+com.twilio.rest.api.v2010.account.usage.record.MonthlyReader reader(String pathAccountSid);
+
----
-com.twilio.rest.api.v2010.account.usage.record.MonthlyReader reader()
-com.twilio.rest.api.v2010.account.usage.record.MonthlyReader reader(String pathAccountSid)
+
+The usage-record-monthly API is defined in the syntax as follows:
----
+twilio:usage-record-monthly/methodName?[parameters]
+----
+
+The 1 method(s) is listed in the table below.
+(API methods can have a shorthand alias name which can be used in the syntax instead of the name)
-The API methods has the following set of options listed in the following table:
-[width="100%",cols="1,2,5,2",options="header"]
+[width="100%",cols="2,2,6",options="header"]
|===
-| Method | Name | Description | Type
+| Method | Alias | Description
+| *reader* | read | Create a MonthlyReader to execute read
+|===
+
+The usage-record-monthly API method(s) has the following set of parameters listed in the table below:
+[width="100%",cols="2,2,4,2",options="header"]
+|===
+| Method | Parameter | Description | Type
| reader | *pathAccountSid* | The SID of the Account that created the resources to read | String
|===
+In addition to the parameters above, the usage-record-monthly API can also use from the 23 endpoint query option
+which is listed in the _Query Parameters_ section.
==== sip-ip-access-control-list
-The sip-ip-access-control-list has 5 API method(s) which is represented by the following method signatures
+The sip-ip-access-control-list API has 5 method(s) which is represented by the following method signatures
(an API method may have multiple signatures due to overloading):
+[source,java]
+----
+
+com.twilio.rest.api.v2010.account.sip.IpAccessControlListCreator creator(String friendlyName);
+
+com.twilio.rest.api.v2010.account.sip.IpAccessControlListCreator creator(String pathAccountSid, String friendlyName);
+
+com.twilio.rest.api.v2010.account.sip.IpAccessControlListDeleter deleter(String pathAccountSid, String pathSid);
+
+com.twilio.rest.api.v2010.account.sip.IpAccessControlListDeleter deleter(String pathSid);
+
+com.twilio.rest.api.v2010.account.sip.IpAccessControlListFetcher fetcher(String pathAccountSid, String pathSid);
+
+com.twilio.rest.api.v2010.account.sip.IpAccessControlListFetcher fetcher(String pathSid);
+
+com.twilio.rest.api.v2010.account.sip.IpAccessControlListReader reader();
+
+com.twilio.rest.api.v2010.account.sip.IpAccessControlListReader reader(String pathAccountSid);
+
+com.twilio.rest.api.v2010.account.sip.IpAccessControlListUpdater updater(String pathAccountSid, String pathSid, String friendlyName);
+
+com.twilio.rest.api.v2010.account.sip.IpAccessControlListUpdater updater(String pathSid, String friendlyName);
+
----
-com.twilio.rest.api.v2010.account.sip.IpAccessControlListCreator creator(String friendlyName)
-com.twilio.rest.api.v2010.account.sip.IpAccessControlListCreator creator(String pathAccountSid, String friendlyName)
-com.twilio.rest.api.v2010.account.sip.IpAccessControlListDeleter deleter(String pathAccountSid, String pathSid)
-com.twilio.rest.api.v2010.account.sip.IpAccessControlListDeleter deleter(String pathSid)
-com.twilio.rest.api.v2010.account.sip.IpAccessControlListFetcher fetcher(String pathAccountSid, String pathSid)
-com.twilio.rest.api.v2010.account.sip.IpAccessControlListFetcher fetcher(String pathSid)
-com.twilio.rest.api.v2010.account.sip.IpAccessControlListReader reader()
-com.twilio.rest.api.v2010.account.sip.IpAccessControlListReader reader(String pathAccountSid)
-com.twilio.rest.api.v2010.account.sip.IpAccessControlListUpdater updater(String pathAccountSid, String pathSid, String friendlyName)
-com.twilio.rest.api.v2010.account.sip.IpAccessControlListUpdater updater(String pathSid, String friendlyName)
+
+The sip-ip-access-control-list API is defined in the syntax as follows:
----
+twilio:sip-ip-access-control-list/methodName?[parameters]
+----
+
+The 5 method(s) is listed in the table below.
+(API methods can have a shorthand alias name which can be used in the syntax instead of the name)
+
+[width="100%",cols="2,2,6",options="header"]
+|===
+| Method | Alias | Description
+| *creator* | create | Create a IpAccessControlListCreator to execute create
+| *deleter* | delete | Create a IpAccessControlListDeleter to execute delete
+| *fetcher* | fetch | Create a IpAccessControlListFetcher to execute fetch
+| *reader* | read | Create a IpAccessControlListReader to execute read
+| *updater* | update | Create a IpAccessControlListUpdater to execute update
+|===
-The API methods has the following set of options listed in the following table:
-[width="100%",cols="1,2,5,2",options="header"]
+The sip-ip-access-control-list API method(s) has the following set of parameters listed in the table below:
+[width="100%",cols="2,2,4,2",options="header"]
|===
-| Method | Name | Description | Type
+| Method | Parameter | Description | Type
| creator | *friendlyName* | A human readable description of this resource | String
| creator | *pathAccountSid* | The unique sid that identifies this account | String
| deleter | *pathAccountSid* | The unique sid that identifies this account | String
@@ -1507,31 +2656,60 @@ The API methods has the following set of options listed in the following table:
| updater | *pathSid* | A string that identifies the resource to update | String
|===
+In addition to the parameters above, the sip-ip-access-control-list API can also use from the 23 endpoint query option
+which is listed in the _Query Parameters_ section.
==== connect-app
-The connect-app has 4 API method(s) which is represented by the following method signatures
+The connect-app API has 4 method(s) which is represented by the following method signatures
(an API method may have multiple signatures due to overloading):
+[source,java]
+----
+
+com.twilio.rest.api.v2010.account.ConnectAppDeleter deleter(String pathAccountSid, String pathSid);
+
+com.twilio.rest.api.v2010.account.ConnectAppDeleter deleter(String pathSid);
+
+com.twilio.rest.api.v2010.account.ConnectAppFetcher fetcher(String pathAccountSid, String pathSid);
+
+com.twilio.rest.api.v2010.account.ConnectAppFetcher fetcher(String pathSid);
+
+com.twilio.rest.api.v2010.account.ConnectAppReader reader();
+
+com.twilio.rest.api.v2010.account.ConnectAppReader reader(String pathAccountSid);
+
+com.twilio.rest.api.v2010.account.ConnectAppUpdater updater(String pathAccountSid, String pathSid);
+
+com.twilio.rest.api.v2010.account.ConnectAppUpdater updater(String pathSid);
+
----
-com.twilio.rest.api.v2010.account.ConnectAppDeleter deleter(String pathAccountSid, String pathSid)
-com.twilio.rest.api.v2010.account.ConnectAppDeleter deleter(String pathSid)
-com.twilio.rest.api.v2010.account.ConnectAppFetcher fetcher(String pathAccountSid, String pathSid)
-com.twilio.rest.api.v2010.account.ConnectAppFetcher fetcher(String pathSid)
-com.twilio.rest.api.v2010.account.ConnectAppReader reader()
-com.twilio.rest.api.v2010.account.ConnectAppReader reader(String pathAccountSid)
-com.twilio.rest.api.v2010.account.ConnectAppUpdater updater(String pathAccountSid, String pathSid)
-com.twilio.rest.api.v2010.account.ConnectAppUpdater updater(String pathSid)
+
+The connect-app API is defined in the syntax as follows:
----
+twilio:connect-app/methodName?[parameters]
+----
+
+The 4 method(s) is listed in the table below.
+(API methods can have a shorthand alias name which can be used in the syntax instead of the name)
+
+[width="100%",cols="2,2,6",options="header"]
+|===
+| Method | Alias | Description
+| *deleter* | delete | Create a ConnectAppDeleter to execute delete
+| *fetcher* | fetch | Create a ConnectAppFetcher to execute fetch
+| *reader* | read | Create a ConnectAppReader to execute read
+| *updater* | update | Create a ConnectAppUpdater to execute update
+|===
-The API methods has the following set of options listed in the following table:
-[width="100%",cols="1,2,5,2",options="header"]
+The connect-app API method(s) has the following set of parameters listed in the table below:
+[width="100%",cols="2,2,4,2",options="header"]
|===
-| Method | Name | Description | Type
+| Method | Parameter | Description | Type
| deleter | *pathAccountSid* | The SID of the Account that created the resource to fetch | String
| deleter | *pathSid* | The unique string that identifies the resource | String
| fetcher | *pathAccountSid* | The SID of the Account that created the resource to fetch | String
@@ -1541,54 +2719,103 @@ The API methods has the following set of options listed in the following table:
| updater | *pathSid* | The unique string that identifies the resource | String
|===
+In addition to the parameters above, the connect-app API can also use from the 23 endpoint query option
+which is listed in the _Query Parameters_ section.
==== address-dependent-phone-number
-The address-dependent-phone-number has 1 API method(s) which is represented by the following method signatures
+The address-dependent-phone-number API has 1 method(s) which is represented by the following method signatures
(an API method may have multiple signatures due to overloading):
+[source,java]
+----
+
+com.twilio.rest.api.v2010.account.address.DependentPhoneNumberReader reader(String pathAccountSid, String pathAddressSid);
+
+com.twilio.rest.api.v2010.account.address.DependentPhoneNumberReader reader(String pathAddressSid);
+
----
-com.twilio.rest.api.v2010.account.address.DependentPhoneNumberReader reader(String pathAccountSid, String pathAddressSid)
-com.twilio.rest.api.v2010.account.address.DependentPhoneNumberReader reader(String pathAddressSid)
+
+The address-dependent-phone-number API is defined in the syntax as follows:
----
+twilio:address-dependent-phone-number/methodName?[parameters]
+----
+
+The 1 method(s) is listed in the table below.
+(API methods can have a shorthand alias name which can be used in the syntax instead of the name)
-The API methods has the following set of options listed in the following table:
-[width="100%",cols="1,2,5,2",options="header"]
+[width="100%",cols="2,2,6",options="header"]
|===
-| Method | Name | Description | Type
+| Method | Alias | Description
+| *reader* | read | Create a DependentPhoneNumberReader to execute read
+|===
+
+The address-dependent-phone-number API method(s) has the following set of parameters listed in the table below:
+[width="100%",cols="2,2,4,2",options="header"]
+|===
+| Method | Parameter | Description | Type
| reader | *pathAccountSid* | The SID of the Account that created the resources to read | String
| reader | *pathAddressSid* | The SID of the Address resource associated with the phone number | String
|===
+In addition to the parameters above, the address-dependent-phone-number API can also use from the 23 endpoint query option
+which is listed in the _Query Parameters_ section.
==== signing-key
-The signing-key has 4 API method(s) which is represented by the following method signatures
+The signing-key API has 4 method(s) which is represented by the following method signatures
(an API method may have multiple signatures due to overloading):
+[source,java]
+----
+
+com.twilio.rest.api.v2010.account.SigningKeyDeleter deleter(String pathAccountSid, String pathSid);
+
+com.twilio.rest.api.v2010.account.SigningKeyDeleter deleter(String pathSid);
+
+com.twilio.rest.api.v2010.account.SigningKeyFetcher fetcher(String pathAccountSid, String pathSid);
+
+com.twilio.rest.api.v2010.account.SigningKeyFetcher fetcher(String pathSid);
+
+com.twilio.rest.api.v2010.account.SigningKeyReader reader();
+
+com.twilio.rest.api.v2010.account.SigningKeyReader reader(String pathAccountSid);
+
+com.twilio.rest.api.v2010.account.SigningKeyUpdater updater(String pathAccountSid, String pathSid);
+
+com.twilio.rest.api.v2010.account.SigningKeyUpdater updater(String pathSid);
+
----
-com.twilio.rest.api.v2010.account.SigningKeyDeleter deleter(String pathAccountSid, String pathSid)
-com.twilio.rest.api.v2010.account.SigningKeyDeleter deleter(String pathSid)
-com.twilio.rest.api.v2010.account.SigningKeyFetcher fetcher(String pathAccountSid, String pathSid)
-com.twilio.rest.api.v2010.account.SigningKeyFetcher fetcher(String pathSid)
-com.twilio.rest.api.v2010.account.SigningKeyReader reader()
-com.twilio.rest.api.v2010.account.SigningKeyReader reader(String pathAccountSid)
-com.twilio.rest.api.v2010.account.SigningKeyUpdater updater(String pathAccountSid, String pathSid)
-com.twilio.rest.api.v2010.account.SigningKeyUpdater updater(String pathSid)
+
+The signing-key API is defined in the syntax as follows:
----
+twilio:signing-key/methodName?[parameters]
+----
+
+The 4 method(s) is listed in the table below.
+(API methods can have a shorthand alias name which can be used in the syntax instead of the name)
-The API methods has the following set of options listed in the following table:
-[width="100%",cols="1,2,5,2",options="header"]
+[width="100%",cols="2,2,6",options="header"]
|===
-| Method | Name | Description | Type
+| Method | Alias | Description
+| *deleter* | delete | Create a SigningKeyDeleter to execute delete
+| *fetcher* | fetch | Create a SigningKeyFetcher to execute fetch
+| *reader* | read | Create a SigningKeyReader to execute read
+| *updater* | update | Create a SigningKeyUpdater to execute update
+|===
+
+The signing-key API method(s) has the following set of parameters listed in the table below:
+[width="100%",cols="2,2,4,2",options="header"]
+|===
+| Method | Parameter | Description | Type
| deleter | *pathAccountSid* | The account_sid | String
| deleter | *pathSid* | The sid | String
| fetcher | *pathAccountSid* | The account_sid | String
@@ -1598,31 +2825,60 @@ The API methods has the following set of options listed in the following table:
| updater | *pathSid* | The sid | String
|===
+In addition to the parameters above, the signing-key API can also use from the 23 endpoint query option
+which is listed in the _Query Parameters_ section.
==== outgoing-caller-id
-The outgoing-caller-id has 4 API method(s) which is represented by the following method signatures
+The outgoing-caller-id API has 4 method(s) which is represented by the following method signatures
(an API method may have multiple signatures due to overloading):
+[source,java]
+----
+
+com.twilio.rest.api.v2010.account.OutgoingCallerIdDeleter deleter(String pathAccountSid, String pathSid);
+
+com.twilio.rest.api.v2010.account.OutgoingCallerIdDeleter deleter(String pathSid);
+
+com.twilio.rest.api.v2010.account.OutgoingCallerIdFetcher fetcher(String pathAccountSid, String pathSid);
+
+com.twilio.rest.api.v2010.account.OutgoingCallerIdFetcher fetcher(String pathSid);
+
+com.twilio.rest.api.v2010.account.OutgoingCallerIdReader reader();
+
+com.twilio.rest.api.v2010.account.OutgoingCallerIdReader reader(String pathAccountSid);
+
+com.twilio.rest.api.v2010.account.OutgoingCallerIdUpdater updater(String pathAccountSid, String pathSid);
+
+com.twilio.rest.api.v2010.account.OutgoingCallerIdUpdater updater(String pathSid);
+
----
-com.twilio.rest.api.v2010.account.OutgoingCallerIdDeleter deleter(String pathAccountSid, String pathSid)
-com.twilio.rest.api.v2010.account.OutgoingCallerIdDeleter deleter(String pathSid)
-com.twilio.rest.api.v2010.account.OutgoingCallerIdFetcher fetcher(String pathAccountSid, String pathSid)
-com.twilio.rest.api.v2010.account.OutgoingCallerIdFetcher fetcher(String pathSid)
-com.twilio.rest.api.v2010.account.OutgoingCallerIdReader reader()
-com.twilio.rest.api.v2010.account.OutgoingCallerIdReader reader(String pathAccountSid)
-com.twilio.rest.api.v2010.account.OutgoingCallerIdUpdater updater(String pathAccountSid, String pathSid)
-com.twilio.rest.api.v2010.account.OutgoingCallerIdUpdater updater(String pathSid)
+
+The outgoing-caller-id API is defined in the syntax as follows:
----
+twilio:outgoing-caller-id/methodName?[parameters]
+----
+
+The 4 method(s) is listed in the table below.
+(API methods can have a shorthand alias name which can be used in the syntax instead of the name)
-The API methods has the following set of options listed in the following table:
-[width="100%",cols="1,2,5,2",options="header"]
+[width="100%",cols="2,2,6",options="header"]
|===
-| Method | Name | Description | Type
+| Method | Alias | Description
+| *deleter* | delete | Create a OutgoingCallerIdDeleter to execute delete
+| *fetcher* | fetch | Create a OutgoingCallerIdFetcher to execute fetch
+| *reader* | read | Create a OutgoingCallerIdReader to execute read
+| *updater* | update | Create a OutgoingCallerIdUpdater to execute update
+|===
+
+The outgoing-caller-id API method(s) has the following set of parameters listed in the table below:
+[width="100%",cols="2,2,4,2",options="header"]
+|===
+| Method | Parameter | Description | Type
| deleter | *pathAccountSid* | The SID of the Account that created the resources to delete | String
| deleter | *pathSid* | The unique string that identifies the resource | String
| fetcher | *pathAccountSid* | The SID of the Account that created the resource to fetch | String
@@ -1632,37 +2888,73 @@ The API methods has the following set of options listed in the following table:
| updater | *pathSid* | The unique string that identifies the resource | String
|===
+In addition to the parameters above, the outgoing-caller-id API can also use from the 23 endpoint query option
+which is listed in the _Query Parameters_ section.
==== call
-The call has 5 API method(s) which is represented by the following method signatures
+The call API has 5 method(s) which is represented by the following method signatures
(an API method may have multiple signatures due to overloading):
+[source,java]
+----
+
+com.twilio.rest.api.v2010.account.CallCreator creator(String pathAccountSid, com.twilio.type.Endpoint to, com.twilio.type.Endpoint from, String applicationSid);
+
+com.twilio.rest.api.v2010.account.CallCreator creator(String pathAccountSid, com.twilio.type.Endpoint to, com.twilio.type.Endpoint from, com.twilio.type.Twiml twiml);
+
+com.twilio.rest.api.v2010.account.CallCreator creator(String pathAccountSid, com.twilio.type.Endpoint to, com.twilio.type.Endpoint from, java.net.URI url);
+
+com.twilio.rest.api.v2010.account.CallCreator creator(com.twilio.type.Endpoint to, com.twilio.type.Endpoint from, String applicationSid);
+
+com.twilio.rest.api.v2010.account.CallCreator creator(com.twilio.type.Endpoint to, com.twilio.type.Endpoint from, com.twilio.type.Twiml twiml);
+
+com.twilio.rest.api.v2010.account.CallCreator creator(com.twilio.type.Endpoint to, com.twilio.type.Endpoint from, java.net.URI url);
+
+com.twilio.rest.api.v2010.account.CallDeleter deleter(String pathAccountSid, String pathSid);
+
+com.twilio.rest.api.v2010.account.CallDeleter deleter(String pathSid);
+
+com.twilio.rest.api.v2010.account.CallFetcher fetcher(String pathAccountSid, String pathSid);
+
+com.twilio.rest.api.v2010.account.CallFetcher fetcher(String pathSid);
+
+com.twilio.rest.api.v2010.account.CallReader reader();
+
+com.twilio.rest.api.v2010.account.CallReader reader(String pathAccountSid);
+
+com.twilio.rest.api.v2010.account.CallUpdater updater(String pathAccountSid, String pathSid);
+
+com.twilio.rest.api.v2010.account.CallUpdater updater(String pathSid);
+
----
-com.twilio.rest.api.v2010.account.CallCreator creator(String pathAccountSid, com.twilio.type.Endpoint to, com.twilio.type.Endpoint from, String applicationSid)
-com.twilio.rest.api.v2010.account.CallCreator creator(String pathAccountSid, com.twilio.type.Endpoint to, com.twilio.type.Endpoint from, com.twilio.type.Twiml twiml)
-com.twilio.rest.api.v2010.account.CallCreator creator(String pathAccountSid, com.twilio.type.Endpoint to, com.twilio.type.Endpoint from, java.net.URI url)
-com.twilio.rest.api.v2010.account.CallCreator creator(com.twilio.type.Endpoint to, com.twilio.type.Endpoint from, String applicationSid)
-com.twilio.rest.api.v2010.account.CallCreator creator(com.twilio.type.Endpoint to, com.twilio.type.Endpoint from, com.twilio.type.Twiml twiml)
-com.twilio.rest.api.v2010.account.CallCreator creator(com.twilio.type.Endpoint to, com.twilio.type.Endpoint from, java.net.URI url)
-com.twilio.rest.api.v2010.account.CallDeleter deleter(String pathAccountSid, String pathSid)
-com.twilio.rest.api.v2010.account.CallDeleter deleter(String pathSid)
-com.twilio.rest.api.v2010.account.CallFetcher fetcher(String pathAccountSid, String pathSid)
-com.twilio.rest.api.v2010.account.CallFetcher fetcher(String pathSid)
-com.twilio.rest.api.v2010.account.CallReader reader()
-com.twilio.rest.api.v2010.account.CallReader reader(String pathAccountSid)
-com.twilio.rest.api.v2010.account.CallUpdater updater(String pathAccountSid, String pathSid)
-com.twilio.rest.api.v2010.account.CallUpdater updater(String pathSid)
+
+The call API is defined in the syntax as follows:
----
+twilio:call/methodName?[parameters]
+----
+
+The 5 method(s) is listed in the table below.
+(API methods can have a shorthand alias name which can be used in the syntax instead of the name)
+
+[width="100%",cols="2,2,6",options="header"]
+|===
+| Method | Alias | Description
+| *creator* | create | Create a CallCreator to execute create
+| *deleter* | delete | Create a CallDeleter to execute delete
+| *fetcher* | fetch | Create a CallFetcher to execute fetch
+| *reader* | read | Create a CallReader to execute read
+| *updater* | update | Create a CallUpdater to execute update
+|===
-The API methods has the following set of options listed in the following table:
-[width="100%",cols="1,2,5,2",options="header"]
+The call API method(s) has the following set of parameters listed in the table below:
+[width="100%",cols="2,2,4,2",options="header"]
|===
-| Method | Name | Description | Type
+| Method | Parameter | Description | Type
| creator | *applicationSid* | The SID of the Application resource that will handle the call | String
| creator | *from* | Twilio number from which to originate the call | Endpoint
| creator | *pathAccountSid* | The SID of the Account that will create the resource | String
@@ -1678,78 +2970,147 @@ The API methods has the following set of options listed in the following table:
| updater | *pathSid* | The unique string that identifies this resource | String
|===
+In addition to the parameters above, the call API can also use from the 23 endpoint query option
+which is listed in the _Query Parameters_ section.
==== incoming-phone-number-local
-The incoming-phone-number-local has 2 API method(s) which is represented by the following method signatures
+The incoming-phone-number-local API has 2 method(s) which is represented by the following method signatures
(an API method may have multiple signatures due to overloading):
+[source,java]
+----
+
+com.twilio.rest.api.v2010.account.incomingphonenumber.LocalCreator creator(String pathAccountSid, com.twilio.type.PhoneNumber phoneNumber);
+
+com.twilio.rest.api.v2010.account.incomingphonenumber.LocalCreator creator(com.twilio.type.PhoneNumber phoneNumber);
+
+com.twilio.rest.api.v2010.account.incomingphonenumber.LocalReader reader();
+
+com.twilio.rest.api.v2010.account.incomingphonenumber.LocalReader reader(String pathAccountSid);
+
----
-com.twilio.rest.api.v2010.account.incomingphonenumber.LocalCreator creator(String pathAccountSid, com.twilio.type.PhoneNumber phoneNumber)
-com.twilio.rest.api.v2010.account.incomingphonenumber.LocalCreator creator(com.twilio.type.PhoneNumber phoneNumber)
-com.twilio.rest.api.v2010.account.incomingphonenumber.LocalReader reader()
-com.twilio.rest.api.v2010.account.incomingphonenumber.LocalReader reader(String pathAccountSid)
+
+The incoming-phone-number-local API is defined in the syntax as follows:
----
+twilio:incoming-phone-number-local/methodName?[parameters]
+----
+
+The 2 method(s) is listed in the table below.
+(API methods can have a shorthand alias name which can be used in the syntax instead of the name)
+
+[width="100%",cols="2,2,6",options="header"]
+|===
+| Method | Alias | Description
+| *creator* | create | Create a LocalCreator to execute create
+| *reader* | read | Create a LocalReader to execute read
+|===
-The API methods has the following set of options listed in the following table:
-[width="100%",cols="1,2,5,2",options="header"]
+The incoming-phone-number-local API method(s) has the following set of parameters listed in the table below:
+[width="100%",cols="2,2,4,2",options="header"]
|===
-| Method | Name | Description | Type
+| Method | Parameter | Description | Type
| creator | *pathAccountSid* | The SID of the Account that will create the resource | String
| creator | *phoneNumber* | The phone number to purchase in E.164 format | PhoneNumber
| reader | *pathAccountSid* | The SID of the Account that created the resources to read | String
|===
+In addition to the parameters above, the incoming-phone-number-local API can also use from the 23 endpoint query option
+which is listed in the _Query Parameters_ section.
==== message-feedback
-The message-feedback has 1 API method(s) which is represented by the following method signatures
+The message-feedback API has 1 method(s) which is represented by the following method signatures
(an API method may have multiple signatures due to overloading):
+[source,java]
+----
+
+com.twilio.rest.api.v2010.account.message.FeedbackCreator creator(String pathAccountSid, String pathMessageSid);
+
+com.twilio.rest.api.v2010.account.message.FeedbackCreator creator(String pathMessageSid);
+
----
-com.twilio.rest.api.v2010.account.message.FeedbackCreator creator(String pathAccountSid, String pathMessageSid)
-com.twilio.rest.api.v2010.account.message.FeedbackCreator creator(String pathMessageSid)
+
+The message-feedback API is defined in the syntax as follows:
----
+twilio:message-feedback/methodName?[parameters]
+----
+
+The 1 method(s) is listed in the table below.
+(API methods can have a shorthand alias name which can be used in the syntax instead of the name)
-The API methods has the following set of options listed in the following table:
-[width="100%",cols="1,2,5,2",options="header"]
+[width="100%",cols="2,2,6",options="header"]
|===
-| Method | Name | Description | Type
+| Method | Alias | Description
+| *creator* | create | Create a FeedbackCreator to execute create
+|===
+
+The message-feedback API method(s) has the following set of parameters listed in the table below:
+[width="100%",cols="2,2,4,2",options="header"]
+|===
+| Method | Parameter | Description | Type
| creator | *pathAccountSid* | The SID of the Account that will create the resource | String
| creator | *pathMessageSid* | The SID of the Message resource for which the feedback was provided | String
|===
+In addition to the parameters above, the message-feedback API can also use from the 23 endpoint query option
+which is listed in the _Query Parameters_ section.
==== recording
-The recording has 3 API method(s) which is represented by the following method signatures
+The recording API has 3 method(s) which is represented by the following method signatures
(an API method may have multiple signatures due to overloading):
+[source,java]
+----
+
+com.twilio.rest.api.v2010.account.RecordingDeleter deleter(String pathAccountSid, String pathSid);
+
+com.twilio.rest.api.v2010.account.RecordingDeleter deleter(String pathSid);
+
+com.twilio.rest.api.v2010.account.RecordingFetcher fetcher(String pathAccountSid, String pathSid);
+
+com.twilio.rest.api.v2010.account.RecordingFetcher fetcher(String pathSid);
+
+com.twilio.rest.api.v2010.account.RecordingReader reader();
+
+com.twilio.rest.api.v2010.account.RecordingReader reader(String pathAccountSid);
+
----
-com.twilio.rest.api.v2010.account.RecordingDeleter deleter(String pathAccountSid, String pathSid)
-com.twilio.rest.api.v2010.account.RecordingDeleter deleter(String pathSid)
-com.twilio.rest.api.v2010.account.RecordingFetcher fetcher(String pathAccountSid, String pathSid)
-com.twilio.rest.api.v2010.account.RecordingFetcher fetcher(String pathSid)
-com.twilio.rest.api.v2010.account.RecordingReader reader()
-com.twilio.rest.api.v2010.account.RecordingReader reader(String pathAccountSid)
+
+The recording API is defined in the syntax as follows:
----
+twilio:recording/methodName?[parameters]
+----
+
+The 3 method(s) is listed in the table below.
+(API methods can have a shorthand alias name which can be used in the syntax instead of the name)
+
+[width="100%",cols="2,2,6",options="header"]
+|===
+| Method | Alias | Description
+| *deleter* | delete | Create a RecordingDeleter to execute delete
+| *fetcher* | fetch | Create a RecordingFetcher to execute fetch
+| *reader* | read | Create a RecordingReader to execute read
+|===
-The API methods has the following set of options listed in the following table:
-[width="100%",cols="1,2,5,2",options="header"]
+The recording API method(s) has the following set of parameters listed in the table below:
+[width="100%",cols="2,2,4,2",options="header"]
|===
-| Method | Name | Description | Type
+| Method | Parameter | Description | Type
| deleter | *pathAccountSid* | The SID of the Account that created the resources to delete | String
| deleter | *pathSid* | The unique string that identifies the resource | String
| fetcher | *pathAccountSid* | The SID of the Account that created the resource to fetch | String
@@ -1757,84 +3118,162 @@ The API methods has the following set of options listed in the following table:
| reader | *pathAccountSid* | The SID of the Account that created the resources to read | String
|===
+In addition to the parameters above, the recording API can also use from the 23 endpoint query option
+which is listed in the _Query Parameters_ section.
==== incoming-phone-number-mobile
-The incoming-phone-number-mobile has 2 API method(s) which is represented by the following method signatures
+The incoming-phone-number-mobile API has 2 method(s) which is represented by the following method signatures
(an API method may have multiple signatures due to overloading):
+[source,java]
+----
+
+com.twilio.rest.api.v2010.account.incomingphonenumber.MobileCreator creator(String pathAccountSid, com.twilio.type.PhoneNumber phoneNumber);
+
+com.twilio.rest.api.v2010.account.incomingphonenumber.MobileCreator creator(com.twilio.type.PhoneNumber phoneNumber);
+
+com.twilio.rest.api.v2010.account.incomingphonenumber.MobileReader reader();
+
+com.twilio.rest.api.v2010.account.incomingphonenumber.MobileReader reader(String pathAccountSid);
+
----
-com.twilio.rest.api.v2010.account.incomingphonenumber.MobileCreator creator(String pathAccountSid, com.twilio.type.PhoneNumber phoneNumber)
-com.twilio.rest.api.v2010.account.incomingphonenumber.MobileCreator creator(com.twilio.type.PhoneNumber phoneNumber)
-com.twilio.rest.api.v2010.account.incomingphonenumber.MobileReader reader()
-com.twilio.rest.api.v2010.account.incomingphonenumber.MobileReader reader(String pathAccountSid)
+
+The incoming-phone-number-mobile API is defined in the syntax as follows:
----
+twilio:incoming-phone-number-mobile/methodName?[parameters]
+----
+
+The 2 method(s) is listed in the table below.
+(API methods can have a shorthand alias name which can be used in the syntax instead of the name)
+
+[width="100%",cols="2,2,6",options="header"]
+|===
+| Method | Alias | Description
+| *creator* | create | Create a MobileCreator to execute create
+| *reader* | read | Create a MobileReader to execute read
+|===
-The API methods has the following set of options listed in the following table:
-[width="100%",cols="1,2,5,2",options="header"]
+The incoming-phone-number-mobile API method(s) has the following set of parameters listed in the table below:
+[width="100%",cols="2,2,4,2",options="header"]
|===
-| Method | Name | Description | Type
+| Method | Parameter | Description | Type
| creator | *pathAccountSid* | The SID of the Account that will create the resource | String
| creator | *phoneNumber* | The phone number to purchase in E.164 format | PhoneNumber
| reader | *pathAccountSid* | The SID of the Account that created the resources to read | String
|===
+In addition to the parameters above, the incoming-phone-number-mobile API can also use from the 23 endpoint query option
+which is listed in the _Query Parameters_ section.
==== account
-The account has 2 API method(s) which is represented by the following method signatures
+The account API has 2 method(s) which is represented by the following method signatures
(an API method may have multiple signatures due to overloading):
+[source,java]
+----
+
+com.twilio.rest.api.v2010.AccountFetcher fetcher();
+
+com.twilio.rest.api.v2010.AccountFetcher fetcher(String pathSid);
+
+com.twilio.rest.api.v2010.AccountUpdater updater();
+
+com.twilio.rest.api.v2010.AccountUpdater updater(String pathSid);
+
----
-com.twilio.rest.api.v2010.AccountFetcher fetcher()
-com.twilio.rest.api.v2010.AccountFetcher fetcher(String pathSid)
-com.twilio.rest.api.v2010.AccountUpdater updater()
-com.twilio.rest.api.v2010.AccountUpdater updater(String pathSid)
+
+The account API is defined in the syntax as follows:
----
+twilio:account/methodName?[parameters]
+----
+
+The 2 method(s) is listed in the table below.
+(API methods can have a shorthand alias name which can be used in the syntax instead of the name)
+
+[width="100%",cols="2,2,6",options="header"]
+|===
+| Method | Alias | Description
+| *fetcher* | fetch | Create a AccountFetcher to execute fetch
+| *updater* | update | Create a AccountUpdater to execute update
+|===
-The API methods has the following set of options listed in the following table:
-[width="100%",cols="1,2,5,2",options="header"]
+The account API method(s) has the following set of parameters listed in the table below:
+[width="100%",cols="2,2,4,2",options="header"]
|===
-| Method | Name | Description | Type
+| Method | Parameter | Description | Type
| fetcher | *pathSid* | Fetch by unique Account Sid | String
| updater | *pathSid* | Update by unique Account Sid | String
|===
+In addition to the parameters above, the account API can also use from the 23 endpoint query option
+which is listed in the _Query Parameters_ section.
==== sip-credential-list
-The sip-credential-list has 5 API method(s) which is represented by the following method signatures
+The sip-credential-list API has 5 method(s) which is represented by the following method signatures
(an API method may have multiple signatures due to overloading):
+[source,java]
+----
+
+com.twilio.rest.api.v2010.account.sip.CredentialListCreator creator(String friendlyName);
+
+com.twilio.rest.api.v2010.account.sip.CredentialListCreator creator(String pathAccountSid, String friendlyName);
+
+com.twilio.rest.api.v2010.account.sip.CredentialListDeleter deleter(String pathAccountSid, String pathSid);
+
+com.twilio.rest.api.v2010.account.sip.CredentialListDeleter deleter(String pathSid);
+
+com.twilio.rest.api.v2010.account.sip.CredentialListFetcher fetcher(String pathAccountSid, String pathSid);
+
+com.twilio.rest.api.v2010.account.sip.CredentialListFetcher fetcher(String pathSid);
+
+com.twilio.rest.api.v2010.account.sip.CredentialListReader reader();
+
+com.twilio.rest.api.v2010.account.sip.CredentialListReader reader(String pathAccountSid);
+
+com.twilio.rest.api.v2010.account.sip.CredentialListUpdater updater(String pathAccountSid, String pathSid, String friendlyName);
+
+com.twilio.rest.api.v2010.account.sip.CredentialListUpdater updater(String pathSid, String friendlyName);
+
----
-com.twilio.rest.api.v2010.account.sip.CredentialListCreator creator(String friendlyName)
-com.twilio.rest.api.v2010.account.sip.CredentialListCreator creator(String pathAccountSid, String friendlyName)
-com.twilio.rest.api.v2010.account.sip.CredentialListDeleter deleter(String pathAccountSid, String pathSid)
-com.twilio.rest.api.v2010.account.sip.CredentialListDeleter deleter(String pathSid)
-com.twilio.rest.api.v2010.account.sip.CredentialListFetcher fetcher(String pathAccountSid, String pathSid)
-com.twilio.rest.api.v2010.account.sip.CredentialListFetcher fetcher(String pathSid)
-com.twilio.rest.api.v2010.account.sip.CredentialListReader reader()
-com.twilio.rest.api.v2010.account.sip.CredentialListReader reader(String pathAccountSid)
-com.twilio.rest.api.v2010.account.sip.CredentialListUpdater updater(String pathAccountSid, String pathSid, String friendlyName)
-com.twilio.rest.api.v2010.account.sip.CredentialListUpdater updater(String pathSid, String friendlyName)
+
+The sip-credential-list API is defined in the syntax as follows:
----
+twilio:sip-credential-list/methodName?[parameters]
+----
+
+The 5 method(s) is listed in the table below.
+(API methods can have a shorthand alias name which can be used in the syntax instead of the name)
-The API methods has the following set of options listed in the following table:
-[width="100%",cols="1,2,5,2",options="header"]
+[width="100%",cols="2,2,6",options="header"]
|===
-| Method | Name | Description | Type
+| Method | Alias | Description
+| *creator* | create | Create a CredentialListCreator to execute create
+| *deleter* | delete | Create a CredentialListDeleter to execute delete
+| *fetcher* | fetch | Create a CredentialListFetcher to execute fetch
+| *reader* | read | Create a CredentialListReader to execute read
+| *updater* | update | Create a CredentialListUpdater to execute update
+|===
+
+The sip-credential-list API method(s) has the following set of parameters listed in the table below:
+[width="100%",cols="2,2,4,2",options="header"]
+|===
+| Method | Parameter | Description | Type
| creator | *friendlyName* | Human readable descriptive text | String
| creator | *pathAccountSid* | The unique id of the Account that is responsible for this resource | String
| deleter | *pathAccountSid* | The unique id of the Account that is responsible for this resource | String
@@ -1846,6 +3285,9 @@ The API methods has the following set of options listed in the following table:
| updater | *pathAccountSid* | The unique id of the Account that is responsible for this resource | String
| updater | *pathSid* | Update by unique credential list Sid | String
|===
+
+In addition to the parameters above, the sip-credential-list API can also use from the 23 endpoint query option
+which is listed in the _Query Parameters_ section.
// endpoint options: END
== Producer Endpoints:
diff --git a/components/camel-zendesk/src/main/docs/zendesk-component.adoc b/components/camel-zendesk/src/main/docs/zendesk-component.adoc
index 2e48640..57ebf1d 100644
--- a/components/camel-zendesk/src/main/docs/zendesk-component.adoc
+++ b/components/camel-zendesk/src/main/docs/zendesk-component.adoc
@@ -123,327 +123,873 @@ The following lists each API name and method and its additional parameters.
==== DEFAULT
-The DEFAULT has 221 API method(s) which is represented by the following method signatures
+The DEFAULT API has 221 method(s) which is represented by the following method signatures
(an API method may have multiple signatures due to overloading):
+[source,java]
+----
+
+java.util.List<String> addTagToOrganisations(long id, String[] tags);
+
+java.util.List<String> addTagToTicket(long id, String[] tags);
+
+java.util.List<String> addTagToTopics(long id, String[] tags);
+
+void associateAttachmentsToArticle(String idArticle, java.util.List<org.zendesk.client.v2.model.Attachment> attachments);
+
+void changeUserPassword(org.zendesk.client.v2.model.User user, String oldPassword, String newPassword);
+
+org.zendesk.client.v2.model.hc.Article createArticle(org.zendesk.client.v2.model.hc.Article article);
+
+org.zendesk.client.v2.model.hc.Article createArticle(org.zendesk.client.v2.model.hc.Article article, boolean notifySubscribers);
+
+org.zendesk.client.v2.model.hc.Translation createArticleTranslation(Long articleId, org.zendesk.client.v2.model.hc.Translation translation);
+
+org.zendesk.client.v2.model.Automation createAutomation(org.zendesk.client.v2.model.Automation automation);
+
+org.zendesk.client.v2.model.hc.Category createCategory(org.zendesk.client.v2.model.hc.Category category);
+
+org.zendesk.client.v2.model.hc.Translation createCategoryTranslation(Long categoryId, org.zendesk.client.v2.model.hc.Translation translation);
+
+org.zendesk.client.v2.model.Ticket createComment(long ticketId, org.zendesk.client.v2.model.Comment comment);
+
+org.zendesk.client.v2.model.dynamic.DynamicContentItem createDynamicContentItem(org.zendesk.client.v2.model.dynamic.DynamicContentItem item);
+
+org.zendesk.client.v2.model.dynamic.DynamicContentItemVariant createDynamicContentItemVariant(Long itemId, org.zendesk.client.v2.model.dynamic.DynamicContentItemVariant variant);
+
+org.zendesk.client.v2.model.Forum createForum(org.zendesk.client.v2.model.Forum forum);
+
+org.zendesk.client.v2.model.Group createGroup(org.zendesk.client.v2.model.Group group);
+
+org.zendesk.client.v2.model.GroupMembership createGroupMembership(long user_id, org.zendesk.client.v2.model.GroupMembership groupMembership);
+
+org.zendesk.client.v2.model.GroupMembership createGroupMembership(org.zendesk.client.v2.model.GroupMembership groupMembership);
+
+org.zendesk.client.v2.model.Macro createMacro(org.zendesk.client.v2.model.Macro macro);
+
+org.zendesk.client.v2.model.User createOrUpdateUser(org.zendesk.client.v2.model.User user);
+
+org.zendesk.client.v2.model.JobStatus createOrUpdateUsers(java.util.List<org.zendesk.client.v2.model.User> users);
+
+org.zendesk.client.v2.model.JobStatus createOrUpdateUsers(org.zendesk.client.v2.model.User[] users);
+
+org.asynchttpclient.ListenableFuture<org.zendesk.client.v2.model.JobStatus> createOrUpdateUsersAsync(java.util.List<org.zendesk.client.v2.model.User> users);
+
+org.zendesk.client.v2.model.Organization createOrganization(org.zendesk.client.v2.model.Organization organization);
+
+org.zendesk.client.v2.model.OrganizationMembership createOrganizationMembership(long user_id, org.zendesk.client.v2.model.OrganizationMembership organizationMembership);
+
+org.zendesk.client.v2.model.OrganizationMembership createOrganizationMembership(org.zendesk.client.v2.model.OrganizationMembership organizationMembership);
+
+org.zendesk.client.v2.model.JobStatus createOrganizationMemberships(java.util.List<org.zendesk.client.v2.model.OrganizationMembership> organizationMemberships);
+
+org.zendesk.client.v2.model.JobStatus createOrganizationMemberships(org.zendesk.client.v2.model.OrganizationMembership[] organizationMemberships);
+
+org.asynchttpclient.ListenableFuture<org.zendesk.client.v2.model.JobStatus> createOrganizationMembershipsAsync(java.util.List<org.zendesk.client.v2.model.OrganizationMembership> organizationMemberships);
+
+org.zendesk.client.v2.model.JobStatus createOrganizations(java.util.List<org.zendesk.client.v2.model.Organization> organizations);
+
+org.zendesk.client.v2.model.JobStatus createOrganizations(org.zendesk.client.v2.model.Organization[] organizations);
+
+org.asynchttpclient.ListenableFuture<org.zendesk.client.v2.model.JobStatus> createOrganizationsAsync(java.util.List<org.zendesk.client.v2.model.Organization> organizations);
+
+org.zendesk.client.v2.model.hc.PermissionGroup createPermissionGroup(org.zendesk.client.v2.model.hc.PermissionGroup permissionGroup);
+
+org.zendesk.client.v2.model.Request createRequest(org.zendesk.client.v2.model.Request request);
+
+org.zendesk.client.v2.model.SatisfactionRating createSatisfactionRating(long ticketId, org.zendesk.client.v2.model.SatisfactionRating satisfactionRating);
+
+org.zendesk.client.v2.model.SatisfactionRating createSatisfactionRating(org.zendesk.client.v2.model.Ticket ticket, org.zendesk.client.v2.model.SatisfactionRating satisfactionRating);
+
+org.zendesk.client.v2.model.hc.Section createSection(org.zendesk.client.v2.model.hc.Section section);
+
+org.zendesk.client.v2.model.hc.Translation createSectionTranslation(Long sectionId, org.zendesk.client.v2.model.hc.Translation translation);
+
+org.zendesk.client.v2.model.targets.Target createTarget(org.zendesk.client.v2.model.targets.Target target);
+
+org.zendesk.client.v2.model.Ticket createTicket(org.zendesk.client.v2.model.Ticket ticket);
+
+org.asynchttpclient.ListenableFuture<org.zendesk.client.v2.model.Ticket> createTicketAsync(org.zendesk.client.v2.model.Ticket ticket);
+
+org.zendesk.client.v2.model.Field createTicketField(org.zendesk.client.v2.model.Field field);
+
+org.zendesk.client.v2.model.TicketForm createTicketForm(org.zendesk.client.v2.model.TicketForm ticketForm);
+
+org.zendesk.client.v2.model.Ticket createTicketFromTweet(long tweetId, long monitorId);
+
+org.zendesk.client.v2.model.JobStatus createTickets(java.util.List<org.zendesk.client.v2.model.Ticket> tickets);
+
+org.zendesk.client.v2.model.JobStatus createTickets(org.zendesk.client.v2.model.Ticket[] tickets);
+
+org.asynchttpclient.ListenableFuture<org.zendesk.client.v2.model.JobStatus> createTicketsAsync(java.util.List<org.zendesk.client.v2.model.Ticket> tickets);
+
+org.zendesk.client.v2.model.Topic createTopic(org.zendesk.client.v2.model.Topic topic);
+
+org.zendesk.client.v2.model.Trigger createTrigger(org.zendesk.client.v2.model.Trigger trigger);
+
+org.zendesk.client.v2.model.Attachment.Upload createUpload(String fileName, String contentType, byte[] content);
+
+org.zendesk.client.v2.model.Attachment.Upload createUpload(String fileName, byte[] content);
+
+org.zendesk.client.v2.model.Attachment.Upload createUpload(String token, String fileName, String contentType, byte[] content);
+
+org.zendesk.client.v2.model.hc.ArticleAttachments createUploadArticle(long articleId, java.io.File file);
+
+org.zendesk.client.v2.model.hc.ArticleAttachments createUploadArticle(long articleId, java.io.File file, boolean inline);
+
+org.zendesk.client.v2.model.User createUser(org.zendesk.client.v2.model.User user);
+
+org.zendesk.client.v2.model.Identity createUserIdentity(long userId, org.zendesk.client.v2.model.Identity identity);
+
+org.zendesk.client.v2.model.Identity createUserIdentity(org.zendesk.client.v2.model.User user, org.zendesk.client.v2.model.Identity identity);
+
+org.zendesk.client.v2.model.hc.UserSegment createUserSegment(org.zendesk.client.v2.model.hc.UserSegment userSegment);
+
+org.zendesk.client.v2.model.JobStatus createUsers(java.util.List<org.zendesk.client.v2.model.User> users);
+
+org.zendesk.client.v2.model.JobStatus createUsers(org.zendesk.client.v2.model.User[] users);
+
+org.asynchttpclient.ListenableFuture<org.zendesk.client.v2.model.JobStatus> createUsersAsync(java.util.List<org.zendesk.client.v2.model.User> users);
+
+void deleteArticle(org.zendesk.client.v2.model.hc.Article article);
+
+void deleteArticleAttachment(long id);
+
+void deleteArticleAttachment(org.zendesk.client.v2.model.hc.ArticleAttachments attachment);
+
+void deleteAttachment(long id);
+
+void deleteAttachment(org.zendesk.client.v2.model.Attachment attachment);
+
+void deleteAutomation(long automationId);
+
+void deleteCategory(org.zendesk.client.v2.model.hc.Category category);
+
+void deleteDynamicContentItem(org.zendesk.client.v2.model.dynamic.DynamicContentItem item);
+
+void deleteDynamicContentItemVariant(Long itemId, org.zendesk.client.v2.model.dynamic.DynamicContentItemVariant variant);
+
+void deleteForum(org.zendesk.client.v2.model.Forum forum);
+
+void deleteGroup(long id);
+
+void deleteGroup(org.zendesk.client.v2.model.Group group);
+
+void deleteGroupMembership(long id);
+
+void deleteGroupMembership(long user_id, long group_membership_id);
+
+void deleteGroupMembership(long user_id, org.zendesk.client.v2.model.GroupMembership groupMembership);
+
+void deleteGroupMembership(org.zendesk.client.v2.model.GroupMembership groupMembership);
+
+void deleteOrganization(long id);
+
+void deleteOrganization(org.zendesk.client.v2.model.Organization organization);
+
+void deleteOrganizationMembership(long id);
+
+void deleteOrganizationMembership(long user_id, long organization_membership_id);
+
+void deleteOrganizationMembership(long user_id, org.zendesk.client.v2.model.OrganizationMembership organizationMembership);
+
+void deleteOrganizationMemberships(long id, long[] ids);
+
+void deletePermissionGroup(long id);
+
+void deletePermissionGroup(org.zendesk.client.v2.model.hc.PermissionGroup permissionGroup);
+
+void deleteSection(org.zendesk.client.v2.model.hc.Section section);
+
+void deleteSuspendedTicket(long id);
+
+void deleteSuspendedTicket(org.zendesk.client.v2.model.SuspendedTicket ticket);
+
+void deleteTarget(long targetId);
+
+void deleteTicket(long id);
+
+void deleteTicket(org.zendesk.client.v2.model.Ticket ticket);
+
+void deleteTicketField(long id);
+
+void deleteTicketField(org.zendesk.client.v2.model.Field field);
+
+void deleteTickets(long id, long[] ids);
+
+void deleteTopic(org.zendesk.client.v2.model.Topic topic);
+
+void deleteTranslation(Long translationId);
+
+void deleteTranslation(org.zendesk.client.v2.model.hc.Translation translation);
+
+void deleteTrigger(long triggerId);
+
+void deleteUpload(String token);
+
+void deleteUpload(org.zendesk.client.v2.model.Attachment.Upload upload);
+
+void deleteUser(long id);
+
+void deleteUser(org.zendesk.client.v2.model.User user);
+
+void deleteUserIdentity(long userId, long identityId);
+
+void deleteUserIdentity(org.zendesk.client.v2.model.User user, long identityId);
+
+void deleteUserIdentity(org.zendesk.client.v2.model.User user, org.zendesk.client.v2.model.Identity identity);
+
+void deleteUserSegment(long id);
+
+void deleteUserSegment(org.zendesk.client.v2.model.hc.UserSegment userSegment);
+
+org.zendesk.client.v2.model.hc.Article getArticle(long id);
+
+Iterable<org.zendesk.client.v2.model.hc.Article> getArticleFromSearch(String searchTerm);
+
+Iterable<org.zendesk.client.v2.model.hc.Article> getArticleFromSearch(String searchTerm, Long sectionId);
+
+Iterable<org.zendesk.client.v2.model.hc.Subscription> getArticleSubscriptions(Long articleId);
+
+Iterable<org.zendesk.client.v2.model.hc.Subscription> getArticleSubscriptions(Long articleId, String locale);
+
+Iterable<org.zendesk.client.v2.model.hc.Translation> getArticleTranslations(Long articleId);
+
+Iterable<org.zendesk.client.v2.model.hc.Article> getArticles();
+
+Iterable<org.zendesk.client.v2.model.hc.Article> getArticles(String locale);
+
+Iterable<org.zendesk.client.v2.model.hc.Article> getArticles(org.zendesk.client.v2.model.hc.Category category);
+
+Iterable<org.zendesk.client.v2.model.hc.Article> getArticles(org.zendesk.client.v2.model.hc.Section section);
+
+Iterable<org.zendesk.client.v2.model.hc.Article> getArticlesFromAllLabels(java.util.List<String> labels);
+
+Iterable<org.zendesk.client.v2.model.hc.Article> getArticlesFromAnyLabels(java.util.List<String> labels);
+
+java.util.List<org.zendesk.client.v2.model.hc.Article> getArticlesFromPage(int page);
+
+Iterable<org.zendesk.client.v2.model.hc.Article> getArticlesIncrementally(java.util.Date startTime);
+
+Iterable<org.zendesk.client.v2.model.GroupMembership> getAssignableGroupMemberships();
+
+java.util.List<org.zendesk.client.v2.model.GroupMembership> getAssignableGroupMemberships(long group_id);
+
+org.zendesk.client.v2.model.Attachment getAttachment(long id);
+
+org.zendesk.client.v2.model.Attachment getAttachment(org.zendesk.client.v2.model.Attachment attachment);
+
+java.util.List<org.zendesk.client.v2.model.hc.ArticleAttachments> getAttachmentsFromArticle(Long articleID);
+
+Iterable<org.zendesk.client.v2.model.Organization> getAutoCompleteOrganizations(String name);
+
+org.zendesk.client.v2.model.Automation getAutomation(long id);
+
+org.zendesk.client.v2.model.hc.Category getCategory(long id);
+
+Iterable<org.zendesk.client.v2.model.hc.Translation> getCategoryTranslations(Long categoryId);
+
+Iterable<org.zendesk.client.v2.model.ComplianceDeletionStatus> getComplianceDeletionStatuses(long userId);
+
+Iterable<org.zendesk.client.v2.model.DeletedTicket> getDeletedTickets();
+
+Iterable<org.zendesk.client.v2.model.DeletedTicket> getDeletedTickets(String sortBy, org.zendesk.client.v2.model.SortOrder sortOrder);
+
+org.zendesk.client.v2.model.dynamic.DynamicContentItem getDynamicContentItem(long id);
+
+org.zendesk.client.v2.model.dynamic.DynamicContentItemVariant getDynamicContentItemVariant(Long itemId, long id);
+
+Iterable<org.zendesk.client.v2.model.dynamic.DynamicContentItemVariant> getDynamicContentItemVariants(org.zendesk.client.v2.model.dynamic.DynamicContentItem item);
+
+org.zendesk.client.v2.model.Forum getForum(long id);
+
+Iterable<org.zendesk.client.v2.model.Forum> getForums();
+
+java.util.List<org.zendesk.client.v2.model.Forum> getForums(long category_id);
+
+org.zendesk.client.v2.model.Group getGroup(long id);
+
+org.zendesk.client.v2.model.GroupMembership getGroupMembership(long id);
+
+org.zendesk.client.v2.model.GroupMembership getGroupMembership(long user_id, long group_membership_id);
+
+java.util.List<org.zendesk.client.v2.model.GroupMembership> getGroupMembershipByUser(long user_id);
+
+Iterable<org.zendesk.client.v2.model.GroupMembership> getGroupMemberships();
+
+java.util.List<org.zendesk.client.v2.model.GroupMembership> getGroupMemberships(long group_id);
+
+org.zendesk.client.v2.model.OrganizationMembership getGroupOrganization(long user_id, long organization_membership_id);
+
+Iterable<org.zendesk.client.v2.model.User> getGroupUsers(long id);
+
+Iterable<org.zendesk.client.v2.model.schedules.Holiday> getHolidaysForSchedule(Long scheduleId);
+
+Iterable<org.zendesk.client.v2.model.schedules.Holiday> getHolidaysForSchedule(org.zendesk.client.v2.model.schedules.Schedule schedule);
+
+java.util.Map getIncrementalTicketsResult(long unixEpochTime);
+
+org.zendesk.client.v2.model.JobStatus getJobStatus(org.zendesk.client.v2.model.JobStatus status);
+
+org.asynchttpclient.ListenableFuture<org.zendesk.client.v2.model.JobStatus> getJobStatusAsync(org.zendesk.client.v2.model.JobStatus status);
+
+java.util.List<org.zendesk.client.v2.model.JobStatus> getJobStatuses(java.util.List<org.zendesk.client.v2.model.JobStatus> statuses);
+
+org.asynchttpclient.ListenableFuture<java.util.List<org.zendesk.client.v2.model.JobStatus>> getJobStatusesAsync(java.util.List<org.zendesk.client.v2.model.JobStatus> statuses);
+
+org.zendesk.client.v2.model.Macro getMacro(long macroId);
+
+org.zendesk.client.v2.model.Organization getOrganization(long id);
+
+org.zendesk.client.v2.model.OrganizationMembership getOrganizationMembership(long id);
+
+java.util.List<org.zendesk.client.v2.model.OrganizationMembership> getOrganizationMembershipByUser(long user_id);
+
+org.zendesk.client.v2.model.OrganizationMembership getOrganizationMembershipForUser(long user_id, long id);
+
+Iterable<org.zendesk.client.v2.model.OrganizationMembership> getOrganizationMembershipsForOrg(long organization_id);
+
+Iterable<org.zendesk.client.v2.model.OrganizationMembership> getOrganizationMembershipsForUser(long user_id);
+
+Iterable<org.zendesk.client.v2.model.Ticket> getOrganizationTickets(long organizationId);
+
+Iterable<org.zendesk.client.v2.model.User> getOrganizationUsers(long id);
+
+Iterable<org.zendesk.client.v2.model.Organization> getOrganizationsIncrementally(java.util.Date startTime);
+
+org.zendesk.client.v2.model.hc.PermissionGroup getPermissionGroup(long id);
+
+org.zendesk.client.v2.model.Request getRequest(long id);
+
+org.zendesk.client.v2.model.Comment getRequestComment(long requestId, long commentId);
+
+org.zendesk.client.v2.model.Comment getRequestComment(org.zendesk.client.v2.model.Request request, long commentId);
+
+org.zendesk.client.v2.model.Comment getRequestComment(org.zendesk.client.v2.model.Request request, org.zendesk.client.v2.model.Comment comment);
+
+Iterable<org.zendesk.client.v2.model.Comment> getRequestComments(long id);
+
+Iterable<org.zendesk.client.v2.model.Comment> getRequestComments(org.zendesk.client.v2.model.Request request);
+
+org.zendesk.client.v2.model.SatisfactionRating getSatisfactionRating(long id);
+
+org.zendesk.client.v2.model.schedules.Schedule getSchedule(Long scheduleId);
+
+org.zendesk.client.v2.model.schedules.Schedule getSchedule(org.zendesk.client.v2.model.schedules.Schedule schedule);
+
+Iterable<org.zendesk.client.v2.model.SearchResultEntity> getSearchResults(Class<org.zendesk.client.v2.model.SearchResultEntity> type, String query);
+
+Iterable<org.zendesk.client.v2.model.SearchResultEntity> getSearchResults(Class<org.zendesk.client.v2.model.SearchResultEntity> type, String query, String params);
+
+Iterable<org.zendesk.client.v2.model.SearchResultEntity> getSearchResults(Class<org.zendesk.client.v2.model.SearchResultEntity> type, String query, String sortBy, org.zendesk.client.v2.model.SortOrder sortOrder);
+
+Iterable<org.zendesk.client.v2.model.SearchResultEntity> getSearchResults(Class<org.zendesk.client.v2.model.SearchResultEntity> type, String query, java.util.Map<String, Object> params);
+
+Iterable<org.zendesk.client.v2.model.SearchResultEntity> getSearchResults(String query);
+
+org.zendesk.client.v2.model.hc.Section getSection(long id);
+
+Iterable<org.zendesk.client.v2.model.hc.Subscription> getSectionSubscriptions(Long sectionId);
+
+Iterable<org.zendesk.client.v2.model.hc.Subscription> getSectionSubscriptions(Long sectionId, String locale);
+
+Iterable<org.zendesk.client.v2.model.hc.Translation> getSectionTranslations(Long sectionId);
+
+Iterable<org.zendesk.client.v2.model.hc.Section> getSections();
+
+Iterable<org.zendesk.client.v2.model.hc.Section> getSections(org.zendesk.client.v2.model.hc.Category category);
+
+Iterable<org.zendesk.client.v2.model.hc.Section> getSections(org.zendesk.client.v2.model.hc.UserSegment userSegment);
+
+org.zendesk.client.v2.model.targets.Target getTarget(long id);
+
+org.zendesk.client.v2.model.Ticket getTicket(long id);
+
+org.zendesk.client.v2.model.Audit getTicketAudit(long ticketId, long auditId);
+
+org.zendesk.client.v2.model.Audit getTicketAudit(org.zendesk.client.v2.model.Ticket ticket, long id);
+
+org.zendesk.client.v2.model.Audit getTicketAudit(org.zendesk.client.v2.model.Ticket ticket, org.zendesk.client.v2.model.Audit audit);
+
+Iterable<org.zendesk.client.v2.model.Audit> getTicketAudits(Long id);
+
+Iterable<org.zendesk.client.v2.model.Audit> getTicketAudits(org.zendesk.client.v2.model.Ticket ticket);
+
+java.util.List<org.zendesk.client.v2.model.User> getTicketCollaborators(long id);
+
+Iterable<org.zendesk.client.v2.model.Comment> getTicketComments(long id);
+
+Iterable<org.zendesk.client.v2.model.Comment> getTicketComments(long id, org.zendesk.client.v2.model.SortOrder order);
+
+org.zendesk.client.v2.model.Field getTicketField(long id);
+
+org.zendesk.client.v2.model.TicketForm getTicketForm(long id);
+
+java.util.List<org.zendesk.client.v2.model.Ticket> getTicketIncidents(long id);
+
+org.zendesk.client.v2.model.Metric getTicketMetric(long id);
+
+org.zendesk.client.v2.model.Metric getTicketMetricByTicket(long id);
+
+Iterable<org.zendesk.client.v2.model.Ticket> getTickets();
+
+java.util.List<org.zendesk.client.v2.model.Ticket> getTickets(long id, long[] ids);
+
+Iterable<org.zendesk.client.v2.model.Ticket> getTicketsByExternalId(String externalId);
+
+Iterable<org.zendesk.client.v2.model.Ticket> getTicketsByExternalId(String externalId, boolean includeArchived);
+
+Iterable<org.zendesk.client.v2.model.Ticket> getTicketsFromSearch(String searchTerm);
+
+Iterable<org.zendesk.client.v2.model.Ticket> getTicketsIncrementally(java.util.Date startTime);
+
+Iterable<org.zendesk.client.v2.model.Ticket> getTicketsIncrementally(java.util.Date startTime, java.util.Date endTime);
+
+org.zendesk.client.v2.model.Topic getTopic(long id);
+
+Iterable<org.zendesk.client.v2.model.Topic> getTopics();
+
+Iterable<org.zendesk.client.v2.model.Topic> getTopics(org.zendesk.client.v2.model.hc.UserSegment userSegment);
+
+java.util.List<org.zendesk.client.v2.model.Topic> getTopics(long forum_id);
+
+java.util.List<org.zendesk.client.v2.model.Topic> getTopics(long id, long[] ids);
+
+java.util.List<org.zendesk.client.v2.model.Topic> getTopicsByUser(long user_id);
+
+org.zendesk.client.v2.model.Trigger getTrigger(long id);
+
+org.zendesk.client.v2.model.User getUser(long id);
+
+Iterable<org.zendesk.client.v2.model.Ticket> getUserCCDTickets(long userId);
+
+java.util.List<org.zendesk.client.v2.model.Identity> getUserIdentities(long userId);
+
+java.util.List<org.zendesk.client.v2.model.Identity> getUserIdentities(org.zendesk.client.v2.model.User user);
+
+org.zendesk.client.v2.model.Identity getUserIdentity(long userId, long identityId);
+
+org.zendesk.client.v2.model.Identity getUserIdentity(org.zendesk.client.v2.model.User user, long identityId);
+
+org.zendesk.client.v2.model.Identity getUserIdentity(org.zendesk.client.v2.model.User user, org.zendesk.client.v2.model.Identity identity);
+
+org.zendesk.client.v2.model.UserRelatedInfo getUserRelatedInfo(long userId);
+
+Iterable<org.zendesk.client.v2.model.Ticket> getUserRequestedTickets(long userId);
+
+Iterable<org.zendesk.client.v2.model.Request> getUserRequests(long id);
+
+Iterable<org.zendesk.client.v2.model.Request> getUserRequests(org.zendesk.client.v2.model.User user);
+
+org.zendesk.client.v2.model.hc.UserSegment getUserSegment(long id);
+
+Iterable<org.zendesk.client.v2.model.hc.UserSegment> getUserSegments();
+
+Iterable<org.zendesk.client.v2.model.hc.UserSegment> getUserSegments(long id);
+
+Iterable<org.zendesk.client.v2.model.hc.Subscription> getUserSubscriptions(Long userId);
+
+Iterable<org.zendesk.client.v2.model.hc.Subscription> getUserSubscriptions(org.zendesk.client.v2.model.User user);
+
+Iterable<org.zendesk.client.v2.model.User> getUsersByRole(String role, String[] roles);
+
+Iterable<org.zendesk.client.v2.model.User> getUsersIncrementally(java.util.Date startTime);
+
+org.zendesk.client.v2.model.Ticket importTicket(org.zendesk.client.v2.model.TicketImport ticketImport);
+
+org.zendesk.client.v2.model.Topic importTopic(org.zendesk.client.v2.model.Topic topic);
+
+Iterable<org.zendesk.client.v2.model.Organization> lookupOrganizationsByExternalId(String externalId);
+
+Iterable<org.zendesk.client.v2.model.User> lookupUserByEmail(String email);
+
+Iterable<org.zendesk.client.v2.model.User> lookupUserByExternalId(String externalId);
+
+org.zendesk.client.v2.model.Ticket macrosShowChangesToTicket(long macroId);
+
+org.zendesk.client.v2.model.Ticket macrosShowTicketAfterChanges(long ticketId, long macroId);
+
+void makePrivateTicketAudit(long ticketId, long auditId);
+
+void makePrivateTicketAudit(org.zendesk.client.v2.model.Ticket ticket, long id);
+
+void makePrivateTicketAudit(org.zendesk.client.v2.model.Ticket ticket, org.zendesk.client.v2.model.Audit audit);
+
+void markTicketAsSpam(long id);
+
+void markTicketAsSpam(org.zendesk.client.v2.model.Ticket ticket);
+
+org.zendesk.client.v2.model.User mergeUsers(long userIdThatWillRemain, long userIdThatWillBeMerged);
+
+void notifyApp(String json);
+
+org.zendesk.client.v2.model.JobStatus permanentlyDeleteTicket(long id);
+
+org.zendesk.client.v2.model.JobStatus permanentlyDeleteTicket(org.zendesk.client.v2.model.Ticket ticket);
+
+org.zendesk.client.v2.model.JobStatus permanentlyDeleteTickets(long id, long[] ids);
+
+org.zendesk.client.v2.model.User permanentlyDeleteUser(long id);
+
+org.zendesk.client.v2.model.User permanentlyDeleteUser(org.zendesk.client.v2.model.User user);
+
+org.asynchttpclient.ListenableFuture<org.zendesk.client.v2.model.JobStatus> queueCreateTicketAsync(org.zendesk.client.v2.model.Ticket ticket);
+
+java.util.List<String> removeTagFromOrganisations(long id, String[] tags);
+
+java.util.List<String> removeTagFromTicket(long id, String[] tags);
+
+java.util.List<String> removeTagFromTopics(long id, String[] tags);
+
+org.zendesk.client.v2.model.Identity requestVerifyUserIdentity(long userId, long identityId);
+
+org.zendesk.client.v2.model.Identity requestVerifyUserIdentity(org.zendesk.client.v2.model.User user, long identityId);
+
+org.zendesk.client.v2.model.Identity requestVerifyUserIdentity(org.zendesk.client.v2.model.User user, org.zendesk.client.v2.model.Identity identity);
+
+void resetUserPassword(long id, String password);
+
+void resetUserPassword(org.zendesk.client.v2.model.User user, String password);
+
+java.util.List<org.zendesk.client.v2.model.GroupMembership> setGroupMembershipAsDefault(long user_id, org.zendesk.client.v2.model.GroupMembership groupMembership);
+
+java.util.List<org.zendesk.client.v2.model.OrganizationMembership> setOrganizationMembershipAsDefault(long user_id, org.zendesk.client.v2.model.OrganizationMembership organizationMembership);
+
+java.util.List<String> setTagOnOrganisations(long id, String[] tags);
+
+java.util.List<String> setTagOnTicket(long id, String[] tags);
+
+java.util.List<String> setTagOnTopics(long id, String[] tags);
+
+java.util.List<org.zendesk.client.v2.model.Identity> setUserPrimaryIdentity(long userId, long identityId);
+
+java.util.List<org.zendesk.client.v2.model.Identity> setUserPrimaryIdentity(org.zendesk.client.v2.model.User user, long identityId);
+
+java.util.List<org.zendesk.client.v2.model.Identity> setUserPrimaryIdentity(org.zendesk.client.v2.model.User user, org.zendesk.client.v2.model.Identity identity);
+
+org.zendesk.client.v2.model.User suspendUser(long id);
+
+void trustTicketAudit(long ticketId, long auditId);
+
+void trustTicketAudit(org.zendesk.client.v2.model.Ticket ticket, long id);
+
+void trustTicketAudit(org.zendesk.client.v2.model.Ticket ticket, org.zendesk.client.v2.model.Audit audit);
+
+org.zendesk.client.v2.model.User unsuspendUser(long id);
+
+org.zendesk.client.v2.model.hc.Article updateArticle(org.zendesk.client.v2.model.hc.Article article);
+
+org.zendesk.client.v2.model.hc.Translation updateArticleTranslation(Long articleId, String locale, org.zendesk.client.v2.model.hc.Translation translation);
+
+org.zendesk.client.v2.model.Automation updateAutomation(Long automationId, org.zendesk.client.v2.model.Automation automation);
+
+org.zendesk.client.v2.model.hc.Category updateCategory(org.zendesk.client.v2.model.hc.Category category);
+
+org.zendesk.client.v2.model.hc.Translation updateCategoryTranslation(Long categoryId, String locale, org.zendesk.client.v2.model.hc.Translation translation);
+
+org.zendesk.client.v2.model.dynamic.DynamicContentItem updateDynamicContentItem(org.zendesk.client.v2.model.dynamic.DynamicContentItem item);
+
+org.zendesk.client.v2.model.dynamic.DynamicContentItemVariant updateDynamicContentItemVariant(Long itemId, org.zendesk.client.v2.model.dynamic.DynamicContentItemVariant variant);
+
+org.zendesk.client.v2.model.Forum updateForum(org.zendesk.client.v2.model.Forum forum);
+
+org.zendesk.client.v2.model.Group updateGroup(org.zendesk.client.v2.model.Group group);
+
+void updateInstallation(int id, String json);
+
+org.zendesk.client.v2.model.Macro updateMacro(Long macroId, org.zendesk.client.v2.model.Macro macro);
+
+org.zendesk.client.v2.model.Organization updateOrganization(org.zendesk.client.v2.model.Organization organization);
+
+org.zendesk.client.v2.model.JobStatus updateOrganizations(java.util.List<org.zendesk.client.v2.model.Organization> organizations);
+
+org.zendesk.client.v2.model.JobStatus updateOrganizations(org.zendesk.client.v2.model.Organization[] organizations);
+
+org.asynchttpclient.ListenableFuture<org.zendesk.client.v2.model.JobStatus> updateOrganizationsAsync(java.util.List<org.zendesk.client.v2.model.Organization> organizations);
+
+org.zendesk.client.v2.model.hc.PermissionGroup updatePermissionGroup(org.zendesk.client.v2.model.hc.PermissionGroup permissionGroup);
+
+org.zendesk.client.v2.model.Request updateRequest(org.zendesk.client.v2.model.Request request);
+
+org.zendesk.client.v2.model.hc.Section updateSection(org.zendesk.client.v2.model.hc.Section section);
+
+org.zendesk.client.v2.model.hc.Translation updateSectionTranslation(Long sectionId, String locale, org.zendesk.client.v2.model.hc.Translation translation);
+
+org.zendesk.client.v2.model.Ticket updateTicket(org.zendesk.client.v2.model.Ticket ticket);
+
+org.zendesk.client.v2.model.Field updateTicketField(org.zendesk.client.v2.model.Field field);
+
+org.zendesk.client.v2.model.JobStatus updateTickets(java.util.List<org.zendesk.client.v2.model.Ticket> tickets);
+
+org.zendesk.client.v2.model.JobStatus updateTickets(org.zendesk.client.v2.model.Ticket[] tickets);
+
+org.asynchttpclient.ListenableFuture<org.zendesk.client.v2.model.JobStatus> updateTicketsAsync(java.util.List<org.zendesk.client.v2.model.Ticket> tickets);
+
+org.zendesk.client.v2.model.Topic updateTopic(org.zendesk.client.v2.model.Topic topic);
+
+org.zendesk.client.v2.model.Trigger updateTrigger(Long triggerId, org.zendesk.client.v2.model.Trigger trigger);
+
+org.zendesk.client.v2.model.User updateUser(org.zendesk.client.v2.model.User user);
+
+org.zendesk.client.v2.model.Identity updateUserIdentity(long userId, org.zendesk.client.v2.model.Identity identity);
+
+org.zendesk.client.v2.model.Identity updateUserIdentity(org.zendesk.client.v2.model.User user, org.zendesk.client.v2.model.Identity identity);
+
+org.zendesk.client.v2.model.hc.UserSegment updateUserSegment(org.zendesk.client.v2.model.hc.UserSegment userSegment);
+
+org.zendesk.client.v2.model.JobStatus updateUsers(java.util.List<org.zendesk.client.v2.model.User> users);
+
+org.zendesk.client.v2.model.JobStatus updateUsers(org.zendesk.client.v2.model.User[] users);
+
+org.asynchttpclient.ListenableFuture<org.zendesk.client.v2.model.JobStatus> updateUsersAsync(java.util.List<org.zendesk.client.v2.model.User> users);
+
+org.zendesk.client.v2.model.Identity verifyUserIdentity(long userId, long identityId);
+
+org.zendesk.client.v2.model.Identity verifyUserIdentity(org.zendesk.client.v2.model.User user, long identityId);
+
+org.zendesk.client.v2.model.Identity verifyUserIdentity(org.zendesk.client.v2.model.User user, org.zendesk.client.v2.model.Identity identity);
+
----
-java.util.List<String> addTagToOrganisations(long id, String[] tags)
-java.util.List<String> addTagToTicket(long id, String[] tags)
-java.util.List<String> addTagToTopics(long id, String[] tags)
-void associateAttachmentsToArticle(String idArticle, java.util.List<org.zendesk.client.v2.model.Attachment> attachments)
-void changeUserPassword(org.zendesk.client.v2.model.User user, String oldPassword, String newPassword)
-org.zendesk.client.v2.model.hc.Article createArticle(org.zendesk.client.v2.model.hc.Article article)
-org.zendesk.client.v2.model.hc.Article createArticle(org.zendesk.client.v2.model.hc.Article article, boolean notifySubscribers)
-org.zendesk.client.v2.model.hc.Translation createArticleTranslation(Long articleId, org.zendesk.client.v2.model.hc.Translation translation)
-org.zendesk.client.v2.model.Automation createAutomation(org.zendesk.client.v2.model.Automation automation)
-org.zendesk.client.v2.model.hc.Category createCategory(org.zendesk.client.v2.model.hc.Category category)
-org.zendesk.client.v2.model.hc.Translation createCategoryTranslation(Long categoryId, org.zendesk.client.v2.model.hc.Translation translation)
-org.zendesk.client.v2.model.Ticket createComment(long ticketId, org.zendesk.client.v2.model.Comment comment)
-org.zendesk.client.v2.model.dynamic.DynamicContentItem createDynamicContentItem(org.zendesk.client.v2.model.dynamic.DynamicContentItem item)
-org.zendesk.client.v2.model.dynamic.DynamicContentItemVariant createDynamicContentItemVariant(Long itemId, org.zendesk.client.v2.model.dynamic.DynamicContentItemVariant variant)
-org.zendesk.client.v2.model.Forum createForum(org.zendesk.client.v2.model.Forum forum)
-org.zendesk.client.v2.model.Group createGroup(org.zendesk.client.v2.model.Group group)
-org.zendesk.client.v2.model.GroupMembership createGroupMembership(long user_id, org.zendesk.client.v2.model.GroupMembership groupMembership)
-org.zendesk.client.v2.model.GroupMembership createGroupMembership(org.zendesk.client.v2.model.GroupMembership groupMembership)
-org.zendesk.client.v2.model.Macro createMacro(org.zendesk.client.v2.model.Macro macro)
-org.zendesk.client.v2.model.User createOrUpdateUser(org.zendesk.client.v2.model.User user)
-org.zendesk.client.v2.model.JobStatus createOrUpdateUsers(java.util.List<org.zendesk.client.v2.model.User> users)
-org.zendesk.client.v2.model.JobStatus createOrUpdateUsers(org.zendesk.client.v2.model.User[] users)
-org.asynchttpclient.ListenableFuture<org.zendesk.client.v2.model.JobStatus> createOrUpdateUsersAsync(java.util.List<org.zendesk.client.v2.model.User> users)
-org.zendesk.client.v2.model.Organization createOrganization(org.zendesk.client.v2.model.Organization organization)
-org.zendesk.client.v2.model.OrganizationMembership createOrganizationMembership(long user_id, org.zendesk.client.v2.model.OrganizationMembership organizationMembership)
-org.zendesk.client.v2.model.OrganizationMembership createOrganizationMembership(org.zendesk.client.v2.model.OrganizationMembership organizationMembership)
-org.zendesk.client.v2.model.JobStatus createOrganizationMemberships(java.util.List<org.zendesk.client.v2.model.OrganizationMembership> organizationMemberships)
-org.zendesk.client.v2.model.JobStatus createOrganizationMemberships(org.zendesk.client.v2.model.OrganizationMembership[] organizationMemberships)
-org.asynchttpclient.ListenableFuture<org.zendesk.client.v2.model.JobStatus> createOrganizationMembershipsAsync(java.util.List<org.zendesk.client.v2.model.OrganizationMembership> organizationMemberships)
-org.zendesk.client.v2.model.JobStatus createOrganizations(java.util.List<org.zendesk.client.v2.model.Organization> organizations)
-org.zendesk.client.v2.model.JobStatus createOrganizations(org.zendesk.client.v2.model.Organization[] organizations)
-org.asynchttpclient.ListenableFuture<org.zendesk.client.v2.model.JobStatus> createOrganizationsAsync(java.util.List<org.zendesk.client.v2.model.Organization> organizations)
-org.zendesk.client.v2.model.hc.PermissionGroup createPermissionGroup(org.zendesk.client.v2.model.hc.PermissionGroup permissionGroup)
-org.zendesk.client.v2.model.Request createRequest(org.zendesk.client.v2.model.Request request)
-org.zendesk.client.v2.model.SatisfactionRating createSatisfactionRating(long ticketId, org.zendesk.client.v2.model.SatisfactionRating satisfactionRating)
-org.zendesk.client.v2.model.SatisfactionRating createSatisfactionRating(org.zendesk.client.v2.model.Ticket ticket, org.zendesk.client.v2.model.SatisfactionRating satisfactionRating)
-org.zendesk.client.v2.model.hc.Section createSection(org.zendesk.client.v2.model.hc.Section section)
-org.zendesk.client.v2.model.hc.Translation createSectionTranslation(Long sectionId, org.zendesk.client.v2.model.hc.Translation translation)
-org.zendesk.client.v2.model.targets.Target createTarget(org.zendesk.client.v2.model.targets.Target target)
-org.zendesk.client.v2.model.Ticket createTicket(org.zendesk.client.v2.model.Ticket ticket)
-org.asynchttpclient.ListenableFuture<org.zendesk.client.v2.model.Ticket> createTicketAsync(org.zendesk.client.v2.model.Ticket ticket)
-org.zendesk.client.v2.model.Field createTicketField(org.zendesk.client.v2.model.Field field)
-org.zendesk.client.v2.model.TicketForm createTicketForm(org.zendesk.client.v2.model.TicketForm ticketForm)
-org.zendesk.client.v2.model.Ticket createTicketFromTweet(long tweetId, long monitorId)
-org.zendesk.client.v2.model.JobStatus createTickets(java.util.List<org.zendesk.client.v2.model.Ticket> tickets)
-org.zendesk.client.v2.model.JobStatus createTickets(org.zendesk.client.v2.model.Ticket[] tickets)
-org.asynchttpclient.ListenableFuture<org.zendesk.client.v2.model.JobStatus> createTicketsAsync(java.util.List<org.zendesk.client.v2.model.Ticket> tickets)
-org.zendesk.client.v2.model.Topic createTopic(org.zendesk.client.v2.model.Topic topic)
-org.zendesk.client.v2.model.Trigger createTrigger(org.zendesk.client.v2.model.Trigger trigger)
-org.zendesk.client.v2.model.Attachment$Upload createUpload(String fileName, String contentType, byte[] content)
-org.zendesk.client.v2.model.Attachment$Upload createUpload(String fileName, byte[] content)
-org.zendesk.client.v2.model.Attachment$Upload createUpload(String token, String fileName, String contentType, byte[] content)
-org.zendesk.client.v2.model.hc.ArticleAttachments createUploadArticle(long articleId, java.io.File file)
-org.zendesk.client.v2.model.hc.ArticleAttachments createUploadArticle(long articleId, java.io.File file, boolean inline)
-org.zendesk.client.v2.model.User createUser(org.zendesk.client.v2.model.User user)
-org.zendesk.client.v2.model.Identity createUserIdentity(long userId, org.zendesk.client.v2.model.Identity identity)
-org.zendesk.client.v2.model.Identity createUserIdentity(org.zendesk.client.v2.model.User user, org.zendesk.client.v2.model.Identity identity)
-org.zendesk.client.v2.model.hc.UserSegment createUserSegment(org.zendesk.client.v2.model.hc.UserSegment userSegment)
-org.zendesk.client.v2.model.JobStatus createUsers(java.util.List<org.zendesk.client.v2.model.User> users)
-org.zendesk.client.v2.model.JobStatus createUsers(org.zendesk.client.v2.model.User[] users)
-org.asynchttpclient.ListenableFuture<org.zendesk.client.v2.model.JobStatus> createUsersAsync(java.util.List<org.zendesk.client.v2.model.User> users)
-void deleteArticle(org.zendesk.client.v2.model.hc.Article article)
-void deleteArticleAttachment(long id)
-void deleteArticleAttachment(org.zendesk.client.v2.model.hc.ArticleAttachments attachment)
-void deleteAttachment(long id)
-void deleteAttachment(org.zendesk.client.v2.model.Attachment attachment)
-void deleteAutomation(long automationId)
-void deleteCategory(org.zendesk.client.v2.model.hc.Category category)
-void deleteDynamicContentItem(org.zendesk.client.v2.model.dynamic.DynamicContentItem item)
-void deleteDynamicContentItemVariant(Long itemId, org.zendesk.client.v2.model.dynamic.DynamicContentItemVariant variant)
-void deleteForum(org.zendesk.client.v2.model.Forum forum)
-void deleteGroup(long id)
-void deleteGroup(org.zendesk.client.v2.model.Group group)
-void deleteGroupMembership(long id)
-void deleteGroupMembership(long user_id, long group_membership_id)
-void deleteGroupMembership(long user_id, org.zendesk.client.v2.model.GroupMembership groupMembership)
-void deleteGroupMembership(org.zendesk.client.v2.model.GroupMembership groupMembership)
-void deleteOrganization(long id)
-void deleteOrganization(org.zendesk.client.v2.model.Organization organization)
-void deleteOrganizationMembership(long id)
-void deleteOrganizationMembership(long user_id, long organization_membership_id)
-void deleteOrganizationMembership(long user_id, org.zendesk.client.v2.model.OrganizationMembership organizationMembership)
-void deleteOrganizationMemberships(long id, long[] ids)
-void deletePermissionGroup(long id)
-void deletePermissionGroup(org.zendesk.client.v2.model.hc.PermissionGroup permissionGroup)
-void deleteSection(org.zendesk.client.v2.model.hc.Section section)
-void deleteSuspendedTicket(long id)
-void deleteSuspendedTicket(org.zendesk.client.v2.model.SuspendedTicket ticket)
-void deleteTarget(long targetId)
-void deleteTicket(long id)
-void deleteTicket(org.zendesk.client.v2.model.Ticket ticket)
-void deleteTicketField(long id)
-void deleteTicketField(org.zendesk.client.v2.model.Field field)
-void deleteTickets(long id, long[] ids)
-void deleteTopic(org.zendesk.client.v2.model.Topic topic)
-void deleteTranslation(Long translationId)
-void deleteTranslation(org.zendesk.client.v2.model.hc.Translation translation)
-void deleteTrigger(long triggerId)
-void deleteUpload(String token)
-void deleteUpload(org.zendesk.client.v2.model.Attachment$Upload upload)
-void deleteUser(long id)
-void deleteUser(org.zendesk.client.v2.model.User user)
-void deleteUserIdentity(long userId, long identityId)
-void deleteUserIdentity(org.zendesk.client.v2.model.User user, long identityId)
-void deleteUserIdentity(org.zendesk.client.v2.model.User user, org.zendesk.client.v2.model.Identity identity)
-void deleteUserSegment(long id)
-void deleteUserSegment(org.zendesk.client.v2.model.hc.UserSegment userSegment)
-org.zendesk.client.v2.model.hc.Article getArticle(long id)
-Iterable<org.zendesk.client.v2.model.hc.Article> getArticleFromSearch(String searchTerm)
-Iterable<org.zendesk.client.v2.model.hc.Article> getArticleFromSearch(String searchTerm, Long sectionId)
-Iterable<org.zendesk.client.v2.model.hc.Subscription> getArticleSubscriptions(Long articleId)
-Iterable<org.zendesk.client.v2.model.hc.Subscription> getArticleSubscriptions(Long articleId, String locale)
-Iterable<org.zendesk.client.v2.model.hc.Translation> getArticleTranslations(Long articleId)
-Iterable<org.zendesk.client.v2.model.hc.Article> getArticles()
-Iterable<org.zendesk.client.v2.model.hc.Article> getArticles(String locale)
-Iterable<org.zendesk.client.v2.model.hc.Article> getArticles(org.zendesk.client.v2.model.hc.Category category)
-Iterable<org.zendesk.client.v2.model.hc.Article> getArticles(org.zendesk.client.v2.model.hc.Section section)
-Iterable<org.zendesk.client.v2.model.hc.Article> getArticlesFromAllLabels(java.util.List<String> labels)
-Iterable<org.zendesk.client.v2.model.hc.Article> getArticlesFromAnyLabels(java.util.List<String> labels)
-java.util.List<org.zendesk.client.v2.model.hc.Article> getArticlesFromPage(int page)
-Iterable<org.zendesk.client.v2.model.hc.Article> getArticlesIncrementally(java.util.Date startTime)
-Iterable<org.zendesk.client.v2.model.GroupMembership> getAssignableGroupMemberships()
-java.util.List<org.zendesk.client.v2.model.GroupMembership> getAssignableGroupMemberships(long group_id)
-org.zendesk.client.v2.model.Attachment getAttachment(long id)
-org.zendesk.client.v2.model.Attachment getAttachment(org.zendesk.client.v2.model.Attachment attachment)
-java.util.List<org.zendesk.client.v2.model.hc.ArticleAttachments> getAttachmentsFromArticle(Long articleID)
-Iterable<org.zendesk.client.v2.model.Organization> getAutoCompleteOrganizations(String name)
-org.zendesk.client.v2.model.Automation getAutomation(long id)
-org.zendesk.client.v2.model.hc.Category getCategory(long id)
-Iterable<org.zendesk.client.v2.model.hc.Translation> getCategoryTranslations(Long categoryId)
-Iterable<org.zendesk.client.v2.model.ComplianceDeletionStatus> getComplianceDeletionStatuses(long userId)
-Iterable<org.zendesk.client.v2.model.DeletedTicket> getDeletedTickets()
-Iterable<org.zendesk.client.v2.model.DeletedTicket> getDeletedTickets(String sortBy, org.zendesk.client.v2.model.SortOrder sortOrder)
-org.zendesk.client.v2.model.dynamic.DynamicContentItem getDynamicContentItem(long id)
-org.zendesk.client.v2.model.dynamic.DynamicContentItemVariant getDynamicContentItemVariant(Long itemId, long id)
-Iterable<org.zendesk.client.v2.model.dynamic.DynamicContentItemVariant> getDynamicContentItemVariants(org.zendesk.client.v2.model.dynamic.DynamicContentItem item)
-org.zendesk.client.v2.model.Forum getForum(long id)
-Iterable<org.zendesk.client.v2.model.Forum> getForums()
-java.util.List<org.zendesk.client.v2.model.Forum> getForums(long category_id)
-org.zendesk.client.v2.model.Group getGroup(long id)
-org.zendesk.client.v2.model.GroupMembership getGroupMembership(long id)
-org.zendesk.client.v2.model.GroupMembership getGroupMembership(long user_id, long group_membership_id)
-java.util.List<org.zendesk.client.v2.model.GroupMembership> getGroupMembershipByUser(long user_id)
-Iterable<org.zendesk.client.v2.model.GroupMembership> getGroupMemberships()
-java.util.List<org.zendesk.client.v2.model.GroupMembership> getGroupMemberships(long group_id)
-org.zendesk.client.v2.model.OrganizationMembership getGroupOrganization(long user_id, long organization_membership_id)
-Iterable<org.zendesk.client.v2.model.User> getGroupUsers(long id)
-Iterable<org.zendesk.client.v2.model.schedules.Holiday> getHolidaysForSchedule(Long scheduleId)
-Iterable<org.zendesk.client.v2.model.schedules.Holiday> getHolidaysForSchedule(org.zendesk.client.v2.model.schedules.Schedule schedule)
-java.util.Map getIncrementalTicketsResult(long unixEpochTime)
-org.zendesk.client.v2.model.JobStatus getJobStatus(org.zendesk.client.v2.model.JobStatus status)
-org.asynchttpclient.ListenableFuture<org.zendesk.client.v2.model.JobStatus> getJobStatusAsync(org.zendesk.client.v2.model.JobStatus status)
-java.util.List<org.zendesk.client.v2.model.JobStatus> getJobStatuses(java.util.List<org.zendesk.client.v2.model.JobStatus> statuses)
-org.asynchttpclient.ListenableFuture<java.util.List<org.zendesk.client.v2.model.JobStatus>> getJobStatusesAsync(java.util.List<org.zendesk.client.v2.model.JobStatus> statuses)
-org.zendesk.client.v2.model.Macro getMacro(long macroId)
-org.zendesk.client.v2.model.Organization getOrganization(long id)
-org.zendesk.client.v2.model.OrganizationMembership getOrganizationMembership(long id)
-java.util.List<org.zendesk.client.v2.model.OrganizationMembership> getOrganizationMembershipByUser(long user_id)
-org.zendesk.client.v2.model.OrganizationMembership getOrganizationMembershipForUser(long user_id, long id)
-Iterable<org.zendesk.client.v2.model.OrganizationMembership> getOrganizationMembershipsForOrg(long organization_id)
-Iterable<org.zendesk.client.v2.model.OrganizationMembership> getOrganizationMembershipsForUser(long user_id)
-Iterable<org.zendesk.client.v2.model.Ticket> getOrganizationTickets(long organizationId)
-Iterable<org.zendesk.client.v2.model.User> getOrganizationUsers(long id)
-Iterable<org.zendesk.client.v2.model.Organization> getOrganizationsIncrementally(java.util.Date startTime)
-org.zendesk.client.v2.model.hc.PermissionGroup getPermissionGroup(long id)
-org.zendesk.client.v2.model.Request getRequest(long id)
-org.zendesk.client.v2.model.Comment getRequestComment(long requestId, long commentId)
-org.zendesk.client.v2.model.Comment getRequestComment(org.zendesk.client.v2.model.Request request, long commentId)
-org.zendesk.client.v2.model.Comment getRequestComment(org.zendesk.client.v2.model.Request request, org.zendesk.client.v2.model.Comment comment)
-Iterable<org.zendesk.client.v2.model.Comment> getRequestComments(long id)
-Iterable<org.zendesk.client.v2.model.Comment> getRequestComments(org.zendesk.client.v2.model.Request request)
-org.zendesk.client.v2.model.SatisfactionRating getSatisfactionRating(long id)
-org.zendesk.client.v2.model.schedules.Schedule getSchedule(Long scheduleId)
-org.zendesk.client.v2.model.schedules.Schedule getSchedule(org.zendesk.client.v2.model.schedules.Schedule schedule)
-Iterable<org.zendesk.client.v2.model.SearchResultEntity> getSearchResults(Class<org.zendesk.client.v2.model.SearchResultEntity> type, String query)
-Iterable<org.zendesk.client.v2.model.SearchResultEntity> getSearchResults(Class<org.zendesk.client.v2.model.SearchResultEntity> type, String query, String params)
-Iterable<org.zendesk.client.v2.model.SearchResultEntity> getSearchResults(Class<org.zendesk.client.v2.model.SearchResultEntity> type, String query, String sortBy, org.zendesk.client.v2.model.SortOrder sortOrder)
-Iterable<org.zendesk.client.v2.model.SearchResultEntity> getSearchResults(Class<org.zendesk.client.v2.model.SearchResultEntity> type, String query, java.util.Map<String, Object> params)
-Iterable<org.zendesk.client.v2.model.SearchResultEntity> getSearchResults(String query)
-org.zendesk.client.v2.model.hc.Section getSection(long id)
-Iterable<org.zendesk.client.v2.model.hc.Subscription> getSectionSubscriptions(Long sectionId)
-Iterable<org.zendesk.client.v2.model.hc.Subscription> getSectionSubscriptions(Long sectionId, String locale)
-Iterable<org.zendesk.client.v2.model.hc.Translation> getSectionTranslations(Long sectionId)
-Iterable<org.zendesk.client.v2.model.hc.Section> getSections()
-Iterable<org.zendesk.client.v2.model.hc.Section> getSections(org.zendesk.client.v2.model.hc.Category category)
-Iterable<org.zendesk.client.v2.model.hc.Section> getSections(org.zendesk.client.v2.model.hc.UserSegment userSegment)
-org.zendesk.client.v2.model.targets.Target getTarget(long id)
-org.zendesk.client.v2.model.Ticket getTicket(long id)
-org.zendesk.client.v2.model.Audit getTicketAudit(long ticketId, long auditId)
-org.zendesk.client.v2.model.Audit getTicketAudit(org.zendesk.client.v2.model.Ticket ticket, long id)
-org.zendesk.client.v2.model.Audit getTicketAudit(org.zendesk.client.v2.model.Ticket ticket, org.zendesk.client.v2.model.Audit audit)
-Iterable<org.zendesk.client.v2.model.Audit> getTicketAudits(Long id)
-Iterable<org.zendesk.client.v2.model.Audit> getTicketAudits(org.zendesk.client.v2.model.Ticket ticket)
-java.util.List<org.zendesk.client.v2.model.User> getTicketCollaborators(long id)
-Iterable<org.zendesk.client.v2.model.Comment> getTicketComments(long id)
-Iterable<org.zendesk.client.v2.model.Comment> getTicketComments(long id, org.zendesk.client.v2.model.SortOrder order)
-org.zendesk.client.v2.model.Field getTicketField(long id)
-org.zendesk.client.v2.model.TicketForm getTicketForm(long id)
-java.util.List<org.zendesk.client.v2.model.Ticket> getTicketIncidents(long id)
-org.zendesk.client.v2.model.Metric getTicketMetric(long id)
-org.zendesk.client.v2.model.Metric getTicketMetricByTicket(long id)
-Iterable<org.zendesk.client.v2.model.Ticket> getTickets()
-java.util.List<org.zendesk.client.v2.model.Ticket> getTickets(long id, long[] ids)
-Iterable<org.zendesk.client.v2.model.Ticket> getTicketsByExternalId(String externalId)
-Iterable<org.zendesk.client.v2.model.Ticket> getTicketsByExternalId(String externalId, boolean includeArchived)
-Iterable<org.zendesk.client.v2.model.Ticket> getTicketsFromSearch(String searchTerm)
-Iterable<org.zendesk.client.v2.model.Ticket> getTicketsIncrementally(java.util.Date startTime)
-Iterable<org.zendesk.client.v2.model.Ticket> getTicketsIncrementally(java.util.Date startTime, java.util.Date endTime)
-org.zendesk.client.v2.model.Topic getTopic(long id)
-Iterable<org.zendesk.client.v2.model.Topic> getTopics()
-Iterable<org.zendesk.client.v2.model.Topic> getTopics(org.zendesk.client.v2.model.hc.UserSegment userSegment)
-java.util.List<org.zendesk.client.v2.model.Topic> getTopics(long forum_id)
-java.util.List<org.zendesk.client.v2.model.Topic> getTopics(long id, long[] ids)
-java.util.List<org.zendesk.client.v2.model.Topic> getTopicsByUser(long user_id)
-org.zendesk.client.v2.model.Trigger getTrigger(long id)
-org.zendesk.client.v2.model.User getUser(long id)
-Iterable<org.zendesk.client.v2.model.Ticket> getUserCCDTickets(long userId)
-java.util.List<org.zendesk.client.v2.model.Identity> getUserIdentities(long userId)
-java.util.List<org.zendesk.client.v2.model.Identity> getUserIdentities(org.zendesk.client.v2.model.User user)
-org.zendesk.client.v2.model.Identity getUserIdentity(long userId, long identityId)
-org.zendesk.client.v2.model.Identity getUserIdentity(org.zendesk.client.v2.model.User user, long identityId)
-org.zendesk.client.v2.model.Identity getUserIdentity(org.zendesk.client.v2.model.User user, org.zendesk.client.v2.model.Identity identity)
-org.zendesk.client.v2.model.UserRelatedInfo getUserRelatedInfo(long userId)
-Iterable<org.zendesk.client.v2.model.Ticket> getUserRequestedTickets(long userId)
-Iterable<org.zendesk.client.v2.model.Request> getUserRequests(long id)
-Iterable<org.zendesk.client.v2.model.Request> getUserRequests(org.zendesk.client.v2.model.User user)
-org.zendesk.client.v2.model.hc.UserSegment getUserSegment(long id)
-Iterable<org.zendesk.client.v2.model.hc.UserSegment> getUserSegments()
-Iterable<org.zendesk.client.v2.model.hc.UserSegment> getUserSegments(long id)
-Iterable<org.zendesk.client.v2.model.hc.Subscription> getUserSubscriptions(Long userId)
-Iterable<org.zendesk.client.v2.model.hc.Subscription> getUserSubscriptions(org.zendesk.client.v2.model.User user)
-Iterable<org.zendesk.client.v2.model.User> getUsersByRole(String role, String[] roles)
-Iterable<org.zendesk.client.v2.model.User> getUsersIncrementally(java.util.Date startTime)
-org.zendesk.client.v2.model.Ticket importTicket(org.zendesk.client.v2.model.TicketImport ticketImport)
-org.zendesk.client.v2.model.Topic importTopic(org.zendesk.client.v2.model.Topic topic)
-Iterable<org.zendesk.client.v2.model.Organization> lookupOrganizationsByExternalId(String externalId)
-Iterable<org.zendesk.client.v2.model.User> lookupUserByEmail(String email)
-Iterable<org.zendesk.client.v2.model.User> lookupUserByExternalId(String externalId)
-org.zendesk.client.v2.model.Ticket macrosShowChangesToTicket(long macroId)
-org.zendesk.client.v2.model.Ticket macrosShowTicketAfterChanges(long ticketId, long macroId)
-void makePrivateTicketAudit(long ticketId, long auditId)
-void makePrivateTicketAudit(org.zendesk.client.v2.model.Ticket ticket, long id)
-void makePrivateTicketAudit(org.zendesk.client.v2.model.Ticket ticket, org.zendesk.client.v2.model.Audit audit)
-void markTicketAsSpam(long id)
-void markTicketAsSpam(org.zendesk.client.v2.model.Ticket ticket)
-org.zendesk.client.v2.model.User mergeUsers(long userIdThatWillRemain, long userIdThatWillBeMerged)
-void notifyApp(String json)
-org.zendesk.client.v2.model.JobStatus permanentlyDeleteTicket(long id)
-org.zendesk.client.v2.model.JobStatus permanentlyDeleteTicket(org.zendesk.client.v2.model.Ticket ticket)
-org.zendesk.client.v2.model.JobStatus permanentlyDeleteTickets(long id, long[] ids)
-org.zendesk.client.v2.model.User permanentlyDeleteUser(long id)
-org.zendesk.client.v2.model.User permanentlyDeleteUser(org.zendesk.client.v2.model.User user)
-org.asynchttpclient.ListenableFuture<org.zendesk.client.v2.model.JobStatus> queueCreateTicketAsync(org.zendesk.client.v2.model.Ticket ticket)
-java.util.List<String> removeTagFromOrganisations(long id, String[] tags)
-java.util.List<String> removeTagFromTicket(long id, String[] tags)
-java.util.List<String> removeTagFromTopics(long id, String[] tags)
-org.zendesk.client.v2.model.Identity requestVerifyUserIdentity(long userId, long identityId)
-org.zendesk.client.v2.model.Identity requestVerifyUserIdentity(org.zendesk.client.v2.model.User user, long identityId)
-org.zendesk.client.v2.model.Identity requestVerifyUserIdentity(org.zendesk.client.v2.model.User user, org.zendesk.client.v2.model.Identity identity)
-void resetUserPassword(long id, String password)
-void resetUserPassword(org.zendesk.client.v2.model.User user, String password)
-java.util.List<org.zendesk.client.v2.model.GroupMembership> setGroupMembershipAsDefault(long user_id, org.zendesk.client.v2.model.GroupMembership groupMembership)
-java.util.List<org.zendesk.client.v2.model.OrganizationMembership> setOrganizationMembershipAsDefault(long user_id, org.zendesk.client.v2.model.OrganizationMembership organizationMembership)
-java.util.List<String> setTagOnOrganisations(long id, String[] tags)
-java.util.List<String> setTagOnTicket(long id, String[] tags)
-java.util.List<String> setTagOnTopics(long id, String[] tags)
-java.util.List<org.zendesk.client.v2.model.Identity> setUserPrimaryIdentity(long userId, long identityId)
-java.util.List<org.zendesk.client.v2.model.Identity> setUserPrimaryIdentity(org.zendesk.client.v2.model.User user, long identityId)
-java.util.List<org.zendesk.client.v2.model.Identity> setUserPrimaryIdentity(org.zendesk.client.v2.model.User user, org.zendesk.client.v2.model.Identity identity)
-org.zendesk.client.v2.model.User suspendUser(long id)
-void trustTicketAudit(long ticketId, long auditId)
-void trustTicketAudit(org.zendesk.client.v2.model.Ticket ticket, long id)
-void trustTicketAudit(org.zendesk.client.v2.model.Ticket ticket, org.zendesk.client.v2.model.Audit audit)
-org.zendesk.client.v2.model.User unsuspendUser(long id)
-org.zendesk.client.v2.model.hc.Article updateArticle(org.zendesk.client.v2.model.hc.Article article)
-org.zendesk.client.v2.model.hc.Translation updateArticleTranslation(Long articleId, String locale, org.zendesk.client.v2.model.hc.Translation translation)
-org.zendesk.client.v2.model.Automation updateAutomation(Long automationId, org.zendesk.client.v2.model.Automation automation)
-org.zendesk.client.v2.model.hc.Category updateCategory(org.zendesk.client.v2.model.hc.Category category)
-org.zendesk.client.v2.model.hc.Translation updateCategoryTranslation(Long categoryId, String locale, org.zendesk.client.v2.model.hc.Translation translation)
-org.zendesk.client.v2.model.dynamic.DynamicContentItem updateDynamicContentItem(org.zendesk.client.v2.model.dynamic.DynamicContentItem item)
-org.zendesk.client.v2.model.dynamic.DynamicContentItemVariant updateDynamicContentItemVariant(Long itemId, org.zendesk.client.v2.model.dynamic.DynamicContentItemVariant variant)
-org.zendesk.client.v2.model.Forum updateForum(org.zendesk.client.v2.model.Forum forum)
-org.zendesk.client.v2.model.Group updateGroup(org.zendesk.client.v2.model.Group group)
-void updateInstallation(int id, String json)
-org.zendesk.client.v2.model.Macro updateMacro(Long macroId, org.zendesk.client.v2.model.Macro macro)
-org.zendesk.client.v2.model.Organization updateOrganization(org.zendesk.client.v2.model.Organization organization)
-org.zendesk.client.v2.model.JobStatus updateOrganizations(java.util.List<org.zendesk.client.v2.model.Organization> organizations)
-org.zendesk.client.v2.model.JobStatus updateOrganizations(org.zendesk.client.v2.model.Organization[] organizations)
-org.asynchttpclient.ListenableFuture<org.zendesk.client.v2.model.JobStatus> updateOrganizationsAsync(java.util.List<org.zendesk.client.v2.model.Organization> organizations)
-org.zendesk.client.v2.model.hc.PermissionGroup updatePermissionGroup(org.zendesk.client.v2.model.hc.PermissionGroup permissionGroup)
-org.zendesk.client.v2.model.Request updateRequest(org.zendesk.client.v2.model.Request request)
-org.zendesk.client.v2.model.hc.Section updateSection(org.zendesk.client.v2.model.hc.Section section)
-org.zendesk.client.v2.model.hc.Translation updateSectionTranslation(Long sectionId, String locale, org.zendesk.client.v2.model.hc.Translation translation)
-org.zendesk.client.v2.model.Ticket updateTicket(org.zendesk.client.v2.model.Ticket ticket)
-org.zendesk.client.v2.model.Field updateTicketField(org.zendesk.client.v2.model.Field field)
-org.zendesk.client.v2.model.JobStatus updateTickets(java.util.List<org.zendesk.client.v2.model.Ticket> tickets)
-org.zendesk.client.v2.model.JobStatus updateTickets(org.zendesk.client.v2.model.Ticket[] tickets)
-org.asynchttpclient.ListenableFuture<org.zendesk.client.v2.model.JobStatus> updateTicketsAsync(java.util.List<org.zendesk.client.v2.model.Ticket> tickets)
-org.zendesk.client.v2.model.Topic updateTopic(org.zendesk.client.v2.model.Topic topic)
-org.zendesk.client.v2.model.Trigger updateTrigger(Long triggerId, org.zendesk.client.v2.model.Trigger trigger)
-org.zendesk.client.v2.model.User updateUser(org.zendesk.client.v2.model.User user)
-org.zendesk.client.v2.model.Identity updateUserIdentity(long userId, org.zendesk.client.v2.model.Identity identity)
-org.zendesk.client.v2.model.Identity updateUserIdentity(org.zendesk.client.v2.model.User user, org.zendesk.client.v2.model.Identity identity)
-org.zendesk.client.v2.model.hc.UserSegment updateUserSegment(org.zendesk.client.v2.model.hc.UserSegment userSegment)
-org.zendesk.client.v2.model.JobStatus updateUsers(java.util.List<org.zendesk.client.v2.model.User> users)
-org.zendesk.client.v2.model.JobStatus updateUsers(org.zendesk.client.v2.model.User[] users)
-org.asynchttpclient.ListenableFuture<org.zendesk.client.v2.model.JobStatus> updateUsersAsync(java.util.List<org.zendesk.client.v2.model.User> users)
-org.zendesk.client.v2.model.Identity verifyUserIdentity(long userId, long identityId)
-org.zendesk.client.v2.model.Identity verifyUserIdentity(org.zendesk.client.v2.model.User user, long identityId)
-org.zendesk.client.v2.model.Identity verifyUserIdentity(org.zendesk.client.v2.model.User user, org.zendesk.client.v2.model.Identity identity)
+The DEFAULT API is defined in the syntax as follows:
+
+----
+zendesk:DEFAULT/methodName?[parameters]
----
... 249 lines suppressed ...