subtain-apimatic-sdk 2.4.69 → 3.1.0

data/lib/advanced_billing/controllers/subscription_invoice_account_controller.rb

@@ -1,226 +0,0 @@
-# advanced_billing
-#
-# This file was automatically generated by APIMATIC v2.0
-# ( https://apimatic.io ).
-
-module AdvancedBilling
-  # SubscriptionInvoiceAccountController
-  class SubscriptionInvoiceAccountController < BaseController
-    # Credit will be added to the subscription in the amount specified in the
-    # request body. The credit is subsequently applied to the next generated
-    # invoice.
-    # @param [String] subscription_id Required parameter: The Chargify id of the
-    # subscription
-    # @param [IssueServiceCreditRequest] body Optional parameter: Example:
-    # @return [ServiceCredit] response from the API call
-    def issue_service_credit(subscription_id,
-                             body: nil)
-      new_api_call_builder
-        .request(new_request_builder(HttpMethodEnum::POST,
-                                     '/subscriptions/{subscription_id}/service_credits.json',
-                                     Server::DEFAULT)
-                   .template_param(new_parameter(subscription_id, key: 'subscription_id')
-                                    .is_required(true)
-                                    .should_encode(true))
-                   .header_param(new_parameter('application/json', key: 'Content-Type'))
-                   .body_param(new_parameter(body))
-                   .header_param(new_parameter('application/json', key: 'accept'))
-                   .body_serializer(proc do |param| param.to_json unless param.nil? end)
-                   .auth(Single.new('BasicAuth')))
-        .response(new_response_handler
-                   .is_nullify404(true)
-                   .deserializer(APIHelper.method(:custom_type_deserializer))
-                   .deserialize_into(ServiceCredit.method(:from_hash)))
-        .execute
-    end
-
-    # Returns the `balance_in_cents` of the Subscription's Pending Discount,
-    # Service Credit, and Prepayment accounts, as well as the sum of the
-    # Subscription's open, payable invoices.
-    # @param [String] subscription_id Required parameter: The Chargify id of the
-    # subscription
-    # @return [AccountBalances] response from the API call
-    def read_account_balances(subscription_id)
-      new_api_call_builder
-        .request(new_request_builder(HttpMethodEnum::GET,
-                                     '/subscriptions/{subscription_id}/account_balances.json',
-                                     Server::DEFAULT)
-                   .template_param(new_parameter(subscription_id, key: 'subscription_id')
-                                    .is_required(true)
-                                    .should_encode(true))
-                   .header_param(new_parameter('application/json', key: 'accept'))
-                   .auth(Single.new('BasicAuth')))
-        .response(new_response_handler
-                   .is_nullify404(true)
-                   .deserializer(APIHelper.method(:custom_type_deserializer))
-                   .deserialize_into(AccountBalances.method(:from_hash)))
-        .execute
-    end
-
-    # This request will list a subscription's prepayments.
-    # @param [String] subscription_id Required parameter: The Chargify id of the
-    # subscription
-    # @param [Integer] page Optional parameter: Result records are organized in
-    # pages. By default, the first page of results is displayed. The page
-    # parameter specifies a page number of results to fetch. You can start
-    # navigating through the pages to consume the results. You do this by
-    # passing in a page parameter. Retrieve the next page by adding ?page=2 to
-    # the query string. If there are no results to return, then an empty result
-    # set will be returned. Use in query `page=1`.
-    # @param [Integer] per_page Optional parameter: This parameter indicates how
-    # 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`.
-    # @param [BasicDateField] filter_date_field Optional parameter: The type of
-    # filter you would like to apply to your search. created_at - Time when
-    # prepayment was created. application_at - Time when prepayment was applied
-    # to invoice. Use in query `filter[date_field]=created_at`.
-    # @param [String] filter_start_date Optional parameter: The start date
-    # (format YYYY-MM-DD) with which to filter the date_field. Returns
-    # prepayments with a timestamp at or after midnight (12:00:00 AM) in your
-    # site’s time zone on the date specified. Use in query
-    # `filter[start_date]=2011-12-15`.
-    # @param [String] filter_end_date Optional parameter: The end date (format
-    # YYYY-MM-DD) with which to filter the date_field. Returns prepayments with
-    # a timestamp up to and including 11:59:59PM in your site’s time zone on the
-    # date specified. Use in query `filter[end_date]=2011-12-15`.
-    # @return [PrepaymentsResponse] response from the API call
-    def list_prepayments(options = {})
-      new_api_call_builder
-        .request(new_request_builder(HttpMethodEnum::GET,
-                                     '/subscriptions/{subscription_id}/prepayments.json',
-                                     Server::DEFAULT)
-                   .template_param(new_parameter(options['subscription_id'], key: 'subscription_id')
-                                    .is_required(true)
-                                    .should_encode(true))
-                   .query_param(new_parameter(options['page'], key: 'page'))
-                   .query_param(new_parameter(options['per_page'], key: 'per_page'))
-                   .query_param(new_parameter(options['filter_date_field'], key: 'filter[date_field]'))
-                   .query_param(new_parameter(options['filter_start_date'], key: 'filter[start_date]'))
-                   .query_param(new_parameter(options['filter_end_date'], key: 'filter[end_date]'))
-                   .header_param(new_parameter('application/json', key: 'accept'))
-                   .auth(Single.new('BasicAuth')))
-        .response(new_response_handler
-                   .is_nullify404(true)
-                   .deserializer(APIHelper.method(:custom_type_deserializer))
-                   .deserialize_into(PrepaymentsResponse.method(:from_hash))
-                   .local_error('401',
-                                'Unauthorized',
-                                APIException)
-                   .local_error('403',
-                                'Forbidden',
-                                APIException)
-                   .local_error('404',
-                                'Not Found',
-                                APIException))
-        .execute
-    end
-
-    # Credit will be removed from the subscription in the amount specified in
-    # the request body. The credit amount being deducted must be equal to or
-    # less than the current credit balance.
-    # @param [String] subscription_id Required parameter: The Chargify id of the
-    # subscription
-    # @param [DeductServiceCreditRequest] body Optional parameter: Example:
-    # @return [void] response from the API call
-    def deduct_service_credit(subscription_id,
-                              body: nil)
-      new_api_call_builder
-        .request(new_request_builder(HttpMethodEnum::POST,
-                                     '/subscriptions/{subscription_id}/service_credit_deductions.json',
-                                     Server::DEFAULT)
-                   .template_param(new_parameter(subscription_id, key: 'subscription_id')
-                                    .is_required(true)
-                                    .should_encode(true))
-                   .header_param(new_parameter('application/json', key: 'Content-Type'))
-                   .body_param(new_parameter(body))
-                   .body_serializer(proc do |param| param.to_json unless param.nil? end)
-                   .auth(Single.new('BasicAuth')))
-        .response(new_response_handler
-                   .is_nullify404(true)
-                   .is_response_void(true)
-                   .local_error('422',
-                                'Unprocessable Entity (WebDAV)',
-                                ErrorListResponseException))
-        .execute
-    end
-
-    # ## Create Prepayment
-    # In order to specify a prepayment made against a subscription, specify the
-    # `amount, memo, details, method`.
-    # When the `method` specified is `"credit_card_on_file"`, the prepayment
-    # amount will be collected using the default credit card payment profile and
-    # applied to the prepayment account balance.  This is especially useful for
-    # manual replenishment of prepaid subscriptions.
-    # Please note that you **can't** pass `amount_in_cents`.
-    # @param [String] subscription_id Required parameter: The Chargify id of the
-    # subscription
-    # @param [CreatePrepaymentRequest] body Optional parameter: Example:
-    # @return [CreatePrepaymentResponse] response from the API call
-    def create_prepayment(subscription_id,
-                          body: nil)
-      new_api_call_builder
-        .request(new_request_builder(HttpMethodEnum::POST,
-                                     '/subscriptions/{subscription_id}/prepayments.json',
-                                     Server::DEFAULT)
-                   .template_param(new_parameter(subscription_id, key: 'subscription_id')
-                                    .is_required(true)
-                                    .should_encode(true))
-                   .header_param(new_parameter('application/json', key: 'Content-Type'))
-                   .body_param(new_parameter(body))
-                   .header_param(new_parameter('application/json', key: 'accept'))
-                   .body_serializer(proc do |param| param.to_json unless param.nil? end)
-                   .auth(Single.new('BasicAuth')))
-        .response(new_response_handler
-                   .is_nullify404(true)
-                   .deserializer(APIHelper.method(:custom_type_deserializer))
-                   .deserialize_into(CreatePrepaymentResponse.method(:from_hash)))
-        .execute
-    end
-
-    # This endpoint will refund, completely or partially, a particular
-    # prepayment applied to a subscription. The `prepayment_id` will be the
-    # account transaction ID of the original payment. The prepayment must have
-    # some amount remaining in order to be refunded.
-    # The amount may be passed either as a decimal, with `amount`, or an integer
-    # in cents, with `amount_in_cents`.
-    # @param [String] subscription_id Required parameter: The Chargify id of the
-    # subscription
-    # @param [String] prepayment_id Required parameter: id of prepayment
-    # @param [RefundPrepaymentRequest] body Optional parameter: Example:
-    # @return [PrepaymentResponse] response from the API call
-    def refund_prepayment(subscription_id,
-                          prepayment_id,
-                          body: nil)
-      new_api_call_builder
-        .request(new_request_builder(HttpMethodEnum::POST,
-                                     '/subscriptions/{subscription_id}/prepayments/{prepayment_id}/refunds.json',
-                                     Server::DEFAULT)
-                   .template_param(new_parameter(subscription_id, key: 'subscription_id')
-                                    .is_required(true)
-                                    .should_encode(true))
-                   .template_param(new_parameter(prepayment_id, key: 'prepayment_id')
-                                    .is_required(true)
-                                    .should_encode(true))
-                   .header_param(new_parameter('application/json', key: 'Content-Type'))
-                   .body_param(new_parameter(body))
-                   .header_param(new_parameter('application/json', key: 'accept'))
-                   .body_serializer(proc do |param| param.to_json unless param.nil? end)
-                   .auth(Single.new('BasicAuth')))
-        .response(new_response_handler
-                   .is_nullify404(true)
-                   .deserializer(APIHelper.method(:custom_type_deserializer))
-                   .deserialize_into(PrepaymentResponse.method(:from_hash))
-                   .local_error('400',
-                                'Bad Request',
-                                RefundPrepaymentBaseErrorsResponseException)
-                   .local_error('404',
-                                'Not Found',
-                                APIException)
-                   .local_error('422',
-                                'Unprocessable Entity',
-                                RefundPrepaymentAggregatedErrorsResponseException))
-        .execute
-    end
-  end
-end

data/lib/advanced_billing/controllers/subscription_notes_controller.rb

@@ -1,159 +0,0 @@
-# advanced_billing
-#
-# This file was automatically generated by APIMATIC v2.0
-# ( https://apimatic.io ).
-
-module AdvancedBilling
-  # SubscriptionNotesController
-  class SubscriptionNotesController < BaseController
-    # Use the following method to update a note for a Subscription.
-    # @param [String] subscription_id Required parameter: The Chargify id of the
-    # subscription
-    # @param [String] note_id Required parameter: The Chargify id of the note
-    # @param [UpdateSubscriptionNoteRequest] body Optional parameter: Example:
-    # @return [SubscriptionNoteResponse] response from the API call
-    def update_subscription_note(subscription_id,
-                                 note_id,
-                                 body: nil)
-      new_api_call_builder
-        .request(new_request_builder(HttpMethodEnum::PUT,
-                                     '/subscriptions/{subscription_id}/notes/{note_id}.json',
-                                     Server::DEFAULT)
-                   .template_param(new_parameter(subscription_id, key: 'subscription_id')
-                                    .is_required(true)
-                                    .should_encode(true))
-                   .template_param(new_parameter(note_id, key: 'note_id')
-                                    .is_required(true)
-                                    .should_encode(true))
-                   .header_param(new_parameter('application/json', key: 'Content-Type'))
-                   .body_param(new_parameter(body))
-                   .header_param(new_parameter('application/json', key: 'accept'))
-                   .body_serializer(proc do |param| param.to_json unless param.nil? end)
-                   .auth(Single.new('BasicAuth')))
-        .response(new_response_handler
-                   .is_nullify404(true)
-                   .deserializer(APIHelper.method(:custom_type_deserializer))
-                   .deserialize_into(SubscriptionNoteResponse.method(:from_hash)))
-        .execute
-    end
-
-    # Use the following method to delete a note for a Subscription.
-    # @param [String] subscription_id Required parameter: The Chargify id of the
-    # subscription
-    # @return [void] response from the API call
-    def delete_subscription_note(subscription_id)
-      new_api_call_builder
-        .request(new_request_builder(HttpMethodEnum::DELETE,
-                                     '/subscriptions/{subscription_id}/notes.json',
-                                     Server::DEFAULT)
-                   .template_param(new_parameter(subscription_id, key: 'subscription_id')
-                                    .is_required(true)
-                                    .should_encode(true))
-                   .auth(Single.new('BasicAuth')))
-        .response(new_response_handler
-                   .is_nullify404(true)
-                   .is_response_void(true)
-                   .local_error('422',
-                                'Unprocessable Entity (WebDAV)',
-                                APIException))
-        .execute
-    end
-
-    # Use this method to retrieve a list of Notes associated with a
-    # Subscription. The response will be an array of Notes.
-    # @param [String] subscription_id Required parameter: The Chargify id of the
-    # subscription
-    # @param [Integer] page Optional parameter: Result records are organized in
-    # pages. By default, the first page of results is displayed. The page
-    # parameter specifies a page number of results to fetch. You can start
-    # navigating through the pages to consume the results. You do this by
-    # passing in a page parameter. Retrieve the next page by adding ?page=2 to
-    # the query string. If there are no results to return, then an empty result
-    # set will be returned. Use in query `page=1`.
-    # @param [Integer] per_page Optional parameter: This parameter indicates how
-    # 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
-    def list_subscription_notes(options = {})
-      new_api_call_builder
-        .request(new_request_builder(HttpMethodEnum::GET,
-                                     '/subscriptions/{subscription_id}/notes.json',
-                                     Server::DEFAULT)
-                   .template_param(new_parameter(options['subscription_id'], key: 'subscription_id')
-                                    .is_required(true)
-                                    .should_encode(true))
-                   .query_param(new_parameter(options['page'], key: 'page'))
-                   .query_param(new_parameter(options['per_page'], key: 'per_page'))
-                   .header_param(new_parameter('application/json', key: 'accept'))
-                   .auth(Single.new('BasicAuth')))
-        .response(new_response_handler
-                   .is_nullify404(true)
-                   .deserializer(APIHelper.method(:custom_type_deserializer))
-                   .deserialize_into(SubscriptionNoteResponse.method(:from_hash))
-                   .is_response_array(true))
-        .execute
-    end
-
-    # Once you have obtained the ID of the note you wish to read, use this
-    # method to show a particular note attached to a subscription.
-    # @param [String] subscription_id Required parameter: The Chargify id of the
-    # subscription
-    # @param [String] note_id Required parameter: The Chargify id of the note
-    # @return [SubscriptionNoteResponse] response from the API call
-    def read_subscription_note(subscription_id,
-                               note_id)
-      new_api_call_builder
-        .request(new_request_builder(HttpMethodEnum::GET,
-                                     '/subscriptions/{subscription_id}/notes/{note_id}.json',
-                                     Server::DEFAULT)
-                   .template_param(new_parameter(subscription_id, key: 'subscription_id')
-                                    .is_required(true)
-                                    .should_encode(true))
-                   .template_param(new_parameter(note_id, key: 'note_id')
-                                    .is_required(true)
-                                    .should_encode(true))
-                   .header_param(new_parameter('application/json', key: 'accept'))
-                   .auth(Single.new('BasicAuth')))
-        .response(new_response_handler
-                   .is_nullify404(true)
-                   .deserializer(APIHelper.method(:custom_type_deserializer))
-                   .deserialize_into(SubscriptionNoteResponse.method(:from_hash)))
-        .execute
-    end
-
-    # Use the following method to create a note for a subscription.
-    # ## How to Use Subscription Notes
-    # Notes allow you to record information about a particular Subscription in a
-    # free text format.
-    # If you have structured data such as birth date, color, etc., consider
-    # using Metadata instead.
-    # Full documentation on how to use Notes in the Chargify UI can be located
-    # [here](https://maxio-chargify.zendesk.com/hc/en-us/articles/5404434903181-
-    # Subscription-Summary#notes).
-    # @param [String] subscription_id Required parameter: The Chargify id of the
-    # subscription
-    # @param [UpdateSubscriptionNoteRequest] body Optional parameter: Example:
-    # @return [SubscriptionNoteResponse] response from the API call
-    def create_subscription_note(subscription_id,
-                                 body: nil)
-      new_api_call_builder
-        .request(new_request_builder(HttpMethodEnum::POST,
-                                     '/subscriptions/{subscription_id}/notes.json',
-                                     Server::DEFAULT)
-                   .template_param(new_parameter(subscription_id, key: 'subscription_id')
-                                    .is_required(true)
-                                    .should_encode(true))
-                   .header_param(new_parameter('application/json', key: 'Content-Type'))
-                   .body_param(new_parameter(body))
-                   .header_param(new_parameter('application/json', key: 'accept'))
-                   .body_serializer(proc do |param| param.to_json unless param.nil? end)
-                   .auth(Single.new('BasicAuth')))
-        .response(new_response_handler
-                   .is_nullify404(true)
-                   .deserializer(APIHelper.method(:custom_type_deserializer))
-                   .deserialize_into(SubscriptionNoteResponse.method(:from_hash)))
-        .execute
-    end
-  end
-end

data/lib/advanced_billing/controllers/subscription_products_controller.rb

@@ -1,166 +0,0 @@
-# advanced_billing
-#
-# This file was automatically generated by APIMATIC v2.0
-# ( https://apimatic.io ).
-
-module AdvancedBilling
-  # SubscriptionProductsController
-  class SubscriptionProductsController < BaseController
-    # ## Previewing a future date
-    # It is also possible to preview the migration for a date in the future, as
-    # long as it's still within the subscription's current billing period, by
-    # passing a `proration_date` along with the request (eg: `"proration_date":
-    # "2020-12-18T18:25:43.511Z"`).
-    # This will calculate the prorated adjustment, charge, payment and credit
-    # applied values assuming the migration is done at that date in the future
-    # as opposed to right now.
-    # @param [String] subscription_id Required parameter: The Chargify id of the
-    # subscription
-    # @param [SubscriptionMigrationPreviewRequest] body Optional parameter:
-    # Example:
-    # @return [SubscriptionMigrationPreviewResponse] response from the API call
-    def preview_subscription_product_migration(subscription_id,
-                                               body: nil)
-      new_api_call_builder
-        .request(new_request_builder(HttpMethodEnum::POST,
-                                     '/subscriptions/{subscription_id}/migrations/preview.json',
-                                     Server::DEFAULT)
-                   .template_param(new_parameter(subscription_id, key: 'subscription_id')
-                                    .is_required(true)
-                                    .should_encode(true))
-                   .header_param(new_parameter('application/json', key: 'Content-Type'))
-                   .body_param(new_parameter(body))
-                   .header_param(new_parameter('application/json', key: 'accept'))
-                   .body_serializer(proc do |param| param.to_json unless param.nil? end)
-                   .auth(Single.new('BasicAuth')))
-        .response(new_response_handler
-                   .is_nullify404(true)
-                   .deserializer(APIHelper.method(:custom_type_deserializer))
-                   .deserialize_into(SubscriptionMigrationPreviewResponse.method(:from_hash))
-                   .local_error('422',
-                                'Unprocessable Entity (WebDAV)',
-                                ErrorListResponseException))
-        .execute
-    end
-
-    # In order to create a migration, you must pass the `product_id` or
-    # `product_handle` in the object when you send a POST request. You may also
-    # pass either a `product_price_point_id` or `product_price_point_handle` to
-    # choose which price point the subscription is moved to. If no price point
-    # identifier is passed the subscription will be moved to the products
-    # default price point. The response will be the updated subscription.
-    # ## Valid Subscriptions
-    # Subscriptions should be in the `active` or `trialing` state in order to be
-    # migrated.
-    # (For backwards compatibility reasons, it is possible to migrate a
-    # subscription that is in the `trial_ended` state via the API, however this
-    # is not recommended.  Since `trial_ended` is an end-of-life state, the
-    # subscription should be canceled, the product changed, and then the
-    # subscription can be reactivated.)
-    # ## Migrations Documentation
-    # Full documentation on how to record Migrations in the Chargify UI can be
-    # located
-    # [here](https://chargify.zendesk.com/hc/en-us/articles/4407898373531).
-    # ## Failed Migrations
-    # One of the most common ways that a migration can fail is when the attempt
-    # is made to migrate a subscription to it's current product. Please be aware
-    # of this issue!
-    # ## Migration 3D Secure - Stripe
-    # It may happen that a payment needs 3D Secure Authentication when the
-    # subscription is migrated to a new product; this is referred to in our help
-    # docs as a [post-authentication
-    # flow](https://maxio-chargify.zendesk.com/hc/en-us/articles/5405177432077#p
-    # sd2-flows-pre-authentication-and-post-authentication). The server returns
-    # `422 Unprocessable Entity` in this case with the following response:
-    # ```json
-    # {
-    #   "errors": [
-    #     "Your card was declined. This transaction requires 3D secure
-    # authentication."
-    #   ],
-    #   "gateway_payment_id": "pi_1F0aGoJ2UDb3Q4av7zU3sHPh",
-    #   "description": "This card requires 3D secure authentication. Redirect
-    # the customer to the URL from the action_link attribute to authenticate.
-    # Attach callback_url param to this URL if you want to be notified about the
-    # result of 3D Secure authentication. Attach redirect_url param to this URL
-    # if you want to redirect a customer back to your page after 3D Secure
-    # authentication. Example:
-    # https://mysite.chargify.com/3d-secure/pi_1FCm4RKDeye4C0XfbqquXRYm?one_time
-    # _token_id=128&callback_url=https://localhost:4000&redirect_url=https://you
-    # rpage.com will do a POST request to https://localhost:4000 after payment
-    # is authenticated and will redirect a customer to https://yourpage.com
-    # after 3DS authentication.",
-    #   "action_link":
-    # "http://acme.chargify.com/3d-secure/pi_1F0aGoJ2UDb3Q4av7zU3sHPh?one_time_t
-    # oken_id=242"
-    # }
-    # ```
-    # To let the customer go through 3D Secure Authentication, they need to be
-    # redirected to the URL specified in `action_link`.
-    # Optionally, you can specify `callback_url` parameter in the `action_link`
-    # URL if you’d like to be notified about the result of 3D Secure
-    # Authentication. The `callback_url` will return the following information:
-    # - whether the authentication was successful (`success`)
-    # - the gateway ID for the payment (`gateway_payment_id`)
-    # - the subscription ID (`subscription_id`)
-    # Lastly, you can also specify a `redirect_url` within the `action_link` URL
-    # if you’d like to redirect a customer back to your site.
-    # It is not possible to use `action_link` in an iframe inside a custom
-    # application. You have to redirect the customer directly to the
-    # `action_link`, then, to be notified about the result, use `redirect_url`
-    # or `callback_url`.
-    # The final URL that you send a customer to to complete 3D Secure may
-    # resemble the following, where the first half is the `action_link` and the
-    # second half contains a `redirect_url` and `callback_url`:
-    # `https://mysite.chargify.com/3d-secure/pi_1FCm4RKDeye4C0XfbqquXRYm?one_tim
-    # e_token_id=128&callback_url=https://localhost:4000&redirect_url=https://yo
-    # urpage.com`
-    # ### Example Redirect Flow
-    # You may wish to redirect customers to different pages depending on whether
-    # their SCA was performed successfully. Here's an example flow to use as a
-    # reference:
-    # 1. Create a migration via API; it requires 3DS
-    # 2. You receive a `gateway_payment_id` in the `action_link` along other
-    # params in the response.
-    # 3. Use this `gateway_payment_id` to, for example, connect with your
-    # internal resources or generate a session_id
-    # 4. Include 1 of those attributes inside the `callback_url` and
-    # `redirect_url` to be aware which “session” this applies to
-    # 5. Redirect the customer to the `action_link` with `callback_url` and
-    # `redirect_url` applied
-    # 6. After the customer finishes 3DS authentication, we let you know the
-    # result by making a request to applied `callback_url`.
-    # 7. After that, we redirect the customer to the `redirect_url`; at this
-    # point the result of authentication is known
-    # 8. Optionally, you can use the applied "msg" param in the `redirect_url`
-    # to determine whether it was successful or not.
-    # @param [String] subscription_id Required parameter: The Chargify id of the
-    # subscription
-    # @param [SubscriptionProductMigrationRequest] body Optional parameter:
-    # Example:
-    # @return [SubscriptionResponse] response from the API call
-    def migrate_subscription_product(subscription_id,
-                                     body: nil)
-      new_api_call_builder
-        .request(new_request_builder(HttpMethodEnum::POST,
-                                     '/subscriptions/{subscription_id}/migrations.json',
-                                     Server::DEFAULT)
-                   .template_param(new_parameter(subscription_id, key: 'subscription_id')
-                                    .is_required(true)
-                                    .should_encode(true))
-                   .header_param(new_parameter('application/json', key: 'Content-Type'))
-                   .body_param(new_parameter(body))
-                   .header_param(new_parameter('application/json', key: 'accept'))
-                   .body_serializer(proc do |param| param.to_json unless param.nil? end)
-                   .auth(Single.new('BasicAuth')))
-        .response(new_response_handler
-                   .is_nullify404(true)
-                   .deserializer(APIHelper.method(:custom_type_deserializer))
-                   .deserialize_into(SubscriptionResponse.method(:from_hash))
-                   .local_error('422',
-                                'Unprocessable Entity (WebDAV)',
-                                ErrorListResponseException))
-        .execute
-    end
-  end
-end