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