google-apis-paymentsresellersubscription_v1 0.43.0 → 0.44.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 25a72439c7db3290a93b10c6566264ac0272f04ce31de4aafbf477b81e2c418e
-  data.tar.gz: 247327166158c86ddb4250aab79664dbfc40f551e12beb02c7728e6a23f80c40
+  metadata.gz: 0b43788999cba2a59778bc1dd4121bede52e5d7c5a65bb84ed0bb528c671af0c
+  data.tar.gz: a0d8094a5149d199d77aa249eee8ed1882c35a0e03ce98b11a95df8ff4ba3d26
 SHA512:
-  metadata.gz: 24eec46035c9e0f02735e9641991aea0d16995113d5910a6d23364f8bd357079fdbbe9e86654e95373308b4ee0918bbbbcf9f42c2f1a04309a213ce022109f76
-  data.tar.gz: 82a7e7de089da2b8c727b84f866569631bb12f1457789d1f41d526af230c47abc77a073afeba99b6c479baeabc9332b2ac49788347a36ffb218999140208f6e3
+  metadata.gz: cc9bda129363b784bb27102a4ce128c11d8a87ad0c30d0180a9af72baa4771b52db0780fb436daf9fe8155be7928da96984e1e3e2b9c27089b765ccb2aca9311
+  data.tar.gz: b9d95a5bd7b00be418b73590d69a35b1368ece2ae3f0dd42621dd9bddd2b97c584112dd70575c80f2dce10eede7568c6f575a7886da97ae803a8772799b196d7

data/CHANGELOG.md

@@ -1,5 +1,10 @@
 # Release history for google-apis-paymentsresellersubscription_v1
 
+### v0.44.0 (2024-11-10)
+
+* Regenerated from discovery document revision 20241105
+* Regenerated using generator version 0.15.1
+
 ### v0.43.0 (2024-06-23)
 
 * Regenerated from discovery document revision 20240616

data/lib/google/apis/paymentsresellersubscription_v1/classes.rb

@@ -106,6 +106,48 @@ module Google
         end
       end
       
+      # Intent message for creating a Subscription resource.
+      class GoogleCloudPaymentsResellerSubscriptionV1CreateSubscriptionIntent
+        include Google::Apis::Core::Hashable
+      
+        # Required. The parent resource name, which is the identifier of the partner.
+        # Corresponds to the JSON property `parent`
+        # @return [String]
+        attr_accessor :parent
+      
+        # A subscription serves as a central billing entity between an external partner
+        # and Google. The underlying Google services rely on the subscription state to
+        # grant or revoke the user's service entitlement. It's important to note that
+        # the subscription state may not always perfectly align with the user's service
+        # entitlement. For example, some Google services may continue providing access
+        # to the user until the current billing cycle ends, even if the subscription has
+        # been immediately canceled. However, other services may not do the same. To
+        # fully understand the specific details, please consult the relevant contract or
+        # product policy.
+        # Corresponds to the JSON property `subscription`
+        # @return [Google::Apis::PaymentsresellersubscriptionV1::GoogleCloudPaymentsResellerSubscriptionV1Subscription]
+        attr_accessor :subscription
+      
+        # Required. Identifies the subscription resource on the Partner side. The value
+        # is restricted to 63 ASCII characters at the maximum. If a subscription was
+        # previously created with the same subscription_id, we will directly return that
+        # one.
+        # Corresponds to the JSON property `subscriptionId`
+        # @return [String]
+        attr_accessor :subscription_id
+      
+        def initialize(**args)
+           update!(**args)
+        end
+      
+        # Update properties of this object
+        def update!(**args)
+          @parent = args[:parent] if args.key?(:parent)
+          @subscription = args[:subscription] if args.key?(:subscription)
+          @subscription_id = args[:subscription_id] if args.key?(:subscription_id)
+        end
+      end
+      
       # Describes the length of a period of a time.
       class GoogleCloudPaymentsResellerSubscriptionV1Duration
         include Google::Apis::Core::Hashable
@@ -131,6 +173,26 @@ module Google
         end
       end
       
+      # Intent for entitling the previously provisioned subscription to an end user.
+      class GoogleCloudPaymentsResellerSubscriptionV1EntitleSubscriptionIntent
+        include Google::Apis::Core::Hashable
+      
+        # Required. The name of the subscription resource that is entitled to the
+        # current end user.
+        # Corresponds to the JSON property `name`
+        # @return [String]
+        attr_accessor :name
+      
+        def initialize(**args)
+           update!(**args)
+        end
+      
+        # Update properties of this object
+        def update!(**args)
+          @name = args[:name] if args.key?(:name)
+        end
+      end
+      
       # LINT.IfChange Partner request for entitling the previously provisioned
       # subscription to an end user. The end user identity is inferred from the
       # request OAuth context.
@@ -392,6 +454,55 @@ module Google
         end
       end
       
+      # [Preview only] Request to generate a user session.
+      class GoogleCloudPaymentsResellerSubscriptionV1GenerateUserSessionRequest
+        include Google::Apis::Core::Hashable
+      
+        # The payload that describes the user intent.
+        # Corresponds to the JSON property `intentPayload`
+        # @return [Google::Apis::PaymentsresellersubscriptionV1::GoogleCloudPaymentsResellerSubscriptionV1IntentPayload]
+        attr_accessor :intent_payload
+      
+        def initialize(**args)
+           update!(**args)
+        end
+      
+        # Update properties of this object
+        def update!(**args)
+          @intent_payload = args[:intent_payload] if args.key?(:intent_payload)
+        end
+      end
+      
+      # [Preview only] Response that contains the details for generated user session.
+      class GoogleCloudPaymentsResellerSubscriptionV1GenerateUserSessionResponse
+        include Google::Apis::Core::Hashable
+      
+        # A user session contains a short-lived token that includes information required
+        # to interact with Google Payments Reseller Platform using the following web
+        # endpoints. - A user session token should be generated dynamically for an
+        # authenticated user. You should refrain from sharing a token directly with a
+        # user in an unauthenticated context, such as SMS, or email. - You can re-
+        # generate new session tokens repeatedly for same `generate` request if
+        # necessary, regardless of the previous tokens being expired or not. You don't
+        # need to worry about multiple sessions resulting in duplicate fulfillments as
+        # guaranteed by the same subscription id. Please refer to the [Google Managed
+        # Signup](/payments/reseller/subscription/reference/index/User.Signup.
+        # Integration/Google.Managed.Signup.\(In.Preview\)) documentation for additional
+        # integration details.
+        # Corresponds to the JSON property `userSession`
+        # @return [Google::Apis::PaymentsresellersubscriptionV1::GoogleCloudPaymentsResellerSubscriptionV1UserSession]
+        attr_accessor :user_session
+      
+        def initialize(**args)
+           update!(**args)
+        end
+      
+        # Update properties of this object
+        def update!(**args)
+          @user_session = args[:user_session] if args.key?(:user_session)
+        end
+      end
+      
       # Payload specific to Google One products.
       class GoogleCloudPaymentsResellerSubscriptionV1GoogleOnePayload
         include Google::Apis::Core::Hashable
@@ -429,6 +540,31 @@ module Google
         end
       end
       
+      # The payload that describes the user intent.
+      class GoogleCloudPaymentsResellerSubscriptionV1IntentPayload
+        include Google::Apis::Core::Hashable
+      
+        # Intent message for creating a Subscription resource.
+        # Corresponds to the JSON property `createIntent`
+        # @return [Google::Apis::PaymentsresellersubscriptionV1::GoogleCloudPaymentsResellerSubscriptionV1CreateSubscriptionIntent]
+        attr_accessor :create_intent
+      
+        # Intent for entitling the previously provisioned subscription to an end user.
+        # Corresponds to the JSON property `entitleIntent`
+        # @return [Google::Apis::PaymentsresellersubscriptionV1::GoogleCloudPaymentsResellerSubscriptionV1EntitleSubscriptionIntent]
+        attr_accessor :entitle_intent
+      
+        def initialize(**args)
+           update!(**args)
+        end
+      
+        # Update properties of this object
+        def update!(**args)
+          @create_intent = args[:create_intent] if args.key?(:create_intent)
+          @entitle_intent = args[:entitle_intent] if args.key?(:entitle_intent)
+        end
+      end
+      
       # Response that contains the products.
       class GoogleCloudPaymentsResellerSubscriptionV1ListProductsResponse
         include Google::Apis::Core::Hashable
@@ -1227,6 +1363,44 @@ module Google
         end
       end
       
+      # A user session contains a short-lived token that includes information required
+      # to interact with Google Payments Reseller Platform using the following web
+      # endpoints. - A user session token should be generated dynamically for an
+      # authenticated user. You should refrain from sharing a token directly with a
+      # user in an unauthenticated context, such as SMS, or email. - You can re-
+      # generate new session tokens repeatedly for same `generate` request if
+      # necessary, regardless of the previous tokens being expired or not. You don't
+      # need to worry about multiple sessions resulting in duplicate fulfillments as
+      # guaranteed by the same subscription id. Please refer to the [Google Managed
+      # Signup](/payments/reseller/subscription/reference/index/User.Signup.
+      # Integration/Google.Managed.Signup.\(In.Preview\)) documentation for additional
+      # integration details.
+      class GoogleCloudPaymentsResellerSubscriptionV1UserSession
+        include Google::Apis::Core::Hashable
+      
+        # Output only. The time at which the user session expires.
+        # Corresponds to the JSON property `expireTime`
+        # @return [String]
+        attr_accessor :expire_time
+      
+        # Output only. The encrypted token of the user session, including the
+        # information of the user's intent and request. This token should be provided
+        # when redirecting the user to Google.
+        # Corresponds to the JSON property `token`
+        # @return [String]
+        attr_accessor :token
+      
+        def initialize(**args)
+           update!(**args)
+        end
+      
+        # Update properties of this object
+        def update!(**args)
+          @expire_time = args[:expire_time] if args.key?(:expire_time)
+          @token = args[:token] if args.key?(:token)
+        end
+      end
+      
       # Payload specific to Youtube products.
       class GoogleCloudPaymentsResellerSubscriptionV1YoutubePayload
         include Google::Apis::Core::Hashable

data/lib/google/apis/paymentsresellersubscription_v1/gem_version.rb

@@ -16,13 +16,13 @@ module Google
   module Apis
     module PaymentsresellersubscriptionV1
       # Version of the google-apis-paymentsresellersubscription_v1 gem
-      GEM_VERSION = "0.43.0"
+      GEM_VERSION = "0.44.0"
 
       # Version of the code generator used to generate this client
-      GENERATOR_VERSION = "0.15.0"
+      GENERATOR_VERSION = "0.15.1"
 
       # Revision of the discovery document this client was generated from
-      REVISION = "20240616"
+      REVISION = "20241105"
     end
   end
 end

data/lib/google/apis/paymentsresellersubscription_v1/representations.rb

@@ -40,12 +40,24 @@ module Google
         include Google::Apis::Core::JsonObjectSupport
       end
       
+      class GoogleCloudPaymentsResellerSubscriptionV1CreateSubscriptionIntent
+        class Representation < Google::Apis::Core::JsonRepresentation; end
+      
+        include Google::Apis::Core::JsonObjectSupport
+      end
+      
       class GoogleCloudPaymentsResellerSubscriptionV1Duration
         class Representation < Google::Apis::Core::JsonRepresentation; end
       
         include Google::Apis::Core::JsonObjectSupport
       end
       
+      class GoogleCloudPaymentsResellerSubscriptionV1EntitleSubscriptionIntent
+        class Representation < Google::Apis::Core::JsonRepresentation; end
+      
+        include Google::Apis::Core::JsonObjectSupport
+      end
+      
       class GoogleCloudPaymentsResellerSubscriptionV1EntitleSubscriptionRequest
         class Representation < Google::Apis::Core::JsonRepresentation; end
       
@@ -100,12 +112,30 @@ module Google
         include Google::Apis::Core::JsonObjectSupport
       end
       
+      class GoogleCloudPaymentsResellerSubscriptionV1GenerateUserSessionRequest
+        class Representation < Google::Apis::Core::JsonRepresentation; end
+      
+        include Google::Apis::Core::JsonObjectSupport
+      end
+      
+      class GoogleCloudPaymentsResellerSubscriptionV1GenerateUserSessionResponse
+        class Representation < Google::Apis::Core::JsonRepresentation; end
+      
+        include Google::Apis::Core::JsonObjectSupport
+      end
+      
       class GoogleCloudPaymentsResellerSubscriptionV1GoogleOnePayload
         class Representation < Google::Apis::Core::JsonRepresentation; end
       
         include Google::Apis::Core::JsonObjectSupport
       end
       
+      class GoogleCloudPaymentsResellerSubscriptionV1IntentPayload
+        class Representation < Google::Apis::Core::JsonRepresentation; end
+      
+        include Google::Apis::Core::JsonObjectSupport
+      end
+      
       class GoogleCloudPaymentsResellerSubscriptionV1ListProductsResponse
         class Representation < Google::Apis::Core::JsonRepresentation; end
       
@@ -226,6 +256,12 @@ module Google
         include Google::Apis::Core::JsonObjectSupport
       end
       
+      class GoogleCloudPaymentsResellerSubscriptionV1UserSession
+        class Representation < Google::Apis::Core::JsonRepresentation; end
+      
+        include Google::Apis::Core::JsonObjectSupport
+      end
+      
       class GoogleCloudPaymentsResellerSubscriptionV1YoutubePayload
         class Representation < Google::Apis::Core::JsonRepresentation; end
       
@@ -274,6 +310,16 @@ module Google
         end
       end
       
+      class GoogleCloudPaymentsResellerSubscriptionV1CreateSubscriptionIntent
+        # @private
+        class Representation < Google::Apis::Core::JsonRepresentation
+          property :parent, as: 'parent'
+          property :subscription, as: 'subscription', class: Google::Apis::PaymentsresellersubscriptionV1::GoogleCloudPaymentsResellerSubscriptionV1Subscription, decorator: Google::Apis::PaymentsresellersubscriptionV1::GoogleCloudPaymentsResellerSubscriptionV1Subscription::Representation
+      
+          property :subscription_id, as: 'subscriptionId'
+        end
+      end
+      
       class GoogleCloudPaymentsResellerSubscriptionV1Duration
         # @private
         class Representation < Google::Apis::Core::JsonRepresentation
@@ -282,6 +328,13 @@ module Google
         end
       end
       
+      class GoogleCloudPaymentsResellerSubscriptionV1EntitleSubscriptionIntent
+        # @private
+        class Representation < Google::Apis::Core::JsonRepresentation
+          property :name, as: 'name'
+        end
+      end
+      
       class GoogleCloudPaymentsResellerSubscriptionV1EntitleSubscriptionRequest
         # @private
         class Representation < Google::Apis::Core::JsonRepresentation
@@ -358,6 +411,22 @@ module Google
         end
       end
       
+      class GoogleCloudPaymentsResellerSubscriptionV1GenerateUserSessionRequest
+        # @private
+        class Representation < Google::Apis::Core::JsonRepresentation
+          property :intent_payload, as: 'intentPayload', class: Google::Apis::PaymentsresellersubscriptionV1::GoogleCloudPaymentsResellerSubscriptionV1IntentPayload, decorator: Google::Apis::PaymentsresellersubscriptionV1::GoogleCloudPaymentsResellerSubscriptionV1IntentPayload::Representation
+      
+        end
+      end
+      
+      class GoogleCloudPaymentsResellerSubscriptionV1GenerateUserSessionResponse
+        # @private
+        class Representation < Google::Apis::Core::JsonRepresentation
+          property :user_session, as: 'userSession', class: Google::Apis::PaymentsresellersubscriptionV1::GoogleCloudPaymentsResellerSubscriptionV1UserSession, decorator: Google::Apis::PaymentsresellersubscriptionV1::GoogleCloudPaymentsResellerSubscriptionV1UserSession::Representation
+      
+        end
+      end
+      
       class GoogleCloudPaymentsResellerSubscriptionV1GoogleOnePayload
         # @private
         class Representation < Google::Apis::Core::JsonRepresentation
@@ -368,6 +437,16 @@ module Google
         end
       end
       
+      class GoogleCloudPaymentsResellerSubscriptionV1IntentPayload
+        # @private
+        class Representation < Google::Apis::Core::JsonRepresentation
+          property :create_intent, as: 'createIntent', class: Google::Apis::PaymentsresellersubscriptionV1::GoogleCloudPaymentsResellerSubscriptionV1CreateSubscriptionIntent, decorator: Google::Apis::PaymentsresellersubscriptionV1::GoogleCloudPaymentsResellerSubscriptionV1CreateSubscriptionIntent::Representation
+      
+          property :entitle_intent, as: 'entitleIntent', class: Google::Apis::PaymentsresellersubscriptionV1::GoogleCloudPaymentsResellerSubscriptionV1EntitleSubscriptionIntent, decorator: Google::Apis::PaymentsresellersubscriptionV1::GoogleCloudPaymentsResellerSubscriptionV1EntitleSubscriptionIntent::Representation
+      
+        end
+      end
+      
       class GoogleCloudPaymentsResellerSubscriptionV1ListProductsResponse
         # @private
         class Representation < Google::Apis::Core::JsonRepresentation
@@ -595,6 +674,14 @@ module Google
         end
       end
       
+      class GoogleCloudPaymentsResellerSubscriptionV1UserSession
+        # @private
+        class Representation < Google::Apis::Core::JsonRepresentation
+          property :expire_time, as: 'expireTime'
+          property :token, as: 'token'
+        end
+      end
+      
       class GoogleCloudPaymentsResellerSubscriptionV1YoutubePayload
         # @private
         class Representation < Google::Apis::Core::JsonRepresentation

data/lib/google/apis/paymentsresellersubscription_v1/service.rb

@@ -460,6 +460,43 @@ module Google
           command.query['quotaUser'] = quota_user unless quota_user.nil?
           execute_or_queue_command(command, &block)
         end
+        
+        # This API replaces user authorized OAuth consnet based APIs (Create, Entitle).
+        # Generates a short-lived token for a user session based on the user intent. You
+        # can use the session token to redirect the user to Google to finish the signup
+        # flow. You can re-generate new session token repeatedly for same request if
+        # necessary, regardless of the previous tokens being expired or not.
+        # @param [String] parent
+        #   Required. The parent, the partner that can resell. Format: partners/`partner`
+        # @param [Google::Apis::PaymentsresellersubscriptionV1::GoogleCloudPaymentsResellerSubscriptionV1GenerateUserSessionRequest] google_cloud_payments_reseller_subscription_v1_generate_user_session_request_object
+        # @param [String] fields
+        #   Selector specifying which fields to include in a partial response.
+        # @param [String] quota_user
+        #   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::PaymentsresellersubscriptionV1::GoogleCloudPaymentsResellerSubscriptionV1GenerateUserSessionResponse] parsed result object
+        # @yieldparam err [StandardError] error object if request failed
+        #
+        # @return [Google::Apis::PaymentsresellersubscriptionV1::GoogleCloudPaymentsResellerSubscriptionV1GenerateUserSessionResponse]
+        #
+        # @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 generate_partner_user_session(parent, google_cloud_payments_reseller_subscription_v1_generate_user_session_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
+          command = make_simple_command(:post, 'v1/{+parent}/userSessions:generate', options)
+          command.request_representation = Google::Apis::PaymentsresellersubscriptionV1::GoogleCloudPaymentsResellerSubscriptionV1GenerateUserSessionRequest::Representation
+          command.request_object = google_cloud_payments_reseller_subscription_v1_generate_user_session_request_object
+          command.response_representation = Google::Apis::PaymentsresellersubscriptionV1::GoogleCloudPaymentsResellerSubscriptionV1GenerateUserSessionResponse::Representation
+          command.response_class = Google::Apis::PaymentsresellersubscriptionV1::GoogleCloudPaymentsResellerSubscriptionV1GenerateUserSessionResponse
+          command.params['parent'] = parent unless parent.nil?
+          command.query['fields'] = fields unless fields.nil?
+          command.query['quotaUser'] = quota_user unless quota_user.nil?
+          execute_or_queue_command(command, &block)
+        end
 
         protected
 

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: google-apis-paymentsresellersubscription_v1
 version: !ruby/object:Gem::Version
-  version: 0.43.0
+  version: 0.44.0
 platform: ruby
 authors:
 - Google LLC
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2024-06-23 00:00:00.000000000 Z
+date: 2024-11-17 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: google-apis-core
@@ -58,7 +58,7 @@ licenses:
 metadata:
   bug_tracker_uri: https://github.com/googleapis/google-api-ruby-client/issues
   changelog_uri: https://github.com/googleapis/google-api-ruby-client/tree/main/generated/google-apis-paymentsresellersubscription_v1/CHANGELOG.md
-  documentation_uri: https://googleapis.dev/ruby/google-apis-paymentsresellersubscription_v1/v0.43.0
+  documentation_uri: https://googleapis.dev/ruby/google-apis-paymentsresellersubscription_v1/v0.44.0
   source_code_uri: https://github.com/googleapis/google-api-ruby-client/tree/main/generated/google-apis-paymentsresellersubscription_v1
 post_install_message: 
 rdoc_options: []
@@ -75,7 +75,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.5.6
+rubygems_version: 3.5.22
 signing_key: 
 specification_version: 4
 summary: Simple REST client for Payments Reseller Subscription API V1