orb-apiamtic-sdk 0.0.1

data/lib/api_reference/apis/plan_api.rb

@@ -0,0 +1,763 @@
+# api_reference
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+module ApiReference
+  # PlanApi
+  class PlanApi < BaseApi
+    # This endpoint returns a list of all [plans](/core-concepts#plan-and-price)
+    # for an account in a list format.
+    # The list of plans is ordered starting from the most recently created plan.
+    # The response also includes
+    # [`pagination_metadata`](/api-reference/pagination)
+    # which lets the caller retrieve the next page of results if they exist.
+    # @param [Integer] limit Optional parameter: Example:20
+    # @param [String] cursor Optional parameter: TODO: type description here
+    # @param [Status10] status Optional parameter: Example:
+    # @param [DateTime] created_at_gte Optional parameter: TODO: type
+    # description here
+    # @param [DateTime] created_at_gt Optional parameter: TODO: type description
+    # here
+    # @param [DateTime] created_at_lt Optional parameter: TODO: type description
+    # here
+    # @param [DateTime] created_at_lte Optional parameter: TODO: type
+    # description here
+    # @return [ApiResponse] Complete http response with raw body and status code.
+    def list_plans(limit: 20,
+                   cursor: nil,
+                   status: nil,
+                   created_at_gte: nil,
+                   created_at_gt: nil,
+                   created_at_lt: nil,
+                   created_at_lte: nil)
+      @api_call
+        .request(new_request_builder(HttpMethodEnum::GET,
+                                     '/plans',
+                                     Server::DEFAULT)
+                   .query_param(new_parameter(limit, key: 'limit'))
+                   .query_param(new_parameter(cursor, key: 'cursor'))
+                   .query_param(new_parameter(status, key: 'status'))
+                   .query_param(new_parameter(created_at_gte, key: 'created_at[gte]'))
+                   .query_param(new_parameter(created_at_gt, key: 'created_at[gt]'))
+                   .query_param(new_parameter(created_at_lt, key: 'created_at[lt]'))
+                   .query_param(new_parameter(created_at_lte, key: 'created_at[lte]'))
+                   .header_param(new_parameter('application/json', key: 'accept'))
+                   .auth(Single.new('APIKeyAuth')))
+        .response(new_response_handler
+                    .deserializer(APIHelper.method(:custom_type_deserializer))
+                    .deserialize_into(Plans.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 allows creation of plans including their prices.
+    # @param [NewPlan] body Required parameter: TODO: type description here
+    # @return [ApiResponse] Complete http response with raw body and status code.
+    def create_plan(body)
+      @api_call
+        .request(new_request_builder(HttpMethodEnum::POST,
+                                     '/plans',
+                                     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(Plan.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 fetch [plan](/core-concepts##plan-and-price)
+    # details given an external_plan_id
+    # identifier. It returns information about the prices included in the plan
+    # and their configuration, as well as
+    # the product that the plan is attached to.
+    # If multiple plans are found to contain the specified external_plan_id, the
+    # active plans will take priority over
+    # archived ones, and among those, the endpoint will return the most recently
+    # created plan.
+    # ## Serialized prices
+    # Orb supports a few different pricing models
+    # out of the box. Each of these models is serialized differently in a given
+    # [Price](/core-concepts#plan-and-price)
+    # object. The `model_type` field determines the key for the configuration
+    # object that is present. A detailed explanation
+    # of price types can be found in the [Price
+    # schema](/core-concepts#plan-and-price). "
+    # @param [String] external_plan_id Required parameter: TODO: type
+    # description here
+    # @return [ApiResponse] Complete http response with raw body and status code.
+    def fetch_plan_external_id(external_plan_id)
+      @api_call
+        .request(new_request_builder(HttpMethodEnum::GET,
+                                     '/plans/external_plan_id/{external_plan_id}',
+                                     Server::DEFAULT)
+                   .template_param(new_parameter(external_plan_id, key: 'external_plan_id')
+                                    .is_required(true)
+                                    .should_encode(true))
+                   .header_param(new_parameter('application/json', key: 'accept'))
+                   .auth(Single.new('APIKeyAuth')))
+        .response(new_response_handler
+                    .deserializer(APIHelper.method(:custom_type_deserializer))
+                    .deserialize_into(Plan.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 can be used to update the `external_plan_id`, `description`,
+    # and `metadata` of an existing plan.
+    # Other fields on a plan are currently immutable.
+    # @param [String] external_plan_id Required parameter: TODO: type
+    # description here
+    # @param [EditPlan] body Required parameter: TODO: type description here
+    # @return [ApiResponse] Complete http response with raw body and status code.
+    def update_plan_external(external_plan_id,
+                             body)
+      @api_call
+        .request(new_request_builder(HttpMethodEnum::PUT,
+                                     '/plans/external_plan_id/{external_plan_id}',
+                                     Server::DEFAULT)
+                   .template_param(new_parameter(external_plan_id, key: 'external_plan_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(Plan.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 allows setting the default version of a plan.
+    # @param [String] external_plan_id Required parameter: TODO: type
+    # description here
+    # @param [SetDefaultVersion] body Required parameter: TODO: type description
+    # here
+    # @return [ApiResponse] Complete http response with raw body and status code.
+    def set_default_version_external_id(external_plan_id: nil,
+                                        body)
+      @api_call
+        .request(new_request_builder(HttpMethodEnum::POST,
+                                     '/plans/external_plan_id/{external_plan_id}/set_default_version',
+                                     Server::DEFAULT)
+                   .template_param(new_parameter(external_plan_id, key: 'external_plan_id')
+                                    .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(Plan.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 allows the creation of a new plan version for an existing
+    # plan.
+    # @param [String] external_plan_id Required parameter: TODO: type
+    # description here
+    # @param [NewPlanVersion] body Required parameter: TODO: type description
+    # here
+    # @return [ApiResponse] Complete http response with raw body and status code.
+    def create_plan_version_external_id(external_plan_id: nil,
+                                        body)
+      @api_call
+        .request(new_request_builder(HttpMethodEnum::POST,
+                                     '/plans/external_plan_id/{external_plan_id}/versions',
+                                     Server::DEFAULT)
+                   .template_param(new_parameter(external_plan_id, key: 'external_plan_id')
+                                    .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(PlanVersion.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 fetch a plan version. It returns the phases,
+    # prices, and adjustments present on this
+    # version of the plan.
+    # @param [String] version Required parameter: TODO: type description here
+    # @param [String] external_plan_id Required parameter: TODO: type
+    # description here
+    # @return [ApiResponse] Complete http response with raw body and status code.
+    def fetch_plan_version_external_id(version,
+                                       external_plan_id: nil)
+      @api_call
+        .request(new_request_builder(HttpMethodEnum::GET,
+                                     '/plans/external_plan_id/{external_plan_id}/versions/{version}',
+                                     Server::DEFAULT)
+                   .template_param(new_parameter(version, key: 'version')
+                                    .is_required(true)
+                                    .should_encode(true))
+                   .template_param(new_parameter(external_plan_id, key: 'external_plan_id')
+                                    .should_encode(true))
+                   .header_param(new_parameter('application/json', key: 'accept'))
+                   .auth(Single.new('APIKeyAuth')))
+        .response(new_response_handler
+                    .deserializer(APIHelper.method(:custom_type_deserializer))
+                    .deserialize_into(PlanVersion.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 fetch [plan](/core-concepts#plan-and-price)
+    # details given a plan identifier.
+    # It returns information about the prices included in the plan and their
+    # configuration, as well as the product
+    # that the plan is attached to.
+    # ## Serialized prices
+    # Orb supports a few different pricing models out of the box.
+    # Each of these models is serialized differently in a given
+    # [Price](/core-concepts#plan-and-price) object.
+    # The `model_type` field determines the key for the configuration object
+    # that is present. A detailed explanation of
+    # price types can be found in the [Price
+    # schema](/core-concepts#plan-and-price).
+    # ## Phases
+    # Orb supports plan phases, also known as contract ramps. For plans with
+    # phases, the serialized prices refer to
+    # all prices across all phases.
+    # @param [String] plan_id Required parameter: TODO: type description here
+    # @return [ApiResponse] Complete http response with raw body and status code.
+    def fetch_plan(plan_id)
+      @api_call
+        .request(new_request_builder(HttpMethodEnum::GET,
+                                     '/plans/{plan_id}',
+                                     Server::DEFAULT)
+                   .template_param(new_parameter(plan_id, key: 'plan_id')
+                                    .is_required(true)
+                                    .should_encode(true))
+                   .header_param(new_parameter('application/json', key: 'accept'))
+                   .auth(Single.new('APIKeyAuth')))
+        .response(new_response_handler
+                    .deserializer(APIHelper.method(:custom_type_deserializer))
+                    .deserialize_into(Plan.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 can be used to update the `external_plan_id`, `description`,
+    # and `metadata` of an existing plan.
+    # Other fields on a plan are currently immutable.
+    # @param [String] plan_id Required parameter: TODO: type description here
+    # @param [EditPlan] body Required parameter: TODO: type description here
+    # @return [ApiResponse] Complete http response with raw body and status code.
+    def update_plan(plan_id,
+                    body)
+      @api_call
+        .request(new_request_builder(HttpMethodEnum::PUT,
+                                     '/plans/{plan_id}',
+                                     Server::DEFAULT)
+                   .template_param(new_parameter(plan_id, key: 'plan_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(Plan.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 list of all migrations for a plan.
+    # The list of migrations is ordered starting from the most recently created
+    # migration.
+    # The response also includes pagination_metadata, which lets the caller
+    # retrieve the next page of results if they exist.
+    # @param [String] plan_id Required parameter: TODO: type description here
+    # @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_migrations(plan_id,
+                        limit: 20,
+                        cursor: nil)
+      @api_call
+        .request(new_request_builder(HttpMethodEnum::GET,
+                                     '/plans/{plan_id}/migrations',
+                                     Server::DEFAULT)
+                   .template_param(new_parameter(plan_id, key: 'plan_id')
+                                    .is_required(true)
+                                    .should_encode(true))
+                   .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(PlanVersionChanges.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
+
+    # TODO: type endpoint description here
+    # @param [String] plan_id Required parameter: TODO: type description here
+    # @param [String] migration_id Required parameter: TODO: type description
+    # here
+    # @return [ApiResponse] Complete http response with raw body and status code.
+    def fetch_migration(plan_id,
+                        migration_id)
+      @api_call
+        .request(new_request_builder(HttpMethodEnum::GET,
+                                     '/plans/{plan_id}/migrations/{migration_id}',
+                                     Server::DEFAULT)
+                   .template_param(new_parameter(plan_id, key: 'plan_id')
+                                    .is_required(true)
+                                    .should_encode(true))
+                   .template_param(new_parameter(migration_id, key: 'migration_id')
+                                    .is_required(true)
+                                    .should_encode(true))
+                   .header_param(new_parameter('application/json', key: 'accept'))
+                   .auth(Single.new('APIKeyAuth')))
+        .response(new_response_handler
+                    .deserializer(APIHelper.method(:custom_type_deserializer))
+                    .deserialize_into(PlanVersionChange.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 cancels a migration.
+    # @param [String] plan_id Required parameter: TODO: type description here
+    # @param [String] migration_id Required parameter: TODO: type description
+    # here
+    # @return [ApiResponse] Complete http response with raw body and status code.
+    def cancel_migration(plan_id,
+                         migration_id)
+      @api_call
+        .request(new_request_builder(HttpMethodEnum::POST,
+                                     '/plans/{plan_id}/migrations/{migration_id}/cancel',
+                                     Server::DEFAULT)
+                   .template_param(new_parameter(plan_id, key: 'plan_id')
+                                    .is_required(true)
+                                    .should_encode(true))
+                   .template_param(new_parameter(migration_id, key: 'migration_id')
+                                    .is_required(true)
+                                    .should_encode(true))
+                   .header_param(new_parameter('application/json', key: 'accept'))
+                   .auth(Single.new('APIKeyAuth')))
+        .response(new_response_handler
+                    .deserializer(APIHelper.method(:custom_type_deserializer))
+                    .deserialize_into(PlanVersionChange.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 allows setting the default version of a plan.
+    # @param [String] plan_id Required parameter: TODO: type description here
+    # @param [SetDefaultVersion] body Required parameter: TODO: type description
+    # here
+    # @return [ApiResponse] Complete http response with raw body and status code.
+    def set_default_version(plan_id: nil,
+                            body)
+      @api_call
+        .request(new_request_builder(HttpMethodEnum::POST,
+                                     '/plans/{plan_id}/set_default_version',
+                                     Server::DEFAULT)
+                   .template_param(new_parameter(plan_id, key: 'plan_id')
+                                    .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(Plan.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 allows the creation of a new plan version for an existing
+    # plan.
+    # @param [String] plan_id Required parameter: TODO: type description here
+    # @param [NewPlanVersion] body Required parameter: TODO: type description
+    # here
+    # @return [ApiResponse] Complete http response with raw body and status code.
+    def create_plan_version(plan_id: nil,
+                            body)
+      @api_call
+        .request(new_request_builder(HttpMethodEnum::POST,
+                                     '/plans/{plan_id}/versions',
+                                     Server::DEFAULT)
+                   .template_param(new_parameter(plan_id, key: 'plan_id')
+                                    .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(PlanVersion.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 fetch a plan version. It returns the phases,
+    # prices, and adjustments present on this
+    # version of the plan.
+    # @param [String] version Required parameter: TODO: type description here
+    # @param [String] plan_id Required parameter: TODO: type description here
+    # @return [ApiResponse] Complete http response with raw body and status code.
+    def fetch_plan_version(version,
+                           plan_id: nil)
+      @api_call
+        .request(new_request_builder(HttpMethodEnum::GET,
+                                     '/plans/{plan_id}/versions/{version}',
+                                     Server::DEFAULT)
+                   .template_param(new_parameter(version, key: 'version')
+                                    .is_required(true)
+                                    .should_encode(true))
+                   .template_param(new_parameter(plan_id, key: 'plan_id')
+                                    .should_encode(true))
+                   .header_param(new_parameter('application/json', key: 'accept'))
+                   .auth(Single.new('APIKeyAuth')))
+        .response(new_response_handler
+                    .deserializer(APIHelper.method(:custom_type_deserializer))
+                    .deserialize_into(PlanVersion.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