lemboy-google-api-client 0.9.26

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