lemboy-google-api-client 0.9.26

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (555) hide show
  1. checksums.yaml +7 -0
  2. data/.gitignore +20 -0
  3. data/.rspec +2 -0
  4. data/.rubocop.yml +7 -0
  5. data/.rubocop_todo.yml +63 -0
  6. data/.travis.yml +27 -0
  7. data/.yardopts +12 -0
  8. data/CHANGELOG.md +309 -0
  9. data/CONTRIBUTING.md +31 -0
  10. data/Gemfile +53 -0
  11. data/LICENSE +202 -0
  12. data/MIGRATING.md +171 -0
  13. data/README.md +327 -0
  14. data/Rakefile +2 -0
  15. data/api_names.yaml +36215 -0
  16. data/bin/generate-api +109 -0
  17. data/generated/google/apis/adexchangebuyer2_v2beta1.rb +35 -0
  18. data/generated/google/apis/adexchangebuyer2_v2beta1/classes.rb +298 -0
  19. data/generated/google/apis/adexchangebuyer2_v2beta1/representations.rb +122 -0
  20. data/generated/google/apis/adexchangebuyer2_v2beta1/service.rb +458 -0
  21. data/generated/google/apis/adexchangebuyer_v1_3.rb +35 -0
  22. data/generated/google/apis/adexchangebuyer_v1_3/classes.rb +1335 -0
  23. data/generated/google/apis/adexchangebuyer_v1_3/representations.rb +446 -0
  24. data/generated/google/apis/adexchangebuyer_v1_3/service.rb +872 -0
  25. data/generated/google/apis/adexchangebuyer_v1_4.rb +35 -0
  26. data/generated/google/apis/adexchangebuyer_v1_4/classes.rb +3550 -0
  27. data/generated/google/apis/adexchangebuyer_v1_4/representations.rb +1421 -0
  28. data/generated/google/apis/adexchangebuyer_v1_4/service.rb +1538 -0
  29. data/generated/google/apis/adexchangeseller_v2_0.rb +37 -0
  30. data/generated/google/apis/adexchangeseller_v2_0/classes.rb +792 -0
  31. data/generated/google/apis/adexchangeseller_v2_0/representations.rb +347 -0
  32. data/generated/google/apis/adexchangeseller_v2_0/service.rb +667 -0
  33. data/generated/google/apis/admin_datatransfer_v1.rb +37 -0
  34. data/generated/google/apis/admin_datatransfer_v1/classes.rb +267 -0
  35. data/generated/google/apis/admin_datatransfer_v1/representations.rb +130 -0
  36. data/generated/google/apis/admin_datatransfer_v1/service.rb +262 -0
  37. data/generated/google/apis/admin_directory_v1.rb +113 -0
  38. data/generated/google/apis/admin_directory_v1/classes.rb +3241 -0
  39. data/generated/google/apis/admin_directory_v1/representations.rb +1172 -0
  40. data/generated/google/apis/admin_directory_v1/service.rb +3857 -0
  41. data/generated/google/apis/admin_reports_v1.rb +38 -0
  42. data/generated/google/apis/admin_reports_v1/classes.rb +582 -0
  43. data/generated/google/apis/admin_reports_v1/representations.rb +257 -0
  44. data/generated/google/apis/admin_reports_v1/service.rb +336 -0
  45. data/generated/google/apis/adsense_v1_4.rb +37 -0
  46. data/generated/google/apis/adsense_v1_4/classes.rb +1280 -0
  47. data/generated/google/apis/adsense_v1_4/representations.rb +555 -0
  48. data/generated/google/apis/adsense_v1_4/service.rb +1713 -0
  49. data/generated/google/apis/adsensehost_v4_1.rb +35 -0
  50. data/generated/google/apis/adsensehost_v4_1/classes.rb +836 -0
  51. data/generated/google/apis/adsensehost_v4_1/representations.rb +367 -0
  52. data/generated/google/apis/adsensehost_v4_1/service.rb +1164 -0
  53. data/generated/google/apis/analytics_v3.rb +49 -0
  54. data/generated/google/apis/analytics_v3/classes.rb +5536 -0
  55. data/generated/google/apis/analytics_v3/representations.rb +1992 -0
  56. data/generated/google/apis/analytics_v3/service.rb +3785 -0
  57. data/generated/google/apis/analyticsreporting_v4.rb +37 -0
  58. data/generated/google/apis/analyticsreporting_v4/classes.rb +1420 -0
  59. data/generated/google/apis/analyticsreporting_v4/representations.rb +598 -0
  60. data/generated/google/apis/analyticsreporting_v4/service.rb +88 -0
  61. data/generated/google/apis/androidenterprise_v1.rb +34 -0
  62. data/generated/google/apis/androidenterprise_v1/classes.rb +2250 -0
  63. data/generated/google/apis/androidenterprise_v1/representations.rb +970 -0
  64. data/generated/google/apis/androidenterprise_v1/service.rb +3267 -0
  65. data/generated/google/apis/androidpublisher_v2.rb +34 -0
  66. data/generated/google/apis/androidpublisher_v2/classes.rb +1941 -0
  67. data/generated/google/apis/androidpublisher_v2/representations.rb +975 -0
  68. data/generated/google/apis/androidpublisher_v2/service.rb +2572 -0
  69. data/generated/google/apis/appengine_v1beta4.rb +35 -0
  70. data/generated/google/apis/appengine_v1beta4/classes.rb +1585 -0
  71. data/generated/google/apis/appengine_v1beta4/representations.rb +542 -0
  72. data/generated/google/apis/appengine_v1beta4/service.rb +477 -0
  73. data/generated/google/apis/appengine_v1beta5.rb +40 -0
  74. data/generated/google/apis/appengine_v1beta5/classes.rb +1984 -0
  75. data/generated/google/apis/appengine_v1beta5/representations.rb +765 -0
  76. data/generated/google/apis/appengine_v1beta5/service.rb +864 -0
  77. data/generated/google/apis/appsactivity_v1.rb +46 -0
  78. data/generated/google/apis/appsactivity_v1/classes.rb +415 -0
  79. data/generated/google/apis/appsactivity_v1/representations.rb +209 -0
  80. data/generated/google/apis/appsactivity_v1/service.rb +128 -0
  81. data/generated/google/apis/appstate_v1.rb +34 -0
  82. data/generated/google/apis/appstate_v1/classes.rb +154 -0
  83. data/generated/google/apis/appstate_v1/representations.rb +87 -0
  84. data/generated/google/apis/appstate_v1/service.rb +260 -0
  85. data/generated/google/apis/autoscaler_v1beta2.rb +38 -0
  86. data/generated/google/apis/autoscaler_v1beta2/classes.rb +710 -0
  87. data/generated/google/apis/autoscaler_v1beta2/representations.rb +296 -0
  88. data/generated/google/apis/autoscaler_v1beta2/service.rb +478 -0
  89. data/generated/google/apis/bigquery_v2.rb +52 -0
  90. data/generated/google/apis/bigquery_v2/classes.rb +3081 -0
  91. data/generated/google/apis/bigquery_v2/representations.rb +1094 -0
  92. data/generated/google/apis/bigquery_v2/service.rb +988 -0
  93. data/generated/google/apis/blogger_v3.rb +37 -0
  94. data/generated/google/apis/blogger_v3/classes.rb +1354 -0
  95. data/generated/google/apis/blogger_v3/representations.rb +632 -0
  96. data/generated/google/apis/blogger_v3/service.rb +1587 -0
  97. data/generated/google/apis/books_v1.rb +34 -0
  98. data/generated/google/apis/books_v1/classes.rb +4160 -0
  99. data/generated/google/apis/books_v1/representations.rb +1799 -0
  100. data/generated/google/apis/books_v1/service.rb +2300 -0
  101. data/generated/google/apis/calendar_v3.rb +37 -0
  102. data/generated/google/apis/calendar_v3/classes.rb +1742 -0
  103. data/generated/google/apis/calendar_v3/representations.rb +631 -0
  104. data/generated/google/apis/calendar_v3/service.rb +1968 -0
  105. data/generated/google/apis/civicinfo_v2.rb +32 -0
  106. data/generated/google/apis/civicinfo_v2/classes.rb +1499 -0
  107. data/generated/google/apis/civicinfo_v2/representations.rb +572 -0
  108. data/generated/google/apis/civicinfo_v2/service.rb +300 -0
  109. data/generated/google/apis/classroom_v1.rb +70 -0
  110. data/generated/google/apis/classroom_v1/classes.rb +1572 -0
  111. data/generated/google/apis/classroom_v1/representations.rb +729 -0
  112. data/generated/google/apis/classroom_v1/service.rb +1945 -0
  113. data/generated/google/apis/classroom_v1beta1.rb +49 -0
  114. data/generated/google/apis/classroom_v1beta1/classes.rb +447 -0
  115. data/generated/google/apis/classroom_v1beta1/representations.rb +190 -0
  116. data/generated/google/apis/classroom_v1beta1/service.rb +791 -0
  117. data/generated/google/apis/cloudbilling_v1.rb +35 -0
  118. data/generated/google/apis/cloudbilling_v1/classes.rb +169 -0
  119. data/generated/google/apis/cloudbilling_v1/representations.rb +87 -0
  120. data/generated/google/apis/cloudbilling_v1/service.rb +258 -0
  121. data/generated/google/apis/cloudbuild_v1.rb +34 -0
  122. data/generated/google/apis/cloudbuild_v1/classes.rb +919 -0
  123. data/generated/google/apis/cloudbuild_v1/representations.rb +364 -0
  124. data/generated/google/apis/cloudbuild_v1/service.rb +492 -0
  125. data/generated/google/apis/clouddebugger_v2.rb +38 -0
  126. data/generated/google/apis/clouddebugger_v2/classes.rb +1081 -0
  127. data/generated/google/apis/clouddebugger_v2/representations.rb +465 -0
  128. data/generated/google/apis/clouddebugger_v2/service.rb +396 -0
  129. data/generated/google/apis/cloudkms_v1beta1.rb +34 -0
  130. data/generated/google/apis/cloudkms_v1beta1/classes.rb +999 -0
  131. data/generated/google/apis/cloudkms_v1beta1/representations.rb +448 -0
  132. data/generated/google/apis/cloudkms_v1beta1/service.rb +932 -0
  133. data/generated/google/apis/cloudlatencytest_v2.rb +34 -0
  134. data/generated/google/apis/cloudlatencytest_v2/classes.rb +195 -0
  135. data/generated/google/apis/cloudlatencytest_v2/representations.rb +127 -0
  136. data/generated/google/apis/cloudlatencytest_v2/service.rb +135 -0
  137. data/generated/google/apis/cloudmonitoring_v2beta2.rb +37 -0
  138. data/generated/google/apis/cloudmonitoring_v2beta2/classes.rb +679 -0
  139. data/generated/google/apis/cloudmonitoring_v2beta2/representations.rb +353 -0
  140. data/generated/google/apis/cloudmonitoring_v2beta2/service.rb +452 -0
  141. data/generated/google/apis/cloudresourcemanager_v1.rb +38 -0
  142. data/generated/google/apis/cloudresourcemanager_v1/classes.rb +886 -0
  143. data/generated/google/apis/cloudresourcemanager_v1/representations.rb +359 -0
  144. data/generated/google/apis/cloudresourcemanager_v1/service.rb +686 -0
  145. data/generated/google/apis/cloudresourcemanager_v1beta1.rb +38 -0
  146. data/generated/google/apis/cloudresourcemanager_v1beta1/classes.rb +682 -0
  147. data/generated/google/apis/cloudresourcemanager_v1beta1/representations.rb +312 -0
  148. data/generated/google/apis/cloudresourcemanager_v1beta1/service.rb +710 -0
  149. data/generated/google/apis/cloudtrace_v1.rb +43 -0
  150. data/generated/google/apis/cloudtrace_v1/classes.rb +188 -0
  151. data/generated/google/apis/cloudtrace_v1/representations.rb +102 -0
  152. data/generated/google/apis/cloudtrace_v1/service.rb +192 -0
  153. data/generated/google/apis/clouduseraccounts_beta.rb +44 -0
  154. data/generated/google/apis/clouduseraccounts_beta/classes.rb +845 -0
  155. data/generated/google/apis/clouduseraccounts_beta/representations.rb +352 -0
  156. data/generated/google/apis/clouduseraccounts_beta/service.rb +907 -0
  157. data/generated/google/apis/compute_beta.rb +49 -0
  158. data/generated/google/apis/compute_beta/classes.rb +12261 -0
  159. data/generated/google/apis/compute_beta/representations.rb +4615 -0
  160. data/generated/google/apis/compute_beta/service.rb +15330 -0
  161. data/generated/google/apis/compute_v1.rb +49 -0
  162. data/generated/google/apis/compute_v1/classes.rb +11179 -0
  163. data/generated/google/apis/compute_v1/representations.rb +4203 -0
  164. data/generated/google/apis/compute_v1/service.rb +12937 -0
  165. data/generated/google/apis/container_v1.rb +35 -0
  166. data/generated/google/apis/container_v1/classes.rb +1040 -0
  167. data/generated/google/apis/container_v1/representations.rb +415 -0
  168. data/generated/google/apis/container_v1/service.rb +659 -0
  169. data/generated/google/apis/container_v1beta1.rb +35 -0
  170. data/generated/google/apis/container_v1beta1/classes.rb +466 -0
  171. data/generated/google/apis/container_v1beta1/representations.rb +177 -0
  172. data/generated/google/apis/container_v1beta1/service.rb +394 -0
  173. data/generated/google/apis/content_v2.rb +35 -0
  174. data/generated/google/apis/content_v2/classes.rb +6887 -0
  175. data/generated/google/apis/content_v2/representations.rb +2963 -0
  176. data/generated/google/apis/content_v2/service.rb +2653 -0
  177. data/generated/google/apis/coordinate_v1.rb +37 -0
  178. data/generated/google/apis/coordinate_v1/classes.rb +669 -0
  179. data/generated/google/apis/coordinate_v1/representations.rb +321 -0
  180. data/generated/google/apis/coordinate_v1/service.rb +678 -0
  181. data/generated/google/apis/customsearch_v1.rb +31 -0
  182. data/generated/google/apis/customsearch_v1/classes.rb +771 -0
  183. data/generated/google/apis/customsearch_v1/representations.rb +302 -0
  184. data/generated/google/apis/customsearch_v1/service.rb +207 -0
  185. data/generated/google/apis/dataflow_v1b3.rb +37 -0
  186. data/generated/google/apis/dataflow_v1b3/classes.rb +4225 -0
  187. data/generated/google/apis/dataflow_v1b3/representations.rb +1809 -0
  188. data/generated/google/apis/dataflow_v1b3/service.rb +874 -0
  189. data/generated/google/apis/dataproc_v1.rb +34 -0
  190. data/generated/google/apis/dataproc_v1/classes.rb +1716 -0
  191. data/generated/google/apis/dataproc_v1/representations.rb +678 -0
  192. data/generated/google/apis/dataproc_v1/service.rb +670 -0
  193. data/generated/google/apis/datastore_v1.rb +38 -0
  194. data/generated/google/apis/datastore_v1/classes.rb +1289 -0
  195. data/generated/google/apis/datastore_v1/representations.rb +572 -0
  196. data/generated/google/apis/datastore_v1/service.rb +259 -0
  197. data/generated/google/apis/datastore_v1beta2.rb +40 -0
  198. data/generated/google/apis/datastore_v1beta2/classes.rb +1186 -0
  199. data/generated/google/apis/datastore_v1beta2/representations.rb +594 -0
  200. data/generated/google/apis/datastore_v1beta2/service.rb +294 -0
  201. data/generated/google/apis/datastore_v1beta3.rb +38 -0
  202. data/generated/google/apis/datastore_v1beta3/classes.rb +1284 -0
  203. data/generated/google/apis/datastore_v1beta3/representations.rb +572 -0
  204. data/generated/google/apis/datastore_v1beta3/service.rb +259 -0
  205. data/generated/google/apis/deploymentmanager_v2.rb +43 -0
  206. data/generated/google/apis/deploymentmanager_v2/classes.rb +1582 -0
  207. data/generated/google/apis/deploymentmanager_v2/representations.rb +686 -0
  208. data/generated/google/apis/deploymentmanager_v2/service.rb +1026 -0
  209. data/generated/google/apis/deploymentmanager_v2beta2.rb +44 -0
  210. data/generated/google/apis/deploymentmanager_v2beta2/classes.rb +843 -0
  211. data/generated/google/apis/deploymentmanager_v2beta2/representations.rb +306 -0
  212. data/generated/google/apis/deploymentmanager_v2beta2/service.rb +689 -0
  213. data/generated/google/apis/dfareporting_v2_1.rb +37 -0
  214. data/generated/google/apis/dfareporting_v2_1/classes.rb +10770 -0
  215. data/generated/google/apis/dfareporting_v2_1/representations.rb +3438 -0
  216. data/generated/google/apis/dfareporting_v2_1/service.rb +8585 -0
  217. data/generated/google/apis/dfareporting_v2_3.rb +37 -0
  218. data/generated/google/apis/dfareporting_v2_3/classes.rb +10839 -0
  219. data/generated/google/apis/dfareporting_v2_3/representations.rb +3829 -0
  220. data/generated/google/apis/dfareporting_v2_3/service.rb +8581 -0
  221. data/generated/google/apis/dfareporting_v2_5.rb +40 -0
  222. data/generated/google/apis/dfareporting_v2_5/classes.rb +11225 -0
  223. data/generated/google/apis/dfareporting_v2_5/representations.rb +3982 -0
  224. data/generated/google/apis/dfareporting_v2_5/service.rb +8755 -0
  225. data/generated/google/apis/dfareporting_v2_6.rb +40 -0
  226. data/generated/google/apis/dfareporting_v2_6/classes.rb +11586 -0
  227. data/generated/google/apis/dfareporting_v2_6/representations.rb +4119 -0
  228. data/generated/google/apis/dfareporting_v2_6/service.rb +9025 -0
  229. data/generated/google/apis/dfareporting_v2_7.rb +40 -0
  230. data/generated/google/apis/dfareporting_v2_7/classes.rb +11876 -0
  231. data/generated/google/apis/dfareporting_v2_7/representations.rb +4243 -0
  232. data/generated/google/apis/dfareporting_v2_7/service.rb +9095 -0
  233. data/generated/google/apis/discovery_v1.rb +32 -0
  234. data/generated/google/apis/discovery_v1/classes.rb +961 -0
  235. data/generated/google/apis/discovery_v1/representations.rb +397 -0
  236. data/generated/google/apis/discovery_v1/service.rb +142 -0
  237. data/generated/google/apis/dns_v1.rb +43 -0
  238. data/generated/google/apis/dns_v1/classes.rb +406 -0
  239. data/generated/google/apis/dns_v1/representations.rb +167 -0
  240. data/generated/google/apis/dns_v1/service.rb +453 -0
  241. data/generated/google/apis/dns_v2beta1.rb +43 -0
  242. data/generated/google/apis/dns_v2beta1/classes.rb +915 -0
  243. data/generated/google/apis/dns_v2beta1/representations.rb +368 -0
  244. data/generated/google/apis/dns_v2beta1/service.rb +768 -0
  245. data/generated/google/apis/doubleclickbidmanager_v1.rb +31 -0
  246. data/generated/google/apis/doubleclickbidmanager_v1/classes.rb +795 -0
  247. data/generated/google/apis/doubleclickbidmanager_v1/representations.rb +368 -0
  248. data/generated/google/apis/doubleclickbidmanager_v1/service.rb +376 -0
  249. data/generated/google/apis/doubleclicksearch_v2.rb +35 -0
  250. data/generated/google/apis/doubleclicksearch_v2/classes.rb +960 -0
  251. data/generated/google/apis/doubleclicksearch_v2/representations.rb +350 -0
  252. data/generated/google/apis/doubleclicksearch_v2/service.rb +480 -0
  253. data/generated/google/apis/drive_v2.rb +59 -0
  254. data/generated/google/apis/drive_v2/classes.rb +2633 -0
  255. data/generated/google/apis/drive_v2/representations.rb +885 -0
  256. data/generated/google/apis/drive_v2/service.rb +2754 -0
  257. data/generated/google/apis/drive_v3.rb +56 -0
  258. data/generated/google/apis/drive_v3/classes.rb +1611 -0
  259. data/generated/google/apis/drive_v3/representations.rb +555 -0
  260. data/generated/google/apis/drive_v3/service.rb +1553 -0
  261. data/generated/google/apis/fitness_v1.rb +85 -0
  262. data/generated/google/apis/fitness_v1/classes.rb +943 -0
  263. data/generated/google/apis/fitness_v1/representations.rb +380 -0
  264. data/generated/google/apis/fitness_v1/service.rb +674 -0
  265. data/generated/google/apis/fusiontables_v2.rb +37 -0
  266. data/generated/google/apis/fusiontables_v2/classes.rb +1049 -0
  267. data/generated/google/apis/fusiontables_v2/representations.rb +457 -0
  268. data/generated/google/apis/fusiontables_v2/service.rb +1463 -0
  269. data/generated/google/apis/games_configuration_v1configuration.rb +34 -0
  270. data/generated/google/apis/games_configuration_v1configuration/classes.rb +506 -0
  271. data/generated/google/apis/games_configuration_v1configuration/representations.rb +228 -0
  272. data/generated/google/apis/games_configuration_v1configuration/service.rb +565 -0
  273. data/generated/google/apis/games_management_v1management.rb +37 -0
  274. data/generated/google/apis/games_management_v1management/classes.rb +567 -0
  275. data/generated/google/apis/games_management_v1management/representations.rb +278 -0
  276. data/generated/google/apis/games_management_v1management/service.rb +994 -0
  277. data/generated/google/apis/games_v1.rb +40 -0
  278. data/generated/google/apis/games_v1/classes.rb +4667 -0
  279. data/generated/google/apis/games_v1/representations.rb +1800 -0
  280. data/generated/google/apis/games_v1/service.rb +2449 -0
  281. data/generated/google/apis/gan_v1beta1.rb +31 -0
  282. data/generated/google/apis/gan_v1beta1/classes.rb +1428 -0
  283. data/generated/google/apis/gan_v1beta1/representations.rb +462 -0
  284. data/generated/google/apis/gan_v1beta1/service.rb +682 -0
  285. data/generated/google/apis/genomics_v1.rb +46 -0
  286. data/generated/google/apis/genomics_v1/classes.rb +3477 -0
  287. data/generated/google/apis/genomics_v1/representations.rb +1284 -0
  288. data/generated/google/apis/genomics_v1/service.rb +2207 -0
  289. data/generated/google/apis/genomics_v1beta2.rb +46 -0
  290. data/generated/google/apis/genomics_v1beta2/classes.rb +3288 -0
  291. data/generated/google/apis/genomics_v1beta2/representations.rb +1194 -0
  292. data/generated/google/apis/genomics_v1beta2/service.rb +2392 -0
  293. data/generated/google/apis/gmail_v1.rb +61 -0
  294. data/generated/google/apis/gmail_v1/classes.rb +1382 -0
  295. data/generated/google/apis/gmail_v1/representations.rb +624 -0
  296. data/generated/google/apis/gmail_v1/service.rb +2447 -0
  297. data/generated/google/apis/groupsmigration_v1.rb +34 -0
  298. data/generated/google/apis/groupsmigration_v1/classes.rb +51 -0
  299. data/generated/google/apis/groupsmigration_v1/representations.rb +40 -0
  300. data/generated/google/apis/groupsmigration_v1/service.rb +110 -0
  301. data/generated/google/apis/groupssettings_v1.rb +34 -0
  302. data/generated/google/apis/groupssettings_v1/classes.rb +240 -0
  303. data/generated/google/apis/groupssettings_v1/representations.rb +69 -0
  304. data/generated/google/apis/groupssettings_v1/service.rb +179 -0
  305. data/generated/google/apis/iam_v1.rb +36 -0
  306. data/generated/google/apis/iam_v1/classes.rb +640 -0
  307. data/generated/google/apis/iam_v1/representations.rb +316 -0
  308. data/generated/google/apis/iam_v1/service.rb +554 -0
  309. data/generated/google/apis/identitytoolkit_v3.rb +37 -0
  310. data/generated/google/apis/identitytoolkit_v3/classes.rb +2182 -0
  311. data/generated/google/apis/identitytoolkit_v3/representations.rb +742 -0
  312. data/generated/google/apis/identitytoolkit_v3/service.rb +657 -0
  313. data/generated/google/apis/kgsearch_v1.rb +31 -0
  314. data/generated/google/apis/kgsearch_v1/classes.rb +59 -0
  315. data/generated/google/apis/kgsearch_v1/representations.rb +41 -0
  316. data/generated/google/apis/kgsearch_v1/service.rb +113 -0
  317. data/generated/google/apis/language_v1beta1.rb +36 -0
  318. data/generated/google/apis/language_v1beta1/classes.rb +757 -0
  319. data/generated/google/apis/language_v1beta1/representations.rb +339 -0
  320. data/generated/google/apis/language_v1beta1/service.rb +184 -0
  321. data/generated/google/apis/licensing_v1.rb +34 -0
  322. data/generated/google/apis/licensing_v1/classes.rb +132 -0
  323. data/generated/google/apis/licensing_v1/representations.rb +74 -0
  324. data/generated/google/apis/licensing_v1/service.rb +369 -0
  325. data/generated/google/apis/logging_v1beta3.rb +47 -0
  326. data/generated/google/apis/logging_v1beta3/classes.rb +1079 -0
  327. data/generated/google/apis/logging_v1beta3/representations.rb +366 -0
  328. data/generated/google/apis/logging_v1beta3/service.rb +1001 -0
  329. data/generated/google/apis/logging_v2beta1.rb +46 -0
  330. data/generated/google/apis/logging_v2beta1/classes.rb +1254 -0
  331. data/generated/google/apis/logging_v2beta1/representations.rb +421 -0
  332. data/generated/google/apis/logging_v2beta1/service.rb +788 -0
  333. data/generated/google/apis/manager_v1beta2.rb +53 -0
  334. data/generated/google/apis/manager_v1beta2/classes.rb +1287 -0
  335. data/generated/google/apis/manager_v1beta2/representations.rb +606 -0
  336. data/generated/google/apis/manager_v1beta2/service.rb +372 -0
  337. data/generated/google/apis/manufacturers_v1.rb +34 -0
  338. data/generated/google/apis/manufacturers_v1/classes.rb +258 -0
  339. data/generated/google/apis/manufacturers_v1/representations.rb +103 -0
  340. data/generated/google/apis/manufacturers_v1/service.rb +138 -0
  341. data/generated/google/apis/mirror_v1.rb +37 -0
  342. data/generated/google/apis/mirror_v1/classes.rb +1072 -0
  343. data/generated/google/apis/mirror_v1/representations.rb +390 -0
  344. data/generated/google/apis/mirror_v1/service.rb +977 -0
  345. data/generated/google/apis/monitoring_v3.rb +45 -0
  346. data/generated/google/apis/monitoring_v3/classes.rb +1335 -0
  347. data/generated/google/apis/monitoring_v3/representations.rb +516 -0
  348. data/generated/google/apis/monitoring_v3/service.rb +706 -0
  349. data/generated/google/apis/mybusiness_v3.rb +32 -0
  350. data/generated/google/apis/mybusiness_v3/classes.rb +1864 -0
  351. data/generated/google/apis/mybusiness_v3/representations.rb +741 -0
  352. data/generated/google/apis/mybusiness_v3/service.rb +960 -0
  353. data/generated/google/apis/oauth2_v2.rb +43 -0
  354. data/generated/google/apis/oauth2_v2/classes.rb +245 -0
  355. data/generated/google/apis/oauth2_v2/representations.rb +102 -0
  356. data/generated/google/apis/oauth2_v2/service.rb +199 -0
  357. data/generated/google/apis/pagespeedonline_v2.rb +32 -0
  358. data/generated/google/apis/pagespeedonline_v2/classes.rb +614 -0
  359. data/generated/google/apis/pagespeedonline_v2/representations.rb +272 -0
  360. data/generated/google/apis/pagespeedonline_v2/service.rb +119 -0
  361. data/generated/google/apis/partners_v2.rb +32 -0
  362. data/generated/google/apis/partners_v2/classes.rb +942 -0
  363. data/generated/google/apis/partners_v2/representations.rb +454 -0
  364. data/generated/google/apis/partners_v2/service.rb +400 -0
  365. data/generated/google/apis/people_v1.rb +59 -0
  366. data/generated/google/apis/people_v1/classes.rb +1521 -0
  367. data/generated/google/apis/people_v1/representations.rb +663 -0
  368. data/generated/google/apis/people_v1/service.rb +189 -0
  369. data/generated/google/apis/plus_domains_v1.rb +61 -0
  370. data/generated/google/apis/plus_domains_v1/classes.rb +2609 -0
  371. data/generated/google/apis/plus_domains_v1/representations.rb +1111 -0
  372. data/generated/google/apis/plus_domains_v1/service.rb +904 -0
  373. data/generated/google/apis/plus_v1.rb +43 -0
  374. data/generated/google/apis/plus_v1/classes.rb +2094 -0
  375. data/generated/google/apis/plus_v1/representations.rb +907 -0
  376. data/generated/google/apis/plus_v1/service.rb +470 -0
  377. data/generated/google/apis/prediction_v1_6.rb +47 -0
  378. data/generated/google/apis/prediction_v1_6/classes.rb +751 -0
  379. data/generated/google/apis/prediction_v1_6/representations.rb +369 -0
  380. data/generated/google/apis/prediction_v1_6/service.rb +380 -0
  381. data/generated/google/apis/proximitybeacon_v1beta1.rb +34 -0
  382. data/generated/google/apis/proximitybeacon_v1beta1/classes.rb +786 -0
  383. data/generated/google/apis/proximitybeacon_v1beta1/representations.rb +347 -0
  384. data/generated/google/apis/proximitybeacon_v1beta1/service.rb +806 -0
  385. data/generated/google/apis/pubsub_v1.rb +37 -0
  386. data/generated/google/apis/pubsub_v1/classes.rb +676 -0
  387. data/generated/google/apis/pubsub_v1/representations.rb +323 -0
  388. data/generated/google/apis/pubsub_v1/service.rb +900 -0
  389. data/generated/google/apis/pubsub_v1beta2.rb +37 -0
  390. data/generated/google/apis/pubsub_v1beta2/classes.rb +620 -0
  391. data/generated/google/apis/pubsub_v1beta2/representations.rb +282 -0
  392. data/generated/google/apis/pubsub_v1beta2/service.rb +774 -0
  393. data/generated/google/apis/qpx_express_v1.rb +31 -0
  394. data/generated/google/apis/qpx_express_v1/classes.rb +1274 -0
  395. data/generated/google/apis/qpx_express_v1/representations.rb +473 -0
  396. data/generated/google/apis/qpx_express_v1/service.rb +100 -0
  397. data/generated/google/apis/replicapool_v1beta2.rb +44 -0
  398. data/generated/google/apis/replicapool_v1beta2/classes.rb +631 -0
  399. data/generated/google/apis/replicapool_v1beta2/representations.rb +264 -0
  400. data/generated/google/apis/replicapool_v1beta2/service.rb +608 -0
  401. data/generated/google/apis/replicapoolupdater_v1beta1.rb +45 -0
  402. data/generated/google/apis/replicapoolupdater_v1beta1/classes.rb +733 -0
  403. data/generated/google/apis/replicapoolupdater_v1beta1/representations.rb +294 -0
  404. data/generated/google/apis/replicapoolupdater_v1beta1/service.rb +509 -0
  405. data/generated/google/apis/reseller_v1.rb +37 -0
  406. data/generated/google/apis/reseller_v1/classes.rb +540 -0
  407. data/generated/google/apis/reseller_v1/representations.rb +225 -0
  408. data/generated/google/apis/reseller_v1/service.rb +623 -0
  409. data/generated/google/apis/resourceviews_v1beta2.rb +50 -0
  410. data/generated/google/apis/resourceviews_v1beta2/classes.rb +660 -0
  411. data/generated/google/apis/resourceviews_v1beta2/representations.rb +301 -0
  412. data/generated/google/apis/resourceviews_v1beta2/service.rb +563 -0
  413. data/generated/google/apis/script_v1.rb +64 -0
  414. data/generated/google/apis/script_v1/classes.rb +265 -0
  415. data/generated/google/apis/script_v1/representations.rb +119 -0
  416. data/generated/google/apis/script_v1/service.rb +98 -0
  417. data/generated/google/apis/sheets_v4.rb +43 -0
  418. data/generated/google/apis/sheets_v4/classes.rb +6368 -0
  419. data/generated/google/apis/sheets_v4/representations.rb +2289 -0
  420. data/generated/google/apis/sheets_v4/service.rb +569 -0
  421. data/generated/google/apis/site_verification_v1.rb +37 -0
  422. data/generated/google/apis/site_verification_v1/classes.rb +185 -0
  423. data/generated/google/apis/site_verification_v1/representations.rb +113 -0
  424. data/generated/google/apis/site_verification_v1/service.rb +315 -0
  425. data/generated/google/apis/slides_v1.rb +49 -0
  426. data/generated/google/apis/slides_v1/classes.rb +4044 -0
  427. data/generated/google/apis/slides_v1/representations.rb +1765 -0
  428. data/generated/google/apis/slides_v1/service.rb +202 -0
  429. data/generated/google/apis/speech_v1beta1.rb +34 -0
  430. data/generated/google/apis/speech_v1beta1/classes.rb +513 -0
  431. data/generated/google/apis/speech_v1beta1/representations.rb +218 -0
  432. data/generated/google/apis/speech_v1beta1/service.rb +273 -0
  433. data/generated/google/apis/sqladmin_v1beta4.rb +38 -0
  434. data/generated/google/apis/sqladmin_v1beta4/classes.rb +2142 -0
  435. data/generated/google/apis/sqladmin_v1beta4/representations.rb +893 -0
  436. data/generated/google/apis/sqladmin_v1beta4/service.rb +1709 -0
  437. data/generated/google/apis/storage_v1.rb +46 -0
  438. data/generated/google/apis/storage_v1/classes.rb +1255 -0
  439. data/generated/google/apis/storage_v1/representations.rb +502 -0
  440. data/generated/google/apis/storage_v1/service.rb +1906 -0
  441. data/generated/google/apis/storagetransfer_v1.rb +35 -0
  442. data/generated/google/apis/storagetransfer_v1/classes.rb +1046 -0
  443. data/generated/google/apis/storagetransfer_v1/representations.rb +418 -0
  444. data/generated/google/apis/storagetransfer_v1/service.rb +473 -0
  445. data/generated/google/apis/tagmanager_v1.rb +52 -0
  446. data/generated/google/apis/tagmanager_v1/classes.rb +1494 -0
  447. data/generated/google/apis/tagmanager_v1/representations.rb +611 -0
  448. data/generated/google/apis/tagmanager_v1/service.rb +2119 -0
  449. data/generated/google/apis/taskqueue_v1beta2.rb +37 -0
  450. data/generated/google/apis/taskqueue_v1beta2/classes.rb +254 -0
  451. data/generated/google/apis/taskqueue_v1beta2/representations.rb +126 -0
  452. data/generated/google/apis/taskqueue_v1beta2/service.rb +408 -0
  453. data/generated/google/apis/tasks_v1.rb +37 -0
  454. data/generated/google/apis/tasks_v1/classes.rb +296 -0
  455. data/generated/google/apis/tasks_v1/representations.rb +125 -0
  456. data/generated/google/apis/tasks_v1/service.rb +643 -0
  457. data/generated/google/apis/translate_v2.rb +31 -0
  458. data/generated/google/apis/translate_v2/classes.rb +168 -0
  459. data/generated/google/apis/translate_v2/representations.rb +121 -0
  460. data/generated/google/apis/translate_v2/service.rb +182 -0
  461. data/generated/google/apis/urlshortener_v1.rb +34 -0
  462. data/generated/google/apis/urlshortener_v1/classes.rb +246 -0
  463. data/generated/google/apis/urlshortener_v1/representations.rb +121 -0
  464. data/generated/google/apis/urlshortener_v1/service.rb +176 -0
  465. data/generated/google/apis/vision_v1.rb +36 -0
  466. data/generated/google/apis/vision_v1/classes.rb +1267 -0
  467. data/generated/google/apis/vision_v1/representations.rb +418 -0
  468. data/generated/google/apis/vision_v1/service.rb +90 -0
  469. data/generated/google/apis/webmasters_v3.rb +37 -0
  470. data/generated/google/apis/webmasters_v3/classes.rb +570 -0
  471. data/generated/google/apis/webmasters_v3/representations.rb +283 -0
  472. data/generated/google/apis/webmasters_v3/service.rb +573 -0
  473. data/generated/google/apis/youtube_analytics_v1.rb +46 -0
  474. data/generated/google/apis/youtube_analytics_v1/classes.rb +337 -0
  475. data/generated/google/apis/youtube_analytics_v1/representations.rb +174 -0
  476. data/generated/google/apis/youtube_analytics_v1/service.rb +486 -0
  477. data/generated/google/apis/youtube_partner_v1.rb +37 -0
  478. data/generated/google/apis/youtube_partner_v1/classes.rb +3854 -0
  479. data/generated/google/apis/youtube_partner_v1/representations.rb +1537 -0
  480. data/generated/google/apis/youtube_partner_v1/service.rb +3269 -0
  481. data/generated/google/apis/youtube_v3.rb +50 -0
  482. data/generated/google/apis/youtube_v3/classes.rb +8375 -0
  483. data/generated/google/apis/youtube_v3/representations.rb +3273 -0
  484. data/generated/google/apis/youtube_v3/service.rb +4440 -0
  485. data/generated/google/apis/youtubereporting_v1.rb +38 -0
  486. data/generated/google/apis/youtubereporting_v1/classes.rb +302 -0
  487. data/generated/google/apis/youtubereporting_v1/representations.rb +149 -0
  488. data/generated/google/apis/youtubereporting_v1/service.rb +385 -0
  489. data/google-api-client.gemspec +33 -0
  490. data/lib/cacerts.pem +2183 -0
  491. data/lib/google/api_client/auth/installed_app.rb +128 -0
  492. data/lib/google/api_client/auth/key_utils.rb +94 -0
  493. data/lib/google/api_client/auth/storage.rb +104 -0
  494. data/lib/google/api_client/auth/storages/file_store.rb +57 -0
  495. data/lib/google/api_client/auth/storages/redis_store.rb +59 -0
  496. data/lib/google/api_client/client_secrets.rb +177 -0
  497. data/lib/google/apis.rb +58 -0
  498. data/lib/google/apis/core/api_command.rb +146 -0
  499. data/lib/google/apis/core/base_service.rb +401 -0
  500. data/lib/google/apis/core/batch.rb +239 -0
  501. data/lib/google/apis/core/download.rb +108 -0
  502. data/lib/google/apis/core/hashable.rb +44 -0
  503. data/lib/google/apis/core/http_client_adapter.rb +82 -0
  504. data/lib/google/apis/core/http_command.rb +332 -0
  505. data/lib/google/apis/core/json_representation.rb +145 -0
  506. data/lib/google/apis/core/logging.rb +30 -0
  507. data/lib/google/apis/core/multipart.rb +187 -0
  508. data/lib/google/apis/core/upload.rb +295 -0
  509. data/lib/google/apis/errors.rb +80 -0
  510. data/lib/google/apis/generator.rb +70 -0
  511. data/lib/google/apis/generator/annotator.rb +301 -0
  512. data/lib/google/apis/generator/helpers.rb +74 -0
  513. data/lib/google/apis/generator/model.rb +143 -0
  514. data/lib/google/apis/generator/template.rb +124 -0
  515. data/lib/google/apis/generator/templates/_class.tmpl +40 -0
  516. data/lib/google/apis/generator/templates/_method.tmpl +92 -0
  517. data/lib/google/apis/generator/templates/_representation.tmpl +51 -0
  518. data/lib/google/apis/generator/templates/_representation_stub.tmpl +17 -0
  519. data/lib/google/apis/generator/templates/_representation_type.tmpl +10 -0
  520. data/lib/google/apis/generator/templates/classes.rb.tmpl +29 -0
  521. data/lib/google/apis/generator/templates/module.rb.tmpl +40 -0
  522. data/lib/google/apis/generator/templates/representations.rb.tmpl +32 -0
  523. data/lib/google/apis/generator/templates/service.rb.tmpl +60 -0
  524. data/lib/google/apis/options.rb +85 -0
  525. data/lib/google/apis/version.rb +39 -0
  526. data/rakelib/metrics.rake +22 -0
  527. data/rakelib/rubocop.rake +10 -0
  528. data/rakelib/spec.rake +11 -0
  529. data/rakelib/yard.rake +11 -0
  530. data/samples/cli/.env +4 -0
  531. data/samples/cli/Gemfile +7 -0
  532. data/samples/cli/README.md +51 -0
  533. data/samples/cli/google-api-samples +32 -0
  534. data/samples/cli/lib/base_cli.rb +95 -0
  535. data/samples/cli/lib/samples/analytics.rb +62 -0
  536. data/samples/cli/lib/samples/androidpublisher.rb +47 -0
  537. data/samples/cli/lib/samples/bigquery.rb +101 -0
  538. data/samples/cli/lib/samples/calendar.rb +83 -0
  539. data/samples/cli/lib/samples/drive.rb +82 -0
  540. data/samples/cli/lib/samples/gmail.rb +124 -0
  541. data/samples/cli/lib/samples/pubsub.rb +114 -0
  542. data/samples/cli/lib/samples/sheets.rb +61 -0
  543. data/samples/cli/lib/samples/translate.rb +44 -0
  544. data/samples/cli/lib/samples/you_tube.rb +44 -0
  545. data/samples/web/.env +2 -0
  546. data/samples/web/Gemfile +7 -0
  547. data/samples/web/README.md +44 -0
  548. data/samples/web/app.rb +120 -0
  549. data/samples/web/views/calendar.erb +34 -0
  550. data/samples/web/views/drive.erb +33 -0
  551. data/samples/web/views/home.erb +34 -0
  552. data/samples/web/views/layout.erb +40 -0
  553. data/sync.rb +71 -0
  554. data/third_party/hurley_patches.rb +103 -0
  555. metadata +735 -0
@@ -0,0 +1,3857 @@
1
+ # Copyright 2015 Google Inc.
2
+ #
3
+ # Licensed under the Apache License, Version 2.0 (the "License");
4
+ # you may not use this file except in compliance with the License.
5
+ # You may obtain a copy of the License at
6
+ #
7
+ # http://www.apache.org/licenses/LICENSE-2.0
8
+ #
9
+ # Unless required by applicable law or agreed to in writing, software
10
+ # distributed under the License is distributed on an "AS IS" BASIS,
11
+ # WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
12
+ # See the License for the specific language governing permissions and
13
+ # limitations under the License.
14
+
15
+ require 'google/apis/core/base_service'
16
+ require 'google/apis/core/json_representation'
17
+ require 'google/apis/core/hashable'
18
+ require 'google/apis/errors'
19
+
20
+ module Google
21
+ module Apis
22
+ module AdminDirectoryV1
23
+ # Admin Directory API
24
+ #
25
+ # The Admin SDK Directory API lets you view and manage enterprise resources such
26
+ # as users and groups, administrative notifications, security features, and more.
27
+ #
28
+ # @example
29
+ # require 'google/apis/admin_directory_v1'
30
+ #
31
+ # Admin = Google::Apis::AdminDirectoryV1 # Alias the module
32
+ # service = Admin::DirectoryService.new
33
+ #
34
+ # @see https://developers.google.com/admin-sdk/directory/
35
+ class DirectoryService < Google::Apis::Core::BaseService
36
+ # @return [String]
37
+ # API key. Your API key identifies your project and provides you with API access,
38
+ # quota, and reports. Required unless you provide an OAuth 2.0 token.
39
+ attr_accessor :key
40
+
41
+ # @return [String]
42
+ # Available to use for quota purposes for server-side applications. Can be any
43
+ # arbitrary string assigned to a user, but should not exceed 40 characters.
44
+ # Overrides userIp if both are provided.
45
+ attr_accessor :quota_user
46
+
47
+ # @return [String]
48
+ # IP address of the site where the request originates. Use this if you want to
49
+ # enforce per-user limits.
50
+ attr_accessor :user_ip
51
+
52
+ def initialize
53
+ super('https://www.googleapis.com/', 'admin/directory/v1/')
54
+ end
55
+
56
+ # Delete an ASP issued by a user.
57
+ # @param [String] user_key
58
+ # Identifies the user in the API request. The value can be the user's primary
59
+ # email address, alias email address, or unique user ID.
60
+ # @param [Fixnum] code_id
61
+ # The unique ID of the ASP to be deleted.
62
+ # @param [String] fields
63
+ # Selector specifying which fields to include in a partial response.
64
+ # @param [String] quota_user
65
+ # Available to use for quota purposes for server-side applications. Can be any
66
+ # arbitrary string assigned to a user, but should not exceed 40 characters.
67
+ # Overrides userIp if both are provided.
68
+ # @param [String] user_ip
69
+ # IP address of the site where the request originates. Use this if you want to
70
+ # enforce per-user limits.
71
+ # @param [Google::Apis::RequestOptions] options
72
+ # Request-specific options
73
+ #
74
+ # @yield [result, err] Result & error if block supplied
75
+ # @yieldparam result [NilClass] No result returned for this method
76
+ # @yieldparam err [StandardError] error object if request failed
77
+ #
78
+ # @return [void]
79
+ #
80
+ # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
81
+ # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
82
+ # @raise [Google::Apis::AuthorizationError] Authorization is required
83
+ def delete_asp(user_key, code_id, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block)
84
+ command = make_simple_command(:delete, 'users/{userKey}/asps/{codeId}', options)
85
+ command.params['userKey'] = user_key unless user_key.nil?
86
+ command.params['codeId'] = code_id unless code_id.nil?
87
+ command.query['fields'] = fields unless fields.nil?
88
+ command.query['quotaUser'] = quota_user unless quota_user.nil?
89
+ command.query['userIp'] = user_ip unless user_ip.nil?
90
+ execute_or_queue_command(command, &block)
91
+ end
92
+
93
+ # Get information about an ASP issued by a user.
94
+ # @param [String] user_key
95
+ # Identifies the user in the API request. The value can be the user's primary
96
+ # email address, alias email address, or unique user ID.
97
+ # @param [Fixnum] code_id
98
+ # The unique ID of the ASP.
99
+ # @param [String] fields
100
+ # Selector specifying which fields to include in a partial response.
101
+ # @param [String] quota_user
102
+ # Available to use for quota purposes for server-side applications. Can be any
103
+ # arbitrary string assigned to a user, but should not exceed 40 characters.
104
+ # Overrides userIp if both are provided.
105
+ # @param [String] user_ip
106
+ # IP address of the site where the request originates. Use this if you want to
107
+ # enforce per-user limits.
108
+ # @param [Google::Apis::RequestOptions] options
109
+ # Request-specific options
110
+ #
111
+ # @yield [result, err] Result & error if block supplied
112
+ # @yieldparam result [Google::Apis::AdminDirectoryV1::Asp] parsed result object
113
+ # @yieldparam err [StandardError] error object if request failed
114
+ #
115
+ # @return [Google::Apis::AdminDirectoryV1::Asp]
116
+ #
117
+ # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
118
+ # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
119
+ # @raise [Google::Apis::AuthorizationError] Authorization is required
120
+ def get_asp(user_key, code_id, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block)
121
+ command = make_simple_command(:get, 'users/{userKey}/asps/{codeId}', options)
122
+ command.response_representation = Google::Apis::AdminDirectoryV1::Asp::Representation
123
+ command.response_class = Google::Apis::AdminDirectoryV1::Asp
124
+ command.params['userKey'] = user_key unless user_key.nil?
125
+ command.params['codeId'] = code_id unless code_id.nil?
126
+ command.query['fields'] = fields unless fields.nil?
127
+ command.query['quotaUser'] = quota_user unless quota_user.nil?
128
+ command.query['userIp'] = user_ip unless user_ip.nil?
129
+ execute_or_queue_command(command, &block)
130
+ end
131
+
132
+ # List the ASPs issued by a user.
133
+ # @param [String] user_key
134
+ # Identifies the user in the API request. The value can be the user's primary
135
+ # email address, alias email address, or unique user ID.
136
+ # @param [String] fields
137
+ # Selector specifying which fields to include in a partial response.
138
+ # @param [String] quota_user
139
+ # Available to use for quota purposes for server-side applications. Can be any
140
+ # arbitrary string assigned to a user, but should not exceed 40 characters.
141
+ # Overrides userIp if both are provided.
142
+ # @param [String] user_ip
143
+ # IP address of the site where the request originates. Use this if you want to
144
+ # enforce per-user limits.
145
+ # @param [Google::Apis::RequestOptions] options
146
+ # Request-specific options
147
+ #
148
+ # @yield [result, err] Result & error if block supplied
149
+ # @yieldparam result [Google::Apis::AdminDirectoryV1::Asps] parsed result object
150
+ # @yieldparam err [StandardError] error object if request failed
151
+ #
152
+ # @return [Google::Apis::AdminDirectoryV1::Asps]
153
+ #
154
+ # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
155
+ # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
156
+ # @raise [Google::Apis::AuthorizationError] Authorization is required
157
+ def list_asps(user_key, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block)
158
+ command = make_simple_command(:get, 'users/{userKey}/asps', options)
159
+ command.response_representation = Google::Apis::AdminDirectoryV1::Asps::Representation
160
+ command.response_class = Google::Apis::AdminDirectoryV1::Asps
161
+ command.params['userKey'] = user_key unless user_key.nil?
162
+ command.query['fields'] = fields unless fields.nil?
163
+ command.query['quotaUser'] = quota_user unless quota_user.nil?
164
+ command.query['userIp'] = user_ip unless user_ip.nil?
165
+ execute_or_queue_command(command, &block)
166
+ end
167
+
168
+ # Stop watching resources through this channel
169
+ # @param [Google::Apis::AdminDirectoryV1::Channel] channel_object
170
+ # @param [String] fields
171
+ # Selector specifying which fields to include in a partial response.
172
+ # @param [String] quota_user
173
+ # Available to use for quota purposes for server-side applications. Can be any
174
+ # arbitrary string assigned to a user, but should not exceed 40 characters.
175
+ # Overrides userIp if both are provided.
176
+ # @param [String] user_ip
177
+ # IP address of the site where the request originates. Use this if you want to
178
+ # enforce per-user limits.
179
+ # @param [Google::Apis::RequestOptions] options
180
+ # Request-specific options
181
+ #
182
+ # @yield [result, err] Result & error if block supplied
183
+ # @yieldparam result [NilClass] No result returned for this method
184
+ # @yieldparam err [StandardError] error object if request failed
185
+ #
186
+ # @return [void]
187
+ #
188
+ # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
189
+ # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
190
+ # @raise [Google::Apis::AuthorizationError] Authorization is required
191
+ def stop_channel(channel_object = nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block)
192
+ command = make_simple_command(:post, '/admin/directory_v1/channels/stop', options)
193
+ command.request_representation = Google::Apis::AdminDirectoryV1::Channel::Representation
194
+ command.request_object = channel_object
195
+ command.query['fields'] = fields unless fields.nil?
196
+ command.query['quotaUser'] = quota_user unless quota_user.nil?
197
+ command.query['userIp'] = user_ip unless user_ip.nil?
198
+ execute_or_queue_command(command, &block)
199
+ end
200
+
201
+ # Take action on Chrome OS Device
202
+ # @param [String] customer_id
203
+ # Immutable id of the Google Apps account
204
+ # @param [String] resource_id
205
+ # Immutable id of Chrome OS Device
206
+ # @param [Google::Apis::AdminDirectoryV1::ChromeOsDeviceAction] chrome_os_device_action_object
207
+ # @param [String] fields
208
+ # Selector specifying which fields to include in a partial response.
209
+ # @param [String] quota_user
210
+ # Available to use for quota purposes for server-side applications. Can be any
211
+ # arbitrary string assigned to a user, but should not exceed 40 characters.
212
+ # Overrides userIp if both are provided.
213
+ # @param [String] user_ip
214
+ # IP address of the site where the request originates. Use this if you want to
215
+ # enforce per-user limits.
216
+ # @param [Google::Apis::RequestOptions] options
217
+ # Request-specific options
218
+ #
219
+ # @yield [result, err] Result & error if block supplied
220
+ # @yieldparam result [NilClass] No result returned for this method
221
+ # @yieldparam err [StandardError] error object if request failed
222
+ #
223
+ # @return [void]
224
+ #
225
+ # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
226
+ # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
227
+ # @raise [Google::Apis::AuthorizationError] Authorization is required
228
+ def action_chromeosdevice(customer_id, resource_id, chrome_os_device_action_object = nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block)
229
+ command = make_simple_command(:post, 'customer/{customerId}/devices/chromeos/{resourceId}/action', options)
230
+ command.request_representation = Google::Apis::AdminDirectoryV1::ChromeOsDeviceAction::Representation
231
+ command.request_object = chrome_os_device_action_object
232
+ command.params['customerId'] = customer_id unless customer_id.nil?
233
+ command.params['resourceId'] = resource_id unless resource_id.nil?
234
+ command.query['fields'] = fields unless fields.nil?
235
+ command.query['quotaUser'] = quota_user unless quota_user.nil?
236
+ command.query['userIp'] = user_ip unless user_ip.nil?
237
+ execute_or_queue_command(command, &block)
238
+ end
239
+
240
+ # Retrieve Chrome OS Device
241
+ # @param [String] customer_id
242
+ # Immutable id of the Google Apps account
243
+ # @param [String] device_id
244
+ # Immutable id of Chrome OS Device
245
+ # @param [String] projection
246
+ # Restrict information returned to a set of selected fields.
247
+ # @param [String] fields
248
+ # Selector specifying which fields to include in a partial response.
249
+ # @param [String] quota_user
250
+ # Available to use for quota purposes for server-side applications. Can be any
251
+ # arbitrary string assigned to a user, but should not exceed 40 characters.
252
+ # Overrides userIp if both are provided.
253
+ # @param [String] user_ip
254
+ # IP address of the site where the request originates. Use this if you want to
255
+ # enforce per-user limits.
256
+ # @param [Google::Apis::RequestOptions] options
257
+ # Request-specific options
258
+ #
259
+ # @yield [result, err] Result & error if block supplied
260
+ # @yieldparam result [Google::Apis::AdminDirectoryV1::ChromeOsDevice] parsed result object
261
+ # @yieldparam err [StandardError] error object if request failed
262
+ #
263
+ # @return [Google::Apis::AdminDirectoryV1::ChromeOsDevice]
264
+ #
265
+ # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
266
+ # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
267
+ # @raise [Google::Apis::AuthorizationError] Authorization is required
268
+ def get_chrome_os_device(customer_id, device_id, projection: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block)
269
+ command = make_simple_command(:get, 'customer/{customerId}/devices/chromeos/{deviceId}', options)
270
+ command.response_representation = Google::Apis::AdminDirectoryV1::ChromeOsDevice::Representation
271
+ command.response_class = Google::Apis::AdminDirectoryV1::ChromeOsDevice
272
+ command.params['customerId'] = customer_id unless customer_id.nil?
273
+ command.params['deviceId'] = device_id unless device_id.nil?
274
+ command.query['projection'] = projection unless projection.nil?
275
+ command.query['fields'] = fields unless fields.nil?
276
+ command.query['quotaUser'] = quota_user unless quota_user.nil?
277
+ command.query['userIp'] = user_ip unless user_ip.nil?
278
+ execute_or_queue_command(command, &block)
279
+ end
280
+
281
+ # Retrieve all Chrome OS Devices of a customer (paginated)
282
+ # @param [String] customer_id
283
+ # Immutable id of the Google Apps account
284
+ # @param [Fixnum] max_results
285
+ # Maximum number of results to return. Default is 100
286
+ # @param [String] order_by
287
+ # Column to use for sorting results
288
+ # @param [String] page_token
289
+ # Token to specify next page in the list
290
+ # @param [String] projection
291
+ # Restrict information returned to a set of selected fields.
292
+ # @param [String] query
293
+ # Search string in the format given at http://support.google.com/chromeos/a/bin/
294
+ # answer.py?hl=en&answer=1698333
295
+ # @param [String] sort_order
296
+ # Whether to return results in ascending or descending order. Only of use when
297
+ # orderBy is also used
298
+ # @param [String] fields
299
+ # Selector specifying which fields to include in a partial response.
300
+ # @param [String] quota_user
301
+ # Available to use for quota purposes for server-side applications. Can be any
302
+ # arbitrary string assigned to a user, but should not exceed 40 characters.
303
+ # Overrides userIp if both are provided.
304
+ # @param [String] user_ip
305
+ # IP address of the site where the request originates. Use this if you want to
306
+ # enforce per-user limits.
307
+ # @param [Google::Apis::RequestOptions] options
308
+ # Request-specific options
309
+ #
310
+ # @yield [result, err] Result & error if block supplied
311
+ # @yieldparam result [Google::Apis::AdminDirectoryV1::ChromeOsDevices] parsed result object
312
+ # @yieldparam err [StandardError] error object if request failed
313
+ #
314
+ # @return [Google::Apis::AdminDirectoryV1::ChromeOsDevices]
315
+ #
316
+ # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
317
+ # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
318
+ # @raise [Google::Apis::AuthorizationError] Authorization is required
319
+ def list_chrome_os_devices(customer_id, max_results: nil, order_by: nil, page_token: nil, projection: nil, query: nil, sort_order: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block)
320
+ command = make_simple_command(:get, 'customer/{customerId}/devices/chromeos', options)
321
+ command.response_representation = Google::Apis::AdminDirectoryV1::ChromeOsDevices::Representation
322
+ command.response_class = Google::Apis::AdminDirectoryV1::ChromeOsDevices
323
+ command.params['customerId'] = customer_id unless customer_id.nil?
324
+ command.query['maxResults'] = max_results unless max_results.nil?
325
+ command.query['orderBy'] = order_by unless order_by.nil?
326
+ command.query['pageToken'] = page_token unless page_token.nil?
327
+ command.query['projection'] = projection unless projection.nil?
328
+ command.query['query'] = query unless query.nil?
329
+ command.query['sortOrder'] = sort_order unless sort_order.nil?
330
+ command.query['fields'] = fields unless fields.nil?
331
+ command.query['quotaUser'] = quota_user unless quota_user.nil?
332
+ command.query['userIp'] = user_ip unless user_ip.nil?
333
+ execute_or_queue_command(command, &block)
334
+ end
335
+
336
+ # Update Chrome OS Device. This method supports patch semantics.
337
+ # @param [String] customer_id
338
+ # Immutable id of the Google Apps account
339
+ # @param [String] device_id
340
+ # Immutable id of Chrome OS Device
341
+ # @param [Google::Apis::AdminDirectoryV1::ChromeOsDevice] chrome_os_device_object
342
+ # @param [String] projection
343
+ # Restrict information returned to a set of selected fields.
344
+ # @param [String] fields
345
+ # Selector specifying which fields to include in a partial response.
346
+ # @param [String] quota_user
347
+ # Available to use for quota purposes for server-side applications. Can be any
348
+ # arbitrary string assigned to a user, but should not exceed 40 characters.
349
+ # Overrides userIp if both are provided.
350
+ # @param [String] user_ip
351
+ # IP address of the site where the request originates. Use this if you want to
352
+ # enforce per-user limits.
353
+ # @param [Google::Apis::RequestOptions] options
354
+ # Request-specific options
355
+ #
356
+ # @yield [result, err] Result & error if block supplied
357
+ # @yieldparam result [Google::Apis::AdminDirectoryV1::ChromeOsDevice] parsed result object
358
+ # @yieldparam err [StandardError] error object if request failed
359
+ #
360
+ # @return [Google::Apis::AdminDirectoryV1::ChromeOsDevice]
361
+ #
362
+ # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
363
+ # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
364
+ # @raise [Google::Apis::AuthorizationError] Authorization is required
365
+ def patch_chrome_os_device(customer_id, device_id, chrome_os_device_object = nil, projection: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block)
366
+ command = make_simple_command(:patch, 'customer/{customerId}/devices/chromeos/{deviceId}', options)
367
+ command.request_representation = Google::Apis::AdminDirectoryV1::ChromeOsDevice::Representation
368
+ command.request_object = chrome_os_device_object
369
+ command.response_representation = Google::Apis::AdminDirectoryV1::ChromeOsDevice::Representation
370
+ command.response_class = Google::Apis::AdminDirectoryV1::ChromeOsDevice
371
+ command.params['customerId'] = customer_id unless customer_id.nil?
372
+ command.params['deviceId'] = device_id unless device_id.nil?
373
+ command.query['projection'] = projection unless projection.nil?
374
+ command.query['fields'] = fields unless fields.nil?
375
+ command.query['quotaUser'] = quota_user unless quota_user.nil?
376
+ command.query['userIp'] = user_ip unless user_ip.nil?
377
+ execute_or_queue_command(command, &block)
378
+ end
379
+
380
+ # Update Chrome OS Device
381
+ # @param [String] customer_id
382
+ # Immutable id of the Google Apps account
383
+ # @param [String] device_id
384
+ # Immutable id of Chrome OS Device
385
+ # @param [Google::Apis::AdminDirectoryV1::ChromeOsDevice] chrome_os_device_object
386
+ # @param [String] projection
387
+ # Restrict information returned to a set of selected fields.
388
+ # @param [String] fields
389
+ # Selector specifying which fields to include in a partial response.
390
+ # @param [String] quota_user
391
+ # Available to use for quota purposes for server-side applications. Can be any
392
+ # arbitrary string assigned to a user, but should not exceed 40 characters.
393
+ # Overrides userIp if both are provided.
394
+ # @param [String] user_ip
395
+ # IP address of the site where the request originates. Use this if you want to
396
+ # enforce per-user limits.
397
+ # @param [Google::Apis::RequestOptions] options
398
+ # Request-specific options
399
+ #
400
+ # @yield [result, err] Result & error if block supplied
401
+ # @yieldparam result [Google::Apis::AdminDirectoryV1::ChromeOsDevice] parsed result object
402
+ # @yieldparam err [StandardError] error object if request failed
403
+ #
404
+ # @return [Google::Apis::AdminDirectoryV1::ChromeOsDevice]
405
+ #
406
+ # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
407
+ # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
408
+ # @raise [Google::Apis::AuthorizationError] Authorization is required
409
+ def update_chrome_os_device(customer_id, device_id, chrome_os_device_object = nil, projection: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block)
410
+ command = make_simple_command(:put, 'customer/{customerId}/devices/chromeos/{deviceId}', options)
411
+ command.request_representation = Google::Apis::AdminDirectoryV1::ChromeOsDevice::Representation
412
+ command.request_object = chrome_os_device_object
413
+ command.response_representation = Google::Apis::AdminDirectoryV1::ChromeOsDevice::Representation
414
+ command.response_class = Google::Apis::AdminDirectoryV1::ChromeOsDevice
415
+ command.params['customerId'] = customer_id unless customer_id.nil?
416
+ command.params['deviceId'] = device_id unless device_id.nil?
417
+ command.query['projection'] = projection unless projection.nil?
418
+ command.query['fields'] = fields unless fields.nil?
419
+ command.query['quotaUser'] = quota_user unless quota_user.nil?
420
+ command.query['userIp'] = user_ip unless user_ip.nil?
421
+ execute_or_queue_command(command, &block)
422
+ end
423
+
424
+ # Retrieves a customer.
425
+ # @param [String] customer_key
426
+ # Id of the customer to be retrieved
427
+ # @param [String] fields
428
+ # Selector specifying which fields to include in a partial response.
429
+ # @param [String] quota_user
430
+ # Available to use for quota purposes for server-side applications. Can be any
431
+ # arbitrary string assigned to a user, but should not exceed 40 characters.
432
+ # Overrides userIp if both are provided.
433
+ # @param [String] user_ip
434
+ # IP address of the site where the request originates. Use this if you want to
435
+ # enforce per-user limits.
436
+ # @param [Google::Apis::RequestOptions] options
437
+ # Request-specific options
438
+ #
439
+ # @yield [result, err] Result & error if block supplied
440
+ # @yieldparam result [Google::Apis::AdminDirectoryV1::Customer] parsed result object
441
+ # @yieldparam err [StandardError] error object if request failed
442
+ #
443
+ # @return [Google::Apis::AdminDirectoryV1::Customer]
444
+ #
445
+ # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
446
+ # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
447
+ # @raise [Google::Apis::AuthorizationError] Authorization is required
448
+ def get_customer(customer_key, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block)
449
+ command = make_simple_command(:get, 'customers/{customerKey}', options)
450
+ command.response_representation = Google::Apis::AdminDirectoryV1::Customer::Representation
451
+ command.response_class = Google::Apis::AdminDirectoryV1::Customer
452
+ command.params['customerKey'] = customer_key unless customer_key.nil?
453
+ command.query['fields'] = fields unless fields.nil?
454
+ command.query['quotaUser'] = quota_user unless quota_user.nil?
455
+ command.query['userIp'] = user_ip unless user_ip.nil?
456
+ execute_or_queue_command(command, &block)
457
+ end
458
+
459
+ # Updates a customer. This method supports patch semantics.
460
+ # @param [String] customer_key
461
+ # Id of the customer to be updated
462
+ # @param [Google::Apis::AdminDirectoryV1::Customer] customer_object
463
+ # @param [String] fields
464
+ # Selector specifying which fields to include in a partial response.
465
+ # @param [String] quota_user
466
+ # Available to use for quota purposes for server-side applications. Can be any
467
+ # arbitrary string assigned to a user, but should not exceed 40 characters.
468
+ # Overrides userIp if both are provided.
469
+ # @param [String] user_ip
470
+ # IP address of the site where the request originates. Use this if you want to
471
+ # enforce per-user limits.
472
+ # @param [Google::Apis::RequestOptions] options
473
+ # Request-specific options
474
+ #
475
+ # @yield [result, err] Result & error if block supplied
476
+ # @yieldparam result [Google::Apis::AdminDirectoryV1::Customer] parsed result object
477
+ # @yieldparam err [StandardError] error object if request failed
478
+ #
479
+ # @return [Google::Apis::AdminDirectoryV1::Customer]
480
+ #
481
+ # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
482
+ # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
483
+ # @raise [Google::Apis::AuthorizationError] Authorization is required
484
+ def patch_customer(customer_key, customer_object = nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block)
485
+ command = make_simple_command(:patch, 'customers/{customerKey}', options)
486
+ command.request_representation = Google::Apis::AdminDirectoryV1::Customer::Representation
487
+ command.request_object = customer_object
488
+ command.response_representation = Google::Apis::AdminDirectoryV1::Customer::Representation
489
+ command.response_class = Google::Apis::AdminDirectoryV1::Customer
490
+ command.params['customerKey'] = customer_key unless customer_key.nil?
491
+ command.query['fields'] = fields unless fields.nil?
492
+ command.query['quotaUser'] = quota_user unless quota_user.nil?
493
+ command.query['userIp'] = user_ip unless user_ip.nil?
494
+ execute_or_queue_command(command, &block)
495
+ end
496
+
497
+ # Updates a customer.
498
+ # @param [String] customer_key
499
+ # Id of the customer to be updated
500
+ # @param [Google::Apis::AdminDirectoryV1::Customer] customer_object
501
+ # @param [String] fields
502
+ # Selector specifying which fields to include in a partial response.
503
+ # @param [String] quota_user
504
+ # Available to use for quota purposes for server-side applications. Can be any
505
+ # arbitrary string assigned to a user, but should not exceed 40 characters.
506
+ # Overrides userIp if both are provided.
507
+ # @param [String] user_ip
508
+ # IP address of the site where the request originates. Use this if you want to
509
+ # enforce per-user limits.
510
+ # @param [Google::Apis::RequestOptions] options
511
+ # Request-specific options
512
+ #
513
+ # @yield [result, err] Result & error if block supplied
514
+ # @yieldparam result [Google::Apis::AdminDirectoryV1::Customer] parsed result object
515
+ # @yieldparam err [StandardError] error object if request failed
516
+ #
517
+ # @return [Google::Apis::AdminDirectoryV1::Customer]
518
+ #
519
+ # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
520
+ # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
521
+ # @raise [Google::Apis::AuthorizationError] Authorization is required
522
+ def update_customer(customer_key, customer_object = nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block)
523
+ command = make_simple_command(:put, 'customers/{customerKey}', options)
524
+ command.request_representation = Google::Apis::AdminDirectoryV1::Customer::Representation
525
+ command.request_object = customer_object
526
+ command.response_representation = Google::Apis::AdminDirectoryV1::Customer::Representation
527
+ command.response_class = Google::Apis::AdminDirectoryV1::Customer
528
+ command.params['customerKey'] = customer_key unless customer_key.nil?
529
+ command.query['fields'] = fields unless fields.nil?
530
+ command.query['quotaUser'] = quota_user unless quota_user.nil?
531
+ command.query['userIp'] = user_ip unless user_ip.nil?
532
+ execute_or_queue_command(command, &block)
533
+ end
534
+
535
+ # Deletes a Domain Alias of the customer.
536
+ # @param [String] customer
537
+ # Immutable id of the Google Apps account.
538
+ # @param [String] domain_alias_name
539
+ # Name of domain alias to be retrieved.
540
+ # @param [String] fields
541
+ # Selector specifying which fields to include in a partial response.
542
+ # @param [String] quota_user
543
+ # Available to use for quota purposes for server-side applications. Can be any
544
+ # arbitrary string assigned to a user, but should not exceed 40 characters.
545
+ # Overrides userIp if both are provided.
546
+ # @param [String] user_ip
547
+ # IP address of the site where the request originates. Use this if you want to
548
+ # enforce per-user limits.
549
+ # @param [Google::Apis::RequestOptions] options
550
+ # Request-specific options
551
+ #
552
+ # @yield [result, err] Result & error if block supplied
553
+ # @yieldparam result [NilClass] No result returned for this method
554
+ # @yieldparam err [StandardError] error object if request failed
555
+ #
556
+ # @return [void]
557
+ #
558
+ # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
559
+ # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
560
+ # @raise [Google::Apis::AuthorizationError] Authorization is required
561
+ def delete_domain_alias(customer, domain_alias_name, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block)
562
+ command = make_simple_command(:delete, 'customer/{customer}/domainaliases/{domainAliasName}', options)
563
+ command.params['customer'] = customer unless customer.nil?
564
+ command.params['domainAliasName'] = domain_alias_name unless domain_alias_name.nil?
565
+ command.query['fields'] = fields unless fields.nil?
566
+ command.query['quotaUser'] = quota_user unless quota_user.nil?
567
+ command.query['userIp'] = user_ip unless user_ip.nil?
568
+ execute_or_queue_command(command, &block)
569
+ end
570
+
571
+ # Retrieves a domain alias of the customer.
572
+ # @param [String] customer
573
+ # Immutable id of the Google Apps account.
574
+ # @param [String] domain_alias_name
575
+ # Name of domain alias to be retrieved.
576
+ # @param [String] fields
577
+ # Selector specifying which fields to include in a partial response.
578
+ # @param [String] quota_user
579
+ # Available to use for quota purposes for server-side applications. Can be any
580
+ # arbitrary string assigned to a user, but should not exceed 40 characters.
581
+ # Overrides userIp if both are provided.
582
+ # @param [String] user_ip
583
+ # IP address of the site where the request originates. Use this if you want to
584
+ # enforce per-user limits.
585
+ # @param [Google::Apis::RequestOptions] options
586
+ # Request-specific options
587
+ #
588
+ # @yield [result, err] Result & error if block supplied
589
+ # @yieldparam result [Google::Apis::AdminDirectoryV1::DomainAlias] parsed result object
590
+ # @yieldparam err [StandardError] error object if request failed
591
+ #
592
+ # @return [Google::Apis::AdminDirectoryV1::DomainAlias]
593
+ #
594
+ # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
595
+ # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
596
+ # @raise [Google::Apis::AuthorizationError] Authorization is required
597
+ def get_domain_alias(customer, domain_alias_name, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block)
598
+ command = make_simple_command(:get, 'customer/{customer}/domainaliases/{domainAliasName}', options)
599
+ command.response_representation = Google::Apis::AdminDirectoryV1::DomainAlias::Representation
600
+ command.response_class = Google::Apis::AdminDirectoryV1::DomainAlias
601
+ command.params['customer'] = customer unless customer.nil?
602
+ command.params['domainAliasName'] = domain_alias_name unless domain_alias_name.nil?
603
+ command.query['fields'] = fields unless fields.nil?
604
+ command.query['quotaUser'] = quota_user unless quota_user.nil?
605
+ command.query['userIp'] = user_ip unless user_ip.nil?
606
+ execute_or_queue_command(command, &block)
607
+ end
608
+
609
+ # Inserts a Domain alias of the customer.
610
+ # @param [String] customer
611
+ # Immutable id of the Google Apps account.
612
+ # @param [Google::Apis::AdminDirectoryV1::DomainAlias] domain_alias_object
613
+ # @param [String] fields
614
+ # Selector specifying which fields to include in a partial response.
615
+ # @param [String] quota_user
616
+ # Available to use for quota purposes for server-side applications. Can be any
617
+ # arbitrary string assigned to a user, but should not exceed 40 characters.
618
+ # Overrides userIp if both are provided.
619
+ # @param [String] user_ip
620
+ # IP address of the site where the request originates. Use this if you want to
621
+ # enforce per-user limits.
622
+ # @param [Google::Apis::RequestOptions] options
623
+ # Request-specific options
624
+ #
625
+ # @yield [result, err] Result & error if block supplied
626
+ # @yieldparam result [Google::Apis::AdminDirectoryV1::DomainAlias] parsed result object
627
+ # @yieldparam err [StandardError] error object if request failed
628
+ #
629
+ # @return [Google::Apis::AdminDirectoryV1::DomainAlias]
630
+ #
631
+ # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
632
+ # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
633
+ # @raise [Google::Apis::AuthorizationError] Authorization is required
634
+ def insert_domain_alias(customer, domain_alias_object = nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block)
635
+ command = make_simple_command(:post, 'customer/{customer}/domainaliases', options)
636
+ command.request_representation = Google::Apis::AdminDirectoryV1::DomainAlias::Representation
637
+ command.request_object = domain_alias_object
638
+ command.response_representation = Google::Apis::AdminDirectoryV1::DomainAlias::Representation
639
+ command.response_class = Google::Apis::AdminDirectoryV1::DomainAlias
640
+ command.params['customer'] = customer unless customer.nil?
641
+ command.query['fields'] = fields unless fields.nil?
642
+ command.query['quotaUser'] = quota_user unless quota_user.nil?
643
+ command.query['userIp'] = user_ip unless user_ip.nil?
644
+ execute_or_queue_command(command, &block)
645
+ end
646
+
647
+ # Lists the domain aliases of the customer.
648
+ # @param [String] customer
649
+ # Immutable id of the Google Apps account.
650
+ # @param [String] parent_domain_name
651
+ # Name of the parent domain for which domain aliases are to be fetched.
652
+ # @param [String] fields
653
+ # Selector specifying which fields to include in a partial response.
654
+ # @param [String] quota_user
655
+ # Available to use for quota purposes for server-side applications. Can be any
656
+ # arbitrary string assigned to a user, but should not exceed 40 characters.
657
+ # Overrides userIp if both are provided.
658
+ # @param [String] user_ip
659
+ # IP address of the site where the request originates. Use this if you want to
660
+ # enforce per-user limits.
661
+ # @param [Google::Apis::RequestOptions] options
662
+ # Request-specific options
663
+ #
664
+ # @yield [result, err] Result & error if block supplied
665
+ # @yieldparam result [Google::Apis::AdminDirectoryV1::DomainAliases] parsed result object
666
+ # @yieldparam err [StandardError] error object if request failed
667
+ #
668
+ # @return [Google::Apis::AdminDirectoryV1::DomainAliases]
669
+ #
670
+ # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
671
+ # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
672
+ # @raise [Google::Apis::AuthorizationError] Authorization is required
673
+ def list_domain_aliases(customer, parent_domain_name: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block)
674
+ command = make_simple_command(:get, 'customer/{customer}/domainaliases', options)
675
+ command.response_representation = Google::Apis::AdminDirectoryV1::DomainAliases::Representation
676
+ command.response_class = Google::Apis::AdminDirectoryV1::DomainAliases
677
+ command.params['customer'] = customer unless customer.nil?
678
+ command.query['parentDomainName'] = parent_domain_name unless parent_domain_name.nil?
679
+ command.query['fields'] = fields unless fields.nil?
680
+ command.query['quotaUser'] = quota_user unless quota_user.nil?
681
+ command.query['userIp'] = user_ip unless user_ip.nil?
682
+ execute_or_queue_command(command, &block)
683
+ end
684
+
685
+ # Deletes a domain of the customer.
686
+ # @param [String] customer
687
+ # Immutable id of the Google Apps account.
688
+ # @param [String] domain_name
689
+ # Name of domain to be deleted
690
+ # @param [String] fields
691
+ # Selector specifying which fields to include in a partial response.
692
+ # @param [String] quota_user
693
+ # Available to use for quota purposes for server-side applications. Can be any
694
+ # arbitrary string assigned to a user, but should not exceed 40 characters.
695
+ # Overrides userIp if both are provided.
696
+ # @param [String] user_ip
697
+ # IP address of the site where the request originates. Use this if you want to
698
+ # enforce per-user limits.
699
+ # @param [Google::Apis::RequestOptions] options
700
+ # Request-specific options
701
+ #
702
+ # @yield [result, err] Result & error if block supplied
703
+ # @yieldparam result [NilClass] No result returned for this method
704
+ # @yieldparam err [StandardError] error object if request failed
705
+ #
706
+ # @return [void]
707
+ #
708
+ # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
709
+ # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
710
+ # @raise [Google::Apis::AuthorizationError] Authorization is required
711
+ def delete_domain(customer, domain_name, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block)
712
+ command = make_simple_command(:delete, 'customer/{customer}/domains/{domainName}', options)
713
+ command.params['customer'] = customer unless customer.nil?
714
+ command.params['domainName'] = domain_name unless domain_name.nil?
715
+ command.query['fields'] = fields unless fields.nil?
716
+ command.query['quotaUser'] = quota_user unless quota_user.nil?
717
+ command.query['userIp'] = user_ip unless user_ip.nil?
718
+ execute_or_queue_command(command, &block)
719
+ end
720
+
721
+ # Retrieves a domain of the customer.
722
+ # @param [String] customer
723
+ # Immutable id of the Google Apps account.
724
+ # @param [String] domain_name
725
+ # Name of domain to be retrieved
726
+ # @param [String] fields
727
+ # Selector specifying which fields to include in a partial response.
728
+ # @param [String] quota_user
729
+ # Available to use for quota purposes for server-side applications. Can be any
730
+ # arbitrary string assigned to a user, but should not exceed 40 characters.
731
+ # Overrides userIp if both are provided.
732
+ # @param [String] user_ip
733
+ # IP address of the site where the request originates. Use this if you want to
734
+ # enforce per-user limits.
735
+ # @param [Google::Apis::RequestOptions] options
736
+ # Request-specific options
737
+ #
738
+ # @yield [result, err] Result & error if block supplied
739
+ # @yieldparam result [Google::Apis::AdminDirectoryV1::Domains] parsed result object
740
+ # @yieldparam err [StandardError] error object if request failed
741
+ #
742
+ # @return [Google::Apis::AdminDirectoryV1::Domains]
743
+ #
744
+ # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
745
+ # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
746
+ # @raise [Google::Apis::AuthorizationError] Authorization is required
747
+ def get_domain(customer, domain_name, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block)
748
+ command = make_simple_command(:get, 'customer/{customer}/domains/{domainName}', options)
749
+ command.response_representation = Google::Apis::AdminDirectoryV1::Domains::Representation
750
+ command.response_class = Google::Apis::AdminDirectoryV1::Domains
751
+ command.params['customer'] = customer unless customer.nil?
752
+ command.params['domainName'] = domain_name unless domain_name.nil?
753
+ command.query['fields'] = fields unless fields.nil?
754
+ command.query['quotaUser'] = quota_user unless quota_user.nil?
755
+ command.query['userIp'] = user_ip unless user_ip.nil?
756
+ execute_or_queue_command(command, &block)
757
+ end
758
+
759
+ # Inserts a domain of the customer.
760
+ # @param [String] customer
761
+ # Immutable id of the Google Apps account.
762
+ # @param [Google::Apis::AdminDirectoryV1::Domains] domains_object
763
+ # @param [String] fields
764
+ # Selector specifying which fields to include in a partial response.
765
+ # @param [String] quota_user
766
+ # Available to use for quota purposes for server-side applications. Can be any
767
+ # arbitrary string assigned to a user, but should not exceed 40 characters.
768
+ # Overrides userIp if both are provided.
769
+ # @param [String] user_ip
770
+ # IP address of the site where the request originates. Use this if you want to
771
+ # enforce per-user limits.
772
+ # @param [Google::Apis::RequestOptions] options
773
+ # Request-specific options
774
+ #
775
+ # @yield [result, err] Result & error if block supplied
776
+ # @yieldparam result [Google::Apis::AdminDirectoryV1::Domains] parsed result object
777
+ # @yieldparam err [StandardError] error object if request failed
778
+ #
779
+ # @return [Google::Apis::AdminDirectoryV1::Domains]
780
+ #
781
+ # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
782
+ # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
783
+ # @raise [Google::Apis::AuthorizationError] Authorization is required
784
+ def insert_domain(customer, domains_object = nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block)
785
+ command = make_simple_command(:post, 'customer/{customer}/domains', options)
786
+ command.request_representation = Google::Apis::AdminDirectoryV1::Domains::Representation
787
+ command.request_object = domains_object
788
+ command.response_representation = Google::Apis::AdminDirectoryV1::Domains::Representation
789
+ command.response_class = Google::Apis::AdminDirectoryV1::Domains
790
+ command.params['customer'] = customer unless customer.nil?
791
+ command.query['fields'] = fields unless fields.nil?
792
+ command.query['quotaUser'] = quota_user unless quota_user.nil?
793
+ command.query['userIp'] = user_ip unless user_ip.nil?
794
+ execute_or_queue_command(command, &block)
795
+ end
796
+
797
+ # Lists the domains of the customer.
798
+ # @param [String] customer
799
+ # Immutable id of the Google Apps account.
800
+ # @param [String] fields
801
+ # Selector specifying which fields to include in a partial response.
802
+ # @param [String] quota_user
803
+ # Available to use for quota purposes for server-side applications. Can be any
804
+ # arbitrary string assigned to a user, but should not exceed 40 characters.
805
+ # Overrides userIp if both are provided.
806
+ # @param [String] user_ip
807
+ # IP address of the site where the request originates. Use this if you want to
808
+ # enforce per-user limits.
809
+ # @param [Google::Apis::RequestOptions] options
810
+ # Request-specific options
811
+ #
812
+ # @yield [result, err] Result & error if block supplied
813
+ # @yieldparam result [Google::Apis::AdminDirectoryV1::Domains2] parsed result object
814
+ # @yieldparam err [StandardError] error object if request failed
815
+ #
816
+ # @return [Google::Apis::AdminDirectoryV1::Domains2]
817
+ #
818
+ # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
819
+ # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
820
+ # @raise [Google::Apis::AuthorizationError] Authorization is required
821
+ def list_domains(customer, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block)
822
+ command = make_simple_command(:get, 'customer/{customer}/domains', options)
823
+ command.response_representation = Google::Apis::AdminDirectoryV1::Domains2::Representation
824
+ command.response_class = Google::Apis::AdminDirectoryV1::Domains2
825
+ command.params['customer'] = customer unless customer.nil?
826
+ command.query['fields'] = fields unless fields.nil?
827
+ command.query['quotaUser'] = quota_user unless quota_user.nil?
828
+ command.query['userIp'] = user_ip unless user_ip.nil?
829
+ execute_or_queue_command(command, &block)
830
+ end
831
+
832
+ # Delete Group
833
+ # @param [String] group_key
834
+ # Email or immutable Id of the group
835
+ # @param [String] fields
836
+ # Selector specifying which fields to include in a partial response.
837
+ # @param [String] quota_user
838
+ # Available to use for quota purposes for server-side applications. Can be any
839
+ # arbitrary string assigned to a user, but should not exceed 40 characters.
840
+ # Overrides userIp if both are provided.
841
+ # @param [String] user_ip
842
+ # IP address of the site where the request originates. Use this if you want to
843
+ # enforce per-user limits.
844
+ # @param [Google::Apis::RequestOptions] options
845
+ # Request-specific options
846
+ #
847
+ # @yield [result, err] Result & error if block supplied
848
+ # @yieldparam result [NilClass] No result returned for this method
849
+ # @yieldparam err [StandardError] error object if request failed
850
+ #
851
+ # @return [void]
852
+ #
853
+ # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
854
+ # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
855
+ # @raise [Google::Apis::AuthorizationError] Authorization is required
856
+ def delete_group(group_key, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block)
857
+ command = make_simple_command(:delete, 'groups/{groupKey}', options)
858
+ command.params['groupKey'] = group_key unless group_key.nil?
859
+ command.query['fields'] = fields unless fields.nil?
860
+ command.query['quotaUser'] = quota_user unless quota_user.nil?
861
+ command.query['userIp'] = user_ip unless user_ip.nil?
862
+ execute_or_queue_command(command, &block)
863
+ end
864
+
865
+ # Retrieve Group
866
+ # @param [String] group_key
867
+ # Email or immutable Id of the group
868
+ # @param [String] fields
869
+ # Selector specifying which fields to include in a partial response.
870
+ # @param [String] quota_user
871
+ # Available to use for quota purposes for server-side applications. Can be any
872
+ # arbitrary string assigned to a user, but should not exceed 40 characters.
873
+ # Overrides userIp if both are provided.
874
+ # @param [String] user_ip
875
+ # IP address of the site where the request originates. Use this if you want to
876
+ # enforce per-user limits.
877
+ # @param [Google::Apis::RequestOptions] options
878
+ # Request-specific options
879
+ #
880
+ # @yield [result, err] Result & error if block supplied
881
+ # @yieldparam result [Google::Apis::AdminDirectoryV1::Group] parsed result object
882
+ # @yieldparam err [StandardError] error object if request failed
883
+ #
884
+ # @return [Google::Apis::AdminDirectoryV1::Group]
885
+ #
886
+ # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
887
+ # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
888
+ # @raise [Google::Apis::AuthorizationError] Authorization is required
889
+ def get_group(group_key, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block)
890
+ command = make_simple_command(:get, 'groups/{groupKey}', options)
891
+ command.response_representation = Google::Apis::AdminDirectoryV1::Group::Representation
892
+ command.response_class = Google::Apis::AdminDirectoryV1::Group
893
+ command.params['groupKey'] = group_key unless group_key.nil?
894
+ command.query['fields'] = fields unless fields.nil?
895
+ command.query['quotaUser'] = quota_user unless quota_user.nil?
896
+ command.query['userIp'] = user_ip unless user_ip.nil?
897
+ execute_or_queue_command(command, &block)
898
+ end
899
+
900
+ # Create Group
901
+ # @param [Google::Apis::AdminDirectoryV1::Group] group_object
902
+ # @param [String] fields
903
+ # Selector specifying which fields to include in a partial response.
904
+ # @param [String] quota_user
905
+ # Available to use for quota purposes for server-side applications. Can be any
906
+ # arbitrary string assigned to a user, but should not exceed 40 characters.
907
+ # Overrides userIp if both are provided.
908
+ # @param [String] user_ip
909
+ # IP address of the site where the request originates. Use this if you want to
910
+ # enforce per-user limits.
911
+ # @param [Google::Apis::RequestOptions] options
912
+ # Request-specific options
913
+ #
914
+ # @yield [result, err] Result & error if block supplied
915
+ # @yieldparam result [Google::Apis::AdminDirectoryV1::Group] parsed result object
916
+ # @yieldparam err [StandardError] error object if request failed
917
+ #
918
+ # @return [Google::Apis::AdminDirectoryV1::Group]
919
+ #
920
+ # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
921
+ # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
922
+ # @raise [Google::Apis::AuthorizationError] Authorization is required
923
+ def insert_group(group_object = nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block)
924
+ command = make_simple_command(:post, 'groups', options)
925
+ command.request_representation = Google::Apis::AdminDirectoryV1::Group::Representation
926
+ command.request_object = group_object
927
+ command.response_representation = Google::Apis::AdminDirectoryV1::Group::Representation
928
+ command.response_class = Google::Apis::AdminDirectoryV1::Group
929
+ command.query['fields'] = fields unless fields.nil?
930
+ command.query['quotaUser'] = quota_user unless quota_user.nil?
931
+ command.query['userIp'] = user_ip unless user_ip.nil?
932
+ execute_or_queue_command(command, &block)
933
+ end
934
+
935
+ # Retrieve all groups in a domain (paginated)
936
+ # @param [String] customer
937
+ # Immutable id of the Google Apps account. In case of multi-domain, to fetch all
938
+ # groups for a customer, fill this field instead of domain.
939
+ # @param [String] domain
940
+ # Name of the domain. Fill this field to get groups from only this domain. To
941
+ # return all groups in a multi-domain fill customer field instead.
942
+ # @param [Fixnum] max_results
943
+ # Maximum number of results to return. Default is 200
944
+ # @param [String] page_token
945
+ # Token to specify next page in the list
946
+ # @param [String] user_key
947
+ # Email or immutable Id of the user if only those groups are to be listed, the
948
+ # given user is a member of. If Id, it should match with id of user object
949
+ # @param [String] fields
950
+ # Selector specifying which fields to include in a partial response.
951
+ # @param [String] quota_user
952
+ # Available to use for quota purposes for server-side applications. Can be any
953
+ # arbitrary string assigned to a user, but should not exceed 40 characters.
954
+ # Overrides userIp if both are provided.
955
+ # @param [String] user_ip
956
+ # IP address of the site where the request originates. Use this if you want to
957
+ # enforce per-user limits.
958
+ # @param [Google::Apis::RequestOptions] options
959
+ # Request-specific options
960
+ #
961
+ # @yield [result, err] Result & error if block supplied
962
+ # @yieldparam result [Google::Apis::AdminDirectoryV1::Groups] parsed result object
963
+ # @yieldparam err [StandardError] error object if request failed
964
+ #
965
+ # @return [Google::Apis::AdminDirectoryV1::Groups]
966
+ #
967
+ # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
968
+ # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
969
+ # @raise [Google::Apis::AuthorizationError] Authorization is required
970
+ def list_groups(customer: nil, domain: nil, max_results: nil, page_token: nil, user_key: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block)
971
+ command = make_simple_command(:get, 'groups', options)
972
+ command.response_representation = Google::Apis::AdminDirectoryV1::Groups::Representation
973
+ command.response_class = Google::Apis::AdminDirectoryV1::Groups
974
+ command.query['customer'] = customer unless customer.nil?
975
+ command.query['domain'] = domain unless domain.nil?
976
+ command.query['maxResults'] = max_results unless max_results.nil?
977
+ command.query['pageToken'] = page_token unless page_token.nil?
978
+ command.query['userKey'] = user_key unless user_key.nil?
979
+ command.query['fields'] = fields unless fields.nil?
980
+ command.query['quotaUser'] = quota_user unless quota_user.nil?
981
+ command.query['userIp'] = user_ip unless user_ip.nil?
982
+ execute_or_queue_command(command, &block)
983
+ end
984
+
985
+ # Update Group. This method supports patch semantics.
986
+ # @param [String] group_key
987
+ # Email or immutable Id of the group. If Id, it should match with id of group
988
+ # object
989
+ # @param [Google::Apis::AdminDirectoryV1::Group] group_object
990
+ # @param [String] fields
991
+ # Selector specifying which fields to include in a partial response.
992
+ # @param [String] quota_user
993
+ # Available to use for quota purposes for server-side applications. Can be any
994
+ # arbitrary string assigned to a user, but should not exceed 40 characters.
995
+ # Overrides userIp if both are provided.
996
+ # @param [String] user_ip
997
+ # IP address of the site where the request originates. Use this if you want to
998
+ # enforce per-user limits.
999
+ # @param [Google::Apis::RequestOptions] options
1000
+ # Request-specific options
1001
+ #
1002
+ # @yield [result, err] Result & error if block supplied
1003
+ # @yieldparam result [Google::Apis::AdminDirectoryV1::Group] parsed result object
1004
+ # @yieldparam err [StandardError] error object if request failed
1005
+ #
1006
+ # @return [Google::Apis::AdminDirectoryV1::Group]
1007
+ #
1008
+ # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
1009
+ # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
1010
+ # @raise [Google::Apis::AuthorizationError] Authorization is required
1011
+ def patch_group(group_key, group_object = nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block)
1012
+ command = make_simple_command(:patch, 'groups/{groupKey}', options)
1013
+ command.request_representation = Google::Apis::AdminDirectoryV1::Group::Representation
1014
+ command.request_object = group_object
1015
+ command.response_representation = Google::Apis::AdminDirectoryV1::Group::Representation
1016
+ command.response_class = Google::Apis::AdminDirectoryV1::Group
1017
+ command.params['groupKey'] = group_key unless group_key.nil?
1018
+ command.query['fields'] = fields unless fields.nil?
1019
+ command.query['quotaUser'] = quota_user unless quota_user.nil?
1020
+ command.query['userIp'] = user_ip unless user_ip.nil?
1021
+ execute_or_queue_command(command, &block)
1022
+ end
1023
+
1024
+ # Update Group
1025
+ # @param [String] group_key
1026
+ # Email or immutable Id of the group. If Id, it should match with id of group
1027
+ # object
1028
+ # @param [Google::Apis::AdminDirectoryV1::Group] group_object
1029
+ # @param [String] fields
1030
+ # Selector specifying which fields to include in a partial response.
1031
+ # @param [String] quota_user
1032
+ # Available to use for quota purposes for server-side applications. Can be any
1033
+ # arbitrary string assigned to a user, but should not exceed 40 characters.
1034
+ # Overrides userIp if both are provided.
1035
+ # @param [String] user_ip
1036
+ # IP address of the site where the request originates. Use this if you want to
1037
+ # enforce per-user limits.
1038
+ # @param [Google::Apis::RequestOptions] options
1039
+ # Request-specific options
1040
+ #
1041
+ # @yield [result, err] Result & error if block supplied
1042
+ # @yieldparam result [Google::Apis::AdminDirectoryV1::Group] parsed result object
1043
+ # @yieldparam err [StandardError] error object if request failed
1044
+ #
1045
+ # @return [Google::Apis::AdminDirectoryV1::Group]
1046
+ #
1047
+ # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
1048
+ # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
1049
+ # @raise [Google::Apis::AuthorizationError] Authorization is required
1050
+ def update_group(group_key, group_object = nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block)
1051
+ command = make_simple_command(:put, 'groups/{groupKey}', options)
1052
+ command.request_representation = Google::Apis::AdminDirectoryV1::Group::Representation
1053
+ command.request_object = group_object
1054
+ command.response_representation = Google::Apis::AdminDirectoryV1::Group::Representation
1055
+ command.response_class = Google::Apis::AdminDirectoryV1::Group
1056
+ command.params['groupKey'] = group_key unless group_key.nil?
1057
+ command.query['fields'] = fields unless fields.nil?
1058
+ command.query['quotaUser'] = quota_user unless quota_user.nil?
1059
+ command.query['userIp'] = user_ip unless user_ip.nil?
1060
+ execute_or_queue_command(command, &block)
1061
+ end
1062
+
1063
+ # Remove a alias for the group
1064
+ # @param [String] group_key
1065
+ # Email or immutable Id of the group
1066
+ # @param [String] group_alias
1067
+ # The alias to be removed
1068
+ # @param [String] fields
1069
+ # Selector specifying which fields to include in a partial response.
1070
+ # @param [String] quota_user
1071
+ # Available to use for quota purposes for server-side applications. Can be any
1072
+ # arbitrary string assigned to a user, but should not exceed 40 characters.
1073
+ # Overrides userIp if both are provided.
1074
+ # @param [String] user_ip
1075
+ # IP address of the site where the request originates. Use this if you want to
1076
+ # enforce per-user limits.
1077
+ # @param [Google::Apis::RequestOptions] options
1078
+ # Request-specific options
1079
+ #
1080
+ # @yield [result, err] Result & error if block supplied
1081
+ # @yieldparam result [NilClass] No result returned for this method
1082
+ # @yieldparam err [StandardError] error object if request failed
1083
+ #
1084
+ # @return [void]
1085
+ #
1086
+ # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
1087
+ # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
1088
+ # @raise [Google::Apis::AuthorizationError] Authorization is required
1089
+ def delete_group_alias(group_key, group_alias, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block)
1090
+ command = make_simple_command(:delete, 'groups/{groupKey}/aliases/{alias}', options)
1091
+ command.params['groupKey'] = group_key unless group_key.nil?
1092
+ command.params['alias'] = group_alias unless group_alias.nil?
1093
+ command.query['fields'] = fields unless fields.nil?
1094
+ command.query['quotaUser'] = quota_user unless quota_user.nil?
1095
+ command.query['userIp'] = user_ip unless user_ip.nil?
1096
+ execute_or_queue_command(command, &block)
1097
+ end
1098
+
1099
+ # Add a alias for the group
1100
+ # @param [String] group_key
1101
+ # Email or immutable Id of the group
1102
+ # @param [Google::Apis::AdminDirectoryV1::Alias] alias_object
1103
+ # @param [String] fields
1104
+ # Selector specifying which fields to include in a partial response.
1105
+ # @param [String] quota_user
1106
+ # Available to use for quota purposes for server-side applications. Can be any
1107
+ # arbitrary string assigned to a user, but should not exceed 40 characters.
1108
+ # Overrides userIp if both are provided.
1109
+ # @param [String] user_ip
1110
+ # IP address of the site where the request originates. Use this if you want to
1111
+ # enforce per-user limits.
1112
+ # @param [Google::Apis::RequestOptions] options
1113
+ # Request-specific options
1114
+ #
1115
+ # @yield [result, err] Result & error if block supplied
1116
+ # @yieldparam result [Google::Apis::AdminDirectoryV1::Alias] parsed result object
1117
+ # @yieldparam err [StandardError] error object if request failed
1118
+ #
1119
+ # @return [Google::Apis::AdminDirectoryV1::Alias]
1120
+ #
1121
+ # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
1122
+ # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
1123
+ # @raise [Google::Apis::AuthorizationError] Authorization is required
1124
+ def insert_group_alias(group_key, alias_object = nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block)
1125
+ command = make_simple_command(:post, 'groups/{groupKey}/aliases', options)
1126
+ command.request_representation = Google::Apis::AdminDirectoryV1::Alias::Representation
1127
+ command.request_object = alias_object
1128
+ command.response_representation = Google::Apis::AdminDirectoryV1::Alias::Representation
1129
+ command.response_class = Google::Apis::AdminDirectoryV1::Alias
1130
+ command.params['groupKey'] = group_key unless group_key.nil?
1131
+ command.query['fields'] = fields unless fields.nil?
1132
+ command.query['quotaUser'] = quota_user unless quota_user.nil?
1133
+ command.query['userIp'] = user_ip unless user_ip.nil?
1134
+ execute_or_queue_command(command, &block)
1135
+ end
1136
+
1137
+ # List all aliases for a group
1138
+ # @param [String] group_key
1139
+ # Email or immutable Id of the group
1140
+ # @param [String] fields
1141
+ # Selector specifying which fields to include in a partial response.
1142
+ # @param [String] quota_user
1143
+ # Available to use for quota purposes for server-side applications. Can be any
1144
+ # arbitrary string assigned to a user, but should not exceed 40 characters.
1145
+ # Overrides userIp if both are provided.
1146
+ # @param [String] user_ip
1147
+ # IP address of the site where the request originates. Use this if you want to
1148
+ # enforce per-user limits.
1149
+ # @param [Google::Apis::RequestOptions] options
1150
+ # Request-specific options
1151
+ #
1152
+ # @yield [result, err] Result & error if block supplied
1153
+ # @yieldparam result [Google::Apis::AdminDirectoryV1::Aliases] parsed result object
1154
+ # @yieldparam err [StandardError] error object if request failed
1155
+ #
1156
+ # @return [Google::Apis::AdminDirectoryV1::Aliases]
1157
+ #
1158
+ # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
1159
+ # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
1160
+ # @raise [Google::Apis::AuthorizationError] Authorization is required
1161
+ def list_group_aliases(group_key, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block)
1162
+ command = make_simple_command(:get, 'groups/{groupKey}/aliases', options)
1163
+ command.response_representation = Google::Apis::AdminDirectoryV1::Aliases::Representation
1164
+ command.response_class = Google::Apis::AdminDirectoryV1::Aliases
1165
+ command.params['groupKey'] = group_key unless group_key.nil?
1166
+ command.query['fields'] = fields unless fields.nil?
1167
+ command.query['quotaUser'] = quota_user unless quota_user.nil?
1168
+ command.query['userIp'] = user_ip unless user_ip.nil?
1169
+ execute_or_queue_command(command, &block)
1170
+ end
1171
+
1172
+ # Remove membership.
1173
+ # @param [String] group_key
1174
+ # Email or immutable Id of the group
1175
+ # @param [String] member_key
1176
+ # Email or immutable Id of the member
1177
+ # @param [String] fields
1178
+ # Selector specifying which fields to include in a partial response.
1179
+ # @param [String] quota_user
1180
+ # Available to use for quota purposes for server-side applications. Can be any
1181
+ # arbitrary string assigned to a user, but should not exceed 40 characters.
1182
+ # Overrides userIp if both are provided.
1183
+ # @param [String] user_ip
1184
+ # IP address of the site where the request originates. Use this if you want to
1185
+ # enforce per-user limits.
1186
+ # @param [Google::Apis::RequestOptions] options
1187
+ # Request-specific options
1188
+ #
1189
+ # @yield [result, err] Result & error if block supplied
1190
+ # @yieldparam result [NilClass] No result returned for this method
1191
+ # @yieldparam err [StandardError] error object if request failed
1192
+ #
1193
+ # @return [void]
1194
+ #
1195
+ # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
1196
+ # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
1197
+ # @raise [Google::Apis::AuthorizationError] Authorization is required
1198
+ def delete_member(group_key, member_key, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block)
1199
+ command = make_simple_command(:delete, 'groups/{groupKey}/members/{memberKey}', options)
1200
+ command.params['groupKey'] = group_key unless group_key.nil?
1201
+ command.params['memberKey'] = member_key unless member_key.nil?
1202
+ command.query['fields'] = fields unless fields.nil?
1203
+ command.query['quotaUser'] = quota_user unless quota_user.nil?
1204
+ command.query['userIp'] = user_ip unless user_ip.nil?
1205
+ execute_or_queue_command(command, &block)
1206
+ end
1207
+
1208
+ # Retrieve Group Member
1209
+ # @param [String] group_key
1210
+ # Email or immutable Id of the group
1211
+ # @param [String] member_key
1212
+ # Email or immutable Id of the member
1213
+ # @param [String] fields
1214
+ # Selector specifying which fields to include in a partial response.
1215
+ # @param [String] quota_user
1216
+ # Available to use for quota purposes for server-side applications. Can be any
1217
+ # arbitrary string assigned to a user, but should not exceed 40 characters.
1218
+ # Overrides userIp if both are provided.
1219
+ # @param [String] user_ip
1220
+ # IP address of the site where the request originates. Use this if you want to
1221
+ # enforce per-user limits.
1222
+ # @param [Google::Apis::RequestOptions] options
1223
+ # Request-specific options
1224
+ #
1225
+ # @yield [result, err] Result & error if block supplied
1226
+ # @yieldparam result [Google::Apis::AdminDirectoryV1::Member] parsed result object
1227
+ # @yieldparam err [StandardError] error object if request failed
1228
+ #
1229
+ # @return [Google::Apis::AdminDirectoryV1::Member]
1230
+ #
1231
+ # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
1232
+ # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
1233
+ # @raise [Google::Apis::AuthorizationError] Authorization is required
1234
+ def get_member(group_key, member_key, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block)
1235
+ command = make_simple_command(:get, 'groups/{groupKey}/members/{memberKey}', options)
1236
+ command.response_representation = Google::Apis::AdminDirectoryV1::Member::Representation
1237
+ command.response_class = Google::Apis::AdminDirectoryV1::Member
1238
+ command.params['groupKey'] = group_key unless group_key.nil?
1239
+ command.params['memberKey'] = member_key unless member_key.nil?
1240
+ command.query['fields'] = fields unless fields.nil?
1241
+ command.query['quotaUser'] = quota_user unless quota_user.nil?
1242
+ command.query['userIp'] = user_ip unless user_ip.nil?
1243
+ execute_or_queue_command(command, &block)
1244
+ end
1245
+
1246
+ # Add user to the specified group.
1247
+ # @param [String] group_key
1248
+ # Email or immutable Id of the group
1249
+ # @param [Google::Apis::AdminDirectoryV1::Member] member_object
1250
+ # @param [String] fields
1251
+ # Selector specifying which fields to include in a partial response.
1252
+ # @param [String] quota_user
1253
+ # Available to use for quota purposes for server-side applications. Can be any
1254
+ # arbitrary string assigned to a user, but should not exceed 40 characters.
1255
+ # Overrides userIp if both are provided.
1256
+ # @param [String] user_ip
1257
+ # IP address of the site where the request originates. Use this if you want to
1258
+ # enforce per-user limits.
1259
+ # @param [Google::Apis::RequestOptions] options
1260
+ # Request-specific options
1261
+ #
1262
+ # @yield [result, err] Result & error if block supplied
1263
+ # @yieldparam result [Google::Apis::AdminDirectoryV1::Member] parsed result object
1264
+ # @yieldparam err [StandardError] error object if request failed
1265
+ #
1266
+ # @return [Google::Apis::AdminDirectoryV1::Member]
1267
+ #
1268
+ # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
1269
+ # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
1270
+ # @raise [Google::Apis::AuthorizationError] Authorization is required
1271
+ def insert_member(group_key, member_object = nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block)
1272
+ command = make_simple_command(:post, 'groups/{groupKey}/members', options)
1273
+ command.request_representation = Google::Apis::AdminDirectoryV1::Member::Representation
1274
+ command.request_object = member_object
1275
+ command.response_representation = Google::Apis::AdminDirectoryV1::Member::Representation
1276
+ command.response_class = Google::Apis::AdminDirectoryV1::Member
1277
+ command.params['groupKey'] = group_key unless group_key.nil?
1278
+ command.query['fields'] = fields unless fields.nil?
1279
+ command.query['quotaUser'] = quota_user unless quota_user.nil?
1280
+ command.query['userIp'] = user_ip unless user_ip.nil?
1281
+ execute_or_queue_command(command, &block)
1282
+ end
1283
+
1284
+ # Retrieve all members in a group (paginated)
1285
+ # @param [String] group_key
1286
+ # Email or immutable Id of the group
1287
+ # @param [Fixnum] max_results
1288
+ # Maximum number of results to return. Default is 200
1289
+ # @param [String] page_token
1290
+ # Token to specify next page in the list
1291
+ # @param [String] roles
1292
+ # Comma separated role values to filter list results on.
1293
+ # @param [String] fields
1294
+ # Selector specifying which fields to include in a partial response.
1295
+ # @param [String] quota_user
1296
+ # Available to use for quota purposes for server-side applications. Can be any
1297
+ # arbitrary string assigned to a user, but should not exceed 40 characters.
1298
+ # Overrides userIp if both are provided.
1299
+ # @param [String] user_ip
1300
+ # IP address of the site where the request originates. Use this if you want to
1301
+ # enforce per-user limits.
1302
+ # @param [Google::Apis::RequestOptions] options
1303
+ # Request-specific options
1304
+ #
1305
+ # @yield [result, err] Result & error if block supplied
1306
+ # @yieldparam result [Google::Apis::AdminDirectoryV1::Members] parsed result object
1307
+ # @yieldparam err [StandardError] error object if request failed
1308
+ #
1309
+ # @return [Google::Apis::AdminDirectoryV1::Members]
1310
+ #
1311
+ # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
1312
+ # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
1313
+ # @raise [Google::Apis::AuthorizationError] Authorization is required
1314
+ def list_members(group_key, max_results: nil, page_token: nil, roles: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block)
1315
+ command = make_simple_command(:get, 'groups/{groupKey}/members', options)
1316
+ command.response_representation = Google::Apis::AdminDirectoryV1::Members::Representation
1317
+ command.response_class = Google::Apis::AdminDirectoryV1::Members
1318
+ command.params['groupKey'] = group_key unless group_key.nil?
1319
+ command.query['maxResults'] = max_results unless max_results.nil?
1320
+ command.query['pageToken'] = page_token unless page_token.nil?
1321
+ command.query['roles'] = roles unless roles.nil?
1322
+ command.query['fields'] = fields unless fields.nil?
1323
+ command.query['quotaUser'] = quota_user unless quota_user.nil?
1324
+ command.query['userIp'] = user_ip unless user_ip.nil?
1325
+ execute_or_queue_command(command, &block)
1326
+ end
1327
+
1328
+ # Update membership of a user in the specified group. This method supports patch
1329
+ # semantics.
1330
+ # @param [String] group_key
1331
+ # Email or immutable Id of the group. If Id, it should match with id of group
1332
+ # object
1333
+ # @param [String] member_key
1334
+ # Email or immutable Id of the user. If Id, it should match with id of member
1335
+ # object
1336
+ # @param [Google::Apis::AdminDirectoryV1::Member] member_object
1337
+ # @param [String] fields
1338
+ # Selector specifying which fields to include in a partial response.
1339
+ # @param [String] quota_user
1340
+ # Available to use for quota purposes for server-side applications. Can be any
1341
+ # arbitrary string assigned to a user, but should not exceed 40 characters.
1342
+ # Overrides userIp if both are provided.
1343
+ # @param [String] user_ip
1344
+ # IP address of the site where the request originates. Use this if you want to
1345
+ # enforce per-user limits.
1346
+ # @param [Google::Apis::RequestOptions] options
1347
+ # Request-specific options
1348
+ #
1349
+ # @yield [result, err] Result & error if block supplied
1350
+ # @yieldparam result [Google::Apis::AdminDirectoryV1::Member] parsed result object
1351
+ # @yieldparam err [StandardError] error object if request failed
1352
+ #
1353
+ # @return [Google::Apis::AdminDirectoryV1::Member]
1354
+ #
1355
+ # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
1356
+ # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
1357
+ # @raise [Google::Apis::AuthorizationError] Authorization is required
1358
+ def patch_member(group_key, member_key, member_object = nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block)
1359
+ command = make_simple_command(:patch, 'groups/{groupKey}/members/{memberKey}', options)
1360
+ command.request_representation = Google::Apis::AdminDirectoryV1::Member::Representation
1361
+ command.request_object = member_object
1362
+ command.response_representation = Google::Apis::AdminDirectoryV1::Member::Representation
1363
+ command.response_class = Google::Apis::AdminDirectoryV1::Member
1364
+ command.params['groupKey'] = group_key unless group_key.nil?
1365
+ command.params['memberKey'] = member_key unless member_key.nil?
1366
+ command.query['fields'] = fields unless fields.nil?
1367
+ command.query['quotaUser'] = quota_user unless quota_user.nil?
1368
+ command.query['userIp'] = user_ip unless user_ip.nil?
1369
+ execute_or_queue_command(command, &block)
1370
+ end
1371
+
1372
+ # Update membership of a user in the specified group.
1373
+ # @param [String] group_key
1374
+ # Email or immutable Id of the group. If Id, it should match with id of group
1375
+ # object
1376
+ # @param [String] member_key
1377
+ # Email or immutable Id of the user. If Id, it should match with id of member
1378
+ # object
1379
+ # @param [Google::Apis::AdminDirectoryV1::Member] member_object
1380
+ # @param [String] fields
1381
+ # Selector specifying which fields to include in a partial response.
1382
+ # @param [String] quota_user
1383
+ # Available to use for quota purposes for server-side applications. Can be any
1384
+ # arbitrary string assigned to a user, but should not exceed 40 characters.
1385
+ # Overrides userIp if both are provided.
1386
+ # @param [String] user_ip
1387
+ # IP address of the site where the request originates. Use this if you want to
1388
+ # enforce per-user limits.
1389
+ # @param [Google::Apis::RequestOptions] options
1390
+ # Request-specific options
1391
+ #
1392
+ # @yield [result, err] Result & error if block supplied
1393
+ # @yieldparam result [Google::Apis::AdminDirectoryV1::Member] parsed result object
1394
+ # @yieldparam err [StandardError] error object if request failed
1395
+ #
1396
+ # @return [Google::Apis::AdminDirectoryV1::Member]
1397
+ #
1398
+ # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
1399
+ # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
1400
+ # @raise [Google::Apis::AuthorizationError] Authorization is required
1401
+ def update_member(group_key, member_key, member_object = nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block)
1402
+ command = make_simple_command(:put, 'groups/{groupKey}/members/{memberKey}', options)
1403
+ command.request_representation = Google::Apis::AdminDirectoryV1::Member::Representation
1404
+ command.request_object = member_object
1405
+ command.response_representation = Google::Apis::AdminDirectoryV1::Member::Representation
1406
+ command.response_class = Google::Apis::AdminDirectoryV1::Member
1407
+ command.params['groupKey'] = group_key unless group_key.nil?
1408
+ command.params['memberKey'] = member_key unless member_key.nil?
1409
+ command.query['fields'] = fields unless fields.nil?
1410
+ command.query['quotaUser'] = quota_user unless quota_user.nil?
1411
+ command.query['userIp'] = user_ip unless user_ip.nil?
1412
+ execute_or_queue_command(command, &block)
1413
+ end
1414
+
1415
+ # Take action on Mobile Device
1416
+ # @param [String] customer_id
1417
+ # Immutable id of the Google Apps account
1418
+ # @param [String] resource_id
1419
+ # Immutable id of Mobile Device
1420
+ # @param [Google::Apis::AdminDirectoryV1::MobileDeviceAction] mobile_device_action_object
1421
+ # @param [String] fields
1422
+ # Selector specifying which fields to include in a partial response.
1423
+ # @param [String] quota_user
1424
+ # Available to use for quota purposes for server-side applications. Can be any
1425
+ # arbitrary string assigned to a user, but should not exceed 40 characters.
1426
+ # Overrides userIp if both are provided.
1427
+ # @param [String] user_ip
1428
+ # IP address of the site where the request originates. Use this if you want to
1429
+ # enforce per-user limits.
1430
+ # @param [Google::Apis::RequestOptions] options
1431
+ # Request-specific options
1432
+ #
1433
+ # @yield [result, err] Result & error if block supplied
1434
+ # @yieldparam result [NilClass] No result returned for this method
1435
+ # @yieldparam err [StandardError] error object if request failed
1436
+ #
1437
+ # @return [void]
1438
+ #
1439
+ # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
1440
+ # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
1441
+ # @raise [Google::Apis::AuthorizationError] Authorization is required
1442
+ def action_mobile_device(customer_id, resource_id, mobile_device_action_object = nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block)
1443
+ command = make_simple_command(:post, 'customer/{customerId}/devices/mobile/{resourceId}/action', options)
1444
+ command.request_representation = Google::Apis::AdminDirectoryV1::MobileDeviceAction::Representation
1445
+ command.request_object = mobile_device_action_object
1446
+ command.params['customerId'] = customer_id unless customer_id.nil?
1447
+ command.params['resourceId'] = resource_id unless resource_id.nil?
1448
+ command.query['fields'] = fields unless fields.nil?
1449
+ command.query['quotaUser'] = quota_user unless quota_user.nil?
1450
+ command.query['userIp'] = user_ip unless user_ip.nil?
1451
+ execute_or_queue_command(command, &block)
1452
+ end
1453
+
1454
+ # Delete Mobile Device
1455
+ # @param [String] customer_id
1456
+ # Immutable id of the Google Apps account
1457
+ # @param [String] resource_id
1458
+ # Immutable id of Mobile Device
1459
+ # @param [String] fields
1460
+ # Selector specifying which fields to include in a partial response.
1461
+ # @param [String] quota_user
1462
+ # Available to use for quota purposes for server-side applications. Can be any
1463
+ # arbitrary string assigned to a user, but should not exceed 40 characters.
1464
+ # Overrides userIp if both are provided.
1465
+ # @param [String] user_ip
1466
+ # IP address of the site where the request originates. Use this if you want to
1467
+ # enforce per-user limits.
1468
+ # @param [Google::Apis::RequestOptions] options
1469
+ # Request-specific options
1470
+ #
1471
+ # @yield [result, err] Result & error if block supplied
1472
+ # @yieldparam result [NilClass] No result returned for this method
1473
+ # @yieldparam err [StandardError] error object if request failed
1474
+ #
1475
+ # @return [void]
1476
+ #
1477
+ # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
1478
+ # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
1479
+ # @raise [Google::Apis::AuthorizationError] Authorization is required
1480
+ def delete_mobile_device(customer_id, resource_id, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block)
1481
+ command = make_simple_command(:delete, 'customer/{customerId}/devices/mobile/{resourceId}', options)
1482
+ command.params['customerId'] = customer_id unless customer_id.nil?
1483
+ command.params['resourceId'] = resource_id unless resource_id.nil?
1484
+ command.query['fields'] = fields unless fields.nil?
1485
+ command.query['quotaUser'] = quota_user unless quota_user.nil?
1486
+ command.query['userIp'] = user_ip unless user_ip.nil?
1487
+ execute_or_queue_command(command, &block)
1488
+ end
1489
+
1490
+ # Retrieve Mobile Device
1491
+ # @param [String] customer_id
1492
+ # Immutable id of the Google Apps account
1493
+ # @param [String] resource_id
1494
+ # Immutable id of Mobile Device
1495
+ # @param [String] projection
1496
+ # Restrict information returned to a set of selected fields.
1497
+ # @param [String] fields
1498
+ # Selector specifying which fields to include in a partial response.
1499
+ # @param [String] quota_user
1500
+ # Available to use for quota purposes for server-side applications. Can be any
1501
+ # arbitrary string assigned to a user, but should not exceed 40 characters.
1502
+ # Overrides userIp if both are provided.
1503
+ # @param [String] user_ip
1504
+ # IP address of the site where the request originates. Use this if you want to
1505
+ # enforce per-user limits.
1506
+ # @param [Google::Apis::RequestOptions] options
1507
+ # Request-specific options
1508
+ #
1509
+ # @yield [result, err] Result & error if block supplied
1510
+ # @yieldparam result [Google::Apis::AdminDirectoryV1::MobileDevice] parsed result object
1511
+ # @yieldparam err [StandardError] error object if request failed
1512
+ #
1513
+ # @return [Google::Apis::AdminDirectoryV1::MobileDevice]
1514
+ #
1515
+ # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
1516
+ # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
1517
+ # @raise [Google::Apis::AuthorizationError] Authorization is required
1518
+ def get_mobile_device(customer_id, resource_id, projection: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block)
1519
+ command = make_simple_command(:get, 'customer/{customerId}/devices/mobile/{resourceId}', options)
1520
+ command.response_representation = Google::Apis::AdminDirectoryV1::MobileDevice::Representation
1521
+ command.response_class = Google::Apis::AdminDirectoryV1::MobileDevice
1522
+ command.params['customerId'] = customer_id unless customer_id.nil?
1523
+ command.params['resourceId'] = resource_id unless resource_id.nil?
1524
+ command.query['projection'] = projection unless projection.nil?
1525
+ command.query['fields'] = fields unless fields.nil?
1526
+ command.query['quotaUser'] = quota_user unless quota_user.nil?
1527
+ command.query['userIp'] = user_ip unless user_ip.nil?
1528
+ execute_or_queue_command(command, &block)
1529
+ end
1530
+
1531
+ # Retrieve all Mobile Devices of a customer (paginated)
1532
+ # @param [String] customer_id
1533
+ # Immutable id of the Google Apps account
1534
+ # @param [Fixnum] max_results
1535
+ # Maximum number of results to return. Default is 100
1536
+ # @param [String] order_by
1537
+ # Column to use for sorting results
1538
+ # @param [String] page_token
1539
+ # Token to specify next page in the list
1540
+ # @param [String] projection
1541
+ # Restrict information returned to a set of selected fields.
1542
+ # @param [String] query
1543
+ # Search string in the format given at http://support.google.com/a/bin/answer.py?
1544
+ # hl=en&answer=1408863#search
1545
+ # @param [String] sort_order
1546
+ # Whether to return results in ascending or descending order. Only of use when
1547
+ # orderBy is also used
1548
+ # @param [String] fields
1549
+ # Selector specifying which fields to include in a partial response.
1550
+ # @param [String] quota_user
1551
+ # Available to use for quota purposes for server-side applications. Can be any
1552
+ # arbitrary string assigned to a user, but should not exceed 40 characters.
1553
+ # Overrides userIp if both are provided.
1554
+ # @param [String] user_ip
1555
+ # IP address of the site where the request originates. Use this if you want to
1556
+ # enforce per-user limits.
1557
+ # @param [Google::Apis::RequestOptions] options
1558
+ # Request-specific options
1559
+ #
1560
+ # @yield [result, err] Result & error if block supplied
1561
+ # @yieldparam result [Google::Apis::AdminDirectoryV1::MobileDevices] parsed result object
1562
+ # @yieldparam err [StandardError] error object if request failed
1563
+ #
1564
+ # @return [Google::Apis::AdminDirectoryV1::MobileDevices]
1565
+ #
1566
+ # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
1567
+ # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
1568
+ # @raise [Google::Apis::AuthorizationError] Authorization is required
1569
+ def list_mobile_devices(customer_id, max_results: nil, order_by: nil, page_token: nil, projection: nil, query: nil, sort_order: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block)
1570
+ command = make_simple_command(:get, 'customer/{customerId}/devices/mobile', options)
1571
+ command.response_representation = Google::Apis::AdminDirectoryV1::MobileDevices::Representation
1572
+ command.response_class = Google::Apis::AdminDirectoryV1::MobileDevices
1573
+ command.params['customerId'] = customer_id unless customer_id.nil?
1574
+ command.query['maxResults'] = max_results unless max_results.nil?
1575
+ command.query['orderBy'] = order_by unless order_by.nil?
1576
+ command.query['pageToken'] = page_token unless page_token.nil?
1577
+ command.query['projection'] = projection unless projection.nil?
1578
+ command.query['query'] = query unless query.nil?
1579
+ command.query['sortOrder'] = sort_order unless sort_order.nil?
1580
+ command.query['fields'] = fields unless fields.nil?
1581
+ command.query['quotaUser'] = quota_user unless quota_user.nil?
1582
+ command.query['userIp'] = user_ip unless user_ip.nil?
1583
+ execute_or_queue_command(command, &block)
1584
+ end
1585
+
1586
+ # Deletes a notification
1587
+ # @param [String] customer
1588
+ # The unique ID for the customer's Google account. The customerId is also
1589
+ # returned as part of the Users resource.
1590
+ # @param [String] notification_id
1591
+ # The unique ID of the notification.
1592
+ # @param [String] fields
1593
+ # Selector specifying which fields to include in a partial response.
1594
+ # @param [String] quota_user
1595
+ # Available to use for quota purposes for server-side applications. Can be any
1596
+ # arbitrary string assigned to a user, but should not exceed 40 characters.
1597
+ # Overrides userIp if both are provided.
1598
+ # @param [String] user_ip
1599
+ # IP address of the site where the request originates. Use this if you want to
1600
+ # enforce per-user limits.
1601
+ # @param [Google::Apis::RequestOptions] options
1602
+ # Request-specific options
1603
+ #
1604
+ # @yield [result, err] Result & error if block supplied
1605
+ # @yieldparam result [NilClass] No result returned for this method
1606
+ # @yieldparam err [StandardError] error object if request failed
1607
+ #
1608
+ # @return [void]
1609
+ #
1610
+ # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
1611
+ # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
1612
+ # @raise [Google::Apis::AuthorizationError] Authorization is required
1613
+ def delete_notification(customer, notification_id, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block)
1614
+ command = make_simple_command(:delete, 'customer/{customer}/notifications/{notificationId}', options)
1615
+ command.params['customer'] = customer unless customer.nil?
1616
+ command.params['notificationId'] = notification_id unless notification_id.nil?
1617
+ command.query['fields'] = fields unless fields.nil?
1618
+ command.query['quotaUser'] = quota_user unless quota_user.nil?
1619
+ command.query['userIp'] = user_ip unless user_ip.nil?
1620
+ execute_or_queue_command(command, &block)
1621
+ end
1622
+
1623
+ # Retrieves a notification.
1624
+ # @param [String] customer
1625
+ # The unique ID for the customer's Google account. The customerId is also
1626
+ # returned as part of the Users resource.
1627
+ # @param [String] notification_id
1628
+ # The unique ID of the notification.
1629
+ # @param [String] fields
1630
+ # Selector specifying which fields to include in a partial response.
1631
+ # @param [String] quota_user
1632
+ # Available to use for quota purposes for server-side applications. Can be any
1633
+ # arbitrary string assigned to a user, but should not exceed 40 characters.
1634
+ # Overrides userIp if both are provided.
1635
+ # @param [String] user_ip
1636
+ # IP address of the site where the request originates. Use this if you want to
1637
+ # enforce per-user limits.
1638
+ # @param [Google::Apis::RequestOptions] options
1639
+ # Request-specific options
1640
+ #
1641
+ # @yield [result, err] Result & error if block supplied
1642
+ # @yieldparam result [Google::Apis::AdminDirectoryV1::Notification] parsed result object
1643
+ # @yieldparam err [StandardError] error object if request failed
1644
+ #
1645
+ # @return [Google::Apis::AdminDirectoryV1::Notification]
1646
+ #
1647
+ # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
1648
+ # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
1649
+ # @raise [Google::Apis::AuthorizationError] Authorization is required
1650
+ def get_notification(customer, notification_id, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block)
1651
+ command = make_simple_command(:get, 'customer/{customer}/notifications/{notificationId}', options)
1652
+ command.response_representation = Google::Apis::AdminDirectoryV1::Notification::Representation
1653
+ command.response_class = Google::Apis::AdminDirectoryV1::Notification
1654
+ command.params['customer'] = customer unless customer.nil?
1655
+ command.params['notificationId'] = notification_id unless notification_id.nil?
1656
+ command.query['fields'] = fields unless fields.nil?
1657
+ command.query['quotaUser'] = quota_user unless quota_user.nil?
1658
+ command.query['userIp'] = user_ip unless user_ip.nil?
1659
+ execute_or_queue_command(command, &block)
1660
+ end
1661
+
1662
+ # Retrieves a list of notifications.
1663
+ # @param [String] customer
1664
+ # The unique ID for the customer's Google account.
1665
+ # @param [String] language
1666
+ # The ISO 639-1 code of the language notifications are returned in. The default
1667
+ # is English (en).
1668
+ # @param [Fixnum] max_results
1669
+ # Maximum number of notifications to return per page. The default is 100.
1670
+ # @param [String] page_token
1671
+ # The token to specify the page of results to retrieve.
1672
+ # @param [String] fields
1673
+ # Selector specifying which fields to include in a partial response.
1674
+ # @param [String] quota_user
1675
+ # Available to use for quota purposes for server-side applications. Can be any
1676
+ # arbitrary string assigned to a user, but should not exceed 40 characters.
1677
+ # Overrides userIp if both are provided.
1678
+ # @param [String] user_ip
1679
+ # IP address of the site where the request originates. Use this if you want to
1680
+ # enforce per-user limits.
1681
+ # @param [Google::Apis::RequestOptions] options
1682
+ # Request-specific options
1683
+ #
1684
+ # @yield [result, err] Result & error if block supplied
1685
+ # @yieldparam result [Google::Apis::AdminDirectoryV1::Notifications] parsed result object
1686
+ # @yieldparam err [StandardError] error object if request failed
1687
+ #
1688
+ # @return [Google::Apis::AdminDirectoryV1::Notifications]
1689
+ #
1690
+ # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
1691
+ # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
1692
+ # @raise [Google::Apis::AuthorizationError] Authorization is required
1693
+ def list_notifications(customer, language: nil, max_results: nil, page_token: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block)
1694
+ command = make_simple_command(:get, 'customer/{customer}/notifications', options)
1695
+ command.response_representation = Google::Apis::AdminDirectoryV1::Notifications::Representation
1696
+ command.response_class = Google::Apis::AdminDirectoryV1::Notifications
1697
+ command.params['customer'] = customer unless customer.nil?
1698
+ command.query['language'] = language unless language.nil?
1699
+ command.query['maxResults'] = max_results unless max_results.nil?
1700
+ command.query['pageToken'] = page_token unless page_token.nil?
1701
+ command.query['fields'] = fields unless fields.nil?
1702
+ command.query['quotaUser'] = quota_user unless quota_user.nil?
1703
+ command.query['userIp'] = user_ip unless user_ip.nil?
1704
+ execute_or_queue_command(command, &block)
1705
+ end
1706
+
1707
+ # Updates a notification. This method supports patch semantics.
1708
+ # @param [String] customer
1709
+ # The unique ID for the customer's Google account.
1710
+ # @param [String] notification_id
1711
+ # The unique ID of the notification.
1712
+ # @param [Google::Apis::AdminDirectoryV1::Notification] notification_object
1713
+ # @param [String] fields
1714
+ # Selector specifying which fields to include in a partial response.
1715
+ # @param [String] quota_user
1716
+ # Available to use for quota purposes for server-side applications. Can be any
1717
+ # arbitrary string assigned to a user, but should not exceed 40 characters.
1718
+ # Overrides userIp if both are provided.
1719
+ # @param [String] user_ip
1720
+ # IP address of the site where the request originates. Use this if you want to
1721
+ # enforce per-user limits.
1722
+ # @param [Google::Apis::RequestOptions] options
1723
+ # Request-specific options
1724
+ #
1725
+ # @yield [result, err] Result & error if block supplied
1726
+ # @yieldparam result [Google::Apis::AdminDirectoryV1::Notification] parsed result object
1727
+ # @yieldparam err [StandardError] error object if request failed
1728
+ #
1729
+ # @return [Google::Apis::AdminDirectoryV1::Notification]
1730
+ #
1731
+ # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
1732
+ # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
1733
+ # @raise [Google::Apis::AuthorizationError] Authorization is required
1734
+ def patch_notification(customer, notification_id, notification_object = nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block)
1735
+ command = make_simple_command(:patch, 'customer/{customer}/notifications/{notificationId}', options)
1736
+ command.request_representation = Google::Apis::AdminDirectoryV1::Notification::Representation
1737
+ command.request_object = notification_object
1738
+ command.response_representation = Google::Apis::AdminDirectoryV1::Notification::Representation
1739
+ command.response_class = Google::Apis::AdminDirectoryV1::Notification
1740
+ command.params['customer'] = customer unless customer.nil?
1741
+ command.params['notificationId'] = notification_id unless notification_id.nil?
1742
+ command.query['fields'] = fields unless fields.nil?
1743
+ command.query['quotaUser'] = quota_user unless quota_user.nil?
1744
+ command.query['userIp'] = user_ip unless user_ip.nil?
1745
+ execute_or_queue_command(command, &block)
1746
+ end
1747
+
1748
+ # Updates a notification.
1749
+ # @param [String] customer
1750
+ # The unique ID for the customer's Google account.
1751
+ # @param [String] notification_id
1752
+ # The unique ID of the notification.
1753
+ # @param [Google::Apis::AdminDirectoryV1::Notification] notification_object
1754
+ # @param [String] fields
1755
+ # Selector specifying which fields to include in a partial response.
1756
+ # @param [String] quota_user
1757
+ # Available to use for quota purposes for server-side applications. Can be any
1758
+ # arbitrary string assigned to a user, but should not exceed 40 characters.
1759
+ # Overrides userIp if both are provided.
1760
+ # @param [String] user_ip
1761
+ # IP address of the site where the request originates. Use this if you want to
1762
+ # enforce per-user limits.
1763
+ # @param [Google::Apis::RequestOptions] options
1764
+ # Request-specific options
1765
+ #
1766
+ # @yield [result, err] Result & error if block supplied
1767
+ # @yieldparam result [Google::Apis::AdminDirectoryV1::Notification] parsed result object
1768
+ # @yieldparam err [StandardError] error object if request failed
1769
+ #
1770
+ # @return [Google::Apis::AdminDirectoryV1::Notification]
1771
+ #
1772
+ # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
1773
+ # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
1774
+ # @raise [Google::Apis::AuthorizationError] Authorization is required
1775
+ def update_notification(customer, notification_id, notification_object = nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block)
1776
+ command = make_simple_command(:put, 'customer/{customer}/notifications/{notificationId}', options)
1777
+ command.request_representation = Google::Apis::AdminDirectoryV1::Notification::Representation
1778
+ command.request_object = notification_object
1779
+ command.response_representation = Google::Apis::AdminDirectoryV1::Notification::Representation
1780
+ command.response_class = Google::Apis::AdminDirectoryV1::Notification
1781
+ command.params['customer'] = customer unless customer.nil?
1782
+ command.params['notificationId'] = notification_id unless notification_id.nil?
1783
+ command.query['fields'] = fields unless fields.nil?
1784
+ command.query['quotaUser'] = quota_user unless quota_user.nil?
1785
+ command.query['userIp'] = user_ip unless user_ip.nil?
1786
+ execute_or_queue_command(command, &block)
1787
+ end
1788
+
1789
+ # Remove Organization Unit
1790
+ # @param [String] customer_id
1791
+ # Immutable id of the Google Apps account
1792
+ # @param [Array<String>, String] org_unit_path
1793
+ # Full path of the organization unit or its Id
1794
+ # @param [String] fields
1795
+ # Selector specifying which fields to include in a partial response.
1796
+ # @param [String] quota_user
1797
+ # Available to use for quota purposes for server-side applications. Can be any
1798
+ # arbitrary string assigned to a user, but should not exceed 40 characters.
1799
+ # Overrides userIp if both are provided.
1800
+ # @param [String] user_ip
1801
+ # IP address of the site where the request originates. Use this if you want to
1802
+ # enforce per-user limits.
1803
+ # @param [Google::Apis::RequestOptions] options
1804
+ # Request-specific options
1805
+ #
1806
+ # @yield [result, err] Result & error if block supplied
1807
+ # @yieldparam result [NilClass] No result returned for this method
1808
+ # @yieldparam err [StandardError] error object if request failed
1809
+ #
1810
+ # @return [void]
1811
+ #
1812
+ # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
1813
+ # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
1814
+ # @raise [Google::Apis::AuthorizationError] Authorization is required
1815
+ def delete_org_unit(customer_id, org_unit_path, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block)
1816
+ command = make_simple_command(:delete, 'customer/{customerId}/orgunits{/orgUnitPath*}', options)
1817
+ command.params['customerId'] = customer_id unless customer_id.nil?
1818
+ command.params['orgUnitPath'] = org_unit_path unless org_unit_path.nil?
1819
+ command.query['fields'] = fields unless fields.nil?
1820
+ command.query['quotaUser'] = quota_user unless quota_user.nil?
1821
+ command.query['userIp'] = user_ip unless user_ip.nil?
1822
+ execute_or_queue_command(command, &block)
1823
+ end
1824
+
1825
+ # Retrieve Organization Unit
1826
+ # @param [String] customer_id
1827
+ # Immutable id of the Google Apps account
1828
+ # @param [Array<String>, String] org_unit_path
1829
+ # Full path of the organization unit or its Id
1830
+ # @param [String] fields
1831
+ # Selector specifying which fields to include in a partial response.
1832
+ # @param [String] quota_user
1833
+ # Available to use for quota purposes for server-side applications. Can be any
1834
+ # arbitrary string assigned to a user, but should not exceed 40 characters.
1835
+ # Overrides userIp if both are provided.
1836
+ # @param [String] user_ip
1837
+ # IP address of the site where the request originates. Use this if you want to
1838
+ # enforce per-user limits.
1839
+ # @param [Google::Apis::RequestOptions] options
1840
+ # Request-specific options
1841
+ #
1842
+ # @yield [result, err] Result & error if block supplied
1843
+ # @yieldparam result [Google::Apis::AdminDirectoryV1::OrgUnit] parsed result object
1844
+ # @yieldparam err [StandardError] error object if request failed
1845
+ #
1846
+ # @return [Google::Apis::AdminDirectoryV1::OrgUnit]
1847
+ #
1848
+ # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
1849
+ # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
1850
+ # @raise [Google::Apis::AuthorizationError] Authorization is required
1851
+ def get_org_unit(customer_id, org_unit_path, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block)
1852
+ command = make_simple_command(:get, 'customer/{customerId}/orgunits{/orgUnitPath*}', options)
1853
+ command.response_representation = Google::Apis::AdminDirectoryV1::OrgUnit::Representation
1854
+ command.response_class = Google::Apis::AdminDirectoryV1::OrgUnit
1855
+ command.params['customerId'] = customer_id unless customer_id.nil?
1856
+ command.params['orgUnitPath'] = org_unit_path unless org_unit_path.nil?
1857
+ command.query['fields'] = fields unless fields.nil?
1858
+ command.query['quotaUser'] = quota_user unless quota_user.nil?
1859
+ command.query['userIp'] = user_ip unless user_ip.nil?
1860
+ execute_or_queue_command(command, &block)
1861
+ end
1862
+
1863
+ # Add Organization Unit
1864
+ # @param [String] customer_id
1865
+ # Immutable id of the Google Apps account
1866
+ # @param [Google::Apis::AdminDirectoryV1::OrgUnit] org_unit_object
1867
+ # @param [String] fields
1868
+ # Selector specifying which fields to include in a partial response.
1869
+ # @param [String] quota_user
1870
+ # Available to use for quota purposes for server-side applications. Can be any
1871
+ # arbitrary string assigned to a user, but should not exceed 40 characters.
1872
+ # Overrides userIp if both are provided.
1873
+ # @param [String] user_ip
1874
+ # IP address of the site where the request originates. Use this if you want to
1875
+ # enforce per-user limits.
1876
+ # @param [Google::Apis::RequestOptions] options
1877
+ # Request-specific options
1878
+ #
1879
+ # @yield [result, err] Result & error if block supplied
1880
+ # @yieldparam result [Google::Apis::AdminDirectoryV1::OrgUnit] parsed result object
1881
+ # @yieldparam err [StandardError] error object if request failed
1882
+ #
1883
+ # @return [Google::Apis::AdminDirectoryV1::OrgUnit]
1884
+ #
1885
+ # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
1886
+ # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
1887
+ # @raise [Google::Apis::AuthorizationError] Authorization is required
1888
+ def insert_org_unit(customer_id, org_unit_object = nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block)
1889
+ command = make_simple_command(:post, 'customer/{customerId}/orgunits', options)
1890
+ command.request_representation = Google::Apis::AdminDirectoryV1::OrgUnit::Representation
1891
+ command.request_object = org_unit_object
1892
+ command.response_representation = Google::Apis::AdminDirectoryV1::OrgUnit::Representation
1893
+ command.response_class = Google::Apis::AdminDirectoryV1::OrgUnit
1894
+ command.params['customerId'] = customer_id unless customer_id.nil?
1895
+ command.query['fields'] = fields unless fields.nil?
1896
+ command.query['quotaUser'] = quota_user unless quota_user.nil?
1897
+ command.query['userIp'] = user_ip unless user_ip.nil?
1898
+ execute_or_queue_command(command, &block)
1899
+ end
1900
+
1901
+ # Retrieve all Organization Units
1902
+ # @param [String] customer_id
1903
+ # Immutable id of the Google Apps account
1904
+ # @param [String] org_unit_path
1905
+ # the URL-encoded organization unit's path or its Id
1906
+ # @param [String] type
1907
+ # Whether to return all sub-organizations or just immediate children
1908
+ # @param [String] fields
1909
+ # Selector specifying which fields to include in a partial response.
1910
+ # @param [String] quota_user
1911
+ # Available to use for quota purposes for server-side applications. Can be any
1912
+ # arbitrary string assigned to a user, but should not exceed 40 characters.
1913
+ # Overrides userIp if both are provided.
1914
+ # @param [String] user_ip
1915
+ # IP address of the site where the request originates. Use this if you want to
1916
+ # enforce per-user limits.
1917
+ # @param [Google::Apis::RequestOptions] options
1918
+ # Request-specific options
1919
+ #
1920
+ # @yield [result, err] Result & error if block supplied
1921
+ # @yieldparam result [Google::Apis::AdminDirectoryV1::OrgUnits] parsed result object
1922
+ # @yieldparam err [StandardError] error object if request failed
1923
+ #
1924
+ # @return [Google::Apis::AdminDirectoryV1::OrgUnits]
1925
+ #
1926
+ # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
1927
+ # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
1928
+ # @raise [Google::Apis::AuthorizationError] Authorization is required
1929
+ def list_org_units(customer_id, org_unit_path: nil, type: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block)
1930
+ command = make_simple_command(:get, 'customer/{customerId}/orgunits', options)
1931
+ command.response_representation = Google::Apis::AdminDirectoryV1::OrgUnits::Representation
1932
+ command.response_class = Google::Apis::AdminDirectoryV1::OrgUnits
1933
+ command.params['customerId'] = customer_id unless customer_id.nil?
1934
+ command.query['orgUnitPath'] = org_unit_path unless org_unit_path.nil?
1935
+ command.query['type'] = type unless type.nil?
1936
+ command.query['fields'] = fields unless fields.nil?
1937
+ command.query['quotaUser'] = quota_user unless quota_user.nil?
1938
+ command.query['userIp'] = user_ip unless user_ip.nil?
1939
+ execute_or_queue_command(command, &block)
1940
+ end
1941
+
1942
+ # Update Organization Unit. This method supports patch semantics.
1943
+ # @param [String] customer_id
1944
+ # Immutable id of the Google Apps account
1945
+ # @param [Array<String>, String] org_unit_path
1946
+ # Full path of the organization unit or its Id
1947
+ # @param [Google::Apis::AdminDirectoryV1::OrgUnit] org_unit_object
1948
+ # @param [String] fields
1949
+ # Selector specifying which fields to include in a partial response.
1950
+ # @param [String] quota_user
1951
+ # Available to use for quota purposes for server-side applications. Can be any
1952
+ # arbitrary string assigned to a user, but should not exceed 40 characters.
1953
+ # Overrides userIp if both are provided.
1954
+ # @param [String] user_ip
1955
+ # IP address of the site where the request originates. Use this if you want to
1956
+ # enforce per-user limits.
1957
+ # @param [Google::Apis::RequestOptions] options
1958
+ # Request-specific options
1959
+ #
1960
+ # @yield [result, err] Result & error if block supplied
1961
+ # @yieldparam result [Google::Apis::AdminDirectoryV1::OrgUnit] parsed result object
1962
+ # @yieldparam err [StandardError] error object if request failed
1963
+ #
1964
+ # @return [Google::Apis::AdminDirectoryV1::OrgUnit]
1965
+ #
1966
+ # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
1967
+ # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
1968
+ # @raise [Google::Apis::AuthorizationError] Authorization is required
1969
+ def patch_org_unit(customer_id, org_unit_path, org_unit_object = nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block)
1970
+ command = make_simple_command(:patch, 'customer/{customerId}/orgunits{/orgUnitPath*}', options)
1971
+ command.request_representation = Google::Apis::AdminDirectoryV1::OrgUnit::Representation
1972
+ command.request_object = org_unit_object
1973
+ command.response_representation = Google::Apis::AdminDirectoryV1::OrgUnit::Representation
1974
+ command.response_class = Google::Apis::AdminDirectoryV1::OrgUnit
1975
+ command.params['customerId'] = customer_id unless customer_id.nil?
1976
+ command.params['orgUnitPath'] = org_unit_path unless org_unit_path.nil?
1977
+ command.query['fields'] = fields unless fields.nil?
1978
+ command.query['quotaUser'] = quota_user unless quota_user.nil?
1979
+ command.query['userIp'] = user_ip unless user_ip.nil?
1980
+ execute_or_queue_command(command, &block)
1981
+ end
1982
+
1983
+ # Update Organization Unit
1984
+ # @param [String] customer_id
1985
+ # Immutable id of the Google Apps account
1986
+ # @param [Array<String>, String] org_unit_path
1987
+ # Full path of the organization unit or its Id
1988
+ # @param [Google::Apis::AdminDirectoryV1::OrgUnit] org_unit_object
1989
+ # @param [String] fields
1990
+ # Selector specifying which fields to include in a partial response.
1991
+ # @param [String] quota_user
1992
+ # Available to use for quota purposes for server-side applications. Can be any
1993
+ # arbitrary string assigned to a user, but should not exceed 40 characters.
1994
+ # Overrides userIp if both are provided.
1995
+ # @param [String] user_ip
1996
+ # IP address of the site where the request originates. Use this if you want to
1997
+ # enforce per-user limits.
1998
+ # @param [Google::Apis::RequestOptions] options
1999
+ # Request-specific options
2000
+ #
2001
+ # @yield [result, err] Result & error if block supplied
2002
+ # @yieldparam result [Google::Apis::AdminDirectoryV1::OrgUnit] parsed result object
2003
+ # @yieldparam err [StandardError] error object if request failed
2004
+ #
2005
+ # @return [Google::Apis::AdminDirectoryV1::OrgUnit]
2006
+ #
2007
+ # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
2008
+ # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
2009
+ # @raise [Google::Apis::AuthorizationError] Authorization is required
2010
+ def update_org_unit(customer_id, org_unit_path, org_unit_object = nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block)
2011
+ command = make_simple_command(:put, 'customer/{customerId}/orgunits{/orgUnitPath*}', options)
2012
+ command.request_representation = Google::Apis::AdminDirectoryV1::OrgUnit::Representation
2013
+ command.request_object = org_unit_object
2014
+ command.response_representation = Google::Apis::AdminDirectoryV1::OrgUnit::Representation
2015
+ command.response_class = Google::Apis::AdminDirectoryV1::OrgUnit
2016
+ command.params['customerId'] = customer_id unless customer_id.nil?
2017
+ command.params['orgUnitPath'] = org_unit_path unless org_unit_path.nil?
2018
+ command.query['fields'] = fields unless fields.nil?
2019
+ command.query['quotaUser'] = quota_user unless quota_user.nil?
2020
+ command.query['userIp'] = user_ip unless user_ip.nil?
2021
+ execute_or_queue_command(command, &block)
2022
+ end
2023
+
2024
+ # Retrieves a paginated list of all privileges for a customer.
2025
+ # @param [String] customer
2026
+ # Immutable ID of the Google Apps account.
2027
+ # @param [String] fields
2028
+ # Selector specifying which fields to include in a partial response.
2029
+ # @param [String] quota_user
2030
+ # Available to use for quota purposes for server-side applications. Can be any
2031
+ # arbitrary string assigned to a user, but should not exceed 40 characters.
2032
+ # Overrides userIp if both are provided.
2033
+ # @param [String] user_ip
2034
+ # IP address of the site where the request originates. Use this if you want to
2035
+ # enforce per-user limits.
2036
+ # @param [Google::Apis::RequestOptions] options
2037
+ # Request-specific options
2038
+ #
2039
+ # @yield [result, err] Result & error if block supplied
2040
+ # @yieldparam result [Google::Apis::AdminDirectoryV1::Privileges] parsed result object
2041
+ # @yieldparam err [StandardError] error object if request failed
2042
+ #
2043
+ # @return [Google::Apis::AdminDirectoryV1::Privileges]
2044
+ #
2045
+ # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
2046
+ # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
2047
+ # @raise [Google::Apis::AuthorizationError] Authorization is required
2048
+ def list_privileges(customer, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block)
2049
+ command = make_simple_command(:get, 'customer/{customer}/roles/ALL/privileges', options)
2050
+ command.response_representation = Google::Apis::AdminDirectoryV1::Privileges::Representation
2051
+ command.response_class = Google::Apis::AdminDirectoryV1::Privileges
2052
+ command.params['customer'] = customer unless customer.nil?
2053
+ command.query['fields'] = fields unless fields.nil?
2054
+ command.query['quotaUser'] = quota_user unless quota_user.nil?
2055
+ command.query['userIp'] = user_ip unless user_ip.nil?
2056
+ execute_or_queue_command(command, &block)
2057
+ end
2058
+
2059
+ # Deletes a calendar resource.
2060
+ # @param [String] customer
2061
+ # The unique ID for the customer's Google account. As an account administrator,
2062
+ # you can also use the my_customer alias to represent your account's customer ID.
2063
+ # @param [String] calendar_resource_id
2064
+ # The unique ID of the calendar resource to delete.
2065
+ # @param [String] fields
2066
+ # Selector specifying which fields to include in a partial response.
2067
+ # @param [String] quota_user
2068
+ # Available to use for quota purposes for server-side applications. Can be any
2069
+ # arbitrary string assigned to a user, but should not exceed 40 characters.
2070
+ # Overrides userIp if both are provided.
2071
+ # @param [String] user_ip
2072
+ # IP address of the site where the request originates. Use this if you want to
2073
+ # enforce per-user limits.
2074
+ # @param [Google::Apis::RequestOptions] options
2075
+ # Request-specific options
2076
+ #
2077
+ # @yield [result, err] Result & error if block supplied
2078
+ # @yieldparam result [NilClass] No result returned for this method
2079
+ # @yieldparam err [StandardError] error object if request failed
2080
+ #
2081
+ # @return [void]
2082
+ #
2083
+ # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
2084
+ # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
2085
+ # @raise [Google::Apis::AuthorizationError] Authorization is required
2086
+ def delete_calendar_resource(customer, calendar_resource_id, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block)
2087
+ command = make_simple_command(:delete, 'customer/{customer}/resources/calendars/{calendarResourceId}', options)
2088
+ command.params['customer'] = customer unless customer.nil?
2089
+ command.params['calendarResourceId'] = calendar_resource_id unless calendar_resource_id.nil?
2090
+ command.query['fields'] = fields unless fields.nil?
2091
+ command.query['quotaUser'] = quota_user unless quota_user.nil?
2092
+ command.query['userIp'] = user_ip unless user_ip.nil?
2093
+ execute_or_queue_command(command, &block)
2094
+ end
2095
+
2096
+ # Retrieves a calendar resource.
2097
+ # @param [String] customer
2098
+ # The unique ID for the customer's Google account. As an account administrator,
2099
+ # you can also use the my_customer alias to represent your account's customer ID.
2100
+ # @param [String] calendar_resource_id
2101
+ # The unique ID of the calendar resource to retrieve.
2102
+ # @param [String] fields
2103
+ # Selector specifying which fields to include in a partial response.
2104
+ # @param [String] quota_user
2105
+ # Available to use for quota purposes for server-side applications. Can be any
2106
+ # arbitrary string assigned to a user, but should not exceed 40 characters.
2107
+ # Overrides userIp if both are provided.
2108
+ # @param [String] user_ip
2109
+ # IP address of the site where the request originates. Use this if you want to
2110
+ # enforce per-user limits.
2111
+ # @param [Google::Apis::RequestOptions] options
2112
+ # Request-specific options
2113
+ #
2114
+ # @yield [result, err] Result & error if block supplied
2115
+ # @yieldparam result [Google::Apis::AdminDirectoryV1::CalendarResource] parsed result object
2116
+ # @yieldparam err [StandardError] error object if request failed
2117
+ #
2118
+ # @return [Google::Apis::AdminDirectoryV1::CalendarResource]
2119
+ #
2120
+ # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
2121
+ # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
2122
+ # @raise [Google::Apis::AuthorizationError] Authorization is required
2123
+ def get_calendar_resource(customer, calendar_resource_id, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block)
2124
+ command = make_simple_command(:get, 'customer/{customer}/resources/calendars/{calendarResourceId}', options)
2125
+ command.response_representation = Google::Apis::AdminDirectoryV1::CalendarResource::Representation
2126
+ command.response_class = Google::Apis::AdminDirectoryV1::CalendarResource
2127
+ command.params['customer'] = customer unless customer.nil?
2128
+ command.params['calendarResourceId'] = calendar_resource_id unless calendar_resource_id.nil?
2129
+ command.query['fields'] = fields unless fields.nil?
2130
+ command.query['quotaUser'] = quota_user unless quota_user.nil?
2131
+ command.query['userIp'] = user_ip unless user_ip.nil?
2132
+ execute_or_queue_command(command, &block)
2133
+ end
2134
+
2135
+ # Inserts a calendar resource.
2136
+ # @param [String] customer
2137
+ # The unique ID for the customer's Google account. As an account administrator,
2138
+ # you can also use the my_customer alias to represent your account's customer ID.
2139
+ # @param [Google::Apis::AdminDirectoryV1::CalendarResource] calendar_resource_object
2140
+ # @param [String] fields
2141
+ # Selector specifying which fields to include in a partial response.
2142
+ # @param [String] quota_user
2143
+ # Available to use for quota purposes for server-side applications. Can be any
2144
+ # arbitrary string assigned to a user, but should not exceed 40 characters.
2145
+ # Overrides userIp if both are provided.
2146
+ # @param [String] user_ip
2147
+ # IP address of the site where the request originates. Use this if you want to
2148
+ # enforce per-user limits.
2149
+ # @param [Google::Apis::RequestOptions] options
2150
+ # Request-specific options
2151
+ #
2152
+ # @yield [result, err] Result & error if block supplied
2153
+ # @yieldparam result [Google::Apis::AdminDirectoryV1::CalendarResource] parsed result object
2154
+ # @yieldparam err [StandardError] error object if request failed
2155
+ #
2156
+ # @return [Google::Apis::AdminDirectoryV1::CalendarResource]
2157
+ #
2158
+ # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
2159
+ # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
2160
+ # @raise [Google::Apis::AuthorizationError] Authorization is required
2161
+ def calendar_resource(customer, calendar_resource_object = nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block)
2162
+ command = make_simple_command(:post, 'customer/{customer}/resources/calendars', options)
2163
+ command.request_representation = Google::Apis::AdminDirectoryV1::CalendarResource::Representation
2164
+ command.request_object = calendar_resource_object
2165
+ command.response_representation = Google::Apis::AdminDirectoryV1::CalendarResource::Representation
2166
+ command.response_class = Google::Apis::AdminDirectoryV1::CalendarResource
2167
+ command.params['customer'] = customer unless customer.nil?
2168
+ command.query['fields'] = fields unless fields.nil?
2169
+ command.query['quotaUser'] = quota_user unless quota_user.nil?
2170
+ command.query['userIp'] = user_ip unless user_ip.nil?
2171
+ execute_or_queue_command(command, &block)
2172
+ end
2173
+
2174
+ # Retrieves a list of calendar resources for an account.
2175
+ # @param [String] customer
2176
+ # The unique ID for the customer's Google account. As an account administrator,
2177
+ # you can also use the my_customer alias to represent your account's customer ID.
2178
+ # @param [Fixnum] max_results
2179
+ # Maximum number of results to return.
2180
+ # @param [String] page_token
2181
+ # Token to specify the next page in the list.
2182
+ # @param [String] fields
2183
+ # Selector specifying which fields to include in a partial response.
2184
+ # @param [String] quota_user
2185
+ # Available to use for quota purposes for server-side applications. Can be any
2186
+ # arbitrary string assigned to a user, but should not exceed 40 characters.
2187
+ # Overrides userIp if both are provided.
2188
+ # @param [String] user_ip
2189
+ # IP address of the site where the request originates. Use this if you want to
2190
+ # enforce per-user limits.
2191
+ # @param [Google::Apis::RequestOptions] options
2192
+ # Request-specific options
2193
+ #
2194
+ # @yield [result, err] Result & error if block supplied
2195
+ # @yieldparam result [Google::Apis::AdminDirectoryV1::CalendarResources] parsed result object
2196
+ # @yieldparam err [StandardError] error object if request failed
2197
+ #
2198
+ # @return [Google::Apis::AdminDirectoryV1::CalendarResources]
2199
+ #
2200
+ # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
2201
+ # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
2202
+ # @raise [Google::Apis::AuthorizationError] Authorization is required
2203
+ def list_calendar_resources(customer, max_results: nil, page_token: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block)
2204
+ command = make_simple_command(:get, 'customer/{customer}/resources/calendars', options)
2205
+ command.response_representation = Google::Apis::AdminDirectoryV1::CalendarResources::Representation
2206
+ command.response_class = Google::Apis::AdminDirectoryV1::CalendarResources
2207
+ command.params['customer'] = customer unless customer.nil?
2208
+ command.query['maxResults'] = max_results unless max_results.nil?
2209
+ command.query['pageToken'] = page_token unless page_token.nil?
2210
+ command.query['fields'] = fields unless fields.nil?
2211
+ command.query['quotaUser'] = quota_user unless quota_user.nil?
2212
+ command.query['userIp'] = user_ip unless user_ip.nil?
2213
+ execute_or_queue_command(command, &block)
2214
+ end
2215
+
2216
+ # Updates a calendar resource. This method supports patch semantics.
2217
+ # @param [String] customer
2218
+ # The unique ID for the customer's Google account. As an account administrator,
2219
+ # you can also use the my_customer alias to represent your account's customer ID.
2220
+ # @param [String] calendar_resource_id
2221
+ # The unique ID of the calendar resource to update.
2222
+ # @param [Google::Apis::AdminDirectoryV1::CalendarResource] calendar_resource_object
2223
+ # @param [String] fields
2224
+ # Selector specifying which fields to include in a partial response.
2225
+ # @param [String] quota_user
2226
+ # Available to use for quota purposes for server-side applications. Can be any
2227
+ # arbitrary string assigned to a user, but should not exceed 40 characters.
2228
+ # Overrides userIp if both are provided.
2229
+ # @param [String] user_ip
2230
+ # IP address of the site where the request originates. Use this if you want to
2231
+ # enforce per-user limits.
2232
+ # @param [Google::Apis::RequestOptions] options
2233
+ # Request-specific options
2234
+ #
2235
+ # @yield [result, err] Result & error if block supplied
2236
+ # @yieldparam result [Google::Apis::AdminDirectoryV1::CalendarResource] parsed result object
2237
+ # @yieldparam err [StandardError] error object if request failed
2238
+ #
2239
+ # @return [Google::Apis::AdminDirectoryV1::CalendarResource]
2240
+ #
2241
+ # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
2242
+ # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
2243
+ # @raise [Google::Apis::AuthorizationError] Authorization is required
2244
+ def patch_calendar_resource(customer, calendar_resource_id, calendar_resource_object = nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block)
2245
+ command = make_simple_command(:patch, 'customer/{customer}/resources/calendars/{calendarResourceId}', options)
2246
+ command.request_representation = Google::Apis::AdminDirectoryV1::CalendarResource::Representation
2247
+ command.request_object = calendar_resource_object
2248
+ command.response_representation = Google::Apis::AdminDirectoryV1::CalendarResource::Representation
2249
+ command.response_class = Google::Apis::AdminDirectoryV1::CalendarResource
2250
+ command.params['customer'] = customer unless customer.nil?
2251
+ command.params['calendarResourceId'] = calendar_resource_id unless calendar_resource_id.nil?
2252
+ command.query['fields'] = fields unless fields.nil?
2253
+ command.query['quotaUser'] = quota_user unless quota_user.nil?
2254
+ command.query['userIp'] = user_ip unless user_ip.nil?
2255
+ execute_or_queue_command(command, &block)
2256
+ end
2257
+
2258
+ # Updates a calendar resource.
2259
+ # @param [String] customer
2260
+ # The unique ID for the customer's Google account. As an account administrator,
2261
+ # you can also use the my_customer alias to represent your account's customer ID.
2262
+ # @param [String] calendar_resource_id
2263
+ # The unique ID of the calendar resource to update.
2264
+ # @param [Google::Apis::AdminDirectoryV1::CalendarResource] calendar_resource_object
2265
+ # @param [String] fields
2266
+ # Selector specifying which fields to include in a partial response.
2267
+ # @param [String] quota_user
2268
+ # Available to use for quota purposes for server-side applications. Can be any
2269
+ # arbitrary string assigned to a user, but should not exceed 40 characters.
2270
+ # Overrides userIp if both are provided.
2271
+ # @param [String] user_ip
2272
+ # IP address of the site where the request originates. Use this if you want to
2273
+ # enforce per-user limits.
2274
+ # @param [Google::Apis::RequestOptions] options
2275
+ # Request-specific options
2276
+ #
2277
+ # @yield [result, err] Result & error if block supplied
2278
+ # @yieldparam result [Google::Apis::AdminDirectoryV1::CalendarResource] parsed result object
2279
+ # @yieldparam err [StandardError] error object if request failed
2280
+ #
2281
+ # @return [Google::Apis::AdminDirectoryV1::CalendarResource]
2282
+ #
2283
+ # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
2284
+ # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
2285
+ # @raise [Google::Apis::AuthorizationError] Authorization is required
2286
+ def update_calendar_resource(customer, calendar_resource_id, calendar_resource_object = nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block)
2287
+ command = make_simple_command(:put, 'customer/{customer}/resources/calendars/{calendarResourceId}', options)
2288
+ command.request_representation = Google::Apis::AdminDirectoryV1::CalendarResource::Representation
2289
+ command.request_object = calendar_resource_object
2290
+ command.response_representation = Google::Apis::AdminDirectoryV1::CalendarResource::Representation
2291
+ command.response_class = Google::Apis::AdminDirectoryV1::CalendarResource
2292
+ command.params['customer'] = customer unless customer.nil?
2293
+ command.params['calendarResourceId'] = calendar_resource_id unless calendar_resource_id.nil?
2294
+ command.query['fields'] = fields unless fields.nil?
2295
+ command.query['quotaUser'] = quota_user unless quota_user.nil?
2296
+ command.query['userIp'] = user_ip unless user_ip.nil?
2297
+ execute_or_queue_command(command, &block)
2298
+ end
2299
+
2300
+ # Deletes a role assignment.
2301
+ # @param [String] customer
2302
+ # Immutable ID of the Google Apps account.
2303
+ # @param [String] role_assignment_id
2304
+ # Immutable ID of the role assignment.
2305
+ # @param [String] fields
2306
+ # Selector specifying which fields to include in a partial response.
2307
+ # @param [String] quota_user
2308
+ # Available to use for quota purposes for server-side applications. Can be any
2309
+ # arbitrary string assigned to a user, but should not exceed 40 characters.
2310
+ # Overrides userIp if both are provided.
2311
+ # @param [String] user_ip
2312
+ # IP address of the site where the request originates. Use this if you want to
2313
+ # enforce per-user limits.
2314
+ # @param [Google::Apis::RequestOptions] options
2315
+ # Request-specific options
2316
+ #
2317
+ # @yield [result, err] Result & error if block supplied
2318
+ # @yieldparam result [NilClass] No result returned for this method
2319
+ # @yieldparam err [StandardError] error object if request failed
2320
+ #
2321
+ # @return [void]
2322
+ #
2323
+ # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
2324
+ # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
2325
+ # @raise [Google::Apis::AuthorizationError] Authorization is required
2326
+ def delete_role_assignment(customer, role_assignment_id, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block)
2327
+ command = make_simple_command(:delete, 'customer/{customer}/roleassignments/{roleAssignmentId}', options)
2328
+ command.params['customer'] = customer unless customer.nil?
2329
+ command.params['roleAssignmentId'] = role_assignment_id unless role_assignment_id.nil?
2330
+ command.query['fields'] = fields unless fields.nil?
2331
+ command.query['quotaUser'] = quota_user unless quota_user.nil?
2332
+ command.query['userIp'] = user_ip unless user_ip.nil?
2333
+ execute_or_queue_command(command, &block)
2334
+ end
2335
+
2336
+ # Retrieve a role assignment.
2337
+ # @param [String] customer
2338
+ # Immutable ID of the Google Apps account.
2339
+ # @param [String] role_assignment_id
2340
+ # Immutable ID of the role assignment.
2341
+ # @param [String] fields
2342
+ # Selector specifying which fields to include in a partial response.
2343
+ # @param [String] quota_user
2344
+ # Available to use for quota purposes for server-side applications. Can be any
2345
+ # arbitrary string assigned to a user, but should not exceed 40 characters.
2346
+ # Overrides userIp if both are provided.
2347
+ # @param [String] user_ip
2348
+ # IP address of the site where the request originates. Use this if you want to
2349
+ # enforce per-user limits.
2350
+ # @param [Google::Apis::RequestOptions] options
2351
+ # Request-specific options
2352
+ #
2353
+ # @yield [result, err] Result & error if block supplied
2354
+ # @yieldparam result [Google::Apis::AdminDirectoryV1::RoleAssignment] parsed result object
2355
+ # @yieldparam err [StandardError] error object if request failed
2356
+ #
2357
+ # @return [Google::Apis::AdminDirectoryV1::RoleAssignment]
2358
+ #
2359
+ # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
2360
+ # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
2361
+ # @raise [Google::Apis::AuthorizationError] Authorization is required
2362
+ def get_role_assignment(customer, role_assignment_id, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block)
2363
+ command = make_simple_command(:get, 'customer/{customer}/roleassignments/{roleAssignmentId}', options)
2364
+ command.response_representation = Google::Apis::AdminDirectoryV1::RoleAssignment::Representation
2365
+ command.response_class = Google::Apis::AdminDirectoryV1::RoleAssignment
2366
+ command.params['customer'] = customer unless customer.nil?
2367
+ command.params['roleAssignmentId'] = role_assignment_id unless role_assignment_id.nil?
2368
+ command.query['fields'] = fields unless fields.nil?
2369
+ command.query['quotaUser'] = quota_user unless quota_user.nil?
2370
+ command.query['userIp'] = user_ip unless user_ip.nil?
2371
+ execute_or_queue_command(command, &block)
2372
+ end
2373
+
2374
+ # Creates a role assignment.
2375
+ # @param [String] customer
2376
+ # Immutable ID of the Google Apps account.
2377
+ # @param [Google::Apis::AdminDirectoryV1::RoleAssignment] role_assignment_object
2378
+ # @param [String] fields
2379
+ # Selector specifying which fields to include in a partial response.
2380
+ # @param [String] quota_user
2381
+ # Available to use for quota purposes for server-side applications. Can be any
2382
+ # arbitrary string assigned to a user, but should not exceed 40 characters.
2383
+ # Overrides userIp if both are provided.
2384
+ # @param [String] user_ip
2385
+ # IP address of the site where the request originates. Use this if you want to
2386
+ # enforce per-user limits.
2387
+ # @param [Google::Apis::RequestOptions] options
2388
+ # Request-specific options
2389
+ #
2390
+ # @yield [result, err] Result & error if block supplied
2391
+ # @yieldparam result [Google::Apis::AdminDirectoryV1::RoleAssignment] parsed result object
2392
+ # @yieldparam err [StandardError] error object if request failed
2393
+ #
2394
+ # @return [Google::Apis::AdminDirectoryV1::RoleAssignment]
2395
+ #
2396
+ # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
2397
+ # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
2398
+ # @raise [Google::Apis::AuthorizationError] Authorization is required
2399
+ def insert_role_assignment(customer, role_assignment_object = nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block)
2400
+ command = make_simple_command(:post, 'customer/{customer}/roleassignments', options)
2401
+ command.request_representation = Google::Apis::AdminDirectoryV1::RoleAssignment::Representation
2402
+ command.request_object = role_assignment_object
2403
+ command.response_representation = Google::Apis::AdminDirectoryV1::RoleAssignment::Representation
2404
+ command.response_class = Google::Apis::AdminDirectoryV1::RoleAssignment
2405
+ command.params['customer'] = customer unless customer.nil?
2406
+ command.query['fields'] = fields unless fields.nil?
2407
+ command.query['quotaUser'] = quota_user unless quota_user.nil?
2408
+ command.query['userIp'] = user_ip unless user_ip.nil?
2409
+ execute_or_queue_command(command, &block)
2410
+ end
2411
+
2412
+ # Retrieves a paginated list of all roleAssignments.
2413
+ # @param [String] customer
2414
+ # Immutable ID of the Google Apps account.
2415
+ # @param [Fixnum] max_results
2416
+ # Maximum number of results to return.
2417
+ # @param [String] page_token
2418
+ # Token to specify the next page in the list.
2419
+ # @param [String] role_id
2420
+ # Immutable ID of a role. If included in the request, returns only role
2421
+ # assignments containing this role ID.
2422
+ # @param [String] user_key
2423
+ # The user's primary email address, alias email address, or unique user ID. If
2424
+ # included in the request, returns role assignments only for this user.
2425
+ # @param [String] fields
2426
+ # Selector specifying which fields to include in a partial response.
2427
+ # @param [String] quota_user
2428
+ # Available to use for quota purposes for server-side applications. Can be any
2429
+ # arbitrary string assigned to a user, but should not exceed 40 characters.
2430
+ # Overrides userIp if both are provided.
2431
+ # @param [String] user_ip
2432
+ # IP address of the site where the request originates. Use this if you want to
2433
+ # enforce per-user limits.
2434
+ # @param [Google::Apis::RequestOptions] options
2435
+ # Request-specific options
2436
+ #
2437
+ # @yield [result, err] Result & error if block supplied
2438
+ # @yieldparam result [Google::Apis::AdminDirectoryV1::RoleAssignments] parsed result object
2439
+ # @yieldparam err [StandardError] error object if request failed
2440
+ #
2441
+ # @return [Google::Apis::AdminDirectoryV1::RoleAssignments]
2442
+ #
2443
+ # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
2444
+ # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
2445
+ # @raise [Google::Apis::AuthorizationError] Authorization is required
2446
+ def list_role_assignments(customer, max_results: nil, page_token: nil, role_id: nil, user_key: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block)
2447
+ command = make_simple_command(:get, 'customer/{customer}/roleassignments', options)
2448
+ command.response_representation = Google::Apis::AdminDirectoryV1::RoleAssignments::Representation
2449
+ command.response_class = Google::Apis::AdminDirectoryV1::RoleAssignments
2450
+ command.params['customer'] = customer unless customer.nil?
2451
+ command.query['maxResults'] = max_results unless max_results.nil?
2452
+ command.query['pageToken'] = page_token unless page_token.nil?
2453
+ command.query['roleId'] = role_id unless role_id.nil?
2454
+ command.query['userKey'] = user_key unless user_key.nil?
2455
+ command.query['fields'] = fields unless fields.nil?
2456
+ command.query['quotaUser'] = quota_user unless quota_user.nil?
2457
+ command.query['userIp'] = user_ip unless user_ip.nil?
2458
+ execute_or_queue_command(command, &block)
2459
+ end
2460
+
2461
+ # Deletes a role.
2462
+ # @param [String] customer
2463
+ # Immutable ID of the Google Apps account.
2464
+ # @param [String] role_id
2465
+ # Immutable ID of the role.
2466
+ # @param [String] fields
2467
+ # Selector specifying which fields to include in a partial response.
2468
+ # @param [String] quota_user
2469
+ # Available to use for quota purposes for server-side applications. Can be any
2470
+ # arbitrary string assigned to a user, but should not exceed 40 characters.
2471
+ # Overrides userIp if both are provided.
2472
+ # @param [String] user_ip
2473
+ # IP address of the site where the request originates. Use this if you want to
2474
+ # enforce per-user limits.
2475
+ # @param [Google::Apis::RequestOptions] options
2476
+ # Request-specific options
2477
+ #
2478
+ # @yield [result, err] Result & error if block supplied
2479
+ # @yieldparam result [NilClass] No result returned for this method
2480
+ # @yieldparam err [StandardError] error object if request failed
2481
+ #
2482
+ # @return [void]
2483
+ #
2484
+ # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
2485
+ # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
2486
+ # @raise [Google::Apis::AuthorizationError] Authorization is required
2487
+ def delete_role(customer, role_id, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block)
2488
+ command = make_simple_command(:delete, 'customer/{customer}/roles/{roleId}', options)
2489
+ command.params['customer'] = customer unless customer.nil?
2490
+ command.params['roleId'] = role_id unless role_id.nil?
2491
+ command.query['fields'] = fields unless fields.nil?
2492
+ command.query['quotaUser'] = quota_user unless quota_user.nil?
2493
+ command.query['userIp'] = user_ip unless user_ip.nil?
2494
+ execute_or_queue_command(command, &block)
2495
+ end
2496
+
2497
+ # Retrieves a role.
2498
+ # @param [String] customer
2499
+ # Immutable ID of the Google Apps account.
2500
+ # @param [String] role_id
2501
+ # Immutable ID of the role.
2502
+ # @param [String] fields
2503
+ # Selector specifying which fields to include in a partial response.
2504
+ # @param [String] quota_user
2505
+ # Available to use for quota purposes for server-side applications. Can be any
2506
+ # arbitrary string assigned to a user, but should not exceed 40 characters.
2507
+ # Overrides userIp if both are provided.
2508
+ # @param [String] user_ip
2509
+ # IP address of the site where the request originates. Use this if you want to
2510
+ # enforce per-user limits.
2511
+ # @param [Google::Apis::RequestOptions] options
2512
+ # Request-specific options
2513
+ #
2514
+ # @yield [result, err] Result & error if block supplied
2515
+ # @yieldparam result [Google::Apis::AdminDirectoryV1::Role] parsed result object
2516
+ # @yieldparam err [StandardError] error object if request failed
2517
+ #
2518
+ # @return [Google::Apis::AdminDirectoryV1::Role]
2519
+ #
2520
+ # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
2521
+ # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
2522
+ # @raise [Google::Apis::AuthorizationError] Authorization is required
2523
+ def get_role(customer, role_id, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block)
2524
+ command = make_simple_command(:get, 'customer/{customer}/roles/{roleId}', options)
2525
+ command.response_representation = Google::Apis::AdminDirectoryV1::Role::Representation
2526
+ command.response_class = Google::Apis::AdminDirectoryV1::Role
2527
+ command.params['customer'] = customer unless customer.nil?
2528
+ command.params['roleId'] = role_id unless role_id.nil?
2529
+ command.query['fields'] = fields unless fields.nil?
2530
+ command.query['quotaUser'] = quota_user unless quota_user.nil?
2531
+ command.query['userIp'] = user_ip unless user_ip.nil?
2532
+ execute_or_queue_command(command, &block)
2533
+ end
2534
+
2535
+ # Creates a role.
2536
+ # @param [String] customer
2537
+ # Immutable ID of the Google Apps account.
2538
+ # @param [Google::Apis::AdminDirectoryV1::Role] role_object
2539
+ # @param [String] fields
2540
+ # Selector specifying which fields to include in a partial response.
2541
+ # @param [String] quota_user
2542
+ # Available to use for quota purposes for server-side applications. Can be any
2543
+ # arbitrary string assigned to a user, but should not exceed 40 characters.
2544
+ # Overrides userIp if both are provided.
2545
+ # @param [String] user_ip
2546
+ # IP address of the site where the request originates. Use this if you want to
2547
+ # enforce per-user limits.
2548
+ # @param [Google::Apis::RequestOptions] options
2549
+ # Request-specific options
2550
+ #
2551
+ # @yield [result, err] Result & error if block supplied
2552
+ # @yieldparam result [Google::Apis::AdminDirectoryV1::Role] parsed result object
2553
+ # @yieldparam err [StandardError] error object if request failed
2554
+ #
2555
+ # @return [Google::Apis::AdminDirectoryV1::Role]
2556
+ #
2557
+ # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
2558
+ # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
2559
+ # @raise [Google::Apis::AuthorizationError] Authorization is required
2560
+ def insert_role(customer, role_object = nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block)
2561
+ command = make_simple_command(:post, 'customer/{customer}/roles', options)
2562
+ command.request_representation = Google::Apis::AdminDirectoryV1::Role::Representation
2563
+ command.request_object = role_object
2564
+ command.response_representation = Google::Apis::AdminDirectoryV1::Role::Representation
2565
+ command.response_class = Google::Apis::AdminDirectoryV1::Role
2566
+ command.params['customer'] = customer unless customer.nil?
2567
+ command.query['fields'] = fields unless fields.nil?
2568
+ command.query['quotaUser'] = quota_user unless quota_user.nil?
2569
+ command.query['userIp'] = user_ip unless user_ip.nil?
2570
+ execute_or_queue_command(command, &block)
2571
+ end
2572
+
2573
+ # Retrieves a paginated list of all the roles in a domain.
2574
+ # @param [String] customer
2575
+ # Immutable id of the Google Apps account.
2576
+ # @param [Fixnum] max_results
2577
+ # Maximum number of results to return.
2578
+ # @param [String] page_token
2579
+ # Token to specify the next page in the list.
2580
+ # @param [String] fields
2581
+ # Selector specifying which fields to include in a partial response.
2582
+ # @param [String] quota_user
2583
+ # Available to use for quota purposes for server-side applications. Can be any
2584
+ # arbitrary string assigned to a user, but should not exceed 40 characters.
2585
+ # Overrides userIp if both are provided.
2586
+ # @param [String] user_ip
2587
+ # IP address of the site where the request originates. Use this if you want to
2588
+ # enforce per-user limits.
2589
+ # @param [Google::Apis::RequestOptions] options
2590
+ # Request-specific options
2591
+ #
2592
+ # @yield [result, err] Result & error if block supplied
2593
+ # @yieldparam result [Google::Apis::AdminDirectoryV1::Roles] parsed result object
2594
+ # @yieldparam err [StandardError] error object if request failed
2595
+ #
2596
+ # @return [Google::Apis::AdminDirectoryV1::Roles]
2597
+ #
2598
+ # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
2599
+ # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
2600
+ # @raise [Google::Apis::AuthorizationError] Authorization is required
2601
+ def list_roles(customer, max_results: nil, page_token: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block)
2602
+ command = make_simple_command(:get, 'customer/{customer}/roles', options)
2603
+ command.response_representation = Google::Apis::AdminDirectoryV1::Roles::Representation
2604
+ command.response_class = Google::Apis::AdminDirectoryV1::Roles
2605
+ command.params['customer'] = customer unless customer.nil?
2606
+ command.query['maxResults'] = max_results unless max_results.nil?
2607
+ command.query['pageToken'] = page_token unless page_token.nil?
2608
+ command.query['fields'] = fields unless fields.nil?
2609
+ command.query['quotaUser'] = quota_user unless quota_user.nil?
2610
+ command.query['userIp'] = user_ip unless user_ip.nil?
2611
+ execute_or_queue_command(command, &block)
2612
+ end
2613
+
2614
+ # Updates a role. This method supports patch semantics.
2615
+ # @param [String] customer
2616
+ # Immutable ID of the Google Apps account.
2617
+ # @param [String] role_id
2618
+ # Immutable ID of the role.
2619
+ # @param [Google::Apis::AdminDirectoryV1::Role] role_object
2620
+ # @param [String] fields
2621
+ # Selector specifying which fields to include in a partial response.
2622
+ # @param [String] quota_user
2623
+ # Available to use for quota purposes for server-side applications. Can be any
2624
+ # arbitrary string assigned to a user, but should not exceed 40 characters.
2625
+ # Overrides userIp if both are provided.
2626
+ # @param [String] user_ip
2627
+ # IP address of the site where the request originates. Use this if you want to
2628
+ # enforce per-user limits.
2629
+ # @param [Google::Apis::RequestOptions] options
2630
+ # Request-specific options
2631
+ #
2632
+ # @yield [result, err] Result & error if block supplied
2633
+ # @yieldparam result [Google::Apis::AdminDirectoryV1::Role] parsed result object
2634
+ # @yieldparam err [StandardError] error object if request failed
2635
+ #
2636
+ # @return [Google::Apis::AdminDirectoryV1::Role]
2637
+ #
2638
+ # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
2639
+ # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
2640
+ # @raise [Google::Apis::AuthorizationError] Authorization is required
2641
+ def patch_role(customer, role_id, role_object = nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block)
2642
+ command = make_simple_command(:patch, 'customer/{customer}/roles/{roleId}', options)
2643
+ command.request_representation = Google::Apis::AdminDirectoryV1::Role::Representation
2644
+ command.request_object = role_object
2645
+ command.response_representation = Google::Apis::AdminDirectoryV1::Role::Representation
2646
+ command.response_class = Google::Apis::AdminDirectoryV1::Role
2647
+ command.params['customer'] = customer unless customer.nil?
2648
+ command.params['roleId'] = role_id unless role_id.nil?
2649
+ command.query['fields'] = fields unless fields.nil?
2650
+ command.query['quotaUser'] = quota_user unless quota_user.nil?
2651
+ command.query['userIp'] = user_ip unless user_ip.nil?
2652
+ execute_or_queue_command(command, &block)
2653
+ end
2654
+
2655
+ # Updates a role.
2656
+ # @param [String] customer
2657
+ # Immutable ID of the Google Apps account.
2658
+ # @param [String] role_id
2659
+ # Immutable ID of the role.
2660
+ # @param [Google::Apis::AdminDirectoryV1::Role] role_object
2661
+ # @param [String] fields
2662
+ # Selector specifying which fields to include in a partial response.
2663
+ # @param [String] quota_user
2664
+ # Available to use for quota purposes for server-side applications. Can be any
2665
+ # arbitrary string assigned to a user, but should not exceed 40 characters.
2666
+ # Overrides userIp if both are provided.
2667
+ # @param [String] user_ip
2668
+ # IP address of the site where the request originates. Use this if you want to
2669
+ # enforce per-user limits.
2670
+ # @param [Google::Apis::RequestOptions] options
2671
+ # Request-specific options
2672
+ #
2673
+ # @yield [result, err] Result & error if block supplied
2674
+ # @yieldparam result [Google::Apis::AdminDirectoryV1::Role] parsed result object
2675
+ # @yieldparam err [StandardError] error object if request failed
2676
+ #
2677
+ # @return [Google::Apis::AdminDirectoryV1::Role]
2678
+ #
2679
+ # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
2680
+ # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
2681
+ # @raise [Google::Apis::AuthorizationError] Authorization is required
2682
+ def update_role(customer, role_id, role_object = nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block)
2683
+ command = make_simple_command(:put, 'customer/{customer}/roles/{roleId}', options)
2684
+ command.request_representation = Google::Apis::AdminDirectoryV1::Role::Representation
2685
+ command.request_object = role_object
2686
+ command.response_representation = Google::Apis::AdminDirectoryV1::Role::Representation
2687
+ command.response_class = Google::Apis::AdminDirectoryV1::Role
2688
+ command.params['customer'] = customer unless customer.nil?
2689
+ command.params['roleId'] = role_id unless role_id.nil?
2690
+ command.query['fields'] = fields unless fields.nil?
2691
+ command.query['quotaUser'] = quota_user unless quota_user.nil?
2692
+ command.query['userIp'] = user_ip unless user_ip.nil?
2693
+ execute_or_queue_command(command, &block)
2694
+ end
2695
+
2696
+ # Delete schema
2697
+ # @param [String] customer_id
2698
+ # Immutable id of the Google Apps account
2699
+ # @param [String] schema_key
2700
+ # Name or immutable Id of the schema
2701
+ # @param [String] fields
2702
+ # Selector specifying which fields to include in a partial response.
2703
+ # @param [String] quota_user
2704
+ # Available to use for quota purposes for server-side applications. Can be any
2705
+ # arbitrary string assigned to a user, but should not exceed 40 characters.
2706
+ # Overrides userIp if both are provided.
2707
+ # @param [String] user_ip
2708
+ # IP address of the site where the request originates. Use this if you want to
2709
+ # enforce per-user limits.
2710
+ # @param [Google::Apis::RequestOptions] options
2711
+ # Request-specific options
2712
+ #
2713
+ # @yield [result, err] Result & error if block supplied
2714
+ # @yieldparam result [NilClass] No result returned for this method
2715
+ # @yieldparam err [StandardError] error object if request failed
2716
+ #
2717
+ # @return [void]
2718
+ #
2719
+ # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
2720
+ # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
2721
+ # @raise [Google::Apis::AuthorizationError] Authorization is required
2722
+ def delete_schema(customer_id, schema_key, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block)
2723
+ command = make_simple_command(:delete, 'customer/{customerId}/schemas/{schemaKey}', options)
2724
+ command.params['customerId'] = customer_id unless customer_id.nil?
2725
+ command.params['schemaKey'] = schema_key unless schema_key.nil?
2726
+ command.query['fields'] = fields unless fields.nil?
2727
+ command.query['quotaUser'] = quota_user unless quota_user.nil?
2728
+ command.query['userIp'] = user_ip unless user_ip.nil?
2729
+ execute_or_queue_command(command, &block)
2730
+ end
2731
+
2732
+ # Retrieve schema
2733
+ # @param [String] customer_id
2734
+ # Immutable id of the Google Apps account
2735
+ # @param [String] schema_key
2736
+ # Name or immutable Id of the schema
2737
+ # @param [String] fields
2738
+ # Selector specifying which fields to include in a partial response.
2739
+ # @param [String] quota_user
2740
+ # Available to use for quota purposes for server-side applications. Can be any
2741
+ # arbitrary string assigned to a user, but should not exceed 40 characters.
2742
+ # Overrides userIp if both are provided.
2743
+ # @param [String] user_ip
2744
+ # IP address of the site where the request originates. Use this if you want to
2745
+ # enforce per-user limits.
2746
+ # @param [Google::Apis::RequestOptions] options
2747
+ # Request-specific options
2748
+ #
2749
+ # @yield [result, err] Result & error if block supplied
2750
+ # @yieldparam result [Google::Apis::AdminDirectoryV1::Schema] parsed result object
2751
+ # @yieldparam err [StandardError] error object if request failed
2752
+ #
2753
+ # @return [Google::Apis::AdminDirectoryV1::Schema]
2754
+ #
2755
+ # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
2756
+ # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
2757
+ # @raise [Google::Apis::AuthorizationError] Authorization is required
2758
+ def get_schema(customer_id, schema_key, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block)
2759
+ command = make_simple_command(:get, 'customer/{customerId}/schemas/{schemaKey}', options)
2760
+ command.response_representation = Google::Apis::AdminDirectoryV1::Schema::Representation
2761
+ command.response_class = Google::Apis::AdminDirectoryV1::Schema
2762
+ command.params['customerId'] = customer_id unless customer_id.nil?
2763
+ command.params['schemaKey'] = schema_key unless schema_key.nil?
2764
+ command.query['fields'] = fields unless fields.nil?
2765
+ command.query['quotaUser'] = quota_user unless quota_user.nil?
2766
+ command.query['userIp'] = user_ip unless user_ip.nil?
2767
+ execute_or_queue_command(command, &block)
2768
+ end
2769
+
2770
+ # Create schema.
2771
+ # @param [String] customer_id
2772
+ # Immutable id of the Google Apps account
2773
+ # @param [Google::Apis::AdminDirectoryV1::Schema] schema_object
2774
+ # @param [String] fields
2775
+ # Selector specifying which fields to include in a partial response.
2776
+ # @param [String] quota_user
2777
+ # Available to use for quota purposes for server-side applications. Can be any
2778
+ # arbitrary string assigned to a user, but should not exceed 40 characters.
2779
+ # Overrides userIp if both are provided.
2780
+ # @param [String] user_ip
2781
+ # IP address of the site where the request originates. Use this if you want to
2782
+ # enforce per-user limits.
2783
+ # @param [Google::Apis::RequestOptions] options
2784
+ # Request-specific options
2785
+ #
2786
+ # @yield [result, err] Result & error if block supplied
2787
+ # @yieldparam result [Google::Apis::AdminDirectoryV1::Schema] parsed result object
2788
+ # @yieldparam err [StandardError] error object if request failed
2789
+ #
2790
+ # @return [Google::Apis::AdminDirectoryV1::Schema]
2791
+ #
2792
+ # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
2793
+ # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
2794
+ # @raise [Google::Apis::AuthorizationError] Authorization is required
2795
+ def insert_schema(customer_id, schema_object = nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block)
2796
+ command = make_simple_command(:post, 'customer/{customerId}/schemas', options)
2797
+ command.request_representation = Google::Apis::AdminDirectoryV1::Schema::Representation
2798
+ command.request_object = schema_object
2799
+ command.response_representation = Google::Apis::AdminDirectoryV1::Schema::Representation
2800
+ command.response_class = Google::Apis::AdminDirectoryV1::Schema
2801
+ command.params['customerId'] = customer_id unless customer_id.nil?
2802
+ command.query['fields'] = fields unless fields.nil?
2803
+ command.query['quotaUser'] = quota_user unless quota_user.nil?
2804
+ command.query['userIp'] = user_ip unless user_ip.nil?
2805
+ execute_or_queue_command(command, &block)
2806
+ end
2807
+
2808
+ # Retrieve all schemas for a customer
2809
+ # @param [String] customer_id
2810
+ # Immutable id of the Google Apps account
2811
+ # @param [String] fields
2812
+ # Selector specifying which fields to include in a partial response.
2813
+ # @param [String] quota_user
2814
+ # Available to use for quota purposes for server-side applications. Can be any
2815
+ # arbitrary string assigned to a user, but should not exceed 40 characters.
2816
+ # Overrides userIp if both are provided.
2817
+ # @param [String] user_ip
2818
+ # IP address of the site where the request originates. Use this if you want to
2819
+ # enforce per-user limits.
2820
+ # @param [Google::Apis::RequestOptions] options
2821
+ # Request-specific options
2822
+ #
2823
+ # @yield [result, err] Result & error if block supplied
2824
+ # @yieldparam result [Google::Apis::AdminDirectoryV1::Schemas] parsed result object
2825
+ # @yieldparam err [StandardError] error object if request failed
2826
+ #
2827
+ # @return [Google::Apis::AdminDirectoryV1::Schemas]
2828
+ #
2829
+ # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
2830
+ # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
2831
+ # @raise [Google::Apis::AuthorizationError] Authorization is required
2832
+ def list_schemas(customer_id, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block)
2833
+ command = make_simple_command(:get, 'customer/{customerId}/schemas', options)
2834
+ command.response_representation = Google::Apis::AdminDirectoryV1::Schemas::Representation
2835
+ command.response_class = Google::Apis::AdminDirectoryV1::Schemas
2836
+ command.params['customerId'] = customer_id unless customer_id.nil?
2837
+ command.query['fields'] = fields unless fields.nil?
2838
+ command.query['quotaUser'] = quota_user unless quota_user.nil?
2839
+ command.query['userIp'] = user_ip unless user_ip.nil?
2840
+ execute_or_queue_command(command, &block)
2841
+ end
2842
+
2843
+ # Update schema. This method supports patch semantics.
2844
+ # @param [String] customer_id
2845
+ # Immutable id of the Google Apps account
2846
+ # @param [String] schema_key
2847
+ # Name or immutable Id of the schema.
2848
+ # @param [Google::Apis::AdminDirectoryV1::Schema] schema_object
2849
+ # @param [String] fields
2850
+ # Selector specifying which fields to include in a partial response.
2851
+ # @param [String] quota_user
2852
+ # Available to use for quota purposes for server-side applications. Can be any
2853
+ # arbitrary string assigned to a user, but should not exceed 40 characters.
2854
+ # Overrides userIp if both are provided.
2855
+ # @param [String] user_ip
2856
+ # IP address of the site where the request originates. Use this if you want to
2857
+ # enforce per-user limits.
2858
+ # @param [Google::Apis::RequestOptions] options
2859
+ # Request-specific options
2860
+ #
2861
+ # @yield [result, err] Result & error if block supplied
2862
+ # @yieldparam result [Google::Apis::AdminDirectoryV1::Schema] parsed result object
2863
+ # @yieldparam err [StandardError] error object if request failed
2864
+ #
2865
+ # @return [Google::Apis::AdminDirectoryV1::Schema]
2866
+ #
2867
+ # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
2868
+ # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
2869
+ # @raise [Google::Apis::AuthorizationError] Authorization is required
2870
+ def patch_schema(customer_id, schema_key, schema_object = nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block)
2871
+ command = make_simple_command(:patch, 'customer/{customerId}/schemas/{schemaKey}', options)
2872
+ command.request_representation = Google::Apis::AdminDirectoryV1::Schema::Representation
2873
+ command.request_object = schema_object
2874
+ command.response_representation = Google::Apis::AdminDirectoryV1::Schema::Representation
2875
+ command.response_class = Google::Apis::AdminDirectoryV1::Schema
2876
+ command.params['customerId'] = customer_id unless customer_id.nil?
2877
+ command.params['schemaKey'] = schema_key unless schema_key.nil?
2878
+ command.query['fields'] = fields unless fields.nil?
2879
+ command.query['quotaUser'] = quota_user unless quota_user.nil?
2880
+ command.query['userIp'] = user_ip unless user_ip.nil?
2881
+ execute_or_queue_command(command, &block)
2882
+ end
2883
+
2884
+ # Update schema
2885
+ # @param [String] customer_id
2886
+ # Immutable id of the Google Apps account
2887
+ # @param [String] schema_key
2888
+ # Name or immutable Id of the schema.
2889
+ # @param [Google::Apis::AdminDirectoryV1::Schema] schema_object
2890
+ # @param [String] fields
2891
+ # Selector specifying which fields to include in a partial response.
2892
+ # @param [String] quota_user
2893
+ # Available to use for quota purposes for server-side applications. Can be any
2894
+ # arbitrary string assigned to a user, but should not exceed 40 characters.
2895
+ # Overrides userIp if both are provided.
2896
+ # @param [String] user_ip
2897
+ # IP address of the site where the request originates. Use this if you want to
2898
+ # enforce per-user limits.
2899
+ # @param [Google::Apis::RequestOptions] options
2900
+ # Request-specific options
2901
+ #
2902
+ # @yield [result, err] Result & error if block supplied
2903
+ # @yieldparam result [Google::Apis::AdminDirectoryV1::Schema] parsed result object
2904
+ # @yieldparam err [StandardError] error object if request failed
2905
+ #
2906
+ # @return [Google::Apis::AdminDirectoryV1::Schema]
2907
+ #
2908
+ # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
2909
+ # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
2910
+ # @raise [Google::Apis::AuthorizationError] Authorization is required
2911
+ def update_schema(customer_id, schema_key, schema_object = nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block)
2912
+ command = make_simple_command(:put, 'customer/{customerId}/schemas/{schemaKey}', options)
2913
+ command.request_representation = Google::Apis::AdminDirectoryV1::Schema::Representation
2914
+ command.request_object = schema_object
2915
+ command.response_representation = Google::Apis::AdminDirectoryV1::Schema::Representation
2916
+ command.response_class = Google::Apis::AdminDirectoryV1::Schema
2917
+ command.params['customerId'] = customer_id unless customer_id.nil?
2918
+ command.params['schemaKey'] = schema_key unless schema_key.nil?
2919
+ command.query['fields'] = fields unless fields.nil?
2920
+ command.query['quotaUser'] = quota_user unless quota_user.nil?
2921
+ command.query['userIp'] = user_ip unless user_ip.nil?
2922
+ execute_or_queue_command(command, &block)
2923
+ end
2924
+
2925
+ # Delete all access tokens issued by a user for an application.
2926
+ # @param [String] user_key
2927
+ # Identifies the user in the API request. The value can be the user's primary
2928
+ # email address, alias email address, or unique user ID.
2929
+ # @param [String] client_id
2930
+ # The Client ID of the application the token is issued to.
2931
+ # @param [String] fields
2932
+ # Selector specifying which fields to include in a partial response.
2933
+ # @param [String] quota_user
2934
+ # Available to use for quota purposes for server-side applications. Can be any
2935
+ # arbitrary string assigned to a user, but should not exceed 40 characters.
2936
+ # Overrides userIp if both are provided.
2937
+ # @param [String] user_ip
2938
+ # IP address of the site where the request originates. Use this if you want to
2939
+ # enforce per-user limits.
2940
+ # @param [Google::Apis::RequestOptions] options
2941
+ # Request-specific options
2942
+ #
2943
+ # @yield [result, err] Result & error if block supplied
2944
+ # @yieldparam result [NilClass] No result returned for this method
2945
+ # @yieldparam err [StandardError] error object if request failed
2946
+ #
2947
+ # @return [void]
2948
+ #
2949
+ # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
2950
+ # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
2951
+ # @raise [Google::Apis::AuthorizationError] Authorization is required
2952
+ def delete_token(user_key, client_id, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block)
2953
+ command = make_simple_command(:delete, 'users/{userKey}/tokens/{clientId}', options)
2954
+ command.params['userKey'] = user_key unless user_key.nil?
2955
+ command.params['clientId'] = client_id unless client_id.nil?
2956
+ command.query['fields'] = fields unless fields.nil?
2957
+ command.query['quotaUser'] = quota_user unless quota_user.nil?
2958
+ command.query['userIp'] = user_ip unless user_ip.nil?
2959
+ execute_or_queue_command(command, &block)
2960
+ end
2961
+
2962
+ # Get information about an access token issued by a user.
2963
+ # @param [String] user_key
2964
+ # Identifies the user in the API request. The value can be the user's primary
2965
+ # email address, alias email address, or unique user ID.
2966
+ # @param [String] client_id
2967
+ # The Client ID of the application the token is issued to.
2968
+ # @param [String] fields
2969
+ # Selector specifying which fields to include in a partial response.
2970
+ # @param [String] quota_user
2971
+ # Available to use for quota purposes for server-side applications. Can be any
2972
+ # arbitrary string assigned to a user, but should not exceed 40 characters.
2973
+ # Overrides userIp if both are provided.
2974
+ # @param [String] user_ip
2975
+ # IP address of the site where the request originates. Use this if you want to
2976
+ # enforce per-user limits.
2977
+ # @param [Google::Apis::RequestOptions] options
2978
+ # Request-specific options
2979
+ #
2980
+ # @yield [result, err] Result & error if block supplied
2981
+ # @yieldparam result [Google::Apis::AdminDirectoryV1::Token] parsed result object
2982
+ # @yieldparam err [StandardError] error object if request failed
2983
+ #
2984
+ # @return [Google::Apis::AdminDirectoryV1::Token]
2985
+ #
2986
+ # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
2987
+ # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
2988
+ # @raise [Google::Apis::AuthorizationError] Authorization is required
2989
+ def get_token(user_key, client_id, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block)
2990
+ command = make_simple_command(:get, 'users/{userKey}/tokens/{clientId}', options)
2991
+ command.response_representation = Google::Apis::AdminDirectoryV1::Token::Representation
2992
+ command.response_class = Google::Apis::AdminDirectoryV1::Token
2993
+ command.params['userKey'] = user_key unless user_key.nil?
2994
+ command.params['clientId'] = client_id unless client_id.nil?
2995
+ command.query['fields'] = fields unless fields.nil?
2996
+ command.query['quotaUser'] = quota_user unless quota_user.nil?
2997
+ command.query['userIp'] = user_ip unless user_ip.nil?
2998
+ execute_or_queue_command(command, &block)
2999
+ end
3000
+
3001
+ # Returns the set of tokens specified user has issued to 3rd party applications.
3002
+ # @param [String] user_key
3003
+ # Identifies the user in the API request. The value can be the user's primary
3004
+ # email address, alias email address, or unique user ID.
3005
+ # @param [String] fields
3006
+ # Selector specifying which fields to include in a partial response.
3007
+ # @param [String] quota_user
3008
+ # Available to use for quota purposes for server-side applications. Can be any
3009
+ # arbitrary string assigned to a user, but should not exceed 40 characters.
3010
+ # Overrides userIp if both are provided.
3011
+ # @param [String] user_ip
3012
+ # IP address of the site where the request originates. Use this if you want to
3013
+ # enforce per-user limits.
3014
+ # @param [Google::Apis::RequestOptions] options
3015
+ # Request-specific options
3016
+ #
3017
+ # @yield [result, err] Result & error if block supplied
3018
+ # @yieldparam result [Google::Apis::AdminDirectoryV1::Tokens] parsed result object
3019
+ # @yieldparam err [StandardError] error object if request failed
3020
+ #
3021
+ # @return [Google::Apis::AdminDirectoryV1::Tokens]
3022
+ #
3023
+ # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
3024
+ # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
3025
+ # @raise [Google::Apis::AuthorizationError] Authorization is required
3026
+ def list_tokens(user_key, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block)
3027
+ command = make_simple_command(:get, 'users/{userKey}/tokens', options)
3028
+ command.response_representation = Google::Apis::AdminDirectoryV1::Tokens::Representation
3029
+ command.response_class = Google::Apis::AdminDirectoryV1::Tokens
3030
+ command.params['userKey'] = user_key unless user_key.nil?
3031
+ command.query['fields'] = fields unless fields.nil?
3032
+ command.query['quotaUser'] = quota_user unless quota_user.nil?
3033
+ command.query['userIp'] = user_ip unless user_ip.nil?
3034
+ execute_or_queue_command(command, &block)
3035
+ end
3036
+
3037
+ # Delete user
3038
+ # @param [String] user_key
3039
+ # Email or immutable Id of the user
3040
+ # @param [String] fields
3041
+ # Selector specifying which fields to include in a partial response.
3042
+ # @param [String] quota_user
3043
+ # Available to use for quota purposes for server-side applications. Can be any
3044
+ # arbitrary string assigned to a user, but should not exceed 40 characters.
3045
+ # Overrides userIp if both are provided.
3046
+ # @param [String] user_ip
3047
+ # IP address of the site where the request originates. Use this if you want to
3048
+ # enforce per-user limits.
3049
+ # @param [Google::Apis::RequestOptions] options
3050
+ # Request-specific options
3051
+ #
3052
+ # @yield [result, err] Result & error if block supplied
3053
+ # @yieldparam result [NilClass] No result returned for this method
3054
+ # @yieldparam err [StandardError] error object if request failed
3055
+ #
3056
+ # @return [void]
3057
+ #
3058
+ # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
3059
+ # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
3060
+ # @raise [Google::Apis::AuthorizationError] Authorization is required
3061
+ def delete_user(user_key, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block)
3062
+ command = make_simple_command(:delete, 'users/{userKey}', options)
3063
+ command.params['userKey'] = user_key unless user_key.nil?
3064
+ command.query['fields'] = fields unless fields.nil?
3065
+ command.query['quotaUser'] = quota_user unless quota_user.nil?
3066
+ command.query['userIp'] = user_ip unless user_ip.nil?
3067
+ execute_or_queue_command(command, &block)
3068
+ end
3069
+
3070
+ # retrieve user
3071
+ # @param [String] user_key
3072
+ # Email or immutable Id of the user
3073
+ # @param [String] custom_field_mask
3074
+ # Comma-separated list of schema names. All fields from these schemas are
3075
+ # fetched. This should only be set when projection=custom.
3076
+ # @param [String] projection
3077
+ # What subset of fields to fetch for this user.
3078
+ # @param [String] view_type
3079
+ # Whether to fetch the ADMIN_VIEW or DOMAIN_PUBLIC view of the user.
3080
+ # @param [String] fields
3081
+ # Selector specifying which fields to include in a partial response.
3082
+ # @param [String] quota_user
3083
+ # Available to use for quota purposes for server-side applications. Can be any
3084
+ # arbitrary string assigned to a user, but should not exceed 40 characters.
3085
+ # Overrides userIp if both are provided.
3086
+ # @param [String] user_ip
3087
+ # IP address of the site where the request originates. Use this if you want to
3088
+ # enforce per-user limits.
3089
+ # @param [Google::Apis::RequestOptions] options
3090
+ # Request-specific options
3091
+ #
3092
+ # @yield [result, err] Result & error if block supplied
3093
+ # @yieldparam result [Google::Apis::AdminDirectoryV1::User] parsed result object
3094
+ # @yieldparam err [StandardError] error object if request failed
3095
+ #
3096
+ # @return [Google::Apis::AdminDirectoryV1::User]
3097
+ #
3098
+ # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
3099
+ # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
3100
+ # @raise [Google::Apis::AuthorizationError] Authorization is required
3101
+ def get_user(user_key, custom_field_mask: nil, projection: nil, view_type: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block)
3102
+ command = make_simple_command(:get, 'users/{userKey}', options)
3103
+ command.response_representation = Google::Apis::AdminDirectoryV1::User::Representation
3104
+ command.response_class = Google::Apis::AdminDirectoryV1::User
3105
+ command.params['userKey'] = user_key unless user_key.nil?
3106
+ command.query['customFieldMask'] = custom_field_mask unless custom_field_mask.nil?
3107
+ command.query['projection'] = projection unless projection.nil?
3108
+ command.query['viewType'] = view_type unless view_type.nil?
3109
+ command.query['fields'] = fields unless fields.nil?
3110
+ command.query['quotaUser'] = quota_user unless quota_user.nil?
3111
+ command.query['userIp'] = user_ip unless user_ip.nil?
3112
+ execute_or_queue_command(command, &block)
3113
+ end
3114
+
3115
+ # create user.
3116
+ # @param [Google::Apis::AdminDirectoryV1::User] user_object
3117
+ # @param [String] fields
3118
+ # Selector specifying which fields to include in a partial response.
3119
+ # @param [String] quota_user
3120
+ # Available to use for quota purposes for server-side applications. Can be any
3121
+ # arbitrary string assigned to a user, but should not exceed 40 characters.
3122
+ # Overrides userIp if both are provided.
3123
+ # @param [String] user_ip
3124
+ # IP address of the site where the request originates. Use this if you want to
3125
+ # enforce per-user limits.
3126
+ # @param [Google::Apis::RequestOptions] options
3127
+ # Request-specific options
3128
+ #
3129
+ # @yield [result, err] Result & error if block supplied
3130
+ # @yieldparam result [Google::Apis::AdminDirectoryV1::User] parsed result object
3131
+ # @yieldparam err [StandardError] error object if request failed
3132
+ #
3133
+ # @return [Google::Apis::AdminDirectoryV1::User]
3134
+ #
3135
+ # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
3136
+ # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
3137
+ # @raise [Google::Apis::AuthorizationError] Authorization is required
3138
+ def insert_user(user_object = nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block)
3139
+ command = make_simple_command(:post, 'users', options)
3140
+ command.request_representation = Google::Apis::AdminDirectoryV1::User::Representation
3141
+ command.request_object = user_object
3142
+ command.response_representation = Google::Apis::AdminDirectoryV1::User::Representation
3143
+ command.response_class = Google::Apis::AdminDirectoryV1::User
3144
+ command.query['fields'] = fields unless fields.nil?
3145
+ command.query['quotaUser'] = quota_user unless quota_user.nil?
3146
+ command.query['userIp'] = user_ip unless user_ip.nil?
3147
+ execute_or_queue_command(command, &block)
3148
+ end
3149
+
3150
+ # Retrieve either deleted users or all users in a domain (paginated)
3151
+ # @param [String] custom_field_mask
3152
+ # Comma-separated list of schema names. All fields from these schemas are
3153
+ # fetched. This should only be set when projection=custom.
3154
+ # @param [String] customer
3155
+ # Immutable id of the Google Apps account. In case of multi-domain, to fetch all
3156
+ # users for a customer, fill this field instead of domain.
3157
+ # @param [String] domain
3158
+ # Name of the domain. Fill this field to get users from only this domain. To
3159
+ # return all users in a multi-domain fill customer field instead.
3160
+ # @param [String] event
3161
+ # Event on which subscription is intended (if subscribing)
3162
+ # @param [Fixnum] max_results
3163
+ # Maximum number of results to return. Default is 100. Max allowed is 500
3164
+ # @param [String] order_by
3165
+ # Column to use for sorting results
3166
+ # @param [String] page_token
3167
+ # Token to specify next page in the list
3168
+ # @param [String] projection
3169
+ # What subset of fields to fetch for this user.
3170
+ # @param [String] query
3171
+ # Query string search. Should be of the form "". Complete documentation is at
3172
+ # https://developers.google.com/admin-sdk/directory/v1/guides/search-users
3173
+ # @param [String] show_deleted
3174
+ # If set to true retrieves the list of deleted users. Default is false
3175
+ # @param [String] sort_order
3176
+ # Whether to return results in ascending or descending order.
3177
+ # @param [String] view_type
3178
+ # Whether to fetch the ADMIN_VIEW or DOMAIN_PUBLIC view of the user.
3179
+ # @param [String] fields
3180
+ # Selector specifying which fields to include in a partial response.
3181
+ # @param [String] quota_user
3182
+ # Available to use for quota purposes for server-side applications. Can be any
3183
+ # arbitrary string assigned to a user, but should not exceed 40 characters.
3184
+ # Overrides userIp if both are provided.
3185
+ # @param [String] user_ip
3186
+ # IP address of the site where the request originates. Use this if you want to
3187
+ # enforce per-user limits.
3188
+ # @param [Google::Apis::RequestOptions] options
3189
+ # Request-specific options
3190
+ #
3191
+ # @yield [result, err] Result & error if block supplied
3192
+ # @yieldparam result [Google::Apis::AdminDirectoryV1::Users] parsed result object
3193
+ # @yieldparam err [StandardError] error object if request failed
3194
+ #
3195
+ # @return [Google::Apis::AdminDirectoryV1::Users]
3196
+ #
3197
+ # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
3198
+ # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
3199
+ # @raise [Google::Apis::AuthorizationError] Authorization is required
3200
+ def list_users(custom_field_mask: nil, customer: nil, domain: nil, event: nil, max_results: nil, order_by: nil, page_token: nil, projection: nil, query: nil, show_deleted: nil, sort_order: nil, view_type: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block)
3201
+ command = make_simple_command(:get, 'users', options)
3202
+ command.response_representation = Google::Apis::AdminDirectoryV1::Users::Representation
3203
+ command.response_class = Google::Apis::AdminDirectoryV1::Users
3204
+ command.query['customFieldMask'] = custom_field_mask unless custom_field_mask.nil?
3205
+ command.query['customer'] = customer unless customer.nil?
3206
+ command.query['domain'] = domain unless domain.nil?
3207
+ command.query['event'] = event unless event.nil?
3208
+ command.query['maxResults'] = max_results unless max_results.nil?
3209
+ command.query['orderBy'] = order_by unless order_by.nil?
3210
+ command.query['pageToken'] = page_token unless page_token.nil?
3211
+ command.query['projection'] = projection unless projection.nil?
3212
+ command.query['query'] = query unless query.nil?
3213
+ command.query['showDeleted'] = show_deleted unless show_deleted.nil?
3214
+ command.query['sortOrder'] = sort_order unless sort_order.nil?
3215
+ command.query['viewType'] = view_type unless view_type.nil?
3216
+ command.query['fields'] = fields unless fields.nil?
3217
+ command.query['quotaUser'] = quota_user unless quota_user.nil?
3218
+ command.query['userIp'] = user_ip unless user_ip.nil?
3219
+ execute_or_queue_command(command, &block)
3220
+ end
3221
+
3222
+ # change admin status of a user
3223
+ # @param [String] user_key
3224
+ # Email or immutable Id of the user as admin
3225
+ # @param [Google::Apis::AdminDirectoryV1::UserMakeAdmin] user_make_admin_object
3226
+ # @param [String] fields
3227
+ # Selector specifying which fields to include in a partial response.
3228
+ # @param [String] quota_user
3229
+ # Available to use for quota purposes for server-side applications. Can be any
3230
+ # arbitrary string assigned to a user, but should not exceed 40 characters.
3231
+ # Overrides userIp if both are provided.
3232
+ # @param [String] user_ip
3233
+ # IP address of the site where the request originates. Use this if you want to
3234
+ # enforce per-user limits.
3235
+ # @param [Google::Apis::RequestOptions] options
3236
+ # Request-specific options
3237
+ #
3238
+ # @yield [result, err] Result & error if block supplied
3239
+ # @yieldparam result [NilClass] No result returned for this method
3240
+ # @yieldparam err [StandardError] error object if request failed
3241
+ #
3242
+ # @return [void]
3243
+ #
3244
+ # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
3245
+ # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
3246
+ # @raise [Google::Apis::AuthorizationError] Authorization is required
3247
+ def make_user_admin(user_key, user_make_admin_object = nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block)
3248
+ command = make_simple_command(:post, 'users/{userKey}/makeAdmin', options)
3249
+ command.request_representation = Google::Apis::AdminDirectoryV1::UserMakeAdmin::Representation
3250
+ command.request_object = user_make_admin_object
3251
+ command.params['userKey'] = user_key unless user_key.nil?
3252
+ command.query['fields'] = fields unless fields.nil?
3253
+ command.query['quotaUser'] = quota_user unless quota_user.nil?
3254
+ command.query['userIp'] = user_ip unless user_ip.nil?
3255
+ execute_or_queue_command(command, &block)
3256
+ end
3257
+
3258
+ # update user. This method supports patch semantics.
3259
+ # @param [String] user_key
3260
+ # Email or immutable Id of the user. If Id, it should match with id of user
3261
+ # object
3262
+ # @param [Google::Apis::AdminDirectoryV1::User] user_object
3263
+ # @param [String] fields
3264
+ # Selector specifying which fields to include in a partial response.
3265
+ # @param [String] quota_user
3266
+ # Available to use for quota purposes for server-side applications. Can be any
3267
+ # arbitrary string assigned to a user, but should not exceed 40 characters.
3268
+ # Overrides userIp if both are provided.
3269
+ # @param [String] user_ip
3270
+ # IP address of the site where the request originates. Use this if you want to
3271
+ # enforce per-user limits.
3272
+ # @param [Google::Apis::RequestOptions] options
3273
+ # Request-specific options
3274
+ #
3275
+ # @yield [result, err] Result & error if block supplied
3276
+ # @yieldparam result [Google::Apis::AdminDirectoryV1::User] parsed result object
3277
+ # @yieldparam err [StandardError] error object if request failed
3278
+ #
3279
+ # @return [Google::Apis::AdminDirectoryV1::User]
3280
+ #
3281
+ # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
3282
+ # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
3283
+ # @raise [Google::Apis::AuthorizationError] Authorization is required
3284
+ def patch_user(user_key, user_object = nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block)
3285
+ command = make_simple_command(:patch, 'users/{userKey}', options)
3286
+ command.request_representation = Google::Apis::AdminDirectoryV1::User::Representation
3287
+ command.request_object = user_object
3288
+ command.response_representation = Google::Apis::AdminDirectoryV1::User::Representation
3289
+ command.response_class = Google::Apis::AdminDirectoryV1::User
3290
+ command.params['userKey'] = user_key unless user_key.nil?
3291
+ command.query['fields'] = fields unless fields.nil?
3292
+ command.query['quotaUser'] = quota_user unless quota_user.nil?
3293
+ command.query['userIp'] = user_ip unless user_ip.nil?
3294
+ execute_or_queue_command(command, &block)
3295
+ end
3296
+
3297
+ # Undelete a deleted user
3298
+ # @param [String] user_key
3299
+ # The immutable id of the user
3300
+ # @param [Google::Apis::AdminDirectoryV1::UserUndelete] user_undelete_object
3301
+ # @param [String] fields
3302
+ # Selector specifying which fields to include in a partial response.
3303
+ # @param [String] quota_user
3304
+ # Available to use for quota purposes for server-side applications. Can be any
3305
+ # arbitrary string assigned to a user, but should not exceed 40 characters.
3306
+ # Overrides userIp if both are provided.
3307
+ # @param [String] user_ip
3308
+ # IP address of the site where the request originates. Use this if you want to
3309
+ # enforce per-user limits.
3310
+ # @param [Google::Apis::RequestOptions] options
3311
+ # Request-specific options
3312
+ #
3313
+ # @yield [result, err] Result & error if block supplied
3314
+ # @yieldparam result [NilClass] No result returned for this method
3315
+ # @yieldparam err [StandardError] error object if request failed
3316
+ #
3317
+ # @return [void]
3318
+ #
3319
+ # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
3320
+ # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
3321
+ # @raise [Google::Apis::AuthorizationError] Authorization is required
3322
+ def undelete_user(user_key, user_undelete_object = nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block)
3323
+ command = make_simple_command(:post, 'users/{userKey}/undelete', options)
3324
+ command.request_representation = Google::Apis::AdminDirectoryV1::UserUndelete::Representation
3325
+ command.request_object = user_undelete_object
3326
+ command.params['userKey'] = user_key unless user_key.nil?
3327
+ command.query['fields'] = fields unless fields.nil?
3328
+ command.query['quotaUser'] = quota_user unless quota_user.nil?
3329
+ command.query['userIp'] = user_ip unless user_ip.nil?
3330
+ execute_or_queue_command(command, &block)
3331
+ end
3332
+
3333
+ # update user
3334
+ # @param [String] user_key
3335
+ # Email or immutable Id of the user. If Id, it should match with id of user
3336
+ # object
3337
+ # @param [Google::Apis::AdminDirectoryV1::User] user_object
3338
+ # @param [String] fields
3339
+ # Selector specifying which fields to include in a partial response.
3340
+ # @param [String] quota_user
3341
+ # Available to use for quota purposes for server-side applications. Can be any
3342
+ # arbitrary string assigned to a user, but should not exceed 40 characters.
3343
+ # Overrides userIp if both are provided.
3344
+ # @param [String] user_ip
3345
+ # IP address of the site where the request originates. Use this if you want to
3346
+ # enforce per-user limits.
3347
+ # @param [Google::Apis::RequestOptions] options
3348
+ # Request-specific options
3349
+ #
3350
+ # @yield [result, err] Result & error if block supplied
3351
+ # @yieldparam result [Google::Apis::AdminDirectoryV1::User] parsed result object
3352
+ # @yieldparam err [StandardError] error object if request failed
3353
+ #
3354
+ # @return [Google::Apis::AdminDirectoryV1::User]
3355
+ #
3356
+ # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
3357
+ # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
3358
+ # @raise [Google::Apis::AuthorizationError] Authorization is required
3359
+ def update_user(user_key, user_object = nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block)
3360
+ command = make_simple_command(:put, 'users/{userKey}', options)
3361
+ command.request_representation = Google::Apis::AdminDirectoryV1::User::Representation
3362
+ command.request_object = user_object
3363
+ command.response_representation = Google::Apis::AdminDirectoryV1::User::Representation
3364
+ command.response_class = Google::Apis::AdminDirectoryV1::User
3365
+ command.params['userKey'] = user_key unless user_key.nil?
3366
+ command.query['fields'] = fields unless fields.nil?
3367
+ command.query['quotaUser'] = quota_user unless quota_user.nil?
3368
+ command.query['userIp'] = user_ip unless user_ip.nil?
3369
+ execute_or_queue_command(command, &block)
3370
+ end
3371
+
3372
+ # Watch for changes in users list
3373
+ # @param [Google::Apis::AdminDirectoryV1::Channel] channel_object
3374
+ # @param [String] custom_field_mask
3375
+ # Comma-separated list of schema names. All fields from these schemas are
3376
+ # fetched. This should only be set when projection=custom.
3377
+ # @param [String] customer
3378
+ # Immutable id of the Google Apps account. In case of multi-domain, to fetch all
3379
+ # users for a customer, fill this field instead of domain.
3380
+ # @param [String] domain
3381
+ # Name of the domain. Fill this field to get users from only this domain. To
3382
+ # return all users in a multi-domain fill customer field instead.
3383
+ # @param [String] event
3384
+ # Event on which subscription is intended (if subscribing)
3385
+ # @param [Fixnum] max_results
3386
+ # Maximum number of results to return. Default is 100. Max allowed is 500
3387
+ # @param [String] order_by
3388
+ # Column to use for sorting results
3389
+ # @param [String] page_token
3390
+ # Token to specify next page in the list
3391
+ # @param [String] projection
3392
+ # What subset of fields to fetch for this user.
3393
+ # @param [String] query
3394
+ # Query string search. Should be of the form "". Complete documentation is at
3395
+ # https://developers.google.com/admin-sdk/directory/v1/guides/search-users
3396
+ # @param [String] show_deleted
3397
+ # If set to true retrieves the list of deleted users. Default is false
3398
+ # @param [String] sort_order
3399
+ # Whether to return results in ascending or descending order.
3400
+ # @param [String] view_type
3401
+ # Whether to fetch the ADMIN_VIEW or DOMAIN_PUBLIC view of the user.
3402
+ # @param [String] fields
3403
+ # Selector specifying which fields to include in a partial response.
3404
+ # @param [String] quota_user
3405
+ # Available to use for quota purposes for server-side applications. Can be any
3406
+ # arbitrary string assigned to a user, but should not exceed 40 characters.
3407
+ # Overrides userIp if both are provided.
3408
+ # @param [String] user_ip
3409
+ # IP address of the site where the request originates. Use this if you want to
3410
+ # enforce per-user limits.
3411
+ # @param [Google::Apis::RequestOptions] options
3412
+ # Request-specific options
3413
+ #
3414
+ # @yield [result, err] Result & error if block supplied
3415
+ # @yieldparam result [Google::Apis::AdminDirectoryV1::Channel] parsed result object
3416
+ # @yieldparam err [StandardError] error object if request failed
3417
+ #
3418
+ # @return [Google::Apis::AdminDirectoryV1::Channel]
3419
+ #
3420
+ # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
3421
+ # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
3422
+ # @raise [Google::Apis::AuthorizationError] Authorization is required
3423
+ def watch_user(channel_object = nil, custom_field_mask: nil, customer: nil, domain: nil, event: nil, max_results: nil, order_by: nil, page_token: nil, projection: nil, query: nil, show_deleted: nil, sort_order: nil, view_type: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block)
3424
+ command = make_simple_command(:post, 'users/watch', options)
3425
+ command.request_representation = Google::Apis::AdminDirectoryV1::Channel::Representation
3426
+ command.request_object = channel_object
3427
+ command.response_representation = Google::Apis::AdminDirectoryV1::Channel::Representation
3428
+ command.response_class = Google::Apis::AdminDirectoryV1::Channel
3429
+ command.query['customFieldMask'] = custom_field_mask unless custom_field_mask.nil?
3430
+ command.query['customer'] = customer unless customer.nil?
3431
+ command.query['domain'] = domain unless domain.nil?
3432
+ command.query['event'] = event unless event.nil?
3433
+ command.query['maxResults'] = max_results unless max_results.nil?
3434
+ command.query['orderBy'] = order_by unless order_by.nil?
3435
+ command.query['pageToken'] = page_token unless page_token.nil?
3436
+ command.query['projection'] = projection unless projection.nil?
3437
+ command.query['query'] = query unless query.nil?
3438
+ command.query['showDeleted'] = show_deleted unless show_deleted.nil?
3439
+ command.query['sortOrder'] = sort_order unless sort_order.nil?
3440
+ command.query['viewType'] = view_type unless view_type.nil?
3441
+ command.query['fields'] = fields unless fields.nil?
3442
+ command.query['quotaUser'] = quota_user unless quota_user.nil?
3443
+ command.query['userIp'] = user_ip unless user_ip.nil?
3444
+ execute_or_queue_command(command, &block)
3445
+ end
3446
+
3447
+ # Remove a alias for the user
3448
+ # @param [String] user_key
3449
+ # Email or immutable Id of the user
3450
+ # @param [String] user_alias
3451
+ # The alias to be removed
3452
+ # @param [String] fields
3453
+ # Selector specifying which fields to include in a partial response.
3454
+ # @param [String] quota_user
3455
+ # Available to use for quota purposes for server-side applications. Can be any
3456
+ # arbitrary string assigned to a user, but should not exceed 40 characters.
3457
+ # Overrides userIp if both are provided.
3458
+ # @param [String] user_ip
3459
+ # IP address of the site where the request originates. Use this if you want to
3460
+ # enforce per-user limits.
3461
+ # @param [Google::Apis::RequestOptions] options
3462
+ # Request-specific options
3463
+ #
3464
+ # @yield [result, err] Result & error if block supplied
3465
+ # @yieldparam result [NilClass] No result returned for this method
3466
+ # @yieldparam err [StandardError] error object if request failed
3467
+ #
3468
+ # @return [void]
3469
+ #
3470
+ # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
3471
+ # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
3472
+ # @raise [Google::Apis::AuthorizationError] Authorization is required
3473
+ def delete_user_alias(user_key, user_alias, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block)
3474
+ command = make_simple_command(:delete, 'users/{userKey}/aliases/{alias}', options)
3475
+ command.params['userKey'] = user_key unless user_key.nil?
3476
+ command.params['alias'] = user_alias unless user_alias.nil?
3477
+ command.query['fields'] = fields unless fields.nil?
3478
+ command.query['quotaUser'] = quota_user unless quota_user.nil?
3479
+ command.query['userIp'] = user_ip unless user_ip.nil?
3480
+ execute_or_queue_command(command, &block)
3481
+ end
3482
+
3483
+ # Add a alias for the user
3484
+ # @param [String] user_key
3485
+ # Email or immutable Id of the user
3486
+ # @param [Google::Apis::AdminDirectoryV1::Alias] alias_object
3487
+ # @param [String] fields
3488
+ # Selector specifying which fields to include in a partial response.
3489
+ # @param [String] quota_user
3490
+ # Available to use for quota purposes for server-side applications. Can be any
3491
+ # arbitrary string assigned to a user, but should not exceed 40 characters.
3492
+ # Overrides userIp if both are provided.
3493
+ # @param [String] user_ip
3494
+ # IP address of the site where the request originates. Use this if you want to
3495
+ # enforce per-user limits.
3496
+ # @param [Google::Apis::RequestOptions] options
3497
+ # Request-specific options
3498
+ #
3499
+ # @yield [result, err] Result & error if block supplied
3500
+ # @yieldparam result [Google::Apis::AdminDirectoryV1::Alias] parsed result object
3501
+ # @yieldparam err [StandardError] error object if request failed
3502
+ #
3503
+ # @return [Google::Apis::AdminDirectoryV1::Alias]
3504
+ #
3505
+ # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
3506
+ # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
3507
+ # @raise [Google::Apis::AuthorizationError] Authorization is required
3508
+ def insert_user_alias(user_key, alias_object = nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block)
3509
+ command = make_simple_command(:post, 'users/{userKey}/aliases', options)
3510
+ command.request_representation = Google::Apis::AdminDirectoryV1::Alias::Representation
3511
+ command.request_object = alias_object
3512
+ command.response_representation = Google::Apis::AdminDirectoryV1::Alias::Representation
3513
+ command.response_class = Google::Apis::AdminDirectoryV1::Alias
3514
+ command.params['userKey'] = user_key unless user_key.nil?
3515
+ command.query['fields'] = fields unless fields.nil?
3516
+ command.query['quotaUser'] = quota_user unless quota_user.nil?
3517
+ command.query['userIp'] = user_ip unless user_ip.nil?
3518
+ execute_or_queue_command(command, &block)
3519
+ end
3520
+
3521
+ # List all aliases for a user
3522
+ # @param [String] user_key
3523
+ # Email or immutable Id of the user
3524
+ # @param [String] event
3525
+ # Event on which subscription is intended (if subscribing)
3526
+ # @param [String] fields
3527
+ # Selector specifying which fields to include in a partial response.
3528
+ # @param [String] quota_user
3529
+ # Available to use for quota purposes for server-side applications. Can be any
3530
+ # arbitrary string assigned to a user, but should not exceed 40 characters.
3531
+ # Overrides userIp if both are provided.
3532
+ # @param [String] user_ip
3533
+ # IP address of the site where the request originates. Use this if you want to
3534
+ # enforce per-user limits.
3535
+ # @param [Google::Apis::RequestOptions] options
3536
+ # Request-specific options
3537
+ #
3538
+ # @yield [result, err] Result & error if block supplied
3539
+ # @yieldparam result [Google::Apis::AdminDirectoryV1::Aliases] parsed result object
3540
+ # @yieldparam err [StandardError] error object if request failed
3541
+ #
3542
+ # @return [Google::Apis::AdminDirectoryV1::Aliases]
3543
+ #
3544
+ # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
3545
+ # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
3546
+ # @raise [Google::Apis::AuthorizationError] Authorization is required
3547
+ def list_user_aliases(user_key, event: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block)
3548
+ command = make_simple_command(:get, 'users/{userKey}/aliases', options)
3549
+ command.response_representation = Google::Apis::AdminDirectoryV1::Aliases::Representation
3550
+ command.response_class = Google::Apis::AdminDirectoryV1::Aliases
3551
+ command.params['userKey'] = user_key unless user_key.nil?
3552
+ command.query['event'] = event unless event.nil?
3553
+ command.query['fields'] = fields unless fields.nil?
3554
+ command.query['quotaUser'] = quota_user unless quota_user.nil?
3555
+ command.query['userIp'] = user_ip unless user_ip.nil?
3556
+ execute_or_queue_command(command, &block)
3557
+ end
3558
+
3559
+ # Watch for changes in user aliases list
3560
+ # @param [String] user_key
3561
+ # Email or immutable Id of the user
3562
+ # @param [Google::Apis::AdminDirectoryV1::Channel] channel_object
3563
+ # @param [String] event
3564
+ # Event on which subscription is intended (if subscribing)
3565
+ # @param [String] fields
3566
+ # Selector specifying which fields to include in a partial response.
3567
+ # @param [String] quota_user
3568
+ # Available to use for quota purposes for server-side applications. Can be any
3569
+ # arbitrary string assigned to a user, but should not exceed 40 characters.
3570
+ # Overrides userIp if both are provided.
3571
+ # @param [String] user_ip
3572
+ # IP address of the site where the request originates. Use this if you want to
3573
+ # enforce per-user limits.
3574
+ # @param [Google::Apis::RequestOptions] options
3575
+ # Request-specific options
3576
+ #
3577
+ # @yield [result, err] Result & error if block supplied
3578
+ # @yieldparam result [Google::Apis::AdminDirectoryV1::Channel] parsed result object
3579
+ # @yieldparam err [StandardError] error object if request failed
3580
+ #
3581
+ # @return [Google::Apis::AdminDirectoryV1::Channel]
3582
+ #
3583
+ # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
3584
+ # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
3585
+ # @raise [Google::Apis::AuthorizationError] Authorization is required
3586
+ def watch_user_alias(user_key, channel_object = nil, event: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block)
3587
+ command = make_simple_command(:post, 'users/{userKey}/aliases/watch', options)
3588
+ command.request_representation = Google::Apis::AdminDirectoryV1::Channel::Representation
3589
+ command.request_object = channel_object
3590
+ command.response_representation = Google::Apis::AdminDirectoryV1::Channel::Representation
3591
+ command.response_class = Google::Apis::AdminDirectoryV1::Channel
3592
+ command.params['userKey'] = user_key unless user_key.nil?
3593
+ command.query['event'] = event unless event.nil?
3594
+ command.query['fields'] = fields unless fields.nil?
3595
+ command.query['quotaUser'] = quota_user unless quota_user.nil?
3596
+ command.query['userIp'] = user_ip unless user_ip.nil?
3597
+ execute_or_queue_command(command, &block)
3598
+ end
3599
+
3600
+ # Remove photos for the user
3601
+ # @param [String] user_key
3602
+ # Email or immutable Id of the user
3603
+ # @param [String] fields
3604
+ # Selector specifying which fields to include in a partial response.
3605
+ # @param [String] quota_user
3606
+ # Available to use for quota purposes for server-side applications. Can be any
3607
+ # arbitrary string assigned to a user, but should not exceed 40 characters.
3608
+ # Overrides userIp if both are provided.
3609
+ # @param [String] user_ip
3610
+ # IP address of the site where the request originates. Use this if you want to
3611
+ # enforce per-user limits.
3612
+ # @param [Google::Apis::RequestOptions] options
3613
+ # Request-specific options
3614
+ #
3615
+ # @yield [result, err] Result & error if block supplied
3616
+ # @yieldparam result [NilClass] No result returned for this method
3617
+ # @yieldparam err [StandardError] error object if request failed
3618
+ #
3619
+ # @return [void]
3620
+ #
3621
+ # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
3622
+ # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
3623
+ # @raise [Google::Apis::AuthorizationError] Authorization is required
3624
+ def delete_user_photo(user_key, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block)
3625
+ command = make_simple_command(:delete, 'users/{userKey}/photos/thumbnail', options)
3626
+ command.params['userKey'] = user_key unless user_key.nil?
3627
+ command.query['fields'] = fields unless fields.nil?
3628
+ command.query['quotaUser'] = quota_user unless quota_user.nil?
3629
+ command.query['userIp'] = user_ip unless user_ip.nil?
3630
+ execute_or_queue_command(command, &block)
3631
+ end
3632
+
3633
+ # Retrieve photo of a user
3634
+ # @param [String] user_key
3635
+ # Email or immutable Id of the user
3636
+ # @param [String] fields
3637
+ # Selector specifying which fields to include in a partial response.
3638
+ # @param [String] quota_user
3639
+ # Available to use for quota purposes for server-side applications. Can be any
3640
+ # arbitrary string assigned to a user, but should not exceed 40 characters.
3641
+ # Overrides userIp if both are provided.
3642
+ # @param [String] user_ip
3643
+ # IP address of the site where the request originates. Use this if you want to
3644
+ # enforce per-user limits.
3645
+ # @param [Google::Apis::RequestOptions] options
3646
+ # Request-specific options
3647
+ #
3648
+ # @yield [result, err] Result & error if block supplied
3649
+ # @yieldparam result [Google::Apis::AdminDirectoryV1::UserPhoto] parsed result object
3650
+ # @yieldparam err [StandardError] error object if request failed
3651
+ #
3652
+ # @return [Google::Apis::AdminDirectoryV1::UserPhoto]
3653
+ #
3654
+ # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
3655
+ # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
3656
+ # @raise [Google::Apis::AuthorizationError] Authorization is required
3657
+ def get_user_photo(user_key, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block)
3658
+ command = make_simple_command(:get, 'users/{userKey}/photos/thumbnail', options)
3659
+ command.response_representation = Google::Apis::AdminDirectoryV1::UserPhoto::Representation
3660
+ command.response_class = Google::Apis::AdminDirectoryV1::UserPhoto
3661
+ command.params['userKey'] = user_key unless user_key.nil?
3662
+ command.query['fields'] = fields unless fields.nil?
3663
+ command.query['quotaUser'] = quota_user unless quota_user.nil?
3664
+ command.query['userIp'] = user_ip unless user_ip.nil?
3665
+ execute_or_queue_command(command, &block)
3666
+ end
3667
+
3668
+ # Add a photo for the user. This method supports patch semantics.
3669
+ # @param [String] user_key
3670
+ # Email or immutable Id of the user
3671
+ # @param [Google::Apis::AdminDirectoryV1::UserPhoto] user_photo_object
3672
+ # @param [String] fields
3673
+ # Selector specifying which fields to include in a partial response.
3674
+ # @param [String] quota_user
3675
+ # Available to use for quota purposes for server-side applications. Can be any
3676
+ # arbitrary string assigned to a user, but should not exceed 40 characters.
3677
+ # Overrides userIp if both are provided.
3678
+ # @param [String] user_ip
3679
+ # IP address of the site where the request originates. Use this if you want to
3680
+ # enforce per-user limits.
3681
+ # @param [Google::Apis::RequestOptions] options
3682
+ # Request-specific options
3683
+ #
3684
+ # @yield [result, err] Result & error if block supplied
3685
+ # @yieldparam result [Google::Apis::AdminDirectoryV1::UserPhoto] parsed result object
3686
+ # @yieldparam err [StandardError] error object if request failed
3687
+ #
3688
+ # @return [Google::Apis::AdminDirectoryV1::UserPhoto]
3689
+ #
3690
+ # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
3691
+ # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
3692
+ # @raise [Google::Apis::AuthorizationError] Authorization is required
3693
+ def patch_user_photo(user_key, user_photo_object = nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block)
3694
+ command = make_simple_command(:patch, 'users/{userKey}/photos/thumbnail', options)
3695
+ command.request_representation = Google::Apis::AdminDirectoryV1::UserPhoto::Representation
3696
+ command.request_object = user_photo_object
3697
+ command.response_representation = Google::Apis::AdminDirectoryV1::UserPhoto::Representation
3698
+ command.response_class = Google::Apis::AdminDirectoryV1::UserPhoto
3699
+ command.params['userKey'] = user_key unless user_key.nil?
3700
+ command.query['fields'] = fields unless fields.nil?
3701
+ command.query['quotaUser'] = quota_user unless quota_user.nil?
3702
+ command.query['userIp'] = user_ip unless user_ip.nil?
3703
+ execute_or_queue_command(command, &block)
3704
+ end
3705
+
3706
+ # Add a photo for the user
3707
+ # @param [String] user_key
3708
+ # Email or immutable Id of the user
3709
+ # @param [Google::Apis::AdminDirectoryV1::UserPhoto] user_photo_object
3710
+ # @param [String] fields
3711
+ # Selector specifying which fields to include in a partial response.
3712
+ # @param [String] quota_user
3713
+ # Available to use for quota purposes for server-side applications. Can be any
3714
+ # arbitrary string assigned to a user, but should not exceed 40 characters.
3715
+ # Overrides userIp if both are provided.
3716
+ # @param [String] user_ip
3717
+ # IP address of the site where the request originates. Use this if you want to
3718
+ # enforce per-user limits.
3719
+ # @param [Google::Apis::RequestOptions] options
3720
+ # Request-specific options
3721
+ #
3722
+ # @yield [result, err] Result & error if block supplied
3723
+ # @yieldparam result [Google::Apis::AdminDirectoryV1::UserPhoto] parsed result object
3724
+ # @yieldparam err [StandardError] error object if request failed
3725
+ #
3726
+ # @return [Google::Apis::AdminDirectoryV1::UserPhoto]
3727
+ #
3728
+ # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
3729
+ # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
3730
+ # @raise [Google::Apis::AuthorizationError] Authorization is required
3731
+ def update_user_photo(user_key, user_photo_object = nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block)
3732
+ command = make_simple_command(:put, 'users/{userKey}/photos/thumbnail', options)
3733
+ command.request_representation = Google::Apis::AdminDirectoryV1::UserPhoto::Representation
3734
+ command.request_object = user_photo_object
3735
+ command.response_representation = Google::Apis::AdminDirectoryV1::UserPhoto::Representation
3736
+ command.response_class = Google::Apis::AdminDirectoryV1::UserPhoto
3737
+ command.params['userKey'] = user_key unless user_key.nil?
3738
+ command.query['fields'] = fields unless fields.nil?
3739
+ command.query['quotaUser'] = quota_user unless quota_user.nil?
3740
+ command.query['userIp'] = user_ip unless user_ip.nil?
3741
+ execute_or_queue_command(command, &block)
3742
+ end
3743
+
3744
+ # Generate new backup verification codes for the user.
3745
+ # @param [String] user_key
3746
+ # Email or immutable Id of the user
3747
+ # @param [String] fields
3748
+ # Selector specifying which fields to include in a partial response.
3749
+ # @param [String] quota_user
3750
+ # Available to use for quota purposes for server-side applications. Can be any
3751
+ # arbitrary string assigned to a user, but should not exceed 40 characters.
3752
+ # Overrides userIp if both are provided.
3753
+ # @param [String] user_ip
3754
+ # IP address of the site where the request originates. Use this if you want to
3755
+ # enforce per-user limits.
3756
+ # @param [Google::Apis::RequestOptions] options
3757
+ # Request-specific options
3758
+ #
3759
+ # @yield [result, err] Result & error if block supplied
3760
+ # @yieldparam result [NilClass] No result returned for this method
3761
+ # @yieldparam err [StandardError] error object if request failed
3762
+ #
3763
+ # @return [void]
3764
+ #
3765
+ # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
3766
+ # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
3767
+ # @raise [Google::Apis::AuthorizationError] Authorization is required
3768
+ def generate_verification_code(user_key, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block)
3769
+ command = make_simple_command(:post, 'users/{userKey}/verificationCodes/generate', options)
3770
+ command.params['userKey'] = user_key unless user_key.nil?
3771
+ command.query['fields'] = fields unless fields.nil?
3772
+ command.query['quotaUser'] = quota_user unless quota_user.nil?
3773
+ command.query['userIp'] = user_ip unless user_ip.nil?
3774
+ execute_or_queue_command(command, &block)
3775
+ end
3776
+
3777
+ # Invalidate the current backup verification codes for the user.
3778
+ # @param [String] user_key
3779
+ # Email or immutable Id of the user
3780
+ # @param [String] fields
3781
+ # Selector specifying which fields to include in a partial response.
3782
+ # @param [String] quota_user
3783
+ # Available to use for quota purposes for server-side applications. Can be any
3784
+ # arbitrary string assigned to a user, but should not exceed 40 characters.
3785
+ # Overrides userIp if both are provided.
3786
+ # @param [String] user_ip
3787
+ # IP address of the site where the request originates. Use this if you want to
3788
+ # enforce per-user limits.
3789
+ # @param [Google::Apis::RequestOptions] options
3790
+ # Request-specific options
3791
+ #
3792
+ # @yield [result, err] Result & error if block supplied
3793
+ # @yieldparam result [NilClass] No result returned for this method
3794
+ # @yieldparam err [StandardError] error object if request failed
3795
+ #
3796
+ # @return [void]
3797
+ #
3798
+ # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
3799
+ # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
3800
+ # @raise [Google::Apis::AuthorizationError] Authorization is required
3801
+ def invalidate_verification_code(user_key, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block)
3802
+ command = make_simple_command(:post, 'users/{userKey}/verificationCodes/invalidate', options)
3803
+ command.params['userKey'] = user_key unless user_key.nil?
3804
+ command.query['fields'] = fields unless fields.nil?
3805
+ command.query['quotaUser'] = quota_user unless quota_user.nil?
3806
+ command.query['userIp'] = user_ip unless user_ip.nil?
3807
+ execute_or_queue_command(command, &block)
3808
+ end
3809
+
3810
+ # Returns the current set of valid backup verification codes for the specified
3811
+ # user.
3812
+ # @param [String] user_key
3813
+ # Identifies the user in the API request. The value can be the user's primary
3814
+ # email address, alias email address, or unique user ID.
3815
+ # @param [String] fields
3816
+ # Selector specifying which fields to include in a partial response.
3817
+ # @param [String] quota_user
3818
+ # Available to use for quota purposes for server-side applications. Can be any
3819
+ # arbitrary string assigned to a user, but should not exceed 40 characters.
3820
+ # Overrides userIp if both are provided.
3821
+ # @param [String] user_ip
3822
+ # IP address of the site where the request originates. Use this if you want to
3823
+ # enforce per-user limits.
3824
+ # @param [Google::Apis::RequestOptions] options
3825
+ # Request-specific options
3826
+ #
3827
+ # @yield [result, err] Result & error if block supplied
3828
+ # @yieldparam result [Google::Apis::AdminDirectoryV1::VerificationCodes] parsed result object
3829
+ # @yieldparam err [StandardError] error object if request failed
3830
+ #
3831
+ # @return [Google::Apis::AdminDirectoryV1::VerificationCodes]
3832
+ #
3833
+ # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
3834
+ # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
3835
+ # @raise [Google::Apis::AuthorizationError] Authorization is required
3836
+ def list_verification_codes(user_key, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block)
3837
+ command = make_simple_command(:get, 'users/{userKey}/verificationCodes', options)
3838
+ command.response_representation = Google::Apis::AdminDirectoryV1::VerificationCodes::Representation
3839
+ command.response_class = Google::Apis::AdminDirectoryV1::VerificationCodes
3840
+ command.params['userKey'] = user_key unless user_key.nil?
3841
+ command.query['fields'] = fields unless fields.nil?
3842
+ command.query['quotaUser'] = quota_user unless quota_user.nil?
3843
+ command.query['userIp'] = user_ip unless user_ip.nil?
3844
+ execute_or_queue_command(command, &block)
3845
+ end
3846
+
3847
+ protected
3848
+
3849
+ def apply_command_defaults(command)
3850
+ command.query['key'] = key unless key.nil?
3851
+ command.query['quotaUser'] = quota_user unless quota_user.nil?
3852
+ command.query['userIp'] = user_ip unless user_ip.nil?
3853
+ end
3854
+ end
3855
+ end
3856
+ end
3857
+ end