maxio-advanced-billing-sdk 3.0.0 → 4.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 32c5dafe5bea02b9f4b9e58fe9b135ae484bfe4e621cddafc46492ef9cb46a84
-  data.tar.gz: 7b375ac0ccb8c59f1573f84bbf40886793981ad28f87727fda0342cda3c35e3d
+  metadata.gz: ec42d6b6b61bfb2d3629b91f90b61488f5283e7b3d309c8c0a07c11ba8bd0949
+  data.tar.gz: 4cfccc5639ae102e40f4b66d8c54870ccb2cd5b69c369b325744c510fede2bbd
 SHA512:
-  metadata.gz: f69877c24f4051ea86da5af356846d3ef5a36bbd7ee147453434488f72eaf0453a9b068013b8f4137d238e7ef168b3e5f1092a8c09a417e6954be648b9c8b273
-  data.tar.gz: c0d84c7e8e61fd733a10a470eff219c6c1eb5f7165df687abc49a895c66db85dbaeb3be563f0dbc7ec3e6e843a2f6a2d248d79411e776eeaa472d08f9ddb5619
+  metadata.gz: 51fad65ae3b11804cdfe05815b330571a04e89ec3d4b2ecb1a36dfed77acd72663020cb15c24cd0f76addbadf2fb350c5dac4e13f779682ab69b1f52d6bb3bcf
+  data.tar.gz: 7ad806dff750525450654ddb2494ac564094fbc37c5773e89e778433100ac191e0bc9f118cb8da6e21783667cdb06250e0e57194c2a560059f13a9d6c86845b3

data/README.md

@@ -30,20 +30,20 @@ curl -u <api_key>:x -H Accept:application/json -H Content-Type:application/json
 Install the gem from the command line:
 
 ```ruby
-gem install maxio-advanced-billing-sdk -v 3.0.0
+gem install maxio-advanced-billing-sdk -v 4.0.0
 ```
 
 Or add the gem to your Gemfile and run `bundle`:
 
 ```ruby
-gem 'maxio-advanced-billing-sdk', '3.0.0'
+gem 'maxio-advanced-billing-sdk', '4.0.0'
 ```
 
-For additional gem details, see the [RubyGems page for the maxio-advanced-billing-sdk gem](https://rubygems.org/gems/maxio-advanced-billing-sdk/versions/3.0.0).
+For additional gem details, see the [RubyGems page for the maxio-advanced-billing-sdk gem](https://rubygems.org/gems/maxio-advanced-billing-sdk/versions/4.0.0).
 
 ## Initialize the API Client
 
-**_Note:_** Documentation for the client can be found [here.](https://www.github.com/maxio-com/ab-ruby-sdk/tree/3.0.0/doc/client.md)
+**_Note:_** Documentation for the client can be found [here.](https://www.github.com/maxio-com/ab-ruby-sdk/tree/4.0.0/doc/client.md)
 
 The following parameters are configurable for the API Client:
 
@@ -54,14 +54,14 @@ The following parameters are configurable for the API Client:
 | `environment` | `Environment` | The API environment. <br> **Default: `Environment.PRODUCTION`** |
 | `connection` | `Faraday::Connection` | The Faraday connection object passed by the SDK user for making requests |
 | `adapter` | `Faraday::Adapter` | The Faraday adapter object passed by the SDK user for performing http requests |
-| `timeout` | `Float` | The value to use for connection timeout. <br> **Default: 30** |
+| `timeout` | `Float` | The value to use for connection timeout. <br> **Default: 120** |
 | `max_retries` | `Integer` | The number of times to retry an endpoint call if it fails. <br> **Default: 0** |
 | `retry_interval` | `Float` | Pause in seconds between retries. <br> **Default: 1** |
 | `backoff_factor` | `Float` | The amount to multiply each successive retry's interval amount by in order to provide backoff. <br> **Default: 2** |
 | `retry_statuses` | `Array` | A list of HTTP statuses to retry. <br> **Default: [408, 413, 429, 500, 502, 503, 504, 521, 522, 524]** |
 | `retry_methods` | `Array` | A list of HTTP methods to retry. <br> **Default: %i[get put]** |
 | `http_callback` | `HttpCallBack` | The Http CallBack allows defining callables for pre and post API calls. |
-| `basic_auth_credentials` | [`BasicAuthCredentials`](https://www.github.com/maxio-com/ab-ruby-sdk/tree/3.0.0/doc/$a/https://www.github.com/maxio-com/ab-ruby-sdk/tree/3.0.0/basic-authentication.md) | The credential object for Basic Authentication |
+| `basic_auth_credentials` | [`BasicAuthCredentials`](https://www.github.com/maxio-com/ab-ruby-sdk/tree/4.0.0/doc/$a/https://www.github.com/maxio-com/ab-ruby-sdk/tree/4.0.0/basic-authentication.md) | The credential object for Basic Authentication |
 
 The API client can be initialized as follows:
 
@@ -92,45 +92,46 @@ The SDK can be configured to use a different environment for making API calls. A
 
 This API uses the following authentication schemes.
 
-* [`BasicAuth (Basic Authentication)`](https://www.github.com/maxio-com/ab-ruby-sdk/tree/3.0.0/doc/$a/https://www.github.com/maxio-com/ab-ruby-sdk/tree/3.0.0/basic-authentication.md)
+* [`BasicAuth (Basic Authentication)`](https://www.github.com/maxio-com/ab-ruby-sdk/tree/4.0.0/doc/$a/https://www.github.com/maxio-com/ab-ruby-sdk/tree/4.0.0/basic-authentication.md)
 
 ## List of APIs
 
-* [API Exports](https://www.github.com/maxio-com/ab-ruby-sdk/tree/3.0.0/doc/controllers/api-exports.md)
-* [Advance Invoice](https://www.github.com/maxio-com/ab-ruby-sdk/tree/3.0.0/doc/controllers/advance-invoice.md)
-* [Billing Portal](https://www.github.com/maxio-com/ab-ruby-sdk/tree/3.0.0/doc/controllers/billing-portal.md)
-* [Custom Fields](https://www.github.com/maxio-com/ab-ruby-sdk/tree/3.0.0/doc/controllers/custom-fields.md)
-* [Events-Based Billing Segments](https://www.github.com/maxio-com/ab-ruby-sdk/tree/3.0.0/doc/controllers/events-based-billing-segments.md)
-* [Payment Profiles](https://www.github.com/maxio-com/ab-ruby-sdk/tree/3.0.0/doc/controllers/payment-profiles.md)
-* [Product Families](https://www.github.com/maxio-com/ab-ruby-sdk/tree/3.0.0/doc/controllers/product-families.md)
-* [Product Price Points](https://www.github.com/maxio-com/ab-ruby-sdk/tree/3.0.0/doc/controllers/product-price-points.md)
-* [Proforma Invoices](https://www.github.com/maxio-com/ab-ruby-sdk/tree/3.0.0/doc/controllers/proforma-invoices.md)
-* [Reason Codes](https://www.github.com/maxio-com/ab-ruby-sdk/tree/3.0.0/doc/controllers/reason-codes.md)
-* [Referral Codes](https://www.github.com/maxio-com/ab-ruby-sdk/tree/3.0.0/doc/controllers/referral-codes.md)
-* [Sales Commissions](https://www.github.com/maxio-com/ab-ruby-sdk/tree/3.0.0/doc/controllers/sales-commissions.md)
-* [Subscription Components](https://www.github.com/maxio-com/ab-ruby-sdk/tree/3.0.0/doc/controllers/subscription-components.md)
-* [Subscription Groups](https://www.github.com/maxio-com/ab-ruby-sdk/tree/3.0.0/doc/controllers/subscription-groups.md)
-* [Subscription Group Invoice Account](https://www.github.com/maxio-com/ab-ruby-sdk/tree/3.0.0/doc/controllers/subscription-group-invoice-account.md)
-* [Subscription Group Status](https://www.github.com/maxio-com/ab-ruby-sdk/tree/3.0.0/doc/controllers/subscription-group-status.md)
-* [Subscription Invoice Account](https://www.github.com/maxio-com/ab-ruby-sdk/tree/3.0.0/doc/controllers/subscription-invoice-account.md)
-* [Subscription Notes](https://www.github.com/maxio-com/ab-ruby-sdk/tree/3.0.0/doc/controllers/subscription-notes.md)
-* [Subscription Products](https://www.github.com/maxio-com/ab-ruby-sdk/tree/3.0.0/doc/controllers/subscription-products.md)
-* [Subscription Status](https://www.github.com/maxio-com/ab-ruby-sdk/tree/3.0.0/doc/controllers/subscription-status.md)
-* [Coupons](https://www.github.com/maxio-com/ab-ruby-sdk/tree/3.0.0/doc/controllers/coupons.md)
-* [Components](https://www.github.com/maxio-com/ab-ruby-sdk/tree/3.0.0/doc/controllers/components.md)
-* [Customers](https://www.github.com/maxio-com/ab-ruby-sdk/tree/3.0.0/doc/controllers/customers.md)
-* [Events](https://www.github.com/maxio-com/ab-ruby-sdk/tree/3.0.0/doc/controllers/events.md)
-* [Insights](https://www.github.com/maxio-com/ab-ruby-sdk/tree/3.0.0/doc/controllers/insights.md)
-* [Invoices](https://www.github.com/maxio-com/ab-ruby-sdk/tree/3.0.0/doc/controllers/invoices.md)
-* [Offers](https://www.github.com/maxio-com/ab-ruby-sdk/tree/3.0.0/doc/controllers/offers.md)
-* [Products](https://www.github.com/maxio-com/ab-ruby-sdk/tree/3.0.0/doc/controllers/products.md)
-* [Sites](https://www.github.com/maxio-com/ab-ruby-sdk/tree/3.0.0/doc/controllers/sites.md)
-* [Subscriptions](https://www.github.com/maxio-com/ab-ruby-sdk/tree/3.0.0/doc/controllers/subscriptions.md)
-* [Webhooks](https://www.github.com/maxio-com/ab-ruby-sdk/tree/3.0.0/doc/controllers/webhooks.md)
+* [API Exports](https://www.github.com/maxio-com/ab-ruby-sdk/tree/4.0.0/doc/controllers/api-exports.md)
+* [Advance Invoice](https://www.github.com/maxio-com/ab-ruby-sdk/tree/4.0.0/doc/controllers/advance-invoice.md)
+* [Billing Portal](https://www.github.com/maxio-com/ab-ruby-sdk/tree/4.0.0/doc/controllers/billing-portal.md)
+* [Component Price Points](https://www.github.com/maxio-com/ab-ruby-sdk/tree/4.0.0/doc/controllers/component-price-points.md)
+* [Custom Fields](https://www.github.com/maxio-com/ab-ruby-sdk/tree/4.0.0/doc/controllers/custom-fields.md)
+* [Events-Based Billing Segments](https://www.github.com/maxio-com/ab-ruby-sdk/tree/4.0.0/doc/controllers/events-based-billing-segments.md)
+* [Payment Profiles](https://www.github.com/maxio-com/ab-ruby-sdk/tree/4.0.0/doc/controllers/payment-profiles.md)
+* [Product Families](https://www.github.com/maxio-com/ab-ruby-sdk/tree/4.0.0/doc/controllers/product-families.md)
+* [Product Price Points](https://www.github.com/maxio-com/ab-ruby-sdk/tree/4.0.0/doc/controllers/product-price-points.md)
+* [Proforma Invoices](https://www.github.com/maxio-com/ab-ruby-sdk/tree/4.0.0/doc/controllers/proforma-invoices.md)
+* [Reason Codes](https://www.github.com/maxio-com/ab-ruby-sdk/tree/4.0.0/doc/controllers/reason-codes.md)
+* [Referral Codes](https://www.github.com/maxio-com/ab-ruby-sdk/tree/4.0.0/doc/controllers/referral-codes.md)
+* [Sales Commissions](https://www.github.com/maxio-com/ab-ruby-sdk/tree/4.0.0/doc/controllers/sales-commissions.md)
+* [Subscription Components](https://www.github.com/maxio-com/ab-ruby-sdk/tree/4.0.0/doc/controllers/subscription-components.md)
+* [Subscription Groups](https://www.github.com/maxio-com/ab-ruby-sdk/tree/4.0.0/doc/controllers/subscription-groups.md)
+* [Subscription Group Invoice Account](https://www.github.com/maxio-com/ab-ruby-sdk/tree/4.0.0/doc/controllers/subscription-group-invoice-account.md)
+* [Subscription Group Status](https://www.github.com/maxio-com/ab-ruby-sdk/tree/4.0.0/doc/controllers/subscription-group-status.md)
+* [Subscription Invoice Account](https://www.github.com/maxio-com/ab-ruby-sdk/tree/4.0.0/doc/controllers/subscription-invoice-account.md)
+* [Subscription Notes](https://www.github.com/maxio-com/ab-ruby-sdk/tree/4.0.0/doc/controllers/subscription-notes.md)
+* [Subscription Products](https://www.github.com/maxio-com/ab-ruby-sdk/tree/4.0.0/doc/controllers/subscription-products.md)
+* [Subscription Status](https://www.github.com/maxio-com/ab-ruby-sdk/tree/4.0.0/doc/controllers/subscription-status.md)
+* [Coupons](https://www.github.com/maxio-com/ab-ruby-sdk/tree/4.0.0/doc/controllers/coupons.md)
+* [Components](https://www.github.com/maxio-com/ab-ruby-sdk/tree/4.0.0/doc/controllers/components.md)
+* [Customers](https://www.github.com/maxio-com/ab-ruby-sdk/tree/4.0.0/doc/controllers/customers.md)
+* [Events](https://www.github.com/maxio-com/ab-ruby-sdk/tree/4.0.0/doc/controllers/events.md)
+* [Insights](https://www.github.com/maxio-com/ab-ruby-sdk/tree/4.0.0/doc/controllers/insights.md)
+* [Invoices](https://www.github.com/maxio-com/ab-ruby-sdk/tree/4.0.0/doc/controllers/invoices.md)
+* [Offers](https://www.github.com/maxio-com/ab-ruby-sdk/tree/4.0.0/doc/controllers/offers.md)
+* [Products](https://www.github.com/maxio-com/ab-ruby-sdk/tree/4.0.0/doc/controllers/products.md)
+* [Sites](https://www.github.com/maxio-com/ab-ruby-sdk/tree/4.0.0/doc/controllers/sites.md)
+* [Subscriptions](https://www.github.com/maxio-com/ab-ruby-sdk/tree/4.0.0/doc/controllers/subscriptions.md)
+* [Webhooks](https://www.github.com/maxio-com/ab-ruby-sdk/tree/4.0.0/doc/controllers/webhooks.md)
 
 ## Classes Documentation
 
-* [Utility Classes](https://www.github.com/maxio-com/ab-ruby-sdk/tree/3.0.0/doc/utility-classes.md)
-* [HttpResponse](https://www.github.com/maxio-com/ab-ruby-sdk/tree/3.0.0/doc/http-response.md)
-* [HttpRequest](https://www.github.com/maxio-com/ab-ruby-sdk/tree/3.0.0/doc/http-request.md)
+* [Utility Classes](https://www.github.com/maxio-com/ab-ruby-sdk/tree/4.0.0/doc/utility-classes.md)
+* [HttpResponse](https://www.github.com/maxio-com/ab-ruby-sdk/tree/4.0.0/doc/http-response.md)
+* [HttpRequest](https://www.github.com/maxio-com/ab-ruby-sdk/tree/4.0.0/doc/http-request.md)
 

data/lib/advanced_billing/client.rb

@@ -39,6 +39,12 @@ module AdvancedBilling
       @components ||= ComponentsController.new @global_configuration
     end
 
+    # Access to component_price_points controller.
+    # @return [ComponentPricePointsController] Returns the controller instance.
+    def component_price_points
+      @component_price_points ||= ComponentPricePointsController.new @global_configuration
+    end
+
     # Access to customers controller.
     # @return [CustomersController] Returns the controller instance.
     def customers
@@ -196,7 +202,7 @@ module AdvancedBilling
     end
 
     def initialize(
-      connection: nil, adapter: :net_http_persistent, timeout: 30,
+      connection: nil, adapter: :net_http_persistent, timeout: 120,
       max_retries: 0, retry_interval: 1, backoff_factor: 2,
       retry_statuses: [408, 413, 429, 500, 502, 503, 504, 521, 522, 524],
       retry_methods: %i[get put], http_callback: nil,

data/lib/advanced_billing/configuration.rb

@@ -32,7 +32,7 @@ module AdvancedBilling
     end
 
     def initialize(
-      connection: nil, adapter: :net_http_persistent, timeout: 30,
+      connection: nil, adapter: :net_http_persistent, timeout: 120,
       max_retries: 0, retry_interval: 1, backoff_factor: 2,
       retry_statuses: [408, 413, 429, 500, 502, 503, 504, 521, 522, 524],
       retry_methods: %i[get put], http_callback: nil,

data/lib/advanced_billing/controllers/base_controller.rb

@@ -10,7 +10,7 @@ module AdvancedBilling
     attr_accessor :config, :http_call_back
 
     def self.user_agent
-      'AB SDK Ruby:3.0.0 on OS {os-info}'
+      'AB SDK Ruby:4.0.0 on OS {os-info}'
     end
 
     def self.user_agent_parameters

data/lib/advanced_billing/controllers/component_price_points_controller.rb

@@ -0,0 +1,420 @@
+# advanced_billing
+#
+# This file was automatically generated by APIMATIC v2.0
+# ( https://apimatic.io ).
+
+module AdvancedBilling
+  # ComponentPricePointsController
+  class ComponentPricePointsController < BaseController
+    # Sets a new default price point for the component. This new default will
+    # apply to all new subscriptions going forward - existing subscriptions will
+    # remain on their current price point.
+    # See [Price Points
+    # Documentation](https://chargify.zendesk.com/hc/en-us/articles/440775586588
+    # 3#price-points) for more information on price points and moving
+    # subscriptions between price points.
+    # Note: Custom price points are not able to be set as the default for a
+    # component.
+    # @param [Integer] component_id Required parameter: The Chargify id of the
+    # component to which the price point belongs
+    # @param [Integer] price_point_id Required parameter: The Chargify id of the
+    # price point
+    # @return [ComponentResponse] response from the API call
+    def promote_component_price_point_to_default(component_id,
+                                                 price_point_id)
+      new_api_call_builder
+        .request(new_request_builder(HttpMethodEnum::PUT,
+                                     '/components/{component_id}/price_points/{price_point_id}/default.json',
+                                     Server::DEFAULT)
+                   .template_param(new_parameter(component_id, key: 'component_id')
+                                    .is_required(true)
+                                    .should_encode(true))
+                   .template_param(new_parameter(price_point_id, key: 'price_point_id')
+                                    .is_required(true)
+                                    .should_encode(true))
+                   .header_param(new_parameter('application/json', key: 'accept'))
+                   .auth(Single.new('BasicAuth')))
+        .response(new_response_handler
+                   .deserializer(APIHelper.method(:custom_type_deserializer))
+                   .deserialize_into(ComponentResponse.method(:from_hash)))
+        .execute
+    end
+
+    # This endpoint can be used to create a new price point for an existing
+    # component.
+    # @param [Integer] component_id Required parameter: The Chargify id of the
+    # component
+    # @param [CreateComponentPricePointRequest] body Optional parameter:
+    # Example:
+    # @return [ComponentPricePointResponse] response from the API call
+    def create_component_price_point(component_id,
+                                     body: nil)
+      new_api_call_builder
+        .request(new_request_builder(HttpMethodEnum::POST,
+                                     '/components/{component_id}/price_points.json',
+                                     Server::DEFAULT)
+                   .template_param(new_parameter(component_id, key: 'component_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
+                   .deserializer(APIHelper.method(:custom_type_deserializer))
+                   .deserialize_into(ComponentPricePointResponse.method(:from_hash)))
+        .execute
+    end
+
+    # Use this endpoint to read current price points that are associated with a
+    # component.
+    # You may specify the component by using either the numeric id or the
+    # `handle:gold` syntax.
+    # When fetching a component's price points, if you have defined multiple
+    # currencies at the site level, you can optionally pass the
+    # `?currency_prices=true` query param to include an array of currency price
+    # data in the response.
+    # If the price point is set to `use_site_exchange_rate: true`, it will
+    # return pricing based on the current exchange rate. If the flag is set to
+    # false, it will return all of the defined prices for each currency.
+    # @param [Integer] component_id Required parameter: The Chargify id of the
+    # component
+    # @param [TrueClass | FalseClass] currency_prices Optional parameter:
+    # Include an array of currency price data
+    # @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 [Array[PricePointType]] filter_type Optional parameter: Use in
+    # query: `filter[type]=catalog,default`.
+    # @return [ComponentPricePointsResponse] response from the API call
+    def list_component_price_points(options = {})
+      new_api_call_builder
+        .request(new_request_builder(HttpMethodEnum::GET,
+                                     '/components/{component_id}/price_points.json',
+                                     Server::DEFAULT)
+                   .template_param(new_parameter(options['component_id'], key: 'component_id')
+                                    .is_required(true)
+                                    .should_encode(true))
+                   .query_param(new_parameter(options['currency_prices'], key: 'currency_prices'))
+                   .query_param(new_parameter(options['page'], key: 'page'))
+                   .query_param(new_parameter(options['per_page'], key: 'per_page'))
+                   .query_param(new_parameter(options['filter_type'], key: 'filter[type]'))
+                   .header_param(new_parameter('application/json', key: 'accept'))
+                   .auth(Single.new('BasicAuth'))
+                   .array_serialization_format(ArraySerializationFormat::CSV))
+        .response(new_response_handler
+                   .deserializer(APIHelper.method(:custom_type_deserializer))
+                   .deserialize_into(ComponentPricePointsResponse.method(:from_hash)))
+        .execute
+    end
+
+    # Use this endpoint to create multiple component price points in one
+    # request.
+    # @param [String] component_id Required parameter: The Chargify id of the
+    # component for which you want to fetch price points.
+    # @param [CreateComponentPricePointsRequest] body Optional parameter:
+    # Example:
+    # @return [ComponentPricePointsResponse] response from the API call
+    def bulk_create_component_price_points(component_id,
+                                           body: nil)
+      new_api_call_builder
+        .request(new_request_builder(HttpMethodEnum::POST,
+                                     '/components/{component_id}/price_points/bulk.json',
+                                     Server::DEFAULT)
+                   .template_param(new_parameter(component_id, key: 'component_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
+                   .deserializer(APIHelper.method(:custom_type_deserializer))
+                   .deserialize_into(ComponentPricePointsResponse.method(:from_hash)))
+        .execute
+    end
+
+    # When updating a price point, it's prices can be updated as well by
+    # creating new prices or editing / removing existing ones.
+    # Passing in a price bracket without an `id` will attempt to create a new
+    # price.
+    # Including an `id` will update the corresponding price, and including the
+    # `_destroy` flag set to true along with the `id` will remove that price.
+    # Note: Custom price points cannot be updated directly. They must be edited
+    # through the Subscription.
+    # @param [Integer | String] component_id Required parameter: The id or
+    # handle of the component. When using the handle, it must be prefixed with
+    # `handle:`. Example: `123` for an integer ID, or
+    # `handle:example-product-handle` for a string handle.
+    # @param [Integer | String] price_point_id Required parameter: The id or
+    # handle of the price point. When using the handle, it must be prefixed with
+    # `handle:`. Example: `123` for an integer ID, or
+    # `handle:example-price_point-handle` for a string handle.
+    # @param [UpdateComponentPricePointRequest] body Optional parameter:
+    # Example:
+    # @return [ComponentPricePointResponse] response from the API call
+    def update_component_price_point(component_id,
+                                     price_point_id,
+                                     body: nil)
+      new_api_call_builder
+        .request(new_request_builder(HttpMethodEnum::PUT,
+                                     '/components/{component_id}/price_points/{price_point_id}.json',
+                                     Server::DEFAULT)
+                   .template_param(new_parameter(component_id, key: 'component_id')
+                                    .is_required(true)
+                                    .should_encode(true)
+                                    .validator(proc do |value|
+                                      UnionTypeLookUp.get(:UpdateComponentPricePointComponentId)
+                                                     .validate(value)
+                                    end))
+                   .template_param(new_parameter(price_point_id, key: 'price_point_id')
+                                    .is_required(true)
+                                    .should_encode(true)
+                                    .validator(proc do |value|
+                                      UnionTypeLookUp.get(:UpdateComponentPricePointPricePointId)
+                                                     .validate(value)
+                                    end))
+                   .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
+                   .deserializer(APIHelper.method(:custom_type_deserializer))
+                   .deserialize_into(ComponentPricePointResponse.method(:from_hash))
+                   .local_error_template('422',
+                                         'HTTP Response Not OK. Status code: {$statusCode}.'\
+                                          ' Response: \'{$response.body}\'.',
+                                         ErrorArrayMapResponseException))
+        .execute
+    end
+
+    # Use this endpoint to retrieve details for a specific component price
+    # point. You can achieve this by using either the component price point ID
+    # or handle.
+    # @param [Integer | String] component_id Required parameter: The id or
+    # handle of the component. When using the handle, it must be prefixed with
+    # `handle:`. Example: `123` for an integer ID, or
+    # `handle:example-product-handle` for a string handle.
+    # @param [Integer | String] price_point_id Required parameter: The id or
+    # handle of the price point. When using the handle, it must be prefixed with
+    # `handle:`. Example: `123` for an integer ID, or
+    # `handle:example-price_point-handle` for a string handle.
+    # @return [ComponentPricePointResponse] response from the API call
+    def read_component_price_point(component_id,
+                                   price_point_id)
+      new_api_call_builder
+        .request(new_request_builder(HttpMethodEnum::GET,
+                                     '/components/{component_id}/price_points/{price_point_id}.json',
+                                     Server::DEFAULT)
+                   .template_param(new_parameter(component_id, key: 'component_id')
+                                    .is_required(true)
+                                    .should_encode(true)
+                                    .validator(proc do |value|
+                                      UnionTypeLookUp.get(:ReadComponentPricePointComponentId)
+                                                     .validate(value)
+                                    end))
+                   .template_param(new_parameter(price_point_id, key: 'price_point_id')
+                                    .is_required(true)
+                                    .should_encode(true)
+                                    .validator(proc do |value|
+                                      UnionTypeLookUp.get(:ReadComponentPricePointPricePointId)
+                                                     .validate(value)
+                                    end))
+                   .header_param(new_parameter('application/json', key: 'accept'))
+                   .auth(Single.new('BasicAuth')))
+        .response(new_response_handler
+                   .deserializer(APIHelper.method(:custom_type_deserializer))
+                   .deserialize_into(ComponentPricePointResponse.method(:from_hash)))
+        .execute
+    end
+
+    # A price point can be archived at any time. Subscriptions using a price
+    # point that has been archived will continue using it until they're moved to
+    # another price point.
+    # @param [Integer | String] component_id Required parameter: The id or
+    # handle of the component. When using the handle, it must be prefixed with
+    # `handle:`. Example: `123` for an integer ID, or
+    # `handle:example-product-handle` for a string handle.
+    # @param [Integer | String] price_point_id Required parameter: The id or
+    # handle of the price point. When using the handle, it must be prefixed with
+    # `handle:`. Example: `123` for an integer ID, or
+    # `handle:example-price_point-handle` for a string handle.
+    # @return [ComponentPricePointResponse] response from the API call
+    def archive_component_price_point(component_id,
+                                      price_point_id)
+      new_api_call_builder
+        .request(new_request_builder(HttpMethodEnum::DELETE,
+                                     '/components/{component_id}/price_points/{price_point_id}.json',
+                                     Server::DEFAULT)
+                   .template_param(new_parameter(component_id, key: 'component_id')
+                                    .is_required(true)
+                                    .should_encode(true)
+                                    .validator(proc do |value|
+                                      UnionTypeLookUp.get(:ArchiveComponentPricePointComponentId)
+                                                     .validate(value)
+                                    end))
+                   .template_param(new_parameter(price_point_id, key: 'price_point_id')
+                                    .is_required(true)
+                                    .should_encode(true)
+                                    .validator(proc do |value|
+                                      UnionTypeLookUp.get(:ArchiveComponentPricePointPricePointId)
+                                                     .validate(value)
+                                    end))
+                   .header_param(new_parameter('application/json', key: 'accept'))
+                   .auth(Single.new('BasicAuth')))
+        .response(new_response_handler
+                   .deserializer(APIHelper.method(:custom_type_deserializer))
+                   .deserialize_into(ComponentPricePointResponse.method(:from_hash))
+                   .local_error_template('422',
+                                         'HTTP Response Not OK. Status code: {$statusCode}.'\
+                                          ' Response: \'{$response.body}\'.',
+                                         ErrorListResponseException))
+        .execute
+    end
+
+    # Use this endpoint to unarchive a component price point.
+    # @param [Integer] component_id Required parameter: The Chargify id of the
+    # component to which the price point belongs
+    # @param [Integer] price_point_id Required parameter: The Chargify id of the
+    # price point
+    # @return [ComponentPricePointResponse] response from the API call
+    def unarchive_component_price_point(component_id,
+                                        price_point_id)
+      new_api_call_builder
+        .request(new_request_builder(HttpMethodEnum::PUT,
+                                     '/components/{component_id}/price_points/{price_point_id}/unarchive.json',
+                                     Server::DEFAULT)
+                   .template_param(new_parameter(component_id, key: 'component_id')
+                                    .is_required(true)
+                                    .should_encode(true))
+                   .template_param(new_parameter(price_point_id, key: 'price_point_id')
+                                    .is_required(true)
+                                    .should_encode(true))
+                   .header_param(new_parameter('application/json', key: 'accept'))
+                   .auth(Single.new('BasicAuth')))
+        .response(new_response_handler
+                   .deserializer(APIHelper.method(:custom_type_deserializer))
+                   .deserialize_into(ComponentPricePointResponse.method(:from_hash)))
+        .execute
+    end
+
+    # This endpoint allows you to create currency prices for a given currency
+    # that has been defined on the site level in your settings.
+    # When creating currency prices, they need to mirror the structure of your
+    # primary pricing. For each price level defined on the component price
+    # point, there should be a matching price level created in the given
+    # currency.
+    # Note: Currency Prices are not able to be created for custom price points.
+    # @param [Integer] price_point_id Required parameter: The Chargify id of the
+    # price point
+    # @param [CreateCurrencyPricesRequest] body Optional parameter: Example:
+    # @return [ComponentCurrencyPricesResponse] response from the API call
+    def create_currency_prices(price_point_id,
+                               body: nil)
+      new_api_call_builder
+        .request(new_request_builder(HttpMethodEnum::POST,
+                                     '/price_points/{price_point_id}/currency_prices.json',
+                                     Server::DEFAULT)
+                   .template_param(new_parameter(price_point_id, key: 'price_point_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
+                   .deserializer(APIHelper.method(:custom_type_deserializer))
+                   .deserialize_into(ComponentCurrencyPricesResponse.method(:from_hash))
+                   .local_error('422',
+                                'Unprocessable Entity (WebDAV)',
+                                ErrorArrayMapResponseException))
+        .execute
+    end
+
+    # This endpoint allows you to update currency prices for a given currency
+    # that has been defined on the site level in your settings.
+    # Note: Currency Prices are not able to be updated for custom price points.
+    # @param [Integer] price_point_id Required parameter: The Chargify id of the
+    # price point
+    # @param [UpdateCurrencyPricesRequest] body Optional parameter: Example:
+    # @return [ComponentCurrencyPricesResponse] response from the API call
+    def update_currency_prices(price_point_id,
+                               body: nil)
+      new_api_call_builder
+        .request(new_request_builder(HttpMethodEnum::PUT,
+                                     '/price_points/{price_point_id}/currency_prices.json',
+                                     Server::DEFAULT)
+                   .template_param(new_parameter(price_point_id, key: 'price_point_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
+                   .deserializer(APIHelper.method(:custom_type_deserializer))
+                   .deserialize_into(ComponentCurrencyPricesResponse.method(:from_hash))
+                   .local_error('422',
+                                'Unprocessable Entity (WebDAV)',
+                                ErrorArrayMapResponseException))
+        .execute
+    end
+
+    # This method allows to retrieve a list of Components Price Points belonging
+    # to a Site.
+    # @param [ListComponentsPricePointsInclude] include Optional parameter:
+    # Allows including additional data in the response. Use in query:
+    # `include=currency_prices`.
+    # @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 [SortingDirection] direction Optional parameter: Controls the order
+    # in which results are returned. Use in query `direction=asc`.
+    # @param [ListPricePointsFilter] filter Optional parameter: Filter to use
+    # for List PricePoints operations
+    # @return [ListComponentsPricePointsResponse] response from the API call
+    def list_all_component_price_points(options = {})
+      new_api_call_builder
+        .request(new_request_builder(HttpMethodEnum::GET,
+                                     '/components_price_points.json',
+                                     Server::DEFAULT)
+                   .query_param(new_parameter(options['include'], key: 'include'))
+                   .query_param(new_parameter(options['page'], key: 'page'))
+                   .query_param(new_parameter(options['per_page'], key: 'per_page'))
+                   .query_param(new_parameter(options['direction'], key: 'direction'))
+                   .query_param(new_parameter(options['filter'], key: 'filter'))
+                   .header_param(new_parameter('application/json', key: 'accept'))
+                   .auth(Single.new('BasicAuth'))
+                   .array_serialization_format(ArraySerializationFormat::CSV))
+        .response(new_response_handler
+                   .deserializer(APIHelper.method(:custom_type_deserializer))
+                   .deserialize_into(ListComponentsPricePointsResponse.method(:from_hash))
+                   .local_error_template('422',
+                                         'HTTP Response Not OK. Status code: {$statusCode}.'\
+                                          ' Response: \'{$response.body}\'.',
+                                         ErrorListResponseException))
+        .execute
+    end
+  end
+end