google-api-client 0.8.7 → 0.9.pre1

Sign up to get free protection for your applications and to get access to all the features.
Files changed (397) hide show
  1. checksums.yaml +4 -4
  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 +21 -0
  7. data/.yardopts +12 -0
  8. data/CHANGELOG.md +6 -3
  9. data/CONTRIBUTING.md +31 -0
  10. data/Gemfile +28 -2
  11. data/MIGRATING.md +171 -0
  12. data/README.md +158 -150
  13. data/Rakefile +1 -40
  14. data/api_names.yaml +872 -0
  15. data/api_names_out.yaml +20843 -0
  16. data/bin/generate-api +93 -0
  17. data/generated/google/apis/adexchangebuyer_v1_3.rb +35 -0
  18. data/generated/google/apis/adexchangebuyer_v1_3/classes.rb +1124 -0
  19. data/generated/google/apis/adexchangebuyer_v1_3/representations.rb +375 -0
  20. data/generated/google/apis/adexchangebuyer_v1_3/service.rb +893 -0
  21. data/generated/google/apis/adexchangeseller_v2_0.rb +38 -0
  22. data/generated/google/apis/adexchangeseller_v2_0/classes.rb +792 -0
  23. data/generated/google/apis/adexchangeseller_v2_0/representations.rb +309 -0
  24. data/generated/google/apis/adexchangeseller_v2_0/service.rb +682 -0
  25. data/generated/google/apis/admin_directory_v1.rb +89 -0
  26. data/generated/google/apis/admin_directory_v1/classes.rb +2389 -0
  27. data/generated/google/apis/admin_directory_v1/representations.rb +780 -0
  28. data/generated/google/apis/admin_directory_v1/service.rb +2805 -0
  29. data/generated/google/apis/admin_reports_v1.rb +38 -0
  30. data/generated/google/apis/admin_reports_v1/classes.rb +582 -0
  31. data/generated/google/apis/admin_reports_v1/representations.rb +231 -0
  32. data/generated/google/apis/admin_reports_v1/service.rb +341 -0
  33. data/generated/google/apis/adsense_v1_4.rb +38 -0
  34. data/generated/google/apis/adsense_v1_4/classes.rb +1279 -0
  35. data/generated/google/apis/adsense_v1_4/representations.rb +493 -0
  36. data/generated/google/apis/adsense_v1_4/service.rb +1752 -0
  37. data/generated/google/apis/adsensehost_v4_1.rb +35 -0
  38. data/generated/google/apis/adsensehost_v4_1/classes.rb +834 -0
  39. data/generated/google/apis/adsensehost_v4_1/representations.rb +327 -0
  40. data/generated/google/apis/adsensehost_v4_1/service.rb +1190 -0
  41. data/generated/google/apis/analytics_v3.rb +49 -0
  42. data/generated/google/apis/analytics_v3/classes.rb +5113 -0
  43. data/generated/google/apis/analytics_v3/representations.rb +1661 -0
  44. data/generated/google/apis/analytics_v3/service.rb +3600 -0
  45. data/generated/google/apis/androidenterprise_v1.rb +34 -0
  46. data/generated/google/apis/androidenterprise_v1/classes.rb +1162 -0
  47. data/generated/google/apis/androidenterprise_v1/representations.rb +431 -0
  48. data/generated/google/apis/androidenterprise_v1/service.rb +1979 -0
  49. data/generated/google/apis/androidpublisher_v2.rb +34 -0
  50. data/generated/google/apis/androidpublisher_v2/classes.rb +1374 -0
  51. data/generated/google/apis/androidpublisher_v2/representations.rb +630 -0
  52. data/generated/google/apis/androidpublisher_v2/service.rb +2390 -0
  53. data/generated/google/apis/appsactivity_v1.rb +46 -0
  54. data/generated/google/apis/appsactivity_v1/classes.rb +392 -0
  55. data/generated/google/apis/appsactivity_v1/representations.rb +184 -0
  56. data/generated/google/apis/appsactivity_v1/service.rb +129 -0
  57. data/generated/google/apis/appstate_v1.rb +34 -0
  58. data/generated/google/apis/appstate_v1/classes.rb +154 -0
  59. data/generated/google/apis/appstate_v1/representations.rb +79 -0
  60. data/generated/google/apis/appstate_v1/service.rb +265 -0
  61. data/generated/google/apis/autoscaler_v1beta2.rb +38 -0
  62. data/generated/google/apis/autoscaler_v1beta2/classes.rb +747 -0
  63. data/generated/google/apis/autoscaler_v1beta2/representations.rb +281 -0
  64. data/generated/google/apis/autoscaler_v1beta2/service.rb +488 -0
  65. data/generated/google/apis/bigquery_v2.rb +49 -0
  66. data/generated/google/apis/bigquery_v2/classes.rb +2255 -0
  67. data/generated/google/apis/bigquery_v2/representations.rb +754 -0
  68. data/generated/google/apis/bigquery_v2/service.rb +1003 -0
  69. data/generated/google/apis/blogger_v3.rb +37 -0
  70. data/generated/google/apis/blogger_v3/classes.rb +1354 -0
  71. data/generated/google/apis/blogger_v3/representations.rb +562 -0
  72. data/generated/google/apis/blogger_v3/service.rb +1620 -0
  73. data/generated/google/apis/books_v1.rb +34 -0
  74. data/generated/google/apis/books_v1/classes.rb +3515 -0
  75. data/generated/google/apis/books_v1/representations.rb +1361 -0
  76. data/generated/google/apis/books_v1/service.rb +2170 -0
  77. data/generated/google/apis/calendar_v3.rb +37 -0
  78. data/generated/google/apis/calendar_v3/classes.rb +1702 -0
  79. data/generated/google/apis/calendar_v3/representations.rb +566 -0
  80. data/generated/google/apis/calendar_v3/service.rb +1943 -0
  81. data/generated/google/apis/civicinfo_v2.rb +31 -0
  82. data/generated/google/apis/civicinfo_v2/classes.rb +1057 -0
  83. data/generated/google/apis/civicinfo_v2/representations.rb +374 -0
  84. data/generated/google/apis/civicinfo_v2/service.rb +284 -0
  85. data/generated/google/apis/cloudmonitoring_v2beta2.rb +34 -0
  86. data/generated/google/apis/cloudmonitoring_v2beta2/classes.rb +679 -0
  87. data/generated/google/apis/cloudmonitoring_v2beta2/representations.rb +311 -0
  88. data/generated/google/apis/cloudmonitoring_v2beta2/service.rb +458 -0
  89. data/generated/google/apis/cloudresourcemanager_v1beta1.rb +38 -0
  90. data/generated/google/apis/cloudresourcemanager_v1beta1/classes.rb +139 -0
  91. data/generated/google/apis/cloudresourcemanager_v1beta1/representations.rb +65 -0
  92. data/generated/google/apis/cloudresourcemanager_v1beta1/service.rb +301 -0
  93. data/generated/google/apis/compute_v1.rb +49 -0
  94. data/generated/google/apis/compute_v1/classes.rb +6391 -0
  95. data/generated/google/apis/compute_v1/representations.rb +2209 -0
  96. data/generated/google/apis/compute_v1/service.rb +6352 -0
  97. data/generated/google/apis/container_v1beta1.rb +35 -0
  98. data/generated/google/apis/container_v1beta1/classes.rb +466 -0
  99. data/generated/google/apis/container_v1beta1/representations.rb +177 -0
  100. data/generated/google/apis/container_v1beta1/service.rb +394 -0
  101. data/generated/google/apis/content_v2.rb +35 -0
  102. data/generated/google/apis/content_v2/classes.rb +3780 -0
  103. data/generated/google/apis/content_v2/representations.rb +1456 -0
  104. data/generated/google/apis/content_v2/service.rb +1706 -0
  105. data/generated/google/apis/coordinate_v1.rb +37 -0
  106. data/generated/google/apis/coordinate_v1/classes.rb +669 -0
  107. data/generated/google/apis/coordinate_v1/representations.rb +285 -0
  108. data/generated/google/apis/coordinate_v1/service.rb +687 -0
  109. data/{lib/google/api_client/auth/compute_service_account.rb → generated/google/apis/customsearch_v1.rb} +13 -10
  110. data/generated/google/apis/customsearch_v1/classes.rb +771 -0
  111. data/generated/google/apis/customsearch_v1/representations.rb +276 -0
  112. data/generated/google/apis/customsearch_v1/service.rb +208 -0
  113. data/generated/google/apis/datastore_v1beta2.rb +40 -0
  114. data/generated/google/apis/datastore_v1beta2/classes.rb +1186 -0
  115. data/generated/google/apis/datastore_v1beta2/representations.rb +526 -0
  116. data/generated/google/apis/datastore_v1beta2/service.rb +300 -0
  117. data/generated/google/apis/deploymentmanager_v2beta2.rb +41 -0
  118. data/generated/google/apis/deploymentmanager_v2beta2/classes.rb +820 -0
  119. data/generated/google/apis/deploymentmanager_v2beta2/representations.rb +303 -0
  120. data/generated/google/apis/deploymentmanager_v2beta2/service.rb +647 -0
  121. data/generated/google/apis/dfareporting_v2_1.rb +37 -0
  122. data/generated/google/apis/dfareporting_v2_1/classes.rb +10755 -0
  123. data/generated/google/apis/dfareporting_v2_1/representations.rb +3438 -0
  124. data/generated/google/apis/dfareporting_v2_1/service.rb +8775 -0
  125. data/generated/google/apis/discovery_v1.rb +32 -0
  126. data/generated/google/apis/discovery_v1/classes.rb +947 -0
  127. data/generated/google/apis/discovery_v1/representations.rb +355 -0
  128. data/generated/google/apis/discovery_v1/service.rb +144 -0
  129. data/generated/google/apis/dns_v1.rb +41 -0
  130. data/generated/google/apis/dns_v1/classes.rb +406 -0
  131. data/generated/google/apis/dns_v1/representations.rb +151 -0
  132. data/generated/google/apis/dns_v1/service.rb +460 -0
  133. data/{spec/google/api_client/request_spec.rb → generated/google/apis/doubleclickbidmanager_v1.rb} +15 -13
  134. data/generated/google/apis/doubleclickbidmanager_v1/classes.rb +709 -0
  135. data/generated/google/apis/doubleclickbidmanager_v1/representations.rb +297 -0
  136. data/generated/google/apis/doubleclickbidmanager_v1/service.rb +349 -0
  137. data/generated/google/apis/doubleclicksearch_v2.rb +35 -0
  138. data/generated/google/apis/doubleclicksearch_v2/classes.rb +947 -0
  139. data/generated/google/apis/doubleclicksearch_v2/representations.rb +315 -0
  140. data/generated/google/apis/doubleclicksearch_v2/service.rb +490 -0
  141. data/generated/google/apis/drive_v2.rb +55 -0
  142. data/generated/google/apis/drive_v2/classes.rb +2519 -0
  143. data/generated/google/apis/drive_v2/representations.rb +781 -0
  144. data/generated/google/apis/drive_v2/service.rb +2685 -0
  145. data/generated/google/apis/fitness_v1.rb +49 -0
  146. data/generated/google/apis/fitness_v1/classes.rb +809 -0
  147. data/generated/google/apis/fitness_v1/representations.rb +295 -0
  148. data/generated/google/apis/fitness_v1/service.rb +684 -0
  149. data/generated/google/apis/fusiontables_v2.rb +37 -0
  150. data/generated/google/apis/fusiontables_v2/classes.rb +1048 -0
  151. data/generated/google/apis/fusiontables_v2/representations.rb +409 -0
  152. data/generated/google/apis/fusiontables_v2/service.rb +1496 -0
  153. data/generated/google/apis/games_configuration_v1configuration.rb +34 -0
  154. data/generated/google/apis/games_configuration_v1configuration/classes.rb +506 -0
  155. data/generated/google/apis/games_configuration_v1configuration/representations.rb +206 -0
  156. data/generated/google/apis/games_configuration_v1configuration/service.rb +578 -0
  157. data/generated/google/apis/games_v1.rb +40 -0
  158. data/generated/google/apis/games_v1/classes.rb +4578 -0
  159. data/generated/google/apis/games_v1/representations.rb +1570 -0
  160. data/generated/google/apis/games_v1/service.rb +2306 -0
  161. data/generated/google/apis/gan_v1beta1.rb +31 -0
  162. data/generated/google/apis/gan_v1beta1/classes.rb +1428 -0
  163. data/generated/google/apis/gan_v1beta1/representations.rb +428 -0
  164. data/generated/google/apis/gan_v1beta1/service.rb +692 -0
  165. data/generated/google/apis/genomics_v1beta2.rb +46 -0
  166. data/generated/google/apis/genomics_v1beta2/classes.rb +3288 -0
  167. data/generated/google/apis/genomics_v1beta2/representations.rb +1194 -0
  168. data/generated/google/apis/genomics_v1beta2/service.rb +2356 -0
  169. data/generated/google/apis/gmail_v1.rb +49 -0
  170. data/generated/google/apis/gmail_v1/classes.rb +794 -0
  171. data/generated/google/apis/gmail_v1/representations.rb +339 -0
  172. data/generated/google/apis/gmail_v1/service.rb +1502 -0
  173. data/generated/google/apis/groupsmigration_v1.rb +34 -0
  174. data/generated/google/apis/groupsmigration_v1/classes.rb +51 -0
  175. data/generated/google/apis/groupsmigration_v1/representations.rb +38 -0
  176. data/generated/google/apis/groupsmigration_v1/service.rb +111 -0
  177. data/generated/google/apis/groupssettings_v1.rb +34 -0
  178. data/generated/google/apis/groupssettings_v1/classes.rb +221 -0
  179. data/generated/google/apis/groupssettings_v1/representations.rb +64 -0
  180. data/generated/google/apis/groupssettings_v1/service.rb +179 -0
  181. data/generated/google/apis/identitytoolkit_v3.rb +31 -0
  182. data/generated/google/apis/identitytoolkit_v3/classes.rb +1229 -0
  183. data/generated/google/apis/identitytoolkit_v3/representations.rb +422 -0
  184. data/generated/google/apis/identitytoolkit_v3/service.rb +491 -0
  185. data/generated/google/apis/licensing_v1.rb +34 -0
  186. data/generated/google/apis/licensing_v1/classes.rb +132 -0
  187. data/generated/google/apis/licensing_v1/representations.rb +68 -0
  188. data/generated/google/apis/licensing_v1/service.rb +376 -0
  189. data/generated/google/apis/logging_v1beta3.rb +35 -0
  190. data/generated/google/apis/logging_v1beta3/classes.rb +505 -0
  191. data/generated/google/apis/logging_v1beta3/representations.rb +222 -0
  192. data/generated/google/apis/logging_v1beta3/service.rb +670 -0
  193. data/generated/google/apis/manager_v1beta2.rb +50 -0
  194. data/generated/google/apis/manager_v1beta2/classes.rb +1287 -0
  195. data/generated/google/apis/manager_v1beta2/representations.rb +536 -0
  196. data/generated/google/apis/manager_v1beta2/service.rb +380 -0
  197. data/generated/google/apis/mapsengine_v1.rb +38 -0
  198. data/generated/google/apis/mapsengine_v1/classes.rb +2873 -0
  199. data/generated/google/apis/mapsengine_v1/representations.rb +1235 -0
  200. data/generated/google/apis/mapsengine_v1/service.rb +3465 -0
  201. data/generated/google/apis/mirror_v1.rb +37 -0
  202. data/generated/google/apis/mirror_v1/classes.rb +1072 -0
  203. data/generated/google/apis/mirror_v1/representations.rb +350 -0
  204. data/generated/google/apis/mirror_v1/service.rb +1001 -0
  205. data/generated/google/apis/oauth2_v2.rb +43 -0
  206. data/generated/google/apis/oauth2_v2/classes.rb +245 -0
  207. data/generated/google/apis/oauth2_v2/representations.rb +94 -0
  208. data/generated/google/apis/oauth2_v2/service.rb +203 -0
  209. data/generated/google/apis/pagespeedonline_v2.rb +32 -0
  210. data/generated/google/apis/pagespeedonline_v2/classes.rb +614 -0
  211. data/generated/google/apis/pagespeedonline_v2/representations.rb +244 -0
  212. data/generated/google/apis/pagespeedonline_v2/service.rb +120 -0
  213. data/generated/google/apis/plus_domains_v1.rb +61 -0
  214. data/generated/google/apis/plus_domains_v1/classes.rb +2402 -0
  215. data/generated/google/apis/plus_domains_v1/representations.rb +873 -0
  216. data/generated/google/apis/plus_domains_v1/service.rb +924 -0
  217. data/generated/google/apis/plus_v1.rb +43 -0
  218. data/generated/google/apis/plus_v1/classes.rb +2384 -0
  219. data/generated/google/apis/plus_v1/representations.rb +812 -0
  220. data/generated/google/apis/plus_v1/service.rb +616 -0
  221. data/generated/google/apis/prediction_v1_6.rb +44 -0
  222. data/generated/google/apis/prediction_v1_6/classes.rb +751 -0
  223. data/generated/google/apis/prediction_v1_6/representations.rb +327 -0
  224. data/generated/google/apis/prediction_v1_6/service.rb +388 -0
  225. data/generated/google/apis/pubsub_v1beta2.rb +37 -0
  226. data/generated/google/apis/pubsub_v1beta2/classes.rb +824 -0
  227. data/generated/google/apis/pubsub_v1beta2/representations.rb +366 -0
  228. data/generated/google/apis/pubsub_v1beta2/service.rb +778 -0
  229. data/generated/google/apis/qpx_express_v1.rb +31 -0
  230. data/generated/google/apis/qpx_express_v1/classes.rb +1268 -0
  231. data/generated/google/apis/qpx_express_v1/representations.rb +424 -0
  232. data/generated/google/apis/qpx_express_v1/service.rb +101 -0
  233. data/generated/google/apis/replicapool_v1beta2.rb +41 -0
  234. data/generated/google/apis/replicapool_v1beta2/classes.rb +621 -0
  235. data/generated/google/apis/replicapool_v1beta2/representations.rb +235 -0
  236. data/generated/google/apis/replicapool_v1beta2/service.rb +620 -0
  237. data/generated/google/apis/replicapoolupdater_v1beta1.rb +41 -0
  238. data/generated/google/apis/replicapoolupdater_v1beta1/classes.rb +682 -0
  239. data/generated/google/apis/replicapoolupdater_v1beta1/representations.rb +247 -0
  240. data/generated/google/apis/replicapoolupdater_v1beta1/service.rb +472 -0
  241. data/generated/google/apis/reseller_v1.rb +37 -0
  242. data/generated/google/apis/reseller_v1/classes.rb +502 -0
  243. data/generated/google/apis/reseller_v1/representations.rb +199 -0
  244. data/generated/google/apis/reseller_v1/service.rb +637 -0
  245. data/generated/google/apis/resourceviews_v1beta2.rb +47 -0
  246. data/generated/google/apis/resourceviews_v1beta2/classes.rb +660 -0
  247. data/generated/google/apis/resourceviews_v1beta2/representations.rb +269 -0
  248. data/generated/google/apis/resourceviews_v1beta2/service.rb +574 -0
  249. data/generated/google/apis/site_verification_v1.rb +37 -0
  250. data/generated/google/apis/site_verification_v1/classes.rb +185 -0
  251. data/generated/google/apis/site_verification_v1/representations.rb +101 -0
  252. data/generated/google/apis/site_verification_v1/service.rb +322 -0
  253. data/generated/google/apis/sqladmin_v1beta4.rb +37 -0
  254. data/generated/google/apis/sqladmin_v1beta4/classes.rb +1817 -0
  255. data/generated/google/apis/sqladmin_v1beta4/representations.rb +688 -0
  256. data/generated/google/apis/sqladmin_v1beta4/service.rb +1534 -0
  257. data/generated/google/apis/storage_v1.rb +43 -0
  258. data/generated/google/apis/storage_v1/classes.rb +1177 -0
  259. data/generated/google/apis/storage_v1/representations.rb +427 -0
  260. data/generated/google/apis/storage_v1/service.rb +1920 -0
  261. data/generated/google/apis/tagmanager_v1.rb +52 -0
  262. data/generated/google/apis/tagmanager_v1/classes.rb +1226 -0
  263. data/generated/google/apis/tagmanager_v1/representations.rb +461 -0
  264. data/generated/google/apis/tagmanager_v1/service.rb +1978 -0
  265. data/generated/google/apis/taskqueue_v1beta2.rb +37 -0
  266. data/generated/google/apis/taskqueue_v1beta2/classes.rb +254 -0
  267. data/generated/google/apis/taskqueue_v1beta2/representations.rb +114 -0
  268. data/generated/google/apis/taskqueue_v1beta2/service.rb +416 -0
  269. data/generated/google/apis/tasks_v1.rb +37 -0
  270. data/generated/google/apis/tasks_v1/classes.rb +296 -0
  271. data/generated/google/apis/tasks_v1/representations.rb +115 -0
  272. data/generated/google/apis/tasks_v1/service.rb +657 -0
  273. data/generated/google/apis/translate_v2.rb +31 -0
  274. data/generated/google/apis/translate_v2/classes.rb +168 -0
  275. data/generated/google/apis/translate_v2/representations.rb +109 -0
  276. data/generated/google/apis/translate_v2/service.rb +185 -0
  277. data/generated/google/apis/urlshortener_v1.rb +34 -0
  278. data/generated/google/apis/urlshortener_v1/classes.rb +246 -0
  279. data/generated/google/apis/urlshortener_v1/representations.rb +111 -0
  280. data/generated/google/apis/urlshortener_v1/service.rb +179 -0
  281. data/generated/google/apis/webmasters_v3.rb +37 -0
  282. data/generated/google/apis/webmasters_v3/classes.rb +563 -0
  283. data/generated/google/apis/webmasters_v3/representations.rb +250 -0
  284. data/generated/google/apis/webmasters_v3/service.rb +587 -0
  285. data/generated/google/apis/youtube_analytics_v1.rb +46 -0
  286. data/generated/google/apis/youtube_analytics_v1/classes.rb +540 -0
  287. data/generated/google/apis/youtube_analytics_v1/representations.rb +242 -0
  288. data/generated/google/apis/youtube_analytics_v1/service.rb +567 -0
  289. data/generated/google/apis/youtube_v3.rb +49 -0
  290. data/generated/google/apis/youtube_v3/classes.rb +7225 -0
  291. data/generated/google/apis/youtube_v3/representations.rb +2529 -0
  292. data/generated/google/apis/youtube_v3/service.rb +4051 -0
  293. data/google-api-client.gemspec +27 -39
  294. data/lib/google/api_client/auth/storage.rb +3 -2
  295. data/lib/google/api_client/auth/storages/file_store.rb +1 -3
  296. data/lib/google/api_client/auth/storages/redis_store.rb +6 -2
  297. data/lib/google/apis.rb +48 -0
  298. data/lib/google/apis/core/api_command.rb +128 -0
  299. data/lib/google/apis/core/base_service.rb +314 -0
  300. data/lib/google/apis/core/batch.rb +222 -0
  301. data/lib/google/apis/core/download.rb +94 -0
  302. data/lib/google/apis/core/hashable.rb +44 -0
  303. data/lib/google/apis/core/http_command.rb +275 -0
  304. data/lib/google/apis/core/json_representation.rb +122 -0
  305. data/lib/google/{api_client/version.rb → apis/core/logging.rb} +12 -8
  306. data/lib/google/apis/core/multipart.rb +173 -0
  307. data/lib/google/apis/core/upload.rb +275 -0
  308. data/lib/google/{api_client → apis}/errors.rb +32 -28
  309. data/lib/google/apis/generator.rb +70 -0
  310. data/lib/google/apis/generator/annotator.rb +271 -0
  311. data/lib/google/apis/generator/helpers.rb +74 -0
  312. data/lib/google/apis/generator/model.rb +130 -0
  313. data/lib/google/apis/generator/template.rb +124 -0
  314. data/lib/google/apis/generator/templates/_class.tmpl +40 -0
  315. data/lib/google/apis/generator/templates/_method.tmpl +90 -0
  316. data/lib/google/apis/generator/templates/_representation.tmpl +51 -0
  317. data/lib/google/apis/generator/templates/_representation_stub.tmpl +15 -0
  318. data/lib/google/apis/generator/templates/_representation_type.tmpl +10 -0
  319. data/lib/google/{api_client/reference.rb → apis/generator/templates/classes.rb.tmpl} +11 -9
  320. data/lib/google/apis/generator/templates/module.rb.tmpl +40 -0
  321. data/lib/google/apis/generator/templates/representations.rb.tmpl +32 -0
  322. data/lib/google/apis/generator/templates/service.rb.tmpl +60 -0
  323. data/lib/google/apis/options.rb +79 -0
  324. data/lib/google/apis/version.rb +39 -0
  325. data/rakelib/metrics.rake +22 -0
  326. data/rakelib/rubocop.rake +10 -0
  327. data/rakelib/spec.rake +11 -0
  328. data/rakelib/yard.rake +11 -0
  329. data/samples/calendar/calendar.rb +43 -0
  330. data/samples/drive/drive.rb +40 -0
  331. data/samples/pubsub/pubsub.rb +52 -0
  332. data/{lib/google/api_client/discovery.rb → samples/translate/translate.rb} +14 -5
  333. data/script/generate +79 -0
  334. data/script/package +8 -0
  335. data/script/release +15 -0
  336. data/spec/fixtures/files/api_names.yaml +3 -0
  337. data/spec/fixtures/files/auth_stored_credentials.json +8 -0
  338. data/spec/fixtures/files/client_secrets.json +1 -0
  339. data/spec/fixtures/files/test.blah +1 -0
  340. data/spec/fixtures/files/test.txt +1 -0
  341. data/spec/fixtures/files/test_api.json +440 -0
  342. data/spec/google/api_client/auth/storage_spec.rb +1 -3
  343. data/spec/google/api_client/auth/storages/file_store_spec.rb +1 -2
  344. data/spec/google/api_client/auth/storages/redis_store_spec.rb +1 -3
  345. data/spec/google/apis/core/api_command_spec.rb +170 -0
  346. data/spec/google/apis/core/batch_spec.rb +128 -0
  347. data/spec/google/apis/core/download_spec.rb +90 -0
  348. data/spec/google/apis/core/hashable_spec.rb +60 -0
  349. data/spec/google/apis/core/http_command_spec.rb +238 -0
  350. data/spec/google/apis/core/json_representation_spec.rb +192 -0
  351. data/spec/google/apis/core/service_spec.rb +247 -0
  352. data/spec/google/apis/core/upload_spec.rb +238 -0
  353. data/{lib/google/api_client/service_account.rb → spec/google/apis/generated_spec.rb} +14 -8
  354. data/spec/google/apis/generator/generator_spec.rb +272 -0
  355. data/spec/google/apis/logging_spec.rb +45 -0
  356. data/spec/google/apis/options_spec.rb +40 -0
  357. data/spec/integration_tests/drive_spec.rb +35 -0
  358. data/spec/integration_tests/pubsub_spec.rb +48 -0
  359. data/spec/integration_tests/url_shortener_spec.rb +31 -0
  360. data/spec/spec_helper.rb +102 -46
  361. metadata +433 -178
  362. data/lib/compat/multi_json.rb +0 -19
  363. data/lib/google/api_client.rb +0 -750
  364. data/lib/google/api_client/auth/file_storage.rb +0 -59
  365. data/lib/google/api_client/auth/jwt_asserter.rb +0 -126
  366. data/lib/google/api_client/auth/key_utils.rb +0 -93
  367. data/lib/google/api_client/auth/pkcs12.rb +0 -41
  368. data/lib/google/api_client/batch.rb +0 -326
  369. data/lib/google/api_client/charset.rb +0 -33
  370. data/lib/google/api_client/discovery/api.rb +0 -310
  371. data/lib/google/api_client/discovery/media.rb +0 -77
  372. data/lib/google/api_client/discovery/method.rb +0 -363
  373. data/lib/google/api_client/discovery/resource.rb +0 -156
  374. data/lib/google/api_client/discovery/schema.rb +0 -117
  375. data/lib/google/api_client/environment.rb +0 -42
  376. data/lib/google/api_client/gzip.rb +0 -28
  377. data/lib/google/api_client/logging.rb +0 -32
  378. data/lib/google/api_client/media.rb +0 -259
  379. data/lib/google/api_client/railtie.rb +0 -18
  380. data/lib/google/api_client/request.rb +0 -350
  381. data/lib/google/api_client/result.rb +0 -255
  382. data/lib/google/api_client/service.rb +0 -233
  383. data/lib/google/api_client/service/batch.rb +0 -110
  384. data/lib/google/api_client/service/request.rb +0 -144
  385. data/lib/google/api_client/service/resource.rb +0 -40
  386. data/lib/google/api_client/service/result.rb +0 -162
  387. data/lib/google/api_client/service/simple_file_store.rb +0 -151
  388. data/lib/google/api_client/service/stub_generator.rb +0 -61
  389. data/spec/google/api_client/batch_spec.rb +0 -248
  390. data/spec/google/api_client/discovery_spec.rb +0 -708
  391. data/spec/google/api_client/gzip_spec.rb +0 -98
  392. data/spec/google/api_client/media_spec.rb +0 -178
  393. data/spec/google/api_client/result_spec.rb +0 -207
  394. data/spec/google/api_client/service_account_spec.rb +0 -169
  395. data/spec/google/api_client/service_spec.rb +0 -618
  396. data/spec/google/api_client/simple_file_store_spec.rb +0 -133
  397. data/spec/google/api_client_spec.rb +0 -352
@@ -0,0 +1,2170 @@
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 BooksV1
23
+ # Books API
24
+ #
25
+ # Lets you search for books and manage your Google Books library.
26
+ #
27
+ # @example
28
+ # require 'google/apis/books_v1'
29
+ #
30
+ # Books = Google::Apis::BooksV1 # Alias the module
31
+ # service = Books::BooksService.new
32
+ #
33
+ # @see https://developers.google.com/books/docs/v1/getting_started
34
+ class BooksService < Google::Apis::Core::BaseService
35
+ # @return [String]
36
+ # API key. Your API key identifies your project and provides you with API access,
37
+ # quota, and reports. Required unless you provide an OAuth 2.0 token.
38
+ attr_accessor :key
39
+
40
+ # @return [String]
41
+ # Available to use for quota purposes for server-side applications. Can be any
42
+ # arbitrary string assigned to a user, but should not exceed 40 characters.
43
+ # Overrides userIp if both are provided.
44
+ attr_accessor :quota_user
45
+
46
+ # @return [String]
47
+ # IP address of the site where the request originates. Use this if you want to
48
+ # enforce per-user limits.
49
+ attr_accessor :user_ip
50
+
51
+ def initialize
52
+ super('https://www.googleapis.com/', 'books/v1/')
53
+ end
54
+
55
+ # Retrieves metadata for a specific bookshelf for the specified user.
56
+ # @param [String] user_id
57
+ # ID of user for whom to retrieve bookshelves.
58
+ # @param [String] shelf
59
+ # ID of bookshelf to retrieve.
60
+ # @param [String] source
61
+ # String to identify the originator of this request.
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 [Google::Apis::BooksV1::Bookshelf] parsed result object
76
+ # @yieldparam err [StandardError] error object if request failed
77
+ #
78
+ # @return [Google::Apis::BooksV1::Bookshelf]
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 get_bookshelf(user_id, shelf, source: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block)
84
+ path = 'users/{userId}/bookshelves/{shelf}'
85
+ command = make_simple_command(:get, path, options)
86
+ command.response_representation = Google::Apis::BooksV1::Bookshelf::Representation
87
+ command.response_class = Google::Apis::BooksV1::Bookshelf
88
+ command.params['userId'] = user_id unless user_id.nil?
89
+ command.params['shelf'] = shelf unless shelf.nil?
90
+ command.query['source'] = source unless source.nil?
91
+ command.query['fields'] = fields unless fields.nil?
92
+ command.query['quotaUser'] = quota_user unless quota_user.nil?
93
+ command.query['userIp'] = user_ip unless user_ip.nil?
94
+ execute_or_queue_command(command, &block)
95
+ end
96
+
97
+ # Retrieves a list of public bookshelves for the specified user.
98
+ # @param [String] user_id
99
+ # ID of user for whom to retrieve bookshelves.
100
+ # @param [String] source
101
+ # String to identify the originator of this request.
102
+ # @param [String] fields
103
+ # Selector specifying which fields to include in a partial response.
104
+ # @param [String] quota_user
105
+ # Available to use for quota purposes for server-side applications. Can be any
106
+ # arbitrary string assigned to a user, but should not exceed 40 characters.
107
+ # Overrides userIp if both are provided.
108
+ # @param [String] user_ip
109
+ # IP address of the site where the request originates. Use this if you want to
110
+ # enforce per-user limits.
111
+ # @param [Google::Apis::RequestOptions] options
112
+ # Request-specific options
113
+ #
114
+ # @yield [result, err] Result & error if block supplied
115
+ # @yieldparam result [Google::Apis::BooksV1::Bookshelves] parsed result object
116
+ # @yieldparam err [StandardError] error object if request failed
117
+ #
118
+ # @return [Google::Apis::BooksV1::Bookshelves]
119
+ #
120
+ # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
121
+ # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
122
+ # @raise [Google::Apis::AuthorizationError] Authorization is required
123
+ def list_bookshelves(user_id, source: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block)
124
+ path = 'users/{userId}/bookshelves'
125
+ command = make_simple_command(:get, path, options)
126
+ command.response_representation = Google::Apis::BooksV1::Bookshelves::Representation
127
+ command.response_class = Google::Apis::BooksV1::Bookshelves
128
+ command.params['userId'] = user_id unless user_id.nil?
129
+ command.query['source'] = source unless source.nil?
130
+ command.query['fields'] = fields unless fields.nil?
131
+ command.query['quotaUser'] = quota_user unless quota_user.nil?
132
+ command.query['userIp'] = user_ip unless user_ip.nil?
133
+ execute_or_queue_command(command, &block)
134
+ end
135
+
136
+ # Retrieves volumes in a specific bookshelf for the specified user.
137
+ # @param [String] user_id
138
+ # ID of user for whom to retrieve bookshelf volumes.
139
+ # @param [String] shelf
140
+ # ID of bookshelf to retrieve volumes.
141
+ # @param [Fixnum] max_results
142
+ # Maximum number of results to return
143
+ # @param [Boolean] show_preorders
144
+ # Set to true to show pre-ordered books. Defaults to false.
145
+ # @param [String] source
146
+ # String to identify the originator of this request.
147
+ # @param [Fixnum] start_index
148
+ # Index of the first element to return (starts at 0)
149
+ # @param [String] fields
150
+ # Selector specifying which fields to include in a partial response.
151
+ # @param [String] quota_user
152
+ # Available to use for quota purposes for server-side applications. Can be any
153
+ # arbitrary string assigned to a user, but should not exceed 40 characters.
154
+ # Overrides userIp if both are provided.
155
+ # @param [String] user_ip
156
+ # IP address of the site where the request originates. Use this if you want to
157
+ # enforce per-user limits.
158
+ # @param [Google::Apis::RequestOptions] options
159
+ # Request-specific options
160
+ #
161
+ # @yield [result, err] Result & error if block supplied
162
+ # @yieldparam result [Google::Apis::BooksV1::Volumes] parsed result object
163
+ # @yieldparam err [StandardError] error object if request failed
164
+ #
165
+ # @return [Google::Apis::BooksV1::Volumes]
166
+ #
167
+ # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
168
+ # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
169
+ # @raise [Google::Apis::AuthorizationError] Authorization is required
170
+ def list_bookshelf_volumes(user_id, shelf, max_results: nil, show_preorders: nil, source: nil, start_index: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block)
171
+ path = 'users/{userId}/bookshelves/{shelf}/volumes'
172
+ command = make_simple_command(:get, path, options)
173
+ command.response_representation = Google::Apis::BooksV1::Volumes::Representation
174
+ command.response_class = Google::Apis::BooksV1::Volumes
175
+ command.params['userId'] = user_id unless user_id.nil?
176
+ command.params['shelf'] = shelf unless shelf.nil?
177
+ command.query['maxResults'] = max_results unless max_results.nil?
178
+ command.query['showPreorders'] = show_preorders unless show_preorders.nil?
179
+ command.query['source'] = source unless source.nil?
180
+ command.query['startIndex'] = start_index unless start_index.nil?
181
+ command.query['fields'] = fields unless fields.nil?
182
+ command.query['quotaUser'] = quota_user unless quota_user.nil?
183
+ command.query['userIp'] = user_ip unless user_ip.nil?
184
+ execute_or_queue_command(command, &block)
185
+ end
186
+
187
+ #
188
+ # @param [String] drive_document_id
189
+ # A drive document id. The upload_client_token must not be set.
190
+ # @param [String] mime_type
191
+ # The document MIME type. It can be set only if the drive_document_id is set.
192
+ # @param [String] name
193
+ # The document name. It can be set only if the drive_document_id is set.
194
+ # @param [String] upload_client_token
195
+ # @param [String] fields
196
+ # Selector specifying which fields to include in a partial response.
197
+ # @param [String] quota_user
198
+ # Available to use for quota purposes for server-side applications. Can be any
199
+ # arbitrary string assigned to a user, but should not exceed 40 characters.
200
+ # Overrides userIp if both are provided.
201
+ # @param [String] user_ip
202
+ # IP address of the site where the request originates. Use this if you want to
203
+ # enforce per-user limits.
204
+ # @param [Google::Apis::RequestOptions] options
205
+ # Request-specific options
206
+ #
207
+ # @yield [result, err] Result & error if block supplied
208
+ # @yieldparam result [Google::Apis::BooksV1::LoadingResource] parsed result object
209
+ # @yieldparam err [StandardError] error object if request failed
210
+ #
211
+ # @return [Google::Apis::BooksV1::LoadingResource]
212
+ #
213
+ # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
214
+ # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
215
+ # @raise [Google::Apis::AuthorizationError] Authorization is required
216
+ def add_book(drive_document_id: nil, mime_type: nil, name: nil, upload_client_token: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block)
217
+ path = 'cloudloading/addBook'
218
+ command = make_simple_command(:post, path, options)
219
+ command.response_representation = Google::Apis::BooksV1::LoadingResource::Representation
220
+ command.response_class = Google::Apis::BooksV1::LoadingResource
221
+ command.query['drive_document_id'] = drive_document_id unless drive_document_id.nil?
222
+ command.query['mime_type'] = mime_type unless mime_type.nil?
223
+ command.query['name'] = name unless name.nil?
224
+ command.query['upload_client_token'] = upload_client_token unless upload_client_token.nil?
225
+ command.query['fields'] = fields unless fields.nil?
226
+ command.query['quotaUser'] = quota_user unless quota_user.nil?
227
+ command.query['userIp'] = user_ip unless user_ip.nil?
228
+ execute_or_queue_command(command, &block)
229
+ end
230
+
231
+ # Remove the book and its contents
232
+ # @param [String] volume_id
233
+ # The id of the book to be removed.
234
+ # @param [String] fields
235
+ # Selector specifying which fields to include in a partial response.
236
+ # @param [String] quota_user
237
+ # Available to use for quota purposes for server-side applications. Can be any
238
+ # arbitrary string assigned to a user, but should not exceed 40 characters.
239
+ # Overrides userIp if both are provided.
240
+ # @param [String] user_ip
241
+ # IP address of the site where the request originates. Use this if you want to
242
+ # enforce per-user limits.
243
+ # @param [Google::Apis::RequestOptions] options
244
+ # Request-specific options
245
+ #
246
+ # @yield [result, err] Result & error if block supplied
247
+ # @yieldparam result [NilClass] No result returned for this method
248
+ # @yieldparam err [StandardError] error object if request failed
249
+ #
250
+ # @return [void]
251
+ #
252
+ # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
253
+ # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
254
+ # @raise [Google::Apis::AuthorizationError] Authorization is required
255
+ def delete_book(volume_id: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block)
256
+ path = 'cloudloading/deleteBook'
257
+ command = make_simple_command(:post, path, options)
258
+ command.query['volumeId'] = volume_id unless volume_id.nil?
259
+ command.query['fields'] = fields unless fields.nil?
260
+ command.query['quotaUser'] = quota_user unless quota_user.nil?
261
+ command.query['userIp'] = user_ip unless user_ip.nil?
262
+ execute_or_queue_command(command, &block)
263
+ end
264
+
265
+ #
266
+ # @param [Google::Apis::BooksV1::LoadingResource] loading_resource_object
267
+ # @param [String] fields
268
+ # Selector specifying which fields to include in a partial response.
269
+ # @param [String] quota_user
270
+ # Available to use for quota purposes for server-side applications. Can be any
271
+ # arbitrary string assigned to a user, but should not exceed 40 characters.
272
+ # Overrides userIp if both are provided.
273
+ # @param [String] user_ip
274
+ # IP address of the site where the request originates. Use this if you want to
275
+ # enforce per-user limits.
276
+ # @param [Google::Apis::RequestOptions] options
277
+ # Request-specific options
278
+ #
279
+ # @yield [result, err] Result & error if block supplied
280
+ # @yieldparam result [Google::Apis::BooksV1::LoadingResource] parsed result object
281
+ # @yieldparam err [StandardError] error object if request failed
282
+ #
283
+ # @return [Google::Apis::BooksV1::LoadingResource]
284
+ #
285
+ # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
286
+ # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
287
+ # @raise [Google::Apis::AuthorizationError] Authorization is required
288
+ def update_book(loading_resource_object = nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block)
289
+ path = 'cloudloading/updateBook'
290
+ command = make_simple_command(:post, path, options)
291
+ command.request_representation = Google::Apis::BooksV1::LoadingResource::Representation
292
+ command.request_object = loading_resource_object
293
+ command.response_representation = Google::Apis::BooksV1::LoadingResource::Representation
294
+ command.response_class = Google::Apis::BooksV1::LoadingResource
295
+ command.query['fields'] = fields unless fields.nil?
296
+ command.query['quotaUser'] = quota_user unless quota_user.nil?
297
+ command.query['userIp'] = user_ip unless user_ip.nil?
298
+ execute_or_queue_command(command, &block)
299
+ end
300
+
301
+ # Returns a list of offline dictionary meatadata available
302
+ # @param [String] cpksver
303
+ # The device/version ID from which to request the data.
304
+ # @param [String] fields
305
+ # Selector specifying which fields to include in a partial response.
306
+ # @param [String] quota_user
307
+ # Available to use for quota purposes for server-side applications. Can be any
308
+ # arbitrary string assigned to a user, but should not exceed 40 characters.
309
+ # Overrides userIp if both are provided.
310
+ # @param [String] user_ip
311
+ # IP address of the site where the request originates. Use this if you want to
312
+ # enforce per-user limits.
313
+ # @param [Google::Apis::RequestOptions] options
314
+ # Request-specific options
315
+ #
316
+ # @yield [result, err] Result & error if block supplied
317
+ # @yieldparam result [Google::Apis::BooksV1::Metadata] parsed result object
318
+ # @yieldparam err [StandardError] error object if request failed
319
+ #
320
+ # @return [Google::Apis::BooksV1::Metadata]
321
+ #
322
+ # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
323
+ # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
324
+ # @raise [Google::Apis::AuthorizationError] Authorization is required
325
+ def list_offline_metadata_dictionary(cpksver: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block)
326
+ path = 'dictionary/listOfflineMetadata'
327
+ command = make_simple_command(:get, path, options)
328
+ command.response_representation = Google::Apis::BooksV1::Metadata::Representation
329
+ command.response_class = Google::Apis::BooksV1::Metadata
330
+ command.query['cpksver'] = cpksver unless cpksver.nil?
331
+ command.query['fields'] = fields unless fields.nil?
332
+ command.query['quotaUser'] = quota_user unless quota_user.nil?
333
+ command.query['userIp'] = user_ip unless user_ip.nil?
334
+ execute_or_queue_command(command, &block)
335
+ end
336
+
337
+ # Gets the layer summary for a volume.
338
+ # @param [String] volume_id
339
+ # The volume to retrieve layers for.
340
+ # @param [String] summary_id
341
+ # The ID for the layer to get the summary for.
342
+ # @param [String] content_version
343
+ # The content version for the requested volume.
344
+ # @param [String] source
345
+ # String to identify the originator of this request.
346
+ # @param [String] fields
347
+ # Selector specifying which fields to include in a partial response.
348
+ # @param [String] quota_user
349
+ # Available to use for quota purposes for server-side applications. Can be any
350
+ # arbitrary string assigned to a user, but should not exceed 40 characters.
351
+ # Overrides userIp if both are provided.
352
+ # @param [String] user_ip
353
+ # IP address of the site where the request originates. Use this if you want to
354
+ # enforce per-user limits.
355
+ # @param [Google::Apis::RequestOptions] options
356
+ # Request-specific options
357
+ #
358
+ # @yield [result, err] Result & error if block supplied
359
+ # @yieldparam result [Google::Apis::BooksV1::LayerSummary] parsed result object
360
+ # @yieldparam err [StandardError] error object if request failed
361
+ #
362
+ # @return [Google::Apis::BooksV1::LayerSummary]
363
+ #
364
+ # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
365
+ # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
366
+ # @raise [Google::Apis::AuthorizationError] Authorization is required
367
+ def get_layer(volume_id, summary_id, content_version: nil, source: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block)
368
+ path = 'volumes/{volumeId}/layersummary/{summaryId}'
369
+ command = make_simple_command(:get, path, options)
370
+ command.response_representation = Google::Apis::BooksV1::LayerSummary::Representation
371
+ command.response_class = Google::Apis::BooksV1::LayerSummary
372
+ command.params['volumeId'] = volume_id unless volume_id.nil?
373
+ command.params['summaryId'] = summary_id unless summary_id.nil?
374
+ command.query['contentVersion'] = content_version unless content_version.nil?
375
+ command.query['source'] = source unless source.nil?
376
+ command.query['fields'] = fields unless fields.nil?
377
+ command.query['quotaUser'] = quota_user unless quota_user.nil?
378
+ command.query['userIp'] = user_ip unless user_ip.nil?
379
+ execute_or_queue_command(command, &block)
380
+ end
381
+
382
+ # List the layer summaries for a volume.
383
+ # @param [String] volume_id
384
+ # The volume to retrieve layers for.
385
+ # @param [String] content_version
386
+ # The content version for the requested volume.
387
+ # @param [Fixnum] max_results
388
+ # Maximum number of results to return
389
+ # @param [String] page_token
390
+ # The value of the nextToken from the previous page.
391
+ # @param [String] source
392
+ # String to identify the originator of this request.
393
+ # @param [String] fields
394
+ # Selector specifying which fields to include in a partial response.
395
+ # @param [String] quota_user
396
+ # Available to use for quota purposes for server-side applications. Can be any
397
+ # arbitrary string assigned to a user, but should not exceed 40 characters.
398
+ # Overrides userIp if both are provided.
399
+ # @param [String] user_ip
400
+ # IP address of the site where the request originates. Use this if you want to
401
+ # enforce per-user limits.
402
+ # @param [Google::Apis::RequestOptions] options
403
+ # Request-specific options
404
+ #
405
+ # @yield [result, err] Result & error if block supplied
406
+ # @yieldparam result [Google::Apis::BooksV1::LayerSummaries] parsed result object
407
+ # @yieldparam err [StandardError] error object if request failed
408
+ #
409
+ # @return [Google::Apis::BooksV1::LayerSummaries]
410
+ #
411
+ # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
412
+ # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
413
+ # @raise [Google::Apis::AuthorizationError] Authorization is required
414
+ def list_layers(volume_id, content_version: nil, max_results: nil, page_token: nil, source: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block)
415
+ path = 'volumes/{volumeId}/layersummary'
416
+ command = make_simple_command(:get, path, options)
417
+ command.response_representation = Google::Apis::BooksV1::LayerSummaries::Representation
418
+ command.response_class = Google::Apis::BooksV1::LayerSummaries
419
+ command.params['volumeId'] = volume_id unless volume_id.nil?
420
+ command.query['contentVersion'] = content_version unless content_version.nil?
421
+ command.query['maxResults'] = max_results unless max_results.nil?
422
+ command.query['pageToken'] = page_token unless page_token.nil?
423
+ command.query['source'] = source unless source.nil?
424
+ command.query['fields'] = fields unless fields.nil?
425
+ command.query['quotaUser'] = quota_user unless quota_user.nil?
426
+ command.query['userIp'] = user_ip unless user_ip.nil?
427
+ execute_or_queue_command(command, &block)
428
+ end
429
+
430
+ # Gets the annotation data.
431
+ # @param [String] volume_id
432
+ # The volume to retrieve annotations for.
433
+ # @param [String] layer_id
434
+ # The ID for the layer to get the annotations.
435
+ # @param [String] annotation_data_id
436
+ # The ID of the annotation data to retrieve.
437
+ # @param [Boolean] allow_web_definitions
438
+ # For the dictionary layer. Whether or not to allow web definitions.
439
+ # @param [String] content_version
440
+ # The content version for the volume you are trying to retrieve.
441
+ # @param [Fixnum] h
442
+ # The requested pixel height for any images. If height is provided width must
443
+ # also be provided.
444
+ # @param [String] locale
445
+ # The locale information for the data. ISO-639-1 language and ISO-3166-1 country
446
+ # code. Ex: 'en_US'.
447
+ # @param [Fixnum] scale
448
+ # The requested scale for the image.
449
+ # @param [String] source
450
+ # String to identify the originator of this request.
451
+ # @param [Fixnum] w
452
+ # The requested pixel width for any images. If width is provided height must
453
+ # also be provided.
454
+ # @param [String] fields
455
+ # Selector specifying which fields to include in a partial response.
456
+ # @param [String] quota_user
457
+ # Available to use for quota purposes for server-side applications. Can be any
458
+ # arbitrary string assigned to a user, but should not exceed 40 characters.
459
+ # Overrides userIp if both are provided.
460
+ # @param [String] user_ip
461
+ # IP address of the site where the request originates. Use this if you want to
462
+ # enforce per-user limits.
463
+ # @param [Google::Apis::RequestOptions] options
464
+ # Request-specific options
465
+ #
466
+ # @yield [result, err] Result & error if block supplied
467
+ # @yieldparam result [Google::Apis::BooksV1::AnnotationData] parsed result object
468
+ # @yieldparam err [StandardError] error object if request failed
469
+ #
470
+ # @return [Google::Apis::BooksV1::AnnotationData]
471
+ #
472
+ # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
473
+ # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
474
+ # @raise [Google::Apis::AuthorizationError] Authorization is required
475
+ def get_layer_annotation_data(volume_id, layer_id, annotation_data_id, allow_web_definitions: nil, content_version: nil, h: nil, locale: nil, scale: nil, source: nil, w: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block)
476
+ path = 'volumes/{volumeId}/layers/{layerId}/data/{annotationDataId}'
477
+ command = make_simple_command(:get, path, options)
478
+ command.response_representation = Google::Apis::BooksV1::AnnotationData::Representation
479
+ command.response_class = Google::Apis::BooksV1::AnnotationData
480
+ command.params['volumeId'] = volume_id unless volume_id.nil?
481
+ command.params['layerId'] = layer_id unless layer_id.nil?
482
+ command.params['annotationDataId'] = annotation_data_id unless annotation_data_id.nil?
483
+ command.query['allowWebDefinitions'] = allow_web_definitions unless allow_web_definitions.nil?
484
+ command.query['contentVersion'] = content_version unless content_version.nil?
485
+ command.query['h'] = h unless h.nil?
486
+ command.query['locale'] = locale unless locale.nil?
487
+ command.query['scale'] = scale unless scale.nil?
488
+ command.query['source'] = source unless source.nil?
489
+ command.query['w'] = w unless w.nil?
490
+ command.query['fields'] = fields unless fields.nil?
491
+ command.query['quotaUser'] = quota_user unless quota_user.nil?
492
+ command.query['userIp'] = user_ip unless user_ip.nil?
493
+ execute_or_queue_command(command, &block)
494
+ end
495
+
496
+ # Gets the annotation data for a volume and layer.
497
+ # @param [String] volume_id
498
+ # The volume to retrieve annotation data for.
499
+ # @param [String] layer_id
500
+ # The ID for the layer to get the annotation data.
501
+ # @param [Array<String>, String] annotation_data_id
502
+ # The list of Annotation Data Ids to retrieve. Pagination is ignored if this is
503
+ # set.
504
+ # @param [String] content_version
505
+ # The content version for the requested volume.
506
+ # @param [Fixnum] h
507
+ # The requested pixel height for any images. If height is provided width must
508
+ # also be provided.
509
+ # @param [String] locale
510
+ # The locale information for the data. ISO-639-1 language and ISO-3166-1 country
511
+ # code. Ex: 'en_US'.
512
+ # @param [Fixnum] max_results
513
+ # Maximum number of results to return
514
+ # @param [String] page_token
515
+ # The value of the nextToken from the previous page.
516
+ # @param [Fixnum] scale
517
+ # The requested scale for the image.
518
+ # @param [String] source
519
+ # String to identify the originator of this request.
520
+ # @param [String] updated_max
521
+ # RFC 3339 timestamp to restrict to items updated prior to this timestamp (
522
+ # exclusive).
523
+ # @param [String] updated_min
524
+ # RFC 3339 timestamp to restrict to items updated since this timestamp (
525
+ # inclusive).
526
+ # @param [Fixnum] w
527
+ # The requested pixel width for any images. If width is provided height must
528
+ # also be provided.
529
+ # @param [String] fields
530
+ # Selector specifying which fields to include in a partial response.
531
+ # @param [String] quota_user
532
+ # Available to use for quota purposes for server-side applications. Can be any
533
+ # arbitrary string assigned to a user, but should not exceed 40 characters.
534
+ # Overrides userIp if both are provided.
535
+ # @param [String] user_ip
536
+ # IP address of the site where the request originates. Use this if you want to
537
+ # enforce per-user limits.
538
+ # @param [Google::Apis::RequestOptions] options
539
+ # Request-specific options
540
+ #
541
+ # @yield [result, err] Result & error if block supplied
542
+ # @yieldparam result [Google::Apis::BooksV1::AnnotationsData] parsed result object
543
+ # @yieldparam err [StandardError] error object if request failed
544
+ #
545
+ # @return [Google::Apis::BooksV1::AnnotationsData]
546
+ #
547
+ # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
548
+ # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
549
+ # @raise [Google::Apis::AuthorizationError] Authorization is required
550
+ def list_layer_annotation_data(volume_id, layer_id, annotation_data_id: nil, content_version: nil, h: nil, locale: nil, max_results: nil, page_token: nil, scale: nil, source: nil, updated_max: nil, updated_min: nil, w: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block)
551
+ path = 'volumes/{volumeId}/layers/{layerId}/data'
552
+ command = make_simple_command(:get, path, options)
553
+ command.response_representation = Google::Apis::BooksV1::AnnotationsData::Representation
554
+ command.response_class = Google::Apis::BooksV1::AnnotationsData
555
+ command.params['volumeId'] = volume_id unless volume_id.nil?
556
+ command.params['layerId'] = layer_id unless layer_id.nil?
557
+ command.query['annotationDataId'] = annotation_data_id unless annotation_data_id.nil?
558
+ command.query['contentVersion'] = content_version unless content_version.nil?
559
+ command.query['h'] = h unless h.nil?
560
+ command.query['locale'] = locale unless locale.nil?
561
+ command.query['maxResults'] = max_results unless max_results.nil?
562
+ command.query['pageToken'] = page_token unless page_token.nil?
563
+ command.query['scale'] = scale unless scale.nil?
564
+ command.query['source'] = source unless source.nil?
565
+ command.query['updatedMax'] = updated_max unless updated_max.nil?
566
+ command.query['updatedMin'] = updated_min unless updated_min.nil?
567
+ command.query['w'] = w unless w.nil?
568
+ command.query['fields'] = fields unless fields.nil?
569
+ command.query['quotaUser'] = quota_user unless quota_user.nil?
570
+ command.query['userIp'] = user_ip unless user_ip.nil?
571
+ execute_or_queue_command(command, &block)
572
+ end
573
+
574
+ # Gets the volume annotation.
575
+ # @param [String] volume_id
576
+ # The volume to retrieve annotations for.
577
+ # @param [String] layer_id
578
+ # The ID for the layer to get the annotations.
579
+ # @param [String] annotation_id
580
+ # The ID of the volume annotation to retrieve.
581
+ # @param [String] locale
582
+ # The locale information for the data. ISO-639-1 language and ISO-3166-1 country
583
+ # code. Ex: 'en_US'.
584
+ # @param [String] source
585
+ # String to identify the originator of this request.
586
+ # @param [String] fields
587
+ # Selector specifying which fields to include in a partial response.
588
+ # @param [String] quota_user
589
+ # Available to use for quota purposes for server-side applications. Can be any
590
+ # arbitrary string assigned to a user, but should not exceed 40 characters.
591
+ # Overrides userIp if both are provided.
592
+ # @param [String] user_ip
593
+ # IP address of the site where the request originates. Use this if you want to
594
+ # enforce per-user limits.
595
+ # @param [Google::Apis::RequestOptions] options
596
+ # Request-specific options
597
+ #
598
+ # @yield [result, err] Result & error if block supplied
599
+ # @yieldparam result [Google::Apis::BooksV1::VolumeAnnotation] parsed result object
600
+ # @yieldparam err [StandardError] error object if request failed
601
+ #
602
+ # @return [Google::Apis::BooksV1::VolumeAnnotation]
603
+ #
604
+ # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
605
+ # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
606
+ # @raise [Google::Apis::AuthorizationError] Authorization is required
607
+ def get_layer_volume_annotation(volume_id, layer_id, annotation_id, locale: nil, source: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block)
608
+ path = 'volumes/{volumeId}/layers/{layerId}/annotations/{annotationId}'
609
+ command = make_simple_command(:get, path, options)
610
+ command.response_representation = Google::Apis::BooksV1::VolumeAnnotation::Representation
611
+ command.response_class = Google::Apis::BooksV1::VolumeAnnotation
612
+ command.params['volumeId'] = volume_id unless volume_id.nil?
613
+ command.params['layerId'] = layer_id unless layer_id.nil?
614
+ command.params['annotationId'] = annotation_id unless annotation_id.nil?
615
+ command.query['locale'] = locale unless locale.nil?
616
+ command.query['source'] = source unless source.nil?
617
+ command.query['fields'] = fields unless fields.nil?
618
+ command.query['quotaUser'] = quota_user unless quota_user.nil?
619
+ command.query['userIp'] = user_ip unless user_ip.nil?
620
+ execute_or_queue_command(command, &block)
621
+ end
622
+
623
+ # Gets the volume annotations for a volume and layer.
624
+ # @param [String] volume_id
625
+ # The volume to retrieve annotations for.
626
+ # @param [String] layer_id
627
+ # The ID for the layer to get the annotations.
628
+ # @param [String] content_version
629
+ # The content version for the requested volume.
630
+ # @param [String] end_offset
631
+ # The end offset to end retrieving data from.
632
+ # @param [String] end_position
633
+ # The end position to end retrieving data from.
634
+ # @param [String] locale
635
+ # The locale information for the data. ISO-639-1 language and ISO-3166-1 country
636
+ # code. Ex: 'en_US'.
637
+ # @param [Fixnum] max_results
638
+ # Maximum number of results to return
639
+ # @param [String] page_token
640
+ # The value of the nextToken from the previous page.
641
+ # @param [Boolean] show_deleted
642
+ # Set to true to return deleted annotations. updatedMin must be in the request
643
+ # to use this. Defaults to false.
644
+ # @param [String] source
645
+ # String to identify the originator of this request.
646
+ # @param [String] start_offset
647
+ # The start offset to start retrieving data from.
648
+ # @param [String] start_position
649
+ # The start position to start retrieving data from.
650
+ # @param [String] updated_max
651
+ # RFC 3339 timestamp to restrict to items updated prior to this timestamp (
652
+ # exclusive).
653
+ # @param [String] updated_min
654
+ # RFC 3339 timestamp to restrict to items updated since this timestamp (
655
+ # inclusive).
656
+ # @param [String] volume_annotations_version
657
+ # The version of the volume annotations that you are requesting.
658
+ # @param [String] fields
659
+ # Selector specifying which fields to include in a partial response.
660
+ # @param [String] quota_user
661
+ # Available to use for quota purposes for server-side applications. Can be any
662
+ # arbitrary string assigned to a user, but should not exceed 40 characters.
663
+ # Overrides userIp if both are provided.
664
+ # @param [String] user_ip
665
+ # IP address of the site where the request originates. Use this if you want to
666
+ # enforce per-user limits.
667
+ # @param [Google::Apis::RequestOptions] options
668
+ # Request-specific options
669
+ #
670
+ # @yield [result, err] Result & error if block supplied
671
+ # @yieldparam result [Google::Apis::BooksV1::Volumeannotations] parsed result object
672
+ # @yieldparam err [StandardError] error object if request failed
673
+ #
674
+ # @return [Google::Apis::BooksV1::Volumeannotations]
675
+ #
676
+ # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
677
+ # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
678
+ # @raise [Google::Apis::AuthorizationError] Authorization is required
679
+ def list_layer_volume_annotations(volume_id, layer_id, content_version: nil, end_offset: nil, end_position: nil, locale: nil, max_results: nil, page_token: nil, show_deleted: nil, source: nil, start_offset: nil, start_position: nil, updated_max: nil, updated_min: nil, volume_annotations_version: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block)
680
+ path = 'volumes/{volumeId}/layers/{layerId}'
681
+ command = make_simple_command(:get, path, options)
682
+ command.response_representation = Google::Apis::BooksV1::Volumeannotations::Representation
683
+ command.response_class = Google::Apis::BooksV1::Volumeannotations
684
+ command.params['volumeId'] = volume_id unless volume_id.nil?
685
+ command.params['layerId'] = layer_id unless layer_id.nil?
686
+ command.query['contentVersion'] = content_version unless content_version.nil?
687
+ command.query['endOffset'] = end_offset unless end_offset.nil?
688
+ command.query['endPosition'] = end_position unless end_position.nil?
689
+ command.query['locale'] = locale unless locale.nil?
690
+ command.query['maxResults'] = max_results unless max_results.nil?
691
+ command.query['pageToken'] = page_token unless page_token.nil?
692
+ command.query['showDeleted'] = show_deleted unless show_deleted.nil?
693
+ command.query['source'] = source unless source.nil?
694
+ command.query['startOffset'] = start_offset unless start_offset.nil?
695
+ command.query['startPosition'] = start_position unless start_position.nil?
696
+ command.query['updatedMax'] = updated_max unless updated_max.nil?
697
+ command.query['updatedMin'] = updated_min unless updated_min.nil?
698
+ command.query['volumeAnnotationsVersion'] = volume_annotations_version unless volume_annotations_version.nil?
699
+ command.query['fields'] = fields unless fields.nil?
700
+ command.query['quotaUser'] = quota_user unless quota_user.nil?
701
+ command.query['userIp'] = user_ip unless user_ip.nil?
702
+ execute_or_queue_command(command, &block)
703
+ end
704
+
705
+ # Gets the current settings for the user.
706
+ # @param [String] fields
707
+ # Selector specifying which fields to include in a partial response.
708
+ # @param [String] quota_user
709
+ # Available to use for quota purposes for server-side applications. Can be any
710
+ # arbitrary string assigned to a user, but should not exceed 40 characters.
711
+ # Overrides userIp if both are provided.
712
+ # @param [String] user_ip
713
+ # IP address of the site where the request originates. Use this if you want to
714
+ # enforce per-user limits.
715
+ # @param [Google::Apis::RequestOptions] options
716
+ # Request-specific options
717
+ #
718
+ # @yield [result, err] Result & error if block supplied
719
+ # @yieldparam result [Google::Apis::BooksV1::UserSettings] parsed result object
720
+ # @yieldparam err [StandardError] error object if request failed
721
+ #
722
+ # @return [Google::Apis::BooksV1::UserSettings]
723
+ #
724
+ # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
725
+ # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
726
+ # @raise [Google::Apis::AuthorizationError] Authorization is required
727
+ def get_user_settings(fields: nil, quota_user: nil, user_ip: nil, options: nil, &block)
728
+ path = 'myconfig/getUserSettings'
729
+ command = make_simple_command(:get, path, options)
730
+ command.response_representation = Google::Apis::BooksV1::UserSettings::Representation
731
+ command.response_class = Google::Apis::BooksV1::UserSettings
732
+ command.query['fields'] = fields unless fields.nil?
733
+ command.query['quotaUser'] = quota_user unless quota_user.nil?
734
+ command.query['userIp'] = user_ip unless user_ip.nil?
735
+ execute_or_queue_command(command, &block)
736
+ end
737
+
738
+ # Release downloaded content access restriction.
739
+ # @param [String] cpksver
740
+ # The device/version ID from which to release the restriction.
741
+ # @param [String] locale
742
+ # ISO-639-1, ISO-3166-1 codes for message localization, i.e. en_US.
743
+ # @param [String] source
744
+ # String to identify the originator of this request.
745
+ # @param [Array<String>, String] volume_ids
746
+ # The volume(s) to release restrictions for.
747
+ # @param [String] fields
748
+ # Selector specifying which fields to include in a partial response.
749
+ # @param [String] quota_user
750
+ # Available to use for quota purposes for server-side applications. Can be any
751
+ # arbitrary string assigned to a user, but should not exceed 40 characters.
752
+ # Overrides userIp if both are provided.
753
+ # @param [String] user_ip
754
+ # IP address of the site where the request originates. Use this if you want to
755
+ # enforce per-user limits.
756
+ # @param [Google::Apis::RequestOptions] options
757
+ # Request-specific options
758
+ #
759
+ # @yield [result, err] Result & error if block supplied
760
+ # @yieldparam result [Google::Apis::BooksV1::DownloadAccesses] parsed result object
761
+ # @yieldparam err [StandardError] error object if request failed
762
+ #
763
+ # @return [Google::Apis::BooksV1::DownloadAccesses]
764
+ #
765
+ # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
766
+ # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
767
+ # @raise [Google::Apis::AuthorizationError] Authorization is required
768
+ def release_download_access(cpksver: nil, locale: nil, source: nil, volume_ids: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block)
769
+ path = 'myconfig/releaseDownloadAccess'
770
+ command = make_simple_command(:post, path, options)
771
+ command.response_representation = Google::Apis::BooksV1::DownloadAccesses::Representation
772
+ command.response_class = Google::Apis::BooksV1::DownloadAccesses
773
+ command.query['cpksver'] = cpksver unless cpksver.nil?
774
+ command.query['locale'] = locale unless locale.nil?
775
+ command.query['source'] = source unless source.nil?
776
+ command.query['volumeIds'] = volume_ids unless volume_ids.nil?
777
+ command.query['fields'] = fields unless fields.nil?
778
+ command.query['quotaUser'] = quota_user unless quota_user.nil?
779
+ command.query['userIp'] = user_ip unless user_ip.nil?
780
+ execute_or_queue_command(command, &block)
781
+ end
782
+
783
+ # Request concurrent and download access restrictions.
784
+ # @param [String] cpksver
785
+ # The device/version ID from which to request the restrictions.
786
+ # @param [String] license_types
787
+ # The type of access license to request. If not specified, the default is BOTH.
788
+ # @param [String] locale
789
+ # ISO-639-1, ISO-3166-1 codes for message localization, i.e. en_US.
790
+ # @param [String] nonce
791
+ # The client nonce value.
792
+ # @param [String] source
793
+ # String to identify the originator of this request.
794
+ # @param [String] volume_id
795
+ # The volume to request concurrent/download restrictions for.
796
+ # @param [String] fields
797
+ # Selector specifying which fields to include in a partial response.
798
+ # @param [String] quota_user
799
+ # Available to use for quota purposes for server-side applications. Can be any
800
+ # arbitrary string assigned to a user, but should not exceed 40 characters.
801
+ # Overrides userIp if both are provided.
802
+ # @param [String] user_ip
803
+ # IP address of the site where the request originates. Use this if you want to
804
+ # enforce per-user limits.
805
+ # @param [Google::Apis::RequestOptions] options
806
+ # Request-specific options
807
+ #
808
+ # @yield [result, err] Result & error if block supplied
809
+ # @yieldparam result [Google::Apis::BooksV1::RequestAccess] parsed result object
810
+ # @yieldparam err [StandardError] error object if request failed
811
+ #
812
+ # @return [Google::Apis::BooksV1::RequestAccess]
813
+ #
814
+ # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
815
+ # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
816
+ # @raise [Google::Apis::AuthorizationError] Authorization is required
817
+ def request_access(cpksver: nil, license_types: nil, locale: nil, nonce: nil, source: nil, volume_id: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block)
818
+ path = 'myconfig/requestAccess'
819
+ command = make_simple_command(:post, path, options)
820
+ command.response_representation = Google::Apis::BooksV1::RequestAccess::Representation
821
+ command.response_class = Google::Apis::BooksV1::RequestAccess
822
+ command.query['cpksver'] = cpksver unless cpksver.nil?
823
+ command.query['licenseTypes'] = license_types unless license_types.nil?
824
+ command.query['locale'] = locale unless locale.nil?
825
+ command.query['nonce'] = nonce unless nonce.nil?
826
+ command.query['source'] = source unless source.nil?
827
+ command.query['volumeId'] = volume_id unless volume_id.nil?
828
+ command.query['fields'] = fields unless fields.nil?
829
+ command.query['quotaUser'] = quota_user unless quota_user.nil?
830
+ command.query['userIp'] = user_ip unless user_ip.nil?
831
+ execute_or_queue_command(command, &block)
832
+ end
833
+
834
+ # Request downloaded content access for specified volumes on the My eBooks shelf.
835
+ # @param [String] cpksver
836
+ # The device/version ID from which to release the restriction.
837
+ # @param [Array<String>, String] features
838
+ # List of features supported by the client, i.e., 'RENTALS'
839
+ # @param [String] locale
840
+ # ISO-639-1, ISO-3166-1 codes for message localization, i.e. en_US.
841
+ # @param [String] nonce
842
+ # The client nonce value.
843
+ # @param [Boolean] show_preorders
844
+ # Set to true to show pre-ordered books. Defaults to false.
845
+ # @param [String] source
846
+ # String to identify the originator of this request.
847
+ # @param [Array<String>, String] volume_ids
848
+ # The volume(s) to request download restrictions for.
849
+ # @param [String] fields
850
+ # Selector specifying which fields to include in a partial response.
851
+ # @param [String] quota_user
852
+ # Available to use for quota purposes for server-side applications. Can be any
853
+ # arbitrary string assigned to a user, but should not exceed 40 characters.
854
+ # Overrides userIp if both are provided.
855
+ # @param [String] user_ip
856
+ # IP address of the site where the request originates. Use this if you want to
857
+ # enforce per-user limits.
858
+ # @param [Google::Apis::RequestOptions] options
859
+ # Request-specific options
860
+ #
861
+ # @yield [result, err] Result & error if block supplied
862
+ # @yieldparam result [Google::Apis::BooksV1::Volumes] parsed result object
863
+ # @yieldparam err [StandardError] error object if request failed
864
+ #
865
+ # @return [Google::Apis::BooksV1::Volumes]
866
+ #
867
+ # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
868
+ # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
869
+ # @raise [Google::Apis::AuthorizationError] Authorization is required
870
+ def sync_volume_licenses(cpksver: nil, features: nil, locale: nil, nonce: nil, show_preorders: nil, source: nil, volume_ids: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block)
871
+ path = 'myconfig/syncVolumeLicenses'
872
+ command = make_simple_command(:post, path, options)
873
+ command.response_representation = Google::Apis::BooksV1::Volumes::Representation
874
+ command.response_class = Google::Apis::BooksV1::Volumes
875
+ command.query['cpksver'] = cpksver unless cpksver.nil?
876
+ command.query['features'] = features unless features.nil?
877
+ command.query['locale'] = locale unless locale.nil?
878
+ command.query['nonce'] = nonce unless nonce.nil?
879
+ command.query['showPreorders'] = show_preorders unless show_preorders.nil?
880
+ command.query['source'] = source unless source.nil?
881
+ command.query['volumeIds'] = volume_ids unless volume_ids.nil?
882
+ command.query['fields'] = fields unless fields.nil?
883
+ command.query['quotaUser'] = quota_user unless quota_user.nil?
884
+ command.query['userIp'] = user_ip unless user_ip.nil?
885
+ execute_or_queue_command(command, &block)
886
+ end
887
+
888
+ # Sets the settings for the user. If a sub-object is specified, it will
889
+ # overwrite the existing sub-object stored in the server. Unspecified sub-
890
+ # objects will retain the existing value.
891
+ # @param [Google::Apis::BooksV1::UserSettings] user_settings_object
892
+ # @param [String] fields
893
+ # Selector specifying which fields to include in a partial response.
894
+ # @param [String] quota_user
895
+ # Available to use for quota purposes for server-side applications. Can be any
896
+ # arbitrary string assigned to a user, but should not exceed 40 characters.
897
+ # Overrides userIp if both are provided.
898
+ # @param [String] user_ip
899
+ # IP address of the site where the request originates. Use this if you want to
900
+ # enforce per-user limits.
901
+ # @param [Google::Apis::RequestOptions] options
902
+ # Request-specific options
903
+ #
904
+ # @yield [result, err] Result & error if block supplied
905
+ # @yieldparam result [Google::Apis::BooksV1::UserSettings] parsed result object
906
+ # @yieldparam err [StandardError] error object if request failed
907
+ #
908
+ # @return [Google::Apis::BooksV1::UserSettings]
909
+ #
910
+ # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
911
+ # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
912
+ # @raise [Google::Apis::AuthorizationError] Authorization is required
913
+ def update_user_settings(user_settings_object = nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block)
914
+ path = 'myconfig/updateUserSettings'
915
+ command = make_simple_command(:post, path, options)
916
+ command.request_representation = Google::Apis::BooksV1::UserSettings::Representation
917
+ command.request_object = user_settings_object
918
+ command.response_representation = Google::Apis::BooksV1::UserSettings::Representation
919
+ command.response_class = Google::Apis::BooksV1::UserSettings
920
+ command.query['fields'] = fields unless fields.nil?
921
+ command.query['quotaUser'] = quota_user unless quota_user.nil?
922
+ command.query['userIp'] = user_ip unless user_ip.nil?
923
+ execute_or_queue_command(command, &block)
924
+ end
925
+
926
+ # Deletes an annotation.
927
+ # @param [String] annotation_id
928
+ # The ID for the annotation to delete.
929
+ # @param [String] source
930
+ # String to identify the originator of this request.
931
+ # @param [String] fields
932
+ # Selector specifying which fields to include in a partial response.
933
+ # @param [String] quota_user
934
+ # Available to use for quota purposes for server-side applications. Can be any
935
+ # arbitrary string assigned to a user, but should not exceed 40 characters.
936
+ # Overrides userIp if both are provided.
937
+ # @param [String] user_ip
938
+ # IP address of the site where the request originates. Use this if you want to
939
+ # enforce per-user limits.
940
+ # @param [Google::Apis::RequestOptions] options
941
+ # Request-specific options
942
+ #
943
+ # @yield [result, err] Result & error if block supplied
944
+ # @yieldparam result [NilClass] No result returned for this method
945
+ # @yieldparam err [StandardError] error object if request failed
946
+ #
947
+ # @return [void]
948
+ #
949
+ # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
950
+ # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
951
+ # @raise [Google::Apis::AuthorizationError] Authorization is required
952
+ def delete_my_library_annotation(annotation_id, source: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block)
953
+ path = 'mylibrary/annotations/{annotationId}'
954
+ command = make_simple_command(:delete, path, options)
955
+ command.params['annotationId'] = annotation_id unless annotation_id.nil?
956
+ command.query['source'] = source unless source.nil?
957
+ command.query['fields'] = fields unless fields.nil?
958
+ command.query['quotaUser'] = quota_user unless quota_user.nil?
959
+ command.query['userIp'] = user_ip unless user_ip.nil?
960
+ execute_or_queue_command(command, &block)
961
+ end
962
+
963
+ # Inserts a new annotation.
964
+ # @param [Google::Apis::BooksV1::Annotation] annotation_object
965
+ # @param [String] country
966
+ # ISO-3166-1 code to override the IP-based location.
967
+ # @param [Boolean] show_only_summary_in_response
968
+ # Requests that only the summary of the specified layer be provided in the
969
+ # response.
970
+ # @param [String] source
971
+ # String to identify the originator of this request.
972
+ # @param [String] fields
973
+ # Selector specifying which fields to include in a partial response.
974
+ # @param [String] quota_user
975
+ # Available to use for quota purposes for server-side applications. Can be any
976
+ # arbitrary string assigned to a user, but should not exceed 40 characters.
977
+ # Overrides userIp if both are provided.
978
+ # @param [String] user_ip
979
+ # IP address of the site where the request originates. Use this if you want to
980
+ # enforce per-user limits.
981
+ # @param [Google::Apis::RequestOptions] options
982
+ # Request-specific options
983
+ #
984
+ # @yield [result, err] Result & error if block supplied
985
+ # @yieldparam result [Google::Apis::BooksV1::Annotation] parsed result object
986
+ # @yieldparam err [StandardError] error object if request failed
987
+ #
988
+ # @return [Google::Apis::BooksV1::Annotation]
989
+ #
990
+ # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
991
+ # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
992
+ # @raise [Google::Apis::AuthorizationError] Authorization is required
993
+ def insert_my_library_annotation(annotation_object = nil, country: nil, show_only_summary_in_response: nil, source: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block)
994
+ path = 'mylibrary/annotations'
995
+ command = make_simple_command(:post, path, options)
996
+ command.request_representation = Google::Apis::BooksV1::Annotation::Representation
997
+ command.request_object = annotation_object
998
+ command.response_representation = Google::Apis::BooksV1::Annotation::Representation
999
+ command.response_class = Google::Apis::BooksV1::Annotation
1000
+ command.query['country'] = country unless country.nil?
1001
+ command.query['showOnlySummaryInResponse'] = show_only_summary_in_response unless show_only_summary_in_response.nil?
1002
+ command.query['source'] = source unless source.nil?
1003
+ command.query['fields'] = fields unless fields.nil?
1004
+ command.query['quotaUser'] = quota_user unless quota_user.nil?
1005
+ command.query['userIp'] = user_ip unless user_ip.nil?
1006
+ execute_or_queue_command(command, &block)
1007
+ end
1008
+
1009
+ # Retrieves a list of annotations, possibly filtered.
1010
+ # @param [String] content_version
1011
+ # The content version for the requested volume.
1012
+ # @param [String] layer_id
1013
+ # The layer ID to limit annotation by.
1014
+ # @param [Array<String>, String] layer_ids
1015
+ # The layer ID(s) to limit annotation by.
1016
+ # @param [Fixnum] max_results
1017
+ # Maximum number of results to return
1018
+ # @param [String] page_token
1019
+ # The value of the nextToken from the previous page.
1020
+ # @param [Boolean] show_deleted
1021
+ # Set to true to return deleted annotations. updatedMin must be in the request
1022
+ # to use this. Defaults to false.
1023
+ # @param [String] source
1024
+ # String to identify the originator of this request.
1025
+ # @param [String] updated_max
1026
+ # RFC 3339 timestamp to restrict to items updated prior to this timestamp (
1027
+ # exclusive).
1028
+ # @param [String] updated_min
1029
+ # RFC 3339 timestamp to restrict to items updated since this timestamp (
1030
+ # inclusive).
1031
+ # @param [String] volume_id
1032
+ # The volume to restrict annotations to.
1033
+ # @param [String] fields
1034
+ # Selector specifying which fields to include in a partial response.
1035
+ # @param [String] quota_user
1036
+ # Available to use for quota purposes for server-side applications. Can be any
1037
+ # arbitrary string assigned to a user, but should not exceed 40 characters.
1038
+ # Overrides userIp if both are provided.
1039
+ # @param [String] user_ip
1040
+ # IP address of the site where the request originates. Use this if you want to
1041
+ # enforce per-user limits.
1042
+ # @param [Google::Apis::RequestOptions] options
1043
+ # Request-specific options
1044
+ #
1045
+ # @yield [result, err] Result & error if block supplied
1046
+ # @yieldparam result [Google::Apis::BooksV1::Annotations] parsed result object
1047
+ # @yieldparam err [StandardError] error object if request failed
1048
+ #
1049
+ # @return [Google::Apis::BooksV1::Annotations]
1050
+ #
1051
+ # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
1052
+ # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
1053
+ # @raise [Google::Apis::AuthorizationError] Authorization is required
1054
+ def list_my_library_annotations(content_version: nil, layer_id: nil, layer_ids: nil, max_results: nil, page_token: nil, show_deleted: nil, source: nil, updated_max: nil, updated_min: nil, volume_id: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block)
1055
+ path = 'mylibrary/annotations'
1056
+ command = make_simple_command(:get, path, options)
1057
+ command.response_representation = Google::Apis::BooksV1::Annotations::Representation
1058
+ command.response_class = Google::Apis::BooksV1::Annotations
1059
+ command.query['contentVersion'] = content_version unless content_version.nil?
1060
+ command.query['layerId'] = layer_id unless layer_id.nil?
1061
+ command.query['layerIds'] = layer_ids unless layer_ids.nil?
1062
+ command.query['maxResults'] = max_results unless max_results.nil?
1063
+ command.query['pageToken'] = page_token unless page_token.nil?
1064
+ command.query['showDeleted'] = show_deleted unless show_deleted.nil?
1065
+ command.query['source'] = source unless source.nil?
1066
+ command.query['updatedMax'] = updated_max unless updated_max.nil?
1067
+ command.query['updatedMin'] = updated_min unless updated_min.nil?
1068
+ command.query['volumeId'] = volume_id unless volume_id.nil?
1069
+ command.query['fields'] = fields unless fields.nil?
1070
+ command.query['quotaUser'] = quota_user unless quota_user.nil?
1071
+ command.query['userIp'] = user_ip unless user_ip.nil?
1072
+ execute_or_queue_command(command, &block)
1073
+ end
1074
+
1075
+ # Gets the summary of specified layers.
1076
+ # @param [Array<String>, String] layer_ids
1077
+ # Array of layer IDs to get the summary for.
1078
+ # @param [String] volume_id
1079
+ # Volume id to get the summary for.
1080
+ # @param [String] fields
1081
+ # Selector specifying which fields to include in a partial response.
1082
+ # @param [String] quota_user
1083
+ # Available to use for quota purposes for server-side applications. Can be any
1084
+ # arbitrary string assigned to a user, but should not exceed 40 characters.
1085
+ # Overrides userIp if both are provided.
1086
+ # @param [String] user_ip
1087
+ # IP address of the site where the request originates. Use this if you want to
1088
+ # enforce per-user limits.
1089
+ # @param [Google::Apis::RequestOptions] options
1090
+ # Request-specific options
1091
+ #
1092
+ # @yield [result, err] Result & error if block supplied
1093
+ # @yieldparam result [Google::Apis::BooksV1::AnnotationsSummary] parsed result object
1094
+ # @yieldparam err [StandardError] error object if request failed
1095
+ #
1096
+ # @return [Google::Apis::BooksV1::AnnotationsSummary]
1097
+ #
1098
+ # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
1099
+ # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
1100
+ # @raise [Google::Apis::AuthorizationError] Authorization is required
1101
+ def summarize_my_library_annotation(layer_ids: nil, volume_id: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block)
1102
+ path = 'mylibrary/annotations/summary'
1103
+ command = make_simple_command(:post, path, options)
1104
+ command.response_representation = Google::Apis::BooksV1::AnnotationsSummary::Representation
1105
+ command.response_class = Google::Apis::BooksV1::AnnotationsSummary
1106
+ command.query['layerIds'] = layer_ids unless layer_ids.nil?
1107
+ command.query['volumeId'] = volume_id unless volume_id.nil?
1108
+ command.query['fields'] = fields unless fields.nil?
1109
+ command.query['quotaUser'] = quota_user unless quota_user.nil?
1110
+ command.query['userIp'] = user_ip unless user_ip.nil?
1111
+ execute_or_queue_command(command, &block)
1112
+ end
1113
+
1114
+ # Updates an existing annotation.
1115
+ # @param [String] annotation_id
1116
+ # The ID for the annotation to update.
1117
+ # @param [Google::Apis::BooksV1::Annotation] annotation_object
1118
+ # @param [String] source
1119
+ # String to identify the originator of this request.
1120
+ # @param [String] fields
1121
+ # Selector specifying which fields to include in a partial response.
1122
+ # @param [String] quota_user
1123
+ # Available to use for quota purposes for server-side applications. Can be any
1124
+ # arbitrary string assigned to a user, but should not exceed 40 characters.
1125
+ # Overrides userIp if both are provided.
1126
+ # @param [String] user_ip
1127
+ # IP address of the site where the request originates. Use this if you want to
1128
+ # enforce per-user limits.
1129
+ # @param [Google::Apis::RequestOptions] options
1130
+ # Request-specific options
1131
+ #
1132
+ # @yield [result, err] Result & error if block supplied
1133
+ # @yieldparam result [Google::Apis::BooksV1::Annotation] parsed result object
1134
+ # @yieldparam err [StandardError] error object if request failed
1135
+ #
1136
+ # @return [Google::Apis::BooksV1::Annotation]
1137
+ #
1138
+ # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
1139
+ # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
1140
+ # @raise [Google::Apis::AuthorizationError] Authorization is required
1141
+ def update_my_library_annotation(annotation_id, annotation_object = nil, source: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block)
1142
+ path = 'mylibrary/annotations/{annotationId}'
1143
+ command = make_simple_command(:put, path, options)
1144
+ command.request_representation = Google::Apis::BooksV1::Annotation::Representation
1145
+ command.request_object = annotation_object
1146
+ command.response_representation = Google::Apis::BooksV1::Annotation::Representation
1147
+ command.response_class = Google::Apis::BooksV1::Annotation
1148
+ command.params['annotationId'] = annotation_id unless annotation_id.nil?
1149
+ command.query['source'] = source unless source.nil?
1150
+ command.query['fields'] = fields unless fields.nil?
1151
+ command.query['quotaUser'] = quota_user unless quota_user.nil?
1152
+ command.query['userIp'] = user_ip unless user_ip.nil?
1153
+ execute_or_queue_command(command, &block)
1154
+ end
1155
+
1156
+ # Adds a volume to a bookshelf.
1157
+ # @param [String] shelf
1158
+ # ID of bookshelf to which to add a volume.
1159
+ # @param [String] reason
1160
+ # The reason for which the book is added to the library.
1161
+ # @param [String] source
1162
+ # String to identify the originator of this request.
1163
+ # @param [String] volume_id
1164
+ # ID of volume to add.
1165
+ # @param [String] fields
1166
+ # Selector specifying which fields to include in a partial response.
1167
+ # @param [String] quota_user
1168
+ # Available to use for quota purposes for server-side applications. Can be any
1169
+ # arbitrary string assigned to a user, but should not exceed 40 characters.
1170
+ # Overrides userIp if both are provided.
1171
+ # @param [String] user_ip
1172
+ # IP address of the site where the request originates. Use this if you want to
1173
+ # enforce per-user limits.
1174
+ # @param [Google::Apis::RequestOptions] options
1175
+ # Request-specific options
1176
+ #
1177
+ # @yield [result, err] Result & error if block supplied
1178
+ # @yieldparam result [NilClass] No result returned for this method
1179
+ # @yieldparam err [StandardError] error object if request failed
1180
+ #
1181
+ # @return [void]
1182
+ #
1183
+ # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
1184
+ # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
1185
+ # @raise [Google::Apis::AuthorizationError] Authorization is required
1186
+ def add_my_library_volume(shelf, reason: nil, source: nil, volume_id: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block)
1187
+ path = 'mylibrary/bookshelves/{shelf}/addVolume'
1188
+ command = make_simple_command(:post, path, options)
1189
+ command.params['shelf'] = shelf unless shelf.nil?
1190
+ command.query['reason'] = reason unless reason.nil?
1191
+ command.query['source'] = source unless source.nil?
1192
+ command.query['volumeId'] = volume_id unless volume_id.nil?
1193
+ command.query['fields'] = fields unless fields.nil?
1194
+ command.query['quotaUser'] = quota_user unless quota_user.nil?
1195
+ command.query['userIp'] = user_ip unless user_ip.nil?
1196
+ execute_or_queue_command(command, &block)
1197
+ end
1198
+
1199
+ # Clears all volumes from a bookshelf.
1200
+ # @param [String] shelf
1201
+ # ID of bookshelf from which to remove a volume.
1202
+ # @param [String] source
1203
+ # String to identify the originator of this request.
1204
+ # @param [String] fields
1205
+ # Selector specifying which fields to include in a partial response.
1206
+ # @param [String] quota_user
1207
+ # Available to use for quota purposes for server-side applications. Can be any
1208
+ # arbitrary string assigned to a user, but should not exceed 40 characters.
1209
+ # Overrides userIp if both are provided.
1210
+ # @param [String] user_ip
1211
+ # IP address of the site where the request originates. Use this if you want to
1212
+ # enforce per-user limits.
1213
+ # @param [Google::Apis::RequestOptions] options
1214
+ # Request-specific options
1215
+ #
1216
+ # @yield [result, err] Result & error if block supplied
1217
+ # @yieldparam result [NilClass] No result returned for this method
1218
+ # @yieldparam err [StandardError] error object if request failed
1219
+ #
1220
+ # @return [void]
1221
+ #
1222
+ # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
1223
+ # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
1224
+ # @raise [Google::Apis::AuthorizationError] Authorization is required
1225
+ def clear_my_library_volumes(shelf, source: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block)
1226
+ path = 'mylibrary/bookshelves/{shelf}/clearVolumes'
1227
+ command = make_simple_command(:post, path, options)
1228
+ command.params['shelf'] = shelf unless shelf.nil?
1229
+ command.query['source'] = source unless source.nil?
1230
+ command.query['fields'] = fields unless fields.nil?
1231
+ command.query['quotaUser'] = quota_user unless quota_user.nil?
1232
+ command.query['userIp'] = user_ip unless user_ip.nil?
1233
+ execute_or_queue_command(command, &block)
1234
+ end
1235
+
1236
+ # Retrieves metadata for a specific bookshelf belonging to the authenticated
1237
+ # user.
1238
+ # @param [String] shelf
1239
+ # ID of bookshelf to retrieve.
1240
+ # @param [String] source
1241
+ # String to identify the originator of this request.
1242
+ # @param [String] fields
1243
+ # Selector specifying which fields to include in a partial response.
1244
+ # @param [String] quota_user
1245
+ # Available to use for quota purposes for server-side applications. Can be any
1246
+ # arbitrary string assigned to a user, but should not exceed 40 characters.
1247
+ # Overrides userIp if both are provided.
1248
+ # @param [String] user_ip
1249
+ # IP address of the site where the request originates. Use this if you want to
1250
+ # enforce per-user limits.
1251
+ # @param [Google::Apis::RequestOptions] options
1252
+ # Request-specific options
1253
+ #
1254
+ # @yield [result, err] Result & error if block supplied
1255
+ # @yieldparam result [Google::Apis::BooksV1::Bookshelf] parsed result object
1256
+ # @yieldparam err [StandardError] error object if request failed
1257
+ #
1258
+ # @return [Google::Apis::BooksV1::Bookshelf]
1259
+ #
1260
+ # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
1261
+ # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
1262
+ # @raise [Google::Apis::AuthorizationError] Authorization is required
1263
+ def get_my_library_bookshelf(shelf, source: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block)
1264
+ path = 'mylibrary/bookshelves/{shelf}'
1265
+ command = make_simple_command(:get, path, options)
1266
+ command.response_representation = Google::Apis::BooksV1::Bookshelf::Representation
1267
+ command.response_class = Google::Apis::BooksV1::Bookshelf
1268
+ command.params['shelf'] = shelf unless shelf.nil?
1269
+ command.query['source'] = source unless source.nil?
1270
+ command.query['fields'] = fields unless fields.nil?
1271
+ command.query['quotaUser'] = quota_user unless quota_user.nil?
1272
+ command.query['userIp'] = user_ip unless user_ip.nil?
1273
+ execute_or_queue_command(command, &block)
1274
+ end
1275
+
1276
+ # Retrieves a list of bookshelves belonging to the authenticated user.
1277
+ # @param [String] source
1278
+ # String to identify the originator of this request.
1279
+ # @param [String] fields
1280
+ # Selector specifying which fields to include in a partial response.
1281
+ # @param [String] quota_user
1282
+ # Available to use for quota purposes for server-side applications. Can be any
1283
+ # arbitrary string assigned to a user, but should not exceed 40 characters.
1284
+ # Overrides userIp if both are provided.
1285
+ # @param [String] user_ip
1286
+ # IP address of the site where the request originates. Use this if you want to
1287
+ # enforce per-user limits.
1288
+ # @param [Google::Apis::RequestOptions] options
1289
+ # Request-specific options
1290
+ #
1291
+ # @yield [result, err] Result & error if block supplied
1292
+ # @yieldparam result [Google::Apis::BooksV1::Bookshelves] parsed result object
1293
+ # @yieldparam err [StandardError] error object if request failed
1294
+ #
1295
+ # @return [Google::Apis::BooksV1::Bookshelves]
1296
+ #
1297
+ # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
1298
+ # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
1299
+ # @raise [Google::Apis::AuthorizationError] Authorization is required
1300
+ def list_my_library_bookshelves(source: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block)
1301
+ path = 'mylibrary/bookshelves'
1302
+ command = make_simple_command(:get, path, options)
1303
+ command.response_representation = Google::Apis::BooksV1::Bookshelves::Representation
1304
+ command.response_class = Google::Apis::BooksV1::Bookshelves
1305
+ command.query['source'] = source unless source.nil?
1306
+ command.query['fields'] = fields unless fields.nil?
1307
+ command.query['quotaUser'] = quota_user unless quota_user.nil?
1308
+ command.query['userIp'] = user_ip unless user_ip.nil?
1309
+ execute_or_queue_command(command, &block)
1310
+ end
1311
+
1312
+ # Moves a volume within a bookshelf.
1313
+ # @param [String] shelf
1314
+ # ID of bookshelf with the volume.
1315
+ # @param [String] source
1316
+ # String to identify the originator of this request.
1317
+ # @param [String] volume_id
1318
+ # ID of volume to move.
1319
+ # @param [Fixnum] volume_position
1320
+ # Position on shelf to move the item (0 puts the item before the current first
1321
+ # item, 1 puts it between the first and the second and so on.)
1322
+ # @param [String] fields
1323
+ # Selector specifying which fields to include in a partial response.
1324
+ # @param [String] quota_user
1325
+ # Available to use for quota purposes for server-side applications. Can be any
1326
+ # arbitrary string assigned to a user, but should not exceed 40 characters.
1327
+ # Overrides userIp if both are provided.
1328
+ # @param [String] user_ip
1329
+ # IP address of the site where the request originates. Use this if you want to
1330
+ # enforce per-user limits.
1331
+ # @param [Google::Apis::RequestOptions] options
1332
+ # Request-specific options
1333
+ #
1334
+ # @yield [result, err] Result & error if block supplied
1335
+ # @yieldparam result [NilClass] No result returned for this method
1336
+ # @yieldparam err [StandardError] error object if request failed
1337
+ #
1338
+ # @return [void]
1339
+ #
1340
+ # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
1341
+ # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
1342
+ # @raise [Google::Apis::AuthorizationError] Authorization is required
1343
+ def move_my_library_volume(shelf, source: nil, volume_id: nil, volume_position: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block)
1344
+ path = 'mylibrary/bookshelves/{shelf}/moveVolume'
1345
+ command = make_simple_command(:post, path, options)
1346
+ command.params['shelf'] = shelf unless shelf.nil?
1347
+ command.query['source'] = source unless source.nil?
1348
+ command.query['volumeId'] = volume_id unless volume_id.nil?
1349
+ command.query['volumePosition'] = volume_position unless volume_position.nil?
1350
+ command.query['fields'] = fields unless fields.nil?
1351
+ command.query['quotaUser'] = quota_user unless quota_user.nil?
1352
+ command.query['userIp'] = user_ip unless user_ip.nil?
1353
+ execute_or_queue_command(command, &block)
1354
+ end
1355
+
1356
+ # Removes a volume from a bookshelf.
1357
+ # @param [String] shelf
1358
+ # ID of bookshelf from which to remove a volume.
1359
+ # @param [String] reason
1360
+ # The reason for which the book is removed from the library.
1361
+ # @param [String] source
1362
+ # String to identify the originator of this request.
1363
+ # @param [String] volume_id
1364
+ # ID of volume to remove.
1365
+ # @param [String] fields
1366
+ # Selector specifying which fields to include in a partial response.
1367
+ # @param [String] quota_user
1368
+ # Available to use for quota purposes for server-side applications. Can be any
1369
+ # arbitrary string assigned to a user, but should not exceed 40 characters.
1370
+ # Overrides userIp if both are provided.
1371
+ # @param [String] user_ip
1372
+ # IP address of the site where the request originates. Use this if you want to
1373
+ # enforce per-user limits.
1374
+ # @param [Google::Apis::RequestOptions] options
1375
+ # Request-specific options
1376
+ #
1377
+ # @yield [result, err] Result & error if block supplied
1378
+ # @yieldparam result [NilClass] No result returned for this method
1379
+ # @yieldparam err [StandardError] error object if request failed
1380
+ #
1381
+ # @return [void]
1382
+ #
1383
+ # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
1384
+ # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
1385
+ # @raise [Google::Apis::AuthorizationError] Authorization is required
1386
+ def remove_my_library_volume(shelf, reason: nil, source: nil, volume_id: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block)
1387
+ path = 'mylibrary/bookshelves/{shelf}/removeVolume'
1388
+ command = make_simple_command(:post, path, options)
1389
+ command.params['shelf'] = shelf unless shelf.nil?
1390
+ command.query['reason'] = reason unless reason.nil?
1391
+ command.query['source'] = source unless source.nil?
1392
+ command.query['volumeId'] = volume_id unless volume_id.nil?
1393
+ command.query['fields'] = fields unless fields.nil?
1394
+ command.query['quotaUser'] = quota_user unless quota_user.nil?
1395
+ command.query['userIp'] = user_ip unless user_ip.nil?
1396
+ execute_or_queue_command(command, &block)
1397
+ end
1398
+
1399
+ # Gets volume information for volumes on a bookshelf.
1400
+ # @param [String] shelf
1401
+ # The bookshelf ID or name retrieve volumes for.
1402
+ # @param [String] country
1403
+ # ISO-3166-1 code to override the IP-based location.
1404
+ # @param [Fixnum] max_results
1405
+ # Maximum number of results to return
1406
+ # @param [String] projection
1407
+ # Restrict information returned to a set of selected fields.
1408
+ # @param [String] q
1409
+ # Full-text search query string in this bookshelf.
1410
+ # @param [Boolean] show_preorders
1411
+ # Set to true to show pre-ordered books. Defaults to false.
1412
+ # @param [String] source
1413
+ # String to identify the originator of this request.
1414
+ # @param [Fixnum] start_index
1415
+ # Index of the first element to return (starts at 0)
1416
+ # @param [String] fields
1417
+ # Selector specifying which fields to include in a partial response.
1418
+ # @param [String] quota_user
1419
+ # Available to use for quota purposes for server-side applications. Can be any
1420
+ # arbitrary string assigned to a user, but should not exceed 40 characters.
1421
+ # Overrides userIp if both are provided.
1422
+ # @param [String] user_ip
1423
+ # IP address of the site where the request originates. Use this if you want to
1424
+ # enforce per-user limits.
1425
+ # @param [Google::Apis::RequestOptions] options
1426
+ # Request-specific options
1427
+ #
1428
+ # @yield [result, err] Result & error if block supplied
1429
+ # @yieldparam result [Google::Apis::BooksV1::Volumes] parsed result object
1430
+ # @yieldparam err [StandardError] error object if request failed
1431
+ #
1432
+ # @return [Google::Apis::BooksV1::Volumes]
1433
+ #
1434
+ # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
1435
+ # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
1436
+ # @raise [Google::Apis::AuthorizationError] Authorization is required
1437
+ def list_my_library_volumes(shelf, country: nil, max_results: nil, projection: nil, q: nil, show_preorders: nil, source: nil, start_index: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block)
1438
+ path = 'mylibrary/bookshelves/{shelf}/volumes'
1439
+ command = make_simple_command(:get, path, options)
1440
+ command.response_representation = Google::Apis::BooksV1::Volumes::Representation
1441
+ command.response_class = Google::Apis::BooksV1::Volumes
1442
+ command.params['shelf'] = shelf unless shelf.nil?
1443
+ command.query['country'] = country unless country.nil?
1444
+ command.query['maxResults'] = max_results unless max_results.nil?
1445
+ command.query['projection'] = projection unless projection.nil?
1446
+ command.query['q'] = q unless q.nil?
1447
+ command.query['showPreorders'] = show_preorders unless show_preorders.nil?
1448
+ command.query['source'] = source unless source.nil?
1449
+ command.query['startIndex'] = start_index unless start_index.nil?
1450
+ command.query['fields'] = fields unless fields.nil?
1451
+ command.query['quotaUser'] = quota_user unless quota_user.nil?
1452
+ command.query['userIp'] = user_ip unless user_ip.nil?
1453
+ execute_or_queue_command(command, &block)
1454
+ end
1455
+
1456
+ # Retrieves my reading position information for a volume.
1457
+ # @param [String] volume_id
1458
+ # ID of volume for which to retrieve a reading position.
1459
+ # @param [String] content_version
1460
+ # Volume content version for which this reading position is requested.
1461
+ # @param [String] source
1462
+ # String to identify the originator of this request.
1463
+ # @param [String] fields
1464
+ # Selector specifying which fields to include in a partial response.
1465
+ # @param [String] quota_user
1466
+ # Available to use for quota purposes for server-side applications. Can be any
1467
+ # arbitrary string assigned to a user, but should not exceed 40 characters.
1468
+ # Overrides userIp if both are provided.
1469
+ # @param [String] user_ip
1470
+ # IP address of the site where the request originates. Use this if you want to
1471
+ # enforce per-user limits.
1472
+ # @param [Google::Apis::RequestOptions] options
1473
+ # Request-specific options
1474
+ #
1475
+ # @yield [result, err] Result & error if block supplied
1476
+ # @yieldparam result [Google::Apis::BooksV1::ReadingPosition] parsed result object
1477
+ # @yieldparam err [StandardError] error object if request failed
1478
+ #
1479
+ # @return [Google::Apis::BooksV1::ReadingPosition]
1480
+ #
1481
+ # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
1482
+ # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
1483
+ # @raise [Google::Apis::AuthorizationError] Authorization is required
1484
+ def get_my_library_reading_position(volume_id, content_version: nil, source: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block)
1485
+ path = 'mylibrary/readingpositions/{volumeId}'
1486
+ command = make_simple_command(:get, path, options)
1487
+ command.response_representation = Google::Apis::BooksV1::ReadingPosition::Representation
1488
+ command.response_class = Google::Apis::BooksV1::ReadingPosition
1489
+ command.params['volumeId'] = volume_id unless volume_id.nil?
1490
+ command.query['contentVersion'] = content_version unless content_version.nil?
1491
+ command.query['source'] = source unless source.nil?
1492
+ command.query['fields'] = fields unless fields.nil?
1493
+ command.query['quotaUser'] = quota_user unless quota_user.nil?
1494
+ command.query['userIp'] = user_ip unless user_ip.nil?
1495
+ execute_or_queue_command(command, &block)
1496
+ end
1497
+
1498
+ # Sets my reading position information for a volume.
1499
+ # @param [String] volume_id
1500
+ # ID of volume for which to update the reading position.
1501
+ # @param [String] action
1502
+ # Action that caused this reading position to be set.
1503
+ # @param [String] content_version
1504
+ # Volume content version for which this reading position applies.
1505
+ # @param [String] device_cookie
1506
+ # Random persistent device cookie optional on set position.
1507
+ # @param [String] position
1508
+ # Position string for the new volume reading position.
1509
+ # @param [String] source
1510
+ # String to identify the originator of this request.
1511
+ # @param [String] timestamp
1512
+ # RFC 3339 UTC format timestamp associated with this reading position.
1513
+ # @param [String] fields
1514
+ # Selector specifying which fields to include in a partial response.
1515
+ # @param [String] quota_user
1516
+ # Available to use for quota purposes for server-side applications. Can be any
1517
+ # arbitrary string assigned to a user, but should not exceed 40 characters.
1518
+ # Overrides userIp if both are provided.
1519
+ # @param [String] user_ip
1520
+ # IP address of the site where the request originates. Use this if you want to
1521
+ # enforce per-user limits.
1522
+ # @param [Google::Apis::RequestOptions] options
1523
+ # Request-specific options
1524
+ #
1525
+ # @yield [result, err] Result & error if block supplied
1526
+ # @yieldparam result [NilClass] No result returned for this method
1527
+ # @yieldparam err [StandardError] error object if request failed
1528
+ #
1529
+ # @return [void]
1530
+ #
1531
+ # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
1532
+ # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
1533
+ # @raise [Google::Apis::AuthorizationError] Authorization is required
1534
+ def set_my_library_reading_position(volume_id, action: nil, content_version: nil, device_cookie: nil, position: nil, source: nil, timestamp: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block)
1535
+ path = 'mylibrary/readingpositions/{volumeId}/setPosition'
1536
+ command = make_simple_command(:post, path, options)
1537
+ command.params['volumeId'] = volume_id unless volume_id.nil?
1538
+ command.query['action'] = action unless action.nil?
1539
+ command.query['contentVersion'] = content_version unless content_version.nil?
1540
+ command.query['deviceCookie'] = device_cookie unless device_cookie.nil?
1541
+ command.query['position'] = position unless position.nil?
1542
+ command.query['source'] = source unless source.nil?
1543
+ command.query['timestamp'] = timestamp unless timestamp.nil?
1544
+ command.query['fields'] = fields unless fields.nil?
1545
+ command.query['quotaUser'] = quota_user unless quota_user.nil?
1546
+ command.query['userIp'] = user_ip unless user_ip.nil?
1547
+ execute_or_queue_command(command, &block)
1548
+ end
1549
+
1550
+ # List categories for onboarding experience.
1551
+ # @param [String] locale
1552
+ # ISO-639-1 language and ISO-3166-1 country code. Default is en-US if unset.
1553
+ # @param [String] fields
1554
+ # Selector specifying which fields to include in a partial response.
1555
+ # @param [String] quota_user
1556
+ # Available to use for quota purposes for server-side applications. Can be any
1557
+ # arbitrary string assigned to a user, but should not exceed 40 characters.
1558
+ # Overrides userIp if both are provided.
1559
+ # @param [String] user_ip
1560
+ # IP address of the site where the request originates. Use this if you want to
1561
+ # enforce per-user limits.
1562
+ # @param [Google::Apis::RequestOptions] options
1563
+ # Request-specific options
1564
+ #
1565
+ # @yield [result, err] Result & error if block supplied
1566
+ # @yieldparam result [Google::Apis::BooksV1::Category] parsed result object
1567
+ # @yieldparam err [StandardError] error object if request failed
1568
+ #
1569
+ # @return [Google::Apis::BooksV1::Category]
1570
+ #
1571
+ # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
1572
+ # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
1573
+ # @raise [Google::Apis::AuthorizationError] Authorization is required
1574
+ def list_onboarding_categories(locale: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block)
1575
+ path = 'onboarding/listCategories'
1576
+ command = make_simple_command(:get, path, options)
1577
+ command.response_representation = Google::Apis::BooksV1::Category::Representation
1578
+ command.response_class = Google::Apis::BooksV1::Category
1579
+ command.query['locale'] = locale unless locale.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
+ # List available volumes under categories for onboarding experience.
1587
+ # @param [Array<String>, String] category_id
1588
+ # List of category ids requested.
1589
+ # @param [String] locale
1590
+ # ISO-639-1 language and ISO-3166-1 country code. Default is en-US if unset.
1591
+ # @param [String] max_allowed_maturity_rating
1592
+ # The maximum allowed maturity rating of returned volumes. Books with a higher
1593
+ # maturity rating are filtered out.
1594
+ # @param [Fixnum] page_size
1595
+ # Number of maximum results per page to be included in the response.
1596
+ # @param [String] page_token
1597
+ # The value of the nextToken from the previous page.
1598
+ # @param [String] fields
1599
+ # Selector specifying which fields to include in a partial response.
1600
+ # @param [String] quota_user
1601
+ # Available to use for quota purposes for server-side applications. Can be any
1602
+ # arbitrary string assigned to a user, but should not exceed 40 characters.
1603
+ # Overrides userIp if both are provided.
1604
+ # @param [String] user_ip
1605
+ # IP address of the site where the request originates. Use this if you want to
1606
+ # enforce per-user limits.
1607
+ # @param [Google::Apis::RequestOptions] options
1608
+ # Request-specific options
1609
+ #
1610
+ # @yield [result, err] Result & error if block supplied
1611
+ # @yieldparam result [Google::Apis::BooksV1::Volume2] parsed result object
1612
+ # @yieldparam err [StandardError] error object if request failed
1613
+ #
1614
+ # @return [Google::Apis::BooksV1::Volume2]
1615
+ #
1616
+ # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
1617
+ # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
1618
+ # @raise [Google::Apis::AuthorizationError] Authorization is required
1619
+ def list_onboarding_category_volumes(category_id: nil, locale: nil, max_allowed_maturity_rating: nil, page_size: nil, page_token: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block)
1620
+ path = 'onboarding/listCategoryVolumes'
1621
+ command = make_simple_command(:get, path, options)
1622
+ command.response_representation = Google::Apis::BooksV1::Volume2::Representation
1623
+ command.response_class = Google::Apis::BooksV1::Volume2
1624
+ command.query['categoryId'] = category_id unless category_id.nil?
1625
+ command.query['locale'] = locale unless locale.nil?
1626
+ command.query['maxAllowedMaturityRating'] = max_allowed_maturity_rating unless max_allowed_maturity_rating.nil?
1627
+ command.query['pageSize'] = page_size unless page_size.nil?
1628
+ command.query['pageToken'] = page_token unless page_token.nil?
1629
+ command.query['fields'] = fields unless fields.nil?
1630
+ command.query['quotaUser'] = quota_user unless quota_user.nil?
1631
+ command.query['userIp'] = user_ip unless user_ip.nil?
1632
+ execute_or_queue_command(command, &block)
1633
+ end
1634
+
1635
+ #
1636
+ # @param [String] android_id
1637
+ # device android_id
1638
+ # @param [String] device
1639
+ # device device
1640
+ # @param [String] manufacturer
1641
+ # device manufacturer
1642
+ # @param [String] model
1643
+ # device model
1644
+ # @param [String] offer_id
1645
+ # @param [String] product
1646
+ # device product
1647
+ # @param [String] serial
1648
+ # device serial
1649
+ # @param [String] volume_id
1650
+ # Volume id to exercise the offer
1651
+ # @param [String] fields
1652
+ # Selector specifying which fields to include in a partial response.
1653
+ # @param [String] quota_user
1654
+ # Available to use for quota purposes for server-side applications. Can be any
1655
+ # arbitrary string assigned to a user, but should not exceed 40 characters.
1656
+ # Overrides userIp if both are provided.
1657
+ # @param [String] user_ip
1658
+ # IP address of the site where the request originates. Use this if you want to
1659
+ # enforce per-user limits.
1660
+ # @param [Google::Apis::RequestOptions] options
1661
+ # Request-specific options
1662
+ #
1663
+ # @yield [result, err] Result & error if block supplied
1664
+ # @yieldparam result [NilClass] No result returned for this method
1665
+ # @yieldparam err [StandardError] error object if request failed
1666
+ #
1667
+ # @return [void]
1668
+ #
1669
+ # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
1670
+ # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
1671
+ # @raise [Google::Apis::AuthorizationError] Authorization is required
1672
+ def accept_promo_offer(android_id: nil, device: nil, manufacturer: nil, model: nil, offer_id: nil, product: nil, serial: nil, volume_id: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block)
1673
+ path = 'promooffer/accept'
1674
+ command = make_simple_command(:post, path, options)
1675
+ command.query['androidId'] = android_id unless android_id.nil?
1676
+ command.query['device'] = device unless device.nil?
1677
+ command.query['manufacturer'] = manufacturer unless manufacturer.nil?
1678
+ command.query['model'] = model unless model.nil?
1679
+ command.query['offerId'] = offer_id unless offer_id.nil?
1680
+ command.query['product'] = product unless product.nil?
1681
+ command.query['serial'] = serial unless serial.nil?
1682
+ command.query['volumeId'] = volume_id unless volume_id.nil?
1683
+ command.query['fields'] = fields unless fields.nil?
1684
+ command.query['quotaUser'] = quota_user unless quota_user.nil?
1685
+ command.query['userIp'] = user_ip unless user_ip.nil?
1686
+ execute_or_queue_command(command, &block)
1687
+ end
1688
+
1689
+ #
1690
+ # @param [String] android_id
1691
+ # device android_id
1692
+ # @param [String] device
1693
+ # device device
1694
+ # @param [String] manufacturer
1695
+ # device manufacturer
1696
+ # @param [String] model
1697
+ # device model
1698
+ # @param [String] offer_id
1699
+ # Offer to dimiss
1700
+ # @param [String] product
1701
+ # device product
1702
+ # @param [String] serial
1703
+ # device serial
1704
+ # @param [String] fields
1705
+ # Selector specifying which fields to include in a partial response.
1706
+ # @param [String] quota_user
1707
+ # Available to use for quota purposes for server-side applications. Can be any
1708
+ # arbitrary string assigned to a user, but should not exceed 40 characters.
1709
+ # Overrides userIp if both are provided.
1710
+ # @param [String] user_ip
1711
+ # IP address of the site where the request originates. Use this if you want to
1712
+ # enforce per-user limits.
1713
+ # @param [Google::Apis::RequestOptions] options
1714
+ # Request-specific options
1715
+ #
1716
+ # @yield [result, err] Result & error if block supplied
1717
+ # @yieldparam result [NilClass] No result returned for this method
1718
+ # @yieldparam err [StandardError] error object if request failed
1719
+ #
1720
+ # @return [void]
1721
+ #
1722
+ # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
1723
+ # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
1724
+ # @raise [Google::Apis::AuthorizationError] Authorization is required
1725
+ def dismiss_promo_offer(android_id: nil, device: nil, manufacturer: nil, model: nil, offer_id: nil, product: nil, serial: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block)
1726
+ path = 'promooffer/dismiss'
1727
+ command = make_simple_command(:post, path, options)
1728
+ command.query['androidId'] = android_id unless android_id.nil?
1729
+ command.query['device'] = device unless device.nil?
1730
+ command.query['manufacturer'] = manufacturer unless manufacturer.nil?
1731
+ command.query['model'] = model unless model.nil?
1732
+ command.query['offerId'] = offer_id unless offer_id.nil?
1733
+ command.query['product'] = product unless product.nil?
1734
+ command.query['serial'] = serial unless serial.nil?
1735
+ command.query['fields'] = fields unless fields.nil?
1736
+ command.query['quotaUser'] = quota_user unless quota_user.nil?
1737
+ command.query['userIp'] = user_ip unless user_ip.nil?
1738
+ execute_or_queue_command(command, &block)
1739
+ end
1740
+
1741
+ # Returns a list of promo offers available to the user
1742
+ # @param [String] android_id
1743
+ # device android_id
1744
+ # @param [String] device
1745
+ # device device
1746
+ # @param [String] manufacturer
1747
+ # device manufacturer
1748
+ # @param [String] model
1749
+ # device model
1750
+ # @param [String] product
1751
+ # device product
1752
+ # @param [String] serial
1753
+ # device serial
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::BooksV1::Offers] parsed result object
1768
+ # @yieldparam err [StandardError] error object if request failed
1769
+ #
1770
+ # @return [Google::Apis::BooksV1::Offers]
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 get_promo_offer(android_id: nil, device: nil, manufacturer: nil, model: nil, product: nil, serial: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block)
1776
+ path = 'promooffer/get'
1777
+ command = make_simple_command(:get, path, options)
1778
+ command.response_representation = Google::Apis::BooksV1::Offers::Representation
1779
+ command.response_class = Google::Apis::BooksV1::Offers
1780
+ command.query['androidId'] = android_id unless android_id.nil?
1781
+ command.query['device'] = device unless device.nil?
1782
+ command.query['manufacturer'] = manufacturer unless manufacturer.nil?
1783
+ command.query['model'] = model unless model.nil?
1784
+ command.query['product'] = product unless product.nil?
1785
+ command.query['serial'] = serial unless serial.nil?
1786
+ command.query['fields'] = fields unless fields.nil?
1787
+ command.query['quotaUser'] = quota_user unless quota_user.nil?
1788
+ command.query['userIp'] = user_ip unless user_ip.nil?
1789
+ execute_or_queue_command(command, &block)
1790
+ end
1791
+
1792
+ # Gets volume information for a single volume.
1793
+ # @param [String] volume_id
1794
+ # ID of volume to retrieve.
1795
+ # @param [String] country
1796
+ # ISO-3166-1 code to override the IP-based location.
1797
+ # @param [String] partner
1798
+ # Brand results for partner ID.
1799
+ # @param [String] projection
1800
+ # Restrict information returned to a set of selected fields.
1801
+ # @param [String] source
1802
+ # String to identify the originator of this request.
1803
+ # @param [Boolean] user_library_consistent_read
1804
+ # @param [String] fields
1805
+ # Selector specifying which fields to include in a partial response.
1806
+ # @param [String] quota_user
1807
+ # Available to use for quota purposes for server-side applications. Can be any
1808
+ # arbitrary string assigned to a user, but should not exceed 40 characters.
1809
+ # Overrides userIp if both are provided.
1810
+ # @param [String] user_ip
1811
+ # IP address of the site where the request originates. Use this if you want to
1812
+ # enforce per-user limits.
1813
+ # @param [Google::Apis::RequestOptions] options
1814
+ # Request-specific options
1815
+ #
1816
+ # @yield [result, err] Result & error if block supplied
1817
+ # @yieldparam result [Google::Apis::BooksV1::Volume] parsed result object
1818
+ # @yieldparam err [StandardError] error object if request failed
1819
+ #
1820
+ # @return [Google::Apis::BooksV1::Volume]
1821
+ #
1822
+ # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
1823
+ # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
1824
+ # @raise [Google::Apis::AuthorizationError] Authorization is required
1825
+ def get_volume(volume_id, country: nil, partner: nil, projection: nil, source: nil, user_library_consistent_read: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block)
1826
+ path = 'volumes/{volumeId}'
1827
+ command = make_simple_command(:get, path, options)
1828
+ command.response_representation = Google::Apis::BooksV1::Volume::Representation
1829
+ command.response_class = Google::Apis::BooksV1::Volume
1830
+ command.params['volumeId'] = volume_id unless volume_id.nil?
1831
+ command.query['country'] = country unless country.nil?
1832
+ command.query['partner'] = partner unless partner.nil?
1833
+ command.query['projection'] = projection unless projection.nil?
1834
+ command.query['source'] = source unless source.nil?
1835
+ command.query['user_library_consistent_read'] = user_library_consistent_read unless user_library_consistent_read.nil?
1836
+ command.query['fields'] = fields unless fields.nil?
1837
+ command.query['quotaUser'] = quota_user unless quota_user.nil?
1838
+ command.query['userIp'] = user_ip unless user_ip.nil?
1839
+ execute_or_queue_command(command, &block)
1840
+ end
1841
+
1842
+ # Performs a book search.
1843
+ # @param [String] download
1844
+ # Restrict to volumes by download availability.
1845
+ # @param [String] filter
1846
+ # Filter search results.
1847
+ # @param [String] lang_restrict
1848
+ # Restrict results to books with this language code.
1849
+ # @param [String] library_restrict
1850
+ # Restrict search to this user's library.
1851
+ # @param [Fixnum] max_results
1852
+ # Maximum number of results to return.
1853
+ # @param [String] order_by
1854
+ # Sort search results.
1855
+ # @param [String] partner
1856
+ # Restrict and brand results for partner ID.
1857
+ # @param [String] print_type
1858
+ # Restrict to books or magazines.
1859
+ # @param [String] projection
1860
+ # Restrict information returned to a set of selected fields.
1861
+ # @param [String] q
1862
+ # Full-text search query string.
1863
+ # @param [Boolean] show_preorders
1864
+ # Set to true to show books available for preorder. Defaults to false.
1865
+ # @param [String] source
1866
+ # String to identify the originator of this request.
1867
+ # @param [Fixnum] start_index
1868
+ # Index of the first result to return (starts at 0)
1869
+ # @param [String] fields
1870
+ # Selector specifying which fields to include in a partial response.
1871
+ # @param [String] quota_user
1872
+ # Available to use for quota purposes for server-side applications. Can be any
1873
+ # arbitrary string assigned to a user, but should not exceed 40 characters.
1874
+ # Overrides userIp if both are provided.
1875
+ # @param [String] user_ip
1876
+ # IP address of the site where the request originates. Use this if you want to
1877
+ # enforce per-user limits.
1878
+ # @param [Google::Apis::RequestOptions] options
1879
+ # Request-specific options
1880
+ #
1881
+ # @yield [result, err] Result & error if block supplied
1882
+ # @yieldparam result [Google::Apis::BooksV1::Volumes] parsed result object
1883
+ # @yieldparam err [StandardError] error object if request failed
1884
+ #
1885
+ # @return [Google::Apis::BooksV1::Volumes]
1886
+ #
1887
+ # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
1888
+ # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
1889
+ # @raise [Google::Apis::AuthorizationError] Authorization is required
1890
+ def list_volumes(download: nil, filter: nil, lang_restrict: nil, library_restrict: nil, max_results: nil, order_by: nil, partner: nil, print_type: nil, projection: nil, q: nil, show_preorders: nil, source: nil, start_index: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block)
1891
+ path = 'volumes'
1892
+ command = make_simple_command(:get, path, options)
1893
+ command.response_representation = Google::Apis::BooksV1::Volumes::Representation
1894
+ command.response_class = Google::Apis::BooksV1::Volumes
1895
+ command.query['download'] = download unless download.nil?
1896
+ command.query['filter'] = filter unless filter.nil?
1897
+ command.query['langRestrict'] = lang_restrict unless lang_restrict.nil?
1898
+ command.query['libraryRestrict'] = library_restrict unless library_restrict.nil?
1899
+ command.query['maxResults'] = max_results unless max_results.nil?
1900
+ command.query['orderBy'] = order_by unless order_by.nil?
1901
+ command.query['partner'] = partner unless partner.nil?
1902
+ command.query['printType'] = print_type unless print_type.nil?
1903
+ command.query['projection'] = projection unless projection.nil?
1904
+ command.query['q'] = q unless q.nil?
1905
+ command.query['showPreorders'] = show_preorders unless show_preorders.nil?
1906
+ command.query['source'] = source unless source.nil?
1907
+ command.query['startIndex'] = start_index unless start_index.nil?
1908
+ command.query['fields'] = fields unless fields.nil?
1909
+ command.query['quotaUser'] = quota_user unless quota_user.nil?
1910
+ command.query['userIp'] = user_ip unless user_ip.nil?
1911
+ execute_or_queue_command(command, &block)
1912
+ end
1913
+
1914
+ # Return a list of associated books.
1915
+ # @param [String] volume_id
1916
+ # ID of the source volume.
1917
+ # @param [String] association
1918
+ # Association type.
1919
+ # @param [String] locale
1920
+ # ISO-639-1 language and ISO-3166-1 country code. Ex: 'en_US'. Used for
1921
+ # generating recommendations.
1922
+ # @param [String] max_allowed_maturity_rating
1923
+ # The maximum allowed maturity rating of returned recommendations. Books with a
1924
+ # higher maturity rating are filtered out.
1925
+ # @param [String] source
1926
+ # String to identify the originator of this request.
1927
+ # @param [String] fields
1928
+ # Selector specifying which fields to include in a partial response.
1929
+ # @param [String] quota_user
1930
+ # Available to use for quota purposes for server-side applications. Can be any
1931
+ # arbitrary string assigned to a user, but should not exceed 40 characters.
1932
+ # Overrides userIp if both are provided.
1933
+ # @param [String] user_ip
1934
+ # IP address of the site where the request originates. Use this if you want to
1935
+ # enforce per-user limits.
1936
+ # @param [Google::Apis::RequestOptions] options
1937
+ # Request-specific options
1938
+ #
1939
+ # @yield [result, err] Result & error if block supplied
1940
+ # @yieldparam result [Google::Apis::BooksV1::Volumes] parsed result object
1941
+ # @yieldparam err [StandardError] error object if request failed
1942
+ #
1943
+ # @return [Google::Apis::BooksV1::Volumes]
1944
+ #
1945
+ # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
1946
+ # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
1947
+ # @raise [Google::Apis::AuthorizationError] Authorization is required
1948
+ def list_associated_volumes(volume_id, association: nil, locale: nil, max_allowed_maturity_rating: nil, source: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block)
1949
+ path = 'volumes/{volumeId}/associated'
1950
+ command = make_simple_command(:get, path, options)
1951
+ command.response_representation = Google::Apis::BooksV1::Volumes::Representation
1952
+ command.response_class = Google::Apis::BooksV1::Volumes
1953
+ command.params['volumeId'] = volume_id unless volume_id.nil?
1954
+ command.query['association'] = association unless association.nil?
1955
+ command.query['locale'] = locale unless locale.nil?
1956
+ command.query['maxAllowedMaturityRating'] = max_allowed_maturity_rating unless max_allowed_maturity_rating.nil?
1957
+ command.query['source'] = source unless source.nil?
1958
+ command.query['fields'] = fields unless fields.nil?
1959
+ command.query['quotaUser'] = quota_user unless quota_user.nil?
1960
+ command.query['userIp'] = user_ip unless user_ip.nil?
1961
+ execute_or_queue_command(command, &block)
1962
+ end
1963
+
1964
+ # Return a list of books in My Library.
1965
+ # @param [Array<String>, String] acquire_method
1966
+ # How the book was aquired
1967
+ # @param [String] locale
1968
+ # ISO-639-1 language and ISO-3166-1 country code. Ex:'en_US'. Used for
1969
+ # generating recommendations.
1970
+ # @param [Fixnum] max_results
1971
+ # Maximum number of results to return.
1972
+ # @param [Array<String>, String] processing_state
1973
+ # The processing state of the user uploaded volumes to be returned. Applicable
1974
+ # only if the UPLOADED is specified in the acquireMethod.
1975
+ # @param [String] source
1976
+ # String to identify the originator of this request.
1977
+ # @param [Fixnum] start_index
1978
+ # Index of the first result to return (starts at 0)
1979
+ # @param [String] fields
1980
+ # Selector specifying which fields to include in a partial response.
1981
+ # @param [String] quota_user
1982
+ # Available to use for quota purposes for server-side applications. Can be any
1983
+ # arbitrary string assigned to a user, but should not exceed 40 characters.
1984
+ # Overrides userIp if both are provided.
1985
+ # @param [String] user_ip
1986
+ # IP address of the site where the request originates. Use this if you want to
1987
+ # enforce per-user limits.
1988
+ # @param [Google::Apis::RequestOptions] options
1989
+ # Request-specific options
1990
+ #
1991
+ # @yield [result, err] Result & error if block supplied
1992
+ # @yieldparam result [Google::Apis::BooksV1::Volumes] parsed result object
1993
+ # @yieldparam err [StandardError] error object if request failed
1994
+ #
1995
+ # @return [Google::Apis::BooksV1::Volumes]
1996
+ #
1997
+ # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
1998
+ # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
1999
+ # @raise [Google::Apis::AuthorizationError] Authorization is required
2000
+ def list_my_books(acquire_method: nil, locale: nil, max_results: nil, processing_state: nil, source: nil, start_index: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block)
2001
+ path = 'volumes/mybooks'
2002
+ command = make_simple_command(:get, path, options)
2003
+ command.response_representation = Google::Apis::BooksV1::Volumes::Representation
2004
+ command.response_class = Google::Apis::BooksV1::Volumes
2005
+ command.query['acquireMethod'] = acquire_method unless acquire_method.nil?
2006
+ command.query['locale'] = locale unless locale.nil?
2007
+ command.query['maxResults'] = max_results unless max_results.nil?
2008
+ command.query['processingState'] = processing_state unless processing_state.nil?
2009
+ command.query['source'] = source unless source.nil?
2010
+ command.query['startIndex'] = start_index unless start_index.nil?
2011
+ command.query['fields'] = fields unless fields.nil?
2012
+ command.query['quotaUser'] = quota_user unless quota_user.nil?
2013
+ command.query['userIp'] = user_ip unless user_ip.nil?
2014
+ execute_or_queue_command(command, &block)
2015
+ end
2016
+
2017
+ # Return a list of recommended books for the current user.
2018
+ # @param [String] locale
2019
+ # ISO-639-1 language and ISO-3166-1 country code. Ex: 'en_US'. Used for
2020
+ # generating recommendations.
2021
+ # @param [String] max_allowed_maturity_rating
2022
+ # The maximum allowed maturity rating of returned recommendations. Books with a
2023
+ # higher maturity rating are filtered out.
2024
+ # @param [String] source
2025
+ # String to identify the originator of this request.
2026
+ # @param [String] fields
2027
+ # Selector specifying which fields to include in a partial response.
2028
+ # @param [String] quota_user
2029
+ # Available to use for quota purposes for server-side applications. Can be any
2030
+ # arbitrary string assigned to a user, but should not exceed 40 characters.
2031
+ # Overrides userIp if both are provided.
2032
+ # @param [String] user_ip
2033
+ # IP address of the site where the request originates. Use this if you want to
2034
+ # enforce per-user limits.
2035
+ # @param [Google::Apis::RequestOptions] options
2036
+ # Request-specific options
2037
+ #
2038
+ # @yield [result, err] Result & error if block supplied
2039
+ # @yieldparam result [Google::Apis::BooksV1::Volumes] parsed result object
2040
+ # @yieldparam err [StandardError] error object if request failed
2041
+ #
2042
+ # @return [Google::Apis::BooksV1::Volumes]
2043
+ #
2044
+ # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
2045
+ # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
2046
+ # @raise [Google::Apis::AuthorizationError] Authorization is required
2047
+ def list_recommended_volumes(locale: nil, max_allowed_maturity_rating: nil, source: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block)
2048
+ path = 'volumes/recommended'
2049
+ command = make_simple_command(:get, path, options)
2050
+ command.response_representation = Google::Apis::BooksV1::Volumes::Representation
2051
+ command.response_class = Google::Apis::BooksV1::Volumes
2052
+ command.query['locale'] = locale unless locale.nil?
2053
+ command.query['maxAllowedMaturityRating'] = max_allowed_maturity_rating unless max_allowed_maturity_rating.nil?
2054
+ command.query['source'] = source unless source.nil?
2055
+ command.query['fields'] = fields unless fields.nil?
2056
+ command.query['quotaUser'] = quota_user unless quota_user.nil?
2057
+ command.query['userIp'] = user_ip unless user_ip.nil?
2058
+ execute_or_queue_command(command, &block)
2059
+ end
2060
+
2061
+ # Rate a recommended book for the current user.
2062
+ # @param [String] locale
2063
+ # ISO-639-1 language and ISO-3166-1 country code. Ex: 'en_US'. Used for
2064
+ # generating recommendations.
2065
+ # @param [String] rating
2066
+ # Rating to be given to the volume.
2067
+ # @param [String] source
2068
+ # String to identify the originator of this request.
2069
+ # @param [String] volume_id
2070
+ # ID of the source volume.
2071
+ # @param [String] fields
2072
+ # Selector specifying which fields to include in a partial response.
2073
+ # @param [String] quota_user
2074
+ # Available to use for quota purposes for server-side applications. Can be any
2075
+ # arbitrary string assigned to a user, but should not exceed 40 characters.
2076
+ # Overrides userIp if both are provided.
2077
+ # @param [String] user_ip
2078
+ # IP address of the site where the request originates. Use this if you want to
2079
+ # enforce per-user limits.
2080
+ # @param [Google::Apis::RequestOptions] options
2081
+ # Request-specific options
2082
+ #
2083
+ # @yield [result, err] Result & error if block supplied
2084
+ # @yieldparam result [Google::Apis::BooksV1::RateRecommendedVolumeResponse] parsed result object
2085
+ # @yieldparam err [StandardError] error object if request failed
2086
+ #
2087
+ # @return [Google::Apis::BooksV1::RateRecommendedVolumeResponse]
2088
+ #
2089
+ # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
2090
+ # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
2091
+ # @raise [Google::Apis::AuthorizationError] Authorization is required
2092
+ def rate_recommended_volume(locale: nil, rating: nil, source: nil, volume_id: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block)
2093
+ path = 'volumes/recommended/rate'
2094
+ command = make_simple_command(:post, path, options)
2095
+ command.response_representation = Google::Apis::BooksV1::RateRecommendedVolumeResponse::Representation
2096
+ command.response_class = Google::Apis::BooksV1::RateRecommendedVolumeResponse
2097
+ command.query['locale'] = locale unless locale.nil?
2098
+ command.query['rating'] = rating unless rating.nil?
2099
+ command.query['source'] = source unless source.nil?
2100
+ command.query['volumeId'] = volume_id unless volume_id.nil?
2101
+ command.query['fields'] = fields unless fields.nil?
2102
+ command.query['quotaUser'] = quota_user unless quota_user.nil?
2103
+ command.query['userIp'] = user_ip unless user_ip.nil?
2104
+ execute_or_queue_command(command, &block)
2105
+ end
2106
+
2107
+ # Return a list of books uploaded by the current user.
2108
+ # @param [String] locale
2109
+ # ISO-639-1 language and ISO-3166-1 country code. Ex: 'en_US'. Used for
2110
+ # generating recommendations.
2111
+ # @param [Fixnum] max_results
2112
+ # Maximum number of results to return.
2113
+ # @param [Array<String>, String] processing_state
2114
+ # The processing state of the user uploaded volumes to be returned.
2115
+ # @param [String] source
2116
+ # String to identify the originator of this request.
2117
+ # @param [Fixnum] start_index
2118
+ # Index of the first result to return (starts at 0)
2119
+ # @param [Array<String>, String] volume_id
2120
+ # The ids of the volumes to be returned. If not specified all that match the
2121
+ # processingState are returned.
2122
+ # @param [String] fields
2123
+ # Selector specifying which fields to include in a partial response.
2124
+ # @param [String] quota_user
2125
+ # Available to use for quota purposes for server-side applications. Can be any
2126
+ # arbitrary string assigned to a user, but should not exceed 40 characters.
2127
+ # Overrides userIp if both are provided.
2128
+ # @param [String] user_ip
2129
+ # IP address of the site where the request originates. Use this if you want to
2130
+ # enforce per-user limits.
2131
+ # @param [Google::Apis::RequestOptions] options
2132
+ # Request-specific options
2133
+ #
2134
+ # @yield [result, err] Result & error if block supplied
2135
+ # @yieldparam result [Google::Apis::BooksV1::Volumes] parsed result object
2136
+ # @yieldparam err [StandardError] error object if request failed
2137
+ #
2138
+ # @return [Google::Apis::BooksV1::Volumes]
2139
+ #
2140
+ # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
2141
+ # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
2142
+ # @raise [Google::Apis::AuthorizationError] Authorization is required
2143
+ def list_user_uploaded_volumes(locale: nil, max_results: nil, processing_state: nil, source: nil, start_index: nil, volume_id: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block)
2144
+ path = 'volumes/useruploaded'
2145
+ command = make_simple_command(:get, path, options)
2146
+ command.response_representation = Google::Apis::BooksV1::Volumes::Representation
2147
+ command.response_class = Google::Apis::BooksV1::Volumes
2148
+ command.query['locale'] = locale unless locale.nil?
2149
+ command.query['maxResults'] = max_results unless max_results.nil?
2150
+ command.query['processingState'] = processing_state unless processing_state.nil?
2151
+ command.query['source'] = source unless source.nil?
2152
+ command.query['startIndex'] = start_index unless start_index.nil?
2153
+ command.query['volumeId'] = volume_id unless volume_id.nil?
2154
+ command.query['fields'] = fields unless fields.nil?
2155
+ command.query['quotaUser'] = quota_user unless quota_user.nil?
2156
+ command.query['userIp'] = user_ip unless user_ip.nil?
2157
+ execute_or_queue_command(command, &block)
2158
+ end
2159
+
2160
+ protected
2161
+
2162
+ def apply_command_defaults(command)
2163
+ command.query['key'] = key unless key.nil?
2164
+ command.query['quotaUser'] = quota_user unless quota_user.nil?
2165
+ command.query['userIp'] = user_ip unless user_ip.nil?
2166
+ end
2167
+ end
2168
+ end
2169
+ end
2170
+ end