google-cloud-channel-v1 0.1.0

data/proto_docs/google/cloud/channel/v1/common.rb

@@ -0,0 +1,155 @@
+# frozen_string_literal: true
+
+# Copyright 2021 Google LLC
+#
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+#     https://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+
+# Auto-generated by gapic-generator-ruby. DO NOT EDIT!
+
+
+module Google
+  module Cloud
+    module Channel
+      module V1
+        # Required Edu Attributes
+        # @!attribute [rw] institute_type
+        #   @return [::Google::Cloud::Channel::V1::EduData::InstituteType]
+        #     Designated institute type of customer.
+        # @!attribute [rw] institute_size
+        #   @return [::Google::Cloud::Channel::V1::EduData::InstituteSize]
+        #     Size of the institute.
+        # @!attribute [rw] website
+        #   @return [::String]
+        #     Web address for the edu customer's institution.
+        class EduData
+          include ::Google::Protobuf::MessageExts
+          extend ::Google::Protobuf::MessageExts::ClassMethods
+
+          # Enum to specify the institute type.
+          module InstituteType
+            # Default value.  This state doesn't show unless an error occurs.
+            INSTITUTE_TYPE_UNSPECIFIED = 0
+
+            # Elementary/Secondary Schools & Districts
+            K12 = 1
+
+            # Higher Education Universities & Colleges
+            UNIVERSITY = 2
+          end
+
+          # Number of students and staff the institute has.
+          module InstituteSize
+            # Default value. This state doesn't show unless an error occurs.
+            INSTITUTE_SIZE_UNSPECIFIED = 0
+
+            # 1 - 100
+            SIZE_1_100 = 1
+
+            # 101 - 500
+            SIZE_101_500 = 2
+
+            # 501 - 1,000
+            SIZE_501_1000 = 3
+
+            # 1,001 - 2,000
+            SIZE_1001_2000 = 4
+
+            # 2,001 - 5,000
+            SIZE_2001_5000 = 5
+
+            # 5,001 - 10,000
+            SIZE_5001_10000 = 6
+
+            # 10,001 +
+            SIZE_10001_OR_MORE = 7
+          end
+        end
+
+        # Cloud Identity information for the Cloud Channel Customer.
+        # @!attribute [rw] customer_type
+        #   @return [::Google::Cloud::Channel::V1::CloudIdentityInfo::CustomerType]
+        #     CustomerType indicates verification type needed for using services.
+        # @!attribute [r] primary_domain
+        #   @return [::String]
+        #     Output only. The primary domain name.
+        # @!attribute [rw] is_domain_verified
+        #   @return [::Boolean]
+        #     Whether the domain is verified.
+        # @!attribute [rw] alternate_email
+        #   @return [::String]
+        #     The alternate email.
+        # @!attribute [rw] phone_number
+        #   @return [::String]
+        #     Phone number associated with the Cloud Identity.
+        # @!attribute [rw] language_code
+        #   @return [::String]
+        #     Language code.
+        # @!attribute [r] admin_console_uri
+        #   @return [::String]
+        #     Output only. URI of Customer's Admin console dashboard.
+        # @!attribute [rw] edu_data
+        #   @return [::Google::Cloud::Channel::V1::EduData]
+        #     Edu information about the customer.
+        class CloudIdentityInfo
+          include ::Google::Protobuf::MessageExts
+          extend ::Google::Protobuf::MessageExts::ClassMethods
+
+          # CustomerType of the customer
+          module CustomerType
+            # Default value. This state doesn't show unless an error occurs.
+            CUSTOMER_TYPE_UNSPECIFIED = 0
+
+            # Domain-owning customer which needs domain verification to use services.
+            DOMAIN = 1
+
+            # Team customer which needs email verification to use services.
+            TEAM = 2
+          end
+        end
+
+        # Data type and value of a parameter.
+        # @!attribute [rw] int64_value
+        #   @return [::Integer]
+        #     Represents an int64 value.
+        # @!attribute [rw] string_value
+        #   @return [::String]
+        #     Represents a string value.
+        # @!attribute [rw] double_value
+        #   @return [::Float]
+        #     Represents a double value.
+        # @!attribute [rw] proto_value
+        #   @return [::Google::Protobuf::Any]
+        #     Represents an 'Any' proto value.
+        class Value
+          include ::Google::Protobuf::MessageExts
+          extend ::Google::Protobuf::MessageExts::ClassMethods
+        end
+
+        # Information needed to create an Admin User for Google Workspace.
+        # @!attribute [rw] email
+        #   @return [::String]
+        #     Primary email of the admin user.
+        # @!attribute [rw] given_name
+        #   @return [::String]
+        #     Given name of the admin user.
+        # @!attribute [rw] family_name
+        #   @return [::String]
+        #     Family name of the admin user.
+        class AdminUser
+          include ::Google::Protobuf::MessageExts
+          extend ::Google::Protobuf::MessageExts::ClassMethods
+        end
+      end
+    end
+  end
+end

data/proto_docs/google/cloud/channel/v1/customers.rb

@@ -0,0 +1,111 @@
+# frozen_string_literal: true
+
+# Copyright 2021 Google LLC
+#
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+#     https://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+
+# Auto-generated by gapic-generator-ruby. DO NOT EDIT!
+
+
+module Google
+  module Cloud
+    module Channel
+      module V1
+        # Entity representing a customer of a reseller or distributor.
+        # @!attribute [r] name
+        #   @return [::String]
+        #     Output only. Resource name of the customer.
+        #     Format: accounts/\\{account_id}/customers/\\{customer_id}
+        # @!attribute [rw] org_display_name
+        #   @return [::String]
+        #     Required. Name of the organization that the customer entity represents.
+        # @!attribute [rw] org_postal_address
+        #   @return [::Google::Type::PostalAddress]
+        #     Required. Address of the organization of the customer entity.
+        #     Region and zip codes are required to enforce US laws and embargoes.
+        #     Language code is discarded. Use the Customer-level language code to set the
+        #     customer's language.
+        # @!attribute [rw] primary_contact_info
+        #   @return [::Google::Cloud::Channel::V1::ContactInfo]
+        #     Primary contact info.
+        # @!attribute [rw] alternate_email
+        #   @return [::String]
+        #     Secondary contact email.
+        #     Alternate email and primary contact email are required to have different
+        #     domains if primary contact email is present.
+        #     When creating admin.google.com accounts, users get notified credentials at
+        #     this email. This email address is also used as a recovery email.
+        # @!attribute [rw] domain
+        #   @return [::String]
+        #     Required. Primary domain used by the customer.
+        #     Domain of primary contact email is required to be same as the provided
+        #     domain.
+        # @!attribute [r] create_time
+        #   @return [::Google::Protobuf::Timestamp]
+        #     Output only. The time at which the customer is created.
+        # @!attribute [r] update_time
+        #   @return [::Google::Protobuf::Timestamp]
+        #     Output only. The time at which the customer is updated.
+        # @!attribute [r] cloud_identity_id
+        #   @return [::String]
+        #     Output only. Customer's cloud_identity_id.
+        #     Populated only if a Cloud Identity resource exists for this customer.
+        # @!attribute [rw] language_code
+        #   @return [::String]
+        #     Optional. The BCP-47 language code, such as "en-US" or "sr-Latn". For more
+        #     information, see
+        #     https://www.unicode.org/reports/tr35/#Unicode_locale_identifier.
+        # @!attribute [r] cloud_identity_info
+        #   @return [::Google::Cloud::Channel::V1::CloudIdentityInfo]
+        #     Output only. Cloud Identity information for the customer.
+        #     Populated only if a Cloud Identity account exists for this customer.
+        # @!attribute [rw] channel_partner_id
+        #   @return [::String]
+        #     Cloud Identity ID of the customer's channel partner.
+        #     Populated only if a channel partner exists for this customer.
+        class Customer
+          include ::Google::Protobuf::MessageExts
+          extend ::Google::Protobuf::MessageExts::ClassMethods
+        end
+
+        # Contact information for a customer account.
+        # @!attribute [rw] first_name
+        #   @return [::String]
+        #     First name of the contact in the customer account.
+        # @!attribute [rw] last_name
+        #   @return [::String]
+        #     Last name of the contact in the customer account.
+        # @!attribute [r] display_name
+        #   @return [::String]
+        #     Output only. Display name of the contact in the customer account.
+        #     Populated by combining customer first name and last name.
+        # @!attribute [rw] email
+        #   @return [::String]
+        #     Email of the contact in the customer account.
+        #     Email is required for entitlements that need creation of admin.google.com
+        #     accounts. The email will be the username used in credentials to access the
+        #     admin.google.com account.
+        # @!attribute [rw] title
+        #   @return [::String]
+        #     Optional. Job title of the contact in the customer account.
+        # @!attribute [rw] phone
+        #   @return [::String]
+        #     Phone number of the contact in the customer account.
+        class ContactInfo
+          include ::Google::Protobuf::MessageExts
+          extend ::Google::Protobuf::MessageExts::ClassMethods
+        end
+      end
+    end
+  end
+end

data/proto_docs/google/cloud/channel/v1/entitlements.rb

@@ -0,0 +1,255 @@
+# frozen_string_literal: true
+
+# Copyright 2021 Google LLC
+#
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+#     https://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+
+# Auto-generated by gapic-generator-ruby. DO NOT EDIT!
+
+
+module Google
+  module Cloud
+    module Channel
+      module V1
+        # An entitlement is a representation of a customer's ability to use a service.
+        # @!attribute [r] name
+        #   @return [::String]
+        #     Output only. Resource name of an entitlement in the form:
+        #     accounts/\\{account_id}/customers/\\{customer_id}/entitlements/\\{entitlement_id}.
+        # @!attribute [r] create_time
+        #   @return [::Google::Protobuf::Timestamp]
+        #     Output only. The time at which the entitlement is created.
+        # @!attribute [r] update_time
+        #   @return [::Google::Protobuf::Timestamp]
+        #     Output only. The time at which the entitlement is updated.
+        # @!attribute [rw] offer
+        #   @return [::String]
+        #     Required. The offer resource name for which the entitlement is to be
+        #     created. Takes the form: accounts/\\{account_id}/offers/\\{offer_id}.
+        # @!attribute [rw] commitment_settings
+        #   @return [::Google::Cloud::Channel::V1::CommitmentSettings]
+        #     Commitment settings for a commitment-based Offer.
+        #     Required for commitment based offers.
+        # @!attribute [r] provisioning_state
+        #   @return [::Google::Cloud::Channel::V1::Entitlement::ProvisioningState]
+        #     Output only. Current provisioning state of the entitlement.
+        # @!attribute [r] provisioned_service
+        #   @return [::Google::Cloud::Channel::V1::ProvisionedService]
+        #     Output only. Service provisioning details for the entitlement.
+        # @!attribute [r] suspension_reasons
+        #   @return [::Array<::Google::Cloud::Channel::V1::Entitlement::SuspensionReason>]
+        #     Output only. Enumerable of all current suspension reasons for an entitlement.
+        # @!attribute [rw] purchase_order_id
+        #   @return [::String]
+        #     Optional. 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.
+        # @!attribute [r] trial_settings
+        #   @return [::Google::Cloud::Channel::V1::TrialSettings]
+        #     Output only. Settings for trial offers.
+        # @!attribute [rw] association_info
+        #   @return [::Google::Cloud::Channel::V1::AssociationInfo]
+        #     Association information to other entitlements.
+        # @!attribute [rw] parameters
+        #   @return [::Array<::Google::Cloud::Channel::V1::Parameter>]
+        #     Extended entitlement parameters. When creating an entitlement, valid
+        #     parameters' names and values are defined in the offer's parameter
+        #     definitions.
+        class Entitlement
+          include ::Google::Protobuf::MessageExts
+          extend ::Google::Protobuf::MessageExts::ClassMethods
+
+          # Indicates the current provisioning state of the entitlement.
+          module ProvisioningState
+            # Default value. This state doesn't show unless an error occurs.
+            PROVISIONING_STATE_UNSPECIFIED = 0
+
+            # The entitlement is currently active.
+            ACTIVE = 1
+
+            # The entitlement is currently suspended.
+            SUSPENDED = 5
+          end
+
+          # Suspension reason for an entitlement if {::Google::Cloud::Channel::V1::Entitlement#provisioning_state provisioning_state} = SUSPENDED.
+          module SuspensionReason
+            # Default value. This state doesn't show unless an error occurs.
+            SUSPENSION_REASON_UNSPECIFIED = 0
+
+            # Entitlement was manually suspended by the Reseller.
+            RESELLER_INITIATED = 1
+
+            # Trial ended.
+            TRIAL_ENDED = 2
+
+            # Entitlement renewal was canceled.
+            RENEWAL_WITH_TYPE_CANCEL = 3
+
+            # Entitlement was automatically suspended on creation for pending ToS
+            # acceptance on customer.
+            PENDING_TOS_ACCEPTANCE = 4
+
+            # Other reasons (internal reasons, abuse, etc.).
+            OTHER = 100
+          end
+        end
+
+        # Definition for extended entitlement parameters.
+        # @!attribute [rw] name
+        #   @return [::String]
+        #     Name of the parameter.
+        # @!attribute [rw] value
+        #   @return [::Google::Cloud::Channel::V1::Value]
+        #     Value of the parameter.
+        # @!attribute [r] editable
+        #   @return [::Boolean]
+        #     Output only. Specifies whether this parameter is allowed to be changed. For example, for
+        #     a Google Workspace Business Starter entitlement in commitment plan,
+        #     num_units is editable when entitlement is active.
+        class Parameter
+          include ::Google::Protobuf::MessageExts
+          extend ::Google::Protobuf::MessageExts::ClassMethods
+        end
+
+        # Association links that an entitlement has to other entitlements.
+        # @!attribute [rw] base_entitlement
+        #   @return [::String]
+        #     The name of the base entitlement, for which this entitlement is an add-on.
+        class AssociationInfo
+          include ::Google::Protobuf::MessageExts
+          extend ::Google::Protobuf::MessageExts::ClassMethods
+        end
+
+        # Service provisioned for an entitlement.
+        # @!attribute [r] provisioning_id
+        #   @return [::String]
+        #     Output only. Provisioning ID of the entitlement. For Google Workspace, this would be the
+        #     underlying Subscription ID.
+        # @!attribute [r] product_id
+        #   @return [::String]
+        #     Output only. The product pertaining to the provisioning resource as specified in the
+        #     Offer.
+        # @!attribute [r] sku_id
+        #   @return [::String]
+        #     Output only. The SKU pertaining to the provisioning resource as specified in the Offer.
+        class ProvisionedService
+          include ::Google::Protobuf::MessageExts
+          extend ::Google::Protobuf::MessageExts::ClassMethods
+        end
+
+        # Commitment settings for commitment-based offers.
+        # @!attribute [r] start_time
+        #   @return [::Google::Protobuf::Timestamp]
+        #     Output only. Commitment start timestamp.
+        # @!attribute [r] end_time
+        #   @return [::Google::Protobuf::Timestamp]
+        #     Output only. Commitment end timestamp.
+        # @!attribute [rw] renewal_settings
+        #   @return [::Google::Cloud::Channel::V1::RenewalSettings]
+        #     Optional. Renewal settings applicable for a commitment-based Offer.
+        class CommitmentSettings
+          include ::Google::Protobuf::MessageExts
+          extend ::Google::Protobuf::MessageExts::ClassMethods
+        end
+
+        # Renewal settings for renewable Offers.
+        # @!attribute [rw] enable_renewal
+        #   @return [::Boolean]
+        #     If false, the plan will be completed at the end date.
+        # @!attribute [rw] resize_unit_count
+        #   @return [::Boolean]
+        #     If true and enable_renewal = true, the unit (for example seats or licenses)
+        #     will be set to the number of active units at renewal time.
+        # @!attribute [rw] payment_plan
+        #   @return [::Google::Cloud::Channel::V1::PaymentPlan]
+        #     Describes how a reseller will be billed.
+        # @!attribute [rw] payment_cycle
+        #   @return [::Google::Cloud::Channel::V1::Period]
+        #     Describes how frequently the reseller will be billed, such as
+        #     once per month.
+        class RenewalSettings
+          include ::Google::Protobuf::MessageExts
+          extend ::Google::Protobuf::MessageExts::ClassMethods
+        end
+
+        # Settings for trial offers.
+        # @!attribute [rw] trial
+        #   @return [::Boolean]
+        #     Determines if the entitlement is in a trial or not:
+        #
+        #     * `true` - The entitlement is in trial.
+        #     * `false` - The entitlement is not in trial.
+        # @!attribute [rw] end_time
+        #   @return [::Google::Protobuf::Timestamp]
+        #     Date when the trial ends. The value is in milliseconds
+        #     using the UNIX Epoch format. See an example [Epoch
+        #     converter](https://www.epochconverter.com).
+        class TrialSettings
+          include ::Google::Protobuf::MessageExts
+          extend ::Google::Protobuf::MessageExts::ClassMethods
+        end
+
+        # TransferableSku represents information a reseller needs to view existing
+        # provisioned services for a customer that they do not own.
+        # Read-only.
+        # @!attribute [rw] is_commitment
+        #   @return [::Google::Protobuf::BoolValue]
+        #     Whether a transferable SKU is commitment-based or not.
+        # @!attribute [rw] commitment_end_timestamp
+        #   @return [::Google::Protobuf::Timestamp]
+        #     Commitment end timestamp.
+        # @!attribute [rw] transfer_eligibility
+        #   @return [::Google::Cloud::Channel::V1::TransferEligibility]
+        #     Describes the transfer eligibility of a SKU.
+        # @!attribute [rw] sku
+        #   @return [::Google::Cloud::Channel::V1::Sku]
+        #     The SKU pertaining to the provisioning resource as specified in the Offer.
+        class TransferableSku
+          include ::Google::Protobuf::MessageExts
+          extend ::Google::Protobuf::MessageExts::ClassMethods
+        end
+
+        # Specifies transfer eligibility of a SKU.
+        # @!attribute [rw] is_eligible
+        #   @return [::Boolean]
+        #     Whether reseller is eligible to transfer the SKU.
+        # @!attribute [rw] description
+        #   @return [::String]
+        #     Localized description if reseller is not eligible to transfer the SKU.
+        # @!attribute [rw] ineligibility_reason
+        #   @return [::Google::Cloud::Channel::V1::TransferEligibility::Reason]
+        #     Specified the reason for ineligibility.
+        class TransferEligibility
+          include ::Google::Protobuf::MessageExts
+          extend ::Google::Protobuf::MessageExts::ClassMethods
+
+          # Reason of ineligibility.
+          module Reason
+            # Reason is not available.
+            REASON_UNSPECIFIED = 0
+
+            # Reseller needs to accept TOS before transferring the SKU.
+            PENDING_TOS_ACCEPTANCE = 1
+
+            # Reseller not eligible to sell the SKU.
+            SKU_NOT_ELIGIBLE = 2
+
+            # SKU subscription is suspended
+            SKU_SUSPENDED = 3
+          end
+        end
+      end
+    end
+  end
+end