google-api-client 0.8.3 → 0.9
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.
- checksums.yaml +4 -4
- data/.gitignore +20 -0
- data/.rspec +2 -0
- data/.rubocop.yml +7 -0
- data/.rubocop_todo.yml +63 -0
- data/.travis.yml +22 -0
- data/.yardopts +12 -0
- data/CHANGELOG.md +52 -2
- data/CONTRIBUTING.md +31 -0
- data/Gemfile +35 -1
- data/MIGRATING.md +171 -0
- data/README.md +181 -148
- data/Rakefile +1 -40
- data/api_names.yaml +1036 -0
- data/api_names_out.yaml +26053 -0
- data/bin/generate-api +95 -0
- data/generated/google/apis/adexchangebuyer_v1_3/classes.rb +1335 -0
- data/generated/google/apis/adexchangebuyer_v1_3/representations.rb +446 -0
- data/generated/google/apis/adexchangebuyer_v1_3/service.rb +872 -0
- data/generated/google/apis/adexchangebuyer_v1_3.rb +35 -0
- data/generated/google/apis/adexchangeseller_v2_0/classes.rb +792 -0
- data/generated/google/apis/adexchangeseller_v2_0/representations.rb +309 -0
- data/generated/google/apis/adexchangeseller_v2_0/service.rb +668 -0
- data/generated/google/apis/adexchangeseller_v2_0.rb +38 -0
- data/generated/google/apis/admin_datatransfer_v1/classes.rb +267 -0
- data/generated/google/apis/admin_datatransfer_v1/representations.rb +118 -0
- data/generated/google/apis/admin_datatransfer_v1/service.rb +262 -0
- data/generated/google/apis/admin_datatransfer_v1.rb +37 -0
- data/generated/google/apis/admin_directory_v1/classes.rb +3141 -0
- data/generated/google/apis/admin_directory_v1/representations.rb +1029 -0
- data/generated/google/apis/admin_directory_v1/service.rb +3818 -0
- data/generated/google/apis/admin_directory_v1.rb +113 -0
- data/generated/google/apis/admin_reports_v1/classes.rb +582 -0
- data/generated/google/apis/admin_reports_v1/representations.rb +231 -0
- data/generated/google/apis/admin_reports_v1/service.rb +336 -0
- data/generated/google/apis/admin_reports_v1.rb +38 -0
- data/generated/google/apis/adsense_v1_4/classes.rb +1285 -0
- data/generated/google/apis/adsense_v1_4/representations.rb +494 -0
- data/generated/google/apis/adsense_v1_4/service.rb +1714 -0
- data/generated/google/apis/adsense_v1_4.rb +38 -0
- data/generated/google/apis/adsensehost_v4_1/classes.rb +834 -0
- data/generated/google/apis/adsensehost_v4_1/representations.rb +327 -0
- data/generated/google/apis/adsensehost_v4_1/service.rb +1164 -0
- data/generated/google/apis/adsensehost_v4_1.rb +35 -0
- data/generated/google/apis/analytics_v3/classes.rb +5118 -0
- data/generated/google/apis/analytics_v3/representations.rb +1662 -0
- data/generated/google/apis/analytics_v3/service.rb +3568 -0
- data/generated/google/apis/analytics_v3.rb +49 -0
- data/generated/google/apis/androidenterprise_v1/classes.rb +1443 -0
- data/generated/google/apis/androidenterprise_v1/representations.rb +538 -0
- data/generated/google/apis/androidenterprise_v1/service.rb +2602 -0
- data/generated/google/apis/androidenterprise_v1.rb +35 -0
- data/generated/google/apis/androidpublisher_v2/classes.rb +1411 -0
- data/generated/google/apis/androidpublisher_v2/representations.rb +646 -0
- data/generated/google/apis/androidpublisher_v2/service.rb +2338 -0
- data/generated/google/apis/androidpublisher_v2.rb +34 -0
- data/generated/google/apis/appengine_v1beta4/classes.rb +1532 -0
- data/generated/google/apis/appengine_v1beta4/representations.rb +526 -0
- data/generated/google/apis/appengine_v1beta4/service.rb +476 -0
- data/generated/google/apis/appengine_v1beta4.rb +35 -0
- data/generated/google/apis/appsactivity_v1/classes.rb +392 -0
- data/generated/google/apis/appsactivity_v1/representations.rb +184 -0
- data/generated/google/apis/appsactivity_v1/service.rb +128 -0
- data/generated/google/apis/appsactivity_v1.rb +46 -0
- data/generated/google/apis/appstate_v1/classes.rb +154 -0
- data/generated/google/apis/appstate_v1/representations.rb +79 -0
- data/generated/google/apis/appstate_v1/service.rb +260 -0
- data/generated/google/apis/appstate_v1.rb +34 -0
- data/generated/google/apis/autoscaler_v1beta2/classes.rb +747 -0
- data/generated/google/apis/autoscaler_v1beta2/representations.rb +281 -0
- data/generated/google/apis/autoscaler_v1beta2/service.rb +478 -0
- data/generated/google/apis/autoscaler_v1beta2.rb +38 -0
- data/generated/google/apis/bigquery_v2/classes.rb +2471 -0
- data/generated/google/apis/bigquery_v2/representations.rb +816 -0
- data/generated/google/apis/bigquery_v2/service.rb +982 -0
- data/generated/google/apis/bigquery_v2.rb +52 -0
- data/generated/google/apis/blogger_v3/classes.rb +1354 -0
- data/generated/google/apis/blogger_v3/representations.rb +562 -0
- data/generated/google/apis/blogger_v3/service.rb +1587 -0
- data/generated/google/apis/blogger_v3.rb +37 -0
- data/generated/google/apis/books_v1/classes.rb +3956 -0
- data/generated/google/apis/books_v1/representations.rb +1538 -0
- data/generated/google/apis/books_v1/service.rb +2290 -0
- data/generated/google/apis/books_v1.rb +34 -0
- data/generated/google/apis/calendar_v3/classes.rb +1742 -0
- data/generated/google/apis/calendar_v3/representations.rb +567 -0
- data/generated/google/apis/calendar_v3/service.rb +1968 -0
- data/generated/google/apis/calendar_v3.rb +37 -0
- data/generated/google/apis/civicinfo_v2/classes.rb +1127 -0
- data/generated/google/apis/civicinfo_v2/representations.rb +383 -0
- data/generated/google/apis/civicinfo_v2/service.rb +279 -0
- data/{lib/google/api_client/service_account.rb → generated/google/apis/civicinfo_v2.rb} +18 -8
- data/generated/google/apis/classroom_v1/classes.rb +512 -0
- data/generated/google/apis/classroom_v1/representations.rb +217 -0
- data/generated/google/apis/classroom_v1/service.rb +970 -0
- data/generated/google/apis/classroom_v1.rb +49 -0
- data/generated/google/apis/classroom_v1beta1/classes.rb +447 -0
- data/generated/google/apis/classroom_v1beta1/representations.rb +190 -0
- data/generated/google/apis/classroom_v1beta1/service.rb +791 -0
- data/generated/google/apis/classroom_v1beta1.rb +49 -0
- data/generated/google/apis/cloudbilling_v1/classes.rb +169 -0
- data/generated/google/apis/cloudbilling_v1/representations.rb +79 -0
- data/generated/google/apis/cloudbilling_v1/service.rb +258 -0
- data/generated/google/apis/cloudbilling_v1.rb +35 -0
- data/generated/google/apis/clouddebugger_v2/classes.rb +1004 -0
- data/generated/google/apis/clouddebugger_v2/representations.rb +410 -0
- data/generated/google/apis/clouddebugger_v2/service.rb +370 -0
- data/generated/google/apis/clouddebugger_v2.rb +41 -0
- data/generated/google/apis/cloudmonitoring_v2beta2/classes.rb +679 -0
- data/generated/google/apis/cloudmonitoring_v2beta2/representations.rb +311 -0
- data/generated/google/apis/cloudmonitoring_v2beta2/service.rb +452 -0
- data/generated/google/apis/cloudmonitoring_v2beta2.rb +37 -0
- data/generated/google/apis/cloudresourcemanager_v1beta1/classes.rb +437 -0
- data/generated/google/apis/cloudresourcemanager_v1beta1/representations.rb +188 -0
- data/generated/google/apis/cloudresourcemanager_v1beta1/service.rb +623 -0
- data/generated/google/apis/cloudresourcemanager_v1beta1.rb +38 -0
- data/generated/google/apis/cloudtrace_v1/classes.rb +188 -0
- data/generated/google/apis/cloudtrace_v1/representations.rb +92 -0
- data/generated/google/apis/cloudtrace_v1/service.rb +190 -0
- data/generated/google/apis/cloudtrace_v1.rb +35 -0
- data/generated/google/apis/clouduseraccounts_beta/classes.rb +823 -0
- data/generated/google/apis/clouduseraccounts_beta/representations.rb +313 -0
- data/generated/google/apis/clouduseraccounts_beta/service.rb +854 -0
- data/generated/google/apis/clouduseraccounts_beta.rb +43 -0
- data/generated/google/apis/compute_beta/classes.rb +9128 -0
- data/generated/google/apis/compute_beta/representations.rb +3048 -0
- data/generated/google/apis/compute_beta/service.rb +10154 -0
- data/generated/google/apis/compute_beta.rb +49 -0
- data/generated/google/apis/compute_v1/classes.rb +8681 -0
- data/generated/google/apis/compute_v1/representations.rb +2895 -0
- data/generated/google/apis/compute_v1/service.rb +9252 -0
- data/generated/google/apis/compute_v1.rb +49 -0
- data/generated/google/apis/container_v1/classes.rb +463 -0
- data/generated/google/apis/container_v1/representations.rb +175 -0
- data/generated/google/apis/container_v1/service.rb +367 -0
- data/generated/google/apis/container_v1.rb +35 -0
- data/generated/google/apis/container_v1beta1/classes.rb +466 -0
- data/generated/google/apis/container_v1beta1/representations.rb +177 -0
- data/generated/google/apis/container_v1beta1/service.rb +394 -0
- data/generated/google/apis/container_v1beta1.rb +35 -0
- data/generated/google/apis/content_v2/classes.rb +5986 -0
- data/generated/google/apis/content_v2/representations.rb +2288 -0
- data/generated/google/apis/content_v2/service.rb +2338 -0
- data/generated/google/apis/content_v2.rb +35 -0
- data/generated/google/apis/coordinate_v1/classes.rb +669 -0
- data/generated/google/apis/coordinate_v1/representations.rb +285 -0
- data/generated/google/apis/coordinate_v1/service.rb +678 -0
- data/generated/google/apis/coordinate_v1.rb +37 -0
- data/generated/google/apis/customsearch_v1/classes.rb +771 -0
- data/generated/google/apis/customsearch_v1/representations.rb +276 -0
- data/generated/google/apis/customsearch_v1/service.rb +207 -0
- data/{lib/google/api_client/auth/compute_service_account.rb → generated/google/apis/customsearch_v1.rb} +13 -10
- data/generated/google/apis/datastore_v1beta2/classes.rb +1186 -0
- data/generated/google/apis/datastore_v1beta2/representations.rb +526 -0
- data/generated/google/apis/datastore_v1beta2/service.rb +294 -0
- data/generated/google/apis/datastore_v1beta2.rb +40 -0
- data/generated/google/apis/deploymentmanager_v2/classes.rb +1091 -0
- data/generated/google/apis/deploymentmanager_v2/representations.rb +422 -0
- data/generated/google/apis/deploymentmanager_v2/service.rb +857 -0
- data/generated/google/apis/deploymentmanager_v2.rb +44 -0
- data/generated/google/apis/deploymentmanager_v2beta2/classes.rb +843 -0
- data/generated/google/apis/deploymentmanager_v2beta2/representations.rb +306 -0
- data/generated/google/apis/deploymentmanager_v2beta2/service.rb +689 -0
- data/generated/google/apis/deploymentmanager_v2beta2.rb +44 -0
- data/generated/google/apis/dfareporting_v2_1/classes.rb +10770 -0
- data/generated/google/apis/dfareporting_v2_1/representations.rb +3438 -0
- data/generated/google/apis/dfareporting_v2_1/service.rb +8585 -0
- data/generated/google/apis/dfareporting_v2_1.rb +37 -0
- data/generated/google/apis/discovery_v1/classes.rb +961 -0
- data/generated/google/apis/discovery_v1/representations.rb +357 -0
- data/generated/google/apis/discovery_v1/service.rb +142 -0
- data/generated/google/apis/discovery_v1.rb +32 -0
- data/generated/google/apis/dns_v1/classes.rb +406 -0
- data/generated/google/apis/dns_v1/representations.rb +151 -0
- data/generated/google/apis/dns_v1/service.rb +454 -0
- data/generated/google/apis/dns_v1.rb +44 -0
- data/generated/google/apis/doubleclickbidmanager_v1/classes.rb +716 -0
- data/generated/google/apis/doubleclickbidmanager_v1/representations.rb +298 -0
- data/generated/google/apis/doubleclickbidmanager_v1/service.rb +341 -0
- data/generated/google/apis/doubleclickbidmanager_v1.rb +31 -0
- data/generated/google/apis/doubleclicksearch_v2/classes.rb +956 -0
- data/generated/google/apis/doubleclicksearch_v2/representations.rb +316 -0
- data/generated/google/apis/doubleclicksearch_v2/service.rb +480 -0
- data/generated/google/apis/doubleclicksearch_v2.rb +35 -0
- data/generated/google/apis/drive_v2/classes.rb +2562 -0
- data/generated/google/apis/drive_v2/representations.rb +795 -0
- data/generated/google/apis/drive_v2/service.rb +2696 -0
- data/generated/google/apis/drive_v2.rb +58 -0
- data/generated/google/apis/drive_v3/classes.rb +1534 -0
- data/generated/google/apis/drive_v3/representations.rb +497 -0
- data/generated/google/apis/drive_v3/service.rb +1541 -0
- data/generated/google/apis/drive_v3.rb +55 -0
- data/generated/google/apis/fitness_v1/classes.rb +885 -0
- data/generated/google/apis/fitness_v1/representations.rb +320 -0
- data/generated/google/apis/fitness_v1/service.rb +675 -0
- data/generated/google/apis/fitness_v1.rb +49 -0
- data/generated/google/apis/fusiontables_v2/classes.rb +1048 -0
- data/generated/google/apis/fusiontables_v2/representations.rb +409 -0
- data/generated/google/apis/fusiontables_v2/service.rb +1463 -0
- data/generated/google/apis/fusiontables_v2.rb +37 -0
- data/generated/google/apis/games_configuration_v1configuration/classes.rb +506 -0
- data/generated/google/apis/games_configuration_v1configuration/representations.rb +206 -0
- data/generated/google/apis/games_configuration_v1configuration/service.rb +565 -0
- data/generated/google/apis/games_configuration_v1configuration.rb +34 -0
- data/generated/google/apis/games_management_v1management/classes.rb +524 -0
- data/generated/google/apis/games_management_v1management/representations.rb +231 -0
- data/generated/google/apis/games_management_v1management/service.rb +994 -0
- data/generated/google/apis/games_management_v1management.rb +37 -0
- data/generated/google/apis/games_v1/classes.rb +4617 -0
- data/generated/google/apis/games_v1/representations.rb +1584 -0
- data/generated/google/apis/games_v1/service.rb +2290 -0
- data/generated/google/apis/games_v1.rb +40 -0
- data/generated/google/apis/gan_v1beta1/classes.rb +1428 -0
- data/generated/google/apis/gan_v1beta1/representations.rb +428 -0
- data/generated/google/apis/gan_v1beta1/service.rb +682 -0
- data/generated/google/apis/gan_v1beta1.rb +31 -0
- data/generated/google/apis/genomics_v1/classes.rb +2609 -0
- data/generated/google/apis/genomics_v1/representations.rb +909 -0
- data/generated/google/apis/genomics_v1/service.rb +1676 -0
- data/generated/google/apis/genomics_v1.rb +49 -0
- data/generated/google/apis/genomics_v1beta2/classes.rb +3288 -0
- data/generated/google/apis/genomics_v1beta2/representations.rb +1194 -0
- data/generated/google/apis/genomics_v1beta2/service.rb +2392 -0
- data/generated/google/apis/genomics_v1beta2.rb +46 -0
- data/generated/google/apis/gmail_v1/classes.rb +794 -0
- data/generated/google/apis/gmail_v1/representations.rb +339 -0
- data/generated/google/apis/gmail_v1/service.rb +1470 -0
- data/generated/google/apis/gmail_v1.rb +52 -0
- data/generated/google/apis/groupsmigration_v1/classes.rb +51 -0
- data/generated/google/apis/groupsmigration_v1/representations.rb +38 -0
- data/generated/google/apis/groupsmigration_v1/service.rb +110 -0
- data/generated/google/apis/groupsmigration_v1.rb +34 -0
- data/generated/google/apis/groupssettings_v1/classes.rb +221 -0
- data/generated/google/apis/groupssettings_v1/representations.rb +64 -0
- data/generated/google/apis/groupssettings_v1/service.rb +179 -0
- data/generated/google/apis/groupssettings_v1.rb +34 -0
- data/generated/google/apis/identitytoolkit_v3/classes.rb +1466 -0
- data/generated/google/apis/identitytoolkit_v3/representations.rb +509 -0
- data/generated/google/apis/identitytoolkit_v3/service.rb +581 -0
- data/generated/google/apis/identitytoolkit_v3.rb +31 -0
- data/generated/google/apis/kgsearch_v1/classes.rb +59 -0
- data/generated/google/apis/kgsearch_v1/representations.rb +39 -0
- data/generated/google/apis/kgsearch_v1/service.rb +111 -0
- data/{spec/google/api_client/request_spec.rb → generated/google/apis/kgsearch_v1.rb} +16 -13
- data/generated/google/apis/licensing_v1/classes.rb +132 -0
- data/generated/google/apis/licensing_v1/representations.rb +68 -0
- data/generated/google/apis/licensing_v1/service.rb +369 -0
- data/generated/google/apis/licensing_v1.rb +34 -0
- data/generated/google/apis/logging_v1beta3/classes.rb +1079 -0
- data/generated/google/apis/logging_v1beta3/representations.rb +366 -0
- data/generated/google/apis/logging_v1beta3/service.rb +1001 -0
- data/generated/google/apis/logging_v1beta3.rb +47 -0
- data/generated/google/apis/manager_v1beta2/classes.rb +1287 -0
- data/generated/google/apis/manager_v1beta2/representations.rb +536 -0
- data/generated/google/apis/manager_v1beta2/service.rb +372 -0
- data/generated/google/apis/manager_v1beta2.rb +53 -0
- data/generated/google/apis/mapsengine_v1/classes.rb +2873 -0
- data/generated/google/apis/mapsengine_v1/representations.rb +1235 -0
- data/generated/google/apis/mapsengine_v1/service.rb +3388 -0
- data/generated/google/apis/mapsengine_v1.rb +38 -0
- data/generated/google/apis/mirror_v1/classes.rb +1072 -0
- data/generated/google/apis/mirror_v1/representations.rb +350 -0
- data/generated/google/apis/mirror_v1/service.rb +977 -0
- data/generated/google/apis/mirror_v1.rb +37 -0
- data/generated/google/apis/oauth2_v2/classes.rb +245 -0
- data/generated/google/apis/oauth2_v2/representations.rb +94 -0
- data/generated/google/apis/oauth2_v2/service.rb +199 -0
- data/generated/google/apis/oauth2_v2.rb +43 -0
- data/generated/google/apis/pagespeedonline_v2/classes.rb +614 -0
- data/generated/google/apis/pagespeedonline_v2/representations.rb +244 -0
- data/generated/google/apis/pagespeedonline_v2/service.rb +119 -0
- data/generated/google/apis/pagespeedonline_v2.rb +32 -0
- data/generated/google/apis/partners_v2/classes.rb +942 -0
- data/generated/google/apis/partners_v2/representations.rb +402 -0
- data/generated/google/apis/partners_v2/service.rb +400 -0
- data/generated/google/apis/partners_v2.rb +32 -0
- data/generated/google/apis/plus_domains_v1/classes.rb +2609 -0
- data/generated/google/apis/plus_domains_v1/representations.rb +987 -0
- data/generated/google/apis/plus_domains_v1/service.rb +904 -0
- data/generated/google/apis/plus_domains_v1.rb +61 -0
- data/generated/google/apis/plus_v1/classes.rb +2094 -0
- data/generated/google/apis/plus_v1/representations.rb +805 -0
- data/generated/google/apis/plus_v1/service.rb +470 -0
- data/generated/google/apis/plus_v1.rb +43 -0
- data/generated/google/apis/prediction_v1_6/classes.rb +751 -0
- data/generated/google/apis/prediction_v1_6/representations.rb +327 -0
- data/generated/google/apis/prediction_v1_6/service.rb +380 -0
- data/generated/google/apis/prediction_v1_6.rb +44 -0
- data/generated/google/apis/proximitybeacon_v1beta1/classes.rb +639 -0
- data/generated/google/apis/proximitybeacon_v1beta1/representations.rb +274 -0
- data/generated/google/apis/proximitybeacon_v1beta1/service.rb +591 -0
- data/generated/google/apis/proximitybeacon_v1beta1.rb +31 -0
- data/generated/google/apis/pubsub_v1/classes.rb +614 -0
- data/generated/google/apis/pubsub_v1/representations.rb +281 -0
- data/generated/google/apis/pubsub_v1/service.rb +774 -0
- data/generated/google/apis/pubsub_v1.rb +37 -0
- data/generated/google/apis/pubsub_v1beta2/classes.rb +620 -0
- data/generated/google/apis/pubsub_v1beta2/representations.rb +282 -0
- data/generated/google/apis/pubsub_v1beta2/service.rb +774 -0
- data/generated/google/apis/pubsub_v1beta2.rb +37 -0
- data/generated/google/apis/qpx_express_v1/classes.rb +1268 -0
- data/generated/google/apis/qpx_express_v1/representations.rb +424 -0
- data/generated/google/apis/qpx_express_v1/service.rb +100 -0
- data/generated/google/apis/qpx_express_v1.rb +31 -0
- data/generated/google/apis/replicapool_v1beta2/classes.rb +631 -0
- data/generated/google/apis/replicapool_v1beta2/representations.rb +236 -0
- data/generated/google/apis/replicapool_v1beta2/service.rb +608 -0
- data/generated/google/apis/replicapool_v1beta2.rb +44 -0
- data/generated/google/apis/replicapoolupdater_v1beta1/classes.rb +733 -0
- data/generated/google/apis/replicapoolupdater_v1beta1/representations.rb +264 -0
- data/generated/google/apis/replicapoolupdater_v1beta1/service.rb +508 -0
- data/generated/google/apis/replicapoolupdater_v1beta1.rb +44 -0
- data/generated/google/apis/reseller_v1/classes.rb +520 -0
- data/generated/google/apis/reseller_v1/representations.rb +200 -0
- data/generated/google/apis/reseller_v1/service.rb +623 -0
- data/generated/google/apis/reseller_v1.rb +37 -0
- data/generated/google/apis/resourceviews_v1beta2/classes.rb +660 -0
- data/generated/google/apis/resourceviews_v1beta2/representations.rb +269 -0
- data/generated/google/apis/resourceviews_v1beta2/service.rb +563 -0
- data/generated/google/apis/resourceviews_v1beta2.rb +50 -0
- data/generated/google/apis/script_v1/classes.rb +259 -0
- data/generated/google/apis/script_v1/representations.rb +106 -0
- data/generated/google/apis/script_v1/service.rb +98 -0
- data/generated/google/apis/script_v1.rb +61 -0
- data/generated/google/apis/site_verification_v1/classes.rb +185 -0
- data/generated/google/apis/site_verification_v1/representations.rb +101 -0
- data/generated/google/apis/site_verification_v1/service.rb +315 -0
- data/generated/google/apis/site_verification_v1.rb +37 -0
- data/generated/google/apis/sqladmin_v1beta4/classes.rb +2001 -0
- data/generated/google/apis/sqladmin_v1beta4/representations.rb +758 -0
- data/generated/google/apis/sqladmin_v1beta4/service.rb +1625 -0
- data/generated/google/apis/sqladmin_v1beta4.rb +37 -0
- data/generated/google/apis/storage_v1/classes.rb +1222 -0
- data/generated/google/apis/storage_v1/representations.rb +445 -0
- data/generated/google/apis/storage_v1/service.rb +1903 -0
- data/generated/google/apis/storage_v1.rb +46 -0
- data/generated/google/apis/storagetransfer_v1/classes.rb +1046 -0
- data/generated/google/apis/storagetransfer_v1/representations.rb +370 -0
- data/generated/google/apis/storagetransfer_v1/service.rb +473 -0
- data/generated/google/apis/storagetransfer_v1.rb +35 -0
- data/generated/google/apis/tagmanager_v1/classes.rb +1384 -0
- data/generated/google/apis/tagmanager_v1/representations.rb +515 -0
- data/generated/google/apis/tagmanager_v1/service.rb +1817 -0
- data/generated/google/apis/tagmanager_v1.rb +52 -0
- data/generated/google/apis/taskqueue_v1beta2/classes.rb +254 -0
- data/generated/google/apis/taskqueue_v1beta2/representations.rb +114 -0
- data/generated/google/apis/taskqueue_v1beta2/service.rb +408 -0
- data/generated/google/apis/taskqueue_v1beta2.rb +37 -0
- data/generated/google/apis/tasks_v1/classes.rb +296 -0
- data/generated/google/apis/tasks_v1/representations.rb +115 -0
- data/generated/google/apis/tasks_v1/service.rb +643 -0
- data/generated/google/apis/tasks_v1.rb +37 -0
- data/generated/google/apis/translate_v2/classes.rb +168 -0
- data/generated/google/apis/translate_v2/representations.rb +109 -0
- data/generated/google/apis/translate_v2/service.rb +182 -0
- data/generated/google/apis/translate_v2.rb +31 -0
- data/generated/google/apis/urlshortener_v1/classes.rb +246 -0
- data/generated/google/apis/urlshortener_v1/representations.rb +111 -0
- data/generated/google/apis/urlshortener_v1/service.rb +176 -0
- data/generated/google/apis/urlshortener_v1.rb +34 -0
- data/generated/google/apis/webmasters_v3/classes.rb +563 -0
- data/generated/google/apis/webmasters_v3/representations.rb +250 -0
- data/generated/google/apis/webmasters_v3/service.rb +573 -0
- data/generated/google/apis/webmasters_v3.rb +37 -0
- data/generated/google/apis/youtube_analytics_v1/classes.rb +546 -0
- data/generated/google/apis/youtube_analytics_v1/representations.rb +243 -0
- data/generated/google/apis/youtube_analytics_v1/service.rb +562 -0
- data/generated/google/apis/youtube_analytics_v1.rb +46 -0
- data/generated/google/apis/youtube_v3/classes.rb +8136 -0
- data/generated/google/apis/youtube_v3/representations.rb +2838 -0
- data/generated/google/apis/youtube_v3/service.rb +4403 -0
- data/generated/google/apis/youtube_v3.rb +49 -0
- data/generated/google/apis/youtubereporting_v1/classes.rb +258 -0
- data/generated/google/apis/youtubereporting_v1/representations.rb +128 -0
- data/generated/google/apis/youtubereporting_v1/service.rb +364 -0
- data/generated/google/apis/youtubereporting_v1.rb +38 -0
- data/google-api-client.gemspec +27 -39
- data/lib/google/api_client/auth/installed_app.rb +7 -5
- data/lib/google/api_client/auth/key_utils.rb +12 -11
- data/lib/google/api_client/auth/storage.rb +5 -2
- data/lib/google/api_client/auth/storages/file_store.rb +2 -3
- data/lib/google/api_client/auth/storages/redis_store.rb +7 -2
- data/lib/google/api_client/client_secrets.rb +4 -5
- data/lib/google/apis/core/api_command.rb +135 -0
- data/lib/google/apis/core/base_service.rb +317 -0
- data/lib/google/apis/core/batch.rb +239 -0
- data/lib/google/apis/core/download.rb +94 -0
- data/lib/google/apis/core/hashable.rb +44 -0
- data/lib/google/apis/core/http_client_adapter.rb +82 -0
- data/lib/google/apis/core/http_command.rb +312 -0
- data/lib/google/apis/core/json_representation.rb +127 -0
- data/lib/google/{api_client/version.rb → apis/core/logging.rb} +12 -8
- data/lib/google/apis/core/multipart.rb +187 -0
- data/lib/google/apis/core/upload.rb +288 -0
- data/lib/google/{api_client → apis}/errors.rb +39 -28
- data/lib/google/apis/generator/annotator.rb +295 -0
- data/lib/google/apis/generator/helpers.rb +74 -0
- data/lib/google/apis/generator/model.rb +143 -0
- data/lib/google/apis/generator/template.rb +124 -0
- data/lib/google/apis/generator/templates/_class.tmpl +40 -0
- data/lib/google/apis/generator/templates/_method.tmpl +92 -0
- data/lib/google/apis/generator/templates/_representation.tmpl +51 -0
- data/lib/google/apis/generator/templates/_representation_stub.tmpl +15 -0
- data/lib/google/apis/generator/templates/_representation_type.tmpl +10 -0
- data/lib/google/{api_client/reference.rb → apis/generator/templates/classes.rb.tmpl} +11 -9
- data/lib/google/apis/generator/templates/module.rb.tmpl +40 -0
- data/lib/google/apis/generator/templates/representations.rb.tmpl +32 -0
- data/lib/google/apis/generator/templates/service.rb.tmpl +60 -0
- data/lib/google/apis/generator.rb +70 -0
- data/lib/google/apis/options.rb +85 -0
- data/lib/google/apis/version.rb +39 -0
- data/lib/google/apis.rb +48 -0
- data/rakelib/metrics.rake +22 -0
- data/rakelib/rubocop.rake +10 -0
- data/rakelib/spec.rake +11 -0
- data/rakelib/yard.rake +11 -0
- data/samples/Gemfile +7 -0
- data/samples/README.md +51 -0
- data/samples/google-api-samples +32 -0
- data/samples/lib/base_cli.rb +94 -0
- data/samples/lib/samples/analytics.rb +62 -0
- data/samples/lib/samples/calendar.rb +83 -0
- data/samples/lib/samples/drive.rb +82 -0
- data/samples/lib/samples/gmail.rb +50 -0
- data/samples/lib/samples/pubsub.rb +114 -0
- data/samples/lib/samples/translate.rb +44 -0
- data/samples/lib/samples/you_tube.rb +44 -0
- data/script/generate +95 -0
- data/script/package +8 -0
- data/script/release +15 -0
- data/spec/fixtures/files/api_names.yaml +3 -0
- data/spec/fixtures/files/auth_stored_credentials.json +8 -0
- data/spec/fixtures/files/child/.gitignore +0 -0
- data/spec/fixtures/files/client_secrets.json +1 -0
- data/spec/fixtures/files/invalid.json +1 -0
- data/spec/fixtures/files/test.blah +1 -0
- data/spec/fixtures/files/test.txt +1 -0
- data/spec/fixtures/files/test_api.json +440 -0
- data/spec/google/api_client/auth/storage_spec.rb +1 -3
- data/spec/google/api_client/auth/storages/file_store_spec.rb +1 -2
- data/spec/google/api_client/auth/storages/redis_store_spec.rb +1 -3
- data/spec/google/api_client/client_secrets_spec.rb +38 -1
- data/spec/google/apis/core/api_command_spec.rb +209 -0
- data/spec/google/apis/core/batch_spec.rb +142 -0
- data/spec/google/apis/core/download_spec.rb +103 -0
- data/spec/google/apis/core/hashable_spec.rb +60 -0
- data/spec/google/apis/core/http_command_spec.rb +284 -0
- data/spec/google/apis/core/json_representation_spec.rb +192 -0
- data/spec/google/apis/core/service_spec.rb +247 -0
- data/spec/google/apis/core/upload_spec.rb +300 -0
- data/{lib/google/api_client/discovery.rb → spec/google/apis/generated_spec.rb} +13 -5
- data/spec/google/apis/generator/generator_spec.rb +272 -0
- data/spec/google/apis/logging_spec.rb +45 -0
- data/spec/google/apis/options_spec.rb +40 -0
- data/spec/integration_tests/adsense_spec.rb +29 -0
- data/spec/integration_tests/drive_spec.rb +35 -0
- data/spec/integration_tests/pubsub_spec.rb +48 -0
- data/spec/integration_tests/url_shortener_spec.rb +45 -0
- data/spec/spec_helper/load_path_spec.rb +33 -0
- data/spec/spec_helper.rb +131 -44
- data/third_party/hurley_patches.rb +103 -0
- metadata +533 -170
- data/lib/compat/multi_json.rb +0 -19
- data/lib/google/api_client/auth/file_storage.rb +0 -59
- data/lib/google/api_client/auth/jwt_asserter.rb +0 -126
- data/lib/google/api_client/auth/pkcs12.rb +0 -41
- data/lib/google/api_client/batch.rb +0 -325
- data/lib/google/api_client/charset.rb +0 -33
- data/lib/google/api_client/discovery/api.rb +0 -300
- data/lib/google/api_client/discovery/media.rb +0 -77
- data/lib/google/api_client/discovery/method.rb +0 -363
- data/lib/google/api_client/discovery/resource.rb +0 -156
- data/lib/google/api_client/discovery/schema.rb +0 -119
- data/lib/google/api_client/environment.rb +0 -42
- data/lib/google/api_client/gzip.rb +0 -28
- data/lib/google/api_client/logging.rb +0 -32
- data/lib/google/api_client/media.rb +0 -259
- data/lib/google/api_client/railtie.rb +0 -18
- data/lib/google/api_client/request.rb +0 -350
- data/lib/google/api_client/result.rb +0 -255
- data/lib/google/api_client/service/batch.rb +0 -110
- data/lib/google/api_client/service/request.rb +0 -144
- data/lib/google/api_client/service/resource.rb +0 -40
- data/lib/google/api_client/service/result.rb +0 -162
- data/lib/google/api_client/service/simple_file_store.rb +0 -151
- data/lib/google/api_client/service/stub_generator.rb +0 -61
- data/lib/google/api_client/service.rb +0 -233
- data/lib/google/api_client.rb +0 -750
- data/spec/google/api_client/batch_spec.rb +0 -248
- data/spec/google/api_client/discovery_spec.rb +0 -662
- data/spec/google/api_client/gzip_spec.rb +0 -98
- data/spec/google/api_client/media_spec.rb +0 -178
- data/spec/google/api_client/result_spec.rb +0 -207
- data/spec/google/api_client/service_account_spec.rb +0 -169
- data/spec/google/api_client/service_spec.rb +0 -618
- data/spec/google/api_client/simple_file_store_spec.rb +0 -133
- data/spec/google/api_client_spec.rb +0 -352
|
@@ -0,0 +1,970 @@
|
|
|
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 ClassroomV1
|
|
23
|
+
# Google Classroom API
|
|
24
|
+
#
|
|
25
|
+
# Google Classroom API
|
|
26
|
+
#
|
|
27
|
+
# @example
|
|
28
|
+
# require 'google/apis/classroom_v1'
|
|
29
|
+
#
|
|
30
|
+
# Classroom = Google::Apis::ClassroomV1 # Alias the module
|
|
31
|
+
# service = Classroom::ClassroomService.new
|
|
32
|
+
#
|
|
33
|
+
# @see https://developers.google.com/classroom/
|
|
34
|
+
class ClassroomService < 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
|
+
attr_accessor :quota_user
|
|
44
|
+
|
|
45
|
+
def initialize
|
|
46
|
+
super('https://classroom.googleapis.com/', '')
|
|
47
|
+
end
|
|
48
|
+
|
|
49
|
+
# Creates a course. The user specified in `ownerId` is the owner of the created
|
|
50
|
+
# course and added as a teacher. This method returns the following error codes: *
|
|
51
|
+
# `PERMISSION_DENIED` if the requesting user is not permitted to create courses
|
|
52
|
+
# or for access errors. * `NOT_FOUND` if the primary teacher is not a valid user.
|
|
53
|
+
# * `FAILED_PRECONDITION` if the course owner's account is disabled or for the
|
|
54
|
+
# following request errors: * UserGroupsMembershipLimitReached * `ALREADY_EXISTS`
|
|
55
|
+
# if an alias was specified in the `id` and already exists.
|
|
56
|
+
# @param [Google::Apis::ClassroomV1::Course] course_object
|
|
57
|
+
# @param [String] fields
|
|
58
|
+
# Selector specifying which fields to include in a partial response.
|
|
59
|
+
# @param [String] quota_user
|
|
60
|
+
# Available to use for quota purposes for server-side applications. Can be any
|
|
61
|
+
# arbitrary string assigned to a user, but should not exceed 40 characters.
|
|
62
|
+
# @param [Google::Apis::RequestOptions] options
|
|
63
|
+
# Request-specific options
|
|
64
|
+
#
|
|
65
|
+
# @yield [result, err] Result & error if block supplied
|
|
66
|
+
# @yieldparam result [Google::Apis::ClassroomV1::Course] parsed result object
|
|
67
|
+
# @yieldparam err [StandardError] error object if request failed
|
|
68
|
+
#
|
|
69
|
+
# @return [Google::Apis::ClassroomV1::Course]
|
|
70
|
+
#
|
|
71
|
+
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
|
|
72
|
+
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
|
|
73
|
+
# @raise [Google::Apis::AuthorizationError] Authorization is required
|
|
74
|
+
def create_course(course_object = nil, fields: nil, quota_user: nil, options: nil, &block)
|
|
75
|
+
command = make_simple_command(:post, 'v1/courses', options)
|
|
76
|
+
command.request_representation = Google::Apis::ClassroomV1::Course::Representation
|
|
77
|
+
command.request_object = course_object
|
|
78
|
+
command.response_representation = Google::Apis::ClassroomV1::Course::Representation
|
|
79
|
+
command.response_class = Google::Apis::ClassroomV1::Course
|
|
80
|
+
command.query['fields'] = fields unless fields.nil?
|
|
81
|
+
command.query['quotaUser'] = quota_user unless quota_user.nil?
|
|
82
|
+
execute_or_queue_command(command, &block)
|
|
83
|
+
end
|
|
84
|
+
|
|
85
|
+
# Returns a course. This method returns the following error codes: * `
|
|
86
|
+
# PERMISSION_DENIED` if the requesting user is not permitted to access the
|
|
87
|
+
# requested course or for access errors. * `NOT_FOUND` if no course exists with
|
|
88
|
+
# the requested ID.
|
|
89
|
+
# @param [String] id
|
|
90
|
+
# Identifier of the course to return. This identifier can be either the
|
|
91
|
+
# Classroom-assigned identifier or an alias.
|
|
92
|
+
# @param [String] fields
|
|
93
|
+
# Selector specifying which fields to include in a partial response.
|
|
94
|
+
# @param [String] quota_user
|
|
95
|
+
# Available to use for quota purposes for server-side applications. Can be any
|
|
96
|
+
# arbitrary string assigned to a user, but should not exceed 40 characters.
|
|
97
|
+
# @param [Google::Apis::RequestOptions] options
|
|
98
|
+
# Request-specific options
|
|
99
|
+
#
|
|
100
|
+
# @yield [result, err] Result & error if block supplied
|
|
101
|
+
# @yieldparam result [Google::Apis::ClassroomV1::Course] parsed result object
|
|
102
|
+
# @yieldparam err [StandardError] error object if request failed
|
|
103
|
+
#
|
|
104
|
+
# @return [Google::Apis::ClassroomV1::Course]
|
|
105
|
+
#
|
|
106
|
+
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
|
|
107
|
+
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
|
|
108
|
+
# @raise [Google::Apis::AuthorizationError] Authorization is required
|
|
109
|
+
def get_course(id, fields: nil, quota_user: nil, options: nil, &block)
|
|
110
|
+
command = make_simple_command(:get, 'v1/courses/{id}', options)
|
|
111
|
+
command.response_representation = Google::Apis::ClassroomV1::Course::Representation
|
|
112
|
+
command.response_class = Google::Apis::ClassroomV1::Course
|
|
113
|
+
command.params['id'] = id unless id.nil?
|
|
114
|
+
command.query['fields'] = fields unless fields.nil?
|
|
115
|
+
command.query['quotaUser'] = quota_user unless quota_user.nil?
|
|
116
|
+
execute_or_queue_command(command, &block)
|
|
117
|
+
end
|
|
118
|
+
|
|
119
|
+
# Updates a course. This method returns the following error codes: * `
|
|
120
|
+
# PERMISSION_DENIED` if the requesting user is not permitted to modify the
|
|
121
|
+
# requested course or for access errors. * `NOT_FOUND` if no course exists with
|
|
122
|
+
# the requested ID. * `FAILED_PRECONDITION` for the following request errors: *
|
|
123
|
+
# CourseNotModifiable
|
|
124
|
+
# @param [String] id
|
|
125
|
+
# Identifier of the course to update. This identifier can be either the
|
|
126
|
+
# Classroom-assigned identifier or an alias.
|
|
127
|
+
# @param [Google::Apis::ClassroomV1::Course] course_object
|
|
128
|
+
# @param [String] fields
|
|
129
|
+
# Selector specifying which fields to include in a partial response.
|
|
130
|
+
# @param [String] quota_user
|
|
131
|
+
# Available to use for quota purposes for server-side applications. Can be any
|
|
132
|
+
# arbitrary string assigned to a user, but should not exceed 40 characters.
|
|
133
|
+
# @param [Google::Apis::RequestOptions] options
|
|
134
|
+
# Request-specific options
|
|
135
|
+
#
|
|
136
|
+
# @yield [result, err] Result & error if block supplied
|
|
137
|
+
# @yieldparam result [Google::Apis::ClassroomV1::Course] parsed result object
|
|
138
|
+
# @yieldparam err [StandardError] error object if request failed
|
|
139
|
+
#
|
|
140
|
+
# @return [Google::Apis::ClassroomV1::Course]
|
|
141
|
+
#
|
|
142
|
+
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
|
|
143
|
+
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
|
|
144
|
+
# @raise [Google::Apis::AuthorizationError] Authorization is required
|
|
145
|
+
def update_course(id, course_object = nil, fields: nil, quota_user: nil, options: nil, &block)
|
|
146
|
+
command = make_simple_command(:put, 'v1/courses/{id}', options)
|
|
147
|
+
command.request_representation = Google::Apis::ClassroomV1::Course::Representation
|
|
148
|
+
command.request_object = course_object
|
|
149
|
+
command.response_representation = Google::Apis::ClassroomV1::Course::Representation
|
|
150
|
+
command.response_class = Google::Apis::ClassroomV1::Course
|
|
151
|
+
command.params['id'] = id unless id.nil?
|
|
152
|
+
command.query['fields'] = fields unless fields.nil?
|
|
153
|
+
command.query['quotaUser'] = quota_user unless quota_user.nil?
|
|
154
|
+
execute_or_queue_command(command, &block)
|
|
155
|
+
end
|
|
156
|
+
|
|
157
|
+
# Updates one or more fields in a course. This method returns the following
|
|
158
|
+
# error codes: * `PERMISSION_DENIED` if the requesting user is not permitted to
|
|
159
|
+
# modify the requested course or for access errors. * `NOT_FOUND` if no course
|
|
160
|
+
# exists with the requested ID. * `INVALID_ARGUMENT` if invalid fields are
|
|
161
|
+
# specified in the update mask or if no update mask is supplied. * `
|
|
162
|
+
# FAILED_PRECONDITION` for the following request errors: * CourseNotModifiable
|
|
163
|
+
# @param [String] id
|
|
164
|
+
# Identifier of the course to update. This identifier can be either the
|
|
165
|
+
# Classroom-assigned identifier or an alias.
|
|
166
|
+
# @param [Google::Apis::ClassroomV1::Course] course_object
|
|
167
|
+
# @param [String] update_mask
|
|
168
|
+
# Mask that identifies which fields on the course to update. This field is
|
|
169
|
+
# required to do an update. The update will fail if invalid fields are specified.
|
|
170
|
+
# The following fields are valid: * `name` * `section` * `descriptionHeading` *
|
|
171
|
+
# `description` * `room` * `courseState` When set in a query parameter, this
|
|
172
|
+
# field should be specified as `updateMask=,,...`
|
|
173
|
+
# @param [String] fields
|
|
174
|
+
# Selector specifying which fields to include in a partial response.
|
|
175
|
+
# @param [String] quota_user
|
|
176
|
+
# Available to use for quota purposes for server-side applications. Can be any
|
|
177
|
+
# arbitrary string assigned to a user, but should not exceed 40 characters.
|
|
178
|
+
# @param [Google::Apis::RequestOptions] options
|
|
179
|
+
# Request-specific options
|
|
180
|
+
#
|
|
181
|
+
# @yield [result, err] Result & error if block supplied
|
|
182
|
+
# @yieldparam result [Google::Apis::ClassroomV1::Course] parsed result object
|
|
183
|
+
# @yieldparam err [StandardError] error object if request failed
|
|
184
|
+
#
|
|
185
|
+
# @return [Google::Apis::ClassroomV1::Course]
|
|
186
|
+
#
|
|
187
|
+
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
|
|
188
|
+
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
|
|
189
|
+
# @raise [Google::Apis::AuthorizationError] Authorization is required
|
|
190
|
+
def patch_course(id, course_object = nil, update_mask: nil, fields: nil, quota_user: nil, options: nil, &block)
|
|
191
|
+
command = make_simple_command(:patch, 'v1/courses/{id}', options)
|
|
192
|
+
command.request_representation = Google::Apis::ClassroomV1::Course::Representation
|
|
193
|
+
command.request_object = course_object
|
|
194
|
+
command.response_representation = Google::Apis::ClassroomV1::Course::Representation
|
|
195
|
+
command.response_class = Google::Apis::ClassroomV1::Course
|
|
196
|
+
command.params['id'] = id unless id.nil?
|
|
197
|
+
command.query['updateMask'] = update_mask unless update_mask.nil?
|
|
198
|
+
command.query['fields'] = fields unless fields.nil?
|
|
199
|
+
command.query['quotaUser'] = quota_user unless quota_user.nil?
|
|
200
|
+
execute_or_queue_command(command, &block)
|
|
201
|
+
end
|
|
202
|
+
|
|
203
|
+
# Deletes a course. This method returns the following error codes: * `
|
|
204
|
+
# PERMISSION_DENIED` if the requesting user is not permitted to delete the
|
|
205
|
+
# requested course or for access errors. * `NOT_FOUND` if no course exists with
|
|
206
|
+
# the requested ID.
|
|
207
|
+
# @param [String] id
|
|
208
|
+
# Identifier of the course to delete. This identifier can be either the
|
|
209
|
+
# Classroom-assigned identifier or an alias.
|
|
210
|
+
# @param [String] fields
|
|
211
|
+
# Selector specifying which fields to include in a partial response.
|
|
212
|
+
# @param [String] quota_user
|
|
213
|
+
# Available to use for quota purposes for server-side applications. Can be any
|
|
214
|
+
# arbitrary string assigned to a user, but should not exceed 40 characters.
|
|
215
|
+
# @param [Google::Apis::RequestOptions] options
|
|
216
|
+
# Request-specific options
|
|
217
|
+
#
|
|
218
|
+
# @yield [result, err] Result & error if block supplied
|
|
219
|
+
# @yieldparam result [Google::Apis::ClassroomV1::Empty] parsed result object
|
|
220
|
+
# @yieldparam err [StandardError] error object if request failed
|
|
221
|
+
#
|
|
222
|
+
# @return [Google::Apis::ClassroomV1::Empty]
|
|
223
|
+
#
|
|
224
|
+
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
|
|
225
|
+
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
|
|
226
|
+
# @raise [Google::Apis::AuthorizationError] Authorization is required
|
|
227
|
+
def delete_course(id, fields: nil, quota_user: nil, options: nil, &block)
|
|
228
|
+
command = make_simple_command(:delete, 'v1/courses/{id}', options)
|
|
229
|
+
command.response_representation = Google::Apis::ClassroomV1::Empty::Representation
|
|
230
|
+
command.response_class = Google::Apis::ClassroomV1::Empty
|
|
231
|
+
command.params['id'] = id unless id.nil?
|
|
232
|
+
command.query['fields'] = fields unless fields.nil?
|
|
233
|
+
command.query['quotaUser'] = quota_user unless quota_user.nil?
|
|
234
|
+
execute_or_queue_command(command, &block)
|
|
235
|
+
end
|
|
236
|
+
|
|
237
|
+
# Returns a list of courses that the requesting user is permitted to view,
|
|
238
|
+
# restricted to those that match the request. This method returns the following
|
|
239
|
+
# error codes: * `PERMISSION_DENIED` for access errors. * `INVALID_ARGUMENT` if
|
|
240
|
+
# the query argument is malformed. * `NOT_FOUND` if any users specified in the
|
|
241
|
+
# query arguments do not exist.
|
|
242
|
+
# @param [String] student_id
|
|
243
|
+
# Restricts returned courses to those having a student with the specified
|
|
244
|
+
# identifier. The identifier can be one of the following: * the numeric
|
|
245
|
+
# identifier for the user * the email address of the user * the string literal `"
|
|
246
|
+
# me"`, indicating the requesting user
|
|
247
|
+
# @param [String] teacher_id
|
|
248
|
+
# Restricts returned courses to those having a teacher with the specified
|
|
249
|
+
# identifier. The identifier can be one of the following: * the numeric
|
|
250
|
+
# identifier for the user * the email address of the user * the string literal `"
|
|
251
|
+
# me"`, indicating the requesting user
|
|
252
|
+
# @param [Fixnum] page_size
|
|
253
|
+
# Maximum number of items to return. Zero or unspecified indicates that the
|
|
254
|
+
# server may assign a maximum. The server may return fewer than the specified
|
|
255
|
+
# number of results.
|
|
256
|
+
# @param [String] page_token
|
|
257
|
+
# nextPageToken value returned from a previous list call, indicating that the
|
|
258
|
+
# subsequent page of results should be returned. The list request must be
|
|
259
|
+
# otherwise identical to the one that resulted in this token.
|
|
260
|
+
# @param [String] fields
|
|
261
|
+
# Selector specifying which fields to include in a partial response.
|
|
262
|
+
# @param [String] quota_user
|
|
263
|
+
# Available to use for quota purposes for server-side applications. Can be any
|
|
264
|
+
# arbitrary string assigned to a user, but should not exceed 40 characters.
|
|
265
|
+
# @param [Google::Apis::RequestOptions] options
|
|
266
|
+
# Request-specific options
|
|
267
|
+
#
|
|
268
|
+
# @yield [result, err] Result & error if block supplied
|
|
269
|
+
# @yieldparam result [Google::Apis::ClassroomV1::ListCoursesResponse] parsed result object
|
|
270
|
+
# @yieldparam err [StandardError] error object if request failed
|
|
271
|
+
#
|
|
272
|
+
# @return [Google::Apis::ClassroomV1::ListCoursesResponse]
|
|
273
|
+
#
|
|
274
|
+
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
|
|
275
|
+
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
|
|
276
|
+
# @raise [Google::Apis::AuthorizationError] Authorization is required
|
|
277
|
+
def list_courses(student_id: nil, teacher_id: nil, page_size: nil, page_token: nil, fields: nil, quota_user: nil, options: nil, &block)
|
|
278
|
+
command = make_simple_command(:get, 'v1/courses', options)
|
|
279
|
+
command.response_representation = Google::Apis::ClassroomV1::ListCoursesResponse::Representation
|
|
280
|
+
command.response_class = Google::Apis::ClassroomV1::ListCoursesResponse
|
|
281
|
+
command.query['studentId'] = student_id unless student_id.nil?
|
|
282
|
+
command.query['teacherId'] = teacher_id unless teacher_id.nil?
|
|
283
|
+
command.query['pageSize'] = page_size unless page_size.nil?
|
|
284
|
+
command.query['pageToken'] = page_token unless page_token.nil?
|
|
285
|
+
command.query['fields'] = fields unless fields.nil?
|
|
286
|
+
command.query['quotaUser'] = quota_user unless quota_user.nil?
|
|
287
|
+
execute_or_queue_command(command, &block)
|
|
288
|
+
end
|
|
289
|
+
|
|
290
|
+
# Creates an alias for a course. This method returns the following error codes: *
|
|
291
|
+
# `PERMISSION_DENIED` if the requesting user is not permitted to create the
|
|
292
|
+
# alias or for access errors. * `NOT_FOUND` if the course does not exist. * `
|
|
293
|
+
# ALREADY_EXISTS` if the alias already exists.
|
|
294
|
+
# @param [String] course_id
|
|
295
|
+
# Identifier of the course to alias. This identifier can be either the Classroom-
|
|
296
|
+
# assigned identifier or an alias.
|
|
297
|
+
# @param [Google::Apis::ClassroomV1::CourseAlias] course_alias_object
|
|
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
|
+
# @param [Google::Apis::RequestOptions] options
|
|
304
|
+
# Request-specific options
|
|
305
|
+
#
|
|
306
|
+
# @yield [result, err] Result & error if block supplied
|
|
307
|
+
# @yieldparam result [Google::Apis::ClassroomV1::CourseAlias] parsed result object
|
|
308
|
+
# @yieldparam err [StandardError] error object if request failed
|
|
309
|
+
#
|
|
310
|
+
# @return [Google::Apis::ClassroomV1::CourseAlias]
|
|
311
|
+
#
|
|
312
|
+
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
|
|
313
|
+
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
|
|
314
|
+
# @raise [Google::Apis::AuthorizationError] Authorization is required
|
|
315
|
+
def create_course_alias(course_id, course_alias_object = nil, fields: nil, quota_user: nil, options: nil, &block)
|
|
316
|
+
command = make_simple_command(:post, 'v1/courses/{courseId}/aliases', options)
|
|
317
|
+
command.request_representation = Google::Apis::ClassroomV1::CourseAlias::Representation
|
|
318
|
+
command.request_object = course_alias_object
|
|
319
|
+
command.response_representation = Google::Apis::ClassroomV1::CourseAlias::Representation
|
|
320
|
+
command.response_class = Google::Apis::ClassroomV1::CourseAlias
|
|
321
|
+
command.params['courseId'] = course_id unless course_id.nil?
|
|
322
|
+
command.query['fields'] = fields unless fields.nil?
|
|
323
|
+
command.query['quotaUser'] = quota_user unless quota_user.nil?
|
|
324
|
+
execute_or_queue_command(command, &block)
|
|
325
|
+
end
|
|
326
|
+
|
|
327
|
+
# Deletes an alias of a course. This method returns the following error codes: *
|
|
328
|
+
# `PERMISSION_DENIED` if the requesting user is not permitted to remove the
|
|
329
|
+
# alias or for access errors. * `NOT_FOUND` if the alias does not exist.
|
|
330
|
+
# @param [String] course_id
|
|
331
|
+
# Identifier of the course whose alias should be deleted. This identifier can be
|
|
332
|
+
# either the Classroom-assigned identifier or an alias.
|
|
333
|
+
# @param [String] alias_
|
|
334
|
+
# Alias to delete. This may not be the Classroom-assigned identifier.
|
|
335
|
+
# @param [String] fields
|
|
336
|
+
# Selector specifying which fields to include in a partial response.
|
|
337
|
+
# @param [String] quota_user
|
|
338
|
+
# Available to use for quota purposes for server-side applications. Can be any
|
|
339
|
+
# arbitrary string assigned to a user, but should not exceed 40 characters.
|
|
340
|
+
# @param [Google::Apis::RequestOptions] options
|
|
341
|
+
# Request-specific options
|
|
342
|
+
#
|
|
343
|
+
# @yield [result, err] Result & error if block supplied
|
|
344
|
+
# @yieldparam result [Google::Apis::ClassroomV1::Empty] parsed result object
|
|
345
|
+
# @yieldparam err [StandardError] error object if request failed
|
|
346
|
+
#
|
|
347
|
+
# @return [Google::Apis::ClassroomV1::Empty]
|
|
348
|
+
#
|
|
349
|
+
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
|
|
350
|
+
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
|
|
351
|
+
# @raise [Google::Apis::AuthorizationError] Authorization is required
|
|
352
|
+
def delete_course_alias(course_id, alias_, fields: nil, quota_user: nil, options: nil, &block)
|
|
353
|
+
command = make_simple_command(:delete, 'v1/courses/{courseId}/aliases/{alias}', options)
|
|
354
|
+
command.response_representation = Google::Apis::ClassroomV1::Empty::Representation
|
|
355
|
+
command.response_class = Google::Apis::ClassroomV1::Empty
|
|
356
|
+
command.params['courseId'] = course_id unless course_id.nil?
|
|
357
|
+
command.params['alias'] = alias_ unless alias_.nil?
|
|
358
|
+
command.query['fields'] = fields unless fields.nil?
|
|
359
|
+
command.query['quotaUser'] = quota_user unless quota_user.nil?
|
|
360
|
+
execute_or_queue_command(command, &block)
|
|
361
|
+
end
|
|
362
|
+
|
|
363
|
+
# Returns a list of aliases for a course. This method returns the following
|
|
364
|
+
# error codes: * `PERMISSION_DENIED` if the requesting user is not permitted to
|
|
365
|
+
# access the course or for access errors. * `NOT_FOUND` if the course does not
|
|
366
|
+
# exist.
|
|
367
|
+
# @param [String] course_id
|
|
368
|
+
# The identifier of the course. This identifier can be either the Classroom-
|
|
369
|
+
# assigned identifier or an alias.
|
|
370
|
+
# @param [Fixnum] page_size
|
|
371
|
+
# Maximum number of items to return. Zero or unspecified indicates that the
|
|
372
|
+
# server may assign a maximum. The server may return fewer than the specified
|
|
373
|
+
# number of results.
|
|
374
|
+
# @param [String] page_token
|
|
375
|
+
# nextPageToken value returned from a previous list call, indicating that the
|
|
376
|
+
# subsequent page of results should be returned. The list request must be
|
|
377
|
+
# otherwise identical to the one that resulted in this token.
|
|
378
|
+
# @param [String] fields
|
|
379
|
+
# Selector specifying which fields to include in a partial response.
|
|
380
|
+
# @param [String] quota_user
|
|
381
|
+
# Available to use for quota purposes for server-side applications. Can be any
|
|
382
|
+
# arbitrary string assigned to a user, but should not exceed 40 characters.
|
|
383
|
+
# @param [Google::Apis::RequestOptions] options
|
|
384
|
+
# Request-specific options
|
|
385
|
+
#
|
|
386
|
+
# @yield [result, err] Result & error if block supplied
|
|
387
|
+
# @yieldparam result [Google::Apis::ClassroomV1::ListCourseAliasesResponse] parsed result object
|
|
388
|
+
# @yieldparam err [StandardError] error object if request failed
|
|
389
|
+
#
|
|
390
|
+
# @return [Google::Apis::ClassroomV1::ListCourseAliasesResponse]
|
|
391
|
+
#
|
|
392
|
+
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
|
|
393
|
+
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
|
|
394
|
+
# @raise [Google::Apis::AuthorizationError] Authorization is required
|
|
395
|
+
def list_course_aliases(course_id, page_size: nil, page_token: nil, fields: nil, quota_user: nil, options: nil, &block)
|
|
396
|
+
command = make_simple_command(:get, 'v1/courses/{courseId}/aliases', options)
|
|
397
|
+
command.response_representation = Google::Apis::ClassroomV1::ListCourseAliasesResponse::Representation
|
|
398
|
+
command.response_class = Google::Apis::ClassroomV1::ListCourseAliasesResponse
|
|
399
|
+
command.params['courseId'] = course_id unless course_id.nil?
|
|
400
|
+
command.query['pageSize'] = page_size unless page_size.nil?
|
|
401
|
+
command.query['pageToken'] = page_token unless page_token.nil?
|
|
402
|
+
command.query['fields'] = fields unless fields.nil?
|
|
403
|
+
command.query['quotaUser'] = quota_user unless quota_user.nil?
|
|
404
|
+
execute_or_queue_command(command, &block)
|
|
405
|
+
end
|
|
406
|
+
|
|
407
|
+
# Creates a teacher of a course. This method returns the following error codes: *
|
|
408
|
+
# `PERMISSION_DENIED` if the requesting user is not permitted to create
|
|
409
|
+
# teachers in this course or for access errors. * `NOT_FOUND` if the requested
|
|
410
|
+
# course ID does not exist. * `FAILED_PRECONDITION` if the requested user's
|
|
411
|
+
# account is disabled, for the following request errors: *
|
|
412
|
+
# CourseMemberLimitReached * CourseNotModifiable * CourseTeacherLimitReached *
|
|
413
|
+
# UserGroupsMembershipLimitReached * `ALREADY_EXISTS` if the user is already a
|
|
414
|
+
# teacher or student in the course.
|
|
415
|
+
# @param [String] course_id
|
|
416
|
+
# Identifier of the course. This identifier can be either the Classroom-assigned
|
|
417
|
+
# identifier or an alias.
|
|
418
|
+
# @param [Google::Apis::ClassroomV1::Teacher] teacher_object
|
|
419
|
+
# @param [String] fields
|
|
420
|
+
# Selector specifying which fields to include in a partial response.
|
|
421
|
+
# @param [String] quota_user
|
|
422
|
+
# Available to use for quota purposes for server-side applications. Can be any
|
|
423
|
+
# arbitrary string assigned to a user, but should not exceed 40 characters.
|
|
424
|
+
# @param [Google::Apis::RequestOptions] options
|
|
425
|
+
# Request-specific options
|
|
426
|
+
#
|
|
427
|
+
# @yield [result, err] Result & error if block supplied
|
|
428
|
+
# @yieldparam result [Google::Apis::ClassroomV1::Teacher] parsed result object
|
|
429
|
+
# @yieldparam err [StandardError] error object if request failed
|
|
430
|
+
#
|
|
431
|
+
# @return [Google::Apis::ClassroomV1::Teacher]
|
|
432
|
+
#
|
|
433
|
+
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
|
|
434
|
+
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
|
|
435
|
+
# @raise [Google::Apis::AuthorizationError] Authorization is required
|
|
436
|
+
def create_course_teacher(course_id, teacher_object = nil, fields: nil, quota_user: nil, options: nil, &block)
|
|
437
|
+
command = make_simple_command(:post, 'v1/courses/{courseId}/teachers', options)
|
|
438
|
+
command.request_representation = Google::Apis::ClassroomV1::Teacher::Representation
|
|
439
|
+
command.request_object = teacher_object
|
|
440
|
+
command.response_representation = Google::Apis::ClassroomV1::Teacher::Representation
|
|
441
|
+
command.response_class = Google::Apis::ClassroomV1::Teacher
|
|
442
|
+
command.params['courseId'] = course_id unless course_id.nil?
|
|
443
|
+
command.query['fields'] = fields unless fields.nil?
|
|
444
|
+
command.query['quotaUser'] = quota_user unless quota_user.nil?
|
|
445
|
+
execute_or_queue_command(command, &block)
|
|
446
|
+
end
|
|
447
|
+
|
|
448
|
+
# Returns a teacher of a course. This method returns the following error codes: *
|
|
449
|
+
# `PERMISSION_DENIED` if the requesting user is not permitted to view teachers
|
|
450
|
+
# of this course or for access errors. * `NOT_FOUND` if no teacher of this
|
|
451
|
+
# course has the requested ID or if the course does not exist.
|
|
452
|
+
# @param [String] course_id
|
|
453
|
+
# Identifier of the course. This identifier can be either the Classroom-assigned
|
|
454
|
+
# identifier or an alias.
|
|
455
|
+
# @param [String] user_id
|
|
456
|
+
# Identifier of the teacher to return. The identifier can be one of the
|
|
457
|
+
# following: * the numeric identifier for the user * the email address of the
|
|
458
|
+
# user * the string literal `"me"`, indicating the requesting user
|
|
459
|
+
# @param [String] fields
|
|
460
|
+
# Selector specifying which fields to include in a partial response.
|
|
461
|
+
# @param [String] quota_user
|
|
462
|
+
# Available to use for quota purposes for server-side applications. Can be any
|
|
463
|
+
# arbitrary string assigned to a user, but should not exceed 40 characters.
|
|
464
|
+
# @param [Google::Apis::RequestOptions] options
|
|
465
|
+
# Request-specific options
|
|
466
|
+
#
|
|
467
|
+
# @yield [result, err] Result & error if block supplied
|
|
468
|
+
# @yieldparam result [Google::Apis::ClassroomV1::Teacher] parsed result object
|
|
469
|
+
# @yieldparam err [StandardError] error object if request failed
|
|
470
|
+
#
|
|
471
|
+
# @return [Google::Apis::ClassroomV1::Teacher]
|
|
472
|
+
#
|
|
473
|
+
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
|
|
474
|
+
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
|
|
475
|
+
# @raise [Google::Apis::AuthorizationError] Authorization is required
|
|
476
|
+
def get_course_teacher(course_id, user_id, fields: nil, quota_user: nil, options: nil, &block)
|
|
477
|
+
command = make_simple_command(:get, 'v1/courses/{courseId}/teachers/{userId}', options)
|
|
478
|
+
command.response_representation = Google::Apis::ClassroomV1::Teacher::Representation
|
|
479
|
+
command.response_class = Google::Apis::ClassroomV1::Teacher
|
|
480
|
+
command.params['courseId'] = course_id unless course_id.nil?
|
|
481
|
+
command.params['userId'] = user_id unless user_id.nil?
|
|
482
|
+
command.query['fields'] = fields unless fields.nil?
|
|
483
|
+
command.query['quotaUser'] = quota_user unless quota_user.nil?
|
|
484
|
+
execute_or_queue_command(command, &block)
|
|
485
|
+
end
|
|
486
|
+
|
|
487
|
+
# Deletes a teacher of a course. This method returns the following error codes: *
|
|
488
|
+
# `PERMISSION_DENIED` if the requesting user is not permitted to delete
|
|
489
|
+
# teachers of this course or for access errors. * `NOT_FOUND` if no teacher of
|
|
490
|
+
# this course has the requested ID or if the course does not exist. * `
|
|
491
|
+
# FAILED_PRECONDITION` if the requested ID belongs to the primary teacher of
|
|
492
|
+
# this course.
|
|
493
|
+
# @param [String] course_id
|
|
494
|
+
# Identifier of the course. This identifier can be either the Classroom-assigned
|
|
495
|
+
# identifier or an alias.
|
|
496
|
+
# @param [String] user_id
|
|
497
|
+
# Identifier of the teacher to delete. The identifier can be one of the
|
|
498
|
+
# following: * the numeric identifier for the user * the email address of the
|
|
499
|
+
# user * the string literal `"me"`, indicating the requesting user
|
|
500
|
+
# @param [String] fields
|
|
501
|
+
# Selector specifying which fields to include in a partial response.
|
|
502
|
+
# @param [String] quota_user
|
|
503
|
+
# Available to use for quota purposes for server-side applications. Can be any
|
|
504
|
+
# arbitrary string assigned to a user, but should not exceed 40 characters.
|
|
505
|
+
# @param [Google::Apis::RequestOptions] options
|
|
506
|
+
# Request-specific options
|
|
507
|
+
#
|
|
508
|
+
# @yield [result, err] Result & error if block supplied
|
|
509
|
+
# @yieldparam result [Google::Apis::ClassroomV1::Empty] parsed result object
|
|
510
|
+
# @yieldparam err [StandardError] error object if request failed
|
|
511
|
+
#
|
|
512
|
+
# @return [Google::Apis::ClassroomV1::Empty]
|
|
513
|
+
#
|
|
514
|
+
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
|
|
515
|
+
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
|
|
516
|
+
# @raise [Google::Apis::AuthorizationError] Authorization is required
|
|
517
|
+
def delete_course_teacher(course_id, user_id, fields: nil, quota_user: nil, options: nil, &block)
|
|
518
|
+
command = make_simple_command(:delete, 'v1/courses/{courseId}/teachers/{userId}', options)
|
|
519
|
+
command.response_representation = Google::Apis::ClassroomV1::Empty::Representation
|
|
520
|
+
command.response_class = Google::Apis::ClassroomV1::Empty
|
|
521
|
+
command.params['courseId'] = course_id unless course_id.nil?
|
|
522
|
+
command.params['userId'] = user_id unless user_id.nil?
|
|
523
|
+
command.query['fields'] = fields unless fields.nil?
|
|
524
|
+
command.query['quotaUser'] = quota_user unless quota_user.nil?
|
|
525
|
+
execute_or_queue_command(command, &block)
|
|
526
|
+
end
|
|
527
|
+
|
|
528
|
+
# Returns a list of teachers of this course that the requester is permitted to
|
|
529
|
+
# view. This method returns the following error codes: * `NOT_FOUND` if the
|
|
530
|
+
# course does not exist. * `PERMISSION_DENIED` for access errors.
|
|
531
|
+
# @param [String] course_id
|
|
532
|
+
# Identifier of the course. This identifier can be either the Classroom-assigned
|
|
533
|
+
# identifier or an alias.
|
|
534
|
+
# @param [Fixnum] page_size
|
|
535
|
+
# Maximum number of items to return. Zero means no maximum. The server may
|
|
536
|
+
# return fewer than the specified number of results.
|
|
537
|
+
# @param [String] page_token
|
|
538
|
+
# nextPageToken value returned from a previous list call, indicating that the
|
|
539
|
+
# subsequent page of results should be returned. The list request must be
|
|
540
|
+
# otherwise identical to the one that resulted in this token.
|
|
541
|
+
# @param [String] fields
|
|
542
|
+
# Selector specifying which fields to include in a partial response.
|
|
543
|
+
# @param [String] quota_user
|
|
544
|
+
# Available to use for quota purposes for server-side applications. Can be any
|
|
545
|
+
# arbitrary string assigned to a user, but should not exceed 40 characters.
|
|
546
|
+
# @param [Google::Apis::RequestOptions] options
|
|
547
|
+
# Request-specific options
|
|
548
|
+
#
|
|
549
|
+
# @yield [result, err] Result & error if block supplied
|
|
550
|
+
# @yieldparam result [Google::Apis::ClassroomV1::ListTeachersResponse] parsed result object
|
|
551
|
+
# @yieldparam err [StandardError] error object if request failed
|
|
552
|
+
#
|
|
553
|
+
# @return [Google::Apis::ClassroomV1::ListTeachersResponse]
|
|
554
|
+
#
|
|
555
|
+
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
|
|
556
|
+
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
|
|
557
|
+
# @raise [Google::Apis::AuthorizationError] Authorization is required
|
|
558
|
+
def list_course_teachers(course_id, page_size: nil, page_token: nil, fields: nil, quota_user: nil, options: nil, &block)
|
|
559
|
+
command = make_simple_command(:get, 'v1/courses/{courseId}/teachers', options)
|
|
560
|
+
command.response_representation = Google::Apis::ClassroomV1::ListTeachersResponse::Representation
|
|
561
|
+
command.response_class = Google::Apis::ClassroomV1::ListTeachersResponse
|
|
562
|
+
command.params['courseId'] = course_id unless course_id.nil?
|
|
563
|
+
command.query['pageSize'] = page_size unless page_size.nil?
|
|
564
|
+
command.query['pageToken'] = page_token unless page_token.nil?
|
|
565
|
+
command.query['fields'] = fields unless fields.nil?
|
|
566
|
+
command.query['quotaUser'] = quota_user unless quota_user.nil?
|
|
567
|
+
execute_or_queue_command(command, &block)
|
|
568
|
+
end
|
|
569
|
+
|
|
570
|
+
# Adds a user as a student of a course. This method returns the following error
|
|
571
|
+
# codes: * `PERMISSION_DENIED` if the requesting user is not permitted to create
|
|
572
|
+
# students in this course or for access errors. * `NOT_FOUND` if the requested
|
|
573
|
+
# course ID does not exist. * `FAILED_PRECONDITION` if the requested user's
|
|
574
|
+
# account is disabled, for the following request errors: *
|
|
575
|
+
# CourseMemberLimitReached * CourseNotModifiable *
|
|
576
|
+
# UserGroupsMembershipLimitReached * `ALREADY_EXISTS` if the user is already a
|
|
577
|
+
# student or teacher in the course.
|
|
578
|
+
# @param [String] course_id
|
|
579
|
+
# Identifier of the course to create the student in. This identifier can be
|
|
580
|
+
# either the Classroom-assigned identifier or an alias.
|
|
581
|
+
# @param [Google::Apis::ClassroomV1::Student] student_object
|
|
582
|
+
# @param [String] enrollment_code
|
|
583
|
+
# Enrollment code of the course to create the student in. This code is required
|
|
584
|
+
# if userId corresponds to the requesting user; it may be omitted if the
|
|
585
|
+
# requesting user has administrative permissions to create students for any user.
|
|
586
|
+
# @param [String] fields
|
|
587
|
+
# Selector specifying which fields to include in a partial response.
|
|
588
|
+
# @param [String] quota_user
|
|
589
|
+
# Available to use for quota purposes for server-side applications. Can be any
|
|
590
|
+
# arbitrary string assigned to a user, but should not exceed 40 characters.
|
|
591
|
+
# @param [Google::Apis::RequestOptions] options
|
|
592
|
+
# Request-specific options
|
|
593
|
+
#
|
|
594
|
+
# @yield [result, err] Result & error if block supplied
|
|
595
|
+
# @yieldparam result [Google::Apis::ClassroomV1::Student] parsed result object
|
|
596
|
+
# @yieldparam err [StandardError] error object if request failed
|
|
597
|
+
#
|
|
598
|
+
# @return [Google::Apis::ClassroomV1::Student]
|
|
599
|
+
#
|
|
600
|
+
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
|
|
601
|
+
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
|
|
602
|
+
# @raise [Google::Apis::AuthorizationError] Authorization is required
|
|
603
|
+
def create_course_student(course_id, student_object = nil, enrollment_code: nil, fields: nil, quota_user: nil, options: nil, &block)
|
|
604
|
+
command = make_simple_command(:post, 'v1/courses/{courseId}/students', options)
|
|
605
|
+
command.request_representation = Google::Apis::ClassroomV1::Student::Representation
|
|
606
|
+
command.request_object = student_object
|
|
607
|
+
command.response_representation = Google::Apis::ClassroomV1::Student::Representation
|
|
608
|
+
command.response_class = Google::Apis::ClassroomV1::Student
|
|
609
|
+
command.params['courseId'] = course_id unless course_id.nil?
|
|
610
|
+
command.query['enrollmentCode'] = enrollment_code unless enrollment_code.nil?
|
|
611
|
+
command.query['fields'] = fields unless fields.nil?
|
|
612
|
+
command.query['quotaUser'] = quota_user unless quota_user.nil?
|
|
613
|
+
execute_or_queue_command(command, &block)
|
|
614
|
+
end
|
|
615
|
+
|
|
616
|
+
# Returns a student of a course. This method returns the following error codes: *
|
|
617
|
+
# `PERMISSION_DENIED` if the requesting user is not permitted to view students
|
|
618
|
+
# of this course or for access errors. * `NOT_FOUND` if no student of this
|
|
619
|
+
# course has the requested ID or if the course does not exist.
|
|
620
|
+
# @param [String] course_id
|
|
621
|
+
# Identifier of the course. This identifier can be either the Classroom-assigned
|
|
622
|
+
# identifier or an alias.
|
|
623
|
+
# @param [String] user_id
|
|
624
|
+
# Identifier of the student to return. The identifier can be one of the
|
|
625
|
+
# following: * the numeric identifier for the user * the email address of the
|
|
626
|
+
# user * the string literal `"me"`, indicating the requesting user
|
|
627
|
+
# @param [String] fields
|
|
628
|
+
# Selector specifying which fields to include in a partial response.
|
|
629
|
+
# @param [String] quota_user
|
|
630
|
+
# Available to use for quota purposes for server-side applications. Can be any
|
|
631
|
+
# arbitrary string assigned to a user, but should not exceed 40 characters.
|
|
632
|
+
# @param [Google::Apis::RequestOptions] options
|
|
633
|
+
# Request-specific options
|
|
634
|
+
#
|
|
635
|
+
# @yield [result, err] Result & error if block supplied
|
|
636
|
+
# @yieldparam result [Google::Apis::ClassroomV1::Student] parsed result object
|
|
637
|
+
# @yieldparam err [StandardError] error object if request failed
|
|
638
|
+
#
|
|
639
|
+
# @return [Google::Apis::ClassroomV1::Student]
|
|
640
|
+
#
|
|
641
|
+
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
|
|
642
|
+
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
|
|
643
|
+
# @raise [Google::Apis::AuthorizationError] Authorization is required
|
|
644
|
+
def get_course_student(course_id, user_id, fields: nil, quota_user: nil, options: nil, &block)
|
|
645
|
+
command = make_simple_command(:get, 'v1/courses/{courseId}/students/{userId}', options)
|
|
646
|
+
command.response_representation = Google::Apis::ClassroomV1::Student::Representation
|
|
647
|
+
command.response_class = Google::Apis::ClassroomV1::Student
|
|
648
|
+
command.params['courseId'] = course_id unless course_id.nil?
|
|
649
|
+
command.params['userId'] = user_id unless user_id.nil?
|
|
650
|
+
command.query['fields'] = fields unless fields.nil?
|
|
651
|
+
command.query['quotaUser'] = quota_user unless quota_user.nil?
|
|
652
|
+
execute_or_queue_command(command, &block)
|
|
653
|
+
end
|
|
654
|
+
|
|
655
|
+
# Deletes a student of a course. This method returns the following error codes: *
|
|
656
|
+
# `PERMISSION_DENIED` if the requesting user is not permitted to delete
|
|
657
|
+
# students of this course or for access errors. * `NOT_FOUND` if no student of
|
|
658
|
+
# this course has the requested ID or if the course does not exist.
|
|
659
|
+
# @param [String] course_id
|
|
660
|
+
# Identifier of the course. This identifier can be either the Classroom-assigned
|
|
661
|
+
# identifier or an alias.
|
|
662
|
+
# @param [String] user_id
|
|
663
|
+
# Identifier of the student to delete. The identifier can be one of the
|
|
664
|
+
# following: * the numeric identifier for the user * the email address of the
|
|
665
|
+
# user * the string literal `"me"`, indicating the requesting user
|
|
666
|
+
# @param [String] fields
|
|
667
|
+
# Selector specifying which fields to include in a partial response.
|
|
668
|
+
# @param [String] quota_user
|
|
669
|
+
# Available to use for quota purposes for server-side applications. Can be any
|
|
670
|
+
# arbitrary string assigned to a user, but should not exceed 40 characters.
|
|
671
|
+
# @param [Google::Apis::RequestOptions] options
|
|
672
|
+
# Request-specific options
|
|
673
|
+
#
|
|
674
|
+
# @yield [result, err] Result & error if block supplied
|
|
675
|
+
# @yieldparam result [Google::Apis::ClassroomV1::Empty] parsed result object
|
|
676
|
+
# @yieldparam err [StandardError] error object if request failed
|
|
677
|
+
#
|
|
678
|
+
# @return [Google::Apis::ClassroomV1::Empty]
|
|
679
|
+
#
|
|
680
|
+
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
|
|
681
|
+
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
|
|
682
|
+
# @raise [Google::Apis::AuthorizationError] Authorization is required
|
|
683
|
+
def delete_course_student(course_id, user_id, fields: nil, quota_user: nil, options: nil, &block)
|
|
684
|
+
command = make_simple_command(:delete, 'v1/courses/{courseId}/students/{userId}', options)
|
|
685
|
+
command.response_representation = Google::Apis::ClassroomV1::Empty::Representation
|
|
686
|
+
command.response_class = Google::Apis::ClassroomV1::Empty
|
|
687
|
+
command.params['courseId'] = course_id unless course_id.nil?
|
|
688
|
+
command.params['userId'] = user_id unless user_id.nil?
|
|
689
|
+
command.query['fields'] = fields unless fields.nil?
|
|
690
|
+
command.query['quotaUser'] = quota_user unless quota_user.nil?
|
|
691
|
+
execute_or_queue_command(command, &block)
|
|
692
|
+
end
|
|
693
|
+
|
|
694
|
+
# Returns a list of students of this course that the requester is permitted to
|
|
695
|
+
# view. This method returns the following error codes: * `NOT_FOUND` if the
|
|
696
|
+
# course does not exist. * `PERMISSION_DENIED` for access errors.
|
|
697
|
+
# @param [String] course_id
|
|
698
|
+
# Identifier of the course. This identifier can be either the Classroom-assigned
|
|
699
|
+
# identifier or an alias.
|
|
700
|
+
# @param [Fixnum] page_size
|
|
701
|
+
# Maximum number of items to return. Zero means no maximum. The server may
|
|
702
|
+
# return fewer than the specified number of results.
|
|
703
|
+
# @param [String] page_token
|
|
704
|
+
# nextPageToken value returned from a previous list call, indicating that the
|
|
705
|
+
# subsequent page of results should be returned. The list request must be
|
|
706
|
+
# otherwise identical to the one that resulted in this token.
|
|
707
|
+
# @param [String] fields
|
|
708
|
+
# Selector specifying which fields to include in a partial response.
|
|
709
|
+
# @param [String] quota_user
|
|
710
|
+
# Available to use for quota purposes for server-side applications. Can be any
|
|
711
|
+
# arbitrary string assigned to a user, but should not exceed 40 characters.
|
|
712
|
+
# @param [Google::Apis::RequestOptions] options
|
|
713
|
+
# Request-specific options
|
|
714
|
+
#
|
|
715
|
+
# @yield [result, err] Result & error if block supplied
|
|
716
|
+
# @yieldparam result [Google::Apis::ClassroomV1::ListStudentsResponse] parsed result object
|
|
717
|
+
# @yieldparam err [StandardError] error object if request failed
|
|
718
|
+
#
|
|
719
|
+
# @return [Google::Apis::ClassroomV1::ListStudentsResponse]
|
|
720
|
+
#
|
|
721
|
+
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
|
|
722
|
+
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
|
|
723
|
+
# @raise [Google::Apis::AuthorizationError] Authorization is required
|
|
724
|
+
def list_course_students(course_id, page_size: nil, page_token: nil, fields: nil, quota_user: nil, options: nil, &block)
|
|
725
|
+
command = make_simple_command(:get, 'v1/courses/{courseId}/students', options)
|
|
726
|
+
command.response_representation = Google::Apis::ClassroomV1::ListStudentsResponse::Representation
|
|
727
|
+
command.response_class = Google::Apis::ClassroomV1::ListStudentsResponse
|
|
728
|
+
command.params['courseId'] = course_id unless course_id.nil?
|
|
729
|
+
command.query['pageSize'] = page_size unless page_size.nil?
|
|
730
|
+
command.query['pageToken'] = page_token unless page_token.nil?
|
|
731
|
+
command.query['fields'] = fields unless fields.nil?
|
|
732
|
+
command.query['quotaUser'] = quota_user unless quota_user.nil?
|
|
733
|
+
execute_or_queue_command(command, &block)
|
|
734
|
+
end
|
|
735
|
+
|
|
736
|
+
# Creates an invitation. Only one invitation for a user and course may exist at
|
|
737
|
+
# a time. Delete and re-create an invitation to make changes. This method
|
|
738
|
+
# returns the following error codes: * `PERMISSION_DENIED` if the requesting
|
|
739
|
+
# user is not permitted to create invitations for this course or for access
|
|
740
|
+
# errors. * `NOT_FOUND` if the course or the user does not exist. * `
|
|
741
|
+
# FAILED_PRECONDITION` if the requested user's account is disabled or if the
|
|
742
|
+
# user already has this role or a role with greater permissions. * `
|
|
743
|
+
# ALREADY_EXISTS` if an invitation for the specified user and course already
|
|
744
|
+
# exists.
|
|
745
|
+
# @param [Google::Apis::ClassroomV1::Invitation] invitation_object
|
|
746
|
+
# @param [String] fields
|
|
747
|
+
# Selector specifying which fields to include in a partial response.
|
|
748
|
+
# @param [String] quota_user
|
|
749
|
+
# Available to use for quota purposes for server-side applications. Can be any
|
|
750
|
+
# arbitrary string assigned to a user, but should not exceed 40 characters.
|
|
751
|
+
# @param [Google::Apis::RequestOptions] options
|
|
752
|
+
# Request-specific options
|
|
753
|
+
#
|
|
754
|
+
# @yield [result, err] Result & error if block supplied
|
|
755
|
+
# @yieldparam result [Google::Apis::ClassroomV1::Invitation] parsed result object
|
|
756
|
+
# @yieldparam err [StandardError] error object if request failed
|
|
757
|
+
#
|
|
758
|
+
# @return [Google::Apis::ClassroomV1::Invitation]
|
|
759
|
+
#
|
|
760
|
+
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
|
|
761
|
+
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
|
|
762
|
+
# @raise [Google::Apis::AuthorizationError] Authorization is required
|
|
763
|
+
def create_invitation(invitation_object = nil, fields: nil, quota_user: nil, options: nil, &block)
|
|
764
|
+
command = make_simple_command(:post, 'v1/invitations', options)
|
|
765
|
+
command.request_representation = Google::Apis::ClassroomV1::Invitation::Representation
|
|
766
|
+
command.request_object = invitation_object
|
|
767
|
+
command.response_representation = Google::Apis::ClassroomV1::Invitation::Representation
|
|
768
|
+
command.response_class = Google::Apis::ClassroomV1::Invitation
|
|
769
|
+
command.query['fields'] = fields unless fields.nil?
|
|
770
|
+
command.query['quotaUser'] = quota_user unless quota_user.nil?
|
|
771
|
+
execute_or_queue_command(command, &block)
|
|
772
|
+
end
|
|
773
|
+
|
|
774
|
+
# Returns an invitation. This method returns the following error codes: * `
|
|
775
|
+
# PERMISSION_DENIED` if the requesting user is not permitted to view the
|
|
776
|
+
# requested invitation or for access errors. * `NOT_FOUND` if no invitation
|
|
777
|
+
# exists with the requested ID.
|
|
778
|
+
# @param [String] id
|
|
779
|
+
# Identifier of the invitation to return.
|
|
780
|
+
# @param [String] fields
|
|
781
|
+
# Selector specifying which fields to include in a partial response.
|
|
782
|
+
# @param [String] quota_user
|
|
783
|
+
# Available to use for quota purposes for server-side applications. Can be any
|
|
784
|
+
# arbitrary string assigned to a user, but should not exceed 40 characters.
|
|
785
|
+
# @param [Google::Apis::RequestOptions] options
|
|
786
|
+
# Request-specific options
|
|
787
|
+
#
|
|
788
|
+
# @yield [result, err] Result & error if block supplied
|
|
789
|
+
# @yieldparam result [Google::Apis::ClassroomV1::Invitation] parsed result object
|
|
790
|
+
# @yieldparam err [StandardError] error object if request failed
|
|
791
|
+
#
|
|
792
|
+
# @return [Google::Apis::ClassroomV1::Invitation]
|
|
793
|
+
#
|
|
794
|
+
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
|
|
795
|
+
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
|
|
796
|
+
# @raise [Google::Apis::AuthorizationError] Authorization is required
|
|
797
|
+
def get_invitation(id, fields: nil, quota_user: nil, options: nil, &block)
|
|
798
|
+
command = make_simple_command(:get, 'v1/invitations/{id}', options)
|
|
799
|
+
command.response_representation = Google::Apis::ClassroomV1::Invitation::Representation
|
|
800
|
+
command.response_class = Google::Apis::ClassroomV1::Invitation
|
|
801
|
+
command.params['id'] = id unless id.nil?
|
|
802
|
+
command.query['fields'] = fields unless fields.nil?
|
|
803
|
+
command.query['quotaUser'] = quota_user unless quota_user.nil?
|
|
804
|
+
execute_or_queue_command(command, &block)
|
|
805
|
+
end
|
|
806
|
+
|
|
807
|
+
# Deletes an invitation. This method returns the following error codes: * `
|
|
808
|
+
# PERMISSION_DENIED` if the requesting user is not permitted to delete the
|
|
809
|
+
# requested invitation or for access errors. * `NOT_FOUND` if no invitation
|
|
810
|
+
# exists with the requested ID.
|
|
811
|
+
# @param [String] id
|
|
812
|
+
# Identifier of the invitation to delete.
|
|
813
|
+
# @param [String] fields
|
|
814
|
+
# Selector specifying which fields to include in a partial response.
|
|
815
|
+
# @param [String] quota_user
|
|
816
|
+
# Available to use for quota purposes for server-side applications. Can be any
|
|
817
|
+
# arbitrary string assigned to a user, but should not exceed 40 characters.
|
|
818
|
+
# @param [Google::Apis::RequestOptions] options
|
|
819
|
+
# Request-specific options
|
|
820
|
+
#
|
|
821
|
+
# @yield [result, err] Result & error if block supplied
|
|
822
|
+
# @yieldparam result [Google::Apis::ClassroomV1::Empty] parsed result object
|
|
823
|
+
# @yieldparam err [StandardError] error object if request failed
|
|
824
|
+
#
|
|
825
|
+
# @return [Google::Apis::ClassroomV1::Empty]
|
|
826
|
+
#
|
|
827
|
+
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
|
|
828
|
+
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
|
|
829
|
+
# @raise [Google::Apis::AuthorizationError] Authorization is required
|
|
830
|
+
def delete_invitation(id, fields: nil, quota_user: nil, options: nil, &block)
|
|
831
|
+
command = make_simple_command(:delete, 'v1/invitations/{id}', options)
|
|
832
|
+
command.response_representation = Google::Apis::ClassroomV1::Empty::Representation
|
|
833
|
+
command.response_class = Google::Apis::ClassroomV1::Empty
|
|
834
|
+
command.params['id'] = id unless id.nil?
|
|
835
|
+
command.query['fields'] = fields unless fields.nil?
|
|
836
|
+
command.query['quotaUser'] = quota_user unless quota_user.nil?
|
|
837
|
+
execute_or_queue_command(command, &block)
|
|
838
|
+
end
|
|
839
|
+
|
|
840
|
+
# Returns a list of invitations that the requesting user is permitted to view,
|
|
841
|
+
# restricted to those that match the list request. *Note:* At least one of `
|
|
842
|
+
# user_id` or `course_id` must be supplied. Both fields can be supplied. This
|
|
843
|
+
# method returns the following error codes: * `PERMISSION_DENIED` for access
|
|
844
|
+
# errors.
|
|
845
|
+
# @param [String] user_id
|
|
846
|
+
# Restricts returned invitations to those for a specific user. The identifier
|
|
847
|
+
# can be one of the following: * the numeric identifier for the user * the email
|
|
848
|
+
# address of the user * the string literal `"me"`, indicating the requesting
|
|
849
|
+
# user
|
|
850
|
+
# @param [String] course_id
|
|
851
|
+
# Restricts returned invitations to those for a course with the specified
|
|
852
|
+
# identifier.
|
|
853
|
+
# @param [Fixnum] page_size
|
|
854
|
+
# Maximum number of items to return. Zero means no maximum. The server may
|
|
855
|
+
# return fewer than the specified number of results.
|
|
856
|
+
# @param [String] page_token
|
|
857
|
+
# nextPageToken value returned from a previous list call, indicating that the
|
|
858
|
+
# subsequent page of results should be returned. The list request must be
|
|
859
|
+
# otherwise identical to the one that resulted in this token.
|
|
860
|
+
# @param [String] fields
|
|
861
|
+
# Selector specifying which fields to include in a partial response.
|
|
862
|
+
# @param [String] quota_user
|
|
863
|
+
# Available to use for quota purposes for server-side applications. Can be any
|
|
864
|
+
# arbitrary string assigned to a user, but should not exceed 40 characters.
|
|
865
|
+
# @param [Google::Apis::RequestOptions] options
|
|
866
|
+
# Request-specific options
|
|
867
|
+
#
|
|
868
|
+
# @yield [result, err] Result & error if block supplied
|
|
869
|
+
# @yieldparam result [Google::Apis::ClassroomV1::ListInvitationsResponse] parsed result object
|
|
870
|
+
# @yieldparam err [StandardError] error object if request failed
|
|
871
|
+
#
|
|
872
|
+
# @return [Google::Apis::ClassroomV1::ListInvitationsResponse]
|
|
873
|
+
#
|
|
874
|
+
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
|
|
875
|
+
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
|
|
876
|
+
# @raise [Google::Apis::AuthorizationError] Authorization is required
|
|
877
|
+
def list_invitations(user_id: nil, course_id: nil, page_size: nil, page_token: nil, fields: nil, quota_user: nil, options: nil, &block)
|
|
878
|
+
command = make_simple_command(:get, 'v1/invitations', options)
|
|
879
|
+
command.response_representation = Google::Apis::ClassroomV1::ListInvitationsResponse::Representation
|
|
880
|
+
command.response_class = Google::Apis::ClassroomV1::ListInvitationsResponse
|
|
881
|
+
command.query['userId'] = user_id unless user_id.nil?
|
|
882
|
+
command.query['courseId'] = course_id unless course_id.nil?
|
|
883
|
+
command.query['pageSize'] = page_size unless page_size.nil?
|
|
884
|
+
command.query['pageToken'] = page_token unless page_token.nil?
|
|
885
|
+
command.query['fields'] = fields unless fields.nil?
|
|
886
|
+
command.query['quotaUser'] = quota_user unless quota_user.nil?
|
|
887
|
+
execute_or_queue_command(command, &block)
|
|
888
|
+
end
|
|
889
|
+
|
|
890
|
+
# Accepts an invitation, removing it and adding the invited user to the teachers
|
|
891
|
+
# or students (as appropriate) of the specified course. Only the invited user
|
|
892
|
+
# may accept an invitation. This method returns the following error codes: * `
|
|
893
|
+
# PERMISSION_DENIED` if the requesting user is not permitted to accept the
|
|
894
|
+
# requested invitation or for access errors. * `FAILED_PRECONDITION` for the
|
|
895
|
+
# following request errors: * CourseMemberLimitReached * CourseNotModifiable *
|
|
896
|
+
# CourseTeacherLimitReached * UserGroupsMembershipLimitReached * `NOT_FOUND` if
|
|
897
|
+
# no invitation exists with the requested ID.
|
|
898
|
+
# @param [String] id
|
|
899
|
+
# Identifier of the invitation to accept.
|
|
900
|
+
# @param [String] fields
|
|
901
|
+
# Selector specifying which fields to include in a partial response.
|
|
902
|
+
# @param [String] quota_user
|
|
903
|
+
# Available to use for quota purposes for server-side applications. Can be any
|
|
904
|
+
# arbitrary string assigned to a user, but should not exceed 40 characters.
|
|
905
|
+
# @param [Google::Apis::RequestOptions] options
|
|
906
|
+
# Request-specific options
|
|
907
|
+
#
|
|
908
|
+
# @yield [result, err] Result & error if block supplied
|
|
909
|
+
# @yieldparam result [Google::Apis::ClassroomV1::Empty] parsed result object
|
|
910
|
+
# @yieldparam err [StandardError] error object if request failed
|
|
911
|
+
#
|
|
912
|
+
# @return [Google::Apis::ClassroomV1::Empty]
|
|
913
|
+
#
|
|
914
|
+
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
|
|
915
|
+
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
|
|
916
|
+
# @raise [Google::Apis::AuthorizationError] Authorization is required
|
|
917
|
+
def accept_invitation(id, fields: nil, quota_user: nil, options: nil, &block)
|
|
918
|
+
command = make_simple_command(:post, 'v1/invitations/{id}:accept', options)
|
|
919
|
+
command.response_representation = Google::Apis::ClassroomV1::Empty::Representation
|
|
920
|
+
command.response_class = Google::Apis::ClassroomV1::Empty
|
|
921
|
+
command.params['id'] = id unless id.nil?
|
|
922
|
+
command.query['fields'] = fields unless fields.nil?
|
|
923
|
+
command.query['quotaUser'] = quota_user unless quota_user.nil?
|
|
924
|
+
execute_or_queue_command(command, &block)
|
|
925
|
+
end
|
|
926
|
+
|
|
927
|
+
# Returns a user profile. This method returns the following error codes: * `
|
|
928
|
+
# PERMISSION_DENIED` if the requesting user is not permitted to access this user
|
|
929
|
+
# profile or if no profile exists with the requested ID or for access errors.
|
|
930
|
+
# @param [String] user_id
|
|
931
|
+
# Identifier of the profile to return. The identifier can be one of the
|
|
932
|
+
# following: * the numeric identifier for the user * the email address of the
|
|
933
|
+
# user * the string literal `"me"`, indicating the requesting user
|
|
934
|
+
# @param [String] fields
|
|
935
|
+
# Selector specifying which fields to include in a partial response.
|
|
936
|
+
# @param [String] quota_user
|
|
937
|
+
# Available to use for quota purposes for server-side applications. Can be any
|
|
938
|
+
# arbitrary string assigned to a user, but should not exceed 40 characters.
|
|
939
|
+
# @param [Google::Apis::RequestOptions] options
|
|
940
|
+
# Request-specific options
|
|
941
|
+
#
|
|
942
|
+
# @yield [result, err] Result & error if block supplied
|
|
943
|
+
# @yieldparam result [Google::Apis::ClassroomV1::UserProfile] parsed result object
|
|
944
|
+
# @yieldparam err [StandardError] error object if request failed
|
|
945
|
+
#
|
|
946
|
+
# @return [Google::Apis::ClassroomV1::UserProfile]
|
|
947
|
+
#
|
|
948
|
+
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
|
|
949
|
+
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
|
|
950
|
+
# @raise [Google::Apis::AuthorizationError] Authorization is required
|
|
951
|
+
def get_user_profile(user_id, fields: nil, quota_user: nil, options: nil, &block)
|
|
952
|
+
command = make_simple_command(:get, 'v1/userProfiles/{userId}', options)
|
|
953
|
+
command.response_representation = Google::Apis::ClassroomV1::UserProfile::Representation
|
|
954
|
+
command.response_class = Google::Apis::ClassroomV1::UserProfile
|
|
955
|
+
command.params['userId'] = user_id unless user_id.nil?
|
|
956
|
+
command.query['fields'] = fields unless fields.nil?
|
|
957
|
+
command.query['quotaUser'] = quota_user unless quota_user.nil?
|
|
958
|
+
execute_or_queue_command(command, &block)
|
|
959
|
+
end
|
|
960
|
+
|
|
961
|
+
protected
|
|
962
|
+
|
|
963
|
+
def apply_command_defaults(command)
|
|
964
|
+
command.query['key'] = key unless key.nil?
|
|
965
|
+
command.query['quotaUser'] = quota_user unless quota_user.nil?
|
|
966
|
+
end
|
|
967
|
+
end
|
|
968
|
+
end
|
|
969
|
+
end
|
|
970
|
+
end
|