orb-apiamtic-sdk 0.0.1

data/lib/api_reference/apis/price_api.rb

@@ -0,0 +1,538 @@
+# api_reference
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+module ApiReference
+  # PriceApi
+  class PriceApi < BaseApi
+    # This endpoint is used to list all add-on prices created using the [price
+    # creation endpoint](/api-reference/price/create-price).
+    # @param [Integer] limit Optional parameter: Example:20
+    # @param [String] cursor Optional parameter: TODO: type description here
+    # @return [ApiResponse] Complete http response with raw body and status code.
+    def list_prices(limit: 20,
+                    cursor: nil)
+      @api_call
+        .request(new_request_builder(HttpMethodEnum::GET,
+                                     '/prices',
+                                     Server::DEFAULT)
+                   .query_param(new_parameter(limit, key: 'limit'))
+                   .query_param(new_parameter(cursor, key: 'cursor'))
+                   .header_param(new_parameter('application/json', key: 'accept'))
+                   .auth(Single.new('APIKeyAuth')))
+        .response(new_response_handler
+                    .deserializer(APIHelper.method(:custom_type_deserializer))
+                    .deserialize_into(Prices.method(:from_hash))
+                    .is_api_response(true)
+                    .local_error('400',
+                                 'Bad Request',
+                                 APIException)
+                    .local_error('401',
+                                 'Unauthorized',
+                                 AuthorizationErrorException)
+                    .local_error('404',
+                                 'Not Found',
+                                 APIException)
+                    .local_error('409',
+                                 'Conflict',
+                                 IdempotencyRequestMismatchException)
+                    .local_error('413',
+                                 'Content Too Large',
+                                 APIException)
+                    .local_error('429',
+                                 'Too Many Requests',
+                                 TooManyRequestsException)
+                    .local_error('500',
+                                 'Internal Server Error',
+                                 ServerErrorException))
+        .execute
+    end
+
+    # This endpoint is used to create a
+    # [price](/product-catalog/price-configuration).
+    # A price created using this endpoint is always an add-on, meaning that it's
+    # not associated with a specific plan and can instead
+    # be individually added to subscriptions, including subscriptions on
+    # different plans.
+    # An `external_price_id` can be optionally specified as an alias to allow
+    # ergonomic interaction with prices in the Orb API.
+    # See the [Price resource](/product-catalog/price-configuration) for the
+    # specification of
+    # different price model configurations possible in this endpoint.
+    # @param [NewFloatingUnitPrice | NewFloatingTieredPrice |
+    # NewFloatingBulkPrice | NewFloatingBulkWithFiltersPrice |
+    # NewFloatingPackagePrice | NewFloatingMatrixPrice |
+    # NewFloatingThresholdTotalAmountPrice | NewFloatingTieredPackagePrice |
+    # NewFloatingTieredWithMinimumPrice | NewFloatingGroupedTieredPrice |
+    # NewFloatingTieredPackageWithMinimumPrice |
+    # NewFloatingPackageWithAllocationPrice | NewFloatingUnitWithPercentPrice |
+    # NewFloatingMatrixWithAllocationPrice |
+    # NewFloatingMatrixWithThresholdDiscountsPrice |
+    # NewFloatingTieredWithProrationPrice | NewFloatingUnitWithProrationPrice |
+    # NewFloatingGroupedAllocationPrice | NewFloatingBulkWithProrationPrice |
+    # NewFloatingGroupedWithProratedMinimumPrice |
+    # NewFloatingGroupedWithMeteredMinimumPrice |
+    # NewFloatingGroupedWithMinMaxThresholdsPrice |
+    # NewFloatingMatrixWithDisplayNamePrice |
+    # NewFloatingGroupedTieredPackagePrice |
+    # NewFloatingMaxGroupTieredPackagePrice |
+    # NewFloatingScalableMatrixWithUnitPricingPrice |
+    # NewFloatingScalableMatrixWithTieredPricingPrice |
+    # NewFloatingCumulativeGroupedBulkPrice |
+    # NewFloatingCumulativeGroupedAllocationPrice |
+    # NewFloatingDailyCreditAllowancePrice | NewFloatingMeteredAllowancePrice |
+    # NewFloatingMinimumCompositePrice | NewFloatingPercentCompositePrice |
+    # NewFloatingEventOutputPrice] body Required parameter: TODO: type
+    # description here
+    # @return [ApiResponse] Complete http response with raw body and status code.
+    def create_price(body)
+      @api_call
+        .request(new_request_builder(HttpMethodEnum::POST,
+                                     '/prices',
+                                     Server::DEFAULT)
+                   .header_param(new_parameter('application/json', key: 'Content-Type'))
+                   .body_param(new_parameter(body)
+                                .is_required(true)
+                                .validator(proc do |value|
+                                  UnionTypeLookUp.get(:NewFloatingPrice)
+                                                 .validate(value)
+                                end))
+                   .header_param(new_parameter('application/json', key: 'accept'))
+                   .body_serializer(APIHelper.method(:json_serialize))
+                   .auth(Single.new('APIKeyAuth')))
+        .response(new_response_handler
+                    .deserializer(proc do |response, should_symbolize|
+                      APIHelper.deserialize_union_type(
+                        UnionTypeLookUp.get(:Price),
+                        response, should_symbolize, true
+                      )
+                    end)
+                    .is_api_response(true)
+                    .local_error('400',
+                                 'Bad Request',
+                                 APIException)
+                    .local_error('401',
+                                 'Unauthorized',
+                                 AuthorizationErrorException)
+                    .local_error('404',
+                                 'Not Found',
+                                 APIException)
+                    .local_error('409',
+                                 'Conflict',
+                                 IdempotencyRequestMismatchException)
+                    .local_error('413',
+                                 'Content Too Large',
+                                 APIException)
+                    .local_error('429',
+                                 'Too Many Requests',
+                                 TooManyRequestsException)
+                    .local_error('500',
+                                 'Internal Server Error',
+                                 ServerErrorException))
+        .execute
+    end
+
+    # This endpoint is used to evaluate the output of price(s) for a given
+    # customer and time range over ingested events.
+    # It enables filtering and grouping the output using
+    # [computed
+    # properties](/extensibility/advanced-metrics#computed-properties),
+    # supporting the following workflows:
+    # 1. Showing detailed usage and costs to the end customer.
+    # 2. Auditing subtotals on invoice line items.
+    # For these workflows, the expressiveness of computed properties in both the
+    # filters and grouping is critical.
+    # For example, if you'd like to show your customer their usage grouped by
+    # hour and another property, you can
+    # do so with the following `grouping_keys`:
+    # `["hour_floor_timestamp_millis(timestamp_millis)", "my_property"]`.
+    # If you'd like to examine a customer's usage for a specific property value,
+    # you can do so with the following `filter`:
+    # `my_property = 'foo' AND my_other_property = 'bar'`.
+    # Prices may either reference existing prices in your Orb account or be
+    # defined inline in the request body. Up to
+    # 100 prices can be evaluated in a single request.
+    # Prices are evaluated on ingested events and the start of the time range
+    # must be no more than 100 days ago. To evaluate
+    # based off a set of provided events, the [evaluate preview
+    # events](/api-reference/price/evaluate-preview-events) endpoint
+    # can be used instead.
+    # Note that this is a POST endpoint rather than a GET endpoint because it
+    # employs a JSON body rather than query parameters.
+    # @param [EvaluateMultiplePricesBody] body Required parameter: TODO: type
+    # description here
+    # @return [ApiResponse] Complete http response with raw body and status code.
+    def evaluate_multiple_prices(body)
+      @api_call
+        .request(new_request_builder(HttpMethodEnum::POST,
+                                     '/prices/evaluate',
+                                     Server::DEFAULT)
+                   .header_param(new_parameter('application/json', key: 'Content-Type'))
+                   .body_param(new_parameter(body)
+                                .is_required(true))
+                   .header_param(new_parameter('application/json', key: 'accept'))
+                   .body_serializer(proc do |param| param.to_json unless param.nil? end)
+                   .auth(Single.new('APIKeyAuth')))
+        .response(new_response_handler
+                    .deserializer(APIHelper.method(:custom_type_deserializer))
+                    .deserialize_into(EvaluateMultiplePriceResource.method(:from_hash))
+                    .is_api_response(true)
+                    .local_error('400',
+                                 'Bad Request',
+                                 APIException)
+                    .local_error('401',
+                                 'Unauthorized',
+                                 AuthorizationErrorException)
+                    .local_error('404',
+                                 'Not Found',
+                                 APIException)
+                    .local_error('409',
+                                 'Conflict',
+                                 IdempotencyRequestMismatchException)
+                    .local_error('413',
+                                 'Content Too Large',
+                                 APIException)
+                    .local_error('429',
+                                 'Too Many Requests',
+                                 TooManyRequestsException)
+                    .local_error('500',
+                                 'Internal Server Error',
+                                 ServerErrorException))
+        .execute
+    end
+
+    # This endpoint evaluates prices on preview events instead of actual usage,
+    # making it ideal for building
+    # price calculators and cost estimation tools. You can filter and group
+    # results using
+    # [computed properties](/extensibility/advanced-metrics#computed-properties)
+    # to analyze
+    # pricing across different dimensions.
+    # Prices may either reference existing prices in your Orb account or be
+    # defined inline in the request body. The endpoint has the
+    # following limitations:
+    # 1. Up to 100 prices can be evaluated in a single request.
+    # 2. Up to 500 preview events can be provided in a single request.
+    # A top-level customer_id is required to evaluate the preview events.
+    # Additionally, all events without a customer_id will have
+    # the top-level customer_id added.
+    # Note that this is a POST endpoint rather than a GET endpoint because it
+    # employs a JSON body rather than query parameters.
+    # @param [EvaluateMultiplePricesWithPreviewEventsBody] body Required
+    # parameter: TODO: type description here
+    # @return [ApiResponse] Complete http response with raw body and status code.
+    def evaluate_preview_events(body)
+      @api_call
+        .request(new_request_builder(HttpMethodEnum::POST,
+                                     '/prices/evaluate_preview_events',
+                                     Server::DEFAULT)
+                   .header_param(new_parameter('application/json', key: 'Content-Type'))
+                   .body_param(new_parameter(body)
+                                .is_required(true))
+                   .header_param(new_parameter('application/json', key: 'accept'))
+                   .body_serializer(proc do |param| param.to_json unless param.nil? end)
+                   .auth(Single.new('APIKeyAuth')))
+        .response(new_response_handler
+                    .deserializer(APIHelper.method(:custom_type_deserializer))
+                    .deserialize_into(EvaluateMultiplePriceResource.method(:from_hash))
+                    .is_api_response(true)
+                    .local_error('400',
+                                 'Bad Request',
+                                 APIException)
+                    .local_error('401',
+                                 'Unauthorized',
+                                 AuthorizationErrorException)
+                    .local_error('404',
+                                 'Not Found',
+                                 APIException)
+                    .local_error('409',
+                                 'Conflict',
+                                 IdempotencyRequestMismatchException)
+                    .local_error('413',
+                                 'Content Too Large',
+                                 APIException)
+                    .local_error('429',
+                                 'Too Many Requests',
+                                 TooManyRequestsException)
+                    .local_error('500',
+                                 'Internal Server Error',
+                                 ServerErrorException))
+        .execute
+    end
+
+    # This endpoint returns a price given an external price id.
+    # See the [price creation API](/api-reference/price/create-price) for more
+    # information about external price aliases.
+    # @param [String] external_price_id Required parameter: TODO: type
+    # description here
+    # @return [ApiResponse] Complete http response with raw body and status code.
+    def fetch_price_external_id(external_price_id)
+      @api_call
+        .request(new_request_builder(HttpMethodEnum::GET,
+                                     '/prices/external_price_id/{external_price_id}',
+                                     Server::DEFAULT)
+                   .template_param(new_parameter(external_price_id, key: 'external_price_id')
+                                    .is_required(true)
+                                    .should_encode(true))
+                   .header_param(new_parameter('application/json', key: 'accept'))
+                   .auth(Single.new('APIKeyAuth')))
+        .response(new_response_handler
+                    .deserializer(proc do |response, should_symbolize|
+                      APIHelper.deserialize_union_type(
+                        UnionTypeLookUp.get(:Price),
+                        response, should_symbolize, true
+                      )
+                    end)
+                    .is_api_response(true)
+                    .local_error('400',
+                                 'Bad Request',
+                                 APIException)
+                    .local_error('401',
+                                 'Unauthorized',
+                                 AuthorizationErrorException)
+                    .local_error('404',
+                                 'Not Found',
+                                 APIException)
+                    .local_error('409',
+                                 'Conflict',
+                                 IdempotencyRequestMismatchException)
+                    .local_error('413',
+                                 'Content Too Large',
+                                 APIException)
+                    .local_error('429',
+                                 'Too Many Requests',
+                                 TooManyRequestsException)
+                    .local_error('500',
+                                 'Internal Server Error',
+                                 ServerErrorException))
+        .execute
+    end
+
+    # This endpoint allows you to update the `metadata` property on a price. If
+    # you pass null for the metadata value,
+    # it will clear any existing metadata for that price.
+    # @param [String] external_price_id Required parameter: TODO: type
+    # description here
+    # @param [UpdatePriceRequestParams] body Required parameter: TODO: type
+    # description here
+    # @return [ApiResponse] Complete http response with raw body and status code.
+    def update_price_by_external_id(external_price_id,
+                                    body)
+      @api_call
+        .request(new_request_builder(HttpMethodEnum::PUT,
+                                     '/prices/external_price_id/{external_price_id}',
+                                     Server::DEFAULT)
+                   .template_param(new_parameter(external_price_id, key: 'external_price_id')
+                                    .is_required(true)
+                                    .should_encode(true))
+                   .header_param(new_parameter('application/json', key: 'Content-Type'))
+                   .body_param(new_parameter(body)
+                                .is_required(true))
+                   .header_param(new_parameter('application/json', key: 'accept'))
+                   .body_serializer(proc do |param| param.to_json unless param.nil? end)
+                   .auth(Single.new('APIKeyAuth')))
+        .response(new_response_handler
+                    .deserializer(proc do |response, should_symbolize|
+                      APIHelper.deserialize_union_type(
+                        UnionTypeLookUp.get(:Price),
+                        response, should_symbolize, true
+                      )
+                    end)
+                    .is_api_response(true)
+                    .local_error('400',
+                                 'Bad Request',
+                                 APIException)
+                    .local_error('401',
+                                 'Unauthorized',
+                                 AuthorizationErrorException)
+                    .local_error('404',
+                                 'Not Found',
+                                 APIException)
+                    .local_error('409',
+                                 'Conflict',
+                                 IdempotencyRequestMismatchException)
+                    .local_error('413',
+                                 'Content Too Large',
+                                 APIException)
+                    .local_error('429',
+                                 'Too Many Requests',
+                                 TooManyRequestsException)
+                    .local_error('500',
+                                 'Internal Server Error',
+                                 ServerErrorException))
+        .execute
+    end
+
+    # This endpoint returns a price given an identifier.
+    # @param [String] price_id Required parameter: TODO: type description here
+    # @return [ApiResponse] Complete http response with raw body and status code.
+    def fetch_price(price_id)
+      @api_call
+        .request(new_request_builder(HttpMethodEnum::GET,
+                                     '/prices/{price_id}',
+                                     Server::DEFAULT)
+                   .template_param(new_parameter(price_id, key: 'price_id')
+                                    .is_required(true)
+                                    .should_encode(true))
+                   .header_param(new_parameter('application/json', key: 'accept'))
+                   .auth(Single.new('APIKeyAuth')))
+        .response(new_response_handler
+                    .deserializer(proc do |response, should_symbolize|
+                      APIHelper.deserialize_union_type(
+                        UnionTypeLookUp.get(:Price),
+                        response, should_symbolize, true
+                      )
+                    end)
+                    .is_api_response(true)
+                    .local_error('400',
+                                 'Bad Request',
+                                 APIException)
+                    .local_error('401',
+                                 'Unauthorized',
+                                 AuthorizationErrorException)
+                    .local_error('404',
+                                 'Not Found',
+                                 APIException)
+                    .local_error('409',
+                                 'Conflict',
+                                 IdempotencyRequestMismatchException)
+                    .local_error('413',
+                                 'Content Too Large',
+                                 APIException)
+                    .local_error('429',
+                                 'Too Many Requests',
+                                 TooManyRequestsException)
+                    .local_error('500',
+                                 'Internal Server Error',
+                                 ServerErrorException))
+        .execute
+    end
+
+    # This endpoint allows you to update the `metadata` property on a price. If
+    # you pass null for the metadata value,
+    # it will clear any existing metadata for that price.
+    # @param [String] price_id Required parameter: TODO: type description here
+    # @param [UpdatePriceRequestParams] body Required parameter: TODO: type
+    # description here
+    # @return [ApiResponse] Complete http response with raw body and status code.
+    def update_price(price_id,
+                     body)
+      @api_call
+        .request(new_request_builder(HttpMethodEnum::PUT,
+                                     '/prices/{price_id}',
+                                     Server::DEFAULT)
+                   .template_param(new_parameter(price_id, key: 'price_id')
+                                    .is_required(true)
+                                    .should_encode(true))
+                   .header_param(new_parameter('application/json', key: 'Content-Type'))
+                   .body_param(new_parameter(body)
+                                .is_required(true))
+                   .header_param(new_parameter('application/json', key: 'accept'))
+                   .body_serializer(proc do |param| param.to_json unless param.nil? end)
+                   .auth(Single.new('APIKeyAuth')))
+        .response(new_response_handler
+                    .deserializer(proc do |response, should_symbolize|
+                      APIHelper.deserialize_union_type(
+                        UnionTypeLookUp.get(:Price),
+                        response, should_symbolize, true
+                      )
+                    end)
+                    .is_api_response(true)
+                    .local_error('400',
+                                 'Bad Request',
+                                 APIException)
+                    .local_error('401',
+                                 'Unauthorized',
+                                 AuthorizationErrorException)
+                    .local_error('404',
+                                 'Not Found',
+                                 APIException)
+                    .local_error('409',
+                                 'Conflict',
+                                 IdempotencyRequestMismatchException)
+                    .local_error('413',
+                                 'Content Too Large',
+                                 APIException)
+                    .local_error('429',
+                                 'Too Many Requests',
+                                 TooManyRequestsException)
+                    .local_error('500',
+                                 'Internal Server Error',
+                                 ServerErrorException))
+        .execute
+    end
+
+    # [NOTE] It is recommended to use the `/v1/prices/evaluate` which offers
+    # further functionality, such as multiple prices, inline
+    # price definitions, and querying over preview events.
+    # This endpoint is used to evaluate the output of a price for a given
+    # customer and time range.
+    # It enables filtering and grouping the output using
+    # [computed
+    # properties](/extensibility/advanced-metrics#computed-properties),
+    # supporting the following workflows:
+    # 1. Showing detailed usage and costs to the end customer.
+    # 2. Auditing subtotals on invoice line items.
+    # For these workflows, the expressiveness of computed properties in both the
+    # filters and grouping is critical.
+    # For example, if you'd like to show your customer their usage grouped by
+    # hour and another property, you can
+    # do so with the following `grouping_keys`:
+    # `["hour_floor_timestamp_millis(timestamp_millis)", "my_property"]`.
+    # If you'd like to examine a customer's usage for a specific property value,
+    # you can do so with the following `filter`:
+    # `my_property = 'foo' AND my_other_property = 'bar'`.
+    # By default, the start of the time range must be no more than 100 days ago
+    # and the length of the results
+    # must be no greater than 1000. Note that this is a POST endpoint rather
+    # than a GET endpoint because it
+    # employs a JSON body rather than query parameters.
+    # @param [String] price_id Required parameter: TODO: type description here
+    # @param [EvaluatePriceBody] body Required parameter: TODO: type description
+    # here
+    # @return [ApiResponse] Complete http response with raw body and status code.
+    def evaluate_price(price_id,
+                       body)
+      @api_call
+        .request(new_request_builder(HttpMethodEnum::POST,
+                                     '/prices/{price_id}/evaluate',
+                                     Server::DEFAULT)
+                   .template_param(new_parameter(price_id, key: 'price_id')
+                                    .is_required(true)
+                                    .should_encode(true))
+                   .header_param(new_parameter('application/json', key: 'Content-Type'))
+                   .body_param(new_parameter(body)
+                                .is_required(true))
+                   .header_param(new_parameter('application/json', key: 'accept'))
+                   .body_serializer(proc do |param| param.to_json unless param.nil? end)
+                   .auth(Single.new('APIKeyAuth')))
+        .response(new_response_handler
+                    .deserializer(APIHelper.method(:custom_type_deserializer))
+                    .deserialize_into(EvaluatePriceResource.method(:from_hash))
+                    .is_api_response(true)
+                    .local_error('400',
+                                 'Bad Request',
+                                 APIException)
+                    .local_error('401',
+                                 'Unauthorized',
+                                 AuthorizationErrorException)
+                    .local_error('404',
+                                 'Not Found',
+                                 APIException)
+                    .local_error('409',
+                                 'Conflict',
+                                 IdempotencyRequestMismatchException)
+                    .local_error('413',
+                                 'Content Too Large',
+                                 APIException)
+                    .local_error('429',
+                                 'Too Many Requests',
+                                 TooManyRequestsException)
+                    .local_error('500',
+                                 'Internal Server Error',
+                                 ServerErrorException))
+        .execute
+    end
+  end
+end

data/lib/api_reference/apis/price_interval_api.rb

@@ -0,0 +1,134 @@
+# api_reference
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+module ApiReference
+  # PriceIntervalApi
+  class PriceIntervalApi < BaseApi
+    # This endpoint is used to add and edit subscription
+    # [price
+    # intervals](/api-reference/price-interval/add-or-edit-price-intervals). By
+    # making
+    # modifications to a subscription’s price intervals, you can [flexibly and
+    # atomically control the billing behavior of a
+    # subscription](/product-catalog/modifying-subscriptions).
+    # ## Adding price intervals
+    # Prices can be added as
+    # price intervals to a subscription by specifying them in the `add` array. A
+    # `price_id` or `external_price_id` from an
+    # add-on price or previously removed plan price can be specified to reuse an
+    # existing price definition (however, please
+    # note that prices from other plans cannot be added to the subscription).
+    # Additionally, a new price can be specified using
+    # the `price` field — this price will be created automatically.
+    # A `start_date` must be specified for the price
+    # interval. This is the date when the price will start billing on the
+    # subscription, so this will notably result in an
+    # immediate charge at this time for any billed in advance fixed fees. The
+    # `end_date` will default to null, resulting in a
+    # price interval that will bill on a continually recurring basis. Both of
+    # these dates can be set in the past or the future
+    # and Orb will generate or modify invoices to ensure the subscription’s
+    # invoicing behavior is correct.
+    # Additionally, a
+    # discount, minimum, or maximum can be specified on the price interval. This
+    # will only apply to this price interval, not
+    # any other price intervals on the subscription.
+    # ## Adjustment intervals
+    # An adjustment interval represents the time period that a particular
+    # adjustment (a discount, minimum, or maximum) applies
+    # to the prices on a subscription. Adjustment intervals can be added to a
+    # subscription by specifying them in the
+    # `add_adjustments` array, or modified via the `edit_adjustments` array.
+    # When creating an adjustment interval, you'll need
+    # to provide the definition of the new adjustment (the type of adjustment,
+    # and which prices it applies to), as well as
+    # the start and end dates for the adjustment interval. The start and end
+    # dates of an existing adjustment interval can be edited
+    # via the `edit_adjustments` field (just like price intervals). (To "change"
+    # the amount of a discount, minimum, or maximum,
+    # then, you'll need to end the existing interval, and create a new
+    # adjustment interval with the new amount and a start date
+    # that matches the end date of the previous interval.)
+    # ## Editing price intervals
+    # Price intervals can be adjusted by
+    # specifying edits to make in the `edit` array. A `price_interval_id` to
+    # edit must be specified — this can be retrieved
+    # from the `price_intervals` field on the subscription.
+    # A new `start_date` or `end_date` can be specified to change the
+    # range of the price interval, which will modify past or future invoices to
+    # ensure correctness. If either of these dates
+    # are unspecified, they will default to the existing date on the price
+    # interval. To remove a price interval entirely from
+    # a subscription, set the `end_date` to be equivalent to the `start_date`.
+    # ## Fixed fee quantity transitions
+    # The fixed fee quantity transitions for a fixed fee price interval can also
+    # be specified when adding or editing by passing an
+    # array for `fixed_fee_quantity_transitions`. A fixed fee quantity
+    # transition must have a `quantity` and an
+    # `effective_date`, which is the date after which the new quantity will be
+    # used for billing. If a fixed fee quantity
+    # transition is scheduled at a billing period boundary, the full quantity
+    # will be billed on an invoice with the other
+    # prices on the subscription. If the fixed fee quantity transition is
+    # scheduled mid-billing period, the difference between
+    # the existing quantity and quantity specified in the transition will be
+    # prorated for the rest of the billing period and
+    # billed immediately, which will generate a new invoice.
+    # Notably, the list of fixed fee quantity transitions passed
+    # will overwrite the existing fixed fee quantity transitions on the price
+    # interval, so the entire list of transitions must
+    # be specified to add additional transitions. The existing list of
+    # transitions can be retrieved using the
+    # `fixed_fee_quantity_transitions` property on a subscription’s serialized
+    # price intervals.
+    # @param [String] subscription_id Required parameter: TODO: type description
+    # here
+    # @param [AddEditPriceIntervalParams] body Required parameter: TODO: type
+    # description here
+    # @return [ApiResponse] Complete http response with raw body and status code.
+    def add_edit_price_intervals(subscription_id,
+                                 body)
+      @api_call
+        .request(new_request_builder(HttpMethodEnum::POST,
+                                     '/subscriptions/{subscription_id}/price_intervals',
+                                     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)
+                                .is_required(true))
+                   .header_param(new_parameter('application/json', key: 'accept'))
+                   .body_serializer(proc do |param| param.to_json unless param.nil? end)
+                   .auth(Single.new('APIKeyAuth')))
+        .response(new_response_handler
+                    .deserializer(APIHelper.method(:custom_type_deserializer))
+                    .deserialize_into(MutatedSubscription.method(:from_hash))
+                    .is_api_response(true)
+                    .local_error('400',
+                                 'Bad Request',
+                                 APIException)
+                    .local_error('401',
+                                 'Unauthorized',
+                                 AuthorizationErrorException)
+                    .local_error('404',
+                                 'Not Found',
+                                 APIException)
+                    .local_error('409',
+                                 'Conflict',
+                                 IdempotencyRequestMismatchException)
+                    .local_error('413',
+                                 'Content Too Large',
+                                 APIException)
+                    .local_error('429',
+                                 'Too Many Requests',
+                                 TooManyRequestsException)
+                    .local_error('500',
+                                 'Internal Server Error',
+                                 ServerErrorException))
+        .execute
+    end
+  end
+end