google-api-client 0.8.6 → 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 +41 -2
- data/CONTRIBUTING.md +31 -0
- data/Gemfile +32 -2
- 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.rb +35 -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/adexchangeseller_v2_0.rb +38 -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/admin_datatransfer_v1.rb +37 -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_directory_v1.rb +113 -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_reports_v1.rb +38 -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/adsense_v1_4.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/adsensehost_v4_1.rb +35 -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/analytics_v3.rb +49 -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/androidenterprise_v1.rb +35 -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/androidpublisher_v2.rb +34 -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/appengine_v1beta4.rb +35 -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/appsactivity_v1.rb +46 -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/appstate_v1.rb +34 -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/autoscaler_v1beta2.rb +38 -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/bigquery_v2.rb +52 -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/blogger_v3.rb +37 -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/books_v1.rb +34 -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/calendar_v3.rb +37 -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/{lib/google/api_client/service_account.rb → generated/google/apis/civicinfo_v2.rb} +18 -8
- 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/generated/google/apis/classroom_v1.rb +49 -0
- 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_v1beta1.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/cloudbilling_v1.rb +35 -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/clouddebugger_v2.rb +41 -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/cloudmonitoring_v2beta2.rb +37 -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/cloudresourcemanager_v1beta1.rb +38 -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/cloudtrace_v1.rb +35 -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/clouduseraccounts_beta.rb +43 -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/compute_beta.rb +49 -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_v1.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/container_v1.rb +35 -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_v1beta1.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/content_v2.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/coordinate_v1.rb +37 -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/{lib/google/api_client/auth/compute_service_account.rb → generated/google/apis/customsearch_v1.rb} +13 -10
- 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/generated/google/apis/datastore_v1beta2.rb +40 -0
- 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/deploymentmanager_v2.rb +44 -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_v2beta2.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/dfareporting_v2_1.rb +37 -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/discovery_v1.rb +32 -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/dns_v1.rb +44 -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/doubleclickbidmanager_v1.rb +31 -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/doubleclicksearch_v2.rb +35 -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/drive_v2.rb +58 -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_v3.rb +55 -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/fitness_v1.rb +49 -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/fusiontables_v2.rb +37 -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/games_configuration_v1configuration.rb +34 -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_management_v1management.rb +37 -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_v1.rb +40 -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/gan_v1beta1.rb +31 -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/genomics_v1.rb +49 -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_v1beta2.rb +46 -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/gmail_v1.rb +52 -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/groupsmigration_v1.rb +34 -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/groupssettings_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/identitytoolkit_v3.rb +31 -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/{spec/google/api_client/request_spec.rb → generated/google/apis/kgsearch_v1.rb} +16 -13
- 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/generated/google/apis/licensing_v1.rb +34 -0
- 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/logging_v1beta3.rb +47 -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/manager_v1beta2.rb +53 -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/mapsengine_v1.rb +38 -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/mirror_v1.rb +37 -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/oauth2_v2.rb +43 -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/pagespeedonline_v2.rb +32 -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/partners_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/plus_domains_v1.rb +61 -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_v1.rb +43 -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/prediction_v1_6.rb +44 -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/proximitybeacon_v1beta1.rb +31 -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/pubsub_v1.rb +37 -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_v1beta2.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/qpx_express_v1.rb +31 -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/replicapool_v1beta2.rb +44 -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/replicapoolupdater_v1beta1.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/reseller_v1.rb +37 -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/resourceviews_v1beta2.rb +50 -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/script_v1.rb +61 -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/site_verification_v1.rb +37 -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/sqladmin_v1beta4.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/storage_v1.rb +46 -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/storagetransfer_v1.rb +35 -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/tagmanager_v1.rb +52 -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/taskqueue_v1beta2.rb +37 -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/tasks_v1.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/translate_v2.rb +31 -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/urlshortener_v1.rb +34 -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/webmasters_v3.rb +37 -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/youtube_analytics_v1.rb +46 -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_v3.rb +49 -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/youtubereporting_v1.rb +38 -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/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 +1 -0
- data/lib/google/api_client/auth/storage.rb +4 -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.rb +48 -0
- 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.rb +70 -0
- 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/options.rb +85 -0
- data/lib/google/apis/version.rb +39 -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.rb +131 -44
- data/spec/spec_helper/load_path_spec.rb +33 -0
- data/third_party/hurley_patches.rb +103 -0
- metadata +533 -170
- data/lib/compat/multi_json.rb +0 -19
- data/lib/google/api_client.rb +0 -750
- 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 -326
- data/lib/google/api_client/charset.rb +0 -33
- data/lib/google/api_client/discovery/api.rb +0 -310
- 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 -117
- 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.rb +0 -233
- 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/spec/google/api_client/batch_spec.rb +0 -248
- data/spec/google/api_client/discovery_spec.rb +0 -708
- 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,1968 @@
|
|
|
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 CalendarV3
|
|
23
|
+
# Calendar API
|
|
24
|
+
#
|
|
25
|
+
# Lets you manipulate events and other calendar data.
|
|
26
|
+
#
|
|
27
|
+
# @example
|
|
28
|
+
# require 'google/apis/calendar_v3'
|
|
29
|
+
#
|
|
30
|
+
# Calendar = Google::Apis::CalendarV3 # Alias the module
|
|
31
|
+
# service = Calendar::CalendarService.new
|
|
32
|
+
#
|
|
33
|
+
# @see https://developers.google.com/google-apps/calendar/firstapp
|
|
34
|
+
class CalendarService < Google::Apis::Core::BaseService
|
|
35
|
+
# @return [String]
|
|
36
|
+
# API key. Your API key identifies your project and provides you with API access,
|
|
37
|
+
# quota, and reports. Required unless you provide an OAuth 2.0 token.
|
|
38
|
+
attr_accessor :key
|
|
39
|
+
|
|
40
|
+
# @return [String]
|
|
41
|
+
# Available to use for quota purposes for server-side applications. Can be any
|
|
42
|
+
# arbitrary string assigned to a user, but should not exceed 40 characters.
|
|
43
|
+
# Overrides userIp if both are provided.
|
|
44
|
+
attr_accessor :quota_user
|
|
45
|
+
|
|
46
|
+
# @return [String]
|
|
47
|
+
# IP address of the site where the request originates. Use this if you want to
|
|
48
|
+
# enforce per-user limits.
|
|
49
|
+
attr_accessor :user_ip
|
|
50
|
+
|
|
51
|
+
def initialize
|
|
52
|
+
super('https://www.googleapis.com/', 'calendar/v3/')
|
|
53
|
+
end
|
|
54
|
+
|
|
55
|
+
# Deletes an access control rule.
|
|
56
|
+
# @param [String] calendar_id
|
|
57
|
+
# Calendar identifier. To retrieve calendar IDs call the calendarList.list
|
|
58
|
+
# method. If you want to access the primary calendar of the currently logged in
|
|
59
|
+
# user, use the "primary" keyword.
|
|
60
|
+
# @param [String] rule_id
|
|
61
|
+
# ACL rule identifier.
|
|
62
|
+
# @param [String] fields
|
|
63
|
+
# Selector specifying which fields to include in a partial response.
|
|
64
|
+
# @param [String] quota_user
|
|
65
|
+
# Available to use for quota purposes for server-side applications. Can be any
|
|
66
|
+
# arbitrary string assigned to a user, but should not exceed 40 characters.
|
|
67
|
+
# Overrides userIp if both are provided.
|
|
68
|
+
# @param [String] user_ip
|
|
69
|
+
# IP address of the site where the request originates. Use this if you want to
|
|
70
|
+
# enforce per-user limits.
|
|
71
|
+
# @param [Google::Apis::RequestOptions] options
|
|
72
|
+
# Request-specific options
|
|
73
|
+
#
|
|
74
|
+
# @yield [result, err] Result & error if block supplied
|
|
75
|
+
# @yieldparam result [NilClass] No result returned for this method
|
|
76
|
+
# @yieldparam err [StandardError] error object if request failed
|
|
77
|
+
#
|
|
78
|
+
# @return [void]
|
|
79
|
+
#
|
|
80
|
+
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
|
|
81
|
+
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
|
|
82
|
+
# @raise [Google::Apis::AuthorizationError] Authorization is required
|
|
83
|
+
def delete_acl(calendar_id, rule_id, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block)
|
|
84
|
+
command = make_simple_command(:delete, 'calendars/{calendarId}/acl/{ruleId}', options)
|
|
85
|
+
command.params['calendarId'] = calendar_id unless calendar_id.nil?
|
|
86
|
+
command.params['ruleId'] = rule_id unless rule_id.nil?
|
|
87
|
+
command.query['fields'] = fields unless fields.nil?
|
|
88
|
+
command.query['quotaUser'] = quota_user unless quota_user.nil?
|
|
89
|
+
command.query['userIp'] = user_ip unless user_ip.nil?
|
|
90
|
+
execute_or_queue_command(command, &block)
|
|
91
|
+
end
|
|
92
|
+
|
|
93
|
+
# Returns an access control rule.
|
|
94
|
+
# @param [String] calendar_id
|
|
95
|
+
# Calendar identifier. To retrieve calendar IDs call the calendarList.list
|
|
96
|
+
# method. If you want to access the primary calendar of the currently logged in
|
|
97
|
+
# user, use the "primary" keyword.
|
|
98
|
+
# @param [String] rule_id
|
|
99
|
+
# ACL rule identifier.
|
|
100
|
+
# @param [String] fields
|
|
101
|
+
# Selector specifying which fields to include in a partial response.
|
|
102
|
+
# @param [String] quota_user
|
|
103
|
+
# Available to use for quota purposes for server-side applications. Can be any
|
|
104
|
+
# arbitrary string assigned to a user, but should not exceed 40 characters.
|
|
105
|
+
# Overrides userIp if both are provided.
|
|
106
|
+
# @param [String] user_ip
|
|
107
|
+
# IP address of the site where the request originates. Use this if you want to
|
|
108
|
+
# enforce per-user limits.
|
|
109
|
+
# @param [Google::Apis::RequestOptions] options
|
|
110
|
+
# Request-specific options
|
|
111
|
+
#
|
|
112
|
+
# @yield [result, err] Result & error if block supplied
|
|
113
|
+
# @yieldparam result [Google::Apis::CalendarV3::AclRule] parsed result object
|
|
114
|
+
# @yieldparam err [StandardError] error object if request failed
|
|
115
|
+
#
|
|
116
|
+
# @return [Google::Apis::CalendarV3::AclRule]
|
|
117
|
+
#
|
|
118
|
+
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
|
|
119
|
+
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
|
|
120
|
+
# @raise [Google::Apis::AuthorizationError] Authorization is required
|
|
121
|
+
def get_acl(calendar_id, rule_id, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block)
|
|
122
|
+
command = make_simple_command(:get, 'calendars/{calendarId}/acl/{ruleId}', options)
|
|
123
|
+
command.response_representation = Google::Apis::CalendarV3::AclRule::Representation
|
|
124
|
+
command.response_class = Google::Apis::CalendarV3::AclRule
|
|
125
|
+
command.params['calendarId'] = calendar_id unless calendar_id.nil?
|
|
126
|
+
command.params['ruleId'] = rule_id unless rule_id.nil?
|
|
127
|
+
command.query['fields'] = fields unless fields.nil?
|
|
128
|
+
command.query['quotaUser'] = quota_user unless quota_user.nil?
|
|
129
|
+
command.query['userIp'] = user_ip unless user_ip.nil?
|
|
130
|
+
execute_or_queue_command(command, &block)
|
|
131
|
+
end
|
|
132
|
+
|
|
133
|
+
# Creates an access control rule.
|
|
134
|
+
# @param [String] calendar_id
|
|
135
|
+
# Calendar identifier. To retrieve calendar IDs call the calendarList.list
|
|
136
|
+
# method. If you want to access the primary calendar of the currently logged in
|
|
137
|
+
# user, use the "primary" keyword.
|
|
138
|
+
# @param [Google::Apis::CalendarV3::AclRule] acl_rule_object
|
|
139
|
+
# @param [String] fields
|
|
140
|
+
# Selector specifying which fields to include in a partial response.
|
|
141
|
+
# @param [String] quota_user
|
|
142
|
+
# Available to use for quota purposes for server-side applications. Can be any
|
|
143
|
+
# arbitrary string assigned to a user, but should not exceed 40 characters.
|
|
144
|
+
# Overrides userIp if both are provided.
|
|
145
|
+
# @param [String] user_ip
|
|
146
|
+
# IP address of the site where the request originates. Use this if you want to
|
|
147
|
+
# enforce per-user limits.
|
|
148
|
+
# @param [Google::Apis::RequestOptions] options
|
|
149
|
+
# Request-specific options
|
|
150
|
+
#
|
|
151
|
+
# @yield [result, err] Result & error if block supplied
|
|
152
|
+
# @yieldparam result [Google::Apis::CalendarV3::AclRule] parsed result object
|
|
153
|
+
# @yieldparam err [StandardError] error object if request failed
|
|
154
|
+
#
|
|
155
|
+
# @return [Google::Apis::CalendarV3::AclRule]
|
|
156
|
+
#
|
|
157
|
+
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
|
|
158
|
+
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
|
|
159
|
+
# @raise [Google::Apis::AuthorizationError] Authorization is required
|
|
160
|
+
def insert_acl(calendar_id, acl_rule_object = nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block)
|
|
161
|
+
command = make_simple_command(:post, 'calendars/{calendarId}/acl', options)
|
|
162
|
+
command.request_representation = Google::Apis::CalendarV3::AclRule::Representation
|
|
163
|
+
command.request_object = acl_rule_object
|
|
164
|
+
command.response_representation = Google::Apis::CalendarV3::AclRule::Representation
|
|
165
|
+
command.response_class = Google::Apis::CalendarV3::AclRule
|
|
166
|
+
command.params['calendarId'] = calendar_id unless calendar_id.nil?
|
|
167
|
+
command.query['fields'] = fields unless fields.nil?
|
|
168
|
+
command.query['quotaUser'] = quota_user unless quota_user.nil?
|
|
169
|
+
command.query['userIp'] = user_ip unless user_ip.nil?
|
|
170
|
+
execute_or_queue_command(command, &block)
|
|
171
|
+
end
|
|
172
|
+
|
|
173
|
+
# Returns the rules in the access control list for the calendar.
|
|
174
|
+
# @param [String] calendar_id
|
|
175
|
+
# Calendar identifier. To retrieve calendar IDs call the calendarList.list
|
|
176
|
+
# method. If you want to access the primary calendar of the currently logged in
|
|
177
|
+
# user, use the "primary" keyword.
|
|
178
|
+
# @param [Fixnum] max_results
|
|
179
|
+
# Maximum number of entries returned on one result page. By default the value is
|
|
180
|
+
# 100 entries. The page size can never be larger than 250 entries. Optional.
|
|
181
|
+
# @param [String] page_token
|
|
182
|
+
# Token specifying which result page to return. Optional.
|
|
183
|
+
# @param [Boolean] show_deleted
|
|
184
|
+
# Whether to include deleted ACLs in the result. Deleted ACLs are represented by
|
|
185
|
+
# role equal to "none". Deleted ACLs will always be included if syncToken is
|
|
186
|
+
# provided. Optional. The default is False.
|
|
187
|
+
# @param [String] sync_token
|
|
188
|
+
# Token obtained from the nextSyncToken field returned on the last page of
|
|
189
|
+
# results from the previous list request. It makes the result of this list
|
|
190
|
+
# request contain only entries that have changed since then. All entries deleted
|
|
191
|
+
# since the previous list request will always be in the result set and it is not
|
|
192
|
+
# allowed to set showDeleted to False.
|
|
193
|
+
# If the syncToken expires, the server will respond with a 410 GONE response
|
|
194
|
+
# code and the client should clear its storage and perform a full
|
|
195
|
+
# synchronization without any syncToken.
|
|
196
|
+
# Learn more about incremental synchronization.
|
|
197
|
+
# Optional. The default is to return all entries.
|
|
198
|
+
# @param [String] fields
|
|
199
|
+
# Selector specifying which fields to include in a partial response.
|
|
200
|
+
# @param [String] quota_user
|
|
201
|
+
# Available to use for quota purposes for server-side applications. Can be any
|
|
202
|
+
# arbitrary string assigned to a user, but should not exceed 40 characters.
|
|
203
|
+
# Overrides userIp if both are provided.
|
|
204
|
+
# @param [String] user_ip
|
|
205
|
+
# IP address of the site where the request originates. Use this if you want to
|
|
206
|
+
# enforce per-user limits.
|
|
207
|
+
# @param [Google::Apis::RequestOptions] options
|
|
208
|
+
# Request-specific options
|
|
209
|
+
#
|
|
210
|
+
# @yield [result, err] Result & error if block supplied
|
|
211
|
+
# @yieldparam result [Google::Apis::CalendarV3::Acl] parsed result object
|
|
212
|
+
# @yieldparam err [StandardError] error object if request failed
|
|
213
|
+
#
|
|
214
|
+
# @return [Google::Apis::CalendarV3::Acl]
|
|
215
|
+
#
|
|
216
|
+
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
|
|
217
|
+
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
|
|
218
|
+
# @raise [Google::Apis::AuthorizationError] Authorization is required
|
|
219
|
+
def list_acls(calendar_id, max_results: nil, page_token: nil, show_deleted: nil, sync_token: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block)
|
|
220
|
+
command = make_simple_command(:get, 'calendars/{calendarId}/acl', options)
|
|
221
|
+
command.response_representation = Google::Apis::CalendarV3::Acl::Representation
|
|
222
|
+
command.response_class = Google::Apis::CalendarV3::Acl
|
|
223
|
+
command.params['calendarId'] = calendar_id unless calendar_id.nil?
|
|
224
|
+
command.query['maxResults'] = max_results unless max_results.nil?
|
|
225
|
+
command.query['pageToken'] = page_token unless page_token.nil?
|
|
226
|
+
command.query['showDeleted'] = show_deleted unless show_deleted.nil?
|
|
227
|
+
command.query['syncToken'] = sync_token unless sync_token.nil?
|
|
228
|
+
command.query['fields'] = fields unless fields.nil?
|
|
229
|
+
command.query['quotaUser'] = quota_user unless quota_user.nil?
|
|
230
|
+
command.query['userIp'] = user_ip unless user_ip.nil?
|
|
231
|
+
execute_or_queue_command(command, &block)
|
|
232
|
+
end
|
|
233
|
+
|
|
234
|
+
# Updates an access control rule. This method supports patch semantics.
|
|
235
|
+
# @param [String] calendar_id
|
|
236
|
+
# Calendar identifier. To retrieve calendar IDs call the calendarList.list
|
|
237
|
+
# method. If you want to access the primary calendar of the currently logged in
|
|
238
|
+
# user, use the "primary" keyword.
|
|
239
|
+
# @param [String] rule_id
|
|
240
|
+
# ACL rule identifier.
|
|
241
|
+
# @param [Google::Apis::CalendarV3::AclRule] acl_rule_object
|
|
242
|
+
# @param [String] fields
|
|
243
|
+
# Selector specifying which fields to include in a partial response.
|
|
244
|
+
# @param [String] quota_user
|
|
245
|
+
# Available to use for quota purposes for server-side applications. Can be any
|
|
246
|
+
# arbitrary string assigned to a user, but should not exceed 40 characters.
|
|
247
|
+
# Overrides userIp if both are provided.
|
|
248
|
+
# @param [String] user_ip
|
|
249
|
+
# IP address of the site where the request originates. Use this if you want to
|
|
250
|
+
# enforce per-user limits.
|
|
251
|
+
# @param [Google::Apis::RequestOptions] options
|
|
252
|
+
# Request-specific options
|
|
253
|
+
#
|
|
254
|
+
# @yield [result, err] Result & error if block supplied
|
|
255
|
+
# @yieldparam result [Google::Apis::CalendarV3::AclRule] parsed result object
|
|
256
|
+
# @yieldparam err [StandardError] error object if request failed
|
|
257
|
+
#
|
|
258
|
+
# @return [Google::Apis::CalendarV3::AclRule]
|
|
259
|
+
#
|
|
260
|
+
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
|
|
261
|
+
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
|
|
262
|
+
# @raise [Google::Apis::AuthorizationError] Authorization is required
|
|
263
|
+
def patch_acl(calendar_id, rule_id, acl_rule_object = nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block)
|
|
264
|
+
command = make_simple_command(:patch, 'calendars/{calendarId}/acl/{ruleId}', options)
|
|
265
|
+
command.request_representation = Google::Apis::CalendarV3::AclRule::Representation
|
|
266
|
+
command.request_object = acl_rule_object
|
|
267
|
+
command.response_representation = Google::Apis::CalendarV3::AclRule::Representation
|
|
268
|
+
command.response_class = Google::Apis::CalendarV3::AclRule
|
|
269
|
+
command.params['calendarId'] = calendar_id unless calendar_id.nil?
|
|
270
|
+
command.params['ruleId'] = rule_id unless rule_id.nil?
|
|
271
|
+
command.query['fields'] = fields unless fields.nil?
|
|
272
|
+
command.query['quotaUser'] = quota_user unless quota_user.nil?
|
|
273
|
+
command.query['userIp'] = user_ip unless user_ip.nil?
|
|
274
|
+
execute_or_queue_command(command, &block)
|
|
275
|
+
end
|
|
276
|
+
|
|
277
|
+
# Updates an access control rule.
|
|
278
|
+
# @param [String] calendar_id
|
|
279
|
+
# Calendar identifier. To retrieve calendar IDs call the calendarList.list
|
|
280
|
+
# method. If you want to access the primary calendar of the currently logged in
|
|
281
|
+
# user, use the "primary" keyword.
|
|
282
|
+
# @param [String] rule_id
|
|
283
|
+
# ACL rule identifier.
|
|
284
|
+
# @param [Google::Apis::CalendarV3::AclRule] acl_rule_object
|
|
285
|
+
# @param [String] fields
|
|
286
|
+
# Selector specifying which fields to include in a partial response.
|
|
287
|
+
# @param [String] quota_user
|
|
288
|
+
# Available to use for quota purposes for server-side applications. Can be any
|
|
289
|
+
# arbitrary string assigned to a user, but should not exceed 40 characters.
|
|
290
|
+
# Overrides userIp if both are provided.
|
|
291
|
+
# @param [String] user_ip
|
|
292
|
+
# IP address of the site where the request originates. Use this if you want to
|
|
293
|
+
# enforce per-user limits.
|
|
294
|
+
# @param [Google::Apis::RequestOptions] options
|
|
295
|
+
# Request-specific options
|
|
296
|
+
#
|
|
297
|
+
# @yield [result, err] Result & error if block supplied
|
|
298
|
+
# @yieldparam result [Google::Apis::CalendarV3::AclRule] parsed result object
|
|
299
|
+
# @yieldparam err [StandardError] error object if request failed
|
|
300
|
+
#
|
|
301
|
+
# @return [Google::Apis::CalendarV3::AclRule]
|
|
302
|
+
#
|
|
303
|
+
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
|
|
304
|
+
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
|
|
305
|
+
# @raise [Google::Apis::AuthorizationError] Authorization is required
|
|
306
|
+
def update_acl(calendar_id, rule_id, acl_rule_object = nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block)
|
|
307
|
+
command = make_simple_command(:put, 'calendars/{calendarId}/acl/{ruleId}', options)
|
|
308
|
+
command.request_representation = Google::Apis::CalendarV3::AclRule::Representation
|
|
309
|
+
command.request_object = acl_rule_object
|
|
310
|
+
command.response_representation = Google::Apis::CalendarV3::AclRule::Representation
|
|
311
|
+
command.response_class = Google::Apis::CalendarV3::AclRule
|
|
312
|
+
command.params['calendarId'] = calendar_id unless calendar_id.nil?
|
|
313
|
+
command.params['ruleId'] = rule_id unless rule_id.nil?
|
|
314
|
+
command.query['fields'] = fields unless fields.nil?
|
|
315
|
+
command.query['quotaUser'] = quota_user unless quota_user.nil?
|
|
316
|
+
command.query['userIp'] = user_ip unless user_ip.nil?
|
|
317
|
+
execute_or_queue_command(command, &block)
|
|
318
|
+
end
|
|
319
|
+
|
|
320
|
+
# Watch for changes to ACL resources.
|
|
321
|
+
# @param [String] calendar_id
|
|
322
|
+
# Calendar identifier. To retrieve calendar IDs call the calendarList.list
|
|
323
|
+
# method. If you want to access the primary calendar of the currently logged in
|
|
324
|
+
# user, use the "primary" keyword.
|
|
325
|
+
# @param [Google::Apis::CalendarV3::Channel] channel_object
|
|
326
|
+
# @param [Fixnum] max_results
|
|
327
|
+
# Maximum number of entries returned on one result page. By default the value is
|
|
328
|
+
# 100 entries. The page size can never be larger than 250 entries. Optional.
|
|
329
|
+
# @param [String] page_token
|
|
330
|
+
# Token specifying which result page to return. Optional.
|
|
331
|
+
# @param [Boolean] show_deleted
|
|
332
|
+
# Whether to include deleted ACLs in the result. Deleted ACLs are represented by
|
|
333
|
+
# role equal to "none". Deleted ACLs will always be included if syncToken is
|
|
334
|
+
# provided. Optional. The default is False.
|
|
335
|
+
# @param [String] sync_token
|
|
336
|
+
# Token obtained from the nextSyncToken field returned on the last page of
|
|
337
|
+
# results from the previous list request. It makes the result of this list
|
|
338
|
+
# request contain only entries that have changed since then. All entries deleted
|
|
339
|
+
# since the previous list request will always be in the result set and it is not
|
|
340
|
+
# allowed to set showDeleted to False.
|
|
341
|
+
# If the syncToken expires, the server will respond with a 410 GONE response
|
|
342
|
+
# code and the client should clear its storage and perform a full
|
|
343
|
+
# synchronization without any syncToken.
|
|
344
|
+
# Learn more about incremental synchronization.
|
|
345
|
+
# Optional. The default is to return all entries.
|
|
346
|
+
# @param [String] fields
|
|
347
|
+
# Selector specifying which fields to include in a partial response.
|
|
348
|
+
# @param [String] quota_user
|
|
349
|
+
# Available to use for quota purposes for server-side applications. Can be any
|
|
350
|
+
# arbitrary string assigned to a user, but should not exceed 40 characters.
|
|
351
|
+
# Overrides userIp if both are provided.
|
|
352
|
+
# @param [String] user_ip
|
|
353
|
+
# IP address of the site where the request originates. Use this if you want to
|
|
354
|
+
# enforce per-user limits.
|
|
355
|
+
# @param [Google::Apis::RequestOptions] options
|
|
356
|
+
# Request-specific options
|
|
357
|
+
#
|
|
358
|
+
# @yield [result, err] Result & error if block supplied
|
|
359
|
+
# @yieldparam result [Google::Apis::CalendarV3::Channel] parsed result object
|
|
360
|
+
# @yieldparam err [StandardError] error object if request failed
|
|
361
|
+
#
|
|
362
|
+
# @return [Google::Apis::CalendarV3::Channel]
|
|
363
|
+
#
|
|
364
|
+
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
|
|
365
|
+
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
|
|
366
|
+
# @raise [Google::Apis::AuthorizationError] Authorization is required
|
|
367
|
+
def watch_acl(calendar_id, channel_object = nil, max_results: nil, page_token: nil, show_deleted: nil, sync_token: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block)
|
|
368
|
+
command = make_simple_command(:post, 'calendars/{calendarId}/acl/watch', options)
|
|
369
|
+
command.request_representation = Google::Apis::CalendarV3::Channel::Representation
|
|
370
|
+
command.request_object = channel_object
|
|
371
|
+
command.response_representation = Google::Apis::CalendarV3::Channel::Representation
|
|
372
|
+
command.response_class = Google::Apis::CalendarV3::Channel
|
|
373
|
+
command.params['calendarId'] = calendar_id unless calendar_id.nil?
|
|
374
|
+
command.query['maxResults'] = max_results unless max_results.nil?
|
|
375
|
+
command.query['pageToken'] = page_token unless page_token.nil?
|
|
376
|
+
command.query['showDeleted'] = show_deleted unless show_deleted.nil?
|
|
377
|
+
command.query['syncToken'] = sync_token unless sync_token.nil?
|
|
378
|
+
command.query['fields'] = fields unless fields.nil?
|
|
379
|
+
command.query['quotaUser'] = quota_user unless quota_user.nil?
|
|
380
|
+
command.query['userIp'] = user_ip unless user_ip.nil?
|
|
381
|
+
execute_or_queue_command(command, &block)
|
|
382
|
+
end
|
|
383
|
+
|
|
384
|
+
# Deletes an entry on the user's calendar list.
|
|
385
|
+
# @param [String] calendar_id
|
|
386
|
+
# Calendar identifier. To retrieve calendar IDs call the calendarList.list
|
|
387
|
+
# method. If you want to access the primary calendar of the currently logged in
|
|
388
|
+
# user, use the "primary" keyword.
|
|
389
|
+
# @param [String] fields
|
|
390
|
+
# Selector specifying which fields to include in a partial response.
|
|
391
|
+
# @param [String] quota_user
|
|
392
|
+
# Available to use for quota purposes for server-side applications. Can be any
|
|
393
|
+
# arbitrary string assigned to a user, but should not exceed 40 characters.
|
|
394
|
+
# Overrides userIp if both are provided.
|
|
395
|
+
# @param [String] user_ip
|
|
396
|
+
# IP address of the site where the request originates. Use this if you want to
|
|
397
|
+
# enforce per-user limits.
|
|
398
|
+
# @param [Google::Apis::RequestOptions] options
|
|
399
|
+
# Request-specific options
|
|
400
|
+
#
|
|
401
|
+
# @yield [result, err] Result & error if block supplied
|
|
402
|
+
# @yieldparam result [NilClass] No result returned for this method
|
|
403
|
+
# @yieldparam err [StandardError] error object if request failed
|
|
404
|
+
#
|
|
405
|
+
# @return [void]
|
|
406
|
+
#
|
|
407
|
+
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
|
|
408
|
+
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
|
|
409
|
+
# @raise [Google::Apis::AuthorizationError] Authorization is required
|
|
410
|
+
def delete_calendar_list(calendar_id, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block)
|
|
411
|
+
command = make_simple_command(:delete, 'users/me/calendarList/{calendarId}', options)
|
|
412
|
+
command.params['calendarId'] = calendar_id unless calendar_id.nil?
|
|
413
|
+
command.query['fields'] = fields unless fields.nil?
|
|
414
|
+
command.query['quotaUser'] = quota_user unless quota_user.nil?
|
|
415
|
+
command.query['userIp'] = user_ip unless user_ip.nil?
|
|
416
|
+
execute_or_queue_command(command, &block)
|
|
417
|
+
end
|
|
418
|
+
|
|
419
|
+
# Returns an entry on the user's calendar list.
|
|
420
|
+
# @param [String] calendar_id
|
|
421
|
+
# Calendar identifier. To retrieve calendar IDs call the calendarList.list
|
|
422
|
+
# method. If you want to access the primary calendar of the currently logged in
|
|
423
|
+
# user, use the "primary" keyword.
|
|
424
|
+
# @param [String] fields
|
|
425
|
+
# Selector specifying which fields to include in a partial response.
|
|
426
|
+
# @param [String] quota_user
|
|
427
|
+
# Available to use for quota purposes for server-side applications. Can be any
|
|
428
|
+
# arbitrary string assigned to a user, but should not exceed 40 characters.
|
|
429
|
+
# Overrides userIp if both are provided.
|
|
430
|
+
# @param [String] user_ip
|
|
431
|
+
# IP address of the site where the request originates. Use this if you want to
|
|
432
|
+
# enforce per-user limits.
|
|
433
|
+
# @param [Google::Apis::RequestOptions] options
|
|
434
|
+
# Request-specific options
|
|
435
|
+
#
|
|
436
|
+
# @yield [result, err] Result & error if block supplied
|
|
437
|
+
# @yieldparam result [Google::Apis::CalendarV3::CalendarListEntry] parsed result object
|
|
438
|
+
# @yieldparam err [StandardError] error object if request failed
|
|
439
|
+
#
|
|
440
|
+
# @return [Google::Apis::CalendarV3::CalendarListEntry]
|
|
441
|
+
#
|
|
442
|
+
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
|
|
443
|
+
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
|
|
444
|
+
# @raise [Google::Apis::AuthorizationError] Authorization is required
|
|
445
|
+
def get_calendar_list(calendar_id, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block)
|
|
446
|
+
command = make_simple_command(:get, 'users/me/calendarList/{calendarId}', options)
|
|
447
|
+
command.response_representation = Google::Apis::CalendarV3::CalendarListEntry::Representation
|
|
448
|
+
command.response_class = Google::Apis::CalendarV3::CalendarListEntry
|
|
449
|
+
command.params['calendarId'] = calendar_id unless calendar_id.nil?
|
|
450
|
+
command.query['fields'] = fields unless fields.nil?
|
|
451
|
+
command.query['quotaUser'] = quota_user unless quota_user.nil?
|
|
452
|
+
command.query['userIp'] = user_ip unless user_ip.nil?
|
|
453
|
+
execute_or_queue_command(command, &block)
|
|
454
|
+
end
|
|
455
|
+
|
|
456
|
+
# Adds an entry to the user's calendar list.
|
|
457
|
+
# @param [Google::Apis::CalendarV3::CalendarListEntry] calendar_list_entry_object
|
|
458
|
+
# @param [Boolean] color_rgb_format
|
|
459
|
+
# Whether to use the foregroundColor and backgroundColor fields to write the
|
|
460
|
+
# calendar colors (RGB). If this feature is used, the index-based colorId field
|
|
461
|
+
# will be set to the best matching option automatically. Optional. The default
|
|
462
|
+
# is False.
|
|
463
|
+
# @param [String] fields
|
|
464
|
+
# Selector specifying which fields to include in a partial response.
|
|
465
|
+
# @param [String] quota_user
|
|
466
|
+
# Available to use for quota purposes for server-side applications. Can be any
|
|
467
|
+
# arbitrary string assigned to a user, but should not exceed 40 characters.
|
|
468
|
+
# Overrides userIp if both are provided.
|
|
469
|
+
# @param [String] user_ip
|
|
470
|
+
# IP address of the site where the request originates. Use this if you want to
|
|
471
|
+
# enforce per-user limits.
|
|
472
|
+
# @param [Google::Apis::RequestOptions] options
|
|
473
|
+
# Request-specific options
|
|
474
|
+
#
|
|
475
|
+
# @yield [result, err] Result & error if block supplied
|
|
476
|
+
# @yieldparam result [Google::Apis::CalendarV3::CalendarListEntry] parsed result object
|
|
477
|
+
# @yieldparam err [StandardError] error object if request failed
|
|
478
|
+
#
|
|
479
|
+
# @return [Google::Apis::CalendarV3::CalendarListEntry]
|
|
480
|
+
#
|
|
481
|
+
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
|
|
482
|
+
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
|
|
483
|
+
# @raise [Google::Apis::AuthorizationError] Authorization is required
|
|
484
|
+
def insert_calendar_list(calendar_list_entry_object = nil, color_rgb_format: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block)
|
|
485
|
+
command = make_simple_command(:post, 'users/me/calendarList', options)
|
|
486
|
+
command.request_representation = Google::Apis::CalendarV3::CalendarListEntry::Representation
|
|
487
|
+
command.request_object = calendar_list_entry_object
|
|
488
|
+
command.response_representation = Google::Apis::CalendarV3::CalendarListEntry::Representation
|
|
489
|
+
command.response_class = Google::Apis::CalendarV3::CalendarListEntry
|
|
490
|
+
command.query['colorRgbFormat'] = color_rgb_format unless color_rgb_format.nil?
|
|
491
|
+
command.query['fields'] = fields unless fields.nil?
|
|
492
|
+
command.query['quotaUser'] = quota_user unless quota_user.nil?
|
|
493
|
+
command.query['userIp'] = user_ip unless user_ip.nil?
|
|
494
|
+
execute_or_queue_command(command, &block)
|
|
495
|
+
end
|
|
496
|
+
|
|
497
|
+
# Returns entries on the user's calendar list.
|
|
498
|
+
# @param [Fixnum] max_results
|
|
499
|
+
# Maximum number of entries returned on one result page. By default the value is
|
|
500
|
+
# 100 entries. The page size can never be larger than 250 entries. Optional.
|
|
501
|
+
# @param [String] min_access_role
|
|
502
|
+
# The minimum access role for the user in the returned entries. Optional. The
|
|
503
|
+
# default is no restriction.
|
|
504
|
+
# @param [String] page_token
|
|
505
|
+
# Token specifying which result page to return. Optional.
|
|
506
|
+
# @param [Boolean] show_deleted
|
|
507
|
+
# Whether to include deleted calendar list entries in the result. Optional. The
|
|
508
|
+
# default is False.
|
|
509
|
+
# @param [Boolean] show_hidden
|
|
510
|
+
# Whether to show hidden entries. Optional. The default is False.
|
|
511
|
+
# @param [String] sync_token
|
|
512
|
+
# Token obtained from the nextSyncToken field returned on the last page of
|
|
513
|
+
# results from the previous list request. It makes the result of this list
|
|
514
|
+
# request contain only entries that have changed since then. If only read-only
|
|
515
|
+
# fields such as calendar properties or ACLs have changed, the entry won't be
|
|
516
|
+
# returned. All entries deleted and hidden since the previous list request will
|
|
517
|
+
# always be in the result set and it is not allowed to set showDeleted neither
|
|
518
|
+
# showHidden to False.
|
|
519
|
+
# To ensure client state consistency minAccessRole query parameter cannot be
|
|
520
|
+
# specified together with nextSyncToken.
|
|
521
|
+
# If the syncToken expires, the server will respond with a 410 GONE response
|
|
522
|
+
# code and the client should clear its storage and perform a full
|
|
523
|
+
# synchronization without any syncToken.
|
|
524
|
+
# Learn more about incremental synchronization.
|
|
525
|
+
# Optional. The default is to return all entries.
|
|
526
|
+
# @param [String] fields
|
|
527
|
+
# Selector specifying which fields to include in a partial response.
|
|
528
|
+
# @param [String] quota_user
|
|
529
|
+
# Available to use for quota purposes for server-side applications. Can be any
|
|
530
|
+
# arbitrary string assigned to a user, but should not exceed 40 characters.
|
|
531
|
+
# Overrides userIp if both are provided.
|
|
532
|
+
# @param [String] user_ip
|
|
533
|
+
# IP address of the site where the request originates. Use this if you want to
|
|
534
|
+
# enforce per-user limits.
|
|
535
|
+
# @param [Google::Apis::RequestOptions] options
|
|
536
|
+
# Request-specific options
|
|
537
|
+
#
|
|
538
|
+
# @yield [result, err] Result & error if block supplied
|
|
539
|
+
# @yieldparam result [Google::Apis::CalendarV3::CalendarList] parsed result object
|
|
540
|
+
# @yieldparam err [StandardError] error object if request failed
|
|
541
|
+
#
|
|
542
|
+
# @return [Google::Apis::CalendarV3::CalendarList]
|
|
543
|
+
#
|
|
544
|
+
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
|
|
545
|
+
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
|
|
546
|
+
# @raise [Google::Apis::AuthorizationError] Authorization is required
|
|
547
|
+
def list_calendar_lists(max_results: nil, min_access_role: nil, page_token: nil, show_deleted: nil, show_hidden: nil, sync_token: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block)
|
|
548
|
+
command = make_simple_command(:get, 'users/me/calendarList', options)
|
|
549
|
+
command.response_representation = Google::Apis::CalendarV3::CalendarList::Representation
|
|
550
|
+
command.response_class = Google::Apis::CalendarV3::CalendarList
|
|
551
|
+
command.query['maxResults'] = max_results unless max_results.nil?
|
|
552
|
+
command.query['minAccessRole'] = min_access_role unless min_access_role.nil?
|
|
553
|
+
command.query['pageToken'] = page_token unless page_token.nil?
|
|
554
|
+
command.query['showDeleted'] = show_deleted unless show_deleted.nil?
|
|
555
|
+
command.query['showHidden'] = show_hidden unless show_hidden.nil?
|
|
556
|
+
command.query['syncToken'] = sync_token unless sync_token.nil?
|
|
557
|
+
command.query['fields'] = fields unless fields.nil?
|
|
558
|
+
command.query['quotaUser'] = quota_user unless quota_user.nil?
|
|
559
|
+
command.query['userIp'] = user_ip unless user_ip.nil?
|
|
560
|
+
execute_or_queue_command(command, &block)
|
|
561
|
+
end
|
|
562
|
+
|
|
563
|
+
# Updates an entry on the user's calendar list. This method supports patch
|
|
564
|
+
# semantics.
|
|
565
|
+
# @param [String] calendar_id
|
|
566
|
+
# Calendar identifier. To retrieve calendar IDs call the calendarList.list
|
|
567
|
+
# method. If you want to access the primary calendar of the currently logged in
|
|
568
|
+
# user, use the "primary" keyword.
|
|
569
|
+
# @param [Google::Apis::CalendarV3::CalendarListEntry] calendar_list_entry_object
|
|
570
|
+
# @param [Boolean] color_rgb_format
|
|
571
|
+
# Whether to use the foregroundColor and backgroundColor fields to write the
|
|
572
|
+
# calendar colors (RGB). If this feature is used, the index-based colorId field
|
|
573
|
+
# will be set to the best matching option automatically. Optional. The default
|
|
574
|
+
# is False.
|
|
575
|
+
# @param [String] fields
|
|
576
|
+
# Selector specifying which fields to include in a partial response.
|
|
577
|
+
# @param [String] quota_user
|
|
578
|
+
# Available to use for quota purposes for server-side applications. Can be any
|
|
579
|
+
# arbitrary string assigned to a user, but should not exceed 40 characters.
|
|
580
|
+
# Overrides userIp if both are provided.
|
|
581
|
+
# @param [String] user_ip
|
|
582
|
+
# IP address of the site where the request originates. Use this if you want to
|
|
583
|
+
# enforce per-user limits.
|
|
584
|
+
# @param [Google::Apis::RequestOptions] options
|
|
585
|
+
# Request-specific options
|
|
586
|
+
#
|
|
587
|
+
# @yield [result, err] Result & error if block supplied
|
|
588
|
+
# @yieldparam result [Google::Apis::CalendarV3::CalendarListEntry] parsed result object
|
|
589
|
+
# @yieldparam err [StandardError] error object if request failed
|
|
590
|
+
#
|
|
591
|
+
# @return [Google::Apis::CalendarV3::CalendarListEntry]
|
|
592
|
+
#
|
|
593
|
+
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
|
|
594
|
+
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
|
|
595
|
+
# @raise [Google::Apis::AuthorizationError] Authorization is required
|
|
596
|
+
def patch_calendar_list(calendar_id, calendar_list_entry_object = nil, color_rgb_format: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block)
|
|
597
|
+
command = make_simple_command(:patch, 'users/me/calendarList/{calendarId}', options)
|
|
598
|
+
command.request_representation = Google::Apis::CalendarV3::CalendarListEntry::Representation
|
|
599
|
+
command.request_object = calendar_list_entry_object
|
|
600
|
+
command.response_representation = Google::Apis::CalendarV3::CalendarListEntry::Representation
|
|
601
|
+
command.response_class = Google::Apis::CalendarV3::CalendarListEntry
|
|
602
|
+
command.params['calendarId'] = calendar_id unless calendar_id.nil?
|
|
603
|
+
command.query['colorRgbFormat'] = color_rgb_format unless color_rgb_format.nil?
|
|
604
|
+
command.query['fields'] = fields unless fields.nil?
|
|
605
|
+
command.query['quotaUser'] = quota_user unless quota_user.nil?
|
|
606
|
+
command.query['userIp'] = user_ip unless user_ip.nil?
|
|
607
|
+
execute_or_queue_command(command, &block)
|
|
608
|
+
end
|
|
609
|
+
|
|
610
|
+
# Updates an entry on the user's calendar list.
|
|
611
|
+
# @param [String] calendar_id
|
|
612
|
+
# Calendar identifier. To retrieve calendar IDs call the calendarList.list
|
|
613
|
+
# method. If you want to access the primary calendar of the currently logged in
|
|
614
|
+
# user, use the "primary" keyword.
|
|
615
|
+
# @param [Google::Apis::CalendarV3::CalendarListEntry] calendar_list_entry_object
|
|
616
|
+
# @param [Boolean] color_rgb_format
|
|
617
|
+
# Whether to use the foregroundColor and backgroundColor fields to write the
|
|
618
|
+
# calendar colors (RGB). If this feature is used, the index-based colorId field
|
|
619
|
+
# will be set to the best matching option automatically. Optional. The default
|
|
620
|
+
# is False.
|
|
621
|
+
# @param [String] fields
|
|
622
|
+
# Selector specifying which fields to include in a partial response.
|
|
623
|
+
# @param [String] quota_user
|
|
624
|
+
# Available to use for quota purposes for server-side applications. Can be any
|
|
625
|
+
# arbitrary string assigned to a user, but should not exceed 40 characters.
|
|
626
|
+
# Overrides userIp if both are provided.
|
|
627
|
+
# @param [String] user_ip
|
|
628
|
+
# IP address of the site where the request originates. Use this if you want to
|
|
629
|
+
# enforce per-user limits.
|
|
630
|
+
# @param [Google::Apis::RequestOptions] options
|
|
631
|
+
# Request-specific options
|
|
632
|
+
#
|
|
633
|
+
# @yield [result, err] Result & error if block supplied
|
|
634
|
+
# @yieldparam result [Google::Apis::CalendarV3::CalendarListEntry] parsed result object
|
|
635
|
+
# @yieldparam err [StandardError] error object if request failed
|
|
636
|
+
#
|
|
637
|
+
# @return [Google::Apis::CalendarV3::CalendarListEntry]
|
|
638
|
+
#
|
|
639
|
+
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
|
|
640
|
+
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
|
|
641
|
+
# @raise [Google::Apis::AuthorizationError] Authorization is required
|
|
642
|
+
def update_calendar_list(calendar_id, calendar_list_entry_object = nil, color_rgb_format: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block)
|
|
643
|
+
command = make_simple_command(:put, 'users/me/calendarList/{calendarId}', options)
|
|
644
|
+
command.request_representation = Google::Apis::CalendarV3::CalendarListEntry::Representation
|
|
645
|
+
command.request_object = calendar_list_entry_object
|
|
646
|
+
command.response_representation = Google::Apis::CalendarV3::CalendarListEntry::Representation
|
|
647
|
+
command.response_class = Google::Apis::CalendarV3::CalendarListEntry
|
|
648
|
+
command.params['calendarId'] = calendar_id unless calendar_id.nil?
|
|
649
|
+
command.query['colorRgbFormat'] = color_rgb_format unless color_rgb_format.nil?
|
|
650
|
+
command.query['fields'] = fields unless fields.nil?
|
|
651
|
+
command.query['quotaUser'] = quota_user unless quota_user.nil?
|
|
652
|
+
command.query['userIp'] = user_ip unless user_ip.nil?
|
|
653
|
+
execute_or_queue_command(command, &block)
|
|
654
|
+
end
|
|
655
|
+
|
|
656
|
+
# Watch for changes to CalendarList resources.
|
|
657
|
+
# @param [Google::Apis::CalendarV3::Channel] channel_object
|
|
658
|
+
# @param [Fixnum] max_results
|
|
659
|
+
# Maximum number of entries returned on one result page. By default the value is
|
|
660
|
+
# 100 entries. The page size can never be larger than 250 entries. Optional.
|
|
661
|
+
# @param [String] min_access_role
|
|
662
|
+
# The minimum access role for the user in the returned entries. Optional. The
|
|
663
|
+
# default is no restriction.
|
|
664
|
+
# @param [String] page_token
|
|
665
|
+
# Token specifying which result page to return. Optional.
|
|
666
|
+
# @param [Boolean] show_deleted
|
|
667
|
+
# Whether to include deleted calendar list entries in the result. Optional. The
|
|
668
|
+
# default is False.
|
|
669
|
+
# @param [Boolean] show_hidden
|
|
670
|
+
# Whether to show hidden entries. Optional. The default is False.
|
|
671
|
+
# @param [String] sync_token
|
|
672
|
+
# Token obtained from the nextSyncToken field returned on the last page of
|
|
673
|
+
# results from the previous list request. It makes the result of this list
|
|
674
|
+
# request contain only entries that have changed since then. If only read-only
|
|
675
|
+
# fields such as calendar properties or ACLs have changed, the entry won't be
|
|
676
|
+
# returned. All entries deleted and hidden since the previous list request will
|
|
677
|
+
# always be in the result set and it is not allowed to set showDeleted neither
|
|
678
|
+
# showHidden to False.
|
|
679
|
+
# To ensure client state consistency minAccessRole query parameter cannot be
|
|
680
|
+
# specified together with nextSyncToken.
|
|
681
|
+
# If the syncToken expires, the server will respond with a 410 GONE response
|
|
682
|
+
# code and the client should clear its storage and perform a full
|
|
683
|
+
# synchronization without any syncToken.
|
|
684
|
+
# Learn more about incremental synchronization.
|
|
685
|
+
# Optional. The default is to return all entries.
|
|
686
|
+
# @param [String] fields
|
|
687
|
+
# Selector specifying which fields to include in a partial response.
|
|
688
|
+
# @param [String] quota_user
|
|
689
|
+
# Available to use for quota purposes for server-side applications. Can be any
|
|
690
|
+
# arbitrary string assigned to a user, but should not exceed 40 characters.
|
|
691
|
+
# Overrides userIp if both are provided.
|
|
692
|
+
# @param [String] user_ip
|
|
693
|
+
# IP address of the site where the request originates. Use this if you want to
|
|
694
|
+
# enforce per-user limits.
|
|
695
|
+
# @param [Google::Apis::RequestOptions] options
|
|
696
|
+
# Request-specific options
|
|
697
|
+
#
|
|
698
|
+
# @yield [result, err] Result & error if block supplied
|
|
699
|
+
# @yieldparam result [Google::Apis::CalendarV3::Channel] parsed result object
|
|
700
|
+
# @yieldparam err [StandardError] error object if request failed
|
|
701
|
+
#
|
|
702
|
+
# @return [Google::Apis::CalendarV3::Channel]
|
|
703
|
+
#
|
|
704
|
+
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
|
|
705
|
+
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
|
|
706
|
+
# @raise [Google::Apis::AuthorizationError] Authorization is required
|
|
707
|
+
def watch_calendar_list(channel_object = nil, max_results: nil, min_access_role: nil, page_token: nil, show_deleted: nil, show_hidden: nil, sync_token: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block)
|
|
708
|
+
command = make_simple_command(:post, 'users/me/calendarList/watch', options)
|
|
709
|
+
command.request_representation = Google::Apis::CalendarV3::Channel::Representation
|
|
710
|
+
command.request_object = channel_object
|
|
711
|
+
command.response_representation = Google::Apis::CalendarV3::Channel::Representation
|
|
712
|
+
command.response_class = Google::Apis::CalendarV3::Channel
|
|
713
|
+
command.query['maxResults'] = max_results unless max_results.nil?
|
|
714
|
+
command.query['minAccessRole'] = min_access_role unless min_access_role.nil?
|
|
715
|
+
command.query['pageToken'] = page_token unless page_token.nil?
|
|
716
|
+
command.query['showDeleted'] = show_deleted unless show_deleted.nil?
|
|
717
|
+
command.query['showHidden'] = show_hidden unless show_hidden.nil?
|
|
718
|
+
command.query['syncToken'] = sync_token unless sync_token.nil?
|
|
719
|
+
command.query['fields'] = fields unless fields.nil?
|
|
720
|
+
command.query['quotaUser'] = quota_user unless quota_user.nil?
|
|
721
|
+
command.query['userIp'] = user_ip unless user_ip.nil?
|
|
722
|
+
execute_or_queue_command(command, &block)
|
|
723
|
+
end
|
|
724
|
+
|
|
725
|
+
# Clears a primary calendar. This operation deletes all events associated with
|
|
726
|
+
# the primary calendar of an account.
|
|
727
|
+
# @param [String] calendar_id
|
|
728
|
+
# Calendar identifier. To retrieve calendar IDs call the calendarList.list
|
|
729
|
+
# method. If you want to access the primary calendar of the currently logged in
|
|
730
|
+
# user, use the "primary" keyword.
|
|
731
|
+
# @param [String] fields
|
|
732
|
+
# Selector specifying which fields to include in a partial response.
|
|
733
|
+
# @param [String] quota_user
|
|
734
|
+
# Available to use for quota purposes for server-side applications. Can be any
|
|
735
|
+
# arbitrary string assigned to a user, but should not exceed 40 characters.
|
|
736
|
+
# Overrides userIp if both are provided.
|
|
737
|
+
# @param [String] user_ip
|
|
738
|
+
# IP address of the site where the request originates. Use this if you want to
|
|
739
|
+
# enforce per-user limits.
|
|
740
|
+
# @param [Google::Apis::RequestOptions] options
|
|
741
|
+
# Request-specific options
|
|
742
|
+
#
|
|
743
|
+
# @yield [result, err] Result & error if block supplied
|
|
744
|
+
# @yieldparam result [NilClass] No result returned for this method
|
|
745
|
+
# @yieldparam err [StandardError] error object if request failed
|
|
746
|
+
#
|
|
747
|
+
# @return [void]
|
|
748
|
+
#
|
|
749
|
+
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
|
|
750
|
+
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
|
|
751
|
+
# @raise [Google::Apis::AuthorizationError] Authorization is required
|
|
752
|
+
def clear_calendar(calendar_id, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block)
|
|
753
|
+
command = make_simple_command(:post, 'calendars/{calendarId}/clear', options)
|
|
754
|
+
command.params['calendarId'] = calendar_id unless calendar_id.nil?
|
|
755
|
+
command.query['fields'] = fields unless fields.nil?
|
|
756
|
+
command.query['quotaUser'] = quota_user unless quota_user.nil?
|
|
757
|
+
command.query['userIp'] = user_ip unless user_ip.nil?
|
|
758
|
+
execute_or_queue_command(command, &block)
|
|
759
|
+
end
|
|
760
|
+
|
|
761
|
+
# Deletes a secondary calendar. Use calendars.clear for clearing all events on
|
|
762
|
+
# primary calendars.
|
|
763
|
+
# @param [String] calendar_id
|
|
764
|
+
# Calendar identifier. To retrieve calendar IDs call the calendarList.list
|
|
765
|
+
# method. If you want to access the primary calendar of the currently logged in
|
|
766
|
+
# user, use the "primary" keyword.
|
|
767
|
+
# @param [String] fields
|
|
768
|
+
# Selector specifying which fields to include in a partial response.
|
|
769
|
+
# @param [String] quota_user
|
|
770
|
+
# Available to use for quota purposes for server-side applications. Can be any
|
|
771
|
+
# arbitrary string assigned to a user, but should not exceed 40 characters.
|
|
772
|
+
# Overrides userIp if both are provided.
|
|
773
|
+
# @param [String] user_ip
|
|
774
|
+
# IP address of the site where the request originates. Use this if you want to
|
|
775
|
+
# enforce per-user limits.
|
|
776
|
+
# @param [Google::Apis::RequestOptions] options
|
|
777
|
+
# Request-specific options
|
|
778
|
+
#
|
|
779
|
+
# @yield [result, err] Result & error if block supplied
|
|
780
|
+
# @yieldparam result [NilClass] No result returned for this method
|
|
781
|
+
# @yieldparam err [StandardError] error object if request failed
|
|
782
|
+
#
|
|
783
|
+
# @return [void]
|
|
784
|
+
#
|
|
785
|
+
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
|
|
786
|
+
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
|
|
787
|
+
# @raise [Google::Apis::AuthorizationError] Authorization is required
|
|
788
|
+
def delete_calendar(calendar_id, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block)
|
|
789
|
+
command = make_simple_command(:delete, 'calendars/{calendarId}', options)
|
|
790
|
+
command.params['calendarId'] = calendar_id unless calendar_id.nil?
|
|
791
|
+
command.query['fields'] = fields unless fields.nil?
|
|
792
|
+
command.query['quotaUser'] = quota_user unless quota_user.nil?
|
|
793
|
+
command.query['userIp'] = user_ip unless user_ip.nil?
|
|
794
|
+
execute_or_queue_command(command, &block)
|
|
795
|
+
end
|
|
796
|
+
|
|
797
|
+
# Returns metadata for a calendar.
|
|
798
|
+
# @param [String] calendar_id
|
|
799
|
+
# Calendar identifier. To retrieve calendar IDs call the calendarList.list
|
|
800
|
+
# method. If you want to access the primary calendar of the currently logged in
|
|
801
|
+
# user, use the "primary" keyword.
|
|
802
|
+
# @param [String] fields
|
|
803
|
+
# Selector specifying which fields to include in a partial response.
|
|
804
|
+
# @param [String] quota_user
|
|
805
|
+
# Available to use for quota purposes for server-side applications. Can be any
|
|
806
|
+
# arbitrary string assigned to a user, but should not exceed 40 characters.
|
|
807
|
+
# Overrides userIp if both are provided.
|
|
808
|
+
# @param [String] user_ip
|
|
809
|
+
# IP address of the site where the request originates. Use this if you want to
|
|
810
|
+
# enforce per-user limits.
|
|
811
|
+
# @param [Google::Apis::RequestOptions] options
|
|
812
|
+
# Request-specific options
|
|
813
|
+
#
|
|
814
|
+
# @yield [result, err] Result & error if block supplied
|
|
815
|
+
# @yieldparam result [Google::Apis::CalendarV3::Calendar] parsed result object
|
|
816
|
+
# @yieldparam err [StandardError] error object if request failed
|
|
817
|
+
#
|
|
818
|
+
# @return [Google::Apis::CalendarV3::Calendar]
|
|
819
|
+
#
|
|
820
|
+
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
|
|
821
|
+
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
|
|
822
|
+
# @raise [Google::Apis::AuthorizationError] Authorization is required
|
|
823
|
+
def get_calendar(calendar_id, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block)
|
|
824
|
+
command = make_simple_command(:get, 'calendars/{calendarId}', options)
|
|
825
|
+
command.response_representation = Google::Apis::CalendarV3::Calendar::Representation
|
|
826
|
+
command.response_class = Google::Apis::CalendarV3::Calendar
|
|
827
|
+
command.params['calendarId'] = calendar_id unless calendar_id.nil?
|
|
828
|
+
command.query['fields'] = fields unless fields.nil?
|
|
829
|
+
command.query['quotaUser'] = quota_user unless quota_user.nil?
|
|
830
|
+
command.query['userIp'] = user_ip unless user_ip.nil?
|
|
831
|
+
execute_or_queue_command(command, &block)
|
|
832
|
+
end
|
|
833
|
+
|
|
834
|
+
# Creates a secondary calendar.
|
|
835
|
+
# @param [Google::Apis::CalendarV3::Calendar] calendar_object
|
|
836
|
+
# @param [String] fields
|
|
837
|
+
# Selector specifying which fields to include in a partial response.
|
|
838
|
+
# @param [String] quota_user
|
|
839
|
+
# Available to use for quota purposes for server-side applications. Can be any
|
|
840
|
+
# arbitrary string assigned to a user, but should not exceed 40 characters.
|
|
841
|
+
# Overrides userIp if both are provided.
|
|
842
|
+
# @param [String] user_ip
|
|
843
|
+
# IP address of the site where the request originates. Use this if you want to
|
|
844
|
+
# enforce per-user limits.
|
|
845
|
+
# @param [Google::Apis::RequestOptions] options
|
|
846
|
+
# Request-specific options
|
|
847
|
+
#
|
|
848
|
+
# @yield [result, err] Result & error if block supplied
|
|
849
|
+
# @yieldparam result [Google::Apis::CalendarV3::Calendar] parsed result object
|
|
850
|
+
# @yieldparam err [StandardError] error object if request failed
|
|
851
|
+
#
|
|
852
|
+
# @return [Google::Apis::CalendarV3::Calendar]
|
|
853
|
+
#
|
|
854
|
+
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
|
|
855
|
+
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
|
|
856
|
+
# @raise [Google::Apis::AuthorizationError] Authorization is required
|
|
857
|
+
def insert_calendar(calendar_object = nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block)
|
|
858
|
+
command = make_simple_command(:post, 'calendars', options)
|
|
859
|
+
command.request_representation = Google::Apis::CalendarV3::Calendar::Representation
|
|
860
|
+
command.request_object = calendar_object
|
|
861
|
+
command.response_representation = Google::Apis::CalendarV3::Calendar::Representation
|
|
862
|
+
command.response_class = Google::Apis::CalendarV3::Calendar
|
|
863
|
+
command.query['fields'] = fields unless fields.nil?
|
|
864
|
+
command.query['quotaUser'] = quota_user unless quota_user.nil?
|
|
865
|
+
command.query['userIp'] = user_ip unless user_ip.nil?
|
|
866
|
+
execute_or_queue_command(command, &block)
|
|
867
|
+
end
|
|
868
|
+
|
|
869
|
+
# Updates metadata for a calendar. This method supports patch semantics.
|
|
870
|
+
# @param [String] calendar_id
|
|
871
|
+
# Calendar identifier. To retrieve calendar IDs call the calendarList.list
|
|
872
|
+
# method. If you want to access the primary calendar of the currently logged in
|
|
873
|
+
# user, use the "primary" keyword.
|
|
874
|
+
# @param [Google::Apis::CalendarV3::Calendar] calendar_object
|
|
875
|
+
# @param [String] fields
|
|
876
|
+
# Selector specifying which fields to include in a partial response.
|
|
877
|
+
# @param [String] quota_user
|
|
878
|
+
# Available to use for quota purposes for server-side applications. Can be any
|
|
879
|
+
# arbitrary string assigned to a user, but should not exceed 40 characters.
|
|
880
|
+
# Overrides userIp if both are provided.
|
|
881
|
+
# @param [String] user_ip
|
|
882
|
+
# IP address of the site where the request originates. Use this if you want to
|
|
883
|
+
# enforce per-user limits.
|
|
884
|
+
# @param [Google::Apis::RequestOptions] options
|
|
885
|
+
# Request-specific options
|
|
886
|
+
#
|
|
887
|
+
# @yield [result, err] Result & error if block supplied
|
|
888
|
+
# @yieldparam result [Google::Apis::CalendarV3::Calendar] parsed result object
|
|
889
|
+
# @yieldparam err [StandardError] error object if request failed
|
|
890
|
+
#
|
|
891
|
+
# @return [Google::Apis::CalendarV3::Calendar]
|
|
892
|
+
#
|
|
893
|
+
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
|
|
894
|
+
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
|
|
895
|
+
# @raise [Google::Apis::AuthorizationError] Authorization is required
|
|
896
|
+
def patch_calendar(calendar_id, calendar_object = nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block)
|
|
897
|
+
command = make_simple_command(:patch, 'calendars/{calendarId}', options)
|
|
898
|
+
command.request_representation = Google::Apis::CalendarV3::Calendar::Representation
|
|
899
|
+
command.request_object = calendar_object
|
|
900
|
+
command.response_representation = Google::Apis::CalendarV3::Calendar::Representation
|
|
901
|
+
command.response_class = Google::Apis::CalendarV3::Calendar
|
|
902
|
+
command.params['calendarId'] = calendar_id unless calendar_id.nil?
|
|
903
|
+
command.query['fields'] = fields unless fields.nil?
|
|
904
|
+
command.query['quotaUser'] = quota_user unless quota_user.nil?
|
|
905
|
+
command.query['userIp'] = user_ip unless user_ip.nil?
|
|
906
|
+
execute_or_queue_command(command, &block)
|
|
907
|
+
end
|
|
908
|
+
|
|
909
|
+
# Updates metadata for a calendar.
|
|
910
|
+
# @param [String] calendar_id
|
|
911
|
+
# Calendar identifier. To retrieve calendar IDs call the calendarList.list
|
|
912
|
+
# method. If you want to access the primary calendar of the currently logged in
|
|
913
|
+
# user, use the "primary" keyword.
|
|
914
|
+
# @param [Google::Apis::CalendarV3::Calendar] calendar_object
|
|
915
|
+
# @param [String] fields
|
|
916
|
+
# Selector specifying which fields to include in a partial response.
|
|
917
|
+
# @param [String] quota_user
|
|
918
|
+
# Available to use for quota purposes for server-side applications. Can be any
|
|
919
|
+
# arbitrary string assigned to a user, but should not exceed 40 characters.
|
|
920
|
+
# Overrides userIp if both are provided.
|
|
921
|
+
# @param [String] user_ip
|
|
922
|
+
# IP address of the site where the request originates. Use this if you want to
|
|
923
|
+
# enforce per-user limits.
|
|
924
|
+
# @param [Google::Apis::RequestOptions] options
|
|
925
|
+
# Request-specific options
|
|
926
|
+
#
|
|
927
|
+
# @yield [result, err] Result & error if block supplied
|
|
928
|
+
# @yieldparam result [Google::Apis::CalendarV3::Calendar] parsed result object
|
|
929
|
+
# @yieldparam err [StandardError] error object if request failed
|
|
930
|
+
#
|
|
931
|
+
# @return [Google::Apis::CalendarV3::Calendar]
|
|
932
|
+
#
|
|
933
|
+
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
|
|
934
|
+
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
|
|
935
|
+
# @raise [Google::Apis::AuthorizationError] Authorization is required
|
|
936
|
+
def update_calendar(calendar_id, calendar_object = nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block)
|
|
937
|
+
command = make_simple_command(:put, 'calendars/{calendarId}', options)
|
|
938
|
+
command.request_representation = Google::Apis::CalendarV3::Calendar::Representation
|
|
939
|
+
command.request_object = calendar_object
|
|
940
|
+
command.response_representation = Google::Apis::CalendarV3::Calendar::Representation
|
|
941
|
+
command.response_class = Google::Apis::CalendarV3::Calendar
|
|
942
|
+
command.params['calendarId'] = calendar_id unless calendar_id.nil?
|
|
943
|
+
command.query['fields'] = fields unless fields.nil?
|
|
944
|
+
command.query['quotaUser'] = quota_user unless quota_user.nil?
|
|
945
|
+
command.query['userIp'] = user_ip unless user_ip.nil?
|
|
946
|
+
execute_or_queue_command(command, &block)
|
|
947
|
+
end
|
|
948
|
+
|
|
949
|
+
# Stop watching resources through this channel
|
|
950
|
+
# @param [Google::Apis::CalendarV3::Channel] channel_object
|
|
951
|
+
# @param [String] fields
|
|
952
|
+
# Selector specifying which fields to include in a partial response.
|
|
953
|
+
# @param [String] quota_user
|
|
954
|
+
# Available to use for quota purposes for server-side applications. Can be any
|
|
955
|
+
# arbitrary string assigned to a user, but should not exceed 40 characters.
|
|
956
|
+
# Overrides userIp if both are provided.
|
|
957
|
+
# @param [String] user_ip
|
|
958
|
+
# IP address of the site where the request originates. Use this if you want to
|
|
959
|
+
# enforce per-user limits.
|
|
960
|
+
# @param [Google::Apis::RequestOptions] options
|
|
961
|
+
# Request-specific options
|
|
962
|
+
#
|
|
963
|
+
# @yield [result, err] Result & error if block supplied
|
|
964
|
+
# @yieldparam result [NilClass] No result returned for this method
|
|
965
|
+
# @yieldparam err [StandardError] error object if request failed
|
|
966
|
+
#
|
|
967
|
+
# @return [void]
|
|
968
|
+
#
|
|
969
|
+
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
|
|
970
|
+
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
|
|
971
|
+
# @raise [Google::Apis::AuthorizationError] Authorization is required
|
|
972
|
+
def stop_channel(channel_object = nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block)
|
|
973
|
+
command = make_simple_command(:post, 'channels/stop', options)
|
|
974
|
+
command.request_representation = Google::Apis::CalendarV3::Channel::Representation
|
|
975
|
+
command.request_object = channel_object
|
|
976
|
+
command.query['fields'] = fields unless fields.nil?
|
|
977
|
+
command.query['quotaUser'] = quota_user unless quota_user.nil?
|
|
978
|
+
command.query['userIp'] = user_ip unless user_ip.nil?
|
|
979
|
+
execute_or_queue_command(command, &block)
|
|
980
|
+
end
|
|
981
|
+
|
|
982
|
+
# Returns the color definitions for calendars and events.
|
|
983
|
+
# @param [String] fields
|
|
984
|
+
# Selector specifying which fields to include in a partial response.
|
|
985
|
+
# @param [String] quota_user
|
|
986
|
+
# Available to use for quota purposes for server-side applications. Can be any
|
|
987
|
+
# arbitrary string assigned to a user, but should not exceed 40 characters.
|
|
988
|
+
# Overrides userIp if both are provided.
|
|
989
|
+
# @param [String] user_ip
|
|
990
|
+
# IP address of the site where the request originates. Use this if you want to
|
|
991
|
+
# enforce per-user limits.
|
|
992
|
+
# @param [Google::Apis::RequestOptions] options
|
|
993
|
+
# Request-specific options
|
|
994
|
+
#
|
|
995
|
+
# @yield [result, err] Result & error if block supplied
|
|
996
|
+
# @yieldparam result [Google::Apis::CalendarV3::Colors] parsed result object
|
|
997
|
+
# @yieldparam err [StandardError] error object if request failed
|
|
998
|
+
#
|
|
999
|
+
# @return [Google::Apis::CalendarV3::Colors]
|
|
1000
|
+
#
|
|
1001
|
+
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
|
|
1002
|
+
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
|
|
1003
|
+
# @raise [Google::Apis::AuthorizationError] Authorization is required
|
|
1004
|
+
def get_color(fields: nil, quota_user: nil, user_ip: nil, options: nil, &block)
|
|
1005
|
+
command = make_simple_command(:get, 'colors', options)
|
|
1006
|
+
command.response_representation = Google::Apis::CalendarV3::Colors::Representation
|
|
1007
|
+
command.response_class = Google::Apis::CalendarV3::Colors
|
|
1008
|
+
command.query['fields'] = fields unless fields.nil?
|
|
1009
|
+
command.query['quotaUser'] = quota_user unless quota_user.nil?
|
|
1010
|
+
command.query['userIp'] = user_ip unless user_ip.nil?
|
|
1011
|
+
execute_or_queue_command(command, &block)
|
|
1012
|
+
end
|
|
1013
|
+
|
|
1014
|
+
# Deletes an event.
|
|
1015
|
+
# @param [String] calendar_id
|
|
1016
|
+
# Calendar identifier. To retrieve calendar IDs call the calendarList.list
|
|
1017
|
+
# method. If you want to access the primary calendar of the currently logged in
|
|
1018
|
+
# user, use the "primary" keyword.
|
|
1019
|
+
# @param [String] event_id
|
|
1020
|
+
# Event identifier.
|
|
1021
|
+
# @param [Boolean] send_notifications
|
|
1022
|
+
# Whether to send notifications about the deletion of the event. Optional. The
|
|
1023
|
+
# default is False.
|
|
1024
|
+
# @param [String] fields
|
|
1025
|
+
# Selector specifying which fields to include in a partial response.
|
|
1026
|
+
# @param [String] quota_user
|
|
1027
|
+
# Available to use for quota purposes for server-side applications. Can be any
|
|
1028
|
+
# arbitrary string assigned to a user, but should not exceed 40 characters.
|
|
1029
|
+
# Overrides userIp if both are provided.
|
|
1030
|
+
# @param [String] user_ip
|
|
1031
|
+
# IP address of the site where the request originates. Use this if you want to
|
|
1032
|
+
# enforce per-user limits.
|
|
1033
|
+
# @param [Google::Apis::RequestOptions] options
|
|
1034
|
+
# Request-specific options
|
|
1035
|
+
#
|
|
1036
|
+
# @yield [result, err] Result & error if block supplied
|
|
1037
|
+
# @yieldparam result [NilClass] No result returned for this method
|
|
1038
|
+
# @yieldparam err [StandardError] error object if request failed
|
|
1039
|
+
#
|
|
1040
|
+
# @return [void]
|
|
1041
|
+
#
|
|
1042
|
+
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
|
|
1043
|
+
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
|
|
1044
|
+
# @raise [Google::Apis::AuthorizationError] Authorization is required
|
|
1045
|
+
def delete_event(calendar_id, event_id, send_notifications: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block)
|
|
1046
|
+
command = make_simple_command(:delete, 'calendars/{calendarId}/events/{eventId}', options)
|
|
1047
|
+
command.params['calendarId'] = calendar_id unless calendar_id.nil?
|
|
1048
|
+
command.params['eventId'] = event_id unless event_id.nil?
|
|
1049
|
+
command.query['sendNotifications'] = send_notifications unless send_notifications.nil?
|
|
1050
|
+
command.query['fields'] = fields unless fields.nil?
|
|
1051
|
+
command.query['quotaUser'] = quota_user unless quota_user.nil?
|
|
1052
|
+
command.query['userIp'] = user_ip unless user_ip.nil?
|
|
1053
|
+
execute_or_queue_command(command, &block)
|
|
1054
|
+
end
|
|
1055
|
+
|
|
1056
|
+
# Returns an event.
|
|
1057
|
+
# @param [String] calendar_id
|
|
1058
|
+
# Calendar identifier. To retrieve calendar IDs call the calendarList.list
|
|
1059
|
+
# method. If you want to access the primary calendar of the currently logged in
|
|
1060
|
+
# user, use the "primary" keyword.
|
|
1061
|
+
# @param [String] event_id
|
|
1062
|
+
# Event identifier.
|
|
1063
|
+
# @param [Boolean] always_include_email
|
|
1064
|
+
# Whether to always include a value in the email field for the organizer,
|
|
1065
|
+
# creator and attendees, even if no real email is available (i.e. a generated,
|
|
1066
|
+
# non-working value will be provided). The use of this option is discouraged and
|
|
1067
|
+
# should only be used by clients which cannot handle the absence of an email
|
|
1068
|
+
# address value in the mentioned places. Optional. The default is False.
|
|
1069
|
+
# @param [Fixnum] max_attendees
|
|
1070
|
+
# The maximum number of attendees to include in the response. If there are more
|
|
1071
|
+
# than the specified number of attendees, only the participant is returned.
|
|
1072
|
+
# Optional.
|
|
1073
|
+
# @param [String] time_zone
|
|
1074
|
+
# Time zone used in the response. Optional. The default is the time zone of the
|
|
1075
|
+
# calendar.
|
|
1076
|
+
# @param [String] fields
|
|
1077
|
+
# Selector specifying which fields to include in a partial response.
|
|
1078
|
+
# @param [String] quota_user
|
|
1079
|
+
# Available to use for quota purposes for server-side applications. Can be any
|
|
1080
|
+
# arbitrary string assigned to a user, but should not exceed 40 characters.
|
|
1081
|
+
# Overrides userIp if both are provided.
|
|
1082
|
+
# @param [String] user_ip
|
|
1083
|
+
# IP address of the site where the request originates. Use this if you want to
|
|
1084
|
+
# enforce per-user limits.
|
|
1085
|
+
# @param [Google::Apis::RequestOptions] options
|
|
1086
|
+
# Request-specific options
|
|
1087
|
+
#
|
|
1088
|
+
# @yield [result, err] Result & error if block supplied
|
|
1089
|
+
# @yieldparam result [Google::Apis::CalendarV3::Event] parsed result object
|
|
1090
|
+
# @yieldparam err [StandardError] error object if request failed
|
|
1091
|
+
#
|
|
1092
|
+
# @return [Google::Apis::CalendarV3::Event]
|
|
1093
|
+
#
|
|
1094
|
+
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
|
|
1095
|
+
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
|
|
1096
|
+
# @raise [Google::Apis::AuthorizationError] Authorization is required
|
|
1097
|
+
def get_event(calendar_id, event_id, always_include_email: nil, max_attendees: nil, time_zone: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block)
|
|
1098
|
+
command = make_simple_command(:get, 'calendars/{calendarId}/events/{eventId}', options)
|
|
1099
|
+
command.response_representation = Google::Apis::CalendarV3::Event::Representation
|
|
1100
|
+
command.response_class = Google::Apis::CalendarV3::Event
|
|
1101
|
+
command.params['calendarId'] = calendar_id unless calendar_id.nil?
|
|
1102
|
+
command.params['eventId'] = event_id unless event_id.nil?
|
|
1103
|
+
command.query['alwaysIncludeEmail'] = always_include_email unless always_include_email.nil?
|
|
1104
|
+
command.query['maxAttendees'] = max_attendees unless max_attendees.nil?
|
|
1105
|
+
command.query['timeZone'] = time_zone unless time_zone.nil?
|
|
1106
|
+
command.query['fields'] = fields unless fields.nil?
|
|
1107
|
+
command.query['quotaUser'] = quota_user unless quota_user.nil?
|
|
1108
|
+
command.query['userIp'] = user_ip unless user_ip.nil?
|
|
1109
|
+
execute_or_queue_command(command, &block)
|
|
1110
|
+
end
|
|
1111
|
+
|
|
1112
|
+
# Imports an event. This operation is used to add a private copy of an existing
|
|
1113
|
+
# event to a calendar.
|
|
1114
|
+
# @param [String] calendar_id
|
|
1115
|
+
# Calendar identifier. To retrieve calendar IDs call the calendarList.list
|
|
1116
|
+
# method. If you want to access the primary calendar of the currently logged in
|
|
1117
|
+
# user, use the "primary" keyword.
|
|
1118
|
+
# @param [Google::Apis::CalendarV3::Event] event_object
|
|
1119
|
+
# @param [Boolean] supports_attachments
|
|
1120
|
+
# Whether API client performing operation supports event attachments. Optional.
|
|
1121
|
+
# The default is False.
|
|
1122
|
+
# @param [String] fields
|
|
1123
|
+
# Selector specifying which fields to include in a partial response.
|
|
1124
|
+
# @param [String] quota_user
|
|
1125
|
+
# Available to use for quota purposes for server-side applications. Can be any
|
|
1126
|
+
# arbitrary string assigned to a user, but should not exceed 40 characters.
|
|
1127
|
+
# Overrides userIp if both are provided.
|
|
1128
|
+
# @param [String] user_ip
|
|
1129
|
+
# IP address of the site where the request originates. Use this if you want to
|
|
1130
|
+
# enforce per-user limits.
|
|
1131
|
+
# @param [Google::Apis::RequestOptions] options
|
|
1132
|
+
# Request-specific options
|
|
1133
|
+
#
|
|
1134
|
+
# @yield [result, err] Result & error if block supplied
|
|
1135
|
+
# @yieldparam result [Google::Apis::CalendarV3::Event] parsed result object
|
|
1136
|
+
# @yieldparam err [StandardError] error object if request failed
|
|
1137
|
+
#
|
|
1138
|
+
# @return [Google::Apis::CalendarV3::Event]
|
|
1139
|
+
#
|
|
1140
|
+
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
|
|
1141
|
+
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
|
|
1142
|
+
# @raise [Google::Apis::AuthorizationError] Authorization is required
|
|
1143
|
+
def import_event(calendar_id, event_object = nil, supports_attachments: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block)
|
|
1144
|
+
command = make_simple_command(:post, 'calendars/{calendarId}/events/import', options)
|
|
1145
|
+
command.request_representation = Google::Apis::CalendarV3::Event::Representation
|
|
1146
|
+
command.request_object = event_object
|
|
1147
|
+
command.response_representation = Google::Apis::CalendarV3::Event::Representation
|
|
1148
|
+
command.response_class = Google::Apis::CalendarV3::Event
|
|
1149
|
+
command.params['calendarId'] = calendar_id unless calendar_id.nil?
|
|
1150
|
+
command.query['supportsAttachments'] = supports_attachments unless supports_attachments.nil?
|
|
1151
|
+
command.query['fields'] = fields unless fields.nil?
|
|
1152
|
+
command.query['quotaUser'] = quota_user unless quota_user.nil?
|
|
1153
|
+
command.query['userIp'] = user_ip unless user_ip.nil?
|
|
1154
|
+
execute_or_queue_command(command, &block)
|
|
1155
|
+
end
|
|
1156
|
+
|
|
1157
|
+
# Creates an event.
|
|
1158
|
+
# @param [String] calendar_id
|
|
1159
|
+
# Calendar identifier. To retrieve calendar IDs call the calendarList.list
|
|
1160
|
+
# method. If you want to access the primary calendar of the currently logged in
|
|
1161
|
+
# user, use the "primary" keyword.
|
|
1162
|
+
# @param [Google::Apis::CalendarV3::Event] event_object
|
|
1163
|
+
# @param [Fixnum] max_attendees
|
|
1164
|
+
# The maximum number of attendees to include in the response. If there are more
|
|
1165
|
+
# than the specified number of attendees, only the participant is returned.
|
|
1166
|
+
# Optional.
|
|
1167
|
+
# @param [Boolean] send_notifications
|
|
1168
|
+
# Whether to send notifications about the creation of the new event. Optional.
|
|
1169
|
+
# The default is False.
|
|
1170
|
+
# @param [Boolean] supports_attachments
|
|
1171
|
+
# Whether API client performing operation supports event attachments. Optional.
|
|
1172
|
+
# The default is False.
|
|
1173
|
+
# @param [String] fields
|
|
1174
|
+
# Selector specifying which fields to include in a partial response.
|
|
1175
|
+
# @param [String] quota_user
|
|
1176
|
+
# Available to use for quota purposes for server-side applications. Can be any
|
|
1177
|
+
# arbitrary string assigned to a user, but should not exceed 40 characters.
|
|
1178
|
+
# Overrides userIp if both are provided.
|
|
1179
|
+
# @param [String] user_ip
|
|
1180
|
+
# IP address of the site where the request originates. Use this if you want to
|
|
1181
|
+
# enforce per-user limits.
|
|
1182
|
+
# @param [Google::Apis::RequestOptions] options
|
|
1183
|
+
# Request-specific options
|
|
1184
|
+
#
|
|
1185
|
+
# @yield [result, err] Result & error if block supplied
|
|
1186
|
+
# @yieldparam result [Google::Apis::CalendarV3::Event] parsed result object
|
|
1187
|
+
# @yieldparam err [StandardError] error object if request failed
|
|
1188
|
+
#
|
|
1189
|
+
# @return [Google::Apis::CalendarV3::Event]
|
|
1190
|
+
#
|
|
1191
|
+
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
|
|
1192
|
+
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
|
|
1193
|
+
# @raise [Google::Apis::AuthorizationError] Authorization is required
|
|
1194
|
+
def insert_event(calendar_id, event_object = nil, max_attendees: nil, send_notifications: nil, supports_attachments: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block)
|
|
1195
|
+
command = make_simple_command(:post, 'calendars/{calendarId}/events', options)
|
|
1196
|
+
command.request_representation = Google::Apis::CalendarV3::Event::Representation
|
|
1197
|
+
command.request_object = event_object
|
|
1198
|
+
command.response_representation = Google::Apis::CalendarV3::Event::Representation
|
|
1199
|
+
command.response_class = Google::Apis::CalendarV3::Event
|
|
1200
|
+
command.params['calendarId'] = calendar_id unless calendar_id.nil?
|
|
1201
|
+
command.query['maxAttendees'] = max_attendees unless max_attendees.nil?
|
|
1202
|
+
command.query['sendNotifications'] = send_notifications unless send_notifications.nil?
|
|
1203
|
+
command.query['supportsAttachments'] = supports_attachments unless supports_attachments.nil?
|
|
1204
|
+
command.query['fields'] = fields unless fields.nil?
|
|
1205
|
+
command.query['quotaUser'] = quota_user unless quota_user.nil?
|
|
1206
|
+
command.query['userIp'] = user_ip unless user_ip.nil?
|
|
1207
|
+
execute_or_queue_command(command, &block)
|
|
1208
|
+
end
|
|
1209
|
+
|
|
1210
|
+
# Returns instances of the specified recurring event.
|
|
1211
|
+
# @param [String] calendar_id
|
|
1212
|
+
# Calendar identifier. To retrieve calendar IDs call the calendarList.list
|
|
1213
|
+
# method. If you want to access the primary calendar of the currently logged in
|
|
1214
|
+
# user, use the "primary" keyword.
|
|
1215
|
+
# @param [String] event_id
|
|
1216
|
+
# Recurring event identifier.
|
|
1217
|
+
# @param [Boolean] always_include_email
|
|
1218
|
+
# Whether to always include a value in the email field for the organizer,
|
|
1219
|
+
# creator and attendees, even if no real email is available (i.e. a generated,
|
|
1220
|
+
# non-working value will be provided). The use of this option is discouraged and
|
|
1221
|
+
# should only be used by clients which cannot handle the absence of an email
|
|
1222
|
+
# address value in the mentioned places. Optional. The default is False.
|
|
1223
|
+
# @param [Fixnum] max_attendees
|
|
1224
|
+
# The maximum number of attendees to include in the response. If there are more
|
|
1225
|
+
# than the specified number of attendees, only the participant is returned.
|
|
1226
|
+
# Optional.
|
|
1227
|
+
# @param [Fixnum] max_results
|
|
1228
|
+
# Maximum number of events returned on one result page. By default the value is
|
|
1229
|
+
# 250 events. The page size can never be larger than 2500 events. Optional.
|
|
1230
|
+
# @param [String] original_start
|
|
1231
|
+
# The original start time of the instance in the result. Optional.
|
|
1232
|
+
# @param [String] page_token
|
|
1233
|
+
# Token specifying which result page to return. Optional.
|
|
1234
|
+
# @param [Boolean] show_deleted
|
|
1235
|
+
# Whether to include deleted events (with status equals "cancelled") in the
|
|
1236
|
+
# result. Cancelled instances of recurring events will still be included if
|
|
1237
|
+
# singleEvents is False. Optional. The default is False.
|
|
1238
|
+
# @param [DateTime] time_max
|
|
1239
|
+
# Upper bound (exclusive) for an event's start time to filter by. Optional. The
|
|
1240
|
+
# default is not to filter by start time. Must be an RFC3339 timestamp with
|
|
1241
|
+
# mandatory time zone offset.
|
|
1242
|
+
# @param [DateTime] time_min
|
|
1243
|
+
# Lower bound (inclusive) for an event's end time to filter by. Optional. The
|
|
1244
|
+
# default is not to filter by end time. Must be an RFC3339 timestamp with
|
|
1245
|
+
# mandatory time zone offset.
|
|
1246
|
+
# @param [String] time_zone
|
|
1247
|
+
# Time zone used in the response. Optional. The default is the time zone of the
|
|
1248
|
+
# calendar.
|
|
1249
|
+
# @param [String] fields
|
|
1250
|
+
# Selector specifying which fields to include in a partial response.
|
|
1251
|
+
# @param [String] quota_user
|
|
1252
|
+
# Available to use for quota purposes for server-side applications. Can be any
|
|
1253
|
+
# arbitrary string assigned to a user, but should not exceed 40 characters.
|
|
1254
|
+
# Overrides userIp if both are provided.
|
|
1255
|
+
# @param [String] user_ip
|
|
1256
|
+
# IP address of the site where the request originates. Use this if you want to
|
|
1257
|
+
# enforce per-user limits.
|
|
1258
|
+
# @param [Google::Apis::RequestOptions] options
|
|
1259
|
+
# Request-specific options
|
|
1260
|
+
#
|
|
1261
|
+
# @yield [result, err] Result & error if block supplied
|
|
1262
|
+
# @yieldparam result [Google::Apis::CalendarV3::Events] parsed result object
|
|
1263
|
+
# @yieldparam err [StandardError] error object if request failed
|
|
1264
|
+
#
|
|
1265
|
+
# @return [Google::Apis::CalendarV3::Events]
|
|
1266
|
+
#
|
|
1267
|
+
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
|
|
1268
|
+
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
|
|
1269
|
+
# @raise [Google::Apis::AuthorizationError] Authorization is required
|
|
1270
|
+
def list_event_instances(calendar_id, event_id, always_include_email: nil, max_attendees: nil, max_results: nil, original_start: nil, page_token: nil, show_deleted: nil, time_max: nil, time_min: nil, time_zone: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block)
|
|
1271
|
+
command = make_simple_command(:get, 'calendars/{calendarId}/events/{eventId}/instances', options)
|
|
1272
|
+
command.response_representation = Google::Apis::CalendarV3::Events::Representation
|
|
1273
|
+
command.response_class = Google::Apis::CalendarV3::Events
|
|
1274
|
+
command.params['calendarId'] = calendar_id unless calendar_id.nil?
|
|
1275
|
+
command.params['eventId'] = event_id unless event_id.nil?
|
|
1276
|
+
command.query['alwaysIncludeEmail'] = always_include_email unless always_include_email.nil?
|
|
1277
|
+
command.query['maxAttendees'] = max_attendees unless max_attendees.nil?
|
|
1278
|
+
command.query['maxResults'] = max_results unless max_results.nil?
|
|
1279
|
+
command.query['originalStart'] = original_start unless original_start.nil?
|
|
1280
|
+
command.query['pageToken'] = page_token unless page_token.nil?
|
|
1281
|
+
command.query['showDeleted'] = show_deleted unless show_deleted.nil?
|
|
1282
|
+
command.query['timeMax'] = time_max unless time_max.nil?
|
|
1283
|
+
command.query['timeMin'] = time_min unless time_min.nil?
|
|
1284
|
+
command.query['timeZone'] = time_zone unless time_zone.nil?
|
|
1285
|
+
command.query['fields'] = fields unless fields.nil?
|
|
1286
|
+
command.query['quotaUser'] = quota_user unless quota_user.nil?
|
|
1287
|
+
command.query['userIp'] = user_ip unless user_ip.nil?
|
|
1288
|
+
execute_or_queue_command(command, &block)
|
|
1289
|
+
end
|
|
1290
|
+
|
|
1291
|
+
# Returns events on the specified calendar.
|
|
1292
|
+
# @param [String] calendar_id
|
|
1293
|
+
# Calendar identifier. To retrieve calendar IDs call the calendarList.list
|
|
1294
|
+
# method. If you want to access the primary calendar of the currently logged in
|
|
1295
|
+
# user, use the "primary" keyword.
|
|
1296
|
+
# @param [Boolean] always_include_email
|
|
1297
|
+
# Whether to always include a value in the email field for the organizer,
|
|
1298
|
+
# creator and attendees, even if no real email is available (i.e. a generated,
|
|
1299
|
+
# non-working value will be provided). The use of this option is discouraged and
|
|
1300
|
+
# should only be used by clients which cannot handle the absence of an email
|
|
1301
|
+
# address value in the mentioned places. Optional. The default is False.
|
|
1302
|
+
# @param [String] i_cal_uid
|
|
1303
|
+
# Specifies event ID in the iCalendar format to be included in the response.
|
|
1304
|
+
# Optional.
|
|
1305
|
+
# @param [Fixnum] max_attendees
|
|
1306
|
+
# The maximum number of attendees to include in the response. If there are more
|
|
1307
|
+
# than the specified number of attendees, only the participant is returned.
|
|
1308
|
+
# Optional.
|
|
1309
|
+
# @param [Fixnum] max_results
|
|
1310
|
+
# Maximum number of events returned on one result page. By default the value is
|
|
1311
|
+
# 250 events. The page size can never be larger than 2500 events. Optional.
|
|
1312
|
+
# @param [String] order_by
|
|
1313
|
+
# The order of the events returned in the result. Optional. The default is an
|
|
1314
|
+
# unspecified, stable order.
|
|
1315
|
+
# @param [String] page_token
|
|
1316
|
+
# Token specifying which result page to return. Optional.
|
|
1317
|
+
# @param [Array<String>, String] private_extended_property
|
|
1318
|
+
# Extended properties constraint specified as propertyName=value. Matches only
|
|
1319
|
+
# private properties. This parameter might be repeated multiple times to return
|
|
1320
|
+
# events that match all given constraints.
|
|
1321
|
+
# @param [String] q
|
|
1322
|
+
# Free text search terms to find events that match these terms in any field,
|
|
1323
|
+
# except for extended properties. Optional.
|
|
1324
|
+
# @param [Array<String>, String] shared_extended_property
|
|
1325
|
+
# Extended properties constraint specified as propertyName=value. Matches only
|
|
1326
|
+
# shared properties. This parameter might be repeated multiple times to return
|
|
1327
|
+
# events that match all given constraints.
|
|
1328
|
+
# @param [Boolean] show_deleted
|
|
1329
|
+
# Whether to include deleted events (with status equals "cancelled") in the
|
|
1330
|
+
# result. Cancelled instances of recurring events (but not the underlying
|
|
1331
|
+
# recurring event) will still be included if showDeleted and singleEvents are
|
|
1332
|
+
# both False. If showDeleted and singleEvents are both True, only single
|
|
1333
|
+
# instances of deleted events (but not the underlying recurring events) are
|
|
1334
|
+
# returned. Optional. The default is False.
|
|
1335
|
+
# @param [Boolean] show_hidden_invitations
|
|
1336
|
+
# Whether to include hidden invitations in the result. Optional. The default is
|
|
1337
|
+
# False.
|
|
1338
|
+
# @param [Boolean] single_events
|
|
1339
|
+
# Whether to expand recurring events into instances and only return single one-
|
|
1340
|
+
# off events and instances of recurring events, but not the underlying recurring
|
|
1341
|
+
# events themselves. Optional. The default is False.
|
|
1342
|
+
# @param [String] sync_token
|
|
1343
|
+
# Token obtained from the nextSyncToken field returned on the last page of
|
|
1344
|
+
# results from the previous list request. It makes the result of this list
|
|
1345
|
+
# request contain only entries that have changed since then. All events deleted
|
|
1346
|
+
# since the previous list request will always be in the result set and it is not
|
|
1347
|
+
# allowed to set showDeleted to False.
|
|
1348
|
+
# There are several query parameters that cannot be specified together with
|
|
1349
|
+
# nextSyncToken to ensure consistency of the client state.
|
|
1350
|
+
# These are:
|
|
1351
|
+
# - iCalUID
|
|
1352
|
+
# - orderBy
|
|
1353
|
+
# - privateExtendedProperty
|
|
1354
|
+
# - q
|
|
1355
|
+
# - sharedExtendedProperty
|
|
1356
|
+
# - timeMin
|
|
1357
|
+
# - timeMax
|
|
1358
|
+
# - updatedMin If the syncToken expires, the server will respond with a 410 GONE
|
|
1359
|
+
# response code and the client should clear its storage and perform a full
|
|
1360
|
+
# synchronization without any syncToken.
|
|
1361
|
+
# Learn more about incremental synchronization.
|
|
1362
|
+
# Optional. The default is to return all entries.
|
|
1363
|
+
# @param [DateTime] time_max
|
|
1364
|
+
# Upper bound (exclusive) for an event's start time to filter by. Optional. The
|
|
1365
|
+
# default is not to filter by start time. Must be an RFC3339 timestamp with
|
|
1366
|
+
# mandatory time zone offset, e.g., 2011-06-03T10:00:00-07:00, 2011-06-03T10:00:
|
|
1367
|
+
# 00Z. Milliseconds may be provided but will be ignored.
|
|
1368
|
+
# @param [DateTime] time_min
|
|
1369
|
+
# Lower bound (inclusive) for an event's end time to filter by. Optional. The
|
|
1370
|
+
# default is not to filter by end time. Must be an RFC3339 timestamp with
|
|
1371
|
+
# mandatory time zone offset, e.g., 2011-06-03T10:00:00-07:00, 2011-06-03T10:00:
|
|
1372
|
+
# 00Z. Milliseconds may be provided but will be ignored.
|
|
1373
|
+
# @param [String] time_zone
|
|
1374
|
+
# Time zone used in the response. Optional. The default is the time zone of the
|
|
1375
|
+
# calendar.
|
|
1376
|
+
# @param [DateTime] updated_min
|
|
1377
|
+
# Lower bound for an event's last modification time (as a RFC3339 timestamp) to
|
|
1378
|
+
# filter by. When specified, entries deleted since this time will always be
|
|
1379
|
+
# included regardless of showDeleted. Optional. The default is not to filter by
|
|
1380
|
+
# last modification time.
|
|
1381
|
+
# @param [String] fields
|
|
1382
|
+
# Selector specifying which fields to include in a partial response.
|
|
1383
|
+
# @param [String] quota_user
|
|
1384
|
+
# Available to use for quota purposes for server-side applications. Can be any
|
|
1385
|
+
# arbitrary string assigned to a user, but should not exceed 40 characters.
|
|
1386
|
+
# Overrides userIp if both are provided.
|
|
1387
|
+
# @param [String] user_ip
|
|
1388
|
+
# IP address of the site where the request originates. Use this if you want to
|
|
1389
|
+
# enforce per-user limits.
|
|
1390
|
+
# @param [Google::Apis::RequestOptions] options
|
|
1391
|
+
# Request-specific options
|
|
1392
|
+
#
|
|
1393
|
+
# @yield [result, err] Result & error if block supplied
|
|
1394
|
+
# @yieldparam result [Google::Apis::CalendarV3::Events] parsed result object
|
|
1395
|
+
# @yieldparam err [StandardError] error object if request failed
|
|
1396
|
+
#
|
|
1397
|
+
# @return [Google::Apis::CalendarV3::Events]
|
|
1398
|
+
#
|
|
1399
|
+
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
|
|
1400
|
+
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
|
|
1401
|
+
# @raise [Google::Apis::AuthorizationError] Authorization is required
|
|
1402
|
+
def list_events(calendar_id, always_include_email: nil, i_cal_uid: nil, max_attendees: nil, max_results: nil, order_by: nil, page_token: nil, private_extended_property: nil, q: nil, shared_extended_property: nil, show_deleted: nil, show_hidden_invitations: nil, single_events: nil, sync_token: nil, time_max: nil, time_min: nil, time_zone: nil, updated_min: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block)
|
|
1403
|
+
command = make_simple_command(:get, 'calendars/{calendarId}/events', options)
|
|
1404
|
+
command.response_representation = Google::Apis::CalendarV3::Events::Representation
|
|
1405
|
+
command.response_class = Google::Apis::CalendarV3::Events
|
|
1406
|
+
command.params['calendarId'] = calendar_id unless calendar_id.nil?
|
|
1407
|
+
command.query['alwaysIncludeEmail'] = always_include_email unless always_include_email.nil?
|
|
1408
|
+
command.query['iCalUID'] = i_cal_uid unless i_cal_uid.nil?
|
|
1409
|
+
command.query['maxAttendees'] = max_attendees unless max_attendees.nil?
|
|
1410
|
+
command.query['maxResults'] = max_results unless max_results.nil?
|
|
1411
|
+
command.query['orderBy'] = order_by unless order_by.nil?
|
|
1412
|
+
command.query['pageToken'] = page_token unless page_token.nil?
|
|
1413
|
+
command.query['privateExtendedProperty'] = private_extended_property unless private_extended_property.nil?
|
|
1414
|
+
command.query['q'] = q unless q.nil?
|
|
1415
|
+
command.query['sharedExtendedProperty'] = shared_extended_property unless shared_extended_property.nil?
|
|
1416
|
+
command.query['showDeleted'] = show_deleted unless show_deleted.nil?
|
|
1417
|
+
command.query['showHiddenInvitations'] = show_hidden_invitations unless show_hidden_invitations.nil?
|
|
1418
|
+
command.query['singleEvents'] = single_events unless single_events.nil?
|
|
1419
|
+
command.query['syncToken'] = sync_token unless sync_token.nil?
|
|
1420
|
+
command.query['timeMax'] = time_max unless time_max.nil?
|
|
1421
|
+
command.query['timeMin'] = time_min unless time_min.nil?
|
|
1422
|
+
command.query['timeZone'] = time_zone unless time_zone.nil?
|
|
1423
|
+
command.query['updatedMin'] = updated_min unless updated_min.nil?
|
|
1424
|
+
command.query['fields'] = fields unless fields.nil?
|
|
1425
|
+
command.query['quotaUser'] = quota_user unless quota_user.nil?
|
|
1426
|
+
command.query['userIp'] = user_ip unless user_ip.nil?
|
|
1427
|
+
execute_or_queue_command(command, &block)
|
|
1428
|
+
end
|
|
1429
|
+
|
|
1430
|
+
# Moves an event to another calendar, i.e. changes an event's organizer.
|
|
1431
|
+
# @param [String] calendar_id
|
|
1432
|
+
# Calendar identifier of the source calendar where the event currently is on.
|
|
1433
|
+
# @param [String] event_id
|
|
1434
|
+
# Event identifier.
|
|
1435
|
+
# @param [String] destination
|
|
1436
|
+
# Calendar identifier of the target calendar where the event is to be moved to.
|
|
1437
|
+
# @param [Boolean] send_notifications
|
|
1438
|
+
# Whether to send notifications about the change of the event's organizer.
|
|
1439
|
+
# Optional. The default is False.
|
|
1440
|
+
# @param [String] fields
|
|
1441
|
+
# Selector specifying which fields to include in a partial response.
|
|
1442
|
+
# @param [String] quota_user
|
|
1443
|
+
# Available to use for quota purposes for server-side applications. Can be any
|
|
1444
|
+
# arbitrary string assigned to a user, but should not exceed 40 characters.
|
|
1445
|
+
# Overrides userIp if both are provided.
|
|
1446
|
+
# @param [String] user_ip
|
|
1447
|
+
# IP address of the site where the request originates. Use this if you want to
|
|
1448
|
+
# enforce per-user limits.
|
|
1449
|
+
# @param [Google::Apis::RequestOptions] options
|
|
1450
|
+
# Request-specific options
|
|
1451
|
+
#
|
|
1452
|
+
# @yield [result, err] Result & error if block supplied
|
|
1453
|
+
# @yieldparam result [Google::Apis::CalendarV3::Event] parsed result object
|
|
1454
|
+
# @yieldparam err [StandardError] error object if request failed
|
|
1455
|
+
#
|
|
1456
|
+
# @return [Google::Apis::CalendarV3::Event]
|
|
1457
|
+
#
|
|
1458
|
+
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
|
|
1459
|
+
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
|
|
1460
|
+
# @raise [Google::Apis::AuthorizationError] Authorization is required
|
|
1461
|
+
def move_event(calendar_id, event_id, destination, send_notifications: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block)
|
|
1462
|
+
command = make_simple_command(:post, 'calendars/{calendarId}/events/{eventId}/move', options)
|
|
1463
|
+
command.response_representation = Google::Apis::CalendarV3::Event::Representation
|
|
1464
|
+
command.response_class = Google::Apis::CalendarV3::Event
|
|
1465
|
+
command.params['calendarId'] = calendar_id unless calendar_id.nil?
|
|
1466
|
+
command.params['eventId'] = event_id unless event_id.nil?
|
|
1467
|
+
command.query['destination'] = destination unless destination.nil?
|
|
1468
|
+
command.query['sendNotifications'] = send_notifications unless send_notifications.nil?
|
|
1469
|
+
command.query['fields'] = fields unless fields.nil?
|
|
1470
|
+
command.query['quotaUser'] = quota_user unless quota_user.nil?
|
|
1471
|
+
command.query['userIp'] = user_ip unless user_ip.nil?
|
|
1472
|
+
execute_or_queue_command(command, &block)
|
|
1473
|
+
end
|
|
1474
|
+
|
|
1475
|
+
# Updates an event. This method supports patch semantics.
|
|
1476
|
+
# @param [String] calendar_id
|
|
1477
|
+
# Calendar identifier. To retrieve calendar IDs call the calendarList.list
|
|
1478
|
+
# method. If you want to access the primary calendar of the currently logged in
|
|
1479
|
+
# user, use the "primary" keyword.
|
|
1480
|
+
# @param [String] event_id
|
|
1481
|
+
# Event identifier.
|
|
1482
|
+
# @param [Google::Apis::CalendarV3::Event] event_object
|
|
1483
|
+
# @param [Boolean] always_include_email
|
|
1484
|
+
# Whether to always include a value in the email field for the organizer,
|
|
1485
|
+
# creator and attendees, even if no real email is available (i.e. a generated,
|
|
1486
|
+
# non-working value will be provided). The use of this option is discouraged and
|
|
1487
|
+
# should only be used by clients which cannot handle the absence of an email
|
|
1488
|
+
# address value in the mentioned places. Optional. The default is False.
|
|
1489
|
+
# @param [Fixnum] max_attendees
|
|
1490
|
+
# The maximum number of attendees to include in the response. If there are more
|
|
1491
|
+
# than the specified number of attendees, only the participant is returned.
|
|
1492
|
+
# Optional.
|
|
1493
|
+
# @param [Boolean] send_notifications
|
|
1494
|
+
# Whether to send notifications about the event update (e.g. attendee's
|
|
1495
|
+
# responses, title changes, etc.). Optional. The default is False.
|
|
1496
|
+
# @param [Boolean] supports_attachments
|
|
1497
|
+
# Whether API client performing operation supports event attachments. Optional.
|
|
1498
|
+
# The default is False.
|
|
1499
|
+
# @param [String] fields
|
|
1500
|
+
# Selector specifying which fields to include in a partial response.
|
|
1501
|
+
# @param [String] quota_user
|
|
1502
|
+
# Available to use for quota purposes for server-side applications. Can be any
|
|
1503
|
+
# arbitrary string assigned to a user, but should not exceed 40 characters.
|
|
1504
|
+
# Overrides userIp if both are provided.
|
|
1505
|
+
# @param [String] user_ip
|
|
1506
|
+
# IP address of the site where the request originates. Use this if you want to
|
|
1507
|
+
# enforce per-user limits.
|
|
1508
|
+
# @param [Google::Apis::RequestOptions] options
|
|
1509
|
+
# Request-specific options
|
|
1510
|
+
#
|
|
1511
|
+
# @yield [result, err] Result & error if block supplied
|
|
1512
|
+
# @yieldparam result [Google::Apis::CalendarV3::Event] parsed result object
|
|
1513
|
+
# @yieldparam err [StandardError] error object if request failed
|
|
1514
|
+
#
|
|
1515
|
+
# @return [Google::Apis::CalendarV3::Event]
|
|
1516
|
+
#
|
|
1517
|
+
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
|
|
1518
|
+
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
|
|
1519
|
+
# @raise [Google::Apis::AuthorizationError] Authorization is required
|
|
1520
|
+
def patch_event(calendar_id, event_id, event_object = nil, always_include_email: nil, max_attendees: nil, send_notifications: nil, supports_attachments: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block)
|
|
1521
|
+
command = make_simple_command(:patch, 'calendars/{calendarId}/events/{eventId}', options)
|
|
1522
|
+
command.request_representation = Google::Apis::CalendarV3::Event::Representation
|
|
1523
|
+
command.request_object = event_object
|
|
1524
|
+
command.response_representation = Google::Apis::CalendarV3::Event::Representation
|
|
1525
|
+
command.response_class = Google::Apis::CalendarV3::Event
|
|
1526
|
+
command.params['calendarId'] = calendar_id unless calendar_id.nil?
|
|
1527
|
+
command.params['eventId'] = event_id unless event_id.nil?
|
|
1528
|
+
command.query['alwaysIncludeEmail'] = always_include_email unless always_include_email.nil?
|
|
1529
|
+
command.query['maxAttendees'] = max_attendees unless max_attendees.nil?
|
|
1530
|
+
command.query['sendNotifications'] = send_notifications unless send_notifications.nil?
|
|
1531
|
+
command.query['supportsAttachments'] = supports_attachments unless supports_attachments.nil?
|
|
1532
|
+
command.query['fields'] = fields unless fields.nil?
|
|
1533
|
+
command.query['quotaUser'] = quota_user unless quota_user.nil?
|
|
1534
|
+
command.query['userIp'] = user_ip unless user_ip.nil?
|
|
1535
|
+
execute_or_queue_command(command, &block)
|
|
1536
|
+
end
|
|
1537
|
+
|
|
1538
|
+
# Creates an event based on a simple text string.
|
|
1539
|
+
# @param [String] calendar_id
|
|
1540
|
+
# Calendar identifier. To retrieve calendar IDs call the calendarList.list
|
|
1541
|
+
# method. If you want to access the primary calendar of the currently logged in
|
|
1542
|
+
# user, use the "primary" keyword.
|
|
1543
|
+
# @param [String] text
|
|
1544
|
+
# The text describing the event to be created.
|
|
1545
|
+
# @param [Boolean] send_notifications
|
|
1546
|
+
# Whether to send notifications about the creation of the event. Optional. The
|
|
1547
|
+
# default is False.
|
|
1548
|
+
# @param [String] fields
|
|
1549
|
+
# Selector specifying which fields to include in a partial response.
|
|
1550
|
+
# @param [String] quota_user
|
|
1551
|
+
# Available to use for quota purposes for server-side applications. Can be any
|
|
1552
|
+
# arbitrary string assigned to a user, but should not exceed 40 characters.
|
|
1553
|
+
# Overrides userIp if both are provided.
|
|
1554
|
+
# @param [String] user_ip
|
|
1555
|
+
# IP address of the site where the request originates. Use this if you want to
|
|
1556
|
+
# enforce per-user limits.
|
|
1557
|
+
# @param [Google::Apis::RequestOptions] options
|
|
1558
|
+
# Request-specific options
|
|
1559
|
+
#
|
|
1560
|
+
# @yield [result, err] Result & error if block supplied
|
|
1561
|
+
# @yieldparam result [Google::Apis::CalendarV3::Event] parsed result object
|
|
1562
|
+
# @yieldparam err [StandardError] error object if request failed
|
|
1563
|
+
#
|
|
1564
|
+
# @return [Google::Apis::CalendarV3::Event]
|
|
1565
|
+
#
|
|
1566
|
+
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
|
|
1567
|
+
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
|
|
1568
|
+
# @raise [Google::Apis::AuthorizationError] Authorization is required
|
|
1569
|
+
def quick_add_event(calendar_id, text, send_notifications: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block)
|
|
1570
|
+
command = make_simple_command(:post, 'calendars/{calendarId}/events/quickAdd', options)
|
|
1571
|
+
command.response_representation = Google::Apis::CalendarV3::Event::Representation
|
|
1572
|
+
command.response_class = Google::Apis::CalendarV3::Event
|
|
1573
|
+
command.params['calendarId'] = calendar_id unless calendar_id.nil?
|
|
1574
|
+
command.query['sendNotifications'] = send_notifications unless send_notifications.nil?
|
|
1575
|
+
command.query['text'] = text unless text.nil?
|
|
1576
|
+
command.query['fields'] = fields unless fields.nil?
|
|
1577
|
+
command.query['quotaUser'] = quota_user unless quota_user.nil?
|
|
1578
|
+
command.query['userIp'] = user_ip unless user_ip.nil?
|
|
1579
|
+
execute_or_queue_command(command, &block)
|
|
1580
|
+
end
|
|
1581
|
+
|
|
1582
|
+
# Updates an event.
|
|
1583
|
+
# @param [String] calendar_id
|
|
1584
|
+
# Calendar identifier. To retrieve calendar IDs call the calendarList.list
|
|
1585
|
+
# method. If you want to access the primary calendar of the currently logged in
|
|
1586
|
+
# user, use the "primary" keyword.
|
|
1587
|
+
# @param [String] event_id
|
|
1588
|
+
# Event identifier.
|
|
1589
|
+
# @param [Google::Apis::CalendarV3::Event] event_object
|
|
1590
|
+
# @param [Boolean] always_include_email
|
|
1591
|
+
# Whether to always include a value in the email field for the organizer,
|
|
1592
|
+
# creator and attendees, even if no real email is available (i.e. a generated,
|
|
1593
|
+
# non-working value will be provided). The use of this option is discouraged and
|
|
1594
|
+
# should only be used by clients which cannot handle the absence of an email
|
|
1595
|
+
# address value in the mentioned places. Optional. The default is False.
|
|
1596
|
+
# @param [Fixnum] max_attendees
|
|
1597
|
+
# The maximum number of attendees to include in the response. If there are more
|
|
1598
|
+
# than the specified number of attendees, only the participant is returned.
|
|
1599
|
+
# Optional.
|
|
1600
|
+
# @param [Boolean] send_notifications
|
|
1601
|
+
# Whether to send notifications about the event update (e.g. attendee's
|
|
1602
|
+
# responses, title changes, etc.). Optional. The default is False.
|
|
1603
|
+
# @param [Boolean] supports_attachments
|
|
1604
|
+
# Whether API client performing operation supports event attachments. Optional.
|
|
1605
|
+
# The default is False.
|
|
1606
|
+
# @param [String] fields
|
|
1607
|
+
# Selector specifying which fields to include in a partial response.
|
|
1608
|
+
# @param [String] quota_user
|
|
1609
|
+
# Available to use for quota purposes for server-side applications. Can be any
|
|
1610
|
+
# arbitrary string assigned to a user, but should not exceed 40 characters.
|
|
1611
|
+
# Overrides userIp if both are provided.
|
|
1612
|
+
# @param [String] user_ip
|
|
1613
|
+
# IP address of the site where the request originates. Use this if you want to
|
|
1614
|
+
# enforce per-user limits.
|
|
1615
|
+
# @param [Google::Apis::RequestOptions] options
|
|
1616
|
+
# Request-specific options
|
|
1617
|
+
#
|
|
1618
|
+
# @yield [result, err] Result & error if block supplied
|
|
1619
|
+
# @yieldparam result [Google::Apis::CalendarV3::Event] parsed result object
|
|
1620
|
+
# @yieldparam err [StandardError] error object if request failed
|
|
1621
|
+
#
|
|
1622
|
+
# @return [Google::Apis::CalendarV3::Event]
|
|
1623
|
+
#
|
|
1624
|
+
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
|
|
1625
|
+
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
|
|
1626
|
+
# @raise [Google::Apis::AuthorizationError] Authorization is required
|
|
1627
|
+
def update_event(calendar_id, event_id, event_object = nil, always_include_email: nil, max_attendees: nil, send_notifications: nil, supports_attachments: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block)
|
|
1628
|
+
command = make_simple_command(:put, 'calendars/{calendarId}/events/{eventId}', options)
|
|
1629
|
+
command.request_representation = Google::Apis::CalendarV3::Event::Representation
|
|
1630
|
+
command.request_object = event_object
|
|
1631
|
+
command.response_representation = Google::Apis::CalendarV3::Event::Representation
|
|
1632
|
+
command.response_class = Google::Apis::CalendarV3::Event
|
|
1633
|
+
command.params['calendarId'] = calendar_id unless calendar_id.nil?
|
|
1634
|
+
command.params['eventId'] = event_id unless event_id.nil?
|
|
1635
|
+
command.query['alwaysIncludeEmail'] = always_include_email unless always_include_email.nil?
|
|
1636
|
+
command.query['maxAttendees'] = max_attendees unless max_attendees.nil?
|
|
1637
|
+
command.query['sendNotifications'] = send_notifications unless send_notifications.nil?
|
|
1638
|
+
command.query['supportsAttachments'] = supports_attachments unless supports_attachments.nil?
|
|
1639
|
+
command.query['fields'] = fields unless fields.nil?
|
|
1640
|
+
command.query['quotaUser'] = quota_user unless quota_user.nil?
|
|
1641
|
+
command.query['userIp'] = user_ip unless user_ip.nil?
|
|
1642
|
+
execute_or_queue_command(command, &block)
|
|
1643
|
+
end
|
|
1644
|
+
|
|
1645
|
+
# Watch for changes to Events resources.
|
|
1646
|
+
# @param [String] calendar_id
|
|
1647
|
+
# Calendar identifier. To retrieve calendar IDs call the calendarList.list
|
|
1648
|
+
# method. If you want to access the primary calendar of the currently logged in
|
|
1649
|
+
# user, use the "primary" keyword.
|
|
1650
|
+
# @param [Google::Apis::CalendarV3::Channel] channel_object
|
|
1651
|
+
# @param [Boolean] always_include_email
|
|
1652
|
+
# Whether to always include a value in the email field for the organizer,
|
|
1653
|
+
# creator and attendees, even if no real email is available (i.e. a generated,
|
|
1654
|
+
# non-working value will be provided). The use of this option is discouraged and
|
|
1655
|
+
# should only be used by clients which cannot handle the absence of an email
|
|
1656
|
+
# address value in the mentioned places. Optional. The default is False.
|
|
1657
|
+
# @param [String] i_cal_uid
|
|
1658
|
+
# Specifies event ID in the iCalendar format to be included in the response.
|
|
1659
|
+
# Optional.
|
|
1660
|
+
# @param [Fixnum] max_attendees
|
|
1661
|
+
# The maximum number of attendees to include in the response. If there are more
|
|
1662
|
+
# than the specified number of attendees, only the participant is returned.
|
|
1663
|
+
# Optional.
|
|
1664
|
+
# @param [Fixnum] max_results
|
|
1665
|
+
# Maximum number of events returned on one result page. By default the value is
|
|
1666
|
+
# 250 events. The page size can never be larger than 2500 events. Optional.
|
|
1667
|
+
# @param [String] order_by
|
|
1668
|
+
# The order of the events returned in the result. Optional. The default is an
|
|
1669
|
+
# unspecified, stable order.
|
|
1670
|
+
# @param [String] page_token
|
|
1671
|
+
# Token specifying which result page to return. Optional.
|
|
1672
|
+
# @param [Array<String>, String] private_extended_property
|
|
1673
|
+
# Extended properties constraint specified as propertyName=value. Matches only
|
|
1674
|
+
# private properties. This parameter might be repeated multiple times to return
|
|
1675
|
+
# events that match all given constraints.
|
|
1676
|
+
# @param [String] q
|
|
1677
|
+
# Free text search terms to find events that match these terms in any field,
|
|
1678
|
+
# except for extended properties. Optional.
|
|
1679
|
+
# @param [Array<String>, String] shared_extended_property
|
|
1680
|
+
# Extended properties constraint specified as propertyName=value. Matches only
|
|
1681
|
+
# shared properties. This parameter might be repeated multiple times to return
|
|
1682
|
+
# events that match all given constraints.
|
|
1683
|
+
# @param [Boolean] show_deleted
|
|
1684
|
+
# Whether to include deleted events (with status equals "cancelled") in the
|
|
1685
|
+
# result. Cancelled instances of recurring events (but not the underlying
|
|
1686
|
+
# recurring event) will still be included if showDeleted and singleEvents are
|
|
1687
|
+
# both False. If showDeleted and singleEvents are both True, only single
|
|
1688
|
+
# instances of deleted events (but not the underlying recurring events) are
|
|
1689
|
+
# returned. Optional. The default is False.
|
|
1690
|
+
# @param [Boolean] show_hidden_invitations
|
|
1691
|
+
# Whether to include hidden invitations in the result. Optional. The default is
|
|
1692
|
+
# False.
|
|
1693
|
+
# @param [Boolean] single_events
|
|
1694
|
+
# Whether to expand recurring events into instances and only return single one-
|
|
1695
|
+
# off events and instances of recurring events, but not the underlying recurring
|
|
1696
|
+
# events themselves. Optional. The default is False.
|
|
1697
|
+
# @param [String] sync_token
|
|
1698
|
+
# Token obtained from the nextSyncToken field returned on the last page of
|
|
1699
|
+
# results from the previous list request. It makes the result of this list
|
|
1700
|
+
# request contain only entries that have changed since then. All events deleted
|
|
1701
|
+
# since the previous list request will always be in the result set and it is not
|
|
1702
|
+
# allowed to set showDeleted to False.
|
|
1703
|
+
# There are several query parameters that cannot be specified together with
|
|
1704
|
+
# nextSyncToken to ensure consistency of the client state.
|
|
1705
|
+
# These are:
|
|
1706
|
+
# - iCalUID
|
|
1707
|
+
# - orderBy
|
|
1708
|
+
# - privateExtendedProperty
|
|
1709
|
+
# - q
|
|
1710
|
+
# - sharedExtendedProperty
|
|
1711
|
+
# - timeMin
|
|
1712
|
+
# - timeMax
|
|
1713
|
+
# - updatedMin If the syncToken expires, the server will respond with a 410 GONE
|
|
1714
|
+
# response code and the client should clear its storage and perform a full
|
|
1715
|
+
# synchronization without any syncToken.
|
|
1716
|
+
# Learn more about incremental synchronization.
|
|
1717
|
+
# Optional. The default is to return all entries.
|
|
1718
|
+
# @param [DateTime] time_max
|
|
1719
|
+
# Upper bound (exclusive) for an event's start time to filter by. Optional. The
|
|
1720
|
+
# default is not to filter by start time. Must be an RFC3339 timestamp with
|
|
1721
|
+
# mandatory time zone offset, e.g., 2011-06-03T10:00:00-07:00, 2011-06-03T10:00:
|
|
1722
|
+
# 00Z. Milliseconds may be provided but will be ignored.
|
|
1723
|
+
# @param [DateTime] time_min
|
|
1724
|
+
# Lower bound (inclusive) for an event's end time to filter by. Optional. The
|
|
1725
|
+
# default is not to filter by end time. Must be an RFC3339 timestamp with
|
|
1726
|
+
# mandatory time zone offset, e.g., 2011-06-03T10:00:00-07:00, 2011-06-03T10:00:
|
|
1727
|
+
# 00Z. Milliseconds may be provided but will be ignored.
|
|
1728
|
+
# @param [String] time_zone
|
|
1729
|
+
# Time zone used in the response. Optional. The default is the time zone of the
|
|
1730
|
+
# calendar.
|
|
1731
|
+
# @param [DateTime] updated_min
|
|
1732
|
+
# Lower bound for an event's last modification time (as a RFC3339 timestamp) to
|
|
1733
|
+
# filter by. When specified, entries deleted since this time will always be
|
|
1734
|
+
# included regardless of showDeleted. Optional. The default is not to filter by
|
|
1735
|
+
# last modification time.
|
|
1736
|
+
# @param [String] fields
|
|
1737
|
+
# Selector specifying which fields to include in a partial response.
|
|
1738
|
+
# @param [String] quota_user
|
|
1739
|
+
# Available to use for quota purposes for server-side applications. Can be any
|
|
1740
|
+
# arbitrary string assigned to a user, but should not exceed 40 characters.
|
|
1741
|
+
# Overrides userIp if both are provided.
|
|
1742
|
+
# @param [String] user_ip
|
|
1743
|
+
# IP address of the site where the request originates. Use this if you want to
|
|
1744
|
+
# enforce per-user limits.
|
|
1745
|
+
# @param [Google::Apis::RequestOptions] options
|
|
1746
|
+
# Request-specific options
|
|
1747
|
+
#
|
|
1748
|
+
# @yield [result, err] Result & error if block supplied
|
|
1749
|
+
# @yieldparam result [Google::Apis::CalendarV3::Channel] parsed result object
|
|
1750
|
+
# @yieldparam err [StandardError] error object if request failed
|
|
1751
|
+
#
|
|
1752
|
+
# @return [Google::Apis::CalendarV3::Channel]
|
|
1753
|
+
#
|
|
1754
|
+
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
|
|
1755
|
+
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
|
|
1756
|
+
# @raise [Google::Apis::AuthorizationError] Authorization is required
|
|
1757
|
+
def watch_event(calendar_id, channel_object = nil, always_include_email: nil, i_cal_uid: nil, max_attendees: nil, max_results: nil, order_by: nil, page_token: nil, private_extended_property: nil, q: nil, shared_extended_property: nil, show_deleted: nil, show_hidden_invitations: nil, single_events: nil, sync_token: nil, time_max: nil, time_min: nil, time_zone: nil, updated_min: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block)
|
|
1758
|
+
command = make_simple_command(:post, 'calendars/{calendarId}/events/watch', options)
|
|
1759
|
+
command.request_representation = Google::Apis::CalendarV3::Channel::Representation
|
|
1760
|
+
command.request_object = channel_object
|
|
1761
|
+
command.response_representation = Google::Apis::CalendarV3::Channel::Representation
|
|
1762
|
+
command.response_class = Google::Apis::CalendarV3::Channel
|
|
1763
|
+
command.params['calendarId'] = calendar_id unless calendar_id.nil?
|
|
1764
|
+
command.query['alwaysIncludeEmail'] = always_include_email unless always_include_email.nil?
|
|
1765
|
+
command.query['iCalUID'] = i_cal_uid unless i_cal_uid.nil?
|
|
1766
|
+
command.query['maxAttendees'] = max_attendees unless max_attendees.nil?
|
|
1767
|
+
command.query['maxResults'] = max_results unless max_results.nil?
|
|
1768
|
+
command.query['orderBy'] = order_by unless order_by.nil?
|
|
1769
|
+
command.query['pageToken'] = page_token unless page_token.nil?
|
|
1770
|
+
command.query['privateExtendedProperty'] = private_extended_property unless private_extended_property.nil?
|
|
1771
|
+
command.query['q'] = q unless q.nil?
|
|
1772
|
+
command.query['sharedExtendedProperty'] = shared_extended_property unless shared_extended_property.nil?
|
|
1773
|
+
command.query['showDeleted'] = show_deleted unless show_deleted.nil?
|
|
1774
|
+
command.query['showHiddenInvitations'] = show_hidden_invitations unless show_hidden_invitations.nil?
|
|
1775
|
+
command.query['singleEvents'] = single_events unless single_events.nil?
|
|
1776
|
+
command.query['syncToken'] = sync_token unless sync_token.nil?
|
|
1777
|
+
command.query['timeMax'] = time_max unless time_max.nil?
|
|
1778
|
+
command.query['timeMin'] = time_min unless time_min.nil?
|
|
1779
|
+
command.query['timeZone'] = time_zone unless time_zone.nil?
|
|
1780
|
+
command.query['updatedMin'] = updated_min unless updated_min.nil?
|
|
1781
|
+
command.query['fields'] = fields unless fields.nil?
|
|
1782
|
+
command.query['quotaUser'] = quota_user unless quota_user.nil?
|
|
1783
|
+
command.query['userIp'] = user_ip unless user_ip.nil?
|
|
1784
|
+
execute_or_queue_command(command, &block)
|
|
1785
|
+
end
|
|
1786
|
+
|
|
1787
|
+
# Returns free/busy information for a set of calendars.
|
|
1788
|
+
# @param [Google::Apis::CalendarV3::FreeBusyRequest] free_busy_request_object
|
|
1789
|
+
# @param [String] fields
|
|
1790
|
+
# Selector specifying which fields to include in a partial response.
|
|
1791
|
+
# @param [String] quota_user
|
|
1792
|
+
# Available to use for quota purposes for server-side applications. Can be any
|
|
1793
|
+
# arbitrary string assigned to a user, but should not exceed 40 characters.
|
|
1794
|
+
# Overrides userIp if both are provided.
|
|
1795
|
+
# @param [String] user_ip
|
|
1796
|
+
# IP address of the site where the request originates. Use this if you want to
|
|
1797
|
+
# enforce per-user limits.
|
|
1798
|
+
# @param [Google::Apis::RequestOptions] options
|
|
1799
|
+
# Request-specific options
|
|
1800
|
+
#
|
|
1801
|
+
# @yield [result, err] Result & error if block supplied
|
|
1802
|
+
# @yieldparam result [Google::Apis::CalendarV3::FreeBusyResponse] parsed result object
|
|
1803
|
+
# @yieldparam err [StandardError] error object if request failed
|
|
1804
|
+
#
|
|
1805
|
+
# @return [Google::Apis::CalendarV3::FreeBusyResponse]
|
|
1806
|
+
#
|
|
1807
|
+
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
|
|
1808
|
+
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
|
|
1809
|
+
# @raise [Google::Apis::AuthorizationError] Authorization is required
|
|
1810
|
+
def query_freebusy(free_busy_request_object = nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block)
|
|
1811
|
+
command = make_simple_command(:post, 'freeBusy', options)
|
|
1812
|
+
command.request_representation = Google::Apis::CalendarV3::FreeBusyRequest::Representation
|
|
1813
|
+
command.request_object = free_busy_request_object
|
|
1814
|
+
command.response_representation = Google::Apis::CalendarV3::FreeBusyResponse::Representation
|
|
1815
|
+
command.response_class = Google::Apis::CalendarV3::FreeBusyResponse
|
|
1816
|
+
command.query['fields'] = fields unless fields.nil?
|
|
1817
|
+
command.query['quotaUser'] = quota_user unless quota_user.nil?
|
|
1818
|
+
command.query['userIp'] = user_ip unless user_ip.nil?
|
|
1819
|
+
execute_or_queue_command(command, &block)
|
|
1820
|
+
end
|
|
1821
|
+
|
|
1822
|
+
# Returns a single user setting.
|
|
1823
|
+
# @param [String] setting
|
|
1824
|
+
# The id of the user setting.
|
|
1825
|
+
# @param [String] fields
|
|
1826
|
+
# Selector specifying which fields to include in a partial response.
|
|
1827
|
+
# @param [String] quota_user
|
|
1828
|
+
# Available to use for quota purposes for server-side applications. Can be any
|
|
1829
|
+
# arbitrary string assigned to a user, but should not exceed 40 characters.
|
|
1830
|
+
# Overrides userIp if both are provided.
|
|
1831
|
+
# @param [String] user_ip
|
|
1832
|
+
# IP address of the site where the request originates. Use this if you want to
|
|
1833
|
+
# enforce per-user limits.
|
|
1834
|
+
# @param [Google::Apis::RequestOptions] options
|
|
1835
|
+
# Request-specific options
|
|
1836
|
+
#
|
|
1837
|
+
# @yield [result, err] Result & error if block supplied
|
|
1838
|
+
# @yieldparam result [Google::Apis::CalendarV3::Setting] parsed result object
|
|
1839
|
+
# @yieldparam err [StandardError] error object if request failed
|
|
1840
|
+
#
|
|
1841
|
+
# @return [Google::Apis::CalendarV3::Setting]
|
|
1842
|
+
#
|
|
1843
|
+
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
|
|
1844
|
+
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
|
|
1845
|
+
# @raise [Google::Apis::AuthorizationError] Authorization is required
|
|
1846
|
+
def get_setting(setting, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block)
|
|
1847
|
+
command = make_simple_command(:get, 'users/me/settings/{setting}', options)
|
|
1848
|
+
command.response_representation = Google::Apis::CalendarV3::Setting::Representation
|
|
1849
|
+
command.response_class = Google::Apis::CalendarV3::Setting
|
|
1850
|
+
command.params['setting'] = setting unless setting.nil?
|
|
1851
|
+
command.query['fields'] = fields unless fields.nil?
|
|
1852
|
+
command.query['quotaUser'] = quota_user unless quota_user.nil?
|
|
1853
|
+
command.query['userIp'] = user_ip unless user_ip.nil?
|
|
1854
|
+
execute_or_queue_command(command, &block)
|
|
1855
|
+
end
|
|
1856
|
+
|
|
1857
|
+
# Returns all user settings for the authenticated user.
|
|
1858
|
+
# @param [Fixnum] max_results
|
|
1859
|
+
# Maximum number of entries returned on one result page. By default the value is
|
|
1860
|
+
# 100 entries. The page size can never be larger than 250 entries. Optional.
|
|
1861
|
+
# @param [String] page_token
|
|
1862
|
+
# Token specifying which result page to return. Optional.
|
|
1863
|
+
# @param [String] sync_token
|
|
1864
|
+
# Token obtained from the nextSyncToken field returned on the last page of
|
|
1865
|
+
# results from the previous list request. It makes the result of this list
|
|
1866
|
+
# request contain only entries that have changed since then.
|
|
1867
|
+
# If the syncToken expires, the server will respond with a 410 GONE response
|
|
1868
|
+
# code and the client should clear its storage and perform a full
|
|
1869
|
+
# synchronization without any syncToken.
|
|
1870
|
+
# Learn more about incremental synchronization.
|
|
1871
|
+
# Optional. The default is to return all entries.
|
|
1872
|
+
# @param [String] fields
|
|
1873
|
+
# Selector specifying which fields to include in a partial response.
|
|
1874
|
+
# @param [String] quota_user
|
|
1875
|
+
# Available to use for quota purposes for server-side applications. Can be any
|
|
1876
|
+
# arbitrary string assigned to a user, but should not exceed 40 characters.
|
|
1877
|
+
# Overrides userIp if both are provided.
|
|
1878
|
+
# @param [String] user_ip
|
|
1879
|
+
# IP address of the site where the request originates. Use this if you want to
|
|
1880
|
+
# enforce per-user limits.
|
|
1881
|
+
# @param [Google::Apis::RequestOptions] options
|
|
1882
|
+
# Request-specific options
|
|
1883
|
+
#
|
|
1884
|
+
# @yield [result, err] Result & error if block supplied
|
|
1885
|
+
# @yieldparam result [Google::Apis::CalendarV3::Settings] parsed result object
|
|
1886
|
+
# @yieldparam err [StandardError] error object if request failed
|
|
1887
|
+
#
|
|
1888
|
+
# @return [Google::Apis::CalendarV3::Settings]
|
|
1889
|
+
#
|
|
1890
|
+
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
|
|
1891
|
+
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
|
|
1892
|
+
# @raise [Google::Apis::AuthorizationError] Authorization is required
|
|
1893
|
+
def list_settings(max_results: nil, page_token: nil, sync_token: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block)
|
|
1894
|
+
command = make_simple_command(:get, 'users/me/settings', options)
|
|
1895
|
+
command.response_representation = Google::Apis::CalendarV3::Settings::Representation
|
|
1896
|
+
command.response_class = Google::Apis::CalendarV3::Settings
|
|
1897
|
+
command.query['maxResults'] = max_results unless max_results.nil?
|
|
1898
|
+
command.query['pageToken'] = page_token unless page_token.nil?
|
|
1899
|
+
command.query['syncToken'] = sync_token unless sync_token.nil?
|
|
1900
|
+
command.query['fields'] = fields unless fields.nil?
|
|
1901
|
+
command.query['quotaUser'] = quota_user unless quota_user.nil?
|
|
1902
|
+
command.query['userIp'] = user_ip unless user_ip.nil?
|
|
1903
|
+
execute_or_queue_command(command, &block)
|
|
1904
|
+
end
|
|
1905
|
+
|
|
1906
|
+
# Watch for changes to Settings resources.
|
|
1907
|
+
# @param [Google::Apis::CalendarV3::Channel] channel_object
|
|
1908
|
+
# @param [Fixnum] max_results
|
|
1909
|
+
# Maximum number of entries returned on one result page. By default the value is
|
|
1910
|
+
# 100 entries. The page size can never be larger than 250 entries. Optional.
|
|
1911
|
+
# @param [String] page_token
|
|
1912
|
+
# Token specifying which result page to return. Optional.
|
|
1913
|
+
# @param [String] sync_token
|
|
1914
|
+
# Token obtained from the nextSyncToken field returned on the last page of
|
|
1915
|
+
# results from the previous list request. It makes the result of this list
|
|
1916
|
+
# request contain only entries that have changed since then.
|
|
1917
|
+
# If the syncToken expires, the server will respond with a 410 GONE response
|
|
1918
|
+
# code and the client should clear its storage and perform a full
|
|
1919
|
+
# synchronization without any syncToken.
|
|
1920
|
+
# Learn more about incremental synchronization.
|
|
1921
|
+
# Optional. The default is to return all entries.
|
|
1922
|
+
# @param [String] fields
|
|
1923
|
+
# Selector specifying which fields to include in a partial response.
|
|
1924
|
+
# @param [String] quota_user
|
|
1925
|
+
# Available to use for quota purposes for server-side applications. Can be any
|
|
1926
|
+
# arbitrary string assigned to a user, but should not exceed 40 characters.
|
|
1927
|
+
# Overrides userIp if both are provided.
|
|
1928
|
+
# @param [String] user_ip
|
|
1929
|
+
# IP address of the site where the request originates. Use this if you want to
|
|
1930
|
+
# enforce per-user limits.
|
|
1931
|
+
# @param [Google::Apis::RequestOptions] options
|
|
1932
|
+
# Request-specific options
|
|
1933
|
+
#
|
|
1934
|
+
# @yield [result, err] Result & error if block supplied
|
|
1935
|
+
# @yieldparam result [Google::Apis::CalendarV3::Channel] parsed result object
|
|
1936
|
+
# @yieldparam err [StandardError] error object if request failed
|
|
1937
|
+
#
|
|
1938
|
+
# @return [Google::Apis::CalendarV3::Channel]
|
|
1939
|
+
#
|
|
1940
|
+
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
|
|
1941
|
+
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
|
|
1942
|
+
# @raise [Google::Apis::AuthorizationError] Authorization is required
|
|
1943
|
+
def watch_setting(channel_object = nil, max_results: nil, page_token: nil, sync_token: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block)
|
|
1944
|
+
command = make_simple_command(:post, 'users/me/settings/watch', options)
|
|
1945
|
+
command.request_representation = Google::Apis::CalendarV3::Channel::Representation
|
|
1946
|
+
command.request_object = channel_object
|
|
1947
|
+
command.response_representation = Google::Apis::CalendarV3::Channel::Representation
|
|
1948
|
+
command.response_class = Google::Apis::CalendarV3::Channel
|
|
1949
|
+
command.query['maxResults'] = max_results unless max_results.nil?
|
|
1950
|
+
command.query['pageToken'] = page_token unless page_token.nil?
|
|
1951
|
+
command.query['syncToken'] = sync_token unless sync_token.nil?
|
|
1952
|
+
command.query['fields'] = fields unless fields.nil?
|
|
1953
|
+
command.query['quotaUser'] = quota_user unless quota_user.nil?
|
|
1954
|
+
command.query['userIp'] = user_ip unless user_ip.nil?
|
|
1955
|
+
execute_or_queue_command(command, &block)
|
|
1956
|
+
end
|
|
1957
|
+
|
|
1958
|
+
protected
|
|
1959
|
+
|
|
1960
|
+
def apply_command_defaults(command)
|
|
1961
|
+
command.query['key'] = key unless key.nil?
|
|
1962
|
+
command.query['quotaUser'] = quota_user unless quota_user.nil?
|
|
1963
|
+
command.query['userIp'] = user_ip unless user_ip.nil?
|
|
1964
|
+
end
|
|
1965
|
+
end
|
|
1966
|
+
end
|
|
1967
|
+
end
|
|
1968
|
+
end
|