Gitiles
Code Review Sign In
gerrit-public.fairphone.software / platform / external / python / google-api-python-client / 614db98bf45b9da1f29c35a9d942536111e99d41 / . / docs / dyn / reseller_v1.customers.html
blob: 8f9e31e5ec0c80815ac7e5217aa17264ae5cb357 [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.
102 "alternateEmail": "A String", # The alternate email of the customer.
103 "kind": "reseller#customer", # Identifies the resource as a customer.
104 "resourceUiUrl": "A String", # Ui url for customer resource.
105 "phoneNumber": "A String", # The phone number of the customer.
106 "postalAddress": { # JSON template for address of a customer. # The postal address of the customer.
107 "kind": "customers#address", # Identifies the resource as a customer address.
108 "organizationName": "A String", # Name of the organization.
109 "countryCode": "A String", # ISO 3166 country code.
110 "locality": "A String", # Name of the locality. This is in accordance with - http://portablecontacts.net/draft-spec.html#address_element.
111 "region": "A String", # Name of the region. This is in accordance with - http://portablecontacts.net/draft-spec.html#address_element.
112 "addressLine2": "A String", # Address line 2 of the address.
113 "addressLine3": "A String", # Address line 3 of the address.
114 "contactName": "A String", # Name of the contact person.
115 "addressLine1": "A String", # Address line 1 of the address.
116 "postalCode": "A String", # The postal code. This is in accordance with - http://portablecontacts.net/draft-spec.html#address_element.
117 },
118 "customerId": "A String", # The id of the customer.
119 }</pre>
120</div>
121
122<div class="method">
123 <code class="details" id="insert">insert(body, customerAuthToken=None)</code>
124 <pre>Creates a customer resource if one does not already exist.
125
126Args:
127 body: object, The request body. (required)
128 The object takes the form of:
129
130{ # JSON template for a customer.
131 "customerDomain": "A String", # The domain name of the customer.
132 "alternateEmail": "A String", # The alternate email of the customer.
133 "kind": "reseller#customer", # Identifies the resource as a customer.
134 "resourceUiUrl": "A String", # Ui url for customer resource.
135 "phoneNumber": "A String", # The phone number of the customer.
136 "postalAddress": { # JSON template for address of a customer. # The postal address of the customer.
137 "kind": "customers#address", # Identifies the resource as a customer address.
138 "organizationName": "A String", # Name of the organization.
139 "countryCode": "A String", # ISO 3166 country code.
140 "locality": "A String", # Name of the locality. This is in accordance with - http://portablecontacts.net/draft-spec.html#address_element.
141 "region": "A String", # Name of the region. This is in accordance with - http://portablecontacts.net/draft-spec.html#address_element.
142 "addressLine2": "A String", # Address line 2 of the address.
143 "addressLine3": "A String", # Address line 3 of the address.
144 "contactName": "A String", # Name of the contact person.
145 "addressLine1": "A String", # Address line 1 of the address.
146 "postalCode": "A String", # The postal code. This is in accordance with - http://portablecontacts.net/draft-spec.html#address_element.
147 },
148 "customerId": "A String", # The id of the customer.
149 }
150
151 customerAuthToken: string, An auth token needed for inserting a customer for which domain already exists. Can be generated at https://www.google.com/a/cpanel//TransferToken. Optional.
152
153Returns:
154 An object of the form:
155
156 { # JSON template for a customer.
157 "customerDomain": "A String", # The domain name of the customer.
158 "alternateEmail": "A String", # The alternate email of the customer.
159 "kind": "reseller#customer", # Identifies the resource as a customer.
160 "resourceUiUrl": "A String", # Ui url for customer resource.
161 "phoneNumber": "A String", # The phone number of the customer.
162 "postalAddress": { # JSON template for address of a customer. # The postal address of the customer.
163 "kind": "customers#address", # Identifies the resource as a customer address.
164 "organizationName": "A String", # Name of the organization.
165 "countryCode": "A String", # ISO 3166 country code.
166 "locality": "A String", # Name of the locality. This is in accordance with - http://portablecontacts.net/draft-spec.html#address_element.
167 "region": "A String", # Name of the region. This is in accordance with - http://portablecontacts.net/draft-spec.html#address_element.
168 "addressLine2": "A String", # Address line 2 of the address.
169 "addressLine3": "A String", # Address line 3 of the address.
170 "contactName": "A String", # Name of the contact person.
171 "addressLine1": "A String", # Address line 1 of the address.
172 "postalCode": "A String", # The postal code. This is in accordance with - http://portablecontacts.net/draft-spec.html#address_element.
173 },
174 "customerId": "A String", # The id of the customer.
175 }</pre>
176</div>
177
178<div class="method">
179 <code class="details" id="patch">patch(customerId, body)</code>
180 <pre>Update a customer resource if one it exists and is owned by the reseller. This method supports patch semantics.
181
182Args:
183 customerId: string, Id of the Customer (required)
184 body: object, The request body. (required)
185 The object takes the form of:
186
187{ # JSON template for a customer.
188 "customerDomain": "A String", # The domain name of the customer.
189 "alternateEmail": "A String", # The alternate email of the customer.
190 "kind": "reseller#customer", # Identifies the resource as a customer.
191 "resourceUiUrl": "A String", # Ui url for customer resource.
192 "phoneNumber": "A String", # The phone number of the customer.
193 "postalAddress": { # JSON template for address of a customer. # The postal address of the customer.
194 "kind": "customers#address", # Identifies the resource as a customer address.
195 "organizationName": "A String", # Name of the organization.
196 "countryCode": "A String", # ISO 3166 country code.
197 "locality": "A String", # Name of the locality. This is in accordance with - http://portablecontacts.net/draft-spec.html#address_element.
198 "region": "A String", # Name of the region. This is in accordance with - http://portablecontacts.net/draft-spec.html#address_element.
199 "addressLine2": "A String", # Address line 2 of the address.
200 "addressLine3": "A String", # Address line 3 of the address.
201 "contactName": "A String", # Name of the contact person.
202 "addressLine1": "A String", # Address line 1 of the address.
203 "postalCode": "A String", # The postal code. This is in accordance with - http://portablecontacts.net/draft-spec.html#address_element.
204 },
205 "customerId": "A String", # The id of the customer.
206 }
207
208
209Returns:
210 An object of the form:
211
212 { # JSON template for a customer.
213 "customerDomain": "A String", # The domain name of the customer.
214 "alternateEmail": "A String", # The alternate email of the customer.
215 "kind": "reseller#customer", # Identifies the resource as a customer.
216 "resourceUiUrl": "A String", # Ui url for customer resource.
217 "phoneNumber": "A String", # The phone number of the customer.
218 "postalAddress": { # JSON template for address of a customer. # The postal address of the customer.
219 "kind": "customers#address", # Identifies the resource as a customer address.
220 "organizationName": "A String", # Name of the organization.
221 "countryCode": "A String", # ISO 3166 country code.
222 "locality": "A String", # Name of the locality. This is in accordance with - http://portablecontacts.net/draft-spec.html#address_element.
223 "region": "A String", # Name of the region. This is in accordance with - http://portablecontacts.net/draft-spec.html#address_element.
224 "addressLine2": "A String", # Address line 2 of the address.
225 "addressLine3": "A String", # Address line 3 of the address.
226 "contactName": "A String", # Name of the contact person.
227 "addressLine1": "A String", # Address line 1 of the address.
228 "postalCode": "A String", # The postal code. This is in accordance with - http://portablecontacts.net/draft-spec.html#address_element.
229 },
230 "customerId": "A String", # The id of the customer.
231 }</pre>
232</div>
233
234<div class="method">
235 <code class="details" id="update">update(customerId, body)</code>
236 <pre>Update a customer resource if one it exists and is owned by the reseller.
237
238Args:
239 customerId: string, Id of the Customer (required)
240 body: object, The request body. (required)
241 The object takes the form of:
242
243{ # JSON template for a customer.
244 "customerDomain": "A String", # The domain name of the customer.
245 "alternateEmail": "A String", # The alternate email of the customer.
246 "kind": "reseller#customer", # Identifies the resource as a customer.
247 "resourceUiUrl": "A String", # Ui url for customer resource.
248 "phoneNumber": "A String", # The phone number of the customer.
249 "postalAddress": { # JSON template for address of a customer. # The postal address of the customer.
250 "kind": "customers#address", # Identifies the resource as a customer address.
251 "organizationName": "A String", # Name of the organization.
252 "countryCode": "A String", # ISO 3166 country code.
253 "locality": "A String", # Name of the locality. This is in accordance with - http://portablecontacts.net/draft-spec.html#address_element.
254 "region": "A String", # Name of the region. This is in accordance with - http://portablecontacts.net/draft-spec.html#address_element.
255 "addressLine2": "A String", # Address line 2 of the address.
256 "addressLine3": "A String", # Address line 3 of the address.
257 "contactName": "A String", # Name of the contact person.
258 "addressLine1": "A String", # Address line 1 of the address.
259 "postalCode": "A String", # The postal code. This is in accordance with - http://portablecontacts.net/draft-spec.html#address_element.
260 },
261 "customerId": "A String", # The id of the customer.
262 }
263
264
265Returns:
266 An object of the form:
267
268 { # JSON template for a customer.
269 "customerDomain": "A String", # The domain name of the customer.
270 "alternateEmail": "A String", # The alternate email of the customer.
271 "kind": "reseller#customer", # Identifies the resource as a customer.
272 "resourceUiUrl": "A String", # Ui url for customer resource.
273 "phoneNumber": "A String", # The phone number of the customer.
274 "postalAddress": { # JSON template for address of a customer. # The postal address of the customer.
275 "kind": "customers#address", # Identifies the resource as a customer address.
276 "organizationName": "A String", # Name of the organization.
277 "countryCode": "A String", # ISO 3166 country code.
278 "locality": "A String", # Name of the locality. This is in accordance with - http://portablecontacts.net/draft-spec.html#address_element.
279 "region": "A String", # Name of the region. This is in accordance with - http://portablecontacts.net/draft-spec.html#address_element.
280 "addressLine2": "A String", # Address line 2 of the address.
281 "addressLine3": "A String", # Address line 3 of the address.
282 "contactName": "A String", # Name of the contact person.
283 "addressLine1": "A String", # Address line 1 of the address.
284 "postalCode": "A String", # The postal code. This is in accordance with - http://portablecontacts.net/draft-spec.html#address_element.
285 },
286 "customerId": "A String", # The id of the customer.
287 }</pre>
288</div>
289
290</body></html>