docs: update return type in jsdoc for Buffers (#366)

googleapis · Jun 12, 2019 · 6bffff4 · 6bffff4
1 parent 3323bfb
commit 6bffff4
Show file tree

Hide file tree

Showing 12 changed files with 28 additions and 28 deletions.
diff --git a/packages/google-cloud-dialogflow/src/v2/agents_client.js b/packages/google-cloud-dialogflow/src/v2/agents_client.js
@@ -734,7 +734,7 @@ class AgentsClient {
    * @param {string} [request.agentUri]
    *   The URI to a Google Cloud Storage file containing the agent to import.
    *   Note: The URI must start with "gs://".
-   * @param {string} [request.agentContent]
+   * @param {Buffer} [request.agentContent]
    *   The agent to import.
    *
    *   Example for how to import an agent via the command line:
@@ -855,7 +855,7 @@ class AgentsClient {
    * @param {string} [request.agentUri]
    *   The URI to a Google Cloud Storage file containing the agent to restore.
    *   Note: The URI must start with "gs://".
-   * @param {string} [request.agentContent]
+   * @param {Buffer} [request.agentContent]
    *   The agent to restore.
    *
    *   Example for how to restore an agent via the command line:

diff --git a/packages/google-cloud-dialogflow/src/v2/doc/google/cloud/dialogflow/v2/doc_agent.js b/packages/google-cloud-dialogflow/src/v2/doc/google/cloud/dialogflow/v2/doc_agent.js
@@ -205,7 +205,7 @@ const ExportAgentRequest = {
  *   The URI to a file containing the exported agent. This field is populated
  *   only if `agent_uri` is specified in `ExportAgentRequest`.
  *
- * @property {string} agentContent
+ * @property {Buffer} agentContent
  *   The exported agent.
  *
  *   Example for how to export an agent to a zip file via a command line:
@@ -240,7 +240,7 @@ const ExportAgentResponse = {
  *   The URI to a Google Cloud Storage file containing the agent to import.
  *   Note: The URI must start with "gs://".
  *
- * @property {string} agentContent
+ * @property {Buffer} agentContent
  *   The agent to import.
  *
  *   Example for how to import an agent via the command line:
@@ -275,7 +275,7 @@ const ImportAgentRequest = {
  *   The URI to a Google Cloud Storage file containing the agent to restore.
  *   Note: The URI must start with "gs://".
  *
- * @property {string} agentContent
+ * @property {Buffer} agentContent
  *   The agent to restore.
  *
  *   Example for how to restore an agent via the command line:

diff --git a/packages/google-cloud-dialogflow/src/v2/doc/google/cloud/dialogflow/v2/doc_session.js b/packages/google-cloud-dialogflow/src/v2/doc/google/cloud/dialogflow/v2/doc_session.js
@@ -49,7 +49,7 @@
  *
  *   This object should have the same structure as [OutputAudioConfig]{@link google.cloud.dialogflow.v2.OutputAudioConfig}
  *
- * @property {string} inputAudio
+ * @property {Buffer} inputAudio
  *   Optional. The natural language speech audio to be processed. This field
  *   should be populated iff `query_input` is set to an input audio config.
  *   A single request can contain up to 1 minute of speech audio data.
@@ -80,7 +80,7 @@ const DetectIntentRequest = {
  *
  *   This object should have the same structure as [Status]{@link google.rpc.Status}
  *
- * @property {string} outputAudio
+ * @property {Buffer} outputAudio
  *   The audio data bytes encoded as specified in the request.
  *   Note: The output audio is generated based on the values of default platform
  *   text responses found in the `query_result.fulfillment_messages` field. If
@@ -348,7 +348,7 @@ const QueryResult = {
  *
  *   This object should have the same structure as [OutputAudioConfig]{@link google.cloud.dialogflow.v2.OutputAudioConfig}
  *
- * @property {string} inputAudio
+ * @property {Buffer} inputAudio
  *   Optional. The input audio content to be recognized. Must be sent if
  *   `query_input` was set to a streaming input audio config. The complete audio
  *   over all streaming messages must not exceed 1 minute.
@@ -394,7 +394,7 @@ const StreamingDetectIntentRequest = {
  *
  *   This object should have the same structure as [Status]{@link google.rpc.Status}
  *
- * @property {string} outputAudio
+ * @property {Buffer} outputAudio
  *   The audio data bytes encoded as specified in the request.
  *
  * @property {Object} outputAudioConfig

diff --git a/packages/google-cloud-dialogflow/src/v2/doc/google/protobuf/doc_any.js b/packages/google-cloud-dialogflow/src/v2/doc/google/protobuf/doc_any.js
@@ -125,7 +125,7 @@
  *   Schemes other than `http`, `https` (or the empty scheme) might be
  *   used with implementation specific semantics.
  *
- * @property {string} value
+ * @property {Buffer} value
  *   Must be a valid serialized protocol buffer of the above specified type.
  *
  * @typedef Any

diff --git a/packages/google-cloud-dialogflow/src/v2/sessions_client.js b/packages/google-cloud-dialogflow/src/v2/sessions_client.js
@@ -239,7 +239,7 @@ class SessionsClient {
    *   configured, no output audio is generated.
    *
    *   This object should have the same structure as [OutputAudioConfig]{@link google.cloud.dialogflow.v2.OutputAudioConfig}
-   * @param {string} [request.inputAudio]
+   * @param {Buffer} [request.inputAudio]
    *   Optional. The natural language speech audio to be processed. This field
    *   should be populated iff `query_input` is set to an input audio config.
    *   A single request can contain up to 1 minute of speech audio data.

diff --git a/packages/google-cloud-dialogflow/src/v2beta1/agents_client.js b/packages/google-cloud-dialogflow/src/v2beta1/agents_client.js
@@ -737,7 +737,7 @@ class AgentsClient {
    * @param {string} [request.agentUri]
    *   The URI to a Google Cloud Storage file containing the agent to import.
    *   Note: The URI must start with "gs://".
-   * @param {string} [request.agentContent]
+   * @param {Buffer} [request.agentContent]
    *   The agent to import.
    *
    *   Example for how to import an agent via the command line:
@@ -859,7 +859,7 @@ class AgentsClient {
    * @param {string} [request.agentUri]
    *   The URI to a Google Cloud Storage file containing the agent to restore.
    *   Note: The URI must start with "gs://".
-   * @param {string} [request.agentContent]
+   * @param {Buffer} [request.agentContent]
    *   The agent to restore.
    *
    *   Example for how to restore an agent via the command line:

diff --git a/...ages/google-cloud-dialogflow/src/v2beta1/doc/google/cloud/dialogflow/v2beta1/doc_agent.js b/...ages/google-cloud-dialogflow/src/v2beta1/doc/google/cloud/dialogflow/v2beta1/doc_agent.js
@@ -205,7 +205,7 @@ const ExportAgentRequest = {
  *   The URI to a file containing the exported agent. This field is populated
  *   only if `agent_uri` is specified in `ExportAgentRequest`.
  *
- * @property {string} agentContent
+ * @property {Buffer} agentContent
  *   The exported agent.
  *
  *   Example for how to export an agent to a zip file via a command line:
@@ -240,7 +240,7 @@ const ExportAgentResponse = {
  *   The URI to a Google Cloud Storage file containing the agent to import.
  *   Note: The URI must start with "gs://".
  *
- * @property {string} agentContent
+ * @property {Buffer} agentContent
  *   The agent to import.
  *
  *   Example for how to import an agent via the command line:
@@ -275,7 +275,7 @@ const ImportAgentRequest = {
  *   The URI to a Google Cloud Storage file containing the agent to restore.
  *   Note: The URI must start with "gs://".
  *
- * @property {string} agentContent
+ * @property {Buffer} agentContent
  *   The agent to restore.
  *
  *   Example for how to restore an agent via the command line:

diff --git a/...s/google-cloud-dialogflow/src/v2beta1/doc/google/cloud/dialogflow/v2beta1/doc_document.js b/...s/google-cloud-dialogflow/src/v2beta1/doc/google/cloud/dialogflow/v2beta1/doc_document.js
@@ -56,7 +56,7 @@
  *   Note: This field is in the process of being deprecated, please use
  *   raw_content instead.
  *
- * @property {string} rawContent
+ * @property {Buffer} rawContent
  *   The raw content of the document. This field is only permitted for
  *   EXTRACTIVE_QA and FAQ knowledge types.
  *

diff --git a/...es/google-cloud-dialogflow/src/v2beta1/doc/google/cloud/dialogflow/v2beta1/doc_session.js b/...es/google-cloud-dialogflow/src/v2beta1/doc/google/cloud/dialogflow/v2beta1/doc_session.js
@@ -53,7 +53,7 @@
  *
  *   This object should have the same structure as [OutputAudioConfig]{@link google.cloud.dialogflow.v2beta1.OutputAudioConfig}
  *
- * @property {string} inputAudio
+ * @property {Buffer} inputAudio
  *   Optional. The natural language speech audio to be processed. This field
  *   should be populated iff `query_input` is set to an input audio config.
  *   A single request can contain up to 1 minute of speech audio data.
@@ -96,7 +96,7 @@ const DetectIntentRequest = {
  *
  *   This object should have the same structure as [Status]{@link google.rpc.Status}
  *
- * @property {string} outputAudio
+ * @property {Buffer} outputAudio
  *   The audio data bytes encoded as specified in the request.
  *   Note: The output audio is generated based on the values of default platform
  *   text responses found in the `query_result.fulfillment_messages` field. If
@@ -475,7 +475,7 @@ const KnowledgeAnswers = {
  *
  *   This object should have the same structure as [OutputAudioConfig]{@link google.cloud.dialogflow.v2beta1.OutputAudioConfig}
  *
- * @property {string} inputAudio
+ * @property {Buffer} inputAudio
  *   Optional. The input audio content to be recognized. Must be sent if
  *   `query_input` was set to a streaming input audio config. The complete audio
  *   over all streaming messages must not exceed 1 minute.
@@ -539,7 +539,7 @@ const StreamingDetectIntentRequest = {
  *
  *   This object should have the same structure as [Status]{@link google.rpc.Status}
  *
- * @property {string} outputAudio
+ * @property {Buffer} outputAudio
  *   The audio data bytes encoded as specified in the request.
  *
  * @property {Object} outputAudioConfig

diff --git a/packages/google-cloud-dialogflow/src/v2beta1/doc/google/protobuf/doc_any.js b/packages/google-cloud-dialogflow/src/v2beta1/doc/google/protobuf/doc_any.js
@@ -125,7 +125,7 @@
  *   Schemes other than `http`, `https` (or the empty scheme) might be
  *   used with implementation specific semantics.
  *
- * @property {string} value
+ * @property {Buffer} value
  *   Must be a valid serialized protocol buffer of the above specified type.
  *
  * @typedef Any

diff --git a/packages/google-cloud-dialogflow/src/v2beta1/sessions_client.js b/packages/google-cloud-dialogflow/src/v2beta1/sessions_client.js
@@ -246,7 +246,7 @@ class SessionsClient {
    *   configured, no output audio is generated.
    *
    *   This object should have the same structure as [OutputAudioConfig]{@link google.cloud.dialogflow.v2beta1.OutputAudioConfig}
-   * @param {string} [request.inputAudio]
+   * @param {Buffer} [request.inputAudio]
    *   Optional. The natural language speech audio to be processed. This field
    *   should be populated iff `query_input` is set to an input audio config.
    *   A single request can contain up to 1 minute of speech audio data.

diff --git a/packages/google-cloud-dialogflow/synth.metadata b/packages/google-cloud-dialogflow/synth.metadata
@@ -1,19 +1,19 @@
 {
-  "updateTime": "2019-06-07T11:12:31.751887Z",
+  "updateTime": "2019-06-12T11:13:55.775624Z",
   "sources": [
     {
       "generator": {
         "name": "artman",
-        "version": "0.23.1",
-        "dockerImage": "googleapis/artman@sha256:9d5cae1454da64ac3a87028f8ef486b04889e351c83bb95e83b8fab3959faed0"
+        "version": "0.24.1",
+        "dockerImage": "googleapis/artman@sha256:6018498e15310260dc9b03c9d576608908ed9fbabe42e1494ff3d827fea27b19"
       }
     },
     {
       "git": {
         "name": "googleapis",
         "remote": "https://github.com/googleapis/googleapis.git",
-        "sha": "15fdbe57306e3a56069af5e2595e9b1bb33b6123",
-        "internalRef": "251960694"
+        "sha": "f117dac435e96ebe58d85280a3faf2350c4d4219",
+        "internalRef": "252714985"
       }
     },
     {