Gitiles
Code Review Sign In
gerrit-public.fairphone.software / platform / external / python / google-api-python-client / f46ea5502e604e4b8e7149dc65d57be67f00e4c6 / . / docs / dyn / siteVerification.v1.webResource.html
blob: 826e1733d43a744853def41ae73ff45f38c99a1f [file] [log] [blame]
Joe Gregorio351b1492011-05-08 23:32:46 -0700[diff] [blame]1
2<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.0 Transitional//EN">
3<html><head><title>Python: class Resource</title>
4</head><body bgcolor="#f0f0f8">
5<p>
6<table width="100%" cellspacing=0 cellpadding=2 border=0 summary="section">
7<tr bgcolor="#ffc8d8">
8<td colspan=3 valign=bottom>&nbsp;<br>
9<font color="#000000" face="helvetica, arial"><a name="Resource">class <strong>Resource</strong></a>(<a href="__builtin__.html#object">__builtin__.object</a>)</font></td></tr>
10
11<tr bgcolor="#ffc8d8"><td rowspan=2><tt>&nbsp;&nbsp;&nbsp;</tt></td>
12<td colspan=2><tt>A&nbsp;class&nbsp;for&nbsp;interacting&nbsp;with&nbsp;a&nbsp;resource.<br>&nbsp;</tt></td></tr>
13<tr><td>&nbsp;</td>
14<td width="100%">Methods defined here:<br>
15<dl><dt><a name="Resource-__init__"><strong>__init__</strong></a>(self)</dt></dl>
16
17<dl><dt><a name="Resource-delete"><strong>delete</strong></a> = method(self, **kwargs)</dt><dd><tt>Relinquish&nbsp;ownership&nbsp;of&nbsp;a&nbsp;website&nbsp;or&nbsp;domain.<br>
18&nbsp;<br>
19Args:<br>
Joe Gregorio66212032012-06-14 09:10:14 -0400[diff] [blame]20&nbsp;&nbsp;pp:&nbsp;string,&nbsp;A&nbsp;parameter<br>
21&nbsp;&nbsp;trace:&nbsp;string,&nbsp;A&nbsp;parameter<br>
22&nbsp;&nbsp;strict:&nbsp;string,&nbsp;A&nbsp;parameter<br>
23&nbsp;&nbsp;userip:&nbsp;string,&nbsp;A&nbsp;parameter<br>
Joe Gregorio351b1492011-05-08 23:32:46 -0700[diff] [blame]24&nbsp;&nbsp;id:&nbsp;string,&nbsp;The&nbsp;id&nbsp;of&nbsp;a&nbsp;verified&nbsp;site&nbsp;or&nbsp;domain.&nbsp;(required)</tt></dd></dl>
25
26<dl><dt><a name="Resource-get"><strong>get</strong></a> = method(self, **kwargs)</dt><dd><tt>Get&nbsp;the&nbsp;most&nbsp;current&nbsp;data&nbsp;for&nbsp;a&nbsp;website&nbsp;or&nbsp;domain.<br>
27&nbsp;<br>
28Args:<br>
Joe Gregorio66212032012-06-14 09:10:14 -0400[diff] [blame]29&nbsp;&nbsp;pp:&nbsp;string,&nbsp;A&nbsp;parameter<br>
30&nbsp;&nbsp;trace:&nbsp;string,&nbsp;A&nbsp;parameter<br>
31&nbsp;&nbsp;strict:&nbsp;string,&nbsp;A&nbsp;parameter<br>
32&nbsp;&nbsp;userip:&nbsp;string,&nbsp;A&nbsp;parameter<br>
Joe Gregoriob417caf2011-12-08 12:04:24 -0500[diff] [blame]33&nbsp;&nbsp;id:&nbsp;string,&nbsp;The&nbsp;id&nbsp;of&nbsp;a&nbsp;verified&nbsp;site&nbsp;or&nbsp;domain.&nbsp;(required)<br>
34&nbsp;<br>
35Returns:<br>
36&nbsp;&nbsp;An&nbsp;object&nbsp;of&nbsp;the&nbsp;form<br>
37&nbsp;<br>
38&nbsp;&nbsp;&nbsp;&nbsp;{<br>
39&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"owners":&nbsp;[&nbsp;#&nbsp;The&nbsp;email&nbsp;addresses&nbsp;of&nbsp;all&nbsp;verified&nbsp;owners.<br>
40&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"A&nbsp;String",<br>
41&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;],<br>
42&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"id":&nbsp;"A&nbsp;String",&nbsp;#&nbsp;The&nbsp;string&nbsp;used&nbsp;to&nbsp;identify&nbsp;this&nbsp;site.&nbsp;This&nbsp;value&nbsp;should&nbsp;be&nbsp;used&nbsp;in&nbsp;the&nbsp;"id"&nbsp;portion&nbsp;of&nbsp;the&nbsp;REST&nbsp;URL&nbsp;for&nbsp;the&nbsp;Get,&nbsp;Update,&nbsp;and&nbsp;Delete&nbsp;operations.<br>
43&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"site":&nbsp;{&nbsp;#&nbsp;The&nbsp;address&nbsp;and&nbsp;type&nbsp;of&nbsp;a&nbsp;site&nbsp;that&nbsp;is&nbsp;verified&nbsp;or&nbsp;will&nbsp;be&nbsp;verified.<br>
44&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"identifier":&nbsp;"A&nbsp;String",&nbsp;#&nbsp;The&nbsp;site&nbsp;identifier.&nbsp;If&nbsp;the&nbsp;type&nbsp;is&nbsp;set&nbsp;to&nbsp;SITE,&nbsp;the&nbsp;identifier&nbsp;is&nbsp;a&nbsp;URL.&nbsp;If&nbsp;the&nbsp;type&nbsp;is&nbsp;set&nbsp;to&nbsp;INET_DOMAIN,&nbsp;the&nbsp;site&nbsp;identifier&nbsp;is&nbsp;a&nbsp;domain&nbsp;name.<br>
45&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"type":&nbsp;"A&nbsp;String",&nbsp;#&nbsp;The&nbsp;site&nbsp;type.&nbsp;Can&nbsp;be&nbsp;SITE&nbsp;or&nbsp;INET_DOMAIN&nbsp;(domain&nbsp;name).<br>
46&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;},<br>
47&nbsp;&nbsp;&nbsp;&nbsp;}</tt></dd></dl>
Joe Gregorio351b1492011-05-08 23:32:46 -0700[diff] [blame]48
49<dl><dt><a name="Resource-getToken"><strong>getToken</strong></a> = method(self, **kwargs)</dt><dd><tt>Get&nbsp;a&nbsp;verification&nbsp;token&nbsp;for&nbsp;placing&nbsp;on&nbsp;a&nbsp;website&nbsp;or&nbsp;domain.<br>
50&nbsp;<br>
51Args:<br>
Joe Gregorio3d55ac52012-02-21 10:11:19 -0500[diff] [blame]52&nbsp;&nbsp;body:&nbsp;object,&nbsp;The&nbsp;request&nbsp;body.&nbsp;(required)<br>
53&nbsp;&nbsp;&nbsp;&nbsp;The&nbsp;object&nbsp;takes&nbsp;the&nbsp;form&nbsp;of:<br>
54&nbsp;<br>
55{<br>
56&nbsp;&nbsp;&nbsp;&nbsp;"verificationMethod":&nbsp;"A&nbsp;String",&nbsp;#&nbsp;The&nbsp;verification&nbsp;method&nbsp;that&nbsp;will&nbsp;be&nbsp;used&nbsp;to&nbsp;verify&nbsp;this&nbsp;site.&nbsp;For&nbsp;sites,&nbsp;'FILE'&nbsp;or&nbsp;'META'&nbsp;methods&nbsp;may&nbsp;be&nbsp;used.&nbsp;For&nbsp;domains,&nbsp;only&nbsp;'DNS'&nbsp;may&nbsp;be&nbsp;used.<br>
57&nbsp;&nbsp;&nbsp;&nbsp;"site":&nbsp;{&nbsp;#&nbsp;The&nbsp;site&nbsp;for&nbsp;which&nbsp;a&nbsp;verification&nbsp;token&nbsp;will&nbsp;be&nbsp;generated.<br>
58&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"identifier":&nbsp;"A&nbsp;String",&nbsp;#&nbsp;The&nbsp;site&nbsp;identifier.&nbsp;If&nbsp;the&nbsp;type&nbsp;is&nbsp;set&nbsp;to&nbsp;SITE,&nbsp;the&nbsp;identifier&nbsp;is&nbsp;a&nbsp;URL.&nbsp;If&nbsp;the&nbsp;type&nbsp;is&nbsp;set&nbsp;to&nbsp;INET_DOMAIN,&nbsp;the&nbsp;site&nbsp;identifier&nbsp;is&nbsp;a&nbsp;domain&nbsp;name.<br>
59&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"type":&nbsp;"A&nbsp;String",&nbsp;#&nbsp;The&nbsp;type&nbsp;of&nbsp;resource&nbsp;to&nbsp;be&nbsp;verified.&nbsp;Can&nbsp;be&nbsp;SITE&nbsp;or&nbsp;INET_DOMAIN&nbsp;(domain&nbsp;name).<br>
60&nbsp;&nbsp;&nbsp;&nbsp;},<br>
61&nbsp;&nbsp;}<br>
62&nbsp;<br>
Joe Gregorio66212032012-06-14 09:10:14 -0400[diff] [blame]63&nbsp;&nbsp;pp:&nbsp;string,&nbsp;A&nbsp;parameter<br>
64&nbsp;&nbsp;trace:&nbsp;string,&nbsp;A&nbsp;parameter<br>
65&nbsp;&nbsp;strict:&nbsp;string,&nbsp;A&nbsp;parameter<br>
66&nbsp;&nbsp;userip:&nbsp;string,&nbsp;A&nbsp;parameter<br>
Joe Gregoriob417caf2011-12-08 12:04:24 -0500[diff] [blame]67&nbsp;<br>
68Returns:<br>
69&nbsp;&nbsp;An&nbsp;object&nbsp;of&nbsp;the&nbsp;form<br>
70&nbsp;<br>
71&nbsp;&nbsp;&nbsp;&nbsp;{<br>
72&nbsp;&nbsp;&nbsp;&nbsp;"token":&nbsp;"A&nbsp;String",&nbsp;#&nbsp;The&nbsp;verification&nbsp;token.&nbsp;The&nbsp;token&nbsp;must&nbsp;be&nbsp;placed&nbsp;appropriately&nbsp;in&nbsp;order&nbsp;for&nbsp;verification&nbsp;to&nbsp;succeed.<br>
73&nbsp;&nbsp;&nbsp;&nbsp;"method":&nbsp;"A&nbsp;String",&nbsp;#&nbsp;The&nbsp;verification&nbsp;method&nbsp;to&nbsp;use&nbsp;in&nbsp;conjunction&nbsp;with&nbsp;this&nbsp;token.&nbsp;For&nbsp;FILE,&nbsp;the&nbsp;token&nbsp;should&nbsp;be&nbsp;placed&nbsp;in&nbsp;the&nbsp;top-level&nbsp;directory&nbsp;of&nbsp;the&nbsp;site,&nbsp;stored&nbsp;inside&nbsp;a&nbsp;file&nbsp;of&nbsp;the&nbsp;same&nbsp;name.&nbsp;For&nbsp;META,&nbsp;the&nbsp;token&nbsp;should&nbsp;be&nbsp;placed&nbsp;in&nbsp;the&nbsp;HEAD&nbsp;tag&nbsp;of&nbsp;the&nbsp;default&nbsp;page&nbsp;that&nbsp;is&nbsp;loaded&nbsp;for&nbsp;the&nbsp;site.&nbsp;For&nbsp;DNS,&nbsp;the&nbsp;token&nbsp;should&nbsp;be&nbsp;placed&nbsp;in&nbsp;a&nbsp;TXT&nbsp;record&nbsp;of&nbsp;the&nbsp;domain.<br>
74&nbsp;&nbsp;}</tt></dd></dl>
Joe Gregorio351b1492011-05-08 23:32:46 -0700[diff] [blame]75
76<dl><dt><a name="Resource-insert"><strong>insert</strong></a> = method(self, **kwargs)</dt><dd><tt>Attempt&nbsp;verification&nbsp;of&nbsp;a&nbsp;website&nbsp;or&nbsp;domain.<br>
77&nbsp;<br>
78Args:<br>
79&nbsp;&nbsp;body:&nbsp;object,&nbsp;The&nbsp;request&nbsp;body.&nbsp;(required)<br>
Joe Gregoriob417caf2011-12-08 12:04:24 -0500[diff] [blame]80&nbsp;&nbsp;&nbsp;&nbsp;The&nbsp;object&nbsp;takes&nbsp;the&nbsp;form&nbsp;of:<br>
81&nbsp;<br>
82{<br>
83&nbsp;&nbsp;&nbsp;&nbsp;"owners":&nbsp;[&nbsp;#&nbsp;The&nbsp;email&nbsp;addresses&nbsp;of&nbsp;all&nbsp;verified&nbsp;owners.<br>
84&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"A&nbsp;String",<br>
85&nbsp;&nbsp;&nbsp;&nbsp;],<br>
86&nbsp;&nbsp;&nbsp;&nbsp;"id":&nbsp;"A&nbsp;String",&nbsp;#&nbsp;The&nbsp;string&nbsp;used&nbsp;to&nbsp;identify&nbsp;this&nbsp;site.&nbsp;This&nbsp;value&nbsp;should&nbsp;be&nbsp;used&nbsp;in&nbsp;the&nbsp;"id"&nbsp;portion&nbsp;of&nbsp;the&nbsp;REST&nbsp;URL&nbsp;for&nbsp;the&nbsp;Get,&nbsp;Update,&nbsp;and&nbsp;Delete&nbsp;operations.<br>
87&nbsp;&nbsp;&nbsp;&nbsp;"site":&nbsp;{&nbsp;#&nbsp;The&nbsp;address&nbsp;and&nbsp;type&nbsp;of&nbsp;a&nbsp;site&nbsp;that&nbsp;is&nbsp;verified&nbsp;or&nbsp;will&nbsp;be&nbsp;verified.<br>
88&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"identifier":&nbsp;"A&nbsp;String",&nbsp;#&nbsp;The&nbsp;site&nbsp;identifier.&nbsp;If&nbsp;the&nbsp;type&nbsp;is&nbsp;set&nbsp;to&nbsp;SITE,&nbsp;the&nbsp;identifier&nbsp;is&nbsp;a&nbsp;URL.&nbsp;If&nbsp;the&nbsp;type&nbsp;is&nbsp;set&nbsp;to&nbsp;INET_DOMAIN,&nbsp;the&nbsp;site&nbsp;identifier&nbsp;is&nbsp;a&nbsp;domain&nbsp;name.<br>
89&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"type":&nbsp;"A&nbsp;String",&nbsp;#&nbsp;The&nbsp;site&nbsp;type.&nbsp;Can&nbsp;be&nbsp;SITE&nbsp;or&nbsp;INET_DOMAIN&nbsp;(domain&nbsp;name).<br>
90&nbsp;&nbsp;&nbsp;&nbsp;},<br>
91&nbsp;&nbsp;}<br>
92&nbsp;<br>
Joe Gregorio66212032012-06-14 09:10:14 -0400[diff] [blame]93&nbsp;&nbsp;pp:&nbsp;string,&nbsp;A&nbsp;parameter<br>
94&nbsp;&nbsp;trace:&nbsp;string,&nbsp;A&nbsp;parameter<br>
Joe Gregoriob417caf2011-12-08 12:04:24 -0500[diff] [blame]95&nbsp;&nbsp;verificationMethod:&nbsp;string,&nbsp;The&nbsp;method&nbsp;to&nbsp;use&nbsp;for&nbsp;verifying&nbsp;a&nbsp;site&nbsp;or&nbsp;domain.&nbsp;(required)<br>
Joe Gregorio66212032012-06-14 09:10:14 -0400[diff] [blame]96&nbsp;&nbsp;strict:&nbsp;string,&nbsp;A&nbsp;parameter<br>
97&nbsp;&nbsp;userip:&nbsp;string,&nbsp;A&nbsp;parameter<br>
Joe Gregoriob417caf2011-12-08 12:04:24 -0500[diff] [blame]98&nbsp;<br>
99Returns:<br>
100&nbsp;&nbsp;An&nbsp;object&nbsp;of&nbsp;the&nbsp;form<br>
101&nbsp;<br>
102&nbsp;&nbsp;&nbsp;&nbsp;{<br>
103&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"owners":&nbsp;[&nbsp;#&nbsp;The&nbsp;email&nbsp;addresses&nbsp;of&nbsp;all&nbsp;verified&nbsp;owners.<br>
104&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"A&nbsp;String",<br>
105&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;],<br>
106&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"id":&nbsp;"A&nbsp;String",&nbsp;#&nbsp;The&nbsp;string&nbsp;used&nbsp;to&nbsp;identify&nbsp;this&nbsp;site.&nbsp;This&nbsp;value&nbsp;should&nbsp;be&nbsp;used&nbsp;in&nbsp;the&nbsp;"id"&nbsp;portion&nbsp;of&nbsp;the&nbsp;REST&nbsp;URL&nbsp;for&nbsp;the&nbsp;Get,&nbsp;Update,&nbsp;and&nbsp;Delete&nbsp;operations.<br>
107&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"site":&nbsp;{&nbsp;#&nbsp;The&nbsp;address&nbsp;and&nbsp;type&nbsp;of&nbsp;a&nbsp;site&nbsp;that&nbsp;is&nbsp;verified&nbsp;or&nbsp;will&nbsp;be&nbsp;verified.<br>
108&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"identifier":&nbsp;"A&nbsp;String",&nbsp;#&nbsp;The&nbsp;site&nbsp;identifier.&nbsp;If&nbsp;the&nbsp;type&nbsp;is&nbsp;set&nbsp;to&nbsp;SITE,&nbsp;the&nbsp;identifier&nbsp;is&nbsp;a&nbsp;URL.&nbsp;If&nbsp;the&nbsp;type&nbsp;is&nbsp;set&nbsp;to&nbsp;INET_DOMAIN,&nbsp;the&nbsp;site&nbsp;identifier&nbsp;is&nbsp;a&nbsp;domain&nbsp;name.<br>
109&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"type":&nbsp;"A&nbsp;String",&nbsp;#&nbsp;The&nbsp;site&nbsp;type.&nbsp;Can&nbsp;be&nbsp;SITE&nbsp;or&nbsp;INET_DOMAIN&nbsp;(domain&nbsp;name).<br>
110&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;},<br>
111&nbsp;&nbsp;&nbsp;&nbsp;}</tt></dd></dl>
Joe Gregorio351b1492011-05-08 23:32:46 -0700[diff] [blame]112
113<dl><dt><a name="Resource-list"><strong>list</strong></a> = method(self, **kwargs)</dt><dd><tt>Get&nbsp;the&nbsp;list&nbsp;of&nbsp;your&nbsp;verified&nbsp;websites&nbsp;and&nbsp;domains.<br>
114&nbsp;<br>
Joe Gregoriob417caf2011-12-08 12:04:24 -0500[diff] [blame]115Args:<br>
Joe Gregorio66212032012-06-14 09:10:14 -0400[diff] [blame]116&nbsp;&nbsp;pp:&nbsp;string,&nbsp;A&nbsp;parameter<br>
117&nbsp;&nbsp;trace:&nbsp;string,&nbsp;A&nbsp;parameter<br>
118&nbsp;&nbsp;strict:&nbsp;string,&nbsp;A&nbsp;parameter<br>
119&nbsp;&nbsp;userip:&nbsp;string,&nbsp;A&nbsp;parameter<br>
Joe Gregoriob417caf2011-12-08 12:04:24 -0500[diff] [blame]120&nbsp;<br>
121Returns:<br>
122&nbsp;&nbsp;An&nbsp;object&nbsp;of&nbsp;the&nbsp;form<br>
123&nbsp;<br>
124&nbsp;&nbsp;&nbsp;&nbsp;{<br>
125&nbsp;&nbsp;&nbsp;&nbsp;"items":&nbsp;[&nbsp;#&nbsp;The&nbsp;list&nbsp;of&nbsp;sites&nbsp;that&nbsp;are&nbsp;owned&nbsp;by&nbsp;the&nbsp;authenticated&nbsp;user.<br>
126&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;{<br>
127&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"owners":&nbsp;[&nbsp;#&nbsp;The&nbsp;email&nbsp;addresses&nbsp;of&nbsp;all&nbsp;verified&nbsp;owners.<br>
128&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"A&nbsp;String",<br>
129&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;],<br>
130&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"id":&nbsp;"A&nbsp;String",&nbsp;#&nbsp;The&nbsp;string&nbsp;used&nbsp;to&nbsp;identify&nbsp;this&nbsp;site.&nbsp;This&nbsp;value&nbsp;should&nbsp;be&nbsp;used&nbsp;in&nbsp;the&nbsp;"id"&nbsp;portion&nbsp;of&nbsp;the&nbsp;REST&nbsp;URL&nbsp;for&nbsp;the&nbsp;Get,&nbsp;Update,&nbsp;and&nbsp;Delete&nbsp;operations.<br>
131&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"site":&nbsp;{&nbsp;#&nbsp;The&nbsp;address&nbsp;and&nbsp;type&nbsp;of&nbsp;a&nbsp;site&nbsp;that&nbsp;is&nbsp;verified&nbsp;or&nbsp;will&nbsp;be&nbsp;verified.<br>
132&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"identifier":&nbsp;"A&nbsp;String",&nbsp;#&nbsp;The&nbsp;site&nbsp;identifier.&nbsp;If&nbsp;the&nbsp;type&nbsp;is&nbsp;set&nbsp;to&nbsp;SITE,&nbsp;the&nbsp;identifier&nbsp;is&nbsp;a&nbsp;URL.&nbsp;If&nbsp;the&nbsp;type&nbsp;is&nbsp;set&nbsp;to&nbsp;INET_DOMAIN,&nbsp;the&nbsp;site&nbsp;identifier&nbsp;is&nbsp;a&nbsp;domain&nbsp;name.<br>
133&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"type":&nbsp;"A&nbsp;String",&nbsp;#&nbsp;The&nbsp;site&nbsp;type.&nbsp;Can&nbsp;be&nbsp;SITE&nbsp;or&nbsp;INET_DOMAIN&nbsp;(domain&nbsp;name).<br>
134&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;},<br>
135&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;},<br>
136&nbsp;&nbsp;&nbsp;&nbsp;],<br>
137&nbsp;&nbsp;}</tt></dd></dl>
Joe Gregorio351b1492011-05-08 23:32:46 -0700[diff] [blame]138
Joe Gregoriob9e63ff2011-06-30 12:38:10 -0400[diff] [blame]139<dl><dt><a name="Resource-patch"><strong>patch</strong></a> = method(self, **kwargs)</dt><dd><tt>Modify&nbsp;the&nbsp;list&nbsp;of&nbsp;owners&nbsp;for&nbsp;your&nbsp;website&nbsp;or&nbsp;domain.&nbsp;This&nbsp;method&nbsp;supports&nbsp;patch&nbsp;semantics.<br>
140&nbsp;<br>
141Args:<br>
142&nbsp;&nbsp;body:&nbsp;object,&nbsp;The&nbsp;request&nbsp;body.&nbsp;(required)<br>
Joe Gregoriob417caf2011-12-08 12:04:24 -0500[diff] [blame]143&nbsp;&nbsp;&nbsp;&nbsp;The&nbsp;object&nbsp;takes&nbsp;the&nbsp;form&nbsp;of:<br>
144&nbsp;<br>
145{<br>
146&nbsp;&nbsp;&nbsp;&nbsp;"owners":&nbsp;[&nbsp;#&nbsp;The&nbsp;email&nbsp;addresses&nbsp;of&nbsp;all&nbsp;verified&nbsp;owners.<br>
147&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"A&nbsp;String",<br>
148&nbsp;&nbsp;&nbsp;&nbsp;],<br>
149&nbsp;&nbsp;&nbsp;&nbsp;"id":&nbsp;"A&nbsp;String",&nbsp;#&nbsp;The&nbsp;string&nbsp;used&nbsp;to&nbsp;identify&nbsp;this&nbsp;site.&nbsp;This&nbsp;value&nbsp;should&nbsp;be&nbsp;used&nbsp;in&nbsp;the&nbsp;"id"&nbsp;portion&nbsp;of&nbsp;the&nbsp;REST&nbsp;URL&nbsp;for&nbsp;the&nbsp;Get,&nbsp;Update,&nbsp;and&nbsp;Delete&nbsp;operations.<br>
150&nbsp;&nbsp;&nbsp;&nbsp;"site":&nbsp;{&nbsp;#&nbsp;The&nbsp;address&nbsp;and&nbsp;type&nbsp;of&nbsp;a&nbsp;site&nbsp;that&nbsp;is&nbsp;verified&nbsp;or&nbsp;will&nbsp;be&nbsp;verified.<br>
151&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"identifier":&nbsp;"A&nbsp;String",&nbsp;#&nbsp;The&nbsp;site&nbsp;identifier.&nbsp;If&nbsp;the&nbsp;type&nbsp;is&nbsp;set&nbsp;to&nbsp;SITE,&nbsp;the&nbsp;identifier&nbsp;is&nbsp;a&nbsp;URL.&nbsp;If&nbsp;the&nbsp;type&nbsp;is&nbsp;set&nbsp;to&nbsp;INET_DOMAIN,&nbsp;the&nbsp;site&nbsp;identifier&nbsp;is&nbsp;a&nbsp;domain&nbsp;name.<br>
152&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"type":&nbsp;"A&nbsp;String",&nbsp;#&nbsp;The&nbsp;site&nbsp;type.&nbsp;Can&nbsp;be&nbsp;SITE&nbsp;or&nbsp;INET_DOMAIN&nbsp;(domain&nbsp;name).<br>
153&nbsp;&nbsp;&nbsp;&nbsp;},<br>
154&nbsp;&nbsp;}<br>
155&nbsp;<br>
Joe Gregorio66212032012-06-14 09:10:14 -0400[diff] [blame]156&nbsp;&nbsp;pp:&nbsp;string,&nbsp;A&nbsp;parameter<br>
157&nbsp;&nbsp;trace:&nbsp;string,&nbsp;A&nbsp;parameter<br>
158&nbsp;&nbsp;strict:&nbsp;string,&nbsp;A&nbsp;parameter<br>
159&nbsp;&nbsp;userip:&nbsp;string,&nbsp;A&nbsp;parameter<br>
Joe Gregoriob417caf2011-12-08 12:04:24 -0500[diff] [blame]160&nbsp;&nbsp;id:&nbsp;string,&nbsp;The&nbsp;id&nbsp;of&nbsp;a&nbsp;verified&nbsp;site&nbsp;or&nbsp;domain.&nbsp;(required)<br>
161&nbsp;<br>
162Returns:<br>
163&nbsp;&nbsp;An&nbsp;object&nbsp;of&nbsp;the&nbsp;form<br>
164&nbsp;<br>
165&nbsp;&nbsp;&nbsp;&nbsp;{<br>
166&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"owners":&nbsp;[&nbsp;#&nbsp;The&nbsp;email&nbsp;addresses&nbsp;of&nbsp;all&nbsp;verified&nbsp;owners.<br>
167&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"A&nbsp;String",<br>
168&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;],<br>
169&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"id":&nbsp;"A&nbsp;String",&nbsp;#&nbsp;The&nbsp;string&nbsp;used&nbsp;to&nbsp;identify&nbsp;this&nbsp;site.&nbsp;This&nbsp;value&nbsp;should&nbsp;be&nbsp;used&nbsp;in&nbsp;the&nbsp;"id"&nbsp;portion&nbsp;of&nbsp;the&nbsp;REST&nbsp;URL&nbsp;for&nbsp;the&nbsp;Get,&nbsp;Update,&nbsp;and&nbsp;Delete&nbsp;operations.<br>
170&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"site":&nbsp;{&nbsp;#&nbsp;The&nbsp;address&nbsp;and&nbsp;type&nbsp;of&nbsp;a&nbsp;site&nbsp;that&nbsp;is&nbsp;verified&nbsp;or&nbsp;will&nbsp;be&nbsp;verified.<br>
171&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"identifier":&nbsp;"A&nbsp;String",&nbsp;#&nbsp;The&nbsp;site&nbsp;identifier.&nbsp;If&nbsp;the&nbsp;type&nbsp;is&nbsp;set&nbsp;to&nbsp;SITE,&nbsp;the&nbsp;identifier&nbsp;is&nbsp;a&nbsp;URL.&nbsp;If&nbsp;the&nbsp;type&nbsp;is&nbsp;set&nbsp;to&nbsp;INET_DOMAIN,&nbsp;the&nbsp;site&nbsp;identifier&nbsp;is&nbsp;a&nbsp;domain&nbsp;name.<br>
172&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"type":&nbsp;"A&nbsp;String",&nbsp;#&nbsp;The&nbsp;site&nbsp;type.&nbsp;Can&nbsp;be&nbsp;SITE&nbsp;or&nbsp;INET_DOMAIN&nbsp;(domain&nbsp;name).<br>
173&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;},<br>
174&nbsp;&nbsp;&nbsp;&nbsp;}</tt></dd></dl>
Joe Gregoriob9e63ff2011-06-30 12:38:10 -0400[diff] [blame]175
Joe Gregorio351b1492011-05-08 23:32:46 -0700[diff] [blame]176<dl><dt><a name="Resource-update"><strong>update</strong></a> = method(self, **kwargs)</dt><dd><tt>Modify&nbsp;the&nbsp;list&nbsp;of&nbsp;owners&nbsp;for&nbsp;your&nbsp;website&nbsp;or&nbsp;domain.<br>
177&nbsp;<br>
178Args:<br>
179&nbsp;&nbsp;body:&nbsp;object,&nbsp;The&nbsp;request&nbsp;body.&nbsp;(required)<br>
Joe Gregoriob417caf2011-12-08 12:04:24 -0500[diff] [blame]180&nbsp;&nbsp;&nbsp;&nbsp;The&nbsp;object&nbsp;takes&nbsp;the&nbsp;form&nbsp;of:<br>
181&nbsp;<br>
182{<br>
183&nbsp;&nbsp;&nbsp;&nbsp;"owners":&nbsp;[&nbsp;#&nbsp;The&nbsp;email&nbsp;addresses&nbsp;of&nbsp;all&nbsp;verified&nbsp;owners.<br>
184&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"A&nbsp;String",<br>
185&nbsp;&nbsp;&nbsp;&nbsp;],<br>
186&nbsp;&nbsp;&nbsp;&nbsp;"id":&nbsp;"A&nbsp;String",&nbsp;#&nbsp;The&nbsp;string&nbsp;used&nbsp;to&nbsp;identify&nbsp;this&nbsp;site.&nbsp;This&nbsp;value&nbsp;should&nbsp;be&nbsp;used&nbsp;in&nbsp;the&nbsp;"id"&nbsp;portion&nbsp;of&nbsp;the&nbsp;REST&nbsp;URL&nbsp;for&nbsp;the&nbsp;Get,&nbsp;Update,&nbsp;and&nbsp;Delete&nbsp;operations.<br>
187&nbsp;&nbsp;&nbsp;&nbsp;"site":&nbsp;{&nbsp;#&nbsp;The&nbsp;address&nbsp;and&nbsp;type&nbsp;of&nbsp;a&nbsp;site&nbsp;that&nbsp;is&nbsp;verified&nbsp;or&nbsp;will&nbsp;be&nbsp;verified.<br>
188&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"identifier":&nbsp;"A&nbsp;String",&nbsp;#&nbsp;The&nbsp;site&nbsp;identifier.&nbsp;If&nbsp;the&nbsp;type&nbsp;is&nbsp;set&nbsp;to&nbsp;SITE,&nbsp;the&nbsp;identifier&nbsp;is&nbsp;a&nbsp;URL.&nbsp;If&nbsp;the&nbsp;type&nbsp;is&nbsp;set&nbsp;to&nbsp;INET_DOMAIN,&nbsp;the&nbsp;site&nbsp;identifier&nbsp;is&nbsp;a&nbsp;domain&nbsp;name.<br>
189&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"type":&nbsp;"A&nbsp;String",&nbsp;#&nbsp;The&nbsp;site&nbsp;type.&nbsp;Can&nbsp;be&nbsp;SITE&nbsp;or&nbsp;INET_DOMAIN&nbsp;(domain&nbsp;name).<br>
190&nbsp;&nbsp;&nbsp;&nbsp;},<br>
191&nbsp;&nbsp;}<br>
192&nbsp;<br>
Joe Gregorio66212032012-06-14 09:10:14 -0400[diff] [blame]193&nbsp;&nbsp;pp:&nbsp;string,&nbsp;A&nbsp;parameter<br>
194&nbsp;&nbsp;trace:&nbsp;string,&nbsp;A&nbsp;parameter<br>
195&nbsp;&nbsp;strict:&nbsp;string,&nbsp;A&nbsp;parameter<br>
196&nbsp;&nbsp;userip:&nbsp;string,&nbsp;A&nbsp;parameter<br>
Joe Gregoriob417caf2011-12-08 12:04:24 -0500[diff] [blame]197&nbsp;&nbsp;id:&nbsp;string,&nbsp;The&nbsp;id&nbsp;of&nbsp;a&nbsp;verified&nbsp;site&nbsp;or&nbsp;domain.&nbsp;(required)<br>
198&nbsp;<br>
199Returns:<br>
200&nbsp;&nbsp;An&nbsp;object&nbsp;of&nbsp;the&nbsp;form<br>
201&nbsp;<br>
202&nbsp;&nbsp;&nbsp;&nbsp;{<br>
203&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"owners":&nbsp;[&nbsp;#&nbsp;The&nbsp;email&nbsp;addresses&nbsp;of&nbsp;all&nbsp;verified&nbsp;owners.<br>
204&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"A&nbsp;String",<br>
205&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;],<br>
206&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"id":&nbsp;"A&nbsp;String",&nbsp;#&nbsp;The&nbsp;string&nbsp;used&nbsp;to&nbsp;identify&nbsp;this&nbsp;site.&nbsp;This&nbsp;value&nbsp;should&nbsp;be&nbsp;used&nbsp;in&nbsp;the&nbsp;"id"&nbsp;portion&nbsp;of&nbsp;the&nbsp;REST&nbsp;URL&nbsp;for&nbsp;the&nbsp;Get,&nbsp;Update,&nbsp;and&nbsp;Delete&nbsp;operations.<br>
207&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"site":&nbsp;{&nbsp;#&nbsp;The&nbsp;address&nbsp;and&nbsp;type&nbsp;of&nbsp;a&nbsp;site&nbsp;that&nbsp;is&nbsp;verified&nbsp;or&nbsp;will&nbsp;be&nbsp;verified.<br>
208&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"identifier":&nbsp;"A&nbsp;String",&nbsp;#&nbsp;The&nbsp;site&nbsp;identifier.&nbsp;If&nbsp;the&nbsp;type&nbsp;is&nbsp;set&nbsp;to&nbsp;SITE,&nbsp;the&nbsp;identifier&nbsp;is&nbsp;a&nbsp;URL.&nbsp;If&nbsp;the&nbsp;type&nbsp;is&nbsp;set&nbsp;to&nbsp;INET_DOMAIN,&nbsp;the&nbsp;site&nbsp;identifier&nbsp;is&nbsp;a&nbsp;domain&nbsp;name.<br>
209&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"type":&nbsp;"A&nbsp;String",&nbsp;#&nbsp;The&nbsp;site&nbsp;type.&nbsp;Can&nbsp;be&nbsp;SITE&nbsp;or&nbsp;INET_DOMAIN&nbsp;(domain&nbsp;name).<br>
210&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;},<br>
211&nbsp;&nbsp;&nbsp;&nbsp;}</tt></dd></dl>
Joe Gregorio351b1492011-05-08 23:32:46 -0700[diff] [blame]212
213<hr>
214Data descriptors defined here:<br>
215<dl><dt><strong>__dict__</strong></dt>
216<dd><tt>dictionary&nbsp;for&nbsp;instance&nbsp;variables&nbsp;(if&nbsp;defined)</tt></dd>
217</dl>
218<dl><dt><strong>__weakref__</strong></dt>
219<dd><tt>list&nbsp;of&nbsp;weak&nbsp;references&nbsp;to&nbsp;the&nbsp;object&nbsp;(if&nbsp;defined)</tt></dd>
220</dl>
221</td></tr></table>
222</body></html>