google-apis-paymentsresellersubscription_v1 0.47.0 → 0.49.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: e9e261fff3ebdeac9e64a9647457e5d43eaaa54684cb28033993f8c2ba020bcf
-  data.tar.gz: 51baa59a0f80651e914520cee0a1d139637796849e1037f64bfeec2e255fbbd9
+  metadata.gz: dcce34d9c9ab68a8b25ec5f47f7c808c53d1fab94c565748c37bcc250f5dfb05
+  data.tar.gz: b2fe7a15053d9ada6c6cf6b7962fac4c546a712fbf61a826441d3ee480fadbe1
 SHA512:
-  metadata.gz: ecf996c7592046b6fe3e518a812d92f797047ea59f25dcdb559490dff6fb6e0705d0b7f64922fadefc70f2408cac04903e5b5925c683980dcde2c96daa1f1fda
-  data.tar.gz: 40c3d8d6bd0b50db9aecdc34d9d9f8652658dcdf854130aa905d3bd10b00a770de9c582f28fe1165558a6e29bbd64c4a9f9d6f4953ba62fa3aaedd47ec651570
+  metadata.gz: b45051cc9e1cb492b900dba50b629eefc2bcabc50364fc186876b5034db98705f54d3c07e920e4db4ac64186495f7485d9440d653f43b063ce66a7fb9e65adff
+  data.tar.gz: 923eeecdc461a8573669e60960c02e1a46f3dae800b8036c281b7b6111783583f1503d17a7fd6059d7bee6fc06ed282b3bf91d6a1c41424cbae75f1cf385f48b

data/CHANGELOG.md

@@ -1,5 +1,13 @@
 # Release history for google-apis-paymentsresellersubscription_v1
 
+### v0.49.0 (2025-03-30)
+
+* Regenerated from discovery document revision 20250327
+
+### v0.48.0 (2025-03-16)
+
+* Regenerated from discovery document revision 20250312
+
 ### v0.47.0 (2025-03-09)
 
 * Regenerated from discovery document revision 20250302

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

@@ -506,8 +506,8 @@ module Google
       class GoogleCloudPaymentsResellerSubscriptionV1GoogleHomePayload
         include Google::Apis::Core::Hashable
       
-        # Output only. Output only. This identifies whether the subscription is attached
-        # to a Google Home structure.
+        # Output only. This identifies whether the subscription is attached to a Google
+        # Home structure.
         # Corresponds to the JSON property `attachedToGoogleStructure`
         # @return [Boolean]
         attr_accessor :attached_to_google_structure
@@ -696,7 +696,7 @@ module Google
         # @return [Array<Google::Apis::PaymentsresellersubscriptionV1::GoogleCloudPaymentsResellerSubscriptionV1ProductPriceConfig>]
         attr_accessor :price_configs
       
-        # Output only. Output Only. Specifies the type of the product.
+        # Output only. Specifies the type of the product.
         # Corresponds to the JSON property `productType`
         # @return [String]
         attr_accessor :product_type
@@ -843,7 +843,7 @@ module Google
         # @return [String]
         attr_accessor :name
       
-        # Output only. Output Only. Specifies the type of the promotion.
+        # Output only. Specifies the type of the promotion.
         # Corresponds to the JSON property `promotionType`
         # @return [String]
         attr_accessor :promotion_type
@@ -917,8 +917,7 @@ module Google
         # @return [Fixnum]
         attr_accessor :discount_ratio_micros
       
-        # Output only. Output Only. The duration of an introductory offer in billing
-        # cycles.
+        # Output only. The duration of an introductory offer in billing cycles.
         # Corresponds to the JSON property `recurrenceCount`
         # @return [Fixnum]
         attr_accessor :recurrence_count
@@ -942,6 +941,46 @@ module Google
         end
       end
       
+      # Request to resume a suspended subscription.
+      class GoogleCloudPaymentsResellerSubscriptionV1ResumeSubscriptionRequest
+        include Google::Apis::Core::Hashable
+      
+        def initialize(**args)
+           update!(**args)
+        end
+      
+        # Update properties of this object
+        def update!(**args)
+        end
+      end
+      
+      # Response that contains the resumed subscription.
+      class GoogleCloudPaymentsResellerSubscriptionV1ResumeSubscriptionResponse
+        include Google::Apis::Core::Hashable
+      
+        # 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
+      
+        def initialize(**args)
+           update!(**args)
+        end
+      
+        # Update properties of this object
+        def update!(**args)
+          @subscription = args[:subscription] if args.key?(:subscription)
+        end
+      end
+      
       # A description of what time period or moment in time the product or service is
       # being delivered over.
       class GoogleCloudPaymentsResellerSubscriptionV1ServicePeriod
@@ -1382,6 +1421,46 @@ module Google
         end
       end
       
+      # Request to suspend a subscription.
+      class GoogleCloudPaymentsResellerSubscriptionV1SuspendSubscriptionRequest
+        include Google::Apis::Core::Hashable
+      
+        def initialize(**args)
+           update!(**args)
+        end
+      
+        # Update properties of this object
+        def update!(**args)
+        end
+      end
+      
+      # Response that contains the suspended subscription.
+      class GoogleCloudPaymentsResellerSubscriptionV1SuspendSubscriptionResponse
+        include Google::Apis::Core::Hashable
+      
+        # 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
+      
+        def initialize(**args)
+           update!(**args)
+        end
+      
+        # Update properties of this object
+        def update!(**args)
+          @subscription = args[:subscription] if args.key?(:subscription)
+        end
+      end
+      
       # Request to revoke a cancellation request.
       class GoogleCloudPaymentsResellerSubscriptionV1UndoCancelSubscriptionRequest
         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.47.0"
+      GEM_VERSION = "0.49.0"
 
       # Version of the code generator used to generate this client
       GENERATOR_VERSION = "0.16.0"
 
       # Revision of the discovery document this client was generated from
-      REVISION = "20250302"
+      REVISION = "20250327"
     end
   end
 end

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

@@ -202,6 +202,18 @@ module Google
         include Google::Apis::Core::JsonObjectSupport
       end
       
+      class GoogleCloudPaymentsResellerSubscriptionV1ResumeSubscriptionRequest
+        class Representation < Google::Apis::Core::JsonRepresentation; end
+      
+        include Google::Apis::Core::JsonObjectSupport
+      end
+      
+      class GoogleCloudPaymentsResellerSubscriptionV1ResumeSubscriptionResponse
+        class Representation < Google::Apis::Core::JsonRepresentation; end
+      
+        include Google::Apis::Core::JsonObjectSupport
+      end
+      
       class GoogleCloudPaymentsResellerSubscriptionV1ServicePeriod
         class Representation < Google::Apis::Core::JsonRepresentation; end
       
@@ -256,6 +268,18 @@ module Google
         include Google::Apis::Core::JsonObjectSupport
       end
       
+      class GoogleCloudPaymentsResellerSubscriptionV1SuspendSubscriptionRequest
+        class Representation < Google::Apis::Core::JsonRepresentation; end
+      
+        include Google::Apis::Core::JsonObjectSupport
+      end
+      
+      class GoogleCloudPaymentsResellerSubscriptionV1SuspendSubscriptionResponse
+        class Representation < Google::Apis::Core::JsonRepresentation; end
+      
+        include Google::Apis::Core::JsonObjectSupport
+      end
+      
       class GoogleCloudPaymentsResellerSubscriptionV1UndoCancelSubscriptionRequest
         class Representation < Google::Apis::Core::JsonRepresentation; end
       
@@ -577,6 +601,20 @@ module Google
         end
       end
       
+      class GoogleCloudPaymentsResellerSubscriptionV1ResumeSubscriptionRequest
+        # @private
+        class Representation < Google::Apis::Core::JsonRepresentation
+        end
+      end
+      
+      class GoogleCloudPaymentsResellerSubscriptionV1ResumeSubscriptionResponse
+        # @private
+        class Representation < Google::Apis::Core::JsonRepresentation
+          property :subscription, as: 'subscription', class: Google::Apis::PaymentsresellersubscriptionV1::GoogleCloudPaymentsResellerSubscriptionV1Subscription, decorator: Google::Apis::PaymentsresellersubscriptionV1::GoogleCloudPaymentsResellerSubscriptionV1Subscription::Representation
+      
+        end
+      end
+      
       class GoogleCloudPaymentsResellerSubscriptionV1ServicePeriod
         # @private
         class Representation < Google::Apis::Core::JsonRepresentation
@@ -691,6 +729,20 @@ module Google
         end
       end
       
+      class GoogleCloudPaymentsResellerSubscriptionV1SuspendSubscriptionRequest
+        # @private
+        class Representation < Google::Apis::Core::JsonRepresentation
+        end
+      end
+      
+      class GoogleCloudPaymentsResellerSubscriptionV1SuspendSubscriptionResponse
+        # @private
+        class Representation < Google::Apis::Core::JsonRepresentation
+          property :subscription, as: 'subscription', class: Google::Apis::PaymentsresellersubscriptionV1::GoogleCloudPaymentsResellerSubscriptionV1Subscription, decorator: Google::Apis::PaymentsresellersubscriptionV1::GoogleCloudPaymentsResellerSubscriptionV1Subscription::Representation
+      
+        end
+      end
+      
       class GoogleCloudPaymentsResellerSubscriptionV1UndoCancelSubscriptionRequest
         # @private
         class Representation < Google::Apis::Core::JsonRepresentation

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

@@ -51,9 +51,9 @@ module Google
           @batch_path = 'batch'
         end
         
-        # To retrieve the products that can be resold by the partner. It should be
-        # autenticated with a service account. - This API doesn't apply to YouTube
-        # products currently.
+        # Currently, it doesn't support **YouTube** products. Retrieves the products
+        # that can be resold by the partner. It should be autenticated with a service
+        # account.
         # @param [String] parent
         #   Required. The parent, the partner that can resell. Format: partners/`partner`
         # @param [String] filter
@@ -104,9 +104,9 @@ module Google
           execute_or_queue_command(command, &block)
         end
         
-        # To find eligible promotions for the current user. The API requires user
-        # authorization via OAuth. The bare minimum oauth scope `openid` is sufficient,
-        # which will skip the consent screen.
+        # Currently, it is only enabeld for **YouTube**. Finds eligible promotions for
+        # the current user. The API requires user authorization via OAuth. The bare
+        # minimum oauth scope `openid` is sufficient, which will skip the consent screen.
         # @param [String] parent
         #   Required. The parent, the partner that can resell. Format: partners/`partner`
         # @param [Google::Apis::PaymentsresellersubscriptionV1::GoogleCloudPaymentsResellerSubscriptionV1FindEligiblePromotionsRequest] google_cloud_payments_reseller_subscription_v1_find_eligible_promotions_request_object
@@ -139,8 +139,8 @@ module Google
           execute_or_queue_command(command, &block)
         end
         
-        # Retrieves the promotions, such as free trial, that can be used by the partner.
-        # - This API doesn't apply to YouTube promotions currently. It should be
+        # Currently, it doesn't support **YouTube** promotions. Retrieves the promotions,
+        # such as free trial, that can be used by the partner. It should be
         # autenticated with a service account.
         # @param [String] parent
         #   Required. The parent, the partner that can resell. Format: partners/`partner`
@@ -194,9 +194,9 @@ module Google
           execute_or_queue_command(command, &block)
         end
         
-        # Used by partners to cancel a subscription service either immediately or by the
-        # end of the current billing cycle for their customers. It should be called
-        # directly by the partner using service accounts.
+        # Cancels a subscription service either immediately or by the end of the current
+        # billing cycle for their customers. It should be called directly by the partner
+        # using service accounts.
         # @param [String] name
         #   Required. The name of the subscription resource to be cancelled. It will have
         #   the format of "partners/`partner_id`/subscriptions/`subscription_id`"
@@ -272,10 +272,9 @@ module Google
           execute_or_queue_command(command, &block)
         end
         
-        # Used by partners to entitle a previously provisioned subscription to the
-        # current end user. The end user identity is inferred from the authorized
-        # credential of the request. This API must be authorized by the end user using
-        # OAuth.
+        # Entitles a previously provisioned subscription to the current end user. The
+        # end user identity is inferred from the authorized credential of the request.
+        # This API must be authorized by the end user using OAuth.
         # @param [String] name
         #   Required. The name of the subscription resource that is entitled to the
         #   current end user. It will have the format of "partners/`partner_id`/
@@ -310,10 +309,10 @@ module Google
           execute_or_queue_command(command, &block)
         end
         
-        # [Opt-in only] Most partners should be on auto-extend by default. Used by
-        # partners to extend a subscription service for their customers on an ongoing
-        # basis for the subscription to remain active and renewable. It should be called
-        # directly by the partner using service accounts.
+        # [Opt-in only] Most partners should be on auto-extend by default. Extends a
+        # subscription service for their customers on an ongoing basis for the
+        # subscription to remain active and renewable. It should be called directly by
+        # the partner using service accounts.
         # @param [String] name
         #   Required. The name of the subscription resource to be extended. It will have
         #   the format of "partners/`partner_id`/subscriptions/`subscription_id`".
@@ -347,8 +346,8 @@ module Google
           execute_or_queue_command(command, &block)
         end
         
-        # Used by partners to get a subscription by id. It should be called directly by
-        # the partner using service accounts.
+        # Gets a subscription by id. It should be called directly by the partner using
+        # service accounts.
         # @param [String] name
         #   Required. The name of the subscription resource to retrieve. It will have the
         #   format of "partners/`partner_id`/subscriptions/`subscription_id`"
@@ -423,10 +422,83 @@ module Google
           execute_or_queue_command(command, &block)
         end
         
-        # Revokes the pending cancellation of a subscription, which is currently in `
+        # Resumes a suspended subscription. The new billing cycle will start at the time
+        # of the request. It should be called directly by the partner using service
+        # accounts.
+        # @param [String] name
+        #   Required. The name of the subscription resource to be resumed. It will have
+        #   the format of "partners/`partner_id`/subscriptions/`subscription_id`"
+        # @param [Google::Apis::PaymentsresellersubscriptionV1::GoogleCloudPaymentsResellerSubscriptionV1ResumeSubscriptionRequest] google_cloud_payments_reseller_subscription_v1_resume_subscription_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::GoogleCloudPaymentsResellerSubscriptionV1ResumeSubscriptionResponse] parsed result object
+        # @yieldparam err [StandardError] error object if request failed
+        #
+        # @return [Google::Apis::PaymentsresellersubscriptionV1::GoogleCloudPaymentsResellerSubscriptionV1ResumeSubscriptionResponse]
+        #
+        # @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 resume_partner_subscription(name, google_cloud_payments_reseller_subscription_v1_resume_subscription_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
+          command = make_simple_command(:post, 'v1/{+name}:resume', options)
+          command.request_representation = Google::Apis::PaymentsresellersubscriptionV1::GoogleCloudPaymentsResellerSubscriptionV1ResumeSubscriptionRequest::Representation
+          command.request_object = google_cloud_payments_reseller_subscription_v1_resume_subscription_request_object
+          command.response_representation = Google::Apis::PaymentsresellersubscriptionV1::GoogleCloudPaymentsResellerSubscriptionV1ResumeSubscriptionResponse::Representation
+          command.response_class = Google::Apis::PaymentsresellersubscriptionV1::GoogleCloudPaymentsResellerSubscriptionV1ResumeSubscriptionResponse
+          command.params['name'] = name unless name.nil?
+          command.query['fields'] = fields unless fields.nil?
+          command.query['quotaUser'] = quota_user unless quota_user.nil?
+          execute_or_queue_command(command, &block)
+        end
+        
+        # Suspends a subscription. Contract terms may dictate if a prorated refund will
+        # be issued upon suspension. It should be called directly by the partner using
+        # service accounts.
+        # @param [String] name
+        #   Required. The name of the subscription resource to be suspended. It will have
+        #   the format of "partners/`partner_id`/subscriptions/`subscription_id`"
+        # @param [Google::Apis::PaymentsresellersubscriptionV1::GoogleCloudPaymentsResellerSubscriptionV1SuspendSubscriptionRequest] google_cloud_payments_reseller_subscription_v1_suspend_subscription_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::GoogleCloudPaymentsResellerSubscriptionV1SuspendSubscriptionResponse] parsed result object
+        # @yieldparam err [StandardError] error object if request failed
+        #
+        # @return [Google::Apis::PaymentsresellersubscriptionV1::GoogleCloudPaymentsResellerSubscriptionV1SuspendSubscriptionResponse]
+        #
+        # @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 suspend_partner_subscription(name, google_cloud_payments_reseller_subscription_v1_suspend_subscription_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
+          command = make_simple_command(:post, 'v1/{+name}:suspend', options)
+          command.request_representation = Google::Apis::PaymentsresellersubscriptionV1::GoogleCloudPaymentsResellerSubscriptionV1SuspendSubscriptionRequest::Representation
+          command.request_object = google_cloud_payments_reseller_subscription_v1_suspend_subscription_request_object
+          command.response_representation = Google::Apis::PaymentsresellersubscriptionV1::GoogleCloudPaymentsResellerSubscriptionV1SuspendSubscriptionResponse::Representation
+          command.response_class = Google::Apis::PaymentsresellersubscriptionV1::GoogleCloudPaymentsResellerSubscriptionV1SuspendSubscriptionResponse
+          command.params['name'] = name unless name.nil?
+          command.query['fields'] = fields unless fields.nil?
+          command.query['quotaUser'] = quota_user unless quota_user.nil?
+          execute_or_queue_command(command, &block)
+        end
+        
+        # Currently, it is used by **Google One, Play Pass** partners. Revokes the
+        # pending cancellation of a subscription, which is currently in `
         # STATE_CANCEL_AT_END_OF_CYCLE` state. If the subscription is already cancelled,
-        # the request will fail. - **This API doesn't apply to YouTube subscriptions.**
-        # It should be called directly by the partner using service accounts.
+        # the request will fail. It should be called directly by the partner using
+        # service accounts.
         # @param [String] name
         #   Required. The name of the subscription resource whose pending cancellation
         #   needs to be undone. It will have the format of "partners/`partner_id`/
@@ -462,10 +534,10 @@ module Google
         end
         
         # This API replaces user authorized OAuth consent 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 the same request if
-        # necessary, regardless of the previous tokens being expired or not.
+        # Issues a timed session token for the given 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 the 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

metadata

@@ -1,13 +1,13 @@
 --- !ruby/object:Gem::Specification
 name: google-apis-paymentsresellersubscription_v1
 version: !ruby/object:Gem::Version
-  version: 0.47.0
+  version: 0.49.0
 platform: ruby
 authors:
 - Google LLC
 bindir: bin
 cert_chain: []
-date: 2025-03-09 00:00:00.000000000 Z
+date: 2025-03-30 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: google-apis-core
@@ -57,7 +57,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.47.0
+  documentation_uri: https://googleapis.dev/ruby/google-apis-paymentsresellersubscription_v1/v0.49.0
   source_code_uri: https://github.com/googleapis/google-api-ruby-client/tree/main/generated/google-apis-paymentsresellersubscription_v1
 rdoc_options: []
 require_paths: