Skip to content

Commit e800977

Browse files
chore(docs): Add new discovery artifacts and reference documents
1 parent 253c39f commit e800977

13 files changed

+2077
-162
lines changed
Lines changed: 111 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,111 @@
1+
<html><body>
2+
<style>
3+
4+
body, h1, h2, h3, div, span, p, pre, a {
5+
margin: 0;
6+
padding: 0;
7+
border: 0;
8+
font-weight: inherit;
9+
font-style: inherit;
10+
font-size: 100%;
11+
font-family: inherit;
12+
vertical-align: baseline;
13+
}
14+
15+
body {
16+
font-size: 13px;
17+
padding: 1em;
18+
}
19+
20+
h1 {
21+
font-size: 26px;
22+
margin-bottom: 1em;
23+
}
24+
25+
h2 {
26+
font-size: 24px;
27+
margin-bottom: 1em;
28+
}
29+
30+
h3 {
31+
font-size: 20px;
32+
margin-bottom: 1em;
33+
margin-top: 1em;
34+
}
35+
36+
pre, code {
37+
line-height: 1.5;
38+
font-family: Monaco, 'DejaVu Sans Mono', 'Bitstream Vera Sans Mono', 'Lucida Console', monospace;
39+
}
40+
41+
pre {
42+
margin-top: 0.5em;
43+
}
44+
45+
h1, h2, h3, p {
46+
font-family: Arial, sans serif;
47+
}
48+
49+
h1, h2, h3 {
50+
border-bottom: solid #CCC 1px;
51+
}
52+
53+
.toc_element {
54+
margin-top: 0.5em;
55+
}
56+
57+
.firstline {
58+
margin-left: 2 em;
59+
}
60+
61+
.method {
62+
margin-top: 1em;
63+
border: solid 1px #CCC;
64+
padding: 1em;
65+
background: #EEE;
66+
}
67+
68+
.details {
69+
font-weight: bold;
70+
font-size: 14px;
71+
}
72+
73+
</style>
74+
75+
<h1><a href="cloudcommerceprocurement_v1.html">Cloud Commerce Partner Procurement API</a></h1>
76+
<h2>Instance Methods</h2>
77+
<p class="toc_element">
78+
<code><a href="cloudcommerceprocurement_v1.providers.html">providers()</a></code>
79+
</p>
80+
<p class="firstline">Returns the providers Resource.</p>
81+
82+
<p class="toc_element">
83+
<code><a href="#close">close()</a></code></p>
84+
<p class="firstline">Close httplib2 connections.</p>
85+
<p class="toc_element">
86+
<code><a href="#new_batch_http_request">new_batch_http_request()</a></code></p>
87+
<p class="firstline">Create a BatchHttpRequest object based on the discovery document.</p>
88+
<h3>Method Details</h3>
89+
<div class="method">
90+
<code class="details" id="close">close()</code>
91+
<pre>Close httplib2 connections.</pre>
92+
</div>
93+
94+
<div class="method">
95+
<code class="details" id="new_batch_http_request">new_batch_http_request()</code>
96+
<pre>Create a BatchHttpRequest object based on the discovery document.
97+
98+
Args:
99+
callback: callable, A callback to be called for each response, of the
100+
form callback(id, response, exception). The first parameter is the
101+
request id, and the second is the deserialized response object. The
102+
third is an apiclient.errors.HttpError exception object if an HTTP
103+
error occurred while processing the request, or None if no error
104+
occurred.
105+
106+
Returns:
107+
A BatchHttpRequest object based on the discovery document.
108+
</pre>
109+
</div>
110+
111+
</body></html>
Lines changed: 272 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,272 @@
1+
<html><body>
2+
<style>
3+
4+
body, h1, h2, h3, div, span, p, pre, a {
5+
margin: 0;
6+
padding: 0;
7+
border: 0;
8+
font-weight: inherit;
9+
font-style: inherit;
10+
font-size: 100%;
11+
font-family: inherit;
12+
vertical-align: baseline;
13+
}
14+
15+
body {
16+
font-size: 13px;
17+
padding: 1em;
18+
}
19+
20+
h1 {
21+
font-size: 26px;
22+
margin-bottom: 1em;
23+
}
24+
25+
h2 {
26+
font-size: 24px;
27+
margin-bottom: 1em;
28+
}
29+
30+
h3 {
31+
font-size: 20px;
32+
margin-bottom: 1em;
33+
margin-top: 1em;
34+
}
35+
36+
pre, code {
37+
line-height: 1.5;
38+
font-family: Monaco, 'DejaVu Sans Mono', 'Bitstream Vera Sans Mono', 'Lucida Console', monospace;
39+
}
40+
41+
pre {
42+
margin-top: 0.5em;
43+
}
44+
45+
h1, h2, h3, p {
46+
font-family: Arial, sans serif;
47+
}
48+
49+
h1, h2, h3 {
50+
border-bottom: solid #CCC 1px;
51+
}
52+
53+
.toc_element {
54+
margin-top: 0.5em;
55+
}
56+
57+
.firstline {
58+
margin-left: 2 em;
59+
}
60+
61+
.method {
62+
margin-top: 1em;
63+
border: solid 1px #CCC;
64+
padding: 1em;
65+
background: #EEE;
66+
}
67+
68+
.details {
69+
font-weight: bold;
70+
font-size: 14px;
71+
}
72+
73+
</style>
74+
75+
<h1><a href="cloudcommerceprocurement_v1.html">Cloud Commerce Partner Procurement API</a> . <a href="cloudcommerceprocurement_v1.providers.html">providers</a> . <a href="cloudcommerceprocurement_v1.providers.accounts.html">accounts</a></h1>
76+
<h2>Instance Methods</h2>
77+
<p class="toc_element">
78+
<code><a href="#approve">approve(name, body=None, x__xgafv=None)</a></code></p>
79+
<p class="firstline">Grants an approval on an Account.</p>
80+
<p class="toc_element">
81+
<code><a href="#close">close()</a></code></p>
82+
<p class="firstline">Close httplib2 connections.</p>
83+
<p class="toc_element">
84+
<code><a href="#get">get(name, x__xgafv=None)</a></code></p>
85+
<p class="firstline">Gets a requested Account resource.</p>
86+
<p class="toc_element">
87+
<code><a href="#list">list(parent, pageSize=None, pageToken=None, x__xgafv=None)</a></code></p>
88+
<p class="firstline">Lists Accounts that the provider has access to.</p>
89+
<p class="toc_element">
90+
<code><a href="#list_next">list_next(previous_request, previous_response)</a></code></p>
91+
<p class="firstline">Retrieves the next page of results.</p>
92+
<p class="toc_element">
93+
<code><a href="#reject">reject(name, body=None, x__xgafv=None)</a></code></p>
94+
<p class="firstline">Rejects an approval on an Account.</p>
95+
<p class="toc_element">
96+
<code><a href="#reset">reset(name, body=None, x__xgafv=None)</a></code></p>
97+
<p class="firstline">Resets an Account and cancel all associated Entitlements. Partner can only reset accounts they own rather than customer accounts.</p>
98+
<h3>Method Details</h3>
99+
<div class="method">
100+
<code class="details" id="approve">approve(name, body=None, x__xgafv=None)</code>
101+
<pre>Grants an approval on an Account.
102+
103+
Args:
104+
name: string, The resource name of the account. Required. (required)
105+
body: object, The request body.
106+
The object takes the form of:
107+
108+
{ # Request message for PartnerProcurementService.ApproveAccount.
109+
&quot;approvalName&quot;: &quot;A String&quot;, # The name of the approval being approved. If absent and there is only one approval possible, that approval will be granted. If absent and there are many approvals possible, the request will fail with a 400 Bad Request. Optional.
110+
&quot;properties&quot;: { # Set of properties that should be associated with the account. Optional.
111+
&quot;a_key&quot;: &quot;A String&quot;,
112+
},
113+
&quot;reason&quot;: &quot;A String&quot;, # Free form text string explaining the approval reason. Optional. Max allowed length: 256 bytes. Longer strings will be truncated.
114+
}
115+
116+
x__xgafv: string, V1 error format.
117+
Allowed values
118+
1 - v1 error format
119+
2 - v2 error format
120+
121+
Returns:
122+
An object of the form:
123+
124+
{ # A generic empty message that you can re-use to avoid defining duplicated empty messages in your APIs. A typical example is to use it as the request or the response type of an API method. For instance: service Foo { rpc Bar(google.protobuf.Empty) returns (google.protobuf.Empty); } The JSON representation for `Empty` is empty JSON object `{}`.
125+
}</pre>
126+
</div>
127+
128+
<div class="method">
129+
<code class="details" id="close">close()</code>
130+
<pre>Close httplib2 connections.</pre>
131+
</div>
132+
133+
<div class="method">
134+
<code class="details" id="get">get(name, x__xgafv=None)</code>
135+
<pre>Gets a requested Account resource.
136+
137+
Args:
138+
name: string, The name of the account to retrieve. (required)
139+
x__xgafv: string, V1 error format.
140+
Allowed values
141+
1 - v1 error format
142+
2 - v2 error format
143+
144+
Returns:
145+
An object of the form:
146+
147+
{ # Represents an account that was established by the customer on the service provider&#x27;s system.
148+
&quot;approvals&quot;: [ # Output only. The approvals for this account. These approvals are used to track actions that are permitted or have been completed by a customer within the context of the provider. This might include a sign up flow or a provisioning step, for example, that the provider can admit to having happened.
149+
{ # An approval for some action on an account.
150+
&quot;name&quot;: &quot;A String&quot;, # Output only. The name of the approval.
151+
&quot;reason&quot;: &quot;A String&quot;, # Output only. An explanation for the state of the approval.
152+
&quot;state&quot;: &quot;A String&quot;, # Output only. The state of the approval.
153+
&quot;updateTime&quot;: &quot;A String&quot;, # Optional. The last update timestamp of the approval.
154+
},
155+
],
156+
&quot;createTime&quot;: &quot;A String&quot;, # Output only. The creation timestamp.
157+
&quot;inputProperties&quot;: { # Output only. The custom properties that were collected from the user to create this account.
158+
&quot;a_key&quot;: &quot;&quot;, # Properties of the object.
159+
},
160+
&quot;name&quot;: &quot;A String&quot;, # Output only. The resource name of the account. Account names have the form `accounts/{account_id}`.
161+
&quot;provider&quot;: &quot;A String&quot;, # Output only. The identifier of the service provider that this account was created against. Each service provider is assigned a unique provider value when they onboard with Cloud Commerce platform.
162+
&quot;state&quot;: &quot;A String&quot;, # Output only. The state of the account. This is used to decide whether the customer is in good standing with the provider and is able to make purchases. An account might not be able to make a purchase if the billing account is suspended, for example.
163+
&quot;updateTime&quot;: &quot;A String&quot;, # Output only. The last update timestamp.
164+
}</pre>
165+
</div>
166+
167+
<div class="method">
168+
<code class="details" id="list">list(parent, pageSize=None, pageToken=None, x__xgafv=None)</code>
169+
<pre>Lists Accounts that the provider has access to.
170+
171+
Args:
172+
parent: string, The parent resource name. (required)
173+
pageSize: integer, The maximum number of entries that are requested. Default size is 200.
174+
pageToken: string, The token for fetching the next page.
175+
x__xgafv: string, V1 error format.
176+
Allowed values
177+
1 - v1 error format
178+
2 - v2 error format
179+
180+
Returns:
181+
An object of the form:
182+
183+
{ # Response message for [PartnerProcurementService.ListAccounts[].
184+
&quot;accounts&quot;: [ # The list of accounts in this response.
185+
{ # Represents an account that was established by the customer on the service provider&#x27;s system.
186+
&quot;approvals&quot;: [ # Output only. The approvals for this account. These approvals are used to track actions that are permitted or have been completed by a customer within the context of the provider. This might include a sign up flow or a provisioning step, for example, that the provider can admit to having happened.
187+
{ # An approval for some action on an account.
188+
&quot;name&quot;: &quot;A String&quot;, # Output only. The name of the approval.
189+
&quot;reason&quot;: &quot;A String&quot;, # Output only. An explanation for the state of the approval.
190+
&quot;state&quot;: &quot;A String&quot;, # Output only. The state of the approval.
191+
&quot;updateTime&quot;: &quot;A String&quot;, # Optional. The last update timestamp of the approval.
192+
},
193+
],
194+
&quot;createTime&quot;: &quot;A String&quot;, # Output only. The creation timestamp.
195+
&quot;inputProperties&quot;: { # Output only. The custom properties that were collected from the user to create this account.
196+
&quot;a_key&quot;: &quot;&quot;, # Properties of the object.
197+
},
198+
&quot;name&quot;: &quot;A String&quot;, # Output only. The resource name of the account. Account names have the form `accounts/{account_id}`.
199+
&quot;provider&quot;: &quot;A String&quot;, # Output only. The identifier of the service provider that this account was created against. Each service provider is assigned a unique provider value when they onboard with Cloud Commerce platform.
200+
&quot;state&quot;: &quot;A String&quot;, # Output only. The state of the account. This is used to decide whether the customer is in good standing with the provider and is able to make purchases. An account might not be able to make a purchase if the billing account is suspended, for example.
201+
&quot;updateTime&quot;: &quot;A String&quot;, # Output only. The last update timestamp.
202+
},
203+
],
204+
&quot;nextPageToken&quot;: &quot;A String&quot;, # The token for fetching the next page.
205+
}</pre>
206+
</div>
207+
208+
<div class="method">
209+
<code class="details" id="list_next">list_next(previous_request, previous_response)</code>
210+
<pre>Retrieves the next page of results.
211+
212+
Args:
213+
previous_request: The request for the previous page. (required)
214+
previous_response: The response from the request for the previous page. (required)
215+
216+
Returns:
217+
A request object that you can call &#x27;execute()&#x27; on to request the next
218+
page. Returns None if there are no more items in the collection.
219+
</pre>
220+
</div>
221+
222+
<div class="method">
223+
<code class="details" id="reject">reject(name, body=None, x__xgafv=None)</code>
224+
<pre>Rejects an approval on an Account.
225+
226+
Args:
227+
name: string, The resource name of the account. Required. (required)
228+
body: object, The request body.
229+
The object takes the form of:
230+
231+
{ # Request message for PartnerProcurementService.RejectAccount.
232+
&quot;approvalName&quot;: &quot;A String&quot;, # The name of the approval being rejected. If absent and there is only one approval possible, that approval will be rejected. If absent and there are many approvals possible, the request will fail with a 400 Bad Request. Optional.
233+
&quot;reason&quot;: &quot;A String&quot;, # Free form text string explaining the rejection reason. Max allowed length: 256 bytes. Longer strings will be truncated.
234+
}
235+
236+
x__xgafv: string, V1 error format.
237+
Allowed values
238+
1 - v1 error format
239+
2 - v2 error format
240+
241+
Returns:
242+
An object of the form:
243+
244+
{ # A generic empty message that you can re-use to avoid defining duplicated empty messages in your APIs. A typical example is to use it as the request or the response type of an API method. For instance: service Foo { rpc Bar(google.protobuf.Empty) returns (google.protobuf.Empty); } The JSON representation for `Empty` is empty JSON object `{}`.
245+
}</pre>
246+
</div>
247+
248+
<div class="method">
249+
<code class="details" id="reset">reset(name, body=None, x__xgafv=None)</code>
250+
<pre>Resets an Account and cancel all associated Entitlements. Partner can only reset accounts they own rather than customer accounts.
251+
252+
Args:
253+
name: string, The resource name of the account. Required. (required)
254+
body: object, The request body.
255+
The object takes the form of:
256+
257+
{ # Request message for for PartnerProcurementService.ResetAccount.
258+
}
259+
260+
x__xgafv: string, V1 error format.
261+
Allowed values
262+
1 - v1 error format
263+
2 - v2 error format
264+
265+
Returns:
266+
An object of the form:
267+
268+
{ # A generic empty message that you can re-use to avoid defining duplicated empty messages in your APIs. A typical example is to use it as the request or the response type of an API method. For instance: service Foo { rpc Bar(google.protobuf.Empty) returns (google.protobuf.Empty); } The JSON representation for `Empty` is empty JSON object `{}`.
269+
}</pre>
270+
</div>
271+
272+
</body></html>

0 commit comments

Comments
 (0)