Gitiles
Code Review Sign In
gerrit-public.fairphone.software / platform / external / python / google-api-python-client / 36e41bc9e5f0c6e6d5920ae4a5c9802ca63554e2 / . / docs / dyn / reseller_v1.customers.html
blob: b2c135d4ecea2db73030ae72fe5623513a70ec4c [file] [log] [blame]
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]1<html><body>
2<style>
3
4body, 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
15body {
16 font-size: 13px;
17 padding: 1em;
18}
19
20h1 {
21 font-size: 26px;
22 margin-bottom: 1em;
23}
24
25h2 {
26 font-size: 24px;
27 margin-bottom: 1em;
28}
29
30h3 {
31 font-size: 20px;
32 margin-bottom: 1em;
33 margin-top: 1em;
34}
35
36pre, code {
37 line-height: 1.5;
38 font-family: Monaco, 'DejaVu Sans Mono', 'Bitstream Vera Sans Mono', 'Lucida Console', monospace;
39}
40
41pre {
42 margin-top: 0.5em;
43}
44
45h1, h2, h3, p {
46 font-family: Arial, sans serif;
47}
48
49h1, 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="reseller_v1.html">Enterprise Apps Reseller API</a> . <a href="reseller_v1.customers.html">customers</a></h1>
76<h2>Instance Methods</h2>
77<p class="toc_element">
78 <code><a href="#get">get(customerId)</a></code></p>
79<p class="firstline">Gets a customer resource if one exists and is owned by the reseller.</p>
80<p class="toc_element">
81 <code><a href="#insert">insert(body, customerAuthToken=None)</a></code></p>
82<p class="firstline">Creates a customer resource if one does not already exist.</p>
83<p class="toc_element">
84 <code><a href="#patch">patch(customerId, body)</a></code></p>
85<p class="firstline">Update a customer resource if one it exists and is owned by the reseller. This method supports patch semantics.</p>
86<p class="toc_element">
87 <code><a href="#update">update(customerId, body)</a></code></p>
88<p class="firstline">Update a customer resource if one it exists and is owned by the reseller.</p>
89<h3>Method Details</h3>
90<div class="method">
91 <code class="details" id="get">get(customerId)</code>
92 <pre>Gets a customer resource if one exists and is owned by the reseller.
93
94Args:
95 customerId: string, Id of the Customer (required)
96
97Returns:
98 An object of the form:
99
100 { # JSON template for a customer.
101 "customerDomain": "A String", # The domain name of the customer.
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800[diff] [blame^]102 "customerDomainVerified": True or False, # Whether the customer's primary domain has been verified.
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]103 "alternateEmail": "A String", # The alternate email of the customer.
104 "kind": "reseller#customer", # Identifies the resource as a customer.
105 "resourceUiUrl": "A String", # Ui url for customer resource.
106 "phoneNumber": "A String", # The phone number of the customer.
107 "postalAddress": { # JSON template for address of a customer. # The postal address of the customer.
108 "kind": "customers#address", # Identifies the resource as a customer address.
109 "organizationName": "A String", # Name of the organization.
110 "countryCode": "A String", # ISO 3166 country code.
111 "locality": "A String", # Name of the locality. This is in accordance with - http://portablecontacts.net/draft-spec.html#address_element.
112 "region": "A String", # Name of the region. This is in accordance with - http://portablecontacts.net/draft-spec.html#address_element.
113 "addressLine2": "A String", # Address line 2 of the address.
114 "addressLine3": "A String", # Address line 3 of the address.
115 "contactName": "A String", # Name of the contact person.
116 "addressLine1": "A String", # Address line 1 of the address.
117 "postalCode": "A String", # The postal code. This is in accordance with - http://portablecontacts.net/draft-spec.html#address_element.
118 },
119 "customerId": "A String", # The id of the customer.
120 }</pre>
121</div>
122
123<div class="method">
124 <code class="details" id="insert">insert(body, customerAuthToken=None)</code>
125 <pre>Creates a customer resource if one does not already exist.
126
127Args:
128 body: object, The request body. (required)
129 The object takes the form of:
130
131{ # JSON template for a customer.
132 "customerDomain": "A String", # The domain name of the customer.
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800[diff] [blame^]133 "customerDomainVerified": True or False, # Whether the customer's primary domain has been verified.
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]134 "alternateEmail": "A String", # The alternate email of the customer.
135 "kind": "reseller#customer", # Identifies the resource as a customer.
136 "resourceUiUrl": "A String", # Ui url for customer resource.
137 "phoneNumber": "A String", # The phone number of the customer.
138 "postalAddress": { # JSON template for address of a customer. # The postal address of the customer.
139 "kind": "customers#address", # Identifies the resource as a customer address.
140 "organizationName": "A String", # Name of the organization.
141 "countryCode": "A String", # ISO 3166 country code.
142 "locality": "A String", # Name of the locality. This is in accordance with - http://portablecontacts.net/draft-spec.html#address_element.
143 "region": "A String", # Name of the region. This is in accordance with - http://portablecontacts.net/draft-spec.html#address_element.
144 "addressLine2": "A String", # Address line 2 of the address.
145 "addressLine3": "A String", # Address line 3 of the address.
146 "contactName": "A String", # Name of the contact person.
147 "addressLine1": "A String", # Address line 1 of the address.
148 "postalCode": "A String", # The postal code. This is in accordance with - http://portablecontacts.net/draft-spec.html#address_element.
149 },
150 "customerId": "A String", # The id of the customer.
151 }
152
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800[diff] [blame^]153 customerAuthToken: string, An auth token needed for inserting a customer for which domain already exists. Can be generated at https://admin.google.com/TransferToken. Optional.
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]154
155Returns:
156 An object of the form:
157
158 { # JSON template for a customer.
159 "customerDomain": "A String", # The domain name of the customer.
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800[diff] [blame^]160 "customerDomainVerified": True or False, # Whether the customer's primary domain has been verified.
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]161 "alternateEmail": "A String", # The alternate email of the customer.
162 "kind": "reseller#customer", # Identifies the resource as a customer.
163 "resourceUiUrl": "A String", # Ui url for customer resource.
164 "phoneNumber": "A String", # The phone number of the customer.
165 "postalAddress": { # JSON template for address of a customer. # The postal address of the customer.
166 "kind": "customers#address", # Identifies the resource as a customer address.
167 "organizationName": "A String", # Name of the organization.
168 "countryCode": "A String", # ISO 3166 country code.
169 "locality": "A String", # Name of the locality. This is in accordance with - http://portablecontacts.net/draft-spec.html#address_element.
170 "region": "A String", # Name of the region. This is in accordance with - http://portablecontacts.net/draft-spec.html#address_element.
171 "addressLine2": "A String", # Address line 2 of the address.
172 "addressLine3": "A String", # Address line 3 of the address.
173 "contactName": "A String", # Name of the contact person.
174 "addressLine1": "A String", # Address line 1 of the address.
175 "postalCode": "A String", # The postal code. This is in accordance with - http://portablecontacts.net/draft-spec.html#address_element.
176 },
177 "customerId": "A String", # The id of the customer.
178 }</pre>
179</div>
180
181<div class="method">
182 <code class="details" id="patch">patch(customerId, body)</code>
183 <pre>Update a customer resource if one it exists and is owned by the reseller. This method supports patch semantics.
184
185Args:
186 customerId: string, Id of the Customer (required)
187 body: object, The request body. (required)
188 The object takes the form of:
189
190{ # JSON template for a customer.
191 "customerDomain": "A String", # The domain name of the customer.
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800[diff] [blame^]192 "customerDomainVerified": True or False, # Whether the customer's primary domain has been verified.
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]193 "alternateEmail": "A String", # The alternate email of the customer.
194 "kind": "reseller#customer", # Identifies the resource as a customer.
195 "resourceUiUrl": "A String", # Ui url for customer resource.
196 "phoneNumber": "A String", # The phone number of the customer.
197 "postalAddress": { # JSON template for address of a customer. # The postal address of the customer.
198 "kind": "customers#address", # Identifies the resource as a customer address.
199 "organizationName": "A String", # Name of the organization.
200 "countryCode": "A String", # ISO 3166 country code.
201 "locality": "A String", # Name of the locality. This is in accordance with - http://portablecontacts.net/draft-spec.html#address_element.
202 "region": "A String", # Name of the region. This is in accordance with - http://portablecontacts.net/draft-spec.html#address_element.
203 "addressLine2": "A String", # Address line 2 of the address.
204 "addressLine3": "A String", # Address line 3 of the address.
205 "contactName": "A String", # Name of the contact person.
206 "addressLine1": "A String", # Address line 1 of the address.
207 "postalCode": "A String", # The postal code. This is in accordance with - http://portablecontacts.net/draft-spec.html#address_element.
208 },
209 "customerId": "A String", # The id of the customer.
210 }
211
212
213Returns:
214 An object of the form:
215
216 { # JSON template for a customer.
217 "customerDomain": "A String", # The domain name of the customer.
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800[diff] [blame^]218 "customerDomainVerified": True or False, # Whether the customer's primary domain has been verified.
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]219 "alternateEmail": "A String", # The alternate email of the customer.
220 "kind": "reseller#customer", # Identifies the resource as a customer.
221 "resourceUiUrl": "A String", # Ui url for customer resource.
222 "phoneNumber": "A String", # The phone number of the customer.
223 "postalAddress": { # JSON template for address of a customer. # The postal address of the customer.
224 "kind": "customers#address", # Identifies the resource as a customer address.
225 "organizationName": "A String", # Name of the organization.
226 "countryCode": "A String", # ISO 3166 country code.
227 "locality": "A String", # Name of the locality. This is in accordance with - http://portablecontacts.net/draft-spec.html#address_element.
228 "region": "A String", # Name of the region. This is in accordance with - http://portablecontacts.net/draft-spec.html#address_element.
229 "addressLine2": "A String", # Address line 2 of the address.
230 "addressLine3": "A String", # Address line 3 of the address.
231 "contactName": "A String", # Name of the contact person.
232 "addressLine1": "A String", # Address line 1 of the address.
233 "postalCode": "A String", # The postal code. This is in accordance with - http://portablecontacts.net/draft-spec.html#address_element.
234 },
235 "customerId": "A String", # The id of the customer.
236 }</pre>
237</div>
238
239<div class="method">
240 <code class="details" id="update">update(customerId, body)</code>
241 <pre>Update a customer resource if one it exists and is owned by the reseller.
242
243Args:
244 customerId: string, Id of the Customer (required)
245 body: object, The request body. (required)
246 The object takes the form of:
247
248{ # JSON template for a customer.
249 "customerDomain": "A String", # The domain name of the customer.
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800[diff] [blame^]250 "customerDomainVerified": True or False, # Whether the customer's primary domain has been verified.
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]251 "alternateEmail": "A String", # The alternate email of the customer.
252 "kind": "reseller#customer", # Identifies the resource as a customer.
253 "resourceUiUrl": "A String", # Ui url for customer resource.
254 "phoneNumber": "A String", # The phone number of the customer.
255 "postalAddress": { # JSON template for address of a customer. # The postal address of the customer.
256 "kind": "customers#address", # Identifies the resource as a customer address.
257 "organizationName": "A String", # Name of the organization.
258 "countryCode": "A String", # ISO 3166 country code.
259 "locality": "A String", # Name of the locality. This is in accordance with - http://portablecontacts.net/draft-spec.html#address_element.
260 "region": "A String", # Name of the region. This is in accordance with - http://portablecontacts.net/draft-spec.html#address_element.
261 "addressLine2": "A String", # Address line 2 of the address.
262 "addressLine3": "A String", # Address line 3 of the address.
263 "contactName": "A String", # Name of the contact person.
264 "addressLine1": "A String", # Address line 1 of the address.
265 "postalCode": "A String", # The postal code. This is in accordance with - http://portablecontacts.net/draft-spec.html#address_element.
266 },
267 "customerId": "A String", # The id of the customer.
268 }
269
270
271Returns:
272 An object of the form:
273
274 { # JSON template for a customer.
275 "customerDomain": "A String", # The domain name of the customer.
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800[diff] [blame^]276 "customerDomainVerified": True or False, # Whether the customer's primary domain has been verified.
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]277 "alternateEmail": "A String", # The alternate email of the customer.
278 "kind": "reseller#customer", # Identifies the resource as a customer.
279 "resourceUiUrl": "A String", # Ui url for customer resource.
280 "phoneNumber": "A String", # The phone number of the customer.
281 "postalAddress": { # JSON template for address of a customer. # The postal address of the customer.
282 "kind": "customers#address", # Identifies the resource as a customer address.
283 "organizationName": "A String", # Name of the organization.
284 "countryCode": "A String", # ISO 3166 country code.
285 "locality": "A String", # Name of the locality. This is in accordance with - http://portablecontacts.net/draft-spec.html#address_element.
286 "region": "A String", # Name of the region. This is in accordance with - http://portablecontacts.net/draft-spec.html#address_element.
287 "addressLine2": "A String", # Address line 2 of the address.
288 "addressLine3": "A String", # Address line 3 of the address.
289 "contactName": "A String", # Name of the contact person.
290 "addressLine1": "A String", # Address line 1 of the address.
291 "postalCode": "A String", # The postal code. This is in accordance with - http://portablecontacts.net/draft-spec.html#address_element.
292 },
293 "customerId": "A String", # The id of the customer.
294 }</pre>
295</div>
296
297</body></html>