maxio-advanced-billing-sdk 5.0.0 → 5.1.0

data/lib/advanced_billing/controllers/subscription_invoice_account_controller.rb

@@ -11,7 +11,7 @@ module AdvancedBilling
     # Subscription's open, payable invoices.
     # @param [Integer] subscription_id Required parameter: The Chargify id of
     # the subscription
-    # @return [AccountBalances] response from the API call
+    # @return [AccountBalances] response from the API call.
     def read_account_balances(subscription_id)
       new_api_call_builder
         .request(new_request_builder(HttpMethodEnum::GET,
@@ -39,7 +39,7 @@ module AdvancedBilling
     # @param [Integer] subscription_id Required parameter: The Chargify id of
     # the subscription
     # @param [CreatePrepaymentRequest] body Optional parameter: Example:
-    # @return [CreatePrepaymentResponse] response from the API call
+    # @return [CreatePrepaymentResponse] response from the API call.
     def create_prepayment(subscription_id,
                           body: nil)
       new_api_call_builder
@@ -80,7 +80,7 @@ module AdvancedBilling
     # Use in query `per_page=200`.
     # @param [ListPrepaymentsFilter] filter Optional parameter: Filter to use
     # for List Prepayments operations
-    # @return [PrepaymentsResponse] response from the API call
+    # @return [PrepaymentsResponse] response from the API call.
     def list_prepayments(options = {})
       new_api_call_builder
         .request(new_request_builder(HttpMethodEnum::GET,
@@ -110,7 +110,7 @@ module AdvancedBilling
     # @param [Integer] subscription_id Required parameter: The Chargify id of
     # the subscription
     # @param [IssueServiceCreditRequest] body Optional parameter: Example:
-    # @return [ServiceCredit] response from the API call
+    # @return [ServiceCredit] response from the API call.
     def issue_service_credit(subscription_id,
                              body: nil)
       new_api_call_builder
@@ -141,7 +141,7 @@ module AdvancedBilling
     # @param [Integer] subscription_id Required parameter: The Chargify id of
     # the subscription
     # @param [DeductServiceCreditRequest] body Optional parameter: Example:
-    # @return [void] response from the API call
+    # @return [void] response from the API call.
     def deduct_service_credit(subscription_id,
                               body: nil)
       new_api_call_builder
@@ -174,7 +174,7 @@ module AdvancedBilling
     # the subscription
     # @param [Integer] prepayment_id Required parameter: id of prepayment
     # @param [RefundPrepaymentRequest] body Optional parameter: Example:
-    # @return [PrepaymentResponse] response from the API call
+    # @return [PrepaymentResponse] response from the API call.
     def refund_prepayment(subscription_id,
                           prepayment_id,
                           body: nil)

data/lib/advanced_billing/controllers/subscription_notes_controller.rb

@@ -19,7 +19,7 @@ module AdvancedBilling
     # @param [Integer] subscription_id Required parameter: The Chargify id of
     # the subscription
     # @param [UpdateSubscriptionNoteRequest] body Optional parameter: Example:
-    # @return [SubscriptionNoteResponse] response from the API call
+    # @return [SubscriptionNoteResponse] response from the API call.
     def create_subscription_note(subscription_id,
                                  body: nil)
       new_api_call_builder
@@ -55,7 +55,7 @@ module AdvancedBilling
     # many records to fetch in each request. Default value is 20. The maximum
     # allowed values is 200; any per_page value over 200 will be changed to 200.
     # Use in query `per_page=200`.
-    # @return [Array[SubscriptionNoteResponse]] response from the API call
+    # @return [Array[SubscriptionNoteResponse]] response from the API call.
     def list_subscription_notes(options = {})
       new_api_call_builder
         .request(new_request_builder(HttpMethodEnum::GET,
@@ -81,7 +81,7 @@ module AdvancedBilling
     # the subscription
     # @param [Integer] note_id Required parameter: The Advanced Billing id of
     # the note
-    # @return [SubscriptionNoteResponse] response from the API call
+    # @return [SubscriptionNoteResponse] response from the API call.
     def read_subscription_note(subscription_id,
                                note_id)
       new_api_call_builder
@@ -108,7 +108,7 @@ module AdvancedBilling
     # @param [Integer] note_id Required parameter: The Advanced Billing id of
     # the note
     # @param [UpdateSubscriptionNoteRequest] body Optional parameter: Example:
-    # @return [SubscriptionNoteResponse] response from the API call
+    # @return [SubscriptionNoteResponse] response from the API call.
     def update_subscription_note(subscription_id,
                                  note_id,
                                  body: nil)
@@ -138,7 +138,7 @@ module AdvancedBilling
     # the subscription
     # @param [Integer] note_id Required parameter: The Advanced Billing id of
     # the note
-    # @return [void] response from the API call
+    # @return [void] response from the API call.
     def delete_subscription_note(subscription_id,
                                  note_id)
       new_api_call_builder

data/lib/advanced_billing/controllers/subscription_products_controller.rb

@@ -103,7 +103,7 @@ module AdvancedBilling
     # the subscription
     # @param [SubscriptionProductMigrationRequest] body Optional parameter:
     # Example:
-    # @return [SubscriptionResponse] response from the API call
+    # @return [SubscriptionResponse] response from the API call.
     def migrate_subscription_product(subscription_id,
                                      body: nil)
       new_api_call_builder
@@ -140,7 +140,7 @@ module AdvancedBilling
     # the subscription
     # @param [SubscriptionMigrationPreviewRequest] body Optional parameter:
     # Example:
-    # @return [SubscriptionMigrationPreviewResponse] response from the API call
+    # @return [SubscriptionMigrationPreviewResponse] response from the API call.
     def preview_subscription_product_migration(subscription_id,
                                                body: nil)
       new_api_call_builder

data/lib/advanced_billing/controllers/subscription_status_controller.rb

@@ -14,7 +14,7 @@ module AdvancedBilling
     # The response will be `422 "Unprocessable Entity`.
     # @param [Integer] subscription_id Required parameter: The Chargify id of
     # the subscription
-    # @return [SubscriptionResponse] response from the API call
+    # @return [SubscriptionResponse] response from the API call.
     def retry_subscription(subscription_id)
       new_api_call_builder
         .request(new_request_builder(HttpMethodEnum::PUT,
@@ -40,7 +40,7 @@ module AdvancedBilling
     # @param [Integer] subscription_id Required parameter: The Chargify id of
     # the subscription
     # @param [CancellationRequest] body Optional parameter: Example:
-    # @return [SubscriptionResponse] response from the API call
+    # @return [SubscriptionResponse] response from the API call.
     def cancel_subscription(subscription_id,
                             body: nil)
       new_api_call_builder
@@ -77,7 +77,7 @@ module AdvancedBilling
     # @param [ResumptionCharge] calendar_billing_resumption_charge Optional
     # parameter: (For calendar billing subscriptions only) The way that the
     # resumed subscription's charge should be handled
-    # @return [SubscriptionResponse] response from the API call
+    # @return [SubscriptionResponse] response from the API call.
     def resume_subscription(subscription_id,
                             calendar_billing_resumption_charge: ResumptionCharge::PRORATED)
       new_api_call_builder
@@ -108,7 +108,7 @@ module AdvancedBilling
     # @param [Integer] subscription_id Required parameter: The Chargify id of
     # the subscription
     # @param [PauseRequest] body Optional parameter: Example:
-    # @return [SubscriptionResponse] response from the API call
+    # @return [SubscriptionResponse] response from the API call.
     def pause_subscription(subscription_id,
                            body: nil)
       new_api_call_builder
@@ -143,7 +143,7 @@ module AdvancedBilling
     # @param [Integer] subscription_id Required parameter: The Chargify id of
     # the subscription
     # @param [PauseRequest] body Optional parameter: Example:
-    # @return [SubscriptionResponse] response from the API call
+    # @return [SubscriptionResponse] response from the API call.
     def update_automatic_subscription_resumption(subscription_id,
                                                  body: nil)
       new_api_call_builder
@@ -309,7 +309,7 @@ module AdvancedBilling
     # @param [Integer] subscription_id Required parameter: The Chargify id of
     # the subscription
     # @param [ReactivateSubscriptionRequest] body Optional parameter: Example:
-    # @return [SubscriptionResponse] response from the API call
+    # @return [SubscriptionResponse] response from the API call.
     def reactivate_subscription(subscription_id,
                                 body: nil)
       new_api_call_builder
@@ -343,7 +343,7 @@ module AdvancedBilling
     # @param [Integer] subscription_id Required parameter: The Chargify id of
     # the subscription
     # @param [CancellationRequest] body Optional parameter: Example:
-    # @return [DelayedCancellationResponse] response from the API call
+    # @return [DelayedCancellationResponse] response from the API call.
     def initiate_delayed_cancellation(subscription_id,
                                       body: nil)
       new_api_call_builder
@@ -375,7 +375,7 @@ module AdvancedBilling
     # will be successful.
     # @param [Integer] subscription_id Required parameter: The Chargify id of
     # the subscription
-    # @return [DelayedCancellationResponse] response from the API call
+    # @return [DelayedCancellationResponse] response from the API call.
     def cancel_delayed_cancellation(subscription_id)
       new_api_call_builder
         .request(new_request_builder(HttpMethodEnum::DELETE,
@@ -399,7 +399,7 @@ module AdvancedBilling
     # active and the active Dunner will be resolved.
     # @param [Integer] subscription_id Required parameter: The Chargify id of
     # the subscription
-    # @return [SubscriptionResponse] response from the API call
+    # @return [SubscriptionResponse] response from the API call.
     def cancel_dunning(subscription_id)
       new_api_call_builder
         .request(new_request_builder(HttpMethodEnum::POST,
@@ -451,7 +451,7 @@ module AdvancedBilling
     # @param [Integer] subscription_id Required parameter: The Chargify id of
     # the subscription
     # @param [RenewalPreviewRequest] body Optional parameter: Example:
-    # @return [RenewalPreviewResponse] response from the API call
+    # @return [RenewalPreviewResponse] response from the API call.
     def preview_renewal(subscription_id,
                         body: nil)
       new_api_call_builder

data/lib/advanced_billing/controllers/subscriptions_controller.rb

@@ -795,7 +795,7 @@ module AdvancedBilling
     #   }
     # ```
     # @param [CreateSubscriptionRequest] body Optional parameter: Example:
-    # @return [SubscriptionResponse] response from the API call
+    # @return [SubscriptionResponse] response from the API call.
     def create_subscription(body: nil)
       new_api_call_builder
         .request(new_request_builder(HttpMethodEnum::POST,
@@ -881,7 +881,7 @@ module AdvancedBilling
     # @param [Array[SubscriptionListInclude]] include Optional parameter: Allows
     # including additional data in the response. Use in query:
     # `include[]=self_service_page_token`.
-    # @return [Array[SubscriptionResponse]] response from the API call
+    # @return [Array[SubscriptionResponse]] response from the API call.
     def list_subscriptions(options = {})
       new_api_call_builder
         .request(new_request_builder(HttpMethodEnum::GET,
@@ -977,7 +977,7 @@ module AdvancedBilling
     # @param [Integer] subscription_id Required parameter: The Chargify id of
     # the subscription
     # @param [UpdateSubscriptionRequest] body Optional parameter: Example:
-    # @return [SubscriptionResponse] response from the API call
+    # @return [SubscriptionResponse] response from the API call.
     def update_subscription(subscription_id,
                             body: nil)
       new_api_call_builder
@@ -1012,7 +1012,7 @@ module AdvancedBilling
     # @param [Array[SubscriptionInclude]] include Optional parameter: Allows
     # including additional data in the response. Use in query:
     # `include[]=coupons&include[]=self_service_page_token`.
-    # @return [SubscriptionResponse] response from the API call
+    # @return [SubscriptionResponse] response from the API call.
     def read_subscription(subscription_id,
                           include: nil)
       new_api_call_builder
@@ -1068,7 +1068,7 @@ module AdvancedBilling
     # the subscription
     # @param [OverrideSubscriptionRequest] body Optional parameter: Only these
     # fields are available to be set.
-    # @return [void] response from the API call
+    # @return [void] response from the API call.
     def override_subscription(subscription_id,
                               body: nil)
       new_api_call_builder
@@ -1093,7 +1093,7 @@ module AdvancedBilling
 
     # Use this endpoint to find a subscription by its reference.
     # @param [String] reference Optional parameter: Subscription reference
-    # @return [SubscriptionResponse] response from the API call
+    # @return [SubscriptionResponse] response from the API call.
     def find_subscription(reference: nil)
       new_api_call_builder
         .request(new_request_builder(HttpMethodEnum::GET,
@@ -1125,7 +1125,7 @@ module AdvancedBilling
     # @param [Array[SubscriptionPurgeType]] cascade Optional parameter: Options
     # are "customer" or "payment_profile". Use in query:
     # `cascade[]=customer&cascade[]=payment_profile`.
-    # @return [void] response from the API call
+    # @return [void] response from the API call.
     def purge_subscription(subscription_id,
                            ack,
                            cascade: nil)
@@ -1151,7 +1151,7 @@ module AdvancedBilling
     # the subscription
     # @param [UpsertPrepaidConfigurationRequest] body Optional parameter:
     # Example:
-    # @return [PrepaidConfigurationResponse] response from the API call
+    # @return [PrepaidConfigurationResponse] response from the API call.
     def update_prepaid_subscription_configuration(subscription_id,
                                                   body: nil)
       new_api_call_builder
@@ -1208,7 +1208,7 @@ module AdvancedBilling
     # If you'd like to calculate subscriptions that do not include tax, please
     # feel free to leave off the billing information.
     # @param [CreateSubscriptionRequest] body Optional parameter: Example:
-    # @return [SubscriptionPreviewResponse] response from the API call
+    # @return [SubscriptionPreviewResponse] response from the API call.
     def preview_subscription(body: nil)
       new_api_call_builder
         .request(new_request_builder(HttpMethodEnum::POST,
@@ -1243,7 +1243,7 @@ module AdvancedBilling
     # @param [String] code Optional parameter: A code for the coupon that would
     # be applied to a subscription
     # @param [AddCouponsRequest] body Optional parameter: Example:
-    # @return [SubscriptionResponse] response from the API call
+    # @return [SubscriptionResponse] response from the API call.
     def apply_coupons_to_subscription(subscription_id,
                                       code: nil,
                                       body: nil)
@@ -1278,7 +1278,7 @@ module AdvancedBilling
     # @param [Integer] subscription_id Required parameter: The Chargify id of
     # the subscription
     # @param [String] coupon_code Optional parameter: The coupon code
-    # @return [String] response from the API call
+    # @return [String] response from the API call.
     def remove_coupon_from_subscription(subscription_id,
                                         coupon_code: nil)
       new_api_call_builder
@@ -1355,7 +1355,7 @@ module AdvancedBilling
     # @param [Integer] subscription_id Required parameter: The Chargify id of
     # the subscription
     # @param [ActivateSubscriptionRequest] body Optional parameter: Example:
-    # @return [SubscriptionResponse] response from the API call
+    # @return [SubscriptionResponse] response from the API call.
     def activate_subscription(subscription_id,
                               body: nil)
       new_api_call_builder

data/lib/advanced_billing/controllers/webhooks_controller.rb

@@ -53,7 +53,7 @@ module AdvancedBilling
     # Webhooks are returned.
     # @param [Integer] subscription Optional parameter: The Advanced Billing id
     # of a subscription you'd like to filter for
-    # @return [Array[WebhookResponse]] response from the API call
+    # @return [Array[WebhookResponse]] response from the API call.
     def list_webhooks(options = {})
       new_api_call_builder
         .request(new_request_builder(HttpMethodEnum::GET,
@@ -77,7 +77,7 @@ module AdvancedBilling
 
     # This method allows you to enable webhooks via API for your site
     # @param [EnableWebhooksRequest] body Optional parameter: Example:
-    # @return [EnableWebhooksResponse] response from the API call
+    # @return [EnableWebhooksResponse] response from the API call.
     def enable_webhooks(body: nil)
       new_api_call_builder
         .request(new_request_builder(HttpMethodEnum::PUT,
@@ -100,7 +100,7 @@ module AdvancedBilling
     # You may submit an array of up to 1000 webhook IDs to replay in the
     # request.
     # @param [ReplayWebhooksRequest] body Optional parameter: Example:
-    # @return [ReplayWebhooksResponse] response from the API call
+    # @return [ReplayWebhooksResponse] response from the API call.
     def replay_webhooks(body: nil)
       new_api_call_builder
         .request(new_request_builder(HttpMethodEnum::POST,
@@ -124,7 +124,7 @@ module AdvancedBilling
     # keys](https://maxio.zendesk.com/hc/en-us/articles/24266136649869-Webhooks-
     # Reference#events)
     # @param [CreateOrUpdateEndpointRequest] body Optional parameter: Example:
-    # @return [EndpointResponse] response from the API call
+    # @return [EndpointResponse] response from the API call.
     def create_endpoint(body: nil)
       new_api_call_builder
         .request(new_request_builder(HttpMethodEnum::POST,
@@ -146,7 +146,7 @@ module AdvancedBilling
     end
 
     # This method returns created endpoints for site.
-    # @return [Array[Endpoint]] response from the API call
+    # @return [Array[Endpoint]] response from the API call.
     def list_endpoints
       new_api_call_builder
         .request(new_request_builder(HttpMethodEnum::GET,
@@ -176,7 +176,7 @@ module AdvancedBilling
     # @param [Integer] endpoint_id Required parameter: The Advanced Billing id
     # for the endpoint that should be updated
     # @param [CreateOrUpdateEndpointRequest] body Optional parameter: Example:
-    # @return [EndpointResponse] response from the API call
+    # @return [EndpointResponse] response from the API call.
     def update_endpoint(endpoint_id,
                         body: nil)
       new_api_call_builder

data/lib/advanced_billing/models/cancellation_method.rb

@@ -21,7 +21,10 @@ module AdvancedBilling
       BILLING_PORTAL = 'billing_portal'.freeze,
 
       # TODO: Write general description for UNKNOWN
-      UNKNOWN = 'unknown'.freeze
+      UNKNOWN = 'unknown'.freeze,
+
+      # TODO: Write general description for IMPORTED
+      IMPORTED = 'imported'.freeze
     ].freeze
 
     def self.validate(value)

data/lib/advanced_billing/models/list_products_filter.rb

@@ -9,6 +9,11 @@ module AdvancedBilling
     SKIP = Object.new
     private_constant :SKIP
 
+    # Allows fetching products with matching id based on provided values. Use in
+    # query `filter[ids]=1,2,3`.
+    # @return [Array[Integer]]
+    attr_accessor :ids
+
     # Allows fetching products only if a prepaid product price point is present
     # or not. To use this filter you also have to include the following param in
     # the request `include=prepaid_product_price_point`. Use in query
@@ -25,6 +30,7 @@ module AdvancedBilling
     # A mapping from model property names to API property names.
     def self.names
       @_hash = {} if @_hash.nil?
+      @_hash['ids'] = 'ids'
       @_hash['prepaid_product_price_point'] = 'prepaid_product_price_point'
       @_hash['use_site_exchange_rate'] = 'use_site_exchange_rate'
       @_hash
@@ -33,6 +39,7 @@ module AdvancedBilling
     # An array for optional fields
     def self.optionals
       %w[
+        ids
         prepaid_product_price_point
         use_site_exchange_rate
       ]
@@ -43,8 +50,9 @@ module AdvancedBilling
       []
     end
 
-    def initialize(prepaid_product_price_point: SKIP,
+    def initialize(ids: SKIP, prepaid_product_price_point: SKIP,
                    use_site_exchange_rate: SKIP, additional_properties: {})
+      @ids = ids unless ids == SKIP
       unless prepaid_product_price_point == SKIP
         @prepaid_product_price_point =
           prepaid_product_price_point
@@ -62,6 +70,7 @@ module AdvancedBilling
       return nil unless hash
 
       # Extract variables from the hash.
+      ids = hash.key?('ids') ? hash['ids'] : SKIP
       if hash['prepaid_product_price_point']
         prepaid_product_price_point = PrepaidProductPricePointFilter.from_hash(hash['prepaid_product_price_point'])
       end
@@ -72,7 +81,8 @@ module AdvancedBilling
       names.each_value { |k| hash.delete(k) }
 
       # Create object from extracted values.
-      ListProductsFilter.new(prepaid_product_price_point: prepaid_product_price_point,
+      ListProductsFilter.new(ids: ids,
+                             prepaid_product_price_point: prepaid_product_price_point,
                              use_site_exchange_rate: use_site_exchange_rate,
                              additional_properties: hash)
     end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: maxio-advanced-billing-sdk
 version: !ruby/object:Gem::Version
-  version: 5.0.0
+  version: 5.1.0
 platform: ruby
 authors:
 - Maxio SDK
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2024-08-21 00:00:00.000000000 Z
+date: 2024-09-27 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: apimatic_core_interfaces