google-api-client 0.8.6 → 0.9

data/generated/google/apis/classroom_v1.rb

@@ -0,0 +1,49 @@
+# Copyright 2015 Google Inc.
+#
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+#      http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+
+require 'google/apis/classroom_v1/service.rb'
+require 'google/apis/classroom_v1/classes.rb'
+require 'google/apis/classroom_v1/representations.rb'
+
+module Google
+  module Apis
+    # Google Classroom API
+    #
+    # Google Classroom API
+    #
+    # @see https://developers.google.com/classroom/
+    module ClassroomV1
+      VERSION = 'V1'
+      REVISION = '20151013'
+
+      # Manage your Google Classroom classes
+      AUTH_CLASSROOM_COURSES = 'https://www.googleapis.com/auth/classroom.courses'
+
+      # View your Google Classroom classes
+      AUTH_CLASSROOM_COURSES_READONLY = 'https://www.googleapis.com/auth/classroom.courses.readonly'
+
+      # View the email addresses of people in your classes
+      AUTH_CLASSROOM_PROFILE_EMAILS = 'https://www.googleapis.com/auth/classroom.profile.emails'
+
+      # View the profile photos of people in your classes
+      AUTH_CLASSROOM_PROFILE_PHOTOS = 'https://www.googleapis.com/auth/classroom.profile.photos'
+
+      # Manage your Google Classroom class rosters
+      AUTH_CLASSROOM_ROSTERS = 'https://www.googleapis.com/auth/classroom.rosters'
+
+      # View your Google Classroom class rosters
+      AUTH_CLASSROOM_ROSTERS_READONLY = 'https://www.googleapis.com/auth/classroom.rosters.readonly'
+    end
+  end
+end

data/generated/google/apis/classroom_v1/classes.rb

@@ -0,0 +1,512 @@
+# Copyright 2015 Google Inc.
+#
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+#      http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+
+require 'date'
+require 'google/apis/core/base_service'
+require 'google/apis/core/json_representation'
+require 'google/apis/core/hashable'
+require 'google/apis/errors'
+
+module Google
+  module Apis
+    module ClassroomV1
+      
+      # A Course in Classroom.
+      class Course
+        include Google::Apis::Core::Hashable
+      
+        # Identifier for this course assigned by Classroom. When creating a course, you
+        # may optionally set this identifier to an alias string in the request to create
+        # a corresponding alias. The `id` is still assigned by Classroom and cannot be
+        # updated after the course is created. Specifying this field in a course update
+        # mask will result in an error.
+        # Corresponds to the JSON property `id`
+        # @return [String]
+        attr_accessor :id
+      
+        # Name of the course. For example, "10th Grade Biology". The name is required.
+        # It must be between 1 and 750 characters and a valid UTF-8 string.
+        # Corresponds to the JSON property `name`
+        # @return [String]
+        attr_accessor :name
+      
+        # Section of the course. For example, "Period 2". If set, this field must be a
+        # valid UTF-8 string and no longer than 2800 characters.
+        # Corresponds to the JSON property `section`
+        # @return [String]
+        attr_accessor :section
+      
+        # Optional heading for the description. For example, "Welcome to 10th Grade
+        # Biology." If set, this field must be a valid UTF-8 string and no longer than
+        # 3600 characters.
+        # Corresponds to the JSON property `descriptionHeading`
+        # @return [String]
+        attr_accessor :description_heading
+      
+        # Optional description. For example, "We'll be learning about the structure of
+        # living creatures from a combination of textbooks, guest lectures, and lab work.
+        # Expect to be excited!" If set, this field must be a valid UTF-8 string and no
+        # longer than 30,000 characters.
+        # Corresponds to the JSON property `description`
+        # @return [String]
+        attr_accessor :description
+      
+        # Optional room location. For example, "301". If set, this field must be a valid
+        # UTF-8 string and no longer than 650 characters.
+        # Corresponds to the JSON property `room`
+        # @return [String]
+        attr_accessor :room
+      
+        # The identifier of the owner of a course. When specified as a parameter of a
+        # create course request, this field is required. The identifier can be one of
+        # the following: * the numeric identifier for the user * the email address of
+        # the user * the string literal `"me"`, indicating the requesting user This must
+        # be set in a create request. Specifying this field in a course update mask will
+        # result in an `INVALID_ARGUMENT` error.
+        # Corresponds to the JSON property `ownerId`
+        # @return [String]
+        attr_accessor :owner_id
+      
+        # Creation time of the course. Specifying this field in a course update mask
+        # will result in an error. Read-only.
+        # Corresponds to the JSON property `creationTime`
+        # @return [String]
+        attr_accessor :creation_time
+      
+        # Time of the most recent update to this course. Specifying this field in a
+        # course update mask will result in an error. Read-only.
+        # Corresponds to the JSON property `updateTime`
+        # @return [String]
+        attr_accessor :update_time
+      
+        # Enrollment code to use when joining this course. Specifying this field in a
+        # course update mask will result in an error. Read-only.
+        # Corresponds to the JSON property `enrollmentCode`
+        # @return [String]
+        attr_accessor :enrollment_code
+      
+        # State of the course. If unspecified, the default state is `PROVISIONED`.
+        # Corresponds to the JSON property `courseState`
+        # @return [String]
+        attr_accessor :course_state
+      
+        # Absolute link to this course in the Classroom web UI. Read-only.
+        # Corresponds to the JSON property `alternateLink`
+        # @return [String]
+        attr_accessor :alternate_link
+      
+        def initialize(**args)
+           update!(**args)
+        end
+      
+        # Update properties of this object
+        def update!(**args)
+          @id = args[:id] unless args[:id].nil?
+          @name = args[:name] unless args[:name].nil?
+          @section = args[:section] unless args[:section].nil?
+          @description_heading = args[:description_heading] unless args[:description_heading].nil?
+          @description = args[:description] unless args[:description].nil?
+          @room = args[:room] unless args[:room].nil?
+          @owner_id = args[:owner_id] unless args[:owner_id].nil?
+          @creation_time = args[:creation_time] unless args[:creation_time].nil?
+          @update_time = args[:update_time] unless args[:update_time].nil?
+          @enrollment_code = args[:enrollment_code] unless args[:enrollment_code].nil?
+          @course_state = args[:course_state] unless args[:course_state].nil?
+          @alternate_link = args[:alternate_link] unless args[:alternate_link].nil?
+        end
+      end
+      
+      # A generic empty message that you can re-use to avoid defining duplicated empty
+      # messages in your APIs. A typical example is to use it as the request or the
+      # response type of an API method. For instance: service Foo ` rpc Bar(google.
+      # protobuf.Empty) returns (google.protobuf.Empty); ` The JSON representation for
+      # `Empty` is empty JSON object ````.
+      class Empty
+        include Google::Apis::Core::Hashable
+      
+        def initialize(**args)
+           update!(**args)
+        end
+      
+        # Update properties of this object
+        def update!(**args)
+        end
+      end
+      
+      # Response when listing courses.
+      class ListCoursesResponse
+        include Google::Apis::Core::Hashable
+      
+        # Courses that match the list request.
+        # Corresponds to the JSON property `courses`
+        # @return [Array<Google::Apis::ClassroomV1::Course>]
+        attr_accessor :courses
+      
+        # Token identifying the next page of results to return. If empty, no further
+        # results are available.
+        # Corresponds to the JSON property `nextPageToken`
+        # @return [String]
+        attr_accessor :next_page_token
+      
+        def initialize(**args)
+           update!(**args)
+        end
+      
+        # Update properties of this object
+        def update!(**args)
+          @courses = args[:courses] unless args[:courses].nil?
+          @next_page_token = args[:next_page_token] unless args[:next_page_token].nil?
+        end
+      end
+      
+      # Alternative identifier for a course. An alias uniquely identifies a course. It
+      # must be unique within one of the following scopes: * domain: A domain-scoped
+      # alias is visible to all users within the alias creator's domain and can be
+      # created only by a domain admin. A domain-scoped alias is often used when a
+      # course has an identifier external to Classroom. * project: A project-scoped
+      # alias is visible to any request from an application using the Developer
+      # Console project ID that created the alias and can be created by any project. A
+      # project-scoped alias is often used when an application has alternative
+      # identifiers. A random value can also be used to avoid duplicate courses in the
+      # event of transmission failures, as retrying a request will return `
+      # ALREADY_EXISTS` if a previous one has succeeded.
+      class CourseAlias
+        include Google::Apis::Core::Hashable
+      
+        # Alias string. The format of the string indicates the desired alias scoping. * `
+        # d:` indicates a domain-scoped alias. Example: `d:math_101` * `p:` indicates a
+        # project-scoped alias. Example: `p:abc123` This field has a maximum length of
+        # 256 characters.
+        # Corresponds to the JSON property `alias`
+        # @return [String]
+        attr_accessor :alias
+      
+        def initialize(**args)
+           update!(**args)
+        end
+      
+        # Update properties of this object
+        def update!(**args)
+          @alias = args[:alias] unless args[:alias].nil?
+        end
+      end
+      
+      # Response when listing course aliases.
+      class ListCourseAliasesResponse
+        include Google::Apis::Core::Hashable
+      
+        # The course aliases.
+        # Corresponds to the JSON property `aliases`
+        # @return [Array<Google::Apis::ClassroomV1::CourseAlias>]
+        attr_accessor :aliases
+      
+        # Token identifying the next page of results to return. If empty, no further
+        # results are available.
+        # Corresponds to the JSON property `nextPageToken`
+        # @return [String]
+        attr_accessor :next_page_token
+      
+        def initialize(**args)
+           update!(**args)
+        end
+      
+        # Update properties of this object
+        def update!(**args)
+          @aliases = args[:aliases] unless args[:aliases].nil?
+          @next_page_token = args[:next_page_token] unless args[:next_page_token].nil?
+        end
+      end
+      
+      # An invitation to join a course.
+      class Invitation
+        include Google::Apis::Core::Hashable
+      
+        # Identifier assigned by Classroom. Read-only.
+        # Corresponds to the JSON property `id`
+        # @return [String]
+        attr_accessor :id
+      
+        # Identifier of the invited user. When specified as a parameter of a request,
+        # this identifier can be set to one of the following: * the numeric identifier
+        # for the user * the email address of the user * the string literal `"me"`,
+        # indicating the requesting user
+        # Corresponds to the JSON property `userId`
+        # @return [String]
+        attr_accessor :user_id
+      
+        # Identifier of the course to invite the user to.
+        # Corresponds to the JSON property `courseId`
+        # @return [String]
+        attr_accessor :course_id
+      
+        # Role to invite the user to have. Must not be `COURSE_ROLE_UNSPECIFIED`.
+        # Corresponds to the JSON property `role`
+        # @return [String]
+        attr_accessor :role
+      
+        def initialize(**args)
+           update!(**args)
+        end
+      
+        # Update properties of this object
+        def update!(**args)
+          @id = args[:id] unless args[:id].nil?
+          @user_id = args[:user_id] unless args[:user_id].nil?
+          @course_id = args[:course_id] unless args[:course_id].nil?
+          @role = args[:role] unless args[:role].nil?
+        end
+      end
+      
+      # Response when listing invitations.
+      class ListInvitationsResponse
+        include Google::Apis::Core::Hashable
+      
+        # Invitations that match the list request.
+        # Corresponds to the JSON property `invitations`
+        # @return [Array<Google::Apis::ClassroomV1::Invitation>]
+        attr_accessor :invitations
+      
+        # Token identifying the next page of results to return. If empty, no further
+        # results are available.
+        # Corresponds to the JSON property `nextPageToken`
+        # @return [String]
+        attr_accessor :next_page_token
+      
+        def initialize(**args)
+           update!(**args)
+        end
+      
+        # Update properties of this object
+        def update!(**args)
+          @invitations = args[:invitations] unless args[:invitations].nil?
+          @next_page_token = args[:next_page_token] unless args[:next_page_token].nil?
+        end
+      end
+      
+      # Global information for a user.
+      class UserProfile
+        include Google::Apis::Core::Hashable
+      
+        # Identifier of the user. Read-only.
+        # Corresponds to the JSON property `id`
+        # @return [String]
+        attr_accessor :id
+      
+        # Details of the user's name.
+        # Corresponds to the JSON property `name`
+        # @return [Google::Apis::ClassroomV1::Name]
+        attr_accessor :name
+      
+        # Email address of the user. Read-only.
+        # Corresponds to the JSON property `emailAddress`
+        # @return [String]
+        attr_accessor :email_address
+      
+        # URL of user's profile photo. Read-only.
+        # Corresponds to the JSON property `photoUrl`
+        # @return [String]
+        attr_accessor :photo_url
+      
+        # Global permissions of the user. Read-only.
+        # Corresponds to the JSON property `permissions`
+        # @return [Array<Google::Apis::ClassroomV1::GlobalPermission>]
+        attr_accessor :permissions
+      
+        def initialize(**args)
+           update!(**args)
+        end
+      
+        # Update properties of this object
+        def update!(**args)
+          @id = args[:id] unless args[:id].nil?
+          @name = args[:name] unless args[:name].nil?
+          @email_address = args[:email_address] unless args[:email_address].nil?
+          @photo_url = args[:photo_url] unless args[:photo_url].nil?
+          @permissions = args[:permissions] unless args[:permissions].nil?
+        end
+      end
+      
+      # Details of the user's name.
+      class Name
+        include Google::Apis::Core::Hashable
+      
+        # The user's first name. Read-only.
+        # Corresponds to the JSON property `givenName`
+        # @return [String]
+        attr_accessor :given_name
+      
+        # The user's last name. Read-only.
+        # Corresponds to the JSON property `familyName`
+        # @return [String]
+        attr_accessor :family_name
+      
+        # The user's full name formed by concatenating the first and last name values.
+        # Read-only.
+        # Corresponds to the JSON property `fullName`
+        # @return [String]
+        attr_accessor :full_name
+      
+        def initialize(**args)
+           update!(**args)
+        end
+      
+        # Update properties of this object
+        def update!(**args)
+          @given_name = args[:given_name] unless args[:given_name].nil?
+          @family_name = args[:family_name] unless args[:family_name].nil?
+          @full_name = args[:full_name] unless args[:full_name].nil?
+        end
+      end
+      
+      # Global user permission description.
+      class GlobalPermission
+        include Google::Apis::Core::Hashable
+      
+        # Permission value.
+        # Corresponds to the JSON property `permission`
+        # @return [String]
+        attr_accessor :permission
+      
+        def initialize(**args)
+           update!(**args)
+        end
+      
+        # Update properties of this object
+        def update!(**args)
+          @permission = args[:permission] unless args[:permission].nil?
+        end
+      end
+      
+      # Teacher of a course.
+      class Teacher
+        include Google::Apis::Core::Hashable
+      
+        # Identifier of the course. Read-only.
+        # Corresponds to the JSON property `courseId`
+        # @return [String]
+        attr_accessor :course_id
+      
+        # Identifier of the user. When specified as a parameter of a request, this
+        # identifier can be one of the following: * the numeric identifier for the user *
+        # the email address of the user * the string literal `"me"`, indicating the
+        # requesting user
+        # Corresponds to the JSON property `userId`
+        # @return [String]
+        attr_accessor :user_id
+      
+        # Global information for a user.
+        # Corresponds to the JSON property `profile`
+        # @return [Google::Apis::ClassroomV1::UserProfile]
+        attr_accessor :profile
+      
+        def initialize(**args)
+           update!(**args)
+        end
+      
+        # Update properties of this object
+        def update!(**args)
+          @course_id = args[:course_id] unless args[:course_id].nil?
+          @user_id = args[:user_id] unless args[:user_id].nil?
+          @profile = args[:profile] unless args[:profile].nil?
+        end
+      end
+      
+      # Response when listing teachers.
+      class ListTeachersResponse
+        include Google::Apis::Core::Hashable
+      
+        # Teachers who match the list request.
+        # Corresponds to the JSON property `teachers`
+        # @return [Array<Google::Apis::ClassroomV1::Teacher>]
+        attr_accessor :teachers
+      
+        # Token identifying the next page of results to return. If empty, no further
+        # results are available.
+        # Corresponds to the JSON property `nextPageToken`
+        # @return [String]
+        attr_accessor :next_page_token
+      
+        def initialize(**args)
+           update!(**args)
+        end
+      
+        # Update properties of this object
+        def update!(**args)
+          @teachers = args[:teachers] unless args[:teachers].nil?
+          @next_page_token = args[:next_page_token] unless args[:next_page_token].nil?
+        end
+      end
+      
+      # Student in a course.
+      class Student
+        include Google::Apis::Core::Hashable
+      
+        # Identifier of the course. Read-only.
+        # Corresponds to the JSON property `courseId`
+        # @return [String]
+        attr_accessor :course_id
+      
+        # Identifier of the user. When specified as a parameter of a request, this
+        # identifier can be one of the following: * the numeric identifier for the user *
+        # the email address of the user * the string literal `"me"`, indicating the
+        # requesting user
+        # Corresponds to the JSON property `userId`
+        # @return [String]
+        attr_accessor :user_id
+      
+        # Global information for a user.
+        # Corresponds to the JSON property `profile`
+        # @return [Google::Apis::ClassroomV1::UserProfile]
+        attr_accessor :profile
+      
+        def initialize(**args)
+           update!(**args)
+        end
+      
+        # Update properties of this object
+        def update!(**args)
+          @course_id = args[:course_id] unless args[:course_id].nil?
+          @user_id = args[:user_id] unless args[:user_id].nil?
+          @profile = args[:profile] unless args[:profile].nil?
+        end
+      end
+      
+      # Response when listing students.
+      class ListStudentsResponse
+        include Google::Apis::Core::Hashable
+      
+        # Students who match the list request.
+        # Corresponds to the JSON property `students`
+        # @return [Array<Google::Apis::ClassroomV1::Student>]
+        attr_accessor :students
+      
+        # Token identifying the next page of results to return. If empty, no further
+        # results are available.
+        # Corresponds to the JSON property `nextPageToken`
+        # @return [String]
+        attr_accessor :next_page_token
+      
+        def initialize(**args)
+           update!(**args)
+        end
+      
+        # Update properties of this object
+        def update!(**args)
+          @students = args[:students] unless args[:students].nil?
+          @next_page_token = args[:next_page_token] unless args[:next_page_token].nil?
+        end
+      end
+    end
+  end
+end