Debian Codegraph @

docs/dyn/admin_directory_v1.customers.html

raw
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="admin_directory_v1.html">Admin SDK API</a> . <a href="admin_directory_v1.customers.html">customers</a></h1>
76 <h2>Instance Methods</h2>
77 <p class="toc_element">
78 <code><a href="admin_directory_v1.customers.chrome.html">chrome()</a></code>
79 </p>
80 <p class="firstline">Returns the chrome 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="#get">get(customerKey, x__xgafv=None)</a></code></p>
87 <p class="firstline">Retrieves a customer.</p>
88 <p class="toc_element">
89 <code><a href="#patch">patch(customerKey, body=None, x__xgafv=None)</a></code></p>
90 <p class="firstline">Patches a customer.</p>
91 <p class="toc_element">
92 <code><a href="#update">update(customerKey, body=None, x__xgafv=None)</a></code></p>
93 <p class="firstline">Updates a customer.</p>
94 <h3>Method Details</h3>
95 <div class="method">
96 <code class="details" id="close">close()</code>
97 <pre>Close httplib2 connections.</pre>
98 </div>
99
100 <div class="method">
101 <code class="details" id="get">get(customerKey, x__xgafv=None)</code>
102 <pre>Retrieves a customer.
103
104 Args:
105 customerKey: string, Id of the customer to be retrieved (required)
106 x__xgafv: string, V1 error format.
107 Allowed values
108 1 - v1 error format
109 2 - v2 error format
110
111 Returns:
112 An object of the form:
113
114 {
115 &quot;alternateEmail&quot;: &quot;A String&quot;, # The customer&#x27;s secondary contact email address. This email address cannot be on the same domain as the `customerDomain`
116 &quot;customerCreationTime&quot;: &quot;A String&quot;, # The customer&#x27;s creation time (Readonly)
117 &quot;customerDomain&quot;: &quot;A String&quot;, # The customer&#x27;s primary domain name string. Do not include the `www` prefix when creating a new customer.
118 &quot;etag&quot;: &quot;A String&quot;, # ETag of the resource.
119 &quot;id&quot;: &quot;A String&quot;, # The unique ID for the customer&#x27;s Google Workspace account. (Readonly)
120 &quot;kind&quot;: &quot;admin#directory#customer&quot;, # Identifies the resource as a customer. Value: `admin#directory#customer`
121 &quot;language&quot;: &quot;A String&quot;, # The customer&#x27;s ISO 639-2 language code. See the [Language Codes](https://developers.google.com/workspace/admin/directory/v1/languages) page for the list of supported codes. Valid language codes outside the supported set will be accepted by the API but may lead to unexpected behavior. The default value is `en`.
122 &quot;phoneNumber&quot;: &quot;A String&quot;, # The customer&#x27;s contact phone number in [E.164](https://en.wikipedia.org/wiki/E.164) format.
123 &quot;postalAddress&quot;: { # The customer&#x27;s postal address information.
124 &quot;addressLine1&quot;: &quot;A String&quot;, # A customer&#x27;s physical address. The address can be composed of one to three lines.
125 &quot;addressLine2&quot;: &quot;A String&quot;, # Address line 2 of the address.
126 &quot;addressLine3&quot;: &quot;A String&quot;, # Address line 3 of the address.
127 &quot;contactName&quot;: &quot;A String&quot;, # The customer contact&#x27;s name.
128 &quot;countryCode&quot;: &quot;A String&quot;, # This is a required property. For `countryCode` information see the [ISO 3166 country code elements](https://www.iso.org/iso/country_codes.htm).
129 &quot;locality&quot;: &quot;A String&quot;, # Name of the locality. An example of a locality value is the city of `San Francisco`.
130 &quot;organizationName&quot;: &quot;A String&quot;, # The company or company division name.
131 &quot;postalCode&quot;: &quot;A String&quot;, # The postal code. A postalCode example is a postal zip code such as `10009`. This is in accordance with - http: //portablecontacts.net/draft-spec.html#address_element.
132 &quot;region&quot;: &quot;A String&quot;, # Name of the region. An example of a region value is `NY` for the state of New York.
133 },
134 }</pre>
135 </div>
136
137 <div class="method">
138 <code class="details" id="patch">patch(customerKey, body=None, x__xgafv=None)</code>
139 <pre>Patches a customer.
140
141 Args:
142 customerKey: string, Id of the customer to be updated (required)
143 body: object, The request body.
144 The object takes the form of:
145
146 {
147 &quot;alternateEmail&quot;: &quot;A String&quot;, # The customer&#x27;s secondary contact email address. This email address cannot be on the same domain as the `customerDomain`
148 &quot;customerCreationTime&quot;: &quot;A String&quot;, # The customer&#x27;s creation time (Readonly)
149 &quot;customerDomain&quot;: &quot;A String&quot;, # The customer&#x27;s primary domain name string. Do not include the `www` prefix when creating a new customer.
150 &quot;etag&quot;: &quot;A String&quot;, # ETag of the resource.
151 &quot;id&quot;: &quot;A String&quot;, # The unique ID for the customer&#x27;s Google Workspace account. (Readonly)
152 &quot;kind&quot;: &quot;admin#directory#customer&quot;, # Identifies the resource as a customer. Value: `admin#directory#customer`
153 &quot;language&quot;: &quot;A String&quot;, # The customer&#x27;s ISO 639-2 language code. See the [Language Codes](https://developers.google.com/workspace/admin/directory/v1/languages) page for the list of supported codes. Valid language codes outside the supported set will be accepted by the API but may lead to unexpected behavior. The default value is `en`.
154 &quot;phoneNumber&quot;: &quot;A String&quot;, # The customer&#x27;s contact phone number in [E.164](https://en.wikipedia.org/wiki/E.164) format.
155 &quot;postalAddress&quot;: { # The customer&#x27;s postal address information.
156 &quot;addressLine1&quot;: &quot;A String&quot;, # A customer&#x27;s physical address. The address can be composed of one to three lines.
157 &quot;addressLine2&quot;: &quot;A String&quot;, # Address line 2 of the address.
158 &quot;addressLine3&quot;: &quot;A String&quot;, # Address line 3 of the address.
159 &quot;contactName&quot;: &quot;A String&quot;, # The customer contact&#x27;s name.
160 &quot;countryCode&quot;: &quot;A String&quot;, # This is a required property. For `countryCode` information see the [ISO 3166 country code elements](https://www.iso.org/iso/country_codes.htm).
161 &quot;locality&quot;: &quot;A String&quot;, # Name of the locality. An example of a locality value is the city of `San Francisco`.
162 &quot;organizationName&quot;: &quot;A String&quot;, # The company or company division name.
163 &quot;postalCode&quot;: &quot;A String&quot;, # The postal code. A postalCode example is a postal zip code such as `10009`. This is in accordance with - http: //portablecontacts.net/draft-spec.html#address_element.
164 &quot;region&quot;: &quot;A String&quot;, # Name of the region. An example of a region value is `NY` for the state of New York.
165 },
166 }
167
168 x__xgafv: string, V1 error format.
169 Allowed values
170 1 - v1 error format
171 2 - v2 error format
172
173 Returns:
174 An object of the form:
175
176 {
177 &quot;alternateEmail&quot;: &quot;A String&quot;, # The customer&#x27;s secondary contact email address. This email address cannot be on the same domain as the `customerDomain`
178 &quot;customerCreationTime&quot;: &quot;A String&quot;, # The customer&#x27;s creation time (Readonly)
179 &quot;customerDomain&quot;: &quot;A String&quot;, # The customer&#x27;s primary domain name string. Do not include the `www` prefix when creating a new customer.
180 &quot;etag&quot;: &quot;A String&quot;, # ETag of the resource.
181 &quot;id&quot;: &quot;A String&quot;, # The unique ID for the customer&#x27;s Google Workspace account. (Readonly)
182 &quot;kind&quot;: &quot;admin#directory#customer&quot;, # Identifies the resource as a customer. Value: `admin#directory#customer`
183 &quot;language&quot;: &quot;A String&quot;, # The customer&#x27;s ISO 639-2 language code. See the [Language Codes](https://developers.google.com/workspace/admin/directory/v1/languages) page for the list of supported codes. Valid language codes outside the supported set will be accepted by the API but may lead to unexpected behavior. The default value is `en`.
184 &quot;phoneNumber&quot;: &quot;A String&quot;, # The customer&#x27;s contact phone number in [E.164](https://en.wikipedia.org/wiki/E.164) format.
185 &quot;postalAddress&quot;: { # The customer&#x27;s postal address information.
186 &quot;addressLine1&quot;: &quot;A String&quot;, # A customer&#x27;s physical address. The address can be composed of one to three lines.
187 &quot;addressLine2&quot;: &quot;A String&quot;, # Address line 2 of the address.
188 &quot;addressLine3&quot;: &quot;A String&quot;, # Address line 3 of the address.
189 &quot;contactName&quot;: &quot;A String&quot;, # The customer contact&#x27;s name.
190 &quot;countryCode&quot;: &quot;A String&quot;, # This is a required property. For `countryCode` information see the [ISO 3166 country code elements](https://www.iso.org/iso/country_codes.htm).
191 &quot;locality&quot;: &quot;A String&quot;, # Name of the locality. An example of a locality value is the city of `San Francisco`.
192 &quot;organizationName&quot;: &quot;A String&quot;, # The company or company division name.
193 &quot;postalCode&quot;: &quot;A String&quot;, # The postal code. A postalCode example is a postal zip code such as `10009`. This is in accordance with - http: //portablecontacts.net/draft-spec.html#address_element.
194 &quot;region&quot;: &quot;A String&quot;, # Name of the region. An example of a region value is `NY` for the state of New York.
195 },
196 }</pre>
197 </div>
198
199 <div class="method">
200 <code class="details" id="update">update(customerKey, body=None, x__xgafv=None)</code>
201 <pre>Updates a customer.
202
203 Args:
204 customerKey: string, Id of the customer to be updated (required)
205 body: object, The request body.
206 The object takes the form of:
207
208 {
209 &quot;alternateEmail&quot;: &quot;A String&quot;, # The customer&#x27;s secondary contact email address. This email address cannot be on the same domain as the `customerDomain`
210 &quot;customerCreationTime&quot;: &quot;A String&quot;, # The customer&#x27;s creation time (Readonly)
211 &quot;customerDomain&quot;: &quot;A String&quot;, # The customer&#x27;s primary domain name string. Do not include the `www` prefix when creating a new customer.
212 &quot;etag&quot;: &quot;A String&quot;, # ETag of the resource.
213 &quot;id&quot;: &quot;A String&quot;, # The unique ID for the customer&#x27;s Google Workspace account. (Readonly)
214 &quot;kind&quot;: &quot;admin#directory#customer&quot;, # Identifies the resource as a customer. Value: `admin#directory#customer`
215 &quot;language&quot;: &quot;A String&quot;, # The customer&#x27;s ISO 639-2 language code. See the [Language Codes](https://developers.google.com/workspace/admin/directory/v1/languages) page for the list of supported codes. Valid language codes outside the supported set will be accepted by the API but may lead to unexpected behavior. The default value is `en`.
216 &quot;phoneNumber&quot;: &quot;A String&quot;, # The customer&#x27;s contact phone number in [E.164](https://en.wikipedia.org/wiki/E.164) format.
217 &quot;postalAddress&quot;: { # The customer&#x27;s postal address information.
218 &quot;addressLine1&quot;: &quot;A String&quot;, # A customer&#x27;s physical address. The address can be composed of one to three lines.
219 &quot;addressLine2&quot;: &quot;A String&quot;, # Address line 2 of the address.
220 &quot;addressLine3&quot;: &quot;A String&quot;, # Address line 3 of the address.
221 &quot;contactName&quot;: &quot;A String&quot;, # The customer contact&#x27;s name.
222 &quot;countryCode&quot;: &quot;A String&quot;, # This is a required property. For `countryCode` information see the [ISO 3166 country code elements](https://www.iso.org/iso/country_codes.htm).
223 &quot;locality&quot;: &quot;A String&quot;, # Name of the locality. An example of a locality value is the city of `San Francisco`.
224 &quot;organizationName&quot;: &quot;A String&quot;, # The company or company division name.
225 &quot;postalCode&quot;: &quot;A String&quot;, # The postal code. A postalCode example is a postal zip code such as `10009`. This is in accordance with - http: //portablecontacts.net/draft-spec.html#address_element.
226 &quot;region&quot;: &quot;A String&quot;, # Name of the region. An example of a region value is `NY` for the state of New York.
227 },
228 }
229
230 x__xgafv: string, V1 error format.
231 Allowed values
232 1 - v1 error format
233 2 - v2 error format
234
235 Returns:
236 An object of the form:
237
238 {
239 &quot;alternateEmail&quot;: &quot;A String&quot;, # The customer&#x27;s secondary contact email address. This email address cannot be on the same domain as the `customerDomain`
240 &quot;customerCreationTime&quot;: &quot;A String&quot;, # The customer&#x27;s creation time (Readonly)
241 &quot;customerDomain&quot;: &quot;A String&quot;, # The customer&#x27;s primary domain name string. Do not include the `www` prefix when creating a new customer.
242 &quot;etag&quot;: &quot;A String&quot;, # ETag of the resource.
243 &quot;id&quot;: &quot;A String&quot;, # The unique ID for the customer&#x27;s Google Workspace account. (Readonly)
244 &quot;kind&quot;: &quot;admin#directory#customer&quot;, # Identifies the resource as a customer. Value: `admin#directory#customer`
245 &quot;language&quot;: &quot;A String&quot;, # The customer&#x27;s ISO 639-2 language code. See the [Language Codes](https://developers.google.com/workspace/admin/directory/v1/languages) page for the list of supported codes. Valid language codes outside the supported set will be accepted by the API but may lead to unexpected behavior. The default value is `en`.
246 &quot;phoneNumber&quot;: &quot;A String&quot;, # The customer&#x27;s contact phone number in [E.164](https://en.wikipedia.org/wiki/E.164) format.
247 &quot;postalAddress&quot;: { # The customer&#x27;s postal address information.
248 &quot;addressLine1&quot;: &quot;A String&quot;, # A customer&#x27;s physical address. The address can be composed of one to three lines.
249 &quot;addressLine2&quot;: &quot;A String&quot;, # Address line 2 of the address.
250 &quot;addressLine3&quot;: &quot;A String&quot;, # Address line 3 of the address.
251 &quot;contactName&quot;: &quot;A String&quot;, # The customer contact&#x27;s name.
252 &quot;countryCode&quot;: &quot;A String&quot;, # This is a required property. For `countryCode` information see the [ISO 3166 country code elements](https://www.iso.org/iso/country_codes.htm).
253 &quot;locality&quot;: &quot;A String&quot;, # Name of the locality. An example of a locality value is the city of `San Francisco`.
254 &quot;organizationName&quot;: &quot;A String&quot;, # The company or company division name.
255 &quot;postalCode&quot;: &quot;A String&quot;, # The postal code. A postalCode example is a postal zip code such as `10009`. This is in accordance with - http: //portablecontacts.net/draft-spec.html#address_element.
256 &quot;region&quot;: &quot;A String&quot;, # Name of the region. An example of a region value is `NY` for the state of New York.
257 },
258 }</pre>
259 </div>
260
261 </body></html>