From 66e530cacc16c1874ddaba21b324b144b77e0072 Mon Sep 17 00:00:00 2001 From: Google APIs Date: Sat, 9 May 2020 00:38:07 +0000 Subject: [PATCH] Autogenerated update (2020-05-09) Update: - bigquery_v2 - bigqueryconnection_v1beta1 - books_v1 - cloudfunctions_v1 - monitoring_v3 - servicedirectory_v1beta1 - servicemanagement_v1 --- generated/google/apis/bigquery_v2.rb | 2 +- generated/google/apis/bigquery_v2/classes.rb | 566 ++++++++++++ .../apis/bigquery_v2/representations.rb | 147 +++ generated/google/apis/bigquery_v2/service.rb | 120 +++ .../google/apis/bigqueryconnection_v1beta1.rb | 2 +- .../bigqueryconnection_v1beta1/classes.rb | 36 +- generated/google/apis/books_v1.rb | 6 +- generated/google/apis/books_v1/classes.rb | 724 +++++++++------ .../google/apis/books_v1/representations.rb | 215 +++-- generated/google/apis/books_v1/service.rb | 840 ++++++++---------- generated/google/apis/cloudfunctions_v1.rb | 2 +- .../google/apis/cloudfunctions_v1/classes.rb | 36 +- .../google/apis/cloudfunctions_v1/service.rb | 3 + generated/google/apis/monitoring_v3.rb | 2 +- .../google/apis/monitoring_v3/classes.rb | 12 +- .../google/apis/servicedirectory_v1beta1.rb | 2 +- .../apis/servicedirectory_v1beta1/classes.rb | 36 +- generated/google/apis/servicemanagement_v1.rb | 2 +- .../apis/servicemanagement_v1/classes.rb | 87 +- .../apis/servicemanagement_v1/service.rb | 8 +- 20 files changed, 1907 insertions(+), 941 deletions(-) diff --git a/generated/google/apis/bigquery_v2.rb b/generated/google/apis/bigquery_v2.rb index eb5c57f4f..98786bb06 100644 --- a/generated/google/apis/bigquery_v2.rb +++ b/generated/google/apis/bigquery_v2.rb @@ -25,7 +25,7 @@ module Google # @see https://cloud.google.com/bigquery/ module BigqueryV2 VERSION = 'V2' - REVISION = '20200415' + REVISION = '20200429' # View and manage your data in Google BigQuery AUTH_BIGQUERY = 'https://www.googleapis.com/auth/bigquery' diff --git a/generated/google/apis/bigquery_v2/classes.rb b/generated/google/apis/bigquery_v2/classes.rb index b0f8c2643..9e0b2dec6 100644 --- a/generated/google/apis/bigquery_v2/classes.rb +++ b/generated/google/apis/bigquery_v2/classes.rb @@ -312,6 +312,122 @@ module Google end end + # Specifies the audit configuration for a service. + # The configuration determines which permission types are logged, and what + # identities, if any, are exempted from logging. + # An AuditConfig must have one or more AuditLogConfigs. + # If there are AuditConfigs for both `allServices` and a specific service, + # the union of the two AuditConfigs is used for that service: the log_types + # specified in each AuditConfig are enabled, and the exempted_members in each + # AuditLogConfig are exempted. + # Example Policy with multiple AuditConfigs: + # ` + # "audit_configs": [ + # ` + # "service": "allServices" + # "audit_log_configs": [ + # ` + # "log_type": "DATA_READ", + # "exempted_members": [ + # "user:jose@example.com" + # ] + # `, + # ` + # "log_type": "DATA_WRITE", + # `, + # ` + # "log_type": "ADMIN_READ", + # ` + # ] + # `, + # ` + # "service": "sampleservice.googleapis.com" + # "audit_log_configs": [ + # ` + # "log_type": "DATA_READ", + # `, + # ` + # "log_type": "DATA_WRITE", + # "exempted_members": [ + # "user:aliya@example.com" + # ] + # ` + # ] + # ` + # ] + # ` + # For sampleservice, this policy enables DATA_READ, DATA_WRITE and ADMIN_READ + # logging. It also exempts jose@example.com from DATA_READ logging, and + # aliya@example.com from DATA_WRITE logging. + class AuditConfig + include Google::Apis::Core::Hashable + + # The configuration for logging of each type of permission. + # Corresponds to the JSON property `auditLogConfigs` + # @return [Array] + attr_accessor :audit_log_configs + + # Specifies a service that will be enabled for audit logging. + # For example, `storage.googleapis.com`, `cloudsql.googleapis.com`. + # `allServices` is a special value that covers all services. + # Corresponds to the JSON property `service` + # @return [String] + attr_accessor :service + + def initialize(**args) + update!(**args) + end + + # Update properties of this object + def update!(**args) + @audit_log_configs = args[:audit_log_configs] if args.key?(:audit_log_configs) + @service = args[:service] if args.key?(:service) + end + end + + # Provides the configuration for logging a type of permissions. + # Example: + # ` + # "audit_log_configs": [ + # ` + # "log_type": "DATA_READ", + # "exempted_members": [ + # "user:jose@example.com" + # ] + # `, + # ` + # "log_type": "DATA_WRITE", + # ` + # ] + # ` + # This enables 'DATA_READ' and 'DATA_WRITE' logging, while exempting + # jose@example.com from DATA_READ logging. + class AuditLogConfig + include Google::Apis::Core::Hashable + + # Specifies the identities that do not cause logging for this type of + # permission. + # Follows the same format of Binding.members. + # Corresponds to the JSON property `exemptedMembers` + # @return [Array] + attr_accessor :exempted_members + + # The log type that this config enables. + # Corresponds to the JSON property `logType` + # @return [String] + attr_accessor :log_type + + def initialize(**args) + update!(**args) + end + + # Update properties of this object + def update!(**args) + @exempted_members = args[:exempted_members] if args.key?(:exempted_members) + @log_type = args[:log_type] if args.key?(:log_type) + end + end + # class BigQueryModelTraining include Google::Apis::Core::Hashable @@ -624,6 +740,89 @@ module Google end end + # Associates `members` with a `role`. + class Binding + include Google::Apis::Core::Hashable + + # Represents a textual expression in the Common Expression Language (CEL) + # syntax. CEL is a C-like expression language. The syntax and semantics of CEL + # are documented at https://github.com/google/cel-spec. + # Example (Comparison): + # title: "Summary size limit" + # description: "Determines if a summary is less than 100 chars" + # expression: "document.summary.size() < 100" + # Example (Equality): + # title: "Requestor is owner" + # description: "Determines if requestor is the document owner" + # expression: "document.owner == request.auth.claims.email" + # Example (Logic): + # title: "Public documents" + # description: "Determine whether the document should be publicly visible" + # expression: "document.type != 'private' && document.type != 'internal'" + # Example (Data Manipulation): + # title: "Notification string" + # description: "Create a notification string with a timestamp." + # expression: "'New message received at ' + string(document.create_time)" + # The exact variables and functions that may be referenced within an expression + # are determined by the service that evaluates it. See the service + # documentation for additional information. + # Corresponds to the JSON property `condition` + # @return [Google::Apis::BigqueryV2::Expr] + attr_accessor :condition + + # Specifies the identities requesting access for a Cloud Platform resource. + # `members` can have the following values: + # * `allUsers`: A special identifier that represents anyone who is + # on the internet; with or without a Google account. + # * `allAuthenticatedUsers`: A special identifier that represents anyone + # who is authenticated with a Google account or a service account. + # * `user:`emailid``: An email address that represents a specific Google + # account. For example, `alice@example.com` . + # * `serviceAccount:`emailid``: An email address that represents a service + # account. For example, `my-other-app@appspot.gserviceaccount.com`. + # * `group:`emailid``: An email address that represents a Google group. + # For example, `admins@example.com`. + # * `deleted:user:`emailid`?uid=`uniqueid``: An email address (plus unique + # identifier) representing a user that has been recently deleted. For + # example, `alice@example.com?uid=123456789012345678901`. If the user is + # recovered, this value reverts to `user:`emailid`` and the recovered user + # retains the role in the binding. + # * `deleted:serviceAccount:`emailid`?uid=`uniqueid``: An email address (plus + # unique identifier) representing a service account that has been recently + # deleted. For example, + # `my-other-app@appspot.gserviceaccount.com?uid=123456789012345678901`. + # If the service account is undeleted, this value reverts to + # `serviceAccount:`emailid`` and the undeleted service account retains the + # role in the binding. + # * `deleted:group:`emailid`?uid=`uniqueid``: An email address (plus unique + # identifier) representing a Google group that has been recently + # deleted. For example, `admins@example.com?uid=123456789012345678901`. If + # the group is recovered, this value reverts to `group:`emailid`` and the + # recovered group retains the role in the binding. + # * `domain:`domain``: The G Suite domain (primary) that represents all the + # users of that domain. For example, `google.com` or `example.com`. + # Corresponds to the JSON property `members` + # @return [Array] + attr_accessor :members + + # Role that is assigned to `members`. + # For example, `roles/viewer`, `roles/editor`, or `roles/owner`. + # 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) + @condition = args[:condition] if args.key?(:condition) + @members = args[:members] if args.key?(:members) + @role = args[:role] if args.key?(:role) + end + end + # class BqmlIterationResult include Google::Apis::Core::Hashable @@ -1832,6 +2031,69 @@ module Google end end + # Represents a textual expression in the Common Expression Language (CEL) + # syntax. CEL is a C-like expression language. The syntax and semantics of CEL + # are documented at https://github.com/google/cel-spec. + # Example (Comparison): + # title: "Summary size limit" + # description: "Determines if a summary is less than 100 chars" + # expression: "document.summary.size() < 100" + # Example (Equality): + # title: "Requestor is owner" + # description: "Determines if requestor is the document owner" + # expression: "document.owner == request.auth.claims.email" + # Example (Logic): + # title: "Public documents" + # description: "Determine whether the document should be publicly visible" + # expression: "document.type != 'private' && document.type != 'internal'" + # Example (Data Manipulation): + # title: "Notification string" + # description: "Create a notification string with a timestamp." + # expression: "'New message received at ' + string(document.create_time)" + # The exact variables and functions that may be referenced within an expression + # are determined by the service that evaluates it. See the service + # documentation for additional information. + class Expr + include Google::Apis::Core::Hashable + + # Optional. Description of the expression. This is a longer text which + # describes the expression, e.g. when hovered over it in a UI. + # Corresponds to the JSON property `description` + # @return [String] + attr_accessor :description + + # Textual representation of an expression in Common Expression Language + # syntax. + # Corresponds to the JSON property `expression` + # @return [String] + attr_accessor :expression + + # Optional. String indicating the location of the expression for error + # reporting, e.g. a file name and a position in the file. + # Corresponds to the JSON property `location` + # @return [String] + attr_accessor :location + + # Optional. Title for the expression, i.e. a short string describing + # its purpose. This can be used e.g. in UIs which allow to enter the + # expression. + # Corresponds to the JSON property `title` + # @return [String] + attr_accessor :title + + def initialize(**args) + update!(**args) + end + + # Update properties of this object + def update!(**args) + @description = args[:description] if args.key?(:description) + @expression = args[:expression] if args.key?(:expression) + @location = args[:location] if args.key?(:location) + @title = args[:title] if args.key?(:title) + end + end + # class ExternalDataConfiguration include Google::Apis::Core::Hashable @@ -1973,6 +2235,52 @@ module Google end end + # Request message for `GetIamPolicy` method. + class GetIamPolicyRequest + include Google::Apis::Core::Hashable + + # Encapsulates settings provided to GetIamPolicy. + # Corresponds to the JSON property `options` + # @return [Google::Apis::BigqueryV2::GetPolicyOptions] + attr_accessor :options + + def initialize(**args) + update!(**args) + end + + # Update properties of this object + def update!(**args) + @options = args[:options] if args.key?(:options) + end + end + + # Encapsulates settings provided to GetIamPolicy. + class GetPolicyOptions + include Google::Apis::Core::Hashable + + # Optional. The policy format version to be returned. + # Valid values are 0, 1, and 3. Requests specifying an invalid value will be + # rejected. + # Requests for policies with any conditional bindings must specify version 3. + # Policies without any conditional bindings may specify any valid value or + # leave the field unset. + # To learn which resources support conditions in their IAM policies, see the + # [IAM + # documentation](https://cloud.google.com/iam/help/conditions/resource-policies). + # Corresponds to the JSON property `requestedPolicyVersion` + # @return [Fixnum] + attr_accessor :requested_policy_version + + def initialize(**args) + update!(**args) + end + + # Update properties of this object + def update!(**args) + @requested_policy_version = args[:requested_policy_version] if args.key?(:requested_policy_version) + end + end + # class GetQueryResultsResponse include Google::Apis::Core::Hashable @@ -3980,6 +4288,134 @@ module Google end end + # An Identity and Access Management (IAM) policy, which specifies access + # controls for Google Cloud resources. + # A `Policy` is a collection of `bindings`. A `binding` binds one or more + # `members` to a single `role`. Members can be user accounts, service accounts, + # Google groups, and domains (such as G Suite). A `role` is a named list of + # permissions; each `role` can be an IAM predefined role or a user-created + # custom role. + # For some types of Google Cloud resources, a `binding` can also specify a + # `condition`, which is a logical expression that allows access to a resource + # only if the expression evaluates to `true`. A condition can add constraints + # based on attributes of the request, the resource, or both. To learn which + # resources support conditions in their IAM policies, see the + # [IAM documentation](https://cloud.google.com/iam/help/conditions/resource- + # policies). + # **JSON example:** + # ` + # "bindings": [ + # ` + # "role": "roles/resourcemanager.organizationAdmin", + # "members": [ + # "user:mike@example.com", + # "group:admins@example.com", + # "domain:google.com", + # "serviceAccount:my-project-id@appspot.gserviceaccount.com" + # ] + # `, + # ` + # "role": "roles/resourcemanager.organizationViewer", + # "members": [ + # "user:eve@example.com" + # ], + # "condition": ` + # "title": "expirable access", + # "description": "Does not grant access after Sep 2020", + # "expression": "request.time < timestamp('2020-10-01T00:00:00.000Z') + # ", + # ` + # ` + # ], + # "etag": "BwWWja0YfJA=", + # "version": 3 + # ` + # **YAML example:** + # bindings: + # - members: + # - user:mike@example.com + # - group:admins@example.com + # - domain:google.com + # - serviceAccount:my-project-id@appspot.gserviceaccount.com + # role: roles/resourcemanager.organizationAdmin + # - members: + # - user:eve@example.com + # role: roles/resourcemanager.organizationViewer + # condition: + # title: expirable access + # description: Does not grant access after Sep 2020 + # expression: request.time < timestamp('2020-10-01T00:00:00.000Z') + # - etag: BwWWja0YfJA= + # - version: 3 + # For a description of IAM and its features, see the + # [IAM documentation](https://cloud.google.com/iam/docs/). + class Policy + include Google::Apis::Core::Hashable + + # Specifies cloud audit logging configuration for this policy. + # Corresponds to the JSON property `auditConfigs` + # @return [Array] + attr_accessor :audit_configs + + # Associates a list of `members` to a `role`. Optionally, may specify a + # `condition` that determines how and when the `bindings` are applied. Each + # of the `bindings` must contain at least one member. + # Corresponds to the JSON property `bindings` + # @return [Array] + attr_accessor :bindings + + # `etag` is used for optimistic concurrency control as a way to help + # prevent simultaneous updates of a policy from overwriting each other. + # It is strongly suggested that systems make use of the `etag` in the + # read-modify-write cycle to perform policy updates in order to avoid race + # conditions: An `etag` is returned in the response to `getIamPolicy`, and + # systems are expected to put that etag in the request to `setIamPolicy` to + # ensure that their change will be applied to the same version of the policy. + # **Important:** If you use IAM Conditions, you must include the `etag` field + # whenever you call `setIamPolicy`. If you omit this field, then IAM allows + # you to overwrite a version `3` policy with a version `1` policy, and all of + # the conditions in the version `3` policy are lost. + # Corresponds to the JSON property `etag` + # NOTE: Values are automatically base64 encoded/decoded in the client library. + # @return [String] + attr_accessor :etag + + # Specifies the format of the policy. + # Valid values are `0`, `1`, and `3`. Requests that specify an invalid value + # are rejected. + # Any operation that affects conditional role bindings must specify version + # `3`. This requirement applies to the following operations: + # * Getting a policy that includes a conditional role binding + # * Adding a conditional role binding to a policy + # * Changing a conditional role binding in a policy + # * Removing any role binding, with or without a condition, from a policy + # that includes conditions + # **Important:** If you use IAM Conditions, you must include the `etag` field + # whenever you call `setIamPolicy`. If you omit this field, then IAM allows + # you to overwrite a version `3` policy with a version `1` policy, and all of + # the conditions in the version `3` policy are lost. + # If a policy does not include any conditions, operations on that policy may + # specify any valid version or leave the field unset. + # To learn which resources support conditions in their IAM policies, see the + # [IAM documentation](https://cloud.google.com/iam/help/conditions/resource- + # policies). + # Corresponds to the JSON property `version` + # @return [Fixnum] + attr_accessor :version + + def initialize(**args) + update!(**args) + end + + # Update properties of this object + def update!(**args) + @audit_configs = args[:audit_configs] if args.key?(:audit_configs) + @bindings = args[:bindings] if args.key?(:bindings) + @etag = args[:etag] if args.key?(:etag) + @version = args[:version] if args.key?(:version) + end + end + # class ProjectList include Google::Apis::Core::Hashable @@ -4914,6 +5350,94 @@ module Google end end + # Request message for `SetIamPolicy` method. + class SetIamPolicyRequest + include Google::Apis::Core::Hashable + + # An Identity and Access Management (IAM) policy, which specifies access + # controls for Google Cloud resources. + # A `Policy` is a collection of `bindings`. A `binding` binds one or more + # `members` to a single `role`. Members can be user accounts, service accounts, + # Google groups, and domains (such as G Suite). A `role` is a named list of + # permissions; each `role` can be an IAM predefined role or a user-created + # custom role. + # For some types of Google Cloud resources, a `binding` can also specify a + # `condition`, which is a logical expression that allows access to a resource + # only if the expression evaluates to `true`. A condition can add constraints + # based on attributes of the request, the resource, or both. To learn which + # resources support conditions in their IAM policies, see the + # [IAM documentation](https://cloud.google.com/iam/help/conditions/resource- + # policies). + # **JSON example:** + # ` + # "bindings": [ + # ` + # "role": "roles/resourcemanager.organizationAdmin", + # "members": [ + # "user:mike@example.com", + # "group:admins@example.com", + # "domain:google.com", + # "serviceAccount:my-project-id@appspot.gserviceaccount.com" + # ] + # `, + # ` + # "role": "roles/resourcemanager.organizationViewer", + # "members": [ + # "user:eve@example.com" + # ], + # "condition": ` + # "title": "expirable access", + # "description": "Does not grant access after Sep 2020", + # "expression": "request.time < timestamp('2020-10-01T00:00:00.000Z') + # ", + # ` + # ` + # ], + # "etag": "BwWWja0YfJA=", + # "version": 3 + # ` + # **YAML example:** + # bindings: + # - members: + # - user:mike@example.com + # - group:admins@example.com + # - domain:google.com + # - serviceAccount:my-project-id@appspot.gserviceaccount.com + # role: roles/resourcemanager.organizationAdmin + # - members: + # - user:eve@example.com + # role: roles/resourcemanager.organizationViewer + # condition: + # title: expirable access + # description: Does not grant access after Sep 2020 + # expression: request.time < timestamp('2020-10-01T00:00:00.000Z') + # - etag: BwWWja0YfJA= + # - version: 3 + # For a description of IAM and its features, see the + # [IAM documentation](https://cloud.google.com/iam/docs/). + # Corresponds to the JSON property `policy` + # @return [Google::Apis::BigqueryV2::Policy] + attr_accessor :policy + + # OPTIONAL: A FieldMask specifying which fields of the policy to modify. Only + # the fields in the mask will be modified. If no mask is provided, the + # following default mask is used: + # `paths: "bindings, etag"` + # Corresponds to the JSON property `updateMask` + # @return [String] + attr_accessor :update_mask + + def initialize(**args) + update!(**args) + end + + # Update properties of this object + def update!(**args) + @policy = args[:policy] if args.key?(:policy) + @update_mask = args[:update_mask] if args.key?(:update_mask) + end + end + # The type of a variable, e.g., a function argument. # Examples: # INT64: `type_kind="INT64"` @@ -5785,6 +6309,48 @@ module Google end end + # Request message for `TestIamPermissions` method. + class TestIamPermissionsRequest + include Google::Apis::Core::Hashable + + # The set of permissions to check for the `resource`. Permissions with + # wildcards (such as '*' or 'storage.*') are not allowed. For more + # information see + # [IAM Overview](https://cloud.google.com/iam/docs/overview#permissions). + # Corresponds to the JSON property `permissions` + # @return [Array] + attr_accessor :permissions + + def initialize(**args) + update!(**args) + end + + # Update properties of this object + def update!(**args) + @permissions = args[:permissions] if args.key?(:permissions) + end + end + + # Response message for `TestIamPermissions` method. + class TestIamPermissionsResponse + include Google::Apis::Core::Hashable + + # A subset of `TestPermissionsRequest.permissions` that the caller is + # allowed. + # Corresponds to the JSON property `permissions` + # @return [Array] + attr_accessor :permissions + + def initialize(**args) + update!(**args) + end + + # Update properties of this object + def update!(**args) + @permissions = args[:permissions] if args.key?(:permissions) + end + end + # class TimePartitioning include Google::Apis::Core::Hashable diff --git a/generated/google/apis/bigquery_v2/representations.rb b/generated/google/apis/bigquery_v2/representations.rb index 30effed06..d3694809f 100644 --- a/generated/google/apis/bigquery_v2/representations.rb +++ b/generated/google/apis/bigquery_v2/representations.rb @@ -64,6 +64,18 @@ module Google include Google::Apis::Core::JsonObjectSupport end + class AuditConfig + class Representation < Google::Apis::Core::JsonRepresentation; end + + include Google::Apis::Core::JsonObjectSupport + end + + class AuditLogConfig + class Representation < Google::Apis::Core::JsonRepresentation; end + + include Google::Apis::Core::JsonObjectSupport + end + class BigQueryModelTraining class Representation < Google::Apis::Core::JsonRepresentation; end @@ -100,6 +112,12 @@ module Google include Google::Apis::Core::JsonObjectSupport end + class Binding + class Representation < Google::Apis::Core::JsonRepresentation; end + + include Google::Apis::Core::JsonObjectSupport + end + class BqmlIterationResult class Representation < Google::Apis::Core::JsonRepresentation; end @@ -250,6 +268,12 @@ module Google include Google::Apis::Core::JsonObjectSupport end + class Expr + class Representation < Google::Apis::Core::JsonRepresentation; end + + include Google::Apis::Core::JsonObjectSupport + end + class ExternalDataConfiguration class Representation < Google::Apis::Core::JsonRepresentation; end @@ -262,6 +286,18 @@ module Google include Google::Apis::Core::JsonObjectSupport end + class GetIamPolicyRequest + class Representation < Google::Apis::Core::JsonRepresentation; end + + include Google::Apis::Core::JsonObjectSupport + end + + class GetPolicyOptions + class Representation < Google::Apis::Core::JsonRepresentation; end + + include Google::Apis::Core::JsonObjectSupport + end + class GetQueryResultsResponse class Representation < Google::Apis::Core::JsonRepresentation; end @@ -448,6 +484,12 @@ module Google include Google::Apis::Core::JsonObjectSupport end + class Policy + class Representation < Google::Apis::Core::JsonRepresentation; end + + include Google::Apis::Core::JsonObjectSupport + end + class ProjectList class Representation < Google::Apis::Core::JsonRepresentation; end @@ -574,6 +616,12 @@ module Google include Google::Apis::Core::JsonObjectSupport end + class SetIamPolicyRequest + class Representation < Google::Apis::Core::JsonRepresentation; end + + include Google::Apis::Core::JsonObjectSupport + end + class StandardSqlDataType class Representation < Google::Apis::Core::JsonRepresentation; end @@ -694,6 +742,18 @@ module Google include Google::Apis::Core::JsonObjectSupport end + class TestIamPermissionsRequest + class Representation < Google::Apis::Core::JsonRepresentation; end + + include Google::Apis::Core::JsonObjectSupport + end + + class TestIamPermissionsResponse + class Representation < Google::Apis::Core::JsonRepresentation; end + + include Google::Apis::Core::JsonObjectSupport + end + class TimePartitioning class Representation < Google::Apis::Core::JsonRepresentation; end @@ -799,6 +859,23 @@ module Google end end + class AuditConfig + # @private + class Representation < Google::Apis::Core::JsonRepresentation + collection :audit_log_configs, as: 'auditLogConfigs', class: Google::Apis::BigqueryV2::AuditLogConfig, decorator: Google::Apis::BigqueryV2::AuditLogConfig::Representation + + property :service, as: 'service' + end + end + + class AuditLogConfig + # @private + class Representation < Google::Apis::Core::JsonRepresentation + collection :exempted_members, as: 'exemptedMembers' + property :log_type, as: 'logType' + end + end + class BigQueryModelTraining # @private class Representation < Google::Apis::Core::JsonRepresentation @@ -868,6 +945,16 @@ module Google end end + class Binding + # @private + class Representation < Google::Apis::Core::JsonRepresentation + property :condition, as: 'condition', class: Google::Apis::BigqueryV2::Expr, decorator: Google::Apis::BigqueryV2::Expr::Representation + + collection :members, as: 'members' + property :role, as: 'role' + end + end + class BqmlIterationResult # @private class Representation < Google::Apis::Core::JsonRepresentation @@ -1163,6 +1250,16 @@ module Google end end + class Expr + # @private + class Representation < Google::Apis::Core::JsonRepresentation + property :description, as: 'description' + property :expression, as: 'expression' + property :location, as: 'location' + property :title, as: 'title' + end + end + class ExternalDataConfiguration # @private class Representation < Google::Apis::Core::JsonRepresentation @@ -1195,6 +1292,21 @@ module Google end end + class GetIamPolicyRequest + # @private + class Representation < Google::Apis::Core::JsonRepresentation + property :options, as: 'options', class: Google::Apis::BigqueryV2::GetPolicyOptions, decorator: Google::Apis::BigqueryV2::GetPolicyOptions::Representation + + end + end + + class GetPolicyOptions + # @private + class Representation < Google::Apis::Core::JsonRepresentation + property :requested_policy_version, as: 'requestedPolicyVersion' + end + end + class GetQueryResultsResponse # @private class Representation < Google::Apis::Core::JsonRepresentation @@ -1669,6 +1781,18 @@ module Google end end + class Policy + # @private + class Representation < Google::Apis::Core::JsonRepresentation + collection :audit_configs, as: 'auditConfigs', class: Google::Apis::BigqueryV2::AuditConfig, decorator: Google::Apis::BigqueryV2::AuditConfig::Representation + + collection :bindings, as: 'bindings', class: Google::Apis::BigqueryV2::Binding, decorator: Google::Apis::BigqueryV2::Binding::Representation + + property :etag, :base64 => true, as: 'etag' + property :version, as: 'version' + end + end + class ProjectList # @private class Representation < Google::Apis::Core::JsonRepresentation @@ -1912,6 +2036,15 @@ module Google end end + class SetIamPolicyRequest + # @private + class Representation < Google::Apis::Core::JsonRepresentation + property :policy, as: 'policy', class: Google::Apis::BigqueryV2::Policy, decorator: Google::Apis::BigqueryV2::Policy::Representation + + property :update_mask, as: 'updateMask' + end + end + class StandardSqlDataType # @private class Representation < Google::Apis::Core::JsonRepresentation @@ -2148,6 +2281,20 @@ module Google end end + class TestIamPermissionsRequest + # @private + class Representation < Google::Apis::Core::JsonRepresentation + collection :permissions, as: 'permissions' + end + end + + class TestIamPermissionsResponse + # @private + class Representation < Google::Apis::Core::JsonRepresentation + collection :permissions, as: 'permissions' + end + end + class TimePartitioning # @private class Representation < Google::Apis::Core::JsonRepresentation diff --git a/generated/google/apis/bigquery_v2/service.rb b/generated/google/apis/bigquery_v2/service.rb index c418d9b13..ed2e6894c 100644 --- a/generated/google/apis/bigquery_v2/service.rb +++ b/generated/google/apis/bigquery_v2/service.rb @@ -1213,6 +1213,45 @@ module Google execute_or_queue_command(command, &block) end + # Gets the access control policy for a resource. + # Returns an empty policy if the resource exists and does not have a policy + # set. + # @param [String] resource + # REQUIRED: The resource for which the policy is being requested. + # See the operation documentation for the appropriate value for this field. + # @param [Google::Apis::BigqueryV2::GetIamPolicyRequest] get_iam_policy_request_object + # @param [String] fields + # Selector specifying which fields to include in a partial response. + # @param [String] quota_user + # An opaque string that represents a user for quota purposes. Must not exceed 40 + # characters. + # @param [String] user_ip + # Deprecated. Please use quotaUser instead. + # @param [Google::Apis::RequestOptions] options + # Request-specific options + # + # @yield [result, err] Result & error if block supplied + # @yieldparam result [Google::Apis::BigqueryV2::Policy] parsed result object + # @yieldparam err [StandardError] error object if request failed + # + # @return [Google::Apis::BigqueryV2::Policy] + # + # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried + # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification + # @raise [Google::Apis::AuthorizationError] Authorization is required + def get_table_iam_policy(resource, get_iam_policy_request_object = nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) + command = make_simple_command(:post, '{+resource}:getIamPolicy', options) + command.request_representation = Google::Apis::BigqueryV2::GetIamPolicyRequest::Representation + command.request_object = get_iam_policy_request_object + command.response_representation = Google::Apis::BigqueryV2::Policy::Representation + command.response_class = Google::Apis::BigqueryV2::Policy + command.params['resource'] = resource unless resource.nil? + command.query['fields'] = fields unless fields.nil? + command.query['quotaUser'] = quota_user unless quota_user.nil? + command.query['userIp'] = user_ip unless user_ip.nil? + execute_or_queue_command(command, &block) + end + # Creates a new, empty table in the dataset. # @param [String] project_id # Project ID of the new table @@ -1338,6 +1377,87 @@ module Google execute_or_queue_command(command, &block) end + # Sets the access control policy on the specified resource. Replaces any + # existing policy. + # Can return `NOT_FOUND`, `INVALID_ARGUMENT`, and `PERMISSION_DENIED` errors. + # @param [String] resource + # REQUIRED: The resource for which the policy is being specified. + # See the operation documentation for the appropriate value for this field. + # @param [Google::Apis::BigqueryV2::SetIamPolicyRequest] set_iam_policy_request_object + # @param [String] fields + # Selector specifying which fields to include in a partial response. + # @param [String] quota_user + # An opaque string that represents a user for quota purposes. Must not exceed 40 + # characters. + # @param [String] user_ip + # Deprecated. Please use quotaUser instead. + # @param [Google::Apis::RequestOptions] options + # Request-specific options + # + # @yield [result, err] Result & error if block supplied + # @yieldparam result [Google::Apis::BigqueryV2::Policy] parsed result object + # @yieldparam err [StandardError] error object if request failed + # + # @return [Google::Apis::BigqueryV2::Policy] + # + # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried + # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification + # @raise [Google::Apis::AuthorizationError] Authorization is required + def set_table_iam_policy(resource, set_iam_policy_request_object = nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) + command = make_simple_command(:post, '{+resource}:setIamPolicy', options) + command.request_representation = Google::Apis::BigqueryV2::SetIamPolicyRequest::Representation + command.request_object = set_iam_policy_request_object + command.response_representation = Google::Apis::BigqueryV2::Policy::Representation + command.response_class = Google::Apis::BigqueryV2::Policy + command.params['resource'] = resource unless resource.nil? + command.query['fields'] = fields unless fields.nil? + command.query['quotaUser'] = quota_user unless quota_user.nil? + command.query['userIp'] = user_ip unless user_ip.nil? + execute_or_queue_command(command, &block) + end + + # Returns permissions that a caller has on the specified resource. + # If the resource does not exist, this will return an empty set of + # permissions, not a `NOT_FOUND` error. + # Note: This operation is designed to be used for building permission-aware + # UIs and command-line tools, not for authorization checking. This operation + # may "fail open" without warning. + # @param [String] resource + # REQUIRED: The resource for which the policy detail is being requested. + # See the operation documentation for the appropriate value for this field. + # @param [Google::Apis::BigqueryV2::TestIamPermissionsRequest] test_iam_permissions_request_object + # @param [String] fields + # Selector specifying which fields to include in a partial response. + # @param [String] quota_user + # An opaque string that represents a user for quota purposes. Must not exceed 40 + # characters. + # @param [String] user_ip + # Deprecated. Please use quotaUser instead. + # @param [Google::Apis::RequestOptions] options + # Request-specific options + # + # @yield [result, err] Result & error if block supplied + # @yieldparam result [Google::Apis::BigqueryV2::TestIamPermissionsResponse] parsed result object + # @yieldparam err [StandardError] error object if request failed + # + # @return [Google::Apis::BigqueryV2::TestIamPermissionsResponse] + # + # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried + # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification + # @raise [Google::Apis::AuthorizationError] Authorization is required + def test_table_iam_permissions(resource, test_iam_permissions_request_object = nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) + command = make_simple_command(:post, '{+resource}:testIamPermissions', options) + command.request_representation = Google::Apis::BigqueryV2::TestIamPermissionsRequest::Representation + command.request_object = test_iam_permissions_request_object + command.response_representation = Google::Apis::BigqueryV2::TestIamPermissionsResponse::Representation + command.response_class = Google::Apis::BigqueryV2::TestIamPermissionsResponse + command.params['resource'] = resource unless resource.nil? + command.query['fields'] = fields unless fields.nil? + command.query['quotaUser'] = quota_user unless quota_user.nil? + command.query['userIp'] = user_ip unless user_ip.nil? + execute_or_queue_command(command, &block) + end + # Updates information in an existing table. The update method replaces the # entire table resource, whereas the patch method only replaces fields that are # provided in the submitted table resource. diff --git a/generated/google/apis/bigqueryconnection_v1beta1.rb b/generated/google/apis/bigqueryconnection_v1beta1.rb index f775ca688..a4850b062 100644 --- a/generated/google/apis/bigqueryconnection_v1beta1.rb +++ b/generated/google/apis/bigqueryconnection_v1beta1.rb @@ -25,7 +25,7 @@ module Google # @see https://cloud.google.com/bigquery/ module BigqueryconnectionV1beta1 VERSION = 'V1beta1' - REVISION = '20200415' + REVISION = '20200430' # View and manage your data in Google BigQuery AUTH_BIGQUERY = 'https://www.googleapis.com/auth/bigquery' diff --git a/generated/google/apis/bigqueryconnection_v1beta1/classes.rb b/generated/google/apis/bigqueryconnection_v1beta1/classes.rb index 39e63a6da..c09e9eb79 100644 --- a/generated/google/apis/bigqueryconnection_v1beta1/classes.rb +++ b/generated/google/apis/bigqueryconnection_v1beta1/classes.rb @@ -471,6 +471,9 @@ module Google # Requests for policies with any conditional bindings must specify version 3. # Policies without any conditional bindings may specify any valid value or # leave the field unset. + # To learn which resources support conditions in their IAM policies, see the + # [IAM + # documentation](https://cloud.google.com/iam/help/conditions/resource-policies). # Corresponds to the JSON property `requestedPolicyVersion` # @return [Fixnum] attr_accessor :requested_policy_version @@ -517,10 +520,13 @@ module Google # Google groups, and domains (such as G Suite). A `role` is a named list of # permissions; each `role` can be an IAM predefined role or a user-created # custom role. - # Optionally, a `binding` can specify a `condition`, which is a logical - # expression that allows access to a resource only if the expression evaluates - # to `true`. A condition can add constraints based on attributes of the - # request, the resource, or both. + # For some types of Google Cloud resources, a `binding` can also specify a + # `condition`, which is a logical expression that allows access to a resource + # only if the expression evaluates to `true`. A condition can add constraints + # based on attributes of the request, the resource, or both. To learn which + # resources support conditions in their IAM policies, see the + # [IAM documentation](https://cloud.google.com/iam/help/conditions/resource- + # policies). # **JSON example:** # ` # "bindings": [ @@ -535,7 +541,9 @@ module Google # `, # ` # "role": "roles/resourcemanager.organizationViewer", - # "members": ["user:eve@example.com"], + # "members": [ + # "user:eve@example.com" + # ], # "condition": ` # "title": "expirable access", # "description": "Does not grant access after Sep 2020", @@ -613,6 +621,9 @@ module Google # the conditions in the version `3` policy are lost. # If a policy does not include any conditions, operations on that policy may # specify any valid version or leave the field unset. + # To learn which resources support conditions in their IAM policies, see the + # [IAM documentation](https://cloud.google.com/iam/help/conditions/resource- + # policies). # Corresponds to the JSON property `version` # @return [Fixnum] attr_accessor :version @@ -641,10 +652,13 @@ module Google # Google groups, and domains (such as G Suite). A `role` is a named list of # permissions; each `role` can be an IAM predefined role or a user-created # custom role. - # Optionally, a `binding` can specify a `condition`, which is a logical - # expression that allows access to a resource only if the expression evaluates - # to `true`. A condition can add constraints based on attributes of the - # request, the resource, or both. + # For some types of Google Cloud resources, a `binding` can also specify a + # `condition`, which is a logical expression that allows access to a resource + # only if the expression evaluates to `true`. A condition can add constraints + # based on attributes of the request, the resource, or both. To learn which + # resources support conditions in their IAM policies, see the + # [IAM documentation](https://cloud.google.com/iam/help/conditions/resource- + # policies). # **JSON example:** # ` # "bindings": [ @@ -659,7 +673,9 @@ module Google # `, # ` # "role": "roles/resourcemanager.organizationViewer", - # "members": ["user:eve@example.com"], + # "members": [ + # "user:eve@example.com" + # ], # "condition": ` # "title": "expirable access", # "description": "Does not grant access after Sep 2020", diff --git a/generated/google/apis/books_v1.rb b/generated/google/apis/books_v1.rb index 87e7a1de4..928633673 100644 --- a/generated/google/apis/books_v1.rb +++ b/generated/google/apis/books_v1.rb @@ -20,12 +20,12 @@ module Google module Apis # Books API # - # Searches for books and manages your Google Books library. + # The Google Books API allows clients to access the Google Books repository. # - # @see https://developers.google.com/books/docs/v1/getting_started + # @see https://code.google.com/apis/books/docs/v1/getting_started.html module BooksV1 VERSION = 'V1' - REVISION = '20200204' + REVISION = '20200506' # Manage your books AUTH_BOOKS = 'https://www.googleapis.com/auth/books' diff --git a/generated/google/apis/books_v1/classes.rb b/generated/google/apis/books_v1/classes.rb index b1281efba..44826cf10 100644 --- a/generated/google/apis/books_v1/classes.rb +++ b/generated/google/apis/books_v1/classes.rb @@ -26,14 +26,14 @@ module Google class Annotation include Google::Apis::Core::Hashable - # Anchor text after excerpt. For requests, if the user bookmarked a screen that - # has no flowing text on it, then this field should be empty. + # Anchor text after excerpt. For requests, if the user bookmarked a screen + # that has no flowing text on it, then this field should be empty. # Corresponds to the JSON property `afterSelectedText` # @return [String] attr_accessor :after_selected_text - # Anchor text before excerpt. For requests, if the user bookmarked a screen that - # has no flowing text on it, then this field should be empty. + # Anchor text before excerpt. For requests, if the user bookmarked a screen + # that has no flowing text on it, then this field should be empty. # Corresponds to the JSON property `beforeSelectedText` # @return [String] attr_accessor :before_selected_text @@ -45,7 +45,7 @@ module Google # Timestamp for the created time of this annotation. # Corresponds to the JSON property `created` - # @return [DateTime] + # @return [String] attr_accessor :created # Selection ranges for the most recent content version. @@ -106,7 +106,7 @@ module Google # Timestamp for the last time this annotation was modified. # Corresponds to the JSON property `updated` - # @return [DateTime] + # @return [String] attr_accessor :updated # The volume that this annotation belongs to. @@ -229,7 +229,8 @@ module Google class LayerSummary include Google::Apis::Core::Hashable - # Maximum allowed characters on this layer, especially for the "copy" layer. + # Maximum allowed characters on this layer, especially for the "copy" + # layer. # Corresponds to the JSON property `allowedCharacterCount` # @return [Fixnum] attr_accessor :allowed_character_count @@ -240,7 +241,8 @@ module Google # @return [String] attr_accessor :limit_type - # Remaining allowed characters on this layer, especially for the "copy" layer. + # Remaining allowed characters on this layer, especially for the "copy" + # layer. # Corresponds to the JSON property `remainingCharacterCount` # @return [Fixnum] attr_accessor :remaining_character_count @@ -258,75 +260,6 @@ module Google end end - # - class AnnotationData - include Google::Apis::Core::Hashable - - # The type of annotation this data is for. - # Corresponds to the JSON property `annotationType` - # @return [String] - attr_accessor :annotation_type - - # - # Corresponds to the JSON property `data` - # @return [Object] - attr_accessor :data - - # Base64 encoded data for this annotation data. - # Corresponds to the JSON property `encoded_data` - # NOTE: Values are automatically base64 encoded/decoded in the client library. - # @return [String] - attr_accessor :encoded_data - - # Unique id for this annotation data. - # Corresponds to the JSON property `id` - # @return [String] - attr_accessor :id - - # Resource Type - # Corresponds to the JSON property `kind` - # @return [String] - attr_accessor :kind - - # The Layer id for this data. * - # Corresponds to the JSON property `layerId` - # @return [String] - attr_accessor :layer_id - - # URL for this resource. * - # Corresponds to the JSON property `selfLink` - # @return [String] - attr_accessor :self_link - - # Timestamp for the last time this data was updated. (RFC 3339 UTC date-time - # format). - # Corresponds to the JSON property `updated` - # @return [DateTime] - attr_accessor :updated - - # The volume id for this data. * - # Corresponds to the JSON property `volumeId` - # @return [String] - attr_accessor :volume_id - - def initialize(**args) - update!(**args) - end - - # Update properties of this object - def update!(**args) - @annotation_type = args[:annotation_type] if args.key?(:annotation_type) - @data = args[:data] if args.key?(:data) - @encoded_data = args[:encoded_data] if args.key?(:encoded_data) - @id = args[:id] if args.key?(:id) - @kind = args[:kind] if args.key?(:kind) - @layer_id = args[:layer_id] if args.key?(:layer_id) - @self_link = args[:self_link] if args.key?(:self_link) - @updated = args[:updated] if args.key?(:updated) - @volume_id = args[:volume_id] if args.key?(:volume_id) - end - end - # class Annotations include Google::Apis::Core::Hashable @@ -341,8 +274,8 @@ module Google # @return [String] attr_accessor :kind - # Token to pass in for pagination for the next page. This will not be present if - # this request does not have more results. + # Token to pass in for pagination for the next page. This will not be present + # if this request does not have more results. # Corresponds to the JSON property `nextPageToken` # @return [String] attr_accessor :next_page_token @@ -416,7 +349,7 @@ module Google # # Corresponds to the JSON property `updated` - # @return [DateTime] + # @return [String] attr_accessor :updated def initialize(**args) @@ -440,7 +373,7 @@ module Google # A list of Annotation Data. # Corresponds to the JSON property `items` - # @return [Array] + # @return [Array] attr_accessor :items # Resource type @@ -448,8 +381,8 @@ module Google # @return [String] attr_accessor :kind - # Token to pass in for pagination for the next page. This will not be present if - # this request does not have more results. + # Token to pass in for pagination for the next page. This will not be present + # if this request does not have more results. # Corresponds to the JSON property `nextPageToken` # @return [String] attr_accessor :next_page_token @@ -546,43 +479,6 @@ module Google end end - # - class BooksSubscriptionReleaseInfo - include Google::Apis::Core::Hashable - - # Amount in micros of the specified currency code. - # Corresponds to the JSON property `amountInMicros` - # @return [Fixnum] - attr_accessor :amount_in_micros - - # Currency code of the amount. - # Corresponds to the JSON property `currencyCode` - # @return [String] - attr_accessor :currency_code - - # The release number of this issue/volume/book. - # Corresponds to the JSON property `releaseNumber` - # @return [String] - attr_accessor :release_number - - # The release date. - # Corresponds to the JSON property `releaseTimestampUs` - # @return [Fixnum] - attr_accessor :release_timestamp_us - - def initialize(**args) - update!(**args) - end - - # Update properties of this object - def update!(**args) - @amount_in_micros = args[:amount_in_micros] if args.key?(:amount_in_micros) - @currency_code = args[:currency_code] if args.key?(:currency_code) - @release_number = args[:release_number] if args.key?(:release_number) - @release_timestamp_us = args[:release_timestamp_us] if args.key?(:release_timestamp_us) - end - end - # class RateRecommendedVolumeResponse include Google::Apis::Core::Hashable @@ -614,7 +510,7 @@ module Google # Created time for this bookshelf (formatted UTC timestamp with millisecond # resolution). # Corresponds to the JSON property `created` - # @return [DateTime] + # @return [String] attr_accessor :created # Description of this bookshelf. @@ -642,10 +538,10 @@ module Google # @return [String] attr_accessor :title - # Last modified time of this bookshelf (formatted UTC timestamp with millisecond - # resolution). + # Last modified time of this bookshelf (formatted UTC timestamp with + # millisecond resolution). # Corresponds to the JSON property `updated` - # @return [DateTime] + # @return [String] attr_accessor :updated # Number of volumes in this bookshelf. @@ -656,7 +552,7 @@ module Google # Last time a volume was added or removed from this bookshelf (formatted UTC # timestamp with millisecond resolution). # Corresponds to the JSON property `volumesLastUpdated` - # @return [DateTime] + # @return [String] attr_accessor :volumes_last_updated def initialize(**args) @@ -805,8 +701,8 @@ module Google # @return [String] attr_accessor :signature - # Client app identifier for verification. Download access and client-validation - # only. + # Client app identifier for verification. Download access and + # client-validation only. # Corresponds to the JSON property `source` # @return [String] attr_accessor :source @@ -841,6 +737,77 @@ module Google end end + # + class DictionaryAnnotationdata + include Google::Apis::Core::Hashable + + # The type of annotation this data is for. + # Corresponds to the JSON property `annotationType` + # @return [String] + attr_accessor :annotation_type + + # JSON encoded data for this dictionary annotation data. + # Emitted with name 'data' in JSON output. Either this or geo_data will + # be populated. + # Corresponds to the JSON property `data` + # @return [Google::Apis::BooksV1::DictLayerData] + attr_accessor :data + + # Base64 encoded data for this annotation data. + # Corresponds to the JSON property `encodedData` + # NOTE: Values are automatically base64 encoded/decoded in the client library. + # @return [String] + attr_accessor :encoded_data + + # Unique id for this annotation data. + # Corresponds to the JSON property `id` + # @return [String] + attr_accessor :id + + # Resource Type + # Corresponds to the JSON property `kind` + # @return [String] + attr_accessor :kind + + # The Layer id for this data. * + # Corresponds to the JSON property `layerId` + # @return [String] + attr_accessor :layer_id + + # URL for this resource. * + # Corresponds to the JSON property `selfLink` + # @return [String] + attr_accessor :self_link + + # Timestamp for the last time this data was updated. (RFC 3339 UTC date-time + # format). + # Corresponds to the JSON property `updated` + # @return [String] + attr_accessor :updated + + # The volume id for this data. * + # Corresponds to the JSON property `volumeId` + # @return [String] + attr_accessor :volume_id + + def initialize(**args) + update!(**args) + end + + # Update properties of this object + def update!(**args) + @annotation_type = args[:annotation_type] if args.key?(:annotation_type) + @data = args[:data] if args.key?(:data) + @encoded_data = args[:encoded_data] if args.key?(:encoded_data) + @id = args[:id] if args.key?(:id) + @kind = args[:kind] if args.key?(:kind) + @layer_id = args[:layer_id] if args.key?(:layer_id) + @self_link = args[:self_link] if args.key?(:self_link) + @updated = args[:updated] if args.key?(:updated) + @volume_id = args[:volume_id] if args.key?(:volume_id) + end + end + # class DictLayerData include Google::Apis::Core::Hashable @@ -875,8 +842,8 @@ module Google class Common include Google::Apis::Core::Hashable - # The display title and localized canonical name to use when searching for this - # entity on Google search. + # The display title and localized canonical name to use when searching for + # this entity on Google search. # Corresponds to the JSON property `title` # @return [String] attr_accessor :title @@ -959,8 +926,8 @@ module Google # @return [Array] attr_accessor :senses - # The words with different meanings but not related words, e.g. "go" (game) and " - # go" (verb). + # The words with different meanings but not related words, e.g. "go" + # (game) and "go" (verb). # Corresponds to the JSON property `source` # @return [Google::Apis::BooksV1::DictLayerData::Dict::Word::Source] attr_accessor :source @@ -1313,8 +1280,8 @@ module Google end end - # The words with different meanings but not related words, e.g. "go" (game) and " - # go" (verb). + # The words with different meanings but not related words, e.g. "go" + # (game) and "go" (verb). class Source include Google::Apis::Core::Hashable @@ -1481,8 +1448,8 @@ module Google attr_accessor :device_allowed alias_method :device_allowed?, :device_allowed - # If restricted, the number of content download licenses already acquired ( - # including the requesting client, if licensed). + # If restricted, the number of content download licenses already acquired + # (including the requesting client, if licensed). # Corresponds to the JSON property `downloadsAcquired` # @return [Fixnum] attr_accessor :downloads_acquired @@ -1498,7 +1465,8 @@ module Google # @return [String] attr_accessor :kind - # If restricted, the maximum number of content download licenses for this volume. + # If restricted, the maximum number of content download licenses for this + # volume. # Corresponds to the JSON property `maxDownloadDevices` # @return [Fixnum] attr_accessor :max_download_devices @@ -1513,8 +1481,8 @@ module Google # @return [String] attr_accessor :nonce - # Error/warning reason code. Additional codes may be added in the future. 0 OK - # 100 ACCESS_DENIED_PUBLISHER_LIMIT 101 ACCESS_DENIED_LIMIT 200 + # Error/warning reason code. Additional codes may be added in the future. 0 + # OK 100 ACCESS_DENIED_PUBLISHER_LIMIT 101 ACCESS_DENIED_LIMIT 200 # WARNING_USED_LAST_ACCESS # Corresponds to the JSON property `reasonCode` # @return [String] @@ -1531,8 +1499,8 @@ module Google # @return [String] attr_accessor :signature - # Client app identifier for verification. Download access and client-validation - # only. + # Client app identifier for verification. Download access and + # client-validation only. # Corresponds to the JSON property `source` # @return [String] attr_accessor :source @@ -1588,6 +1556,25 @@ module Google 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 + # class FamilyInfo include Google::Apis::Core::Hashable @@ -1657,6 +1644,77 @@ module Google end end + # + class GeoAnnotationdata + include Google::Apis::Core::Hashable + + # The type of annotation this data is for. + # Corresponds to the JSON property `annotationType` + # @return [String] + attr_accessor :annotation_type + + # JSON encoded data for this geo annotation data. + # Emitted with name 'data' in JSON output. Either this or dict_data will + # be populated. + # Corresponds to the JSON property `data` + # @return [Google::Apis::BooksV1::GeoLayerData] + attr_accessor :data + + # Base64 encoded data for this annotation data. + # Corresponds to the JSON property `encodedData` + # NOTE: Values are automatically base64 encoded/decoded in the client library. + # @return [String] + attr_accessor :encoded_data + + # Unique id for this annotation data. + # Corresponds to the JSON property `id` + # @return [String] + attr_accessor :id + + # Resource Type + # Corresponds to the JSON property `kind` + # @return [String] + attr_accessor :kind + + # The Layer id for this data. * + # Corresponds to the JSON property `layerId` + # @return [String] + attr_accessor :layer_id + + # URL for this resource. * + # Corresponds to the JSON property `selfLink` + # @return [String] + attr_accessor :self_link + + # Timestamp for the last time this data was updated. (RFC 3339 UTC date-time + # format). + # Corresponds to the JSON property `updated` + # @return [String] + attr_accessor :updated + + # The volume id for this data. * + # Corresponds to the JSON property `volumeId` + # @return [String] + attr_accessor :volume_id + + def initialize(**args) + update!(**args) + end + + # Update properties of this object + def update!(**args) + @annotation_type = args[:annotation_type] if args.key?(:annotation_type) + @data = args[:data] if args.key?(:data) + @encoded_data = args[:encoded_data] if args.key?(:encoded_data) + @id = args[:id] if args.key?(:id) + @kind = args[:kind] if args.key?(:kind) + @layer_id = args[:layer_id] if args.key?(:layer_id) + @self_link = args[:self_link] if args.key?(:self_link) + @updated = args[:updated] if args.key?(:updated) + @volume_id = args[:volume_id] if args.key?(:volume_id) + end + end + # class GeoLayerData include Google::Apis::Core::Hashable @@ -1711,8 +1769,8 @@ module Google # @return [String] attr_accessor :snippet_url - # The display title and localized canonical name to use when searching for this - # entity on Google search. + # The display title and localized canonical name to use when searching for + # this entity on Google search. # Corresponds to the JSON property `title` # @return [String] attr_accessor :title @@ -1735,13 +1793,14 @@ module Google class Geo include Google::Apis::Core::Hashable - # The boundary of the location as a set of loops containing pairs of latitude, - # longitude coordinates. + # The boundary of the location as a set of loops containing pairs of + # latitude, longitude coordinates. # Corresponds to the JSON property `boundary` - # @return [Array>] + # @return [Array] attr_accessor :boundary - # The cache policy active for this data. EX: UNRESTRICTED, RESTRICTED, NEVER + # The cache policy active for this data. EX: UNRESTRICTED, RESTRICTED, + # NEVER # Corresponds to the JSON property `cachePolicy` # @return [String] attr_accessor :cache_policy @@ -1761,8 +1820,8 @@ module Google # @return [Float] attr_accessor :longitude - # The type of map that should be used for this location. EX: HYBRID, ROADMAP, - # SATELLITE, TERRAIN + # The type of map that should be used for this location. EX: HYBRID, + # ROADMAP, SATELLITE, TERRAIN # Corresponds to the JSON property `mapType` # @return [String] attr_accessor :map_type @@ -1775,8 +1834,8 @@ module Google # The Zoom level to use for the map. Zoom levels between 0 (the lowest zoom # level, in which the entire world can be seen on one map) to 21+ (down to - # individual buildings). See: https://developers.google.com/maps/documentation/ - # staticmaps/#Zoomlevels + # individual buildings). See: https: + # //developers.google.com/maps/documentation/staticmaps/#Zoomlevels # Corresponds to the JSON property `zoom` # @return [Fixnum] attr_accessor :zoom @@ -1797,31 +1856,6 @@ module Google @zoom = args[:zoom] if args.key?(:zoom) end - # - class Boundary - include Google::Apis::Core::Hashable - - # - # Corresponds to the JSON property `latitude` - # @return [Fixnum] - attr_accessor :latitude - - # - # Corresponds to the JSON property `longitude` - # @return [Fixnum] - attr_accessor :longitude - - def initialize(**args) - update!(**args) - end - - # Update properties of this object - def update!(**args) - @latitude = args[:latitude] if args.key?(:latitude) - @longitude = args[:longitude] if args.key?(:longitude) - end - end - # The viewport for showing this location. This is a latitude, longitude # rectangle. class Viewport @@ -1985,15 +2019,15 @@ module Google # @return [String] attr_accessor :self_link - # Timestamp for the last time an item in this layer was updated. (RFC 3339 UTC - # date-time format). + # Timestamp for the last time an item in this layer was updated. (RFC 3339 + # UTC date-time format). # Corresponds to the JSON property `updated` - # @return [DateTime] + # @return [String] attr_accessor :updated - # The current version of this layer's volume annotations. Note that this version - # applies only to the data in the books.layers.volumeAnnotations.* responses. - # The actual annotation data is versioned separately. + # The current version of this layer's volume annotations. Note that this + # version applies only to the data in the books.layers.volumeAnnotations.* + # responses. The actual annotation data is versioned separately. # Corresponds to the JSON property `volumeAnnotationsVersion` # @return [String] attr_accessor :volume_annotations_version @@ -2345,10 +2379,10 @@ module Google # @return [String] attr_accessor :pdf_position - # Timestamp when this reading position was last updated (formatted UTC timestamp - # with millisecond resolution). + # Timestamp when this reading position was last updated (formatted UTC + # timestamp with millisecond resolution). # Corresponds to the JSON property `updated` - # @return [DateTime] + # @return [String] attr_accessor :updated # Volume id associated with this reading position. @@ -2373,7 +2407,7 @@ module Google end # - class RequestAccess + class RequestAccessData include Google::Apis::Core::Hashable # A concurrent access response. @@ -2432,14 +2466,14 @@ module Google # @return [String] attr_accessor :kind - # Star rating for this review. Possible values are ONE, TWO, THREE, FOUR, FIVE - # or NOT_RATED. + # Star rating for this review. Possible values are ONE, TWO, THREE, FOUR, + # FIVE or NOT_RATED. # Corresponds to the JSON property `rating` # @return [String] attr_accessor :rating - # Information regarding the source of this review, when the review is not from a - # Google Books user. + # Information regarding the source of this review, when the review is not + # from a Google Books user. # Corresponds to the JSON property `source` # @return [Google::Apis::BooksV1::Review::Source] attr_accessor :source @@ -2497,8 +2531,8 @@ module Google end end - # Information regarding the source of this review, when the review is not from a - # Google Books user. + # Information regarding the source of this review, when the review is not + # from a Google Books user. class Source include Google::Apis::Core::Hashable @@ -2632,22 +2666,22 @@ module Google class SeriesSubscriptionReleaseInfo include Google::Apis::Core::Hashable - # Cancellation date of the series subscription (or when it ends). - # Corresponds to the JSON property `cancellationTimestampUs` - # @return [Fixnum] - attr_accessor :cancellation_timestamp_us + # + # Corresponds to the JSON property `cancelTime` + # @return [String] + attr_accessor :cancel_time - # Release information for the last release. + # # Corresponds to the JSON property `currentReleaseInfo` - # @return [Google::Apis::BooksV1::BooksSubscriptionReleaseInfo] + # @return [Google::Apis::BooksV1::Series::Series::SeriesSubscriptionReleaseInfo::CurrentReleaseInfo] attr_accessor :current_release_info - # Release information for the next release. + # # Corresponds to the JSON property `nextReleaseInfo` - # @return [Google::Apis::BooksV1::BooksSubscriptionReleaseInfo] + # @return [Google::Apis::BooksV1::Series::Series::SeriesSubscriptionReleaseInfo::NextReleaseInfo] attr_accessor :next_release_info - # series subscription type. + # # Corresponds to the JSON property `seriesSubscriptionType` # @return [String] attr_accessor :series_subscription_type @@ -2658,11 +2692,85 @@ module Google # Update properties of this object def update!(**args) - @cancellation_timestamp_us = args[:cancellation_timestamp_us] if args.key?(:cancellation_timestamp_us) + @cancel_time = args[:cancel_time] if args.key?(:cancel_time) @current_release_info = args[:current_release_info] if args.key?(:current_release_info) @next_release_info = args[:next_release_info] if args.key?(:next_release_info) @series_subscription_type = args[:series_subscription_type] if args.key?(:series_subscription_type) end + + # + class CurrentReleaseInfo + include Google::Apis::Core::Hashable + + # + # Corresponds to the JSON property `amountInMicros` + # @return [Float] + attr_accessor :amount_in_micros + + # + # Corresponds to the JSON property `currencyCode` + # @return [String] + attr_accessor :currency_code + + # + # Corresponds to the JSON property `releaseNumber` + # @return [String] + attr_accessor :release_number + + # + # Corresponds to the JSON property `releaseTime` + # @return [String] + attr_accessor :release_time + + def initialize(**args) + update!(**args) + end + + # Update properties of this object + def update!(**args) + @amount_in_micros = args[:amount_in_micros] if args.key?(:amount_in_micros) + @currency_code = args[:currency_code] if args.key?(:currency_code) + @release_number = args[:release_number] if args.key?(:release_number) + @release_time = args[:release_time] if args.key?(:release_time) + end + end + + # + class NextReleaseInfo + include Google::Apis::Core::Hashable + + # + # Corresponds to the JSON property `amountInMicros` + # @return [Float] + attr_accessor :amount_in_micros + + # + # Corresponds to the JSON property `currencyCode` + # @return [String] + attr_accessor :currency_code + + # + # Corresponds to the JSON property `releaseNumber` + # @return [String] + attr_accessor :release_number + + # + # Corresponds to the JSON property `releaseTime` + # @return [String] + attr_accessor :release_time + + def initialize(**args) + update!(**args) + end + + # Update properties of this object + def update!(**args) + @amount_in_micros = args[:amount_in_micros] if args.key?(:amount_in_micros) + @currency_code = args[:currency_code] if args.key?(:currency_code) + @release_number = args[:release_number] if args.key?(:release_number) + @release_time = args[:release_time] if args.key?(:release_time) + end + end end end end @@ -2931,8 +3039,9 @@ module Google attr_accessor :recommended_info # Any information about a volume related to the eBookstore and/or - # purchaseability. This information can depend on the country where the request - # originates from (i.e. books may not be for sale in certain countries). + # purchaseability. This information can depend on the country where the + # request originates from (i.e. books may not be for sale in certain + # countries). # Corresponds to the JSON property `saleInfo` # @return [Google::Apis::BooksV1::Volume::SaleInfo] attr_accessor :sale_info @@ -2983,15 +3092,15 @@ module Google class AccessInfo include Google::Apis::Core::Hashable - # Combines the access and viewability of this volume into a single status field - # for this user. Values can be FULL_PURCHASED, FULL_PUBLIC_DOMAIN, SAMPLE or - # NONE. (In LITE projection.) + # Combines the access and viewability of this volume into a single status + # field for this user. Values can be FULL_PURCHASED, FULL_PUBLIC_DOMAIN, + # SAMPLE or NONE. (In LITE projection.) # Corresponds to the JSON property `accessViewStatus` # @return [String] attr_accessor :access_view_status - # The two-letter ISO_3166-1 country code for which this access information is - # valid. (In LITE projection.) + # The two-letter ISO_3166-1 country code for which this access information + # is valid. (In LITE projection.) # Corresponds to the JSON property `country` # @return [String] attr_accessor :country @@ -3007,8 +3116,8 @@ module Google # @return [String] attr_accessor :drive_imported_content_link - # Whether this volume can be embedded in a viewport using the Embedded Viewer - # API. + # Whether this volume can be embedded in a viewport using the Embedded + # Viewer API. # Corresponds to the JSON property `embeddable` # @return [Boolean] attr_accessor :embeddable @@ -3044,29 +3153,30 @@ module Google attr_accessor :quote_sharing_allowed alias_method :quote_sharing_allowed?, :quote_sharing_allowed - # Whether text-to-speech is permitted for this volume. Values can be ALLOWED, - # ALLOWED_FOR_ACCESSIBILITY, or NOT_ALLOWED. + # Whether text-to-speech is permitted for this volume. Values can be + # ALLOWED, ALLOWED_FOR_ACCESSIBILITY, or NOT_ALLOWED. # Corresponds to the JSON property `textToSpeechPermission` # @return [String] attr_accessor :text_to_speech_permission - # For ordered but not yet processed orders, we give a URL that can be used to go - # to the appropriate Google Wallet page. + # For ordered but not yet processed orders, we give a URL that can be used + # to go to the appropriate Google Wallet page. # Corresponds to the JSON property `viewOrderUrl` # @return [String] attr_accessor :view_order_url - # The read access of a volume. Possible values are PARTIAL, ALL_PAGES, NO_PAGES - # or UNKNOWN. This value depends on the country listed above. A value of PARTIAL - # means that the publisher has allowed some portion of the volume to be viewed - # publicly, without purchase. This can apply to eBooks as well as non-eBooks. - # Public domain books will always have a value of ALL_PAGES. + # The read access of a volume. Possible values are PARTIAL, ALL_PAGES, + # NO_PAGES or UNKNOWN. This value depends on the country listed above. A + # value of PARTIAL means that the publisher has allowed some portion of the + # volume to be viewed publicly, without purchase. This can apply to eBooks + # as well as non-eBooks. Public domain books will always have a value of + # ALL_PAGES. # Corresponds to the JSON property `viewability` # @return [String] attr_accessor :viewability - # URL to read this volume on the Google Books site. Link will not allow users to - # read non-viewable volumes. + # URL to read this volume on the Google Books site. Link will not allow + # users to read non-viewable volumes. # Corresponds to the JSON property `webReaderLink` # @return [String] attr_accessor :web_reader_link @@ -3107,8 +3217,8 @@ module Google # @return [String] attr_accessor :download_link - # Is a flowing text epub available either as public domain or for purchase. (In - # LITE projection.) + # Is a flowing text epub available either as public domain or for + # purchase. (In LITE projection.) # Corresponds to the JSON property `isAvailable` # @return [Boolean] attr_accessor :is_available @@ -3140,8 +3250,8 @@ module Google # @return [String] attr_accessor :download_link - # Is a scanned image pdf available either as public domain or for purchase. (In - # LITE projection.) + # Is a scanned image pdf available either as public domain or for + # purchase. (In LITE projection.) # Corresponds to the JSON property `isAvailable` # @return [Boolean] attr_accessor :is_available @@ -3187,9 +3297,10 @@ module Google # @return [String] attr_accessor :layer_id - # The current version of this layer's volume annotations. Note that this version - # applies only to the data in the books.layers.volumeAnnotations.* responses. - # The actual annotation data is versioned separately. + # The current version of this layer's volume annotations. Note that this + # version applies only to the data in the + # books.layers.volumeAnnotations.* responses. The actual annotation data + # is versioned separately. # Corresponds to the JSON property `volumeAnnotationsVersion` # @return [String] attr_accessor :volume_annotations_version @@ -3226,12 +3337,14 @@ module Google end # Any information about a volume related to the eBookstore and/or - # purchaseability. This information can depend on the country where the request - # originates from (i.e. books may not be for sale in certain countries). + # purchaseability. This information can depend on the country where the + # request originates from (i.e. books may not be for sale in certain + # countries). class SaleInfo include Google::Apis::Core::Hashable - # URL to purchase this volume on the Google Books site. (In LITE projection) + # URL to purchase this volume on the Google Books site. (In LITE + # projection) # Corresponds to the JSON property `buyLink` # @return [String] attr_accessor :buy_link @@ -3242,7 +3355,8 @@ module Google # @return [String] attr_accessor :country - # Whether or not this volume is an eBook (can be added to the My eBooks shelf). + # Whether or not this volume is an eBook (can be added to the My eBooks + # shelf). # Corresponds to the JSON property `isEbook` # @return [Boolean] attr_accessor :is_ebook @@ -3260,19 +3374,20 @@ module Google # The date on which this book is available for sale. # Corresponds to the JSON property `onSaleDate` - # @return [DateTime] + # @return [String] attr_accessor :on_sale_date - # The actual selling price of the book. This is the same as the suggested retail - # or list price unless there are offers or discounts on this volume. (In LITE - # projection.) + # The actual selling price of the book. This is the same as the suggested + # retail or list price unless there are offers or discounts on this volume. + # (In LITE projection.) # Corresponds to the JSON property `retailPrice` # @return [Google::Apis::BooksV1::Volume::SaleInfo::RetailPrice] attr_accessor :retail_price # Whether or not this book is available for sale or offered for free in the - # Google eBookstore for the country listed above. Possible values are FOR_SALE, - # FOR_RENTAL_ONLY, FOR_SALE_AND_RENTAL, FREE, NOT_FOR_SALE, or FOR_PREORDER. + # Google eBookstore for the country listed above. Possible values are + # FOR_SALE, FOR_RENTAL_ONLY, FOR_SALE_AND_RENTAL, FREE, NOT_FOR_SALE, or + # FOR_PREORDER. # Corresponds to the JSON property `saleability` # @return [String] attr_accessor :saleability @@ -3437,9 +3552,9 @@ module Google end end - # The actual selling price of the book. This is the same as the suggested retail - # or list price unless there are offers or discounts on this volume. (In LITE - # projection.) + # The actual selling price of the book. This is the same as the suggested + # retail or list price unless there are offers or discounts on this volume. + # (In LITE projection.) class RetailPrice include Google::Apis::Core::Hashable @@ -3489,11 +3604,11 @@ module Google class UserInfo include Google::Apis::Core::Hashable - # Timestamp when this volume was acquired by the user. (RFC 3339 UTC date-time - # format) Acquiring includes purchase, user upload, receiving family sharing, - # etc. + # Timestamp when this volume was acquired by the user. (RFC 3339 UTC + # date-time format) Acquiring includes purchase, user upload, receiving + # family sharing, etc. # Corresponds to the JSON property `acquiredTime` - # @return [DateTime] + # @return [String] attr_accessor :acquired_time # How this volume was acquired. @@ -3546,15 +3661,15 @@ module Google attr_accessor :is_in_my_books alias_method :is_in_my_books?, :is_in_my_books - # Whether or not this volume was pre-ordered by the authenticated user making - # the request. (In LITE projection.) + # Whether or not this volume was pre-ordered by the authenticated user + # making the request. (In LITE projection.) # Corresponds to the JSON property `isPreordered` # @return [Boolean] attr_accessor :is_preordered alias_method :is_preordered?, :is_preordered - # Whether or not this volume was purchased by the authenticated user making the - # request. (In LITE projection.) + # Whether or not this volume was purchased by the authenticated user making + # the request. (In LITE projection.) # Corresponds to the JSON property `isPurchased` # @return [Boolean] attr_accessor :is_purchased @@ -3566,8 +3681,8 @@ module Google attr_accessor :is_uploaded alias_method :is_uploaded?, :is_uploaded - # The user's current reading position in the volume, if one is available. (In - # LITE projection.) + # The user's current reading position in the volume, if one is available. + # (In LITE projection.) # Corresponds to the JSON property `readingPosition` # @return [Google::Apis::BooksV1::ReadingPosition] attr_accessor :reading_position @@ -3588,10 +3703,10 @@ module Google attr_accessor :review # Timestamp when this volume was last modified by a user action, such as a - # reading position update, volume purchase or writing a review. (RFC 3339 UTC - # date-time format). + # reading position update, volume purchase or writing a review. (RFC 3339 + # UTC date-time format). # Corresponds to the JSON property `updated` - # @return [DateTime] + # @return [String] attr_accessor :updated # @@ -3647,7 +3762,7 @@ module Google # # Corresponds to the JSON property `updated` - # @return [DateTime] + # @return [String] attr_accessor :updated def initialize(**args) @@ -3672,16 +3787,16 @@ module Google # @return [String] attr_accessor :family_role - # Whether or not this volume can be shared with the family by the user. This - # includes sharing eligibility of both the volume and the user. If the value is - # true, the user can initiate a family sharing action. + # Whether or not this volume can be shared with the family by the user. + # This includes sharing eligibility of both the volume and the user. If + # the value is true, the user can initiate a family sharing action. # Corresponds to the JSON property `isSharingAllowed` # @return [Boolean] attr_accessor :is_sharing_allowed alias_method :is_sharing_allowed?, :is_sharing_allowed - # Whether or not sharing this volume is temporarily disabled due to issues with - # the Family Wallet. + # Whether or not sharing this volume is temporarily disabled due to + # issues with the Family Wallet. # Corresponds to the JSON property `isSharingDisabledByFop` # @return [Boolean] attr_accessor :is_sharing_disabled_by_fop @@ -3754,7 +3869,8 @@ module Google attr_accessor :allow_anon_logging alias_method :allow_anon_logging?, :allow_anon_logging - # The names of the authors and/or editors for this volume. (In LITE projection) + # The names of the authors and/or editors for this volume. (In LITE + # projection) # Corresponds to the JSON property `authors` # @return [Array] attr_accessor :authors @@ -3780,15 +3896,15 @@ module Google attr_accessor :comics_content alias_method :comics_content?, :comics_content - # An identifier for the version of the volume content (text & images). (In LITE - # projection) + # An identifier for the version of the volume content (text & images). (In + # LITE projection) # Corresponds to the JSON property `contentVersion` # @return [String] attr_accessor :content_version - # A synopsis of the volume. The text of the description is formatted in HTML and - # includes simple formatting elements, such as b, i, and br tags. (In LITE - # projection.) + # A synopsis of the volume. The text of the description is formatted in + # HTML and includes simple formatting elements, such as b, i, and br tags. + # (In LITE projection.) # Corresponds to the JSON property `description` # @return [String] attr_accessor :description @@ -3809,20 +3925,20 @@ module Google # @return [Array] attr_accessor :industry_identifiers - # URL to view information about this volume on the Google Books site. (In LITE - # projection) + # URL to view information about this volume on the Google Books site. (In + # LITE projection) # Corresponds to the JSON property `infoLink` # @return [String] attr_accessor :info_link - # Best language for this volume (based on content). It is the two-letter ISO 639- - # 1 code such as 'fr', 'en', etc. + # Best language for this volume (based on content). It is the two-letter + # ISO 639-1 code such as 'fr', 'en', etc. # Corresponds to the JSON property `language` # @return [String] attr_accessor :language - # The main category to which this volume belongs. It will be the category from - # the categories list returned below that has the highest weight. + # The main category to which this volume belongs. It will be the category + # from the categories list returned below that has the highest weight. # Corresponds to the JSON property `mainCategory` # @return [String] attr_accessor :main_category @@ -3874,7 +3990,7 @@ module Google # The reading modes available for this volume. # Corresponds to the JSON property `readingModes` - # @return [Object] + # @return [Google::Apis::BooksV1::Volume::VolumeInfo::ReadingModes] attr_accessor :reading_modes # Total number of sample pages as per publisher metadata. @@ -3969,7 +4085,8 @@ module Google class ImageLinks include Google::Apis::Core::Hashable - # Image link for extra large size (width of ~1280 pixels). (In LITE projection) + # Image link for extra large size (width of ~1280 pixels). (In LITE + # projection) # Corresponds to the JSON property `extraLarge` # @return [String] attr_accessor :extra_large @@ -3989,12 +4106,14 @@ module Google # @return [String] attr_accessor :small - # Image link for small thumbnail size (width of ~80 pixels). (In LITE projection) + # Image link for small thumbnail size (width of ~80 pixels). (In LITE + # projection) # Corresponds to the JSON property `smallThumbnail` # @return [String] attr_accessor :small_thumbnail - # Image link for thumbnail size (width of ~128 pixels). (In LITE projection) + # Image link for thumbnail size (width of ~128 pixels). (In LITE + # projection) # Corresponds to the JSON property `thumbnail` # @return [String] attr_accessor :thumbnail @@ -4077,6 +4196,33 @@ module Google @image_bubble_version = args[:image_bubble_version] if args.key?(:image_bubble_version) end end + + # The reading modes available for this volume. + class ReadingModes + include Google::Apis::Core::Hashable + + # + # Corresponds to the JSON property `image` + # @return [Boolean] + attr_accessor :image + alias_method :image?, :image + + # + # Corresponds to the JSON property `text` + # @return [Boolean] + attr_accessor :text + alias_method :text?, :text + + def initialize(**args) + update!(**args) + end + + # Update properties of this object + def update!(**args) + @image = args[:image] if args.key?(:image) + @text = args[:text] if args.key?(:text) + end + end end end @@ -4176,10 +4322,10 @@ module Google # @return [String] attr_accessor :self_link - # Timestamp for the last time this anntoation was updated. (RFC 3339 UTC date- - # time format). + # Timestamp for the last time this anntoation was updated. (RFC 3339 UTC + # date-time format). # Corresponds to the JSON property `updated` - # @return [DateTime] + # @return [String] attr_accessor :updated # The Volume this annotation is for. @@ -4261,8 +4407,8 @@ module Google # @return [String] attr_accessor :kind - # Token to pass in for pagination for the next page. This will not be present if - # this request does not have more results. + # Token to pass in for pagination for the next page. This will not be present + # if this request does not have more results. # Corresponds to the JSON property `nextPageToken` # @return [String] attr_accessor :next_page_token @@ -4272,10 +4418,10 @@ module Google # @return [Fixnum] attr_accessor :total_items - # The version string for all of the volume annotations in this layer (not just - # the ones in this response). Note: the version string doesn't apply to the - # annotation data, just the information in this response (e.g. the location of - # annotations in the book). + # The version string for all of the volume annotations in this layer (not + # just the ones in this response). Note: the version string + # doesn't apply to the annotation data, just the information in this response + # (e.g. the location of annotations in the book). # Corresponds to the JSON property `version` # @return [String] attr_accessor :version @@ -4330,8 +4476,8 @@ module Google class Volumeseriesinfo include Google::Apis::Core::Hashable - # The display number string. This should be used only for display purposes and - # the actual sequence should be inferred from the below orderNumber. + # The display number string. This should be used only for display purposes + # and the actual sequence should be inferred from the below orderNumber. # Corresponds to the JSON property `bookDisplayNumber` # @return [String] attr_accessor :book_display_number @@ -4377,8 +4523,8 @@ module Google # @return [Fixnum] attr_accessor :order_number - # The book type in the context of series. Examples - Single Issue, Collection - # Edition, etc. + # The book type in the context of series. Examples - Single Issue, + # Collection Edition, etc. # Corresponds to the JSON property `seriesBookType` # @return [String] attr_accessor :series_book_type diff --git a/generated/google/apis/books_v1/representations.rb b/generated/google/apis/books_v1/representations.rb index 48e627187..05fd0ae4c 100644 --- a/generated/google/apis/books_v1/representations.rb +++ b/generated/google/apis/books_v1/representations.rb @@ -46,12 +46,6 @@ module Google include Google::Apis::Core::JsonObjectSupport end - class AnnotationData - class Representation < Google::Apis::Core::JsonRepresentation; end - - include Google::Apis::Core::JsonObjectSupport - end - class Annotations class Representation < Google::Apis::Core::JsonRepresentation; end @@ -88,12 +82,6 @@ module Google include Google::Apis::Core::JsonObjectSupport end - class BooksSubscriptionReleaseInfo - class Representation < Google::Apis::Core::JsonRepresentation; end - - include Google::Apis::Core::JsonObjectSupport - end - class RateRecommendedVolumeResponse class Representation < Google::Apis::Core::JsonRepresentation; end @@ -130,6 +118,12 @@ module Google include Google::Apis::Core::JsonObjectSupport end + class DictionaryAnnotationdata + class Representation < Google::Apis::Core::JsonRepresentation; end + + include Google::Apis::Core::JsonObjectSupport + end + class DictLayerData class Representation < Google::Apis::Core::JsonRepresentation; end @@ -268,6 +262,12 @@ module Google include Google::Apis::Core::JsonObjectSupport end + class Empty + class Representation < Google::Apis::Core::JsonRepresentation; end + + include Google::Apis::Core::JsonObjectSupport + end + class FamilyInfo class Representation < Google::Apis::Core::JsonRepresentation; end @@ -280,6 +280,12 @@ module Google include Google::Apis::Core::JsonObjectSupport end + class GeoAnnotationdata + class Representation < Google::Apis::Core::JsonRepresentation; end + + include Google::Apis::Core::JsonObjectSupport + end + class GeoLayerData class Representation < Google::Apis::Core::JsonRepresentation; end @@ -292,12 +298,6 @@ module Google class Geo class Representation < Google::Apis::Core::JsonRepresentation; end - class Boundary - class Representation < Google::Apis::Core::JsonRepresentation; end - - include Google::Apis::Core::JsonObjectSupport - end - class Viewport class Representation < Google::Apis::Core::JsonRepresentation; end @@ -376,7 +376,7 @@ module Google include Google::Apis::Core::JsonObjectSupport end - class RequestAccess + class RequestAccessData class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport @@ -408,6 +408,18 @@ module Google class SeriesSubscriptionReleaseInfo class Representation < Google::Apis::Core::JsonRepresentation; end + + class CurrentReleaseInfo + class Representation < Google::Apis::Core::JsonRepresentation; end + + include Google::Apis::Core::JsonObjectSupport + end + + class NextReleaseInfo + class Representation < Google::Apis::Core::JsonRepresentation; end + + include Google::Apis::Core::JsonObjectSupport + end include Google::Apis::Core::JsonObjectSupport end @@ -615,6 +627,12 @@ module Google include Google::Apis::Core::JsonObjectSupport end + + class ReadingModes + class Representation < Google::Apis::Core::JsonRepresentation; end + + include Google::Apis::Core::JsonObjectSupport + end include Google::Apis::Core::JsonObjectSupport end @@ -677,8 +695,7 @@ module Google property :before_selected_text, as: 'beforeSelectedText' property :client_version_ranges, as: 'clientVersionRanges', class: Google::Apis::BooksV1::Annotation::ClientVersionRanges, decorator: Google::Apis::BooksV1::Annotation::ClientVersionRanges::Representation - property :created, as: 'created', type: DateTime - + property :created, as: 'created' property :current_version_ranges, as: 'currentVersionRanges', class: Google::Apis::BooksV1::Annotation::CurrentVersionRanges, decorator: Google::Apis::BooksV1::Annotation::CurrentVersionRanges::Representation property :data, as: 'data' @@ -692,8 +709,7 @@ module Google collection :page_ids, as: 'pageIds' property :selected_text, as: 'selectedText' property :self_link, as: 'selfLink' - property :updated, as: 'updated', type: DateTime - + property :updated, as: 'updated' property :volume_id, as: 'volumeId' end @@ -737,22 +753,6 @@ module Google end end - class AnnotationData - # @private - class Representation < Google::Apis::Core::JsonRepresentation - property :annotation_type, as: 'annotationType' - property :data, as: 'data' - property :encoded_data, :base64 => true, as: 'encoded_data' - property :id, as: 'id' - property :kind, as: 'kind' - property :layer_id, as: 'layerId' - property :self_link, as: 'selfLink' - property :updated, as: 'updated', type: DateTime - - property :volume_id, as: 'volumeId' - end - end - class Annotations # @private class Representation < Google::Apis::Core::JsonRepresentation @@ -779,8 +779,7 @@ module Google property :layer_id, as: 'layerId' property :limit_type, as: 'limitType' property :remaining_character_count, as: 'remainingCharacterCount' - property :updated, as: 'updated', type: DateTime - + property :updated, as: 'updated' end end end @@ -788,7 +787,7 @@ module Google class AnnotationsData # @private class Representation < Google::Apis::Core::JsonRepresentation - collection :items, as: 'items', class: Google::Apis::BooksV1::AnnotationData, decorator: Google::Apis::BooksV1::AnnotationData::Representation + collection :items, as: 'items', class: Google::Apis::BooksV1::GeoAnnotationdata, decorator: Google::Apis::BooksV1::GeoAnnotationdata::Representation property :kind, as: 'kind' property :next_page_token, as: 'nextPageToken' @@ -816,16 +815,6 @@ module Google end end - class BooksSubscriptionReleaseInfo - # @private - class Representation < Google::Apis::Core::JsonRepresentation - property :amount_in_micros, :numeric_string => true, as: 'amountInMicros' - property :currency_code, as: 'currencyCode' - property :release_number, as: 'releaseNumber' - property :release_timestamp_us, :numeric_string => true, as: 'releaseTimestampUs' - end - end - class RateRecommendedVolumeResponse # @private class Representation < Google::Apis::Core::JsonRepresentation @@ -837,18 +826,15 @@ module Google # @private class Representation < Google::Apis::Core::JsonRepresentation property :access, as: 'access' - property :created, as: 'created', type: DateTime - + property :created, as: 'created' property :description, as: 'description' property :id, as: 'id' property :kind, as: 'kind' property :self_link, as: 'selfLink' property :title, as: 'title' - property :updated, as: 'updated', type: DateTime - + property :updated, as: 'updated' property :volume_count, as: 'volumeCount' - property :volumes_last_updated, as: 'volumesLastUpdated', type: DateTime - + property :volumes_last_updated, as: 'volumesLastUpdated' end end @@ -896,6 +882,22 @@ module Google end end + class DictionaryAnnotationdata + # @private + class Representation < Google::Apis::Core::JsonRepresentation + property :annotation_type, as: 'annotationType' + property :data, as: 'data', class: Google::Apis::BooksV1::DictLayerData, decorator: Google::Apis::BooksV1::DictLayerData::Representation + + property :encoded_data, :base64 => true, as: 'encodedData' + property :id, as: 'id' + property :kind, as: 'kind' + property :layer_id, as: 'layerId' + property :self_link, as: 'selfLink' + property :updated, as: 'updated' + property :volume_id, as: 'volumeId' + end + end + class DictLayerData # @private class Representation < Google::Apis::Core::JsonRepresentation @@ -1128,6 +1130,12 @@ module Google end end + class Empty + # @private + class Representation < Google::Apis::Core::JsonRepresentation + end + end + class FamilyInfo # @private class Representation < Google::Apis::Core::JsonRepresentation @@ -1148,6 +1156,22 @@ module Google end end + class GeoAnnotationdata + # @private + class Representation < Google::Apis::Core::JsonRepresentation + property :annotation_type, as: 'annotationType' + property :data, as: 'data', class: Google::Apis::BooksV1::GeoLayerData, decorator: Google::Apis::BooksV1::GeoLayerData::Representation + + property :encoded_data, :base64 => true, as: 'encodedData' + property :id, as: 'id' + property :kind, as: 'kind' + property :layer_id, as: 'layerId' + property :self_link, as: 'selfLink' + property :updated, as: 'updated' + property :volume_id, as: 'volumeId' + end + end + class GeoLayerData # @private class Representation < Google::Apis::Core::JsonRepresentation @@ -1172,12 +1196,7 @@ module Google class Geo # @private class Representation < Google::Apis::Core::JsonRepresentation - collection :boundary, as: 'boundary', :class => Array do - include Representable::JSON::Collection - items class: Google::Apis::BooksV1::GeoLayerData::Geo::Boundary, decorator: Google::Apis::BooksV1::GeoLayerData::Geo::Boundary::Representation - - end - + collection :boundary, as: 'boundary' property :cache_policy, as: 'cachePolicy' property :country_code, as: 'countryCode' property :latitude, as: 'latitude' @@ -1188,14 +1207,6 @@ module Google property :zoom, as: 'zoom' end - class Boundary - # @private - class Representation < Google::Apis::Core::JsonRepresentation - property :latitude, as: 'latitude' - property :longitude, as: 'longitude' - end - end - class Viewport # @private class Representation < Google::Apis::Core::JsonRepresentation @@ -1247,8 +1258,7 @@ module Google property :kind, as: 'kind' property :layer_id, as: 'layerId' property :self_link, as: 'selfLink' - property :updated, as: 'updated', type: DateTime - + property :updated, as: 'updated' property :volume_annotations_version, as: 'volumeAnnotationsVersion' property :volume_id, as: 'volumeId' end @@ -1336,13 +1346,12 @@ module Google property :gb_text_position, as: 'gbTextPosition' property :kind, as: 'kind' property :pdf_position, as: 'pdfPosition' - property :updated, as: 'updated', type: DateTime - + property :updated, as: 'updated' property :volume_id, as: 'volumeId' end end - class RequestAccess + class RequestAccessData # @private class Representation < Google::Apis::Core::JsonRepresentation property :concurrent_access, as: 'concurrentAccess', class: Google::Apis::BooksV1::ConcurrentAccessRestriction, decorator: Google::Apis::BooksV1::ConcurrentAccessRestriction::Representation @@ -1414,13 +1423,33 @@ module Google class SeriesSubscriptionReleaseInfo # @private class Representation < Google::Apis::Core::JsonRepresentation - property :cancellation_timestamp_us, :numeric_string => true, as: 'cancellationTimestampUs' - property :current_release_info, as: 'currentReleaseInfo', class: Google::Apis::BooksV1::BooksSubscriptionReleaseInfo, decorator: Google::Apis::BooksV1::BooksSubscriptionReleaseInfo::Representation + property :cancel_time, as: 'cancelTime' + property :current_release_info, as: 'currentReleaseInfo', class: Google::Apis::BooksV1::Series::Series::SeriesSubscriptionReleaseInfo::CurrentReleaseInfo, decorator: Google::Apis::BooksV1::Series::Series::SeriesSubscriptionReleaseInfo::CurrentReleaseInfo::Representation - property :next_release_info, as: 'nextReleaseInfo', class: Google::Apis::BooksV1::BooksSubscriptionReleaseInfo, decorator: Google::Apis::BooksV1::BooksSubscriptionReleaseInfo::Representation + property :next_release_info, as: 'nextReleaseInfo', class: Google::Apis::BooksV1::Series::Series::SeriesSubscriptionReleaseInfo::NextReleaseInfo, decorator: Google::Apis::BooksV1::Series::Series::SeriesSubscriptionReleaseInfo::NextReleaseInfo::Representation property :series_subscription_type, as: 'seriesSubscriptionType' end + + class CurrentReleaseInfo + # @private + class Representation < Google::Apis::Core::JsonRepresentation + property :amount_in_micros, as: 'amountInMicros' + property :currency_code, as: 'currencyCode' + property :release_number, as: 'releaseNumber' + property :release_time, as: 'releaseTime' + end + end + + class NextReleaseInfo + # @private + class Representation < Google::Apis::Core::JsonRepresentation + property :amount_in_micros, as: 'amountInMicros' + property :currency_code, as: 'currencyCode' + property :release_number, as: 'releaseNumber' + property :release_time, as: 'releaseTime' + end + end end end end @@ -1602,8 +1631,7 @@ module Google collection :offers, as: 'offers', class: Google::Apis::BooksV1::Volume::SaleInfo::Offer, decorator: Google::Apis::BooksV1::Volume::SaleInfo::Offer::Representation - property :on_sale_date, as: 'onSaleDate', type: DateTime - + property :on_sale_date, as: 'onSaleDate' property :retail_price, as: 'retailPrice', class: Google::Apis::BooksV1::Volume::SaleInfo::RetailPrice, decorator: Google::Apis::BooksV1::Volume::SaleInfo::RetailPrice::Representation property :saleability, as: 'saleability' @@ -1674,8 +1702,7 @@ module Google class UserInfo # @private class Representation < Google::Apis::Core::JsonRepresentation - property :acquired_time, as: 'acquiredTime', type: DateTime - + property :acquired_time, as: 'acquiredTime' property :acquisition_type, as: 'acquisitionType' property :copy, as: 'copy', class: Google::Apis::BooksV1::Volume::UserInfo::Copy, decorator: Google::Apis::BooksV1::Volume::UserInfo::Copy::Representation @@ -1697,8 +1724,7 @@ module Google property :rental_state, as: 'rentalState' property :review, as: 'review', class: Google::Apis::BooksV1::Review, decorator: Google::Apis::BooksV1::Review::Representation - property :updated, as: 'updated', type: DateTime - + property :updated, as: 'updated' property :user_uploaded_volume_info, as: 'userUploadedVolumeInfo', class: Google::Apis::BooksV1::Volume::UserInfo::UserUploadedVolumeInfo, decorator: Google::Apis::BooksV1::Volume::UserInfo::UserUploadedVolumeInfo::Representation end @@ -1709,8 +1735,7 @@ module Google property :allowed_character_count, as: 'allowedCharacterCount' property :limit_type, as: 'limitType' property :remaining_character_count, as: 'remainingCharacterCount' - property :updated, as: 'updated', type: DateTime - + property :updated, as: 'updated' end end @@ -1769,7 +1794,8 @@ module Google property :published_date, as: 'publishedDate' property :publisher, as: 'publisher' property :ratings_count, as: 'ratingsCount' - property :reading_modes, as: 'readingModes' + property :reading_modes, as: 'readingModes', class: Google::Apis::BooksV1::Volume::VolumeInfo::ReadingModes, decorator: Google::Apis::BooksV1::Volume::VolumeInfo::ReadingModes::Representation + property :sample_page_count, as: 'samplePageCount' property :series_info, as: 'seriesInfo', class: Google::Apis::BooksV1::Volumeseriesinfo, decorator: Google::Apis::BooksV1::Volumeseriesinfo::Representation @@ -1815,6 +1841,14 @@ module Google property :image_bubble_version, as: 'imageBubbleVersion' end end + + class ReadingModes + # @private + class Representation < Google::Apis::Core::JsonRepresentation + property :image, as: 'image' + property :text, as: 'text' + end + end end end @@ -1844,8 +1878,7 @@ module Google collection :page_ids, as: 'pageIds' property :selected_text, as: 'selectedText' property :self_link, as: 'selfLink' - property :updated, as: 'updated', type: DateTime - + property :updated, as: 'updated' property :volume_id, as: 'volumeId' end diff --git a/generated/google/apis/books_v1/service.rb b/generated/google/apis/books_v1/service.rb index 900ab4df2..0624d6d44 100644 --- a/generated/google/apis/books_v1/service.rb +++ b/generated/google/apis/books_v1/service.rb @@ -22,7 +22,7 @@ module Google module BooksV1 # Books API # - # Searches for books and manages your Google Books library. + # The Google Books API allows clients to access the Google Books repository. # # @example # require 'google/apis/books_v1' @@ -30,7 +30,7 @@ module Google # Books = Google::Apis::BooksV1 # Alias the module # service = Books::BooksService.new # - # @see https://developers.google.com/books/docs/v1/getting_started + # @see https://code.google.com/apis/books/docs/v1/getting_started.html class BooksService < Google::Apis::Core::BaseService # @return [String] # API key. Your API key identifies your project and provides you with API access, @@ -38,17 +38,13 @@ module Google attr_accessor :key # @return [String] - # An opaque string that represents a user for quota purposes. Must not exceed 40 - # characters. + # Available to use for quota purposes for server-side applications. Can be any + # arbitrary string assigned to a user, but should not exceed 40 characters. attr_accessor :quota_user - # @return [String] - # Deprecated. Please use quotaUser instead. - attr_accessor :user_ip - def initialize - super('https://www.googleapis.com/', 'books/v1/') - @batch_path = 'batch/books/v1' + super('https://books.googleapis.com/', '') + @batch_path = 'batch' end # Retrieves metadata for a specific bookshelf for the specified user. @@ -61,10 +57,8 @@ module Google # @param [String] fields # Selector specifying which fields to include in a partial response. # @param [String] quota_user - # An opaque string that represents a user for quota purposes. Must not exceed 40 - # characters. - # @param [String] user_ip - # Deprecated. Please use quotaUser instead. + # Available to use for quota purposes for server-side applications. Can be any + # arbitrary string assigned to a user, but should not exceed 40 characters. # @param [Google::Apis::RequestOptions] options # Request-specific options # @@ -77,8 +71,8 @@ module Google # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification # @raise [Google::Apis::AuthorizationError] Authorization is required - def get_bookshelf(user_id, shelf, source: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) - command = make_simple_command(:get, 'users/{userId}/bookshelves/{shelf}', options) + def get_bookshelf(user_id, shelf, source: nil, fields: nil, quota_user: nil, options: nil, &block) + command = make_simple_command(:get, 'books/v1/users/{userId}/bookshelves/{shelf}', options) command.response_representation = Google::Apis::BooksV1::Bookshelf::Representation command.response_class = Google::Apis::BooksV1::Bookshelf command.params['userId'] = user_id unless user_id.nil? @@ -86,7 +80,6 @@ module Google command.query['source'] = source unless source.nil? command.query['fields'] = fields unless fields.nil? command.query['quotaUser'] = quota_user unless quota_user.nil? - command.query['userIp'] = user_ip unless user_ip.nil? execute_or_queue_command(command, &block) end @@ -98,10 +91,8 @@ module Google # @param [String] fields # Selector specifying which fields to include in a partial response. # @param [String] quota_user - # An opaque string that represents a user for quota purposes. Must not exceed 40 - # characters. - # @param [String] user_ip - # Deprecated. Please use quotaUser instead. + # Available to use for quota purposes for server-side applications. Can be any + # arbitrary string assigned to a user, but should not exceed 40 characters. # @param [Google::Apis::RequestOptions] options # Request-specific options # @@ -114,15 +105,14 @@ module Google # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification # @raise [Google::Apis::AuthorizationError] Authorization is required - def list_bookshelves(user_id, source: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) - command = make_simple_command(:get, 'users/{userId}/bookshelves', options) + def list_bookshelves(user_id, source: nil, fields: nil, quota_user: nil, options: nil, &block) + command = make_simple_command(:get, 'books/v1/users/{userId}/bookshelves', options) command.response_representation = Google::Apis::BooksV1::Bookshelves::Representation command.response_class = Google::Apis::BooksV1::Bookshelves command.params['userId'] = user_id unless user_id.nil? command.query['source'] = source unless source.nil? command.query['fields'] = fields unless fields.nil? command.query['quotaUser'] = quota_user unless quota_user.nil? - command.query['userIp'] = user_ip unless user_ip.nil? execute_or_queue_command(command, &block) end @@ -142,10 +132,8 @@ module Google # @param [String] fields # Selector specifying which fields to include in a partial response. # @param [String] quota_user - # An opaque string that represents a user for quota purposes. Must not exceed 40 - # characters. - # @param [String] user_ip - # Deprecated. Please use quotaUser instead. + # Available to use for quota purposes for server-side applications. Can be any + # arbitrary string assigned to a user, but should not exceed 40 characters. # @param [Google::Apis::RequestOptions] options # Request-specific options # @@ -158,8 +146,8 @@ module Google # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification # @raise [Google::Apis::AuthorizationError] Authorization is required - def list_bookshelf_volumes(user_id, shelf, max_results: nil, show_preorders: nil, source: nil, start_index: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) - command = make_simple_command(:get, 'users/{userId}/bookshelves/{shelf}/volumes', options) + def list_bookshelf_volumes(user_id, shelf, max_results: nil, show_preorders: nil, source: nil, start_index: nil, fields: nil, quota_user: nil, options: nil, &block) + command = make_simple_command(:get, 'books/v1/users/{userId}/bookshelves/{shelf}/volumes', options) command.response_representation = Google::Apis::BooksV1::Volumes::Representation command.response_class = Google::Apis::BooksV1::Volumes command.params['userId'] = user_id unless user_id.nil? @@ -170,11 +158,10 @@ module Google command.query['startIndex'] = start_index unless start_index.nil? command.query['fields'] = fields unless fields.nil? command.query['quotaUser'] = quota_user unless quota_user.nil? - command.query['userIp'] = user_ip unless user_ip.nil? execute_or_queue_command(command, &block) end - # + # Add a user-upload volume and triggers processing. # @param [String] drive_document_id # A drive document id. The upload_client_token must not be set. # @param [String] mime_type @@ -182,13 +169,12 @@ module Google # @param [String] name # The document name. It can be set only if the drive_document_id is set. # @param [String] upload_client_token + # Scotty upload token. # @param [String] fields # Selector specifying which fields to include in a partial response. # @param [String] quota_user - # An opaque string that represents a user for quota purposes. Must not exceed 40 - # characters. - # @param [String] user_ip - # Deprecated. Please use quotaUser instead. + # Available to use for quota purposes for server-side applications. Can be any + # arbitrary string assigned to a user, but should not exceed 40 characters. # @param [Google::Apis::RequestOptions] options # Request-specific options # @@ -201,8 +187,8 @@ module Google # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification # @raise [Google::Apis::AuthorizationError] Authorization is required - def add_book(drive_document_id: nil, mime_type: nil, name: nil, upload_client_token: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) - command = make_simple_command(:post, 'cloudloading/addBook', options) + def add_book(drive_document_id: nil, mime_type: nil, name: nil, upload_client_token: nil, fields: nil, quota_user: nil, options: nil, &block) + command = make_simple_command(:post, 'books/v1/cloudloading/addBook', options) command.response_representation = Google::Apis::BooksV1::LoadingResource::Representation command.response_class = Google::Apis::BooksV1::LoadingResource command.query['drive_document_id'] = drive_document_id unless drive_document_id.nil? @@ -211,7 +197,6 @@ module Google command.query['upload_client_token'] = upload_client_token unless upload_client_token.nil? command.query['fields'] = fields unless fields.nil? command.query['quotaUser'] = quota_user unless quota_user.nil? - command.query['userIp'] = user_ip unless user_ip.nil? execute_or_queue_command(command, &block) end @@ -221,40 +206,37 @@ module Google # @param [String] fields # Selector specifying which fields to include in a partial response. # @param [String] quota_user - # An opaque string that represents a user for quota purposes. Must not exceed 40 - # characters. - # @param [String] user_ip - # Deprecated. Please use quotaUser instead. + # Available to use for quota purposes for server-side applications. Can be any + # arbitrary string assigned to a user, but should not exceed 40 characters. # @param [Google::Apis::RequestOptions] options # Request-specific options # # @yield [result, err] Result & error if block supplied - # @yieldparam result [NilClass] No result returned for this method + # @yieldparam result [Google::Apis::BooksV1::Empty] parsed result object # @yieldparam err [StandardError] error object if request failed # - # @return [void] + # @return [Google::Apis::BooksV1::Empty] # # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification # @raise [Google::Apis::AuthorizationError] Authorization is required - def delete_book(volume_id, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) - command = make_simple_command(:post, 'cloudloading/deleteBook', options) + def delete_book(volume_id: nil, fields: nil, quota_user: nil, options: nil, &block) + command = make_simple_command(:post, 'books/v1/cloudloading/deleteBook', options) + command.response_representation = Google::Apis::BooksV1::Empty::Representation + command.response_class = Google::Apis::BooksV1::Empty command.query['volumeId'] = volume_id unless volume_id.nil? command.query['fields'] = fields unless fields.nil? command.query['quotaUser'] = quota_user unless quota_user.nil? - command.query['userIp'] = user_ip unless user_ip.nil? execute_or_queue_command(command, &block) end - # + # Updates a user-upload volume. # @param [Google::Apis::BooksV1::LoadingResource] loading_resource_object # @param [String] fields # Selector specifying which fields to include in a partial response. # @param [String] quota_user - # An opaque string that represents a user for quota purposes. Must not exceed 40 - # characters. - # @param [String] user_ip - # Deprecated. Please use quotaUser instead. + # Available to use for quota purposes for server-side applications. Can be any + # arbitrary string assigned to a user, but should not exceed 40 characters. # @param [Google::Apis::RequestOptions] options # Request-specific options # @@ -267,15 +249,14 @@ module Google # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification # @raise [Google::Apis::AuthorizationError] Authorization is required - def update_book(loading_resource_object = nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) - command = make_simple_command(:post, 'cloudloading/updateBook', options) + def update_book(loading_resource_object = nil, fields: nil, quota_user: nil, options: nil, &block) + command = make_simple_command(:post, 'books/v1/cloudloading/updateBook', options) command.request_representation = Google::Apis::BooksV1::LoadingResource::Representation command.request_object = loading_resource_object command.response_representation = Google::Apis::BooksV1::LoadingResource::Representation command.response_class = Google::Apis::BooksV1::LoadingResource command.query['fields'] = fields unless fields.nil? command.query['quotaUser'] = quota_user unless quota_user.nil? - command.query['userIp'] = user_ip unless user_ip.nil? execute_or_queue_command(command, &block) end @@ -285,10 +266,8 @@ module Google # @param [String] fields # Selector specifying which fields to include in a partial response. # @param [String] quota_user - # An opaque string that represents a user for quota purposes. Must not exceed 40 - # characters. - # @param [String] user_ip - # Deprecated. Please use quotaUser instead. + # Available to use for quota purposes for server-side applications. Can be any + # arbitrary string assigned to a user, but should not exceed 40 characters. # @param [Google::Apis::RequestOptions] options # Request-specific options # @@ -301,14 +280,13 @@ module Google # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification # @raise [Google::Apis::AuthorizationError] Authorization is required - def list_offline_metadata_dictionary(cpksver, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) - command = make_simple_command(:get, 'dictionary/listOfflineMetadata', options) + def list_offline_metadata_dictionary(cpksver: nil, fields: nil, quota_user: nil, options: nil, &block) + command = make_simple_command(:get, 'books/v1/dictionary/listOfflineMetadata', options) command.response_representation = Google::Apis::BooksV1::Metadata::Representation command.response_class = Google::Apis::BooksV1::Metadata command.query['cpksver'] = cpksver unless cpksver.nil? command.query['fields'] = fields unless fields.nil? command.query['quotaUser'] = quota_user unless quota_user.nil? - command.query['userIp'] = user_ip unless user_ip.nil? execute_or_queue_command(command, &block) end @@ -318,10 +296,8 @@ module Google # @param [String] fields # Selector specifying which fields to include in a partial response. # @param [String] quota_user - # An opaque string that represents a user for quota purposes. Must not exceed 40 - # characters. - # @param [String] user_ip - # Deprecated. Please use quotaUser instead. + # Available to use for quota purposes for server-side applications. Can be any + # arbitrary string assigned to a user, but should not exceed 40 characters. # @param [Google::Apis::RequestOptions] options # Request-specific options # @@ -334,14 +310,13 @@ module Google # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification # @raise [Google::Apis::AuthorizationError] Authorization is required - def get_familysharing_family_info(source: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) - command = make_simple_command(:get, 'familysharing/getFamilyInfo', options) + def get_familysharing_family_info(source: nil, fields: nil, quota_user: nil, options: nil, &block) + command = make_simple_command(:get, 'books/v1/familysharing/getFamilyInfo', options) command.response_representation = Google::Apis::BooksV1::FamilyInfo::Representation command.response_class = Google::Apis::BooksV1::FamilyInfo command.query['source'] = source unless source.nil? command.query['fields'] = fields unless fields.nil? command.query['quotaUser'] = quota_user unless quota_user.nil? - command.query['userIp'] = user_ip unless user_ip.nil? execute_or_queue_command(command, &block) end @@ -356,35 +331,34 @@ module Google # @param [String] fields # Selector specifying which fields to include in a partial response. # @param [String] quota_user - # An opaque string that represents a user for quota purposes. Must not exceed 40 - # characters. - # @param [String] user_ip - # Deprecated. Please use quotaUser instead. + # Available to use for quota purposes for server-side applications. Can be any + # arbitrary string assigned to a user, but should not exceed 40 characters. # @param [Google::Apis::RequestOptions] options # Request-specific options # # @yield [result, err] Result & error if block supplied - # @yieldparam result [NilClass] No result returned for this method + # @yieldparam result [Google::Apis::BooksV1::Empty] parsed result object # @yieldparam err [StandardError] error object if request failed # - # @return [void] + # @return [Google::Apis::BooksV1::Empty] # # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification # @raise [Google::Apis::AuthorizationError] Authorization is required - def share_familysharing(doc_id: nil, source: nil, volume_id: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) - command = make_simple_command(:post, 'familysharing/share', options) + def share_familysharing(doc_id: nil, source: nil, volume_id: nil, fields: nil, quota_user: nil, options: nil, &block) + command = make_simple_command(:post, 'books/v1/familysharing/share', options) + command.response_representation = Google::Apis::BooksV1::Empty::Representation + command.response_class = Google::Apis::BooksV1::Empty command.query['docId'] = doc_id unless doc_id.nil? command.query['source'] = source unless source.nil? command.query['volumeId'] = volume_id unless volume_id.nil? command.query['fields'] = fields unless fields.nil? command.query['quotaUser'] = quota_user unless quota_user.nil? - command.query['userIp'] = user_ip unless user_ip.nil? execute_or_queue_command(command, &block) end - # Initiates revoking content that has already been shared with the user's family. - # Empty response indicates success. + # Initiates revoking content that has already been shared with the user's + # family. Empty response indicates success. # @param [String] doc_id # The docid to unshare. # @param [String] source @@ -394,30 +368,29 @@ module Google # @param [String] fields # Selector specifying which fields to include in a partial response. # @param [String] quota_user - # An opaque string that represents a user for quota purposes. Must not exceed 40 - # characters. - # @param [String] user_ip - # Deprecated. Please use quotaUser instead. + # Available to use for quota purposes for server-side applications. Can be any + # arbitrary string assigned to a user, but should not exceed 40 characters. # @param [Google::Apis::RequestOptions] options # Request-specific options # # @yield [result, err] Result & error if block supplied - # @yieldparam result [NilClass] No result returned for this method + # @yieldparam result [Google::Apis::BooksV1::Empty] parsed result object # @yieldparam err [StandardError] error object if request failed # - # @return [void] + # @return [Google::Apis::BooksV1::Empty] # # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification # @raise [Google::Apis::AuthorizationError] Authorization is required - def unshare_familysharing(doc_id: nil, source: nil, volume_id: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) - command = make_simple_command(:post, 'familysharing/unshare', options) + def unshare_familysharing(doc_id: nil, source: nil, volume_id: nil, fields: nil, quota_user: nil, options: nil, &block) + command = make_simple_command(:post, 'books/v1/familysharing/unshare', options) + command.response_representation = Google::Apis::BooksV1::Empty::Representation + command.response_class = Google::Apis::BooksV1::Empty command.query['docId'] = doc_id unless doc_id.nil? command.query['source'] = source unless source.nil? command.query['volumeId'] = volume_id unless volume_id.nil? command.query['fields'] = fields unless fields.nil? command.query['quotaUser'] = quota_user unless quota_user.nil? - command.query['userIp'] = user_ip unless user_ip.nil? execute_or_queue_command(command, &block) end @@ -433,10 +406,8 @@ module Google # @param [String] fields # Selector specifying which fields to include in a partial response. # @param [String] quota_user - # An opaque string that represents a user for quota purposes. Must not exceed 40 - # characters. - # @param [String] user_ip - # Deprecated. Please use quotaUser instead. + # Available to use for quota purposes for server-side applications. Can be any + # arbitrary string assigned to a user, but should not exceed 40 characters. # @param [Google::Apis::RequestOptions] options # Request-specific options # @@ -449,8 +420,8 @@ module Google # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification # @raise [Google::Apis::AuthorizationError] Authorization is required - def get_layer(volume_id, summary_id, content_version: nil, source: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) - command = make_simple_command(:get, 'volumes/{volumeId}/layersummary/{summaryId}', options) + def get_layer(volume_id, summary_id, content_version: nil, source: nil, fields: nil, quota_user: nil, options: nil, &block) + command = make_simple_command(:get, 'books/v1/volumes/{volumeId}/layersummary/{summaryId}', options) command.response_representation = Google::Apis::BooksV1::LayerSummary::Representation command.response_class = Google::Apis::BooksV1::LayerSummary command.params['volumeId'] = volume_id unless volume_id.nil? @@ -459,7 +430,6 @@ module Google command.query['source'] = source unless source.nil? command.query['fields'] = fields unless fields.nil? command.query['quotaUser'] = quota_user unless quota_user.nil? - command.query['userIp'] = user_ip unless user_ip.nil? execute_or_queue_command(command, &block) end @@ -477,10 +447,8 @@ module Google # @param [String] fields # Selector specifying which fields to include in a partial response. # @param [String] quota_user - # An opaque string that represents a user for quota purposes. Must not exceed 40 - # characters. - # @param [String] user_ip - # Deprecated. Please use quotaUser instead. + # Available to use for quota purposes for server-side applications. Can be any + # arbitrary string assigned to a user, but should not exceed 40 characters. # @param [Google::Apis::RequestOptions] options # Request-specific options # @@ -493,8 +461,8 @@ module Google # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification # @raise [Google::Apis::AuthorizationError] Authorization is required - def list_layers(volume_id, content_version: nil, max_results: nil, page_token: nil, source: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) - command = make_simple_command(:get, 'volumes/{volumeId}/layersummary', options) + def list_layers(volume_id, content_version: nil, max_results: nil, page_token: nil, source: nil, fields: nil, quota_user: nil, options: nil, &block) + command = make_simple_command(:get, 'books/v1/volumes/{volumeId}/layersummary', options) command.response_representation = Google::Apis::BooksV1::LayerSummaries::Representation command.response_class = Google::Apis::BooksV1::LayerSummaries command.params['volumeId'] = volume_id unless volume_id.nil? @@ -504,7 +472,6 @@ module Google command.query['source'] = source unless source.nil? command.query['fields'] = fields unless fields.nil? command.query['quotaUser'] = quota_user unless quota_user.nil? - command.query['userIp'] = user_ip unless user_ip.nil? execute_or_queue_command(command, &block) end @@ -515,16 +482,16 @@ module Google # The ID for the layer to get the annotations. # @param [String] annotation_data_id # The ID of the annotation data to retrieve. - # @param [String] content_version - # The content version for the volume you are trying to retrieve. # @param [Boolean] allow_web_definitions # For the dictionary layer. Whether or not to allow web definitions. + # @param [String] content_version + # The content version for the volume you are trying to retrieve. # @param [Fixnum] h # The requested pixel height for any images. If height is provided width must # also be provided. # @param [String] locale - # The locale information for the data. ISO-639-1 language and ISO-3166-1 country - # code. Ex: 'en_US'. + # The locale information for the data. ISO-639-1 language and ISO-3166-1 + # country code. Ex: 'en_US'. # @param [Fixnum] scale # The requested scale for the image. # @param [String] source @@ -535,26 +502,24 @@ module Google # @param [String] fields # Selector specifying which fields to include in a partial response. # @param [String] quota_user - # An opaque string that represents a user for quota purposes. Must not exceed 40 - # characters. - # @param [String] user_ip - # Deprecated. Please use quotaUser instead. + # Available to use for quota purposes for server-side applications. Can be any + # arbitrary string assigned to a user, but should not exceed 40 characters. # @param [Google::Apis::RequestOptions] options # Request-specific options # # @yield [result, err] Result & error if block supplied - # @yieldparam result [Google::Apis::BooksV1::AnnotationData] parsed result object + # @yieldparam result [Google::Apis::BooksV1::DictionaryAnnotationdata] parsed result object # @yieldparam err [StandardError] error object if request failed # - # @return [Google::Apis::BooksV1::AnnotationData] + # @return [Google::Apis::BooksV1::DictionaryAnnotationdata] # # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification # @raise [Google::Apis::AuthorizationError] Authorization is required - def get_layer_annotation_data(volume_id, layer_id, annotation_data_id, content_version, allow_web_definitions: nil, h: nil, locale: nil, scale: nil, source: nil, w: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) - command = make_simple_command(:get, 'volumes/{volumeId}/layers/{layerId}/data/{annotationDataId}', options) - command.response_representation = Google::Apis::BooksV1::AnnotationData::Representation - command.response_class = Google::Apis::BooksV1::AnnotationData + def get_layer_annotation_data(volume_id, layer_id, annotation_data_id, allow_web_definitions: nil, content_version: nil, h: nil, locale: nil, scale: nil, source: nil, w: nil, fields: nil, quota_user: nil, options: nil, &block) + command = make_simple_command(:get, 'books/v1/volumes/{volumeId}/layers/{layerId}/data/{annotationDataId}', options) + command.response_representation = Google::Apis::BooksV1::DictionaryAnnotationdata::Representation + command.response_class = Google::Apis::BooksV1::DictionaryAnnotationdata command.params['volumeId'] = volume_id unless volume_id.nil? command.params['layerId'] = layer_id unless layer_id.nil? command.params['annotationDataId'] = annotation_data_id unless annotation_data_id.nil? @@ -567,7 +532,6 @@ module Google command.query['w'] = w unless w.nil? command.query['fields'] = fields unless fields.nil? command.query['quotaUser'] = quota_user unless quota_user.nil? - command.query['userIp'] = user_ip unless user_ip.nil? execute_or_queue_command(command, &block) end @@ -576,17 +540,17 @@ module Google # The volume to retrieve annotation data for. # @param [String] layer_id # The ID for the layer to get the annotation data. + # @param [Array, String] annotation_data_id + # The list of Annotation Data Ids to retrieve. Pagination is ignored if this + # is set. # @param [String] content_version # The content version for the requested volume. - # @param [Array, String] annotation_data_id - # The list of Annotation Data Ids to retrieve. Pagination is ignored if this is - # set. # @param [Fixnum] h # The requested pixel height for any images. If height is provided width must # also be provided. # @param [String] locale - # The locale information for the data. ISO-639-1 language and ISO-3166-1 country - # code. Ex: 'en_US'. + # The locale information for the data. ISO-639-1 language and ISO-3166-1 + # country code. Ex: 'en_US'. # @param [Fixnum] max_results # Maximum number of results to return # @param [String] page_token @@ -596,21 +560,19 @@ module Google # @param [String] source # String to identify the originator of this request. # @param [String] updated_max - # RFC 3339 timestamp to restrict to items updated prior to this timestamp ( - # exclusive). + # RFC 3339 timestamp to restrict to items updated prior to this timestamp + # (exclusive). # @param [String] updated_min - # RFC 3339 timestamp to restrict to items updated since this timestamp ( - # inclusive). + # RFC 3339 timestamp to restrict to items updated since this timestamp + # (inclusive). # @param [Fixnum] w # The requested pixel width for any images. If width is provided height must # also be provided. # @param [String] fields # Selector specifying which fields to include in a partial response. # @param [String] quota_user - # An opaque string that represents a user for quota purposes. Must not exceed 40 - # characters. - # @param [String] user_ip - # Deprecated. Please use quotaUser instead. + # Available to use for quota purposes for server-side applications. Can be any + # arbitrary string assigned to a user, but should not exceed 40 characters. # @param [Google::Apis::RequestOptions] options # Request-specific options # @@ -623,8 +585,8 @@ module Google # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification # @raise [Google::Apis::AuthorizationError] Authorization is required - def list_layer_annotation_data(volume_id, layer_id, content_version, annotation_data_id: nil, h: nil, locale: nil, max_results: nil, page_token: nil, scale: nil, source: nil, updated_max: nil, updated_min: nil, w: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) - command = make_simple_command(:get, 'volumes/{volumeId}/layers/{layerId}/data', options) + def list_layer_annotation_data(volume_id, layer_id, annotation_data_id: nil, content_version: nil, h: nil, locale: nil, max_results: nil, page_token: nil, scale: nil, source: nil, updated_max: nil, updated_min: nil, w: nil, fields: nil, quota_user: nil, options: nil, &block) + command = make_simple_command(:get, 'books/v1/volumes/{volumeId}/layers/{layerId}/data', options) command.response_representation = Google::Apis::BooksV1::AnnotationsData::Representation command.response_class = Google::Apis::BooksV1::AnnotationsData command.params['volumeId'] = volume_id unless volume_id.nil? @@ -642,7 +604,6 @@ module Google command.query['w'] = w unless w.nil? command.query['fields'] = fields unless fields.nil? command.query['quotaUser'] = quota_user unless quota_user.nil? - command.query['userIp'] = user_ip unless user_ip.nil? execute_or_queue_command(command, &block) end @@ -654,17 +615,15 @@ module Google # @param [String] annotation_id # The ID of the volume annotation to retrieve. # @param [String] locale - # The locale information for the data. ISO-639-1 language and ISO-3166-1 country - # code. Ex: 'en_US'. + # The locale information for the data. ISO-639-1 language and ISO-3166-1 + # country code. Ex: 'en_US'. # @param [String] source # String to identify the originator of this request. # @param [String] fields # Selector specifying which fields to include in a partial response. # @param [String] quota_user - # An opaque string that represents a user for quota purposes. Must not exceed 40 - # characters. - # @param [String] user_ip - # Deprecated. Please use quotaUser instead. + # Available to use for quota purposes for server-side applications. Can be any + # arbitrary string assigned to a user, but should not exceed 40 characters. # @param [Google::Apis::RequestOptions] options # Request-specific options # @@ -677,8 +636,8 @@ module Google # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification # @raise [Google::Apis::AuthorizationError] Authorization is required - def get_layer_volume_annotation(volume_id, layer_id, annotation_id, locale: nil, source: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) - command = make_simple_command(:get, 'volumes/{volumeId}/layers/{layerId}/annotations/{annotationId}', options) + def get_layer_volume_annotation(volume_id, layer_id, annotation_id, locale: nil, source: nil, fields: nil, quota_user: nil, options: nil, &block) + command = make_simple_command(:get, 'books/v1/volumes/{volumeId}/layers/{layerId}/annotations/{annotationId}', options) command.response_representation = Google::Apis::BooksV1::VolumeAnnotation::Representation command.response_class = Google::Apis::BooksV1::VolumeAnnotation command.params['volumeId'] = volume_id unless volume_id.nil? @@ -688,7 +647,6 @@ module Google command.query['source'] = source unless source.nil? command.query['fields'] = fields unless fields.nil? command.query['quotaUser'] = quota_user unless quota_user.nil? - command.query['userIp'] = user_ip unless user_ip.nil? execute_or_queue_command(command, &block) end @@ -704,15 +662,15 @@ module Google # @param [String] end_position # The end position to end retrieving data from. # @param [String] locale - # The locale information for the data. ISO-639-1 language and ISO-3166-1 country - # code. Ex: 'en_US'. + # The locale information for the data. ISO-639-1 language and ISO-3166-1 + # country code. Ex: 'en_US'. # @param [Fixnum] max_results # Maximum number of results to return # @param [String] page_token # The value of the nextToken from the previous page. # @param [Boolean] show_deleted - # Set to true to return deleted annotations. updatedMin must be in the request - # to use this. Defaults to false. + # Set to true to return deleted annotations. updatedMin must be in the + # request to use this. Defaults to false. # @param [String] source # String to identify the originator of this request. # @param [String] start_offset @@ -720,20 +678,18 @@ module Google # @param [String] start_position # The start position to start retrieving data from. # @param [String] updated_max - # RFC 3339 timestamp to restrict to items updated prior to this timestamp ( - # exclusive). + # RFC 3339 timestamp to restrict to items updated prior to this timestamp + # (exclusive). # @param [String] updated_min - # RFC 3339 timestamp to restrict to items updated since this timestamp ( - # inclusive). + # RFC 3339 timestamp to restrict to items updated since this timestamp + # (inclusive). # @param [String] volume_annotations_version # The version of the volume annotations that you are requesting. # @param [String] fields # Selector specifying which fields to include in a partial response. # @param [String] quota_user - # An opaque string that represents a user for quota purposes. Must not exceed 40 - # characters. - # @param [String] user_ip - # Deprecated. Please use quotaUser instead. + # Available to use for quota purposes for server-side applications. Can be any + # arbitrary string assigned to a user, but should not exceed 40 characters. # @param [Google::Apis::RequestOptions] options # Request-specific options # @@ -746,8 +702,8 @@ module Google # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification # @raise [Google::Apis::AuthorizationError] Authorization is required - def list_layer_volume_annotations(volume_id, layer_id, content_version, end_offset: nil, end_position: nil, locale: nil, max_results: nil, page_token: nil, show_deleted: nil, source: nil, start_offset: nil, start_position: nil, updated_max: nil, updated_min: nil, volume_annotations_version: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) - command = make_simple_command(:get, 'volumes/{volumeId}/layers/{layerId}', options) + def list_layer_volume_annotations(volume_id, layer_id, content_version: nil, end_offset: nil, end_position: nil, locale: nil, max_results: nil, page_token: nil, show_deleted: nil, source: nil, start_offset: nil, start_position: nil, updated_max: nil, updated_min: nil, volume_annotations_version: nil, fields: nil, quota_user: nil, options: nil, &block) + command = make_simple_command(:get, 'books/v1/volumes/{volumeId}/layers/{layerId}', options) command.response_representation = Google::Apis::BooksV1::Volumeannotations::Representation command.response_class = Google::Apis::BooksV1::Volumeannotations command.params['volumeId'] = volume_id unless volume_id.nil? @@ -767,18 +723,17 @@ module Google command.query['volumeAnnotationsVersion'] = volume_annotations_version unless volume_annotations_version.nil? command.query['fields'] = fields unless fields.nil? command.query['quotaUser'] = quota_user unless quota_user.nil? - command.query['userIp'] = user_ip unless user_ip.nil? execute_or_queue_command(command, &block) end # Gets the current settings for the user. + # @param [String] country + # Unused. Added only to workaround TEX mandatory request template requirement # @param [String] fields # Selector specifying which fields to include in a partial response. # @param [String] quota_user - # An opaque string that represents a user for quota purposes. Must not exceed 40 - # characters. - # @param [String] user_ip - # Deprecated. Please use quotaUser instead. + # Available to use for quota purposes for server-side applications. Can be any + # arbitrary string assigned to a user, but should not exceed 40 characters. # @param [Google::Apis::RequestOptions] options # Request-specific options # @@ -791,32 +746,30 @@ module Google # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification # @raise [Google::Apis::AuthorizationError] Authorization is required - def get_user_settings(fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) - command = make_simple_command(:get, 'myconfig/getUserSettings', options) + def get_user_settings(country: nil, fields: nil, quota_user: nil, options: nil, &block) + command = make_simple_command(:get, 'books/v1/myconfig/getUserSettings', options) command.response_representation = Google::Apis::BooksV1::UserSettings::Representation command.response_class = Google::Apis::BooksV1::UserSettings + command.query['country'] = country unless country.nil? command.query['fields'] = fields unless fields.nil? command.query['quotaUser'] = quota_user unless quota_user.nil? - command.query['userIp'] = user_ip unless user_ip.nil? execute_or_queue_command(command, &block) end # Release downloaded content access restriction. - # @param [Array, String] volume_ids - # The volume(s) to release restrictions for. # @param [String] cpksver # The device/version ID from which to release the restriction. # @param [String] locale # ISO-639-1, ISO-3166-1 codes for message localization, i.e. en_US. # @param [String] source # String to identify the originator of this request. + # @param [Array, String] volume_ids + # The volume(s) to release restrictions for. # @param [String] fields # Selector specifying which fields to include in a partial response. # @param [String] quota_user - # An opaque string that represents a user for quota purposes. Must not exceed 40 - # characters. - # @param [String] user_ip - # Deprecated. Please use quotaUser instead. + # Available to use for quota purposes for server-side applications. Can be any + # arbitrary string assigned to a user, but should not exceed 40 characters. # @param [Google::Apis::RequestOptions] options # Request-specific options # @@ -829,8 +782,8 @@ module Google # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification # @raise [Google::Apis::AuthorizationError] Authorization is required - def release_download_access(volume_ids, cpksver, locale: nil, source: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) - command = make_simple_command(:post, 'myconfig/releaseDownloadAccess', options) + def release_download_access(cpksver: nil, locale: nil, source: nil, volume_ids: nil, fields: nil, quota_user: nil, options: nil, &block) + command = make_simple_command(:post, 'books/v1/myconfig/releaseDownloadAccess', options) command.response_representation = Google::Apis::BooksV1::DownloadAccesses::Representation command.response_class = Google::Apis::BooksV1::DownloadAccesses command.query['cpksver'] = cpksver unless cpksver.nil? @@ -839,46 +792,44 @@ module Google command.query['volumeIds'] = volume_ids unless volume_ids.nil? command.query['fields'] = fields unless fields.nil? command.query['quotaUser'] = quota_user unless quota_user.nil? - command.query['userIp'] = user_ip unless user_ip.nil? execute_or_queue_command(command, &block) end # Request concurrent and download access restrictions. + # @param [String] cpksver + # The device/version ID from which to request the restrictions. + # @param [String] license_types + # The type of access license to request. If not specified, the default is + # BOTH. + # @param [String] locale + # ISO-639-1, ISO-3166-1 codes for message localization, i.e. en_US. + # @param [String] nonce + # The client nonce value. # @param [String] source # String to identify the originator of this request. # @param [String] volume_id # The volume to request concurrent/download restrictions for. - # @param [String] nonce - # The client nonce value. - # @param [String] cpksver - # The device/version ID from which to request the restrictions. - # @param [String] license_types - # The type of access license to request. If not specified, the default is BOTH. - # @param [String] locale - # ISO-639-1, ISO-3166-1 codes for message localization, i.e. en_US. # @param [String] fields # Selector specifying which fields to include in a partial response. # @param [String] quota_user - # An opaque string that represents a user for quota purposes. Must not exceed 40 - # characters. - # @param [String] user_ip - # Deprecated. Please use quotaUser instead. + # Available to use for quota purposes for server-side applications. Can be any + # arbitrary string assigned to a user, but should not exceed 40 characters. # @param [Google::Apis::RequestOptions] options # Request-specific options # # @yield [result, err] Result & error if block supplied - # @yieldparam result [Google::Apis::BooksV1::RequestAccess] parsed result object + # @yieldparam result [Google::Apis::BooksV1::RequestAccessData] parsed result object # @yieldparam err [StandardError] error object if request failed # - # @return [Google::Apis::BooksV1::RequestAccess] + # @return [Google::Apis::BooksV1::RequestAccessData] # # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification # @raise [Google::Apis::AuthorizationError] Authorization is required - def request_access(source, volume_id, nonce, cpksver, license_types: nil, locale: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) - command = make_simple_command(:post, 'myconfig/requestAccess', options) - command.response_representation = Google::Apis::BooksV1::RequestAccess::Representation - command.response_class = Google::Apis::BooksV1::RequestAccess + def request_access(cpksver: nil, license_types: nil, locale: nil, nonce: nil, source: nil, volume_id: nil, fields: nil, quota_user: nil, options: nil, &block) + command = make_simple_command(:post, 'books/v1/myconfig/requestAccess', options) + command.response_representation = Google::Apis::BooksV1::RequestAccessData::Representation + command.response_class = Google::Apis::BooksV1::RequestAccessData command.query['cpksver'] = cpksver unless cpksver.nil? command.query['licenseTypes'] = license_types unless license_types.nil? command.query['locale'] = locale unless locale.nil? @@ -887,15 +838,11 @@ module Google command.query['volumeId'] = volume_id unless volume_id.nil? command.query['fields'] = fields unless fields.nil? command.query['quotaUser'] = quota_user unless quota_user.nil? - command.query['userIp'] = user_ip unless user_ip.nil? execute_or_queue_command(command, &block) end - # Request downloaded content access for specified volumes on the My eBooks shelf. - # @param [String] source - # String to identify the originator of this request. - # @param [String] nonce - # The client nonce value. + # Request downloaded content access for specified volumes on the My eBooks + # shelf. # @param [String] cpksver # The device/version ID from which to release the restriction. # @param [Array, String] features @@ -904,17 +851,19 @@ module Google # Set to true to include non-comics series. Defaults to false. # @param [String] locale # ISO-639-1, ISO-3166-1 codes for message localization, i.e. en_US. + # @param [String] nonce + # The client nonce value. # @param [Boolean] show_preorders # Set to true to show pre-ordered books. Defaults to false. + # @param [String] source + # String to identify the originator of this request. # @param [Array, String] volume_ids # The volume(s) to request download restrictions for. # @param [String] fields # Selector specifying which fields to include in a partial response. # @param [String] quota_user - # An opaque string that represents a user for quota purposes. Must not exceed 40 - # characters. - # @param [String] user_ip - # Deprecated. Please use quotaUser instead. + # Available to use for quota purposes for server-side applications. Can be any + # arbitrary string assigned to a user, but should not exceed 40 characters. # @param [Google::Apis::RequestOptions] options # Request-specific options # @@ -927,8 +876,8 @@ module Google # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification # @raise [Google::Apis::AuthorizationError] Authorization is required - def sync_volume_licenses(source, nonce, cpksver, features: nil, include_non_comics_series: nil, locale: nil, show_preorders: nil, volume_ids: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) - command = make_simple_command(:post, 'myconfig/syncVolumeLicenses', options) + def sync_volume_licenses(cpksver: nil, features: nil, include_non_comics_series: nil, locale: nil, nonce: nil, show_preorders: nil, source: nil, volume_ids: nil, fields: nil, quota_user: nil, options: nil, &block) + command = make_simple_command(:post, 'books/v1/myconfig/syncVolumeLicenses', options) command.response_representation = Google::Apis::BooksV1::Volumes::Representation command.response_class = Google::Apis::BooksV1::Volumes command.query['cpksver'] = cpksver unless cpksver.nil? @@ -941,21 +890,18 @@ module Google command.query['volumeIds'] = volume_ids unless volume_ids.nil? command.query['fields'] = fields unless fields.nil? command.query['quotaUser'] = quota_user unless quota_user.nil? - command.query['userIp'] = user_ip unless user_ip.nil? execute_or_queue_command(command, &block) end # Sets the settings for the user. If a sub-object is specified, it will - # overwrite the existing sub-object stored in the server. Unspecified sub- - # objects will retain the existing value. + # overwrite the existing sub-object stored in the server. Unspecified + # sub-objects will retain the existing value. # @param [Google::Apis::BooksV1::UserSettings] user_settings_object # @param [String] fields # Selector specifying which fields to include in a partial response. # @param [String] quota_user - # An opaque string that represents a user for quota purposes. Must not exceed 40 - # characters. - # @param [String] user_ip - # Deprecated. Please use quotaUser instead. + # Available to use for quota purposes for server-side applications. Can be any + # arbitrary string assigned to a user, but should not exceed 40 characters. # @param [Google::Apis::RequestOptions] options # Request-specific options # @@ -968,15 +914,14 @@ module Google # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification # @raise [Google::Apis::AuthorizationError] Authorization is required - def update_user_settings(user_settings_object = nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) - command = make_simple_command(:post, 'myconfig/updateUserSettings', options) + def update_user_settings(user_settings_object = nil, fields: nil, quota_user: nil, options: nil, &block) + command = make_simple_command(:post, 'books/v1/myconfig/updateUserSettings', options) command.request_representation = Google::Apis::BooksV1::UserSettings::Representation command.request_object = user_settings_object command.response_representation = Google::Apis::BooksV1::UserSettings::Representation command.response_class = Google::Apis::BooksV1::UserSettings command.query['fields'] = fields unless fields.nil? command.query['quotaUser'] = quota_user unless quota_user.nil? - command.query['userIp'] = user_ip unless user_ip.nil? execute_or_queue_command(command, &block) end @@ -988,29 +933,28 @@ module Google # @param [String] fields # Selector specifying which fields to include in a partial response. # @param [String] quota_user - # An opaque string that represents a user for quota purposes. Must not exceed 40 - # characters. - # @param [String] user_ip - # Deprecated. Please use quotaUser instead. + # Available to use for quota purposes for server-side applications. Can be any + # arbitrary string assigned to a user, but should not exceed 40 characters. # @param [Google::Apis::RequestOptions] options # Request-specific options # # @yield [result, err] Result & error if block supplied - # @yieldparam result [NilClass] No result returned for this method + # @yieldparam result [Google::Apis::BooksV1::Empty] parsed result object # @yieldparam err [StandardError] error object if request failed # - # @return [void] + # @return [Google::Apis::BooksV1::Empty] # # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification # @raise [Google::Apis::AuthorizationError] Authorization is required - def delete_my_library_annotation(annotation_id, source: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) - command = make_simple_command(:delete, 'mylibrary/annotations/{annotationId}', options) + def delete_my_library_annotation(annotation_id, source: nil, fields: nil, quota_user: nil, options: nil, &block) + command = make_simple_command(:delete, 'books/v1/mylibrary/annotations/{annotationId}', options) + command.response_representation = Google::Apis::BooksV1::Empty::Representation + command.response_class = Google::Apis::BooksV1::Empty command.params['annotationId'] = annotation_id unless annotation_id.nil? command.query['source'] = source unless source.nil? command.query['fields'] = fields unless fields.nil? command.query['quotaUser'] = quota_user unless quota_user.nil? - command.query['userIp'] = user_ip unless user_ip.nil? execute_or_queue_command(command, &block) end @@ -1028,10 +972,8 @@ module Google # @param [String] fields # Selector specifying which fields to include in a partial response. # @param [String] quota_user - # An opaque string that represents a user for quota purposes. Must not exceed 40 - # characters. - # @param [String] user_ip - # Deprecated. Please use quotaUser instead. + # Available to use for quota purposes for server-side applications. Can be any + # arbitrary string assigned to a user, but should not exceed 40 characters. # @param [Google::Apis::RequestOptions] options # Request-specific options # @@ -1044,8 +986,8 @@ module Google # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification # @raise [Google::Apis::AuthorizationError] Authorization is required - def insert_my_library_annotation(annotation_object = nil, annotation_id: nil, country: nil, show_only_summary_in_response: nil, source: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) - command = make_simple_command(:post, 'mylibrary/annotations', options) + def insert_my_library_annotation(annotation_object = nil, annotation_id: nil, country: nil, show_only_summary_in_response: nil, source: nil, fields: nil, quota_user: nil, options: nil, &block) + command = make_simple_command(:post, 'books/v1/mylibrary/annotations', options) command.request_representation = Google::Apis::BooksV1::Annotation::Representation command.request_object = annotation_object command.response_representation = Google::Apis::BooksV1::Annotation::Representation @@ -1056,7 +998,6 @@ module Google command.query['source'] = source unless source.nil? command.query['fields'] = fields unless fields.nil? command.query['quotaUser'] = quota_user unless quota_user.nil? - command.query['userIp'] = user_ip unless user_ip.nil? execute_or_queue_command(command, &block) end @@ -1072,25 +1013,23 @@ module Google # @param [String] page_token # The value of the nextToken from the previous page. # @param [Boolean] show_deleted - # Set to true to return deleted annotations. updatedMin must be in the request - # to use this. Defaults to false. + # Set to true to return deleted annotations. updatedMin must be in the + # request to use this. Defaults to false. # @param [String] source # String to identify the originator of this request. # @param [String] updated_max - # RFC 3339 timestamp to restrict to items updated prior to this timestamp ( - # exclusive). + # RFC 3339 timestamp to restrict to items updated prior to this timestamp + # (exclusive). # @param [String] updated_min - # RFC 3339 timestamp to restrict to items updated since this timestamp ( - # inclusive). + # RFC 3339 timestamp to restrict to items updated since this timestamp + # (inclusive). # @param [String] volume_id # The volume to restrict annotations to. # @param [String] fields # Selector specifying which fields to include in a partial response. # @param [String] quota_user - # An opaque string that represents a user for quota purposes. Must not exceed 40 - # characters. - # @param [String] user_ip - # Deprecated. Please use quotaUser instead. + # Available to use for quota purposes for server-side applications. Can be any + # arbitrary string assigned to a user, but should not exceed 40 characters. # @param [Google::Apis::RequestOptions] options # Request-specific options # @@ -1103,8 +1042,8 @@ module Google # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification # @raise [Google::Apis::AuthorizationError] Authorization is required - def list_my_library_annotations(content_version: nil, layer_id: nil, layer_ids: nil, max_results: nil, page_token: nil, show_deleted: nil, source: nil, updated_max: nil, updated_min: nil, volume_id: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) - command = make_simple_command(:get, 'mylibrary/annotations', options) + def list_my_library_annotations(content_version: nil, layer_id: nil, layer_ids: nil, max_results: nil, page_token: nil, show_deleted: nil, source: nil, updated_max: nil, updated_min: nil, volume_id: nil, fields: nil, quota_user: nil, options: nil, &block) + command = make_simple_command(:get, 'books/v1/mylibrary/annotations', options) command.response_representation = Google::Apis::BooksV1::Annotations::Representation command.response_class = Google::Apis::BooksV1::Annotations command.query['contentVersion'] = content_version unless content_version.nil? @@ -1119,7 +1058,6 @@ module Google command.query['volumeId'] = volume_id unless volume_id.nil? command.query['fields'] = fields unless fields.nil? command.query['quotaUser'] = quota_user unless quota_user.nil? - command.query['userIp'] = user_ip unless user_ip.nil? execute_or_queue_command(command, &block) end @@ -1131,10 +1069,8 @@ module Google # @param [String] fields # Selector specifying which fields to include in a partial response. # @param [String] quota_user - # An opaque string that represents a user for quota purposes. Must not exceed 40 - # characters. - # @param [String] user_ip - # Deprecated. Please use quotaUser instead. + # Available to use for quota purposes for server-side applications. Can be any + # arbitrary string assigned to a user, but should not exceed 40 characters. # @param [Google::Apis::RequestOptions] options # Request-specific options # @@ -1147,15 +1083,14 @@ module Google # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification # @raise [Google::Apis::AuthorizationError] Authorization is required - def summarize_my_library_annotation(layer_ids, volume_id, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) - command = make_simple_command(:post, 'mylibrary/annotations/summary', options) + def summarize_my_library_annotation(layer_ids: nil, volume_id: nil, fields: nil, quota_user: nil, options: nil, &block) + command = make_simple_command(:post, 'books/v1/mylibrary/annotations/summary', options) command.response_representation = Google::Apis::BooksV1::AnnotationsSummary::Representation command.response_class = Google::Apis::BooksV1::AnnotationsSummary command.query['layerIds'] = layer_ids unless layer_ids.nil? command.query['volumeId'] = volume_id unless volume_id.nil? command.query['fields'] = fields unless fields.nil? command.query['quotaUser'] = quota_user unless quota_user.nil? - command.query['userIp'] = user_ip unless user_ip.nil? execute_or_queue_command(command, &block) end @@ -1168,10 +1103,8 @@ module Google # @param [String] fields # Selector specifying which fields to include in a partial response. # @param [String] quota_user - # An opaque string that represents a user for quota purposes. Must not exceed 40 - # characters. - # @param [String] user_ip - # Deprecated. Please use quotaUser instead. + # Available to use for quota purposes for server-side applications. Can be any + # arbitrary string assigned to a user, but should not exceed 40 characters. # @param [Google::Apis::RequestOptions] options # Request-specific options # @@ -1184,8 +1117,8 @@ module Google # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification # @raise [Google::Apis::AuthorizationError] Authorization is required - def update_my_library_annotation(annotation_id, annotation_object = nil, source: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) - command = make_simple_command(:put, 'mylibrary/annotations/{annotationId}', options) + def update_my_library_annotation(annotation_id, annotation_object = nil, source: nil, fields: nil, quota_user: nil, options: nil, &block) + command = make_simple_command(:put, 'books/v1/mylibrary/annotations/{annotationId}', options) command.request_representation = Google::Apis::BooksV1::Annotation::Representation command.request_object = annotation_object command.response_representation = Google::Apis::BooksV1::Annotation::Representation @@ -1194,47 +1127,45 @@ module Google command.query['source'] = source unless source.nil? command.query['fields'] = fields unless fields.nil? command.query['quotaUser'] = quota_user unless quota_user.nil? - command.query['userIp'] = user_ip unless user_ip.nil? execute_or_queue_command(command, &block) end # Adds a volume to a bookshelf. # @param [String] shelf # ID of bookshelf to which to add a volume. - # @param [String] volume_id - # ID of volume to add. # @param [String] reason # The reason for which the book is added to the library. # @param [String] source # String to identify the originator of this request. + # @param [String] volume_id + # ID of volume to add. # @param [String] fields # Selector specifying which fields to include in a partial response. # @param [String] quota_user - # An opaque string that represents a user for quota purposes. Must not exceed 40 - # characters. - # @param [String] user_ip - # Deprecated. Please use quotaUser instead. + # Available to use for quota purposes for server-side applications. Can be any + # arbitrary string assigned to a user, but should not exceed 40 characters. # @param [Google::Apis::RequestOptions] options # Request-specific options # # @yield [result, err] Result & error if block supplied - # @yieldparam result [NilClass] No result returned for this method + # @yieldparam result [Google::Apis::BooksV1::Empty] parsed result object # @yieldparam err [StandardError] error object if request failed # - # @return [void] + # @return [Google::Apis::BooksV1::Empty] # # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification # @raise [Google::Apis::AuthorizationError] Authorization is required - def add_my_library_volume(shelf, volume_id, reason: nil, source: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) - command = make_simple_command(:post, 'mylibrary/bookshelves/{shelf}/addVolume', options) + def add_my_library_volume(shelf, reason: nil, source: nil, volume_id: nil, fields: nil, quota_user: nil, options: nil, &block) + command = make_simple_command(:post, 'books/v1/mylibrary/bookshelves/{shelf}/addVolume', options) + command.response_representation = Google::Apis::BooksV1::Empty::Representation + command.response_class = Google::Apis::BooksV1::Empty command.params['shelf'] = shelf unless shelf.nil? command.query['reason'] = reason unless reason.nil? command.query['source'] = source unless source.nil? command.query['volumeId'] = volume_id unless volume_id.nil? command.query['fields'] = fields unless fields.nil? command.query['quotaUser'] = quota_user unless quota_user.nil? - command.query['userIp'] = user_ip unless user_ip.nil? execute_or_queue_command(command, &block) end @@ -1246,29 +1177,28 @@ module Google # @param [String] fields # Selector specifying which fields to include in a partial response. # @param [String] quota_user - # An opaque string that represents a user for quota purposes. Must not exceed 40 - # characters. - # @param [String] user_ip - # Deprecated. Please use quotaUser instead. + # Available to use for quota purposes for server-side applications. Can be any + # arbitrary string assigned to a user, but should not exceed 40 characters. # @param [Google::Apis::RequestOptions] options # Request-specific options # # @yield [result, err] Result & error if block supplied - # @yieldparam result [NilClass] No result returned for this method + # @yieldparam result [Google::Apis::BooksV1::Empty] parsed result object # @yieldparam err [StandardError] error object if request failed # - # @return [void] + # @return [Google::Apis::BooksV1::Empty] # # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification # @raise [Google::Apis::AuthorizationError] Authorization is required - def clear_my_library_volumes(shelf, source: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) - command = make_simple_command(:post, 'mylibrary/bookshelves/{shelf}/clearVolumes', options) + def clear_my_library_volumes(shelf, source: nil, fields: nil, quota_user: nil, options: nil, &block) + command = make_simple_command(:post, 'books/v1/mylibrary/bookshelves/{shelf}/clearVolumes', options) + command.response_representation = Google::Apis::BooksV1::Empty::Representation + command.response_class = Google::Apis::BooksV1::Empty command.params['shelf'] = shelf unless shelf.nil? command.query['source'] = source unless source.nil? command.query['fields'] = fields unless fields.nil? command.query['quotaUser'] = quota_user unless quota_user.nil? - command.query['userIp'] = user_ip unless user_ip.nil? execute_or_queue_command(command, &block) end @@ -1281,10 +1211,8 @@ module Google # @param [String] fields # Selector specifying which fields to include in a partial response. # @param [String] quota_user - # An opaque string that represents a user for quota purposes. Must not exceed 40 - # characters. - # @param [String] user_ip - # Deprecated. Please use quotaUser instead. + # Available to use for quota purposes for server-side applications. Can be any + # arbitrary string assigned to a user, but should not exceed 40 characters. # @param [Google::Apis::RequestOptions] options # Request-specific options # @@ -1297,15 +1225,14 @@ module Google # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification # @raise [Google::Apis::AuthorizationError] Authorization is required - def get_my_library_bookshelf(shelf, source: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) - command = make_simple_command(:get, 'mylibrary/bookshelves/{shelf}', options) + def get_my_library_bookshelf(shelf, source: nil, fields: nil, quota_user: nil, options: nil, &block) + command = make_simple_command(:get, 'books/v1/mylibrary/bookshelves/{shelf}', options) command.response_representation = Google::Apis::BooksV1::Bookshelf::Representation command.response_class = Google::Apis::BooksV1::Bookshelf command.params['shelf'] = shelf unless shelf.nil? command.query['source'] = source unless source.nil? command.query['fields'] = fields unless fields.nil? command.query['quotaUser'] = quota_user unless quota_user.nil? - command.query['userIp'] = user_ip unless user_ip.nil? execute_or_queue_command(command, &block) end @@ -1315,10 +1242,8 @@ module Google # @param [String] fields # Selector specifying which fields to include in a partial response. # @param [String] quota_user - # An opaque string that represents a user for quota purposes. Must not exceed 40 - # characters. - # @param [String] user_ip - # Deprecated. Please use quotaUser instead. + # Available to use for quota purposes for server-side applications. Can be any + # arbitrary string assigned to a user, but should not exceed 40 characters. # @param [Google::Apis::RequestOptions] options # Request-specific options # @@ -1331,95 +1256,92 @@ module Google # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification # @raise [Google::Apis::AuthorizationError] Authorization is required - def list_my_library_bookshelves(source: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) - command = make_simple_command(:get, 'mylibrary/bookshelves', options) + def list_my_library_bookshelves(source: nil, fields: nil, quota_user: nil, options: nil, &block) + command = make_simple_command(:get, 'books/v1/mylibrary/bookshelves', options) command.response_representation = Google::Apis::BooksV1::Bookshelves::Representation command.response_class = Google::Apis::BooksV1::Bookshelves command.query['source'] = source unless source.nil? command.query['fields'] = fields unless fields.nil? command.query['quotaUser'] = quota_user unless quota_user.nil? - command.query['userIp'] = user_ip unless user_ip.nil? execute_or_queue_command(command, &block) end # Moves a volume within a bookshelf. # @param [String] shelf # ID of bookshelf with the volume. + # @param [String] source + # String to identify the originator of this request. # @param [String] volume_id # ID of volume to move. # @param [Fixnum] volume_position - # Position on shelf to move the item (0 puts the item before the current first - # item, 1 puts it between the first and the second and so on.) - # @param [String] source - # String to identify the originator of this request. + # Position on shelf to move the item (0 puts the item before the current + # first item, 1 puts it between the first and the second and so on.) # @param [String] fields # Selector specifying which fields to include in a partial response. # @param [String] quota_user - # An opaque string that represents a user for quota purposes. Must not exceed 40 - # characters. - # @param [String] user_ip - # Deprecated. Please use quotaUser instead. + # Available to use for quota purposes for server-side applications. Can be any + # arbitrary string assigned to a user, but should not exceed 40 characters. # @param [Google::Apis::RequestOptions] options # Request-specific options # # @yield [result, err] Result & error if block supplied - # @yieldparam result [NilClass] No result returned for this method + # @yieldparam result [Google::Apis::BooksV1::Empty] parsed result object # @yieldparam err [StandardError] error object if request failed # - # @return [void] + # @return [Google::Apis::BooksV1::Empty] # # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification # @raise [Google::Apis::AuthorizationError] Authorization is required - def move_my_library_volume(shelf, volume_id, volume_position, source: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) - command = make_simple_command(:post, 'mylibrary/bookshelves/{shelf}/moveVolume', options) + def move_my_library_volume(shelf, source: nil, volume_id: nil, volume_position: nil, fields: nil, quota_user: nil, options: nil, &block) + command = make_simple_command(:post, 'books/v1/mylibrary/bookshelves/{shelf}/moveVolume', options) + command.response_representation = Google::Apis::BooksV1::Empty::Representation + command.response_class = Google::Apis::BooksV1::Empty command.params['shelf'] = shelf unless shelf.nil? command.query['source'] = source unless source.nil? command.query['volumeId'] = volume_id unless volume_id.nil? command.query['volumePosition'] = volume_position unless volume_position.nil? command.query['fields'] = fields unless fields.nil? command.query['quotaUser'] = quota_user unless quota_user.nil? - command.query['userIp'] = user_ip unless user_ip.nil? execute_or_queue_command(command, &block) end # Removes a volume from a bookshelf. # @param [String] shelf # ID of bookshelf from which to remove a volume. - # @param [String] volume_id - # ID of volume to remove. # @param [String] reason # The reason for which the book is removed from the library. # @param [String] source # String to identify the originator of this request. + # @param [String] volume_id + # ID of volume to remove. # @param [String] fields # Selector specifying which fields to include in a partial response. # @param [String] quota_user - # An opaque string that represents a user for quota purposes. Must not exceed 40 - # characters. - # @param [String] user_ip - # Deprecated. Please use quotaUser instead. + # Available to use for quota purposes for server-side applications. Can be any + # arbitrary string assigned to a user, but should not exceed 40 characters. # @param [Google::Apis::RequestOptions] options # Request-specific options # # @yield [result, err] Result & error if block supplied - # @yieldparam result [NilClass] No result returned for this method + # @yieldparam result [Google::Apis::BooksV1::Empty] parsed result object # @yieldparam err [StandardError] error object if request failed # - # @return [void] + # @return [Google::Apis::BooksV1::Empty] # # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification # @raise [Google::Apis::AuthorizationError] Authorization is required - def remove_my_library_volume(shelf, volume_id, reason: nil, source: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) - command = make_simple_command(:post, 'mylibrary/bookshelves/{shelf}/removeVolume', options) + def remove_my_library_volume(shelf, reason: nil, source: nil, volume_id: nil, fields: nil, quota_user: nil, options: nil, &block) + command = make_simple_command(:post, 'books/v1/mylibrary/bookshelves/{shelf}/removeVolume', options) + command.response_representation = Google::Apis::BooksV1::Empty::Representation + command.response_class = Google::Apis::BooksV1::Empty command.params['shelf'] = shelf unless shelf.nil? command.query['reason'] = reason unless reason.nil? command.query['source'] = source unless source.nil? command.query['volumeId'] = volume_id unless volume_id.nil? command.query['fields'] = fields unless fields.nil? command.query['quotaUser'] = quota_user unless quota_user.nil? - command.query['userIp'] = user_ip unless user_ip.nil? execute_or_queue_command(command, &block) end @@ -1443,10 +1365,8 @@ module Google # @param [String] fields # Selector specifying which fields to include in a partial response. # @param [String] quota_user - # An opaque string that represents a user for quota purposes. Must not exceed 40 - # characters. - # @param [String] user_ip - # Deprecated. Please use quotaUser instead. + # Available to use for quota purposes for server-side applications. Can be any + # arbitrary string assigned to a user, but should not exceed 40 characters. # @param [Google::Apis::RequestOptions] options # Request-specific options # @@ -1459,8 +1379,8 @@ module Google # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification # @raise [Google::Apis::AuthorizationError] Authorization is required - def list_my_library_volumes(shelf, country: nil, max_results: nil, projection: nil, q: nil, show_preorders: nil, source: nil, start_index: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) - command = make_simple_command(:get, 'mylibrary/bookshelves/{shelf}/volumes', options) + def list_my_library_volumes(shelf, country: nil, max_results: nil, projection: nil, q: nil, show_preorders: nil, source: nil, start_index: nil, fields: nil, quota_user: nil, options: nil, &block) + command = make_simple_command(:get, 'books/v1/mylibrary/bookshelves/{shelf}/volumes', options) command.response_representation = Google::Apis::BooksV1::Volumes::Representation command.response_class = Google::Apis::BooksV1::Volumes command.params['shelf'] = shelf unless shelf.nil? @@ -1473,7 +1393,6 @@ module Google command.query['startIndex'] = start_index unless start_index.nil? command.query['fields'] = fields unless fields.nil? command.query['quotaUser'] = quota_user unless quota_user.nil? - command.query['userIp'] = user_ip unless user_ip.nil? execute_or_queue_command(command, &block) end @@ -1487,10 +1406,8 @@ module Google # @param [String] fields # Selector specifying which fields to include in a partial response. # @param [String] quota_user - # An opaque string that represents a user for quota purposes. Must not exceed 40 - # characters. - # @param [String] user_ip - # Deprecated. Please use quotaUser instead. + # Available to use for quota purposes for server-side applications. Can be any + # arbitrary string assigned to a user, but should not exceed 40 characters. # @param [Google::Apis::RequestOptions] options # Request-specific options # @@ -1503,8 +1420,8 @@ module Google # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification # @raise [Google::Apis::AuthorizationError] Authorization is required - def get_my_library_reading_position(volume_id, content_version: nil, source: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) - command = make_simple_command(:get, 'mylibrary/readingpositions/{volumeId}', options) + def get_my_library_reading_position(volume_id, content_version: nil, source: nil, fields: nil, quota_user: nil, options: nil, &block) + command = make_simple_command(:get, 'books/v1/mylibrary/readingpositions/{volumeId}', options) command.response_representation = Google::Apis::BooksV1::ReadingPosition::Representation command.response_class = Google::Apis::BooksV1::ReadingPosition command.params['volumeId'] = volume_id unless volume_id.nil? @@ -1512,46 +1429,45 @@ module Google command.query['source'] = source unless source.nil? command.query['fields'] = fields unless fields.nil? command.query['quotaUser'] = quota_user unless quota_user.nil? - command.query['userIp'] = user_ip unless user_ip.nil? execute_or_queue_command(command, &block) end # Sets my reading position information for a volume. # @param [String] volume_id # ID of volume for which to update the reading position. - # @param [String] timestamp - # RFC 3339 UTC format timestamp associated with this reading position. - # @param [String] position - # Position string for the new volume reading position. # @param [String] action # Action that caused this reading position to be set. # @param [String] content_version # Volume content version for which this reading position applies. # @param [String] device_cookie # Random persistent device cookie optional on set position. + # @param [String] position + # Position string for the new volume reading position. # @param [String] source # String to identify the originator of this request. + # @param [String] timestamp + # RFC 3339 UTC format timestamp associated with this reading position. # @param [String] fields # Selector specifying which fields to include in a partial response. # @param [String] quota_user - # An opaque string that represents a user for quota purposes. Must not exceed 40 - # characters. - # @param [String] user_ip - # Deprecated. Please use quotaUser instead. + # Available to use for quota purposes for server-side applications. Can be any + # arbitrary string assigned to a user, but should not exceed 40 characters. # @param [Google::Apis::RequestOptions] options # Request-specific options # # @yield [result, err] Result & error if block supplied - # @yieldparam result [NilClass] No result returned for this method + # @yieldparam result [Google::Apis::BooksV1::Empty] parsed result object # @yieldparam err [StandardError] error object if request failed # - # @return [void] + # @return [Google::Apis::BooksV1::Empty] # # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification # @raise [Google::Apis::AuthorizationError] Authorization is required - def set_my_library_reading_position(volume_id, timestamp, position, action: nil, content_version: nil, device_cookie: nil, source: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) - command = make_simple_command(:post, 'mylibrary/readingpositions/{volumeId}/setPosition', options) + def set_my_library_reading_position(volume_id, action: nil, content_version: nil, device_cookie: nil, position: nil, source: nil, timestamp: nil, fields: nil, quota_user: nil, options: nil, &block) + command = make_simple_command(:post, 'books/v1/mylibrary/readingpositions/{volumeId}/setPosition', options) + command.response_representation = Google::Apis::BooksV1::Empty::Representation + command.response_class = Google::Apis::BooksV1::Empty command.params['volumeId'] = volume_id unless volume_id.nil? command.query['action'] = action unless action.nil? command.query['contentVersion'] = content_version unless content_version.nil? @@ -1561,25 +1477,22 @@ module Google command.query['timestamp'] = timestamp unless timestamp.nil? command.query['fields'] = fields unless fields.nil? command.query['quotaUser'] = quota_user unless quota_user.nil? - command.query['userIp'] = user_ip unless user_ip.nil? execute_or_queue_command(command, &block) end # Returns notification details for a given notification id. - # @param [String] notification_id - # String to identify the notification. # @param [String] locale # ISO-639-1 language and ISO-3166-1 country code. Ex: 'en_US'. Used for # generating notification title and body. + # @param [String] notification_id + # String to identify the notification. # @param [String] source # String to identify the originator of this request. # @param [String] fields # Selector specifying which fields to include in a partial response. # @param [String] quota_user - # An opaque string that represents a user for quota purposes. Must not exceed 40 - # characters. - # @param [String] user_ip - # Deprecated. Please use quotaUser instead. + # Available to use for quota purposes for server-side applications. Can be any + # arbitrary string assigned to a user, but should not exceed 40 characters. # @param [Google::Apis::RequestOptions] options # Request-specific options # @@ -1592,8 +1505,8 @@ module Google # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification # @raise [Google::Apis::AuthorizationError] Authorization is required - def get_notification(notification_id, locale: nil, source: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) - command = make_simple_command(:get, 'notification/get', options) + def get_notification(locale: nil, notification_id: nil, source: nil, fields: nil, quota_user: nil, options: nil, &block) + command = make_simple_command(:get, 'books/v1/notification/get', options) command.response_representation = Google::Apis::BooksV1::Notification::Representation command.response_class = Google::Apis::BooksV1::Notification command.query['locale'] = locale unless locale.nil? @@ -1601,7 +1514,6 @@ module Google command.query['source'] = source unless source.nil? command.query['fields'] = fields unless fields.nil? command.query['quotaUser'] = quota_user unless quota_user.nil? - command.query['userIp'] = user_ip unless user_ip.nil? execute_or_queue_command(command, &block) end @@ -1611,10 +1523,8 @@ module Google # @param [String] fields # Selector specifying which fields to include in a partial response. # @param [String] quota_user - # An opaque string that represents a user for quota purposes. Must not exceed 40 - # characters. - # @param [String] user_ip - # Deprecated. Please use quotaUser instead. + # Available to use for quota purposes for server-side applications. Can be any + # arbitrary string assigned to a user, but should not exceed 40 characters. # @param [Google::Apis::RequestOptions] options # Request-specific options # @@ -1627,14 +1537,13 @@ module Google # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification # @raise [Google::Apis::AuthorizationError] Authorization is required - def list_onboarding_categories(locale: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) - command = make_simple_command(:get, 'onboarding/listCategories', options) + def list_onboarding_categories(locale: nil, fields: nil, quota_user: nil, options: nil, &block) + command = make_simple_command(:get, 'books/v1/onboarding/listCategories', options) command.response_representation = Google::Apis::BooksV1::Category::Representation command.response_class = Google::Apis::BooksV1::Category command.query['locale'] = locale unless locale.nil? command.query['fields'] = fields unless fields.nil? command.query['quotaUser'] = quota_user unless quota_user.nil? - command.query['userIp'] = user_ip unless user_ip.nil? execute_or_queue_command(command, &block) end @@ -1644,8 +1553,8 @@ module Google # @param [String] locale # ISO-639-1 language and ISO-3166-1 country code. Default is en-US if unset. # @param [String] max_allowed_maturity_rating - # The maximum allowed maturity rating of returned volumes. Books with a higher - # maturity rating are filtered out. + # The maximum allowed maturity rating of returned volumes. Books with a + # higher maturity rating are filtered out. # @param [Fixnum] page_size # Number of maximum results per page to be included in the response. # @param [String] page_token @@ -1653,10 +1562,8 @@ module Google # @param [String] fields # Selector specifying which fields to include in a partial response. # @param [String] quota_user - # An opaque string that represents a user for quota purposes. Must not exceed 40 - # characters. - # @param [String] user_ip - # Deprecated. Please use quotaUser instead. + # Available to use for quota purposes for server-side applications. Can be any + # arbitrary string assigned to a user, but should not exceed 40 characters. # @param [Google::Apis::RequestOptions] options # Request-specific options # @@ -1669,8 +1576,8 @@ module Google # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification # @raise [Google::Apis::AuthorizationError] Authorization is required - def list_onboarding_category_volumes(category_id: nil, locale: nil, max_allowed_maturity_rating: nil, page_size: nil, page_token: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) - command = make_simple_command(:get, 'onboarding/listCategoryVolumes', options) + def list_onboarding_category_volumes(category_id: nil, locale: nil, max_allowed_maturity_rating: nil, page_size: nil, page_token: nil, fields: nil, quota_user: nil, options: nil, &block) + command = make_simple_command(:get, 'books/v1/onboarding/listCategoryVolumes', options) command.response_representation = Google::Apis::BooksV1::Volume2::Representation command.response_class = Google::Apis::BooksV1::Volume2 command.query['categoryId'] = category_id unless category_id.nil? @@ -1680,7 +1587,6 @@ module Google command.query['pageToken'] = page_token unless page_token.nil? command.query['fields'] = fields unless fields.nil? command.query['quotaUser'] = quota_user unless quota_user.nil? - command.query['userIp'] = user_ip unless user_ip.nil? execute_or_queue_command(command, &block) end @@ -1689,17 +1595,15 @@ module Google # ISO-639-1 language and ISO-3166-1 country code. Ex: 'en_US'. Used for # generating recommendations. # @param [String] max_allowed_maturity_rating - # The maximum allowed maturity rating of returned recommendations. Books with a - # higher maturity rating are filtered out. + # The maximum allowed maturity rating of returned recommendations. Books with + # a higher maturity rating are filtered out. # @param [String] source # String to identify the originator of this request. # @param [String] fields # Selector specifying which fields to include in a partial response. # @param [String] quota_user - # An opaque string that represents a user for quota purposes. Must not exceed 40 - # characters. - # @param [String] user_ip - # Deprecated. Please use quotaUser instead. + # Available to use for quota purposes for server-side applications. Can be any + # arbitrary string assigned to a user, but should not exceed 40 characters. # @param [Google::Apis::RequestOptions] options # Request-specific options # @@ -1712,8 +1616,8 @@ module Google # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification # @raise [Google::Apis::AuthorizationError] Authorization is required - def get_personalizedstream(locale: nil, max_allowed_maturity_rating: nil, source: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) - command = make_simple_command(:get, 'personalizedstream/get', options) + def get_personalizedstream(locale: nil, max_allowed_maturity_rating: nil, source: nil, fields: nil, quota_user: nil, options: nil, &block) + command = make_simple_command(:get, 'books/v1/personalizedstream/get', options) command.response_representation = Google::Apis::BooksV1::Discoveryclusters::Representation command.response_class = Google::Apis::BooksV1::Discoveryclusters command.query['locale'] = locale unless locale.nil? @@ -1721,11 +1625,10 @@ module Google command.query['source'] = source unless source.nil? command.query['fields'] = fields unless fields.nil? command.query['quotaUser'] = quota_user unless quota_user.nil? - command.query['userIp'] = user_ip unless user_ip.nil? execute_or_queue_command(command, &block) end - # + # Accepts the promo offer. # @param [String] android_id # device android_id # @param [String] device @@ -1744,24 +1647,24 @@ module Google # @param [String] fields # Selector specifying which fields to include in a partial response. # @param [String] quota_user - # An opaque string that represents a user for quota purposes. Must not exceed 40 - # characters. - # @param [String] user_ip - # Deprecated. Please use quotaUser instead. + # Available to use for quota purposes for server-side applications. Can be any + # arbitrary string assigned to a user, but should not exceed 40 characters. # @param [Google::Apis::RequestOptions] options # Request-specific options # # @yield [result, err] Result & error if block supplied - # @yieldparam result [NilClass] No result returned for this method + # @yieldparam result [Google::Apis::BooksV1::Empty] parsed result object # @yieldparam err [StandardError] error object if request failed # - # @return [void] + # @return [Google::Apis::BooksV1::Empty] # # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification # @raise [Google::Apis::AuthorizationError] Authorization is required - def accept_promo_offer(android_id: nil, device: nil, manufacturer: nil, model: nil, offer_id: nil, product: nil, serial: nil, volume_id: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) - command = make_simple_command(:post, 'promooffer/accept', options) + def accept_promo_offer(android_id: nil, device: nil, manufacturer: nil, model: nil, offer_id: nil, product: nil, serial: nil, volume_id: nil, fields: nil, quota_user: nil, options: nil, &block) + command = make_simple_command(:post, 'books/v1/promooffer/accept', options) + command.response_representation = Google::Apis::BooksV1::Empty::Representation + command.response_class = Google::Apis::BooksV1::Empty command.query['androidId'] = android_id unless android_id.nil? command.query['device'] = device unless device.nil? command.query['manufacturer'] = manufacturer unless manufacturer.nil? @@ -1772,11 +1675,10 @@ module Google command.query['volumeId'] = volume_id unless volume_id.nil? command.query['fields'] = fields unless fields.nil? command.query['quotaUser'] = quota_user unless quota_user.nil? - command.query['userIp'] = user_ip unless user_ip.nil? execute_or_queue_command(command, &block) end - # + # Marks the promo offer as dismissed. # @param [String] android_id # device android_id # @param [String] device @@ -1794,24 +1696,24 @@ module Google # @param [String] fields # Selector specifying which fields to include in a partial response. # @param [String] quota_user - # An opaque string that represents a user for quota purposes. Must not exceed 40 - # characters. - # @param [String] user_ip - # Deprecated. Please use quotaUser instead. + # Available to use for quota purposes for server-side applications. Can be any + # arbitrary string assigned to a user, but should not exceed 40 characters. # @param [Google::Apis::RequestOptions] options # Request-specific options # # @yield [result, err] Result & error if block supplied - # @yieldparam result [NilClass] No result returned for this method + # @yieldparam result [Google::Apis::BooksV1::Empty] parsed result object # @yieldparam err [StandardError] error object if request failed # - # @return [void] + # @return [Google::Apis::BooksV1::Empty] # # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification # @raise [Google::Apis::AuthorizationError] Authorization is required - def dismiss_promo_offer(android_id: nil, device: nil, manufacturer: nil, model: nil, offer_id: nil, product: nil, serial: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) - command = make_simple_command(:post, 'promooffer/dismiss', options) + def dismiss_promo_offer(android_id: nil, device: nil, manufacturer: nil, model: nil, offer_id: nil, product: nil, serial: nil, fields: nil, quota_user: nil, options: nil, &block) + command = make_simple_command(:post, 'books/v1/promooffer/dismiss', options) + command.response_representation = Google::Apis::BooksV1::Empty::Representation + command.response_class = Google::Apis::BooksV1::Empty command.query['androidId'] = android_id unless android_id.nil? command.query['device'] = device unless device.nil? command.query['manufacturer'] = manufacturer unless manufacturer.nil? @@ -1821,7 +1723,6 @@ module Google command.query['serial'] = serial unless serial.nil? command.query['fields'] = fields unless fields.nil? command.query['quotaUser'] = quota_user unless quota_user.nil? - command.query['userIp'] = user_ip unless user_ip.nil? execute_or_queue_command(command, &block) end @@ -1841,10 +1742,8 @@ module Google # @param [String] fields # Selector specifying which fields to include in a partial response. # @param [String] quota_user - # An opaque string that represents a user for quota purposes. Must not exceed 40 - # characters. - # @param [String] user_ip - # Deprecated. Please use quotaUser instead. + # Available to use for quota purposes for server-side applications. Can be any + # arbitrary string assigned to a user, but should not exceed 40 characters. # @param [Google::Apis::RequestOptions] options # Request-specific options # @@ -1857,8 +1756,8 @@ module Google # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification # @raise [Google::Apis::AuthorizationError] Authorization is required - def get_promo_offer(android_id: nil, device: nil, manufacturer: nil, model: nil, product: nil, serial: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) - command = make_simple_command(:get, 'promooffer/get', options) + def get_promo_offer(android_id: nil, device: nil, manufacturer: nil, model: nil, product: nil, serial: nil, fields: nil, quota_user: nil, options: nil, &block) + command = make_simple_command(:get, 'books/v1/promooffer/get', options) command.response_representation = Google::Apis::BooksV1::Offers::Representation command.response_class = Google::Apis::BooksV1::Offers command.query['androidId'] = android_id unless android_id.nil? @@ -1869,7 +1768,6 @@ module Google command.query['serial'] = serial unless serial.nil? command.query['fields'] = fields unless fields.nil? command.query['quotaUser'] = quota_user unless quota_user.nil? - command.query['userIp'] = user_ip unless user_ip.nil? execute_or_queue_command(command, &block) end @@ -1879,10 +1777,8 @@ module Google # @param [String] fields # Selector specifying which fields to include in a partial response. # @param [String] quota_user - # An opaque string that represents a user for quota purposes. Must not exceed 40 - # characters. - # @param [String] user_ip - # Deprecated. Please use quotaUser instead. + # Available to use for quota purposes for server-side applications. Can be any + # arbitrary string assigned to a user, but should not exceed 40 characters. # @param [Google::Apis::RequestOptions] options # Request-specific options # @@ -1895,31 +1791,28 @@ module Google # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification # @raise [Google::Apis::AuthorizationError] Authorization is required - def get_series(series_id, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) - command = make_simple_command(:get, 'series/get', options) + def get_series(series_id: nil, fields: nil, quota_user: nil, options: nil, &block) + command = make_simple_command(:get, 'books/v1/series/get', options) command.response_representation = Google::Apis::BooksV1::Series::Representation command.response_class = Google::Apis::BooksV1::Series command.query['series_id'] = series_id unless series_id.nil? command.query['fields'] = fields unless fields.nil? command.query['quotaUser'] = quota_user unless quota_user.nil? - command.query['userIp'] = user_ip unless user_ip.nil? execute_or_queue_command(command, &block) end # Returns Series membership data given the series id. - # @param [String] series_id - # String that identifies the series # @param [Fixnum] page_size # Number of maximum results per page to be included in the response. # @param [String] page_token # The value of the nextToken from the previous page. + # @param [String] series_id + # String that identifies the series # @param [String] fields # Selector specifying which fields to include in a partial response. # @param [String] quota_user - # An opaque string that represents a user for quota purposes. Must not exceed 40 - # characters. - # @param [String] user_ip - # Deprecated. Please use quotaUser instead. + # Available to use for quota purposes for server-side applications. Can be any + # arbitrary string assigned to a user, but should not exceed 40 characters. # @param [Google::Apis::RequestOptions] options # Request-specific options # @@ -1932,8 +1825,8 @@ module Google # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification # @raise [Google::Apis::AuthorizationError] Authorization is required - def get_series_membership(series_id, page_size: nil, page_token: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) - command = make_simple_command(:get, 'series/membership/get', options) + def get_series_membership(page_size: nil, page_token: nil, series_id: nil, fields: nil, quota_user: nil, options: nil, &block) + command = make_simple_command(:get, 'books/v1/series/membership/get', options) command.response_representation = Google::Apis::BooksV1::SeriesMembership::Representation command.response_class = Google::Apis::BooksV1::SeriesMembership command.query['page_size'] = page_size unless page_size.nil? @@ -1941,7 +1834,6 @@ module Google command.query['series_id'] = series_id unless series_id.nil? command.query['fields'] = fields unless fields.nil? command.query['quotaUser'] = quota_user unless quota_user.nil? - command.query['userIp'] = user_ip unless user_ip.nil? execute_or_queue_command(command, &block) end @@ -1957,15 +1849,13 @@ module Google # @param [String] projection # Restrict information returned to a set of selected fields. # @param [String] source - # String to identify the originator of this request. + # string to identify the originator of this request. # @param [Boolean] user_library_consistent_read # @param [String] fields # Selector specifying which fields to include in a partial response. # @param [String] quota_user - # An opaque string that represents a user for quota purposes. Must not exceed 40 - # characters. - # @param [String] user_ip - # Deprecated. Please use quotaUser instead. + # Available to use for quota purposes for server-side applications. Can be any + # arbitrary string assigned to a user, but should not exceed 40 characters. # @param [Google::Apis::RequestOptions] options # Request-specific options # @@ -1978,8 +1868,8 @@ module Google # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification # @raise [Google::Apis::AuthorizationError] Authorization is required - def get_volume(volume_id, country: nil, include_non_comics_series: nil, partner: nil, projection: nil, source: nil, user_library_consistent_read: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) - command = make_simple_command(:get, 'volumes/{volumeId}', options) + def get_volume(volume_id, country: nil, include_non_comics_series: nil, partner: nil, projection: nil, source: nil, user_library_consistent_read: nil, fields: nil, quota_user: nil, options: nil, &block) + command = make_simple_command(:get, 'books/v1/volumes/{volumeId}', options) command.response_representation = Google::Apis::BooksV1::Volume::Representation command.response_class = Google::Apis::BooksV1::Volume command.params['volumeId'] = volume_id unless volume_id.nil? @@ -1991,13 +1881,10 @@ module Google command.query['user_library_consistent_read'] = user_library_consistent_read unless user_library_consistent_read.nil? command.query['fields'] = fields unless fields.nil? command.query['quotaUser'] = quota_user unless quota_user.nil? - command.query['userIp'] = user_ip unless user_ip.nil? execute_or_queue_command(command, &block) end # Performs a book search. - # @param [String] q - # Full-text search query string. # @param [String] download # Restrict to volumes by download availability. # @param [String] filter @@ -2007,8 +1894,8 @@ module Google # @param [String] library_restrict # Restrict search to this user's library. # @param [String] max_allowed_maturity_rating - # The maximum allowed maturity rating of returned recommendations. Books with a - # higher maturity rating are filtered out. + # The maximum allowed maturity rating of returned recommendations. Books with + # a higher maturity rating are filtered out. # @param [Fixnum] max_results # Maximum number of results to return. # @param [String] order_by @@ -2019,6 +1906,8 @@ module Google # Restrict to books or magazines. # @param [String] projection # Restrict information returned to a set of selected fields. + # @param [String] q + # Full-text search query string. # @param [Boolean] show_preorders # Set to true to show books available for preorder. Defaults to false. # @param [String] source @@ -2028,10 +1917,8 @@ module Google # @param [String] fields # Selector specifying which fields to include in a partial response. # @param [String] quota_user - # An opaque string that represents a user for quota purposes. Must not exceed 40 - # characters. - # @param [String] user_ip - # Deprecated. Please use quotaUser instead. + # Available to use for quota purposes for server-side applications. Can be any + # arbitrary string assigned to a user, but should not exceed 40 characters. # @param [Google::Apis::RequestOptions] options # Request-specific options # @@ -2044,8 +1931,8 @@ module Google # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification # @raise [Google::Apis::AuthorizationError] Authorization is required - def list_volumes(q, download: nil, filter: nil, lang_restrict: nil, library_restrict: nil, max_allowed_maturity_rating: nil, max_results: nil, order_by: nil, partner: nil, print_type: nil, projection: nil, show_preorders: nil, source: nil, start_index: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) - command = make_simple_command(:get, 'volumes', options) + def list_volumes(download: nil, filter: nil, lang_restrict: nil, library_restrict: nil, max_allowed_maturity_rating: nil, max_results: nil, order_by: nil, partner: nil, print_type: nil, projection: nil, q: nil, show_preorders: nil, source: nil, start_index: nil, fields: nil, quota_user: nil, options: nil, &block) + command = make_simple_command(:get, 'books/v1/volumes', options) command.response_representation = Google::Apis::BooksV1::Volumes::Representation command.response_class = Google::Apis::BooksV1::Volumes command.query['download'] = download unless download.nil? @@ -2064,7 +1951,6 @@ module Google command.query['startIndex'] = start_index unless start_index.nil? command.query['fields'] = fields unless fields.nil? command.query['quotaUser'] = quota_user unless quota_user.nil? - command.query['userIp'] = user_ip unless user_ip.nil? execute_or_queue_command(command, &block) end @@ -2077,17 +1963,15 @@ module Google # ISO-639-1 language and ISO-3166-1 country code. Ex: 'en_US'. Used for # generating recommendations. # @param [String] max_allowed_maturity_rating - # The maximum allowed maturity rating of returned recommendations. Books with a - # higher maturity rating are filtered out. + # The maximum allowed maturity rating of returned recommendations. Books with + # a higher maturity rating are filtered out. # @param [String] source # String to identify the originator of this request. # @param [String] fields # Selector specifying which fields to include in a partial response. # @param [String] quota_user - # An opaque string that represents a user for quota purposes. Must not exceed 40 - # characters. - # @param [String] user_ip - # Deprecated. Please use quotaUser instead. + # Available to use for quota purposes for server-side applications. Can be any + # arbitrary string assigned to a user, but should not exceed 40 characters. # @param [Google::Apis::RequestOptions] options # Request-specific options # @@ -2100,8 +1984,8 @@ module Google # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification # @raise [Google::Apis::AuthorizationError] Authorization is required - def list_associated_volumes(volume_id, association: nil, locale: nil, max_allowed_maturity_rating: nil, source: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) - command = make_simple_command(:get, 'volumes/{volumeId}/associated', options) + def list_associated_volumes(volume_id, association: nil, locale: nil, max_allowed_maturity_rating: nil, source: nil, fields: nil, quota_user: nil, options: nil, &block) + command = make_simple_command(:get, 'books/v1/volumes/{volumeId}/associated', options) command.response_representation = Google::Apis::BooksV1::Volumes::Representation command.response_class = Google::Apis::BooksV1::Volumes command.params['volumeId'] = volume_id unless volume_id.nil? @@ -2111,7 +1995,6 @@ module Google command.query['source'] = source unless source.nil? command.query['fields'] = fields unless fields.nil? command.query['quotaUser'] = quota_user unless quota_user.nil? - command.query['userIp'] = user_ip unless user_ip.nil? execute_or_queue_command(command, &block) end @@ -2126,8 +2009,8 @@ module Google # @param [Fixnum] max_results # Maximum number of results to return. # @param [Array, String] processing_state - # The processing state of the user uploaded volumes to be returned. Applicable - # only if the UPLOADED is specified in the acquireMethod. + # The processing state of the user uploaded volumes to be returned. + # Applicable only if the UPLOADED is specified in the acquireMethod. # @param [String] source # String to identify the originator of this request. # @param [Fixnum] start_index @@ -2135,10 +2018,8 @@ module Google # @param [String] fields # Selector specifying which fields to include in a partial response. # @param [String] quota_user - # An opaque string that represents a user for quota purposes. Must not exceed 40 - # characters. - # @param [String] user_ip - # Deprecated. Please use quotaUser instead. + # Available to use for quota purposes for server-side applications. Can be any + # arbitrary string assigned to a user, but should not exceed 40 characters. # @param [Google::Apis::RequestOptions] options # Request-specific options # @@ -2151,8 +2032,8 @@ module Google # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification # @raise [Google::Apis::AuthorizationError] Authorization is required - def list_my_books(acquire_method: nil, country: nil, locale: nil, max_results: nil, processing_state: nil, source: nil, start_index: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) - command = make_simple_command(:get, 'volumes/mybooks', options) + def list_my_books(acquire_method: nil, country: nil, locale: nil, max_results: nil, processing_state: nil, source: nil, start_index: nil, fields: nil, quota_user: nil, options: nil, &block) + command = make_simple_command(:get, 'books/v1/volumes/mybooks', options) command.response_representation = Google::Apis::BooksV1::Volumes::Representation command.response_class = Google::Apis::BooksV1::Volumes command.query['acquireMethod'] = acquire_method unless acquire_method.nil? @@ -2164,7 +2045,6 @@ module Google command.query['startIndex'] = start_index unless start_index.nil? command.query['fields'] = fields unless fields.nil? command.query['quotaUser'] = quota_user unless quota_user.nil? - command.query['userIp'] = user_ip unless user_ip.nil? execute_or_queue_command(command, &block) end @@ -2173,17 +2053,15 @@ module Google # ISO-639-1 language and ISO-3166-1 country code. Ex: 'en_US'. Used for # generating recommendations. # @param [String] max_allowed_maturity_rating - # The maximum allowed maturity rating of returned recommendations. Books with a - # higher maturity rating are filtered out. + # The maximum allowed maturity rating of returned recommendations. Books with + # a higher maturity rating are filtered out. # @param [String] source # String to identify the originator of this request. # @param [String] fields # Selector specifying which fields to include in a partial response. # @param [String] quota_user - # An opaque string that represents a user for quota purposes. Must not exceed 40 - # characters. - # @param [String] user_ip - # Deprecated. Please use quotaUser instead. + # Available to use for quota purposes for server-side applications. Can be any + # arbitrary string assigned to a user, but should not exceed 40 characters. # @param [Google::Apis::RequestOptions] options # Request-specific options # @@ -2196,8 +2074,8 @@ module Google # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification # @raise [Google::Apis::AuthorizationError] Authorization is required - def list_recommended_volumes(locale: nil, max_allowed_maturity_rating: nil, source: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) - command = make_simple_command(:get, 'volumes/recommended', options) + def list_recommended_volumes(locale: nil, max_allowed_maturity_rating: nil, source: nil, fields: nil, quota_user: nil, options: nil, &block) + command = make_simple_command(:get, 'books/v1/volumes/recommended', options) command.response_representation = Google::Apis::BooksV1::Volumes::Representation command.response_class = Google::Apis::BooksV1::Volumes command.query['locale'] = locale unless locale.nil? @@ -2205,27 +2083,24 @@ module Google command.query['source'] = source unless source.nil? command.query['fields'] = fields unless fields.nil? command.query['quotaUser'] = quota_user unless quota_user.nil? - command.query['userIp'] = user_ip unless user_ip.nil? execute_or_queue_command(command, &block) end # Rate a recommended book for the current user. - # @param [String] rating - # Rating to be given to the volume. - # @param [String] volume_id - # ID of the source volume. # @param [String] locale # ISO-639-1 language and ISO-3166-1 country code. Ex: 'en_US'. Used for # generating recommendations. + # @param [String] rating + # Rating to be given to the volume. # @param [String] source # String to identify the originator of this request. + # @param [String] volume_id + # ID of the source volume. # @param [String] fields # Selector specifying which fields to include in a partial response. # @param [String] quota_user - # An opaque string that represents a user for quota purposes. Must not exceed 40 - # characters. - # @param [String] user_ip - # Deprecated. Please use quotaUser instead. + # Available to use for quota purposes for server-side applications. Can be any + # arbitrary string assigned to a user, but should not exceed 40 characters. # @param [Google::Apis::RequestOptions] options # Request-specific options # @@ -2238,8 +2113,8 @@ module Google # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification # @raise [Google::Apis::AuthorizationError] Authorization is required - def rate_recommended_volume(rating, volume_id, locale: nil, source: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) - command = make_simple_command(:post, 'volumes/recommended/rate', options) + def rate_recommended_volume(locale: nil, rating: nil, source: nil, volume_id: nil, fields: nil, quota_user: nil, options: nil, &block) + command = make_simple_command(:post, 'books/v1/volumes/recommended/rate', options) command.response_representation = Google::Apis::BooksV1::RateRecommendedVolumeResponse::Representation command.response_class = Google::Apis::BooksV1::RateRecommendedVolumeResponse command.query['locale'] = locale unless locale.nil? @@ -2248,7 +2123,6 @@ module Google command.query['volumeId'] = volume_id unless volume_id.nil? command.query['fields'] = fields unless fields.nil? command.query['quotaUser'] = quota_user unless quota_user.nil? - command.query['userIp'] = user_ip unless user_ip.nil? execute_or_queue_command(command, &block) end @@ -2270,10 +2144,8 @@ module Google # @param [String] fields # Selector specifying which fields to include in a partial response. # @param [String] quota_user - # An opaque string that represents a user for quota purposes. Must not exceed 40 - # characters. - # @param [String] user_ip - # Deprecated. Please use quotaUser instead. + # Available to use for quota purposes for server-side applications. Can be any + # arbitrary string assigned to a user, but should not exceed 40 characters. # @param [Google::Apis::RequestOptions] options # Request-specific options # @@ -2286,8 +2158,8 @@ module Google # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification # @raise [Google::Apis::AuthorizationError] Authorization is required - def list_user_uploaded_volumes(locale: nil, max_results: nil, processing_state: nil, source: nil, start_index: nil, volume_id: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) - command = make_simple_command(:get, 'volumes/useruploaded', options) + def list_user_uploaded_volumes(locale: nil, max_results: nil, processing_state: nil, source: nil, start_index: nil, volume_id: nil, fields: nil, quota_user: nil, options: nil, &block) + command = make_simple_command(:get, 'books/v1/volumes/useruploaded', options) command.response_representation = Google::Apis::BooksV1::Volumes::Representation command.response_class = Google::Apis::BooksV1::Volumes command.query['locale'] = locale unless locale.nil? @@ -2298,7 +2170,6 @@ module Google command.query['volumeId'] = volume_id unless volume_id.nil? command.query['fields'] = fields unless fields.nil? command.query['quotaUser'] = quota_user unless quota_user.nil? - command.query['userIp'] = user_ip unless user_ip.nil? execute_or_queue_command(command, &block) end @@ -2307,7 +2178,6 @@ module Google def apply_command_defaults(command) command.query['key'] = key unless key.nil? command.query['quotaUser'] = quota_user unless quota_user.nil? - command.query['userIp'] = user_ip unless user_ip.nil? end end end diff --git a/generated/google/apis/cloudfunctions_v1.rb b/generated/google/apis/cloudfunctions_v1.rb index 51cf4896e..06696f352 100644 --- a/generated/google/apis/cloudfunctions_v1.rb +++ b/generated/google/apis/cloudfunctions_v1.rb @@ -25,7 +25,7 @@ module Google # @see https://cloud.google.com/functions module CloudfunctionsV1 VERSION = 'V1' - REVISION = '20200219' + REVISION = '20200504' # View and manage your data across Google Cloud Platform services AUTH_CLOUD_PLATFORM = 'https://www.googleapis.com/auth/cloud-platform' diff --git a/generated/google/apis/cloudfunctions_v1/classes.rb b/generated/google/apis/cloudfunctions_v1/classes.rb index 61c36f2b8..c009ed802 100644 --- a/generated/google/apis/cloudfunctions_v1/classes.rb +++ b/generated/google/apis/cloudfunctions_v1/classes.rb @@ -1000,10 +1000,13 @@ module Google # Google groups, and domains (such as G Suite). A `role` is a named list of # permissions; each `role` can be an IAM predefined role or a user-created # custom role. - # Optionally, a `binding` can specify a `condition`, which is a logical - # expression that allows access to a resource only if the expression evaluates - # to `true`. A condition can add constraints based on attributes of the - # request, the resource, or both. + # For some types of Google Cloud resources, a `binding` can also specify a + # `condition`, which is a logical expression that allows access to a resource + # only if the expression evaluates to `true`. A condition can add constraints + # based on attributes of the request, the resource, or both. To learn which + # resources support conditions in their IAM policies, see the + # [IAM documentation](https://cloud.google.com/iam/help/conditions/resource- + # policies). # **JSON example:** # ` # "bindings": [ @@ -1018,7 +1021,9 @@ module Google # `, # ` # "role": "roles/resourcemanager.organizationViewer", - # "members": ["user:eve@example.com"], + # "members": [ + # "user:eve@example.com" + # ], # "condition": ` # "title": "expirable access", # "description": "Does not grant access after Sep 2020", @@ -1096,6 +1101,9 @@ module Google # the conditions in the version `3` policy are lost. # If a policy does not include any conditions, operations on that policy may # specify any valid version or leave the field unset. + # To learn which resources support conditions in their IAM policies, see the + # [IAM documentation](https://cloud.google.com/iam/help/conditions/resource- + # policies). # Corresponds to the JSON property `version` # @return [Fixnum] attr_accessor :version @@ -1141,10 +1149,13 @@ module Google # Google groups, and domains (such as G Suite). A `role` is a named list of # permissions; each `role` can be an IAM predefined role or a user-created # custom role. - # Optionally, a `binding` can specify a `condition`, which is a logical - # expression that allows access to a resource only if the expression evaluates - # to `true`. A condition can add constraints based on attributes of the - # request, the resource, or both. + # For some types of Google Cloud resources, a `binding` can also specify a + # `condition`, which is a logical expression that allows access to a resource + # only if the expression evaluates to `true`. A condition can add constraints + # based on attributes of the request, the resource, or both. To learn which + # resources support conditions in their IAM policies, see the + # [IAM documentation](https://cloud.google.com/iam/help/conditions/resource- + # policies). # **JSON example:** # ` # "bindings": [ @@ -1159,7 +1170,9 @@ module Google # `, # ` # "role": "roles/resourcemanager.organizationViewer", - # "members": ["user:eve@example.com"], + # "members": [ + # "user:eve@example.com" + # ], # "condition": ` # "title": "expirable access", # "description": "Does not grant access after Sep 2020", @@ -1197,8 +1210,7 @@ module Google # OPTIONAL: A FieldMask specifying which fields of the policy to modify. Only # the fields in the mask will be modified. If no mask is provided, the # following default mask is used: - # paths: "bindings, etag" - # This field is only used by Cloud IAM. + # `paths: "bindings, etag"` # Corresponds to the JSON property `updateMask` # @return [String] attr_accessor :update_mask diff --git a/generated/google/apis/cloudfunctions_v1/service.rb b/generated/google/apis/cloudfunctions_v1/service.rb index 1a9e27604..fc750a173 100644 --- a/generated/google/apis/cloudfunctions_v1/service.rb +++ b/generated/google/apis/cloudfunctions_v1/service.rb @@ -410,6 +410,9 @@ module Google # Requests for policies with any conditional bindings must specify version 3. # Policies without any conditional bindings may specify any valid value or # leave the field unset. + # To learn which resources support conditions in their IAM policies, see the + # [IAM + # documentation](https://cloud.google.com/iam/help/conditions/resource-policies). # @param [String] fields # Selector specifying which fields to include in a partial response. # @param [String] quota_user diff --git a/generated/google/apis/monitoring_v3.rb b/generated/google/apis/monitoring_v3.rb index ef9f41aaf..3e362ebfd 100644 --- a/generated/google/apis/monitoring_v3.rb +++ b/generated/google/apis/monitoring_v3.rb @@ -29,7 +29,7 @@ module Google # @see https://cloud.google.com/monitoring/api/ module MonitoringV3 VERSION = 'V3' - REVISION = '20200420' + REVISION = '20200502' # View and manage your data across Google Cloud Platform services AUTH_CLOUD_PLATFORM = 'https://www.googleapis.com/auth/cloud-platform' diff --git a/generated/google/apis/monitoring_v3/classes.rb b/generated/google/apis/monitoring_v3/classes.rb index bc075cac3..c3f2ac54c 100644 --- a/generated/google/apis/monitoring_v3/classes.rb +++ b/generated/google/apis/monitoring_v3/classes.rb @@ -1435,11 +1435,13 @@ module Google # @return [Google::Apis::MonitoringV3::BasicAuthentication] attr_accessor :auth_info - # The request body associated with the HTTP request. If content_type is + # The request body associated with the HTTP POST request. If content_type is # URL_ENCODED, the body passed in must be URL-encoded. Users can provide a - # Content-Length header via the headers field or the API will do so. The maximum - # byte size is 1 megabyte. Note: As with all bytes fields JSON representations - # are base64 encoded. + # Content-Length header via the headers field or the API will do so. If the + # request_method is GET and body is not empty, the API will return an error. The + # maximum byte size is 1 megabyte. Note: As with all bytes fields JSON + # representations are base64 encoded. e.g.: "foo=bar" in URL-encoded form is " + # foo%3Dbar" and in base64 encoding is "Zm9vJTI1M0RiYXI=". # Corresponds to the JSON property `body` # NOTE: Values are automatically base64 encoded/decoded in the client library. # @return [String] @@ -1461,7 +1463,7 @@ module Google # @return [Hash] attr_accessor :headers - # Boolean specifiying whether to encrypt the header information. Encryption + # Boolean specifying whether to encrypt the header information. Encryption # should be specified for any headers related to authentication that you do not # wish to be seen when retrieving the configuration. The server will be # responsible for encrypting the headers. On Get/List calls, if mask_headers is diff --git a/generated/google/apis/servicedirectory_v1beta1.rb b/generated/google/apis/servicedirectory_v1beta1.rb index d6b7e4731..51155ff71 100644 --- a/generated/google/apis/servicedirectory_v1beta1.rb +++ b/generated/google/apis/servicedirectory_v1beta1.rb @@ -26,7 +26,7 @@ module Google # @see https://cloud.google.com/service-directory module ServicedirectoryV1beta1 VERSION = 'V1beta1' - REVISION = '20200415' + REVISION = '20200429' # View and manage your data across Google Cloud Platform services AUTH_CLOUD_PLATFORM = 'https://www.googleapis.com/auth/cloud-platform' diff --git a/generated/google/apis/servicedirectory_v1beta1/classes.rb b/generated/google/apis/servicedirectory_v1beta1/classes.rb index 19624f628..1dd3a9355 100644 --- a/generated/google/apis/servicedirectory_v1beta1/classes.rb +++ b/generated/google/apis/servicedirectory_v1beta1/classes.rb @@ -266,6 +266,9 @@ module Google # Requests for policies with any conditional bindings must specify version 3. # Policies without any conditional bindings may specify any valid value or # leave the field unset. + # To learn which resources support conditions in their IAM policies, see the + # [IAM + # documentation](https://cloud.google.com/iam/help/conditions/resource-policies). # Corresponds to the JSON property `requestedPolicyVersion` # @return [Fixnum] attr_accessor :requested_policy_version @@ -467,10 +470,13 @@ module Google # Google groups, and domains (such as G Suite). A `role` is a named list of # permissions; each `role` can be an IAM predefined role or a user-created # custom role. - # Optionally, a `binding` can specify a `condition`, which is a logical - # expression that allows access to a resource only if the expression evaluates - # to `true`. A condition can add constraints based on attributes of the - # request, the resource, or both. + # For some types of Google Cloud resources, a `binding` can also specify a + # `condition`, which is a logical expression that allows access to a resource + # only if the expression evaluates to `true`. A condition can add constraints + # based on attributes of the request, the resource, or both. To learn which + # resources support conditions in their IAM policies, see the + # [IAM documentation](https://cloud.google.com/iam/help/conditions/resource- + # policies). # **JSON example:** # ` # "bindings": [ @@ -485,7 +491,9 @@ module Google # `, # ` # "role": "roles/resourcemanager.organizationViewer", - # "members": ["user:eve@example.com"], + # "members": [ + # "user:eve@example.com" + # ], # "condition": ` # "title": "expirable access", # "description": "Does not grant access after Sep 2020", @@ -558,6 +566,9 @@ module Google # the conditions in the version `3` policy are lost. # If a policy does not include any conditions, operations on that policy may # specify any valid version or leave the field unset. + # To learn which resources support conditions in their IAM policies, see the + # [IAM documentation](https://cloud.google.com/iam/help/conditions/resource- + # policies). # Corresponds to the JSON property `version` # @return [Fixnum] attr_accessor :version @@ -691,10 +702,13 @@ module Google # Google groups, and domains (such as G Suite). A `role` is a named list of # permissions; each `role` can be an IAM predefined role or a user-created # custom role. - # Optionally, a `binding` can specify a `condition`, which is a logical - # expression that allows access to a resource only if the expression evaluates - # to `true`. A condition can add constraints based on attributes of the - # request, the resource, or both. + # For some types of Google Cloud resources, a `binding` can also specify a + # `condition`, which is a logical expression that allows access to a resource + # only if the expression evaluates to `true`. A condition can add constraints + # based on attributes of the request, the resource, or both. To learn which + # resources support conditions in their IAM policies, see the + # [IAM documentation](https://cloud.google.com/iam/help/conditions/resource- + # policies). # **JSON example:** # ` # "bindings": [ @@ -709,7 +723,9 @@ module Google # `, # ` # "role": "roles/resourcemanager.organizationViewer", - # "members": ["user:eve@example.com"], + # "members": [ + # "user:eve@example.com" + # ], # "condition": ` # "title": "expirable access", # "description": "Does not grant access after Sep 2020", diff --git a/generated/google/apis/servicemanagement_v1.rb b/generated/google/apis/servicemanagement_v1.rb index a8d1b8c34..c458ee592 100644 --- a/generated/google/apis/servicemanagement_v1.rb +++ b/generated/google/apis/servicemanagement_v1.rb @@ -27,7 +27,7 @@ module Google # @see https://cloud.google.com/service-management/ module ServicemanagementV1 VERSION = 'V1' - REVISION = '20200411' + REVISION = '20200506' # View and manage your data across Google Cloud Platform services AUTH_CLOUD_PLATFORM = 'https://www.googleapis.com/auth/cloud-platform' diff --git a/generated/google/apis/servicemanagement_v1/classes.rb b/generated/google/apis/servicemanagement_v1/classes.rb index bdb4993c7..2bd57c476 100644 --- a/generated/google/apis/servicemanagement_v1/classes.rb +++ b/generated/google/apis/servicemanagement_v1/classes.rb @@ -635,21 +635,31 @@ module Google # Billing related configuration of the service. # The following example shows how to configure monitored resources and metrics - # for billing: + # for billing, `consumer_destinations` is the only supported destination and + # the monitored resources need at least one label key + # `cloud.googleapis.com/location` to indicate the location of the billing + # usage, using different monitored resources between monitoring and billing is + # recommended so they can be evolved independently: # monitored_resources: - # - type: library.googleapis.com/branch + # - type: library.googleapis.com/billing_branch # labels: - # - key: /city - # description: The city where the library branch is located in. - # - key: /name - # description: The name of the branch. + # - key: cloud.googleapis.com/location + # description: | + # Predefined label to support billing location restriction. + # - key: city + # description: | + # Custom label to define the city where the library branch is located + # in. + # - key: name + # description: Custom label to define the name of the library branch. # metrics: # - name: library.googleapis.com/book/borrowed_count # metric_kind: DELTA # value_type: INT64 + # unit: "1" # billing: # consumer_destinations: - # - monitored_resource: library.googleapis.com/branch + # - monitored_resource: library.googleapis.com/billing_branch # metrics: # - library.googleapis.com/book/borrowed_count class Billing @@ -1834,6 +1844,9 @@ module Google # Requests for policies with any conditional bindings must specify version 3. # Policies without any conditional bindings may specify any valid value or # leave the field unset. + # To learn which resources support conditions in their IAM policies, see the + # [IAM + # documentation](https://cloud.google.com/iam/help/conditions/resource-policies). # Corresponds to the JSON property `requestedPolicyVersion` # @return [Fixnum] attr_accessor :requested_policy_version @@ -3311,10 +3324,13 @@ module Google # Google groups, and domains (such as G Suite). A `role` is a named list of # permissions; each `role` can be an IAM predefined role or a user-created # custom role. - # Optionally, a `binding` can specify a `condition`, which is a logical - # expression that allows access to a resource only if the expression evaluates - # to `true`. A condition can add constraints based on attributes of the - # request, the resource, or both. + # For some types of Google Cloud resources, a `binding` can also specify a + # `condition`, which is a logical expression that allows access to a resource + # only if the expression evaluates to `true`. A condition can add constraints + # based on attributes of the request, the resource, or both. To learn which + # resources support conditions in their IAM policies, see the + # [IAM documentation](https://cloud.google.com/iam/help/conditions/resource- + # policies). # **JSON example:** # ` # "bindings": [ @@ -3329,7 +3345,9 @@ module Google # `, # ` # "role": "roles/resourcemanager.organizationViewer", - # "members": ["user:eve@example.com"], + # "members": [ + # "user:eve@example.com" + # ], # "condition": ` # "title": "expirable access", # "description": "Does not grant access after Sep 2020", @@ -3407,6 +3425,9 @@ module Google # the conditions in the version `3` policy are lost. # If a policy does not include any conditions, operations on that policy may # specify any valid version or leave the field unset. + # To learn which resources support conditions in their IAM policies, see the + # [IAM documentation](https://cloud.google.com/iam/help/conditions/resource- + # policies). # Corresponds to the JSON property `version` # @return [Fixnum] attr_accessor :version @@ -3751,21 +3772,31 @@ module Google # Billing related configuration of the service. # The following example shows how to configure monitored resources and metrics - # for billing: + # for billing, `consumer_destinations` is the only supported destination and + # the monitored resources need at least one label key + # `cloud.googleapis.com/location` to indicate the location of the billing + # usage, using different monitored resources between monitoring and billing is + # recommended so they can be evolved independently: # monitored_resources: - # - type: library.googleapis.com/branch + # - type: library.googleapis.com/billing_branch # labels: - # - key: /city - # description: The city where the library branch is located in. - # - key: /name - # description: The name of the branch. + # - key: cloud.googleapis.com/location + # description: | + # Predefined label to support billing location restriction. + # - key: city + # description: | + # Custom label to define the city where the library branch is located + # in. + # - key: name + # description: Custom label to define the name of the library branch. # metrics: # - name: library.googleapis.com/book/borrowed_count # metric_kind: DELTA # value_type: INT64 + # unit: "1" # billing: # consumer_destinations: - # - monitored_resource: library.googleapis.com/branch + # - monitored_resource: library.googleapis.com/billing_branch # metrics: # - library.googleapis.com/book/borrowed_count # Corresponds to the JSON property `billing` @@ -4193,10 +4224,13 @@ module Google # Google groups, and domains (such as G Suite). A `role` is a named list of # permissions; each `role` can be an IAM predefined role or a user-created # custom role. - # Optionally, a `binding` can specify a `condition`, which is a logical - # expression that allows access to a resource only if the expression evaluates - # to `true`. A condition can add constraints based on attributes of the - # request, the resource, or both. + # For some types of Google Cloud resources, a `binding` can also specify a + # `condition`, which is a logical expression that allows access to a resource + # only if the expression evaluates to `true`. A condition can add constraints + # based on attributes of the request, the resource, or both. To learn which + # resources support conditions in their IAM policies, see the + # [IAM documentation](https://cloud.google.com/iam/help/conditions/resource- + # policies). # **JSON example:** # ` # "bindings": [ @@ -4211,7 +4245,9 @@ module Google # `, # ` # "role": "roles/resourcemanager.organizationViewer", - # "members": ["user:eve@example.com"], + # "members": [ + # "user:eve@example.com" + # ], # "condition": ` # "title": "expirable access", # "description": "Does not grant access after Sep 2020", @@ -4249,8 +4285,7 @@ module Google # OPTIONAL: A FieldMask specifying which fields of the policy to modify. Only # the fields in the mask will be modified. If no mask is provided, the # following default mask is used: - # paths: "bindings, etag" - # This field is only used by Cloud IAM. + # `paths: "bindings, etag"` # Corresponds to the JSON property `updateMask` # @return [String] attr_accessor :update_mask diff --git a/generated/google/apis/servicemanagement_v1/service.rb b/generated/google/apis/servicemanagement_v1/service.rb index 71f47d000..3728278ce 100644 --- a/generated/google/apis/servicemanagement_v1/service.rb +++ b/generated/google/apis/servicemanagement_v1/service.rb @@ -487,7 +487,7 @@ module Google # Sets the access control policy on the specified resource. Replaces any # existing policy. - # Can return Public Errors: NOT_FOUND, INVALID_ARGUMENT and PERMISSION_DENIED + # Can return `NOT_FOUND`, `INVALID_ARGUMENT`, and `PERMISSION_DENIED` errors. # @param [String] resource # REQUIRED: The resource for which the policy is being specified. # See the operation documentation for the appropriate value for this field. @@ -523,7 +523,7 @@ module Google # Returns permissions that a caller has on the specified resource. # If the resource does not exist, this will return an empty set of - # permissions, not a NOT_FOUND error. + # permissions, not a `NOT_FOUND` error. # Note: This operation is designed to be used for building permission-aware # UIs and command-line tools, not for authorization checking. This operation # may "fail open" without warning. @@ -801,7 +801,7 @@ module Google # Sets the access control policy on the specified resource. Replaces any # existing policy. - # Can return Public Errors: NOT_FOUND, INVALID_ARGUMENT and PERMISSION_DENIED + # Can return `NOT_FOUND`, `INVALID_ARGUMENT`, and `PERMISSION_DENIED` errors. # @param [String] resource # REQUIRED: The resource for which the policy is being specified. # See the operation documentation for the appropriate value for this field. @@ -837,7 +837,7 @@ module Google # Returns permissions that a caller has on the specified resource. # If the resource does not exist, this will return an empty set of - # permissions, not a NOT_FOUND error. + # permissions, not a `NOT_FOUND` error. # Note: This operation is designed to be used for building permission-aware # UIs and command-line tools, not for authorization checking. This operation # may "fail open" without warning.