Skip to content

Commit

Permalink
feat(ideahub): update the api
Browse files Browse the repository at this point in the history
#### ideahub:v1alpha

The following keys were added:
- resources.platforms.resources.properties.resources.topicStates.methods.patch (Total Keys: 14)
- schemas.GoogleSearchIdeahubV1alphaTopicState (Total Keys: 5)
  • Loading branch information
yoshi-automation committed Jun 29, 2021
1 parent cec376d commit 73b86d9
Show file tree
Hide file tree
Showing 5 changed files with 184 additions and 5 deletions.
2 changes: 1 addition & 1 deletion docs/dyn/ideahub_v1alpha.ideas.html
Original file line number Diff line number Diff line change
Expand Up @@ -100,7 +100,7 @@ <h3>Method Details</h3>
BLOGGER -
SITEKIT -
creator_platformId: string, Identifies the platform account (blog/site/etc.) for which to fetch Ideas.
filter: string, Filter semantics described below.
filter: string, Allows filtering. Supported syntax: * Filter expressions are made up of one or more restrictions. * Restrictions are implicitly combined, as if the `AND` operator was always used. The `OR` operator is currently unsupported. * Supported functions: - `saved(bool)`: If set to true, fetches only saved ideas. If set to false, fetches all except saved ideas. Can&#x27;t be simultaneously used with `dismissed(bool)`. - `dismissed(bool)`: If set to true, fetches only dismissed ideas. Can&#x27;t be simultaneously used with `saved(bool)`. The `false` value is currently unsupported. Examples: * `saved(true)` * `saved(false)` * `dismissed(true)` The length of this field should be no more than 500 characters.
orderBy: string, Order semantics described below.
pageSize: integer, The maximum number of ideas per page. If unspecified, at most 10 ideas will be returned. The maximum value is 2000; values above 2000 will be coerced to 2000.
pageToken: string, Used to fetch next page.
Expand Down
5 changes: 5 additions & 0 deletions docs/dyn/ideahub_v1alpha.platforms.properties.html
Original file line number Diff line number Diff line change
Expand Up @@ -89,6 +89,11 @@ <h2>Instance Methods</h2>
</p>
<p class="firstline">Returns the locales Resource.</p>

<p class="toc_element">
<code><a href="ideahub_v1alpha.platforms.properties.topicStates.html">topicStates()</a></code>
</p>
<p class="firstline">Returns the topicStates Resource.</p>

<p class="toc_element">
<code><a href="#close">close()</a></code></p>
<p class="firstline">Close httplib2 connections.</p>
Expand Down
2 changes: 1 addition & 1 deletion docs/dyn/ideahub_v1alpha.platforms.properties.ideas.html
Original file line number Diff line number Diff line change
Expand Up @@ -101,7 +101,7 @@ <h3>Method Details</h3>
BLOGGER -
SITEKIT -
creator_platformId: string, Identifies the platform account (blog/site/etc.) for which to fetch Ideas.
filter: string, Filter semantics described below.
filter: string, Allows filtering. Supported syntax: * Filter expressions are made up of one or more restrictions. * Restrictions are implicitly combined, as if the `AND` operator was always used. The `OR` operator is currently unsupported. * Supported functions: - `saved(bool)`: If set to true, fetches only saved ideas. If set to false, fetches all except saved ideas. Can&#x27;t be simultaneously used with `dismissed(bool)`. - `dismissed(bool)`: If set to true, fetches only dismissed ideas. Can&#x27;t be simultaneously used with `saved(bool)`. The `false` value is currently unsupported. Examples: * `saved(true)` * `saved(false)` * `dismissed(true)` The length of this field should be no more than 500 characters.
orderBy: string, Order semantics described below.
pageSize: integer, The maximum number of ideas per page. If unspecified, at most 10 ideas will be returned. The maximum value is 2000; values above 2000 will be coerced to 2000.
pageToken: string, Used to fetch next page.
Expand Down
120 changes: 120 additions & 0 deletions docs/dyn/ideahub_v1alpha.platforms.properties.topicStates.html
Original file line number Diff line number Diff line change
@@ -0,0 +1,120 @@
<html><body>
<style>

body, h1, h2, h3, div, span, p, pre, a {
margin: 0;
padding: 0;
border: 0;
font-weight: inherit;
font-style: inherit;
font-size: 100%;
font-family: inherit;
vertical-align: baseline;
}

body {
font-size: 13px;
padding: 1em;
}

h1 {
font-size: 26px;
margin-bottom: 1em;
}

h2 {
font-size: 24px;
margin-bottom: 1em;
}

h3 {
font-size: 20px;
margin-bottom: 1em;
margin-top: 1em;
}

pre, code {
line-height: 1.5;
font-family: Monaco, 'DejaVu Sans Mono', 'Bitstream Vera Sans Mono', 'Lucida Console', monospace;
}

pre {
margin-top: 0.5em;
}

h1, h2, h3, p {
font-family: Arial, sans serif;
}

h1, h2, h3 {
border-bottom: solid #CCC 1px;
}

.toc_element {
margin-top: 0.5em;
}

.firstline {
margin-left: 2 em;
}

.method {
margin-top: 1em;
border: solid 1px #CCC;
padding: 1em;
background: #EEE;
}

.details {
font-weight: bold;
font-size: 14px;
}

</style>

<h1><a href="ideahub_v1alpha.html">Idea Hub API</a> . <a href="ideahub_v1alpha.platforms.html">platforms</a> . <a href="ideahub_v1alpha.platforms.properties.html">properties</a> . <a href="ideahub_v1alpha.platforms.properties.topicStates.html">topicStates</a></h1>
<h2>Instance Methods</h2>
<p class="toc_element">
<code><a href="#close">close()</a></code></p>
<p class="firstline">Close httplib2 connections.</p>
<p class="toc_element">
<code><a href="#patch">patch(name, body=None, updateMask=None, x__xgafv=None)</a></code></p>
<p class="firstline">Update a topic state resource.</p>
<h3>Method Details</h3>
<div class="method">
<code class="details" id="close">close()</code>
<pre>Close httplib2 connections.</pre>
</div>

<div class="method">
<code class="details" id="patch">patch(name, body=None, updateMask=None, x__xgafv=None)</code>
<pre>Update a topic state resource.

Args:
name: string, Unique identifier for the topic state. Format: platforms/{platform}/properties/{property}/topicStates/{topic_state} (required)
body: object, The request body.
The object takes the form of:

{ # Represents topic state specific to a web property.
&quot;dismissed&quot;: True or False, # Whether the topic is dismissed.
&quot;name&quot;: &quot;A String&quot;, # Unique identifier for the topic state. Format: platforms/{platform}/properties/{property}/topicStates/{topic_state}
&quot;saved&quot;: True or False, # Whether the topic is saved.
}

updateMask: string, The list of fields to be updated.
x__xgafv: string, V1 error format.
Allowed values
1 - v1 error format
2 - v2 error format

Returns:
An object of the form:

{ # Represents topic state specific to a web property.
&quot;dismissed&quot;: True or False, # Whether the topic is dismissed.
&quot;name&quot;: &quot;A String&quot;, # Unique identifier for the topic state. Format: platforms/{platform}/properties/{property}/topicStates/{topic_state}
&quot;saved&quot;: True or False, # Whether the topic is saved.
}</pre>
</div>

</body></html>
60 changes: 57 additions & 3 deletions googleapiclient/discovery_cache/documents/ideahub.v1alpha.json
Original file line number Diff line number Diff line change
Expand Up @@ -126,7 +126,7 @@
"type": "string"
},
"filter": {
"description": "Filter semantics described below.",
"description": "Allows filtering. Supported syntax: * Filter expressions are made up of one or more restrictions. * Restrictions are implicitly combined, as if the `AND` operator was always used. The `OR` operator is currently unsupported. * Supported functions: - `saved(bool)`: If set to true, fetches only saved ideas. If set to false, fetches all except saved ideas. Can't be simultaneously used with `dismissed(bool)`. - `dismissed(bool)`: If set to true, fetches only dismissed ideas. Can't be simultaneously used with `saved(bool)`. The `false` value is currently unsupported. Examples: * `saved(true)` * `saved(false)` * `dismissed(true)` The length of this field should be no more than 500 characters.",
"location": "query",
"type": "string"
},
Expand Down Expand Up @@ -230,7 +230,7 @@
"type": "string"
},
"filter": {
"description": "Filter semantics described below.",
"description": "Allows filtering. Supported syntax: * Filter expressions are made up of one or more restrictions. * Restrictions are implicitly combined, as if the `AND` operator was always used. The `OR` operator is currently unsupported. * Supported functions: - `saved(bool)`: If set to true, fetches only saved ideas. If set to false, fetches all except saved ideas. Can't be simultaneously used with `dismissed(bool)`. - `dismissed(bool)`: If set to true, fetches only dismissed ideas. Can't be simultaneously used with `saved(bool)`. The `false` value is currently unsupported. Examples: * `saved(true)` * `saved(false)` * `dismissed(true)` The length of this field should be no more than 500 characters.",
"location": "query",
"type": "string"
},
Expand Down Expand Up @@ -301,13 +301,48 @@
}
}
}
},
"topicStates": {
"methods": {
"patch": {
"description": "Update a topic state resource.",
"flatPath": "v1alpha/platforms/{platformsId}/properties/{propertiesId}/topicStates/{topicStatesId}",
"httpMethod": "PATCH",
"id": "ideahub.platforms.properties.topicStates.patch",
"parameterOrder": [
"name"
],
"parameters": {
"name": {
"description": "Unique identifier for the topic state. Format: platforms/{platform}/properties/{property}/topicStates/{topic_state}",
"location": "path",
"pattern": "^platforms/[^/]+/properties/[^/]+/topicStates/[^/]+$",
"required": true,
"type": "string"
},
"updateMask": {
"description": "The list of fields to be updated.",
"format": "google-fieldmask",
"location": "query",
"type": "string"
}
},
"path": "v1alpha/{+name}",
"request": {
"$ref": "GoogleSearchIdeahubV1alphaTopicState"
},
"response": {
"$ref": "GoogleSearchIdeahubV1alphaTopicState"
}
}
}
}
}
}
}
}
},
"revision": "20210614",
"revision": "20210625",
"rootUrl": "https://ideahub.googleapis.com/",
"schemas": {
"GoogleSearchIdeahubV1alphaAvailableLocale": {
Expand Down Expand Up @@ -415,6 +450,25 @@
}
},
"type": "object"
},
"GoogleSearchIdeahubV1alphaTopicState": {
"description": "Represents topic state specific to a web property.",
"id": "GoogleSearchIdeahubV1alphaTopicState",
"properties": {
"dismissed": {
"description": "Whether the topic is dismissed.",
"type": "boolean"
},
"name": {
"description": "Unique identifier for the topic state. Format: platforms/{platform}/properties/{property}/topicStates/{topic_state}",
"type": "string"
},
"saved": {
"description": "Whether the topic is saved.",
"type": "boolean"
}
},
"type": "object"
}
},
"servicePath": "",
Expand Down

0 comments on commit 73b86d9

Please sign in to comment.