google-api-client 0.10.0 → 0.10.1

data/generated/google/apis/reseller_v1.rb

@@ -25,7 +25,7 @@ module Google
     # @see https://developers.google.com/google-apps/reseller/
     module ResellerV1
       VERSION = 'V1'
-      REVISION = '20160329'
+      REVISION = '20170216'
 
       # Manage users on your domain
       AUTH_APPS_ORDER = 'https://www.googleapis.com/auth/apps.order'

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

@@ -26,55 +26,56 @@ module Google
       class Address
         include Google::Apis::Core::Hashable
       
-        # Address line 1 of the address.
+        # A customer's physical address. An address can be composed of one to three
+        # lines. The addressline2 and addressLine3 are optional.
         # Corresponds to the JSON property `addressLine1`
         # @return [String]
         attr_accessor :address_line1
       
-        # Address line 2 of the address.
+        # Line 2 of the address.
         # Corresponds to the JSON property `addressLine2`
         # @return [String]
         attr_accessor :address_line2
       
-        # Address line 3 of the address.
+        # Line 3 of the address.
         # Corresponds to the JSON property `addressLine3`
         # @return [String]
         attr_accessor :address_line3
       
-        # Name of the contact person.
+        # The customer contact's name. This is required.
         # Corresponds to the JSON property `contactName`
         # @return [String]
         attr_accessor :contact_name
       
-        # ISO 3166 country code.
+        # For countryCode information, see the ISO 3166 country code elements. Verify
+        # that country is approved for resale of Google products. This property is
+        # required when creating a new customer.
         # Corresponds to the JSON property `countryCode`
         # @return [String]
         attr_accessor :country_code
       
-        # Identifies the resource as a customer address.
+        # Identifies the resource as a customer address. Value: customers#address
         # Corresponds to the JSON property `kind`
         # @return [String]
         attr_accessor :kind
       
-        # Name of the locality. This is in accordance with - http://portablecontacts.net/
-        # draft-spec.html#address_element.
+        # An example of a locality value is the city of San Francisco.
         # Corresponds to the JSON property `locality`
         # @return [String]
         attr_accessor :locality
       
-        # Name of the organization.
+        # The company or company division name. This is required.
         # Corresponds to the JSON property `organizationName`
         # @return [String]
         attr_accessor :organization_name
       
-        # The postal code. This is in accordance with - http://portablecontacts.net/
-        # draft-spec.html#address_element.
+        # A postalCode example is a postal zip code such as 94043. This property is
+        # required when creating a new customer.
         # Corresponds to the JSON property `postalCode`
         # @return [String]
         attr_accessor :postal_code
       
-        # Name of the region. This is in accordance with - http://portablecontacts.net/
-        # draft-spec.html#address_element.
+        # An example of a region value is CA for the state of California.
         # Corresponds to the JSON property `region`
         # @return [String]
         attr_accessor :region
@@ -102,23 +103,40 @@ module Google
       class ChangePlanRequest
         include Google::Apis::Core::Hashable
       
-        # External name of the deal code applicable for the subscription. This field is
-        # optional. If missing, the deal price plan won't be used.
+        # Google-issued code (100 char max) for discounted pricing on subscription plans.
+        # Deal code must be included in changePlan request in order to receive
+        # discounted rate. This property is optional. If a deal code has already been
+        # added to a subscription, this property may be left empty and the existing
+        # discounted rate will still apply (if not empty, only provide the deal code
+        # that is already present on the subscription). If a deal code has never been
+        # added to a subscription and this property is left blank, regular pricing will
+        # apply.
         # Corresponds to the JSON property `dealCode`
         # @return [String]
         attr_accessor :deal_code
       
-        # Identifies the resource as a subscription change plan request.
+        # Identifies the resource as a subscription change plan request. Value:
+        # subscriptions#changePlanRequest
         # Corresponds to the JSON property `kind`
         # @return [String]
         attr_accessor :kind
       
-        # Name of the plan to change to.
+        # The planName property is required. This is the name of the subscription's
+        # payment plan. For more information about the Google payment plans, see API
+        # concepts.
+        # Possible values are:
+        # - ANNUAL_MONTHLY_PAY - The annual commitment plan with monthly payments
+        # - ANNUAL_YEARLY_PAY - The annual commitment plan with yearly payments
+        # - FLEXIBLE - The flexible plan
+        # - TRIAL - The 30-day free trial plan
         # Corresponds to the JSON property `planName`
         # @return [String]
         attr_accessor :plan_name
       
-        # Purchase order id for your order tracking purposes.
+        # This is an optional property. This purchase order (PO) information is for
+        # resellers to use for their company tracking usage. If a purchaseOrderId value
+        # is given it appears in the API responses and shows up in the invoice. The
+        # property accepts up to 80 plain text characters.
         # Corresponds to the JSON property `purchaseOrderId`
         # @return [String]
         attr_accessor :purchase_order_id
@@ -146,12 +164,17 @@ module Google
       class Customer
         include Google::Apis::Core::Hashable
       
-        # The alternate email of the customer.
+        # Like the "Customer email" in the reseller tools, this email is the secondary
+        # contact used if something happens to the customer's service such as service
+        # outage or a security issue. This property is required when creating a new
+        # customer and should not use the same domain as customerDomain.
         # Corresponds to the JSON property `alternateEmail`
         # @return [String]
         attr_accessor :alternate_email
       
-        # The domain name of the customer.
+        # The customer's primary domain name string. customerDomain is required when
+        # creating a new customer. Do not include the www prefix in the domain when
+        # adding a customer.
         # Corresponds to the JSON property `customerDomain`
         # @return [String]
         attr_accessor :customer_domain
@@ -162,17 +185,21 @@ module Google
         attr_accessor :customer_domain_verified
         alias_method :customer_domain_verified?, :customer_domain_verified
       
-        # The id of the customer.
+        # This property will always be returned in a response as the unique identifier
+        # generated by Google. In a request, this property can be either the primary
+        # domain or the unique identifier generated by Google.
         # Corresponds to the JSON property `customerId`
         # @return [String]
         attr_accessor :customer_id
       
-        # Identifies the resource as a customer.
+        # Identifies the resource as a customer. Value: reseller#customer
         # Corresponds to the JSON property `kind`
         # @return [String]
         attr_accessor :kind
       
-        # The phone number of the customer.
+        # Customer contact phone number. This can be continuous numbers, with spaces,
+        # etc. But it must be a real phone number and not, for example, "123". See phone
+        # local format conventions.
         # Corresponds to the JSON property `phoneNumber`
         # @return [String]
         attr_accessor :phone_number
@@ -182,7 +209,9 @@ module Google
         # @return [Google::Apis::ResellerV1::Address]
         attr_accessor :postal_address
       
-        # Ui url for customer resource.
+        # URL to customer's Admin console dashboard. The read-only URL is generated by
+        # the API service. This is used if your client application requires the customer
+        # to complete a task in the Admin console.
         # Corresponds to the JSON property `resourceUiUrl`
         # @return [String]
         attr_accessor :resource_ui_url
@@ -208,12 +237,15 @@ module Google
       class RenewalSettings
         include Google::Apis::Core::Hashable
       
-        # Identifies the resource as a subscription renewal setting.
+        # Identifies the resource as a subscription renewal setting. Value:
+        # subscriptions#renewalSettings
         # Corresponds to the JSON property `kind`
         # @return [String]
         attr_accessor :kind
       
-        # Subscription renewal type.
+        # Renewal settings for the annual commitment plan. For more detailed information,
+        # see renewal options in the administrator help center. When renewing a
+        # subscription, the renewalType is a required property.
         # Corresponds to the JSON property `renewalType`
         # @return [String]
         attr_accessor :renewal_type
@@ -229,11 +261,56 @@ module Google
         end
       end
       
+      # JSON template for resellernotify getwatchdetails response.
+      class ResellernotifyGetwatchdetailsResponse
+        include Google::Apis::Core::Hashable
+      
+        # List of registered service accounts.
+        # Corresponds to the JSON property `serviceAccountEmailAddresses`
+        # @return [Array<String>]
+        attr_accessor :service_account_email_addresses
+      
+        # Topic name of the PubSub
+        # Corresponds to the JSON property `topicName`
+        # @return [String]
+        attr_accessor :topic_name
+      
+        def initialize(**args)
+           update!(**args)
+        end
+      
+        # Update properties of this object
+        def update!(**args)
+          @service_account_email_addresses = args[:service_account_email_addresses] if args.key?(:service_account_email_addresses)
+          @topic_name = args[:topic_name] if args.key?(:topic_name)
+        end
+      end
+      
+      # JSON template for resellernotify response.
+      class ResellernotifyResource
+        include Google::Apis::Core::Hashable
+      
+        # Topic name of the PubSub
+        # Corresponds to the JSON property `topicName`
+        # @return [String]
+        attr_accessor :topic_name
+      
+        def initialize(**args)
+           update!(**args)
+        end
+      
+        # Update properties of this object
+        def update!(**args)
+          @topic_name = args[:topic_name] if args.key?(:topic_name)
+        end
+      end
+      
       # JSON template for subscription seats.
       class Seats
         include Google::Apis::Core::Hashable
       
-        # Identifies the resource as a subscription change plan request.
+        # Identifies the resource as a subscription change plan request. Value:
+        # subscriptions#seats
         # Corresponds to the JSON property `kind`
         # @return [String]
         attr_accessor :kind
@@ -245,13 +322,40 @@ module Google
         # @return [Fixnum]
         attr_accessor :licensed_number_of_seats
       
-        # Maximum number of seats that can be purchased. This needs to be provided only
-        # for a non-commitment plan. For a commitment plan it is decided by the contract.
+        # The maximumNumberOfSeats property is the maximum number of licenses that the
+        # customer can purchase. This property applies to plans other than the annual
+        # commitment plan. How a user's licenses are managed depends on the subscription'
+        # s payment plan:
+        # - annual commitment plan (with monthly or yearly payments) — For this plan, a
+        # reseller is invoiced on the number of user licenses in the numberOfSeats
+        # property. The maximumNumberOfSeats property is a read-only property in the API'
+        # s response.
+        # - flexible plan — For this plan, a reseller is invoiced on the actual number
+        # of users which is capped by the maximumNumberOfSeats. This is the maximum
+        # number of user licenses a customer has for user license provisioning. This
+        # quantity can be increased up to the maximum limit defined in the reseller's
+        # contract. And the minimum quantity is the current number of users in the
+        # customer account.
+        # - 30-day free trial plan — A subscription in a 30-day free trial is restricted
+        # to maximum 10 seats.
         # Corresponds to the JSON property `maximumNumberOfSeats`
         # @return [Fixnum]
         attr_accessor :maximum_number_of_seats
       
-        # Number of seats to purchase. This is applicable only for a commitment plan.
+        # The numberOfSeats property holds the customer's number of user licenses. How a
+        # user's licenses are managed depends on the subscription's plan:
+        # - annual commitment plan (with monthly or yearly pay) — For this plan, a
+        # reseller is invoiced on the number of user licenses in the numberOfSeats
+        # property. This is the maximum number of user licenses that a reseller's
+        # customer can create. The reseller can add more licenses, but once set, the
+        # numberOfSeats can not be reduced until renewal. The reseller is invoiced based
+        # on the numberOfSeats value regardless of how many of these user licenses are
+        # provisioned users.
+        # - flexible plan — For this plan, a reseller is invoiced on the actual number
+        # of users which is capped by the maximumNumberOfSeats. The numberOfSeats
+        # property is not used in the request or response for flexible plan customers.
+        # - 30-day free trial plan — The numberOfSeats property is not used in the
+        # request or response for an account in a 30-day trial.
         # Corresponds to the JSON property `numberOfSeats`
         # @return [Fixnum]
         attr_accessor :number_of_seats
@@ -273,12 +377,13 @@ module Google
       class Subscription
         include Google::Apis::Core::Hashable
       
-        # Billing method of this subscription.
+        # Read-only field that returns the current billing method for a subscription.
         # Corresponds to the JSON property `billingMethod`
         # @return [String]
         attr_accessor :billing_method
       
-        # Creation time of this subscription in milliseconds since Unix epoch.
+        # The creationTime property is the date when subscription was created. It is in
+        # milliseconds using the Epoch format. See an example Epoch converter.
         # Corresponds to the JSON property `creationTime`
         # @return [String]
         attr_accessor :creation_time
@@ -288,28 +393,36 @@ module Google
         # @return [String]
         attr_accessor :customer_domain
       
-        # The id of the customer to whom the subscription belongs.
+        # This property will always be returned in a response as the unique identifier
+        # generated by Google. In a request, this property can be either the primary
+        # domain or the unique identifier generated by Google.
         # Corresponds to the JSON property `customerId`
         # @return [String]
         attr_accessor :customer_id
       
-        # External name of the deal, if this subscription was provisioned under one.
-        # Otherwise this field will be empty.
+        # Google-issued code (100 char max) for discounted pricing on subscription plans.
+        # Deal code must be included in insert requests in order to receive discounted
+        # rate. This property is optional, regular pricing applies if left empty.
         # Corresponds to the JSON property `dealCode`
         # @return [String]
         attr_accessor :deal_code
       
-        # Identifies the resource as a Subscription.
+        # Identifies the resource as a Subscription. Value: reseller#subscription
         # Corresponds to the JSON property `kind`
         # @return [String]
         attr_accessor :kind
       
-        # Plan details of the subscription
+        # The plan property is required. In this version of the API, the G Suite plans
+        # are the flexible plan, annual commitment plan, and the 30-day free trial plan.
+        # For more information about the API"s payment plans, see the API concepts.
         # Corresponds to the JSON property `plan`
         # @return [Google::Apis::ResellerV1::Subscription::Plan]
         attr_accessor :plan
       
-        # Purchase order id for your order tracking purposes.
+        # This is an optional property. This purchase order (PO) information is for
+        # resellers to use for their company tracking usage. If a purchaseOrderId value
+        # is given it appears in the API responses and shows up in the invoice. The
+        # property accepts up to 80 plain text characters.
         # Corresponds to the JSON property `purchaseOrderId`
         # @return [String]
         attr_accessor :purchase_order_id
@@ -319,7 +432,10 @@ module Google
         # @return [Google::Apis::ResellerV1::RenewalSettings]
         attr_accessor :renewal_settings
       
-        # Ui url for subscription resource.
+        # URL to customer's Subscriptions page in the Admin console. The read-only URL
+        # is generated by the API service. This is used if your client application
+        # requires the customer to complete a task using the Subscriptions page in the
+        # Admin console.
         # Corresponds to the JSON property `resourceUiUrl`
         # @return [String]
         attr_accessor :resource_ui_url
@@ -329,17 +445,23 @@ module Google
         # @return [Google::Apis::ResellerV1::Seats]
         attr_accessor :seats
       
-        # Name of the sku for which this subscription is purchased.
+        # A required property. The skuId is a unique system identifier for a product's
+        # SKU assigned to a customer in the subscription. For products and SKUs
+        # available in this version of the API, see  Product and SKU IDs.
         # Corresponds to the JSON property `skuId`
         # @return [String]
         attr_accessor :sku_id
       
-        # Status of the subscription.
+        # This is an optional property.
         # Corresponds to the JSON property `status`
         # @return [String]
         attr_accessor :status
       
-        # The id of the subscription.
+        # The subscriptionId is the subscription identifier and is unique for each
+        # customer. This is a required property. Since a subscriptionId changes when a
+        # subscription is updated, we recommend not using this ID as a key for
+        # persistent data. Use the subscriptionId as described in retrieve all reseller
+        # subscriptions.
         # Corresponds to the JSON property `subscriptionId`
         # @return [String]
         attr_accessor :subscription_id
@@ -347,9 +469,10 @@ module Google
         # Read-only field containing an enumerable of all the current suspension reasons
         # for a subscription. It is possible for a subscription to have many concurrent,
         # overlapping suspension reasons. A subscription's STATUS is SUSPENDED until all
-        # pending suspensions are removed. Possible options include:
-        # - PENDING_TOS_ACCEPTANCE - The customer has not logged in and accepted the
-        # Google Apps Resold Terms of Services.
+        # pending suspensions are removed.
+        # Possible options include:
+        # - PENDING_TOS_ACCEPTANCE - The customer has not logged in and accepted the G
+        # Suite Resold Terms of Services.
         # - RENEWAL_WITH_TYPE_CANCEL - The customer's commitment ended and their service
         # was cancelled at the end of their term.
         # - RESELLER_INITIATED - A manual suspension invoked by a Reseller.
@@ -360,12 +483,14 @@ module Google
         # @return [Array<String>]
         attr_accessor :suspension_reasons
       
-        # Transfer related information for the subscription.
+        # Read-only transfer related information for the subscription. For more
+        # information, see retrieve transferable subscriptions for a customer.
         # Corresponds to the JSON property `transferInfo`
         # @return [Google::Apis::ResellerV1::Subscription::TransferInfo]
         attr_accessor :transfer_info
       
-        # Trial Settings of the subscription.
+        # The G Suite annual commitment and flexible payment plans can be in a 30-day
+        # free trial. For more information, see the API concepts.
         # Corresponds to the JSON property `trialSettings`
         # @return [Google::Apis::ResellerV1::Subscription::TrialSettings]
         attr_accessor :trial_settings
@@ -395,22 +520,37 @@ module Google
           @trial_settings = args[:trial_settings] if args.key?(:trial_settings)
         end
         
-        # Plan details of the subscription
+        # The plan property is required. In this version of the API, the G Suite plans
+        # are the flexible plan, annual commitment plan, and the 30-day free trial plan.
+        # For more information about the API"s payment plans, see the API concepts.
         class Plan
           include Google::Apis::Core::Hashable
         
-          # Interval of the commitment if it is a commitment plan.
+          # In this version of the API, annual commitment plan's interval is one year.
           # Corresponds to the JSON property `commitmentInterval`
           # @return [Google::Apis::ResellerV1::Subscription::Plan::CommitmentInterval]
           attr_accessor :commitment_interval
         
-          # Whether the plan is a commitment plan or not.
+          # The isCommitmentPlan property's boolean value identifies the plan as an annual
+          # commitment plan:
+          # - true — The subscription's plan is an annual commitment plan.
+          # - false — The plan is not an annual commitment plan.
           # Corresponds to the JSON property `isCommitmentPlan`
           # @return [Boolean]
           attr_accessor :is_commitment_plan
           alias_method :is_commitment_plan?, :is_commitment_plan
         
-          # The plan name of this subscription's plan.
+          # The planName property is required. This is the name of the subscription's plan.
+          # For more information about the Google payment plans, see the API concepts.
+          # Possible values are:
+          # - ANNUAL_MONTHLY_PAY — The annual commitment plan with monthly payments
+          # - ANNUAL_YEARLY_PAY — The annual commitment plan with yearly payments
+          # - FLEXIBLE — The flexible plan
+          # - TRIAL — The 30-day free trial plan. A subscription in trial will be
+          # suspended after the 30th free day if no payment plan is assigned. Calling
+          # changePlan will assign a payment plan to a trial but will not activate the
+          # plan. A trial will automatically begin its assigned payment plan after its
+          # 30th free day or immediately after calling startPaidService.
           # Corresponds to the JSON property `planName`
           # @return [String]
           attr_accessor :plan_name
@@ -426,16 +566,18 @@ module Google
             @plan_name = args[:plan_name] if args.key?(:plan_name)
           end
           
-          # Interval of the commitment if it is a commitment plan.
+          # In this version of the API, annual commitment plan's interval is one year.
           class CommitmentInterval
             include Google::Apis::Core::Hashable
           
-            # End time of the commitment interval in milliseconds since Unix epoch.
+            # An annual commitment plan's interval's endTime in milliseconds using the UNIX
+            # Epoch format. See an example Epoch converter.
             # Corresponds to the JSON property `endTime`
             # @return [String]
             attr_accessor :end_time
           
-            # Start time of the commitment interval in milliseconds since Unix epoch.
+            # An annual commitment plan's interval's startTime in milliseconds using UNIX
+            # Epoch format. See an example Epoch converter.
             # Corresponds to the JSON property `startTime`
             # @return [String]
             attr_accessor :start_time
@@ -452,16 +594,21 @@ module Google
           end
         end
         
-        # Transfer related information for the subscription.
+        # Read-only transfer related information for the subscription. For more
+        # information, see retrieve transferable subscriptions for a customer.
         class TransferInfo
           include Google::Apis::Core::Hashable
         
-          # 
+          # When inserting a subscription, this is the minimum number of seats listed in
+          # the transfer order for this product. For example, if the customer has 20 users,
+          # the reseller cannot place a transfer order of 15 seats. The minimum is 20
+          # seats.
           # Corresponds to the JSON property `minimumTransferableSeats`
           # @return [Fixnum]
           attr_accessor :minimum_transferable_seats
         
-          # Time when transfer token or intent to transfer will expire.
+          # The time when transfer token or intent to transfer will expire. The time is in
+          # milliseconds using UNIX Epoch format.
           # Corresponds to the JSON property `transferabilityExpirationTime`
           # @return [String]
           attr_accessor :transferability_expiration_time
@@ -477,17 +624,21 @@ module Google
           end
         end
         
-        # Trial Settings of the subscription.
+        # The G Suite annual commitment and flexible payment plans can be in a 30-day
+        # free trial. For more information, see the API concepts.
         class TrialSettings
           include Google::Apis::Core::Hashable
         
-          # Whether the subscription is in trial.
+          # Determines if a subscription's plan is in a 30-day free trial or not:
+          # - true — The plan is in trial.
+          # - false — The plan is not in trial.
           # Corresponds to the JSON property `isInTrial`
           # @return [Boolean]
           attr_accessor :is_in_trial
           alias_method :is_in_trial?, :is_in_trial
         
-          # End time of the trial in milliseconds since Unix epoch.
+          # Date when the trial ends. The value is in milliseconds using the UNIX Epoch
+          # format. See an example Epoch converter.
           # Corresponds to the JSON property `trialEndTime`
           # @return [String]
           attr_accessor :trial_end_time
@@ -508,7 +659,8 @@ module Google
       class Subscriptions
         include Google::Apis::Core::Hashable
       
-        # Identifies the resource as a collection of subscriptions.
+        # Identifies the resource as a collection of subscriptions. Value: reseller#
+        # subscriptions
         # Corresponds to the JSON property `kind`
         # @return [String]
         attr_accessor :kind