orb-apiamtic-sdk 0.0.1

data/lib/api_reference/apis/credit_api.rb

@@ -0,0 +1,1269 @@
+# api_reference
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+module ApiReference
+  # CreditApi
+  class CreditApi < BaseApi
+    # This endpoint returns a credit block identified by its block_id.
+    # @param [String] block_id Required parameter: TODO: type description here
+    # @return [ApiResponse] Complete http response with raw body and status code.
+    def fetch_credit_block(block_id)
+      @api_call
+        .request(new_request_builder(HttpMethodEnum::GET,
+                                     '/credit_blocks/{block_id}',
+                                     Server::DEFAULT)
+                   .template_param(new_parameter(block_id, key: 'block_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(CreditBlock.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 deletes a credit block by its ID.
+    # When a credit block is deleted:
+    # - The block is removed from the customer's credit ledger.
+    # - Any usage of the credit block is reversed, and the ledger is replayed as
+    # if the block never existed.
+    # - If invoices were generated from the purchase of the credit block, they
+    # will be deleted if in draft status,
+    #   voided if issued, or a credit note will be issued if the invoice is
+    # paid.
+    # <Note>
+    # Issued invoices that had credits applied from this block will not be
+    # regenerated, but the ledger will
+    # reflect the state as if credits from the deleted block were never applied.
+    # </Note>
+    # @param [String] block_id Required parameter: TODO: type description here
+    # @return [ApiResponse] Complete http response with raw body and status code.
+    def delete_credit_block(block_id)
+      @api_call
+        .request(new_request_builder(HttpMethodEnum::DELETE,
+                                     '/credit_blocks/{block_id}',
+                                     Server::DEFAULT)
+                   .template_param(new_parameter(block_id, key: 'block_id')
+                                    .is_required(true)
+                                    .should_encode(true))
+                   .auth(Single.new('APIKeyAuth')))
+        .response(new_response_handler
+                    .is_response_void(true)
+                    .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 the credit block and its associated purchasing
+    # invoices.
+    # If a credit block was purchased (as opposed to being manually added),
+    # this endpoint returns the invoices that were created to charge the
+    # customer for the credit block.
+    # For credit blocks with payment schedules spanning multiple periods (e.g.,
+    # monthly payments over 12 months),
+    # multiple invoices will be returned.
+    # For credit blocks created by subscription allocation prices, this endpoint
+    # returns the subscription
+    # invoice containing the allocation line item that created the block.
+    # If the credit block was not purchased (e.g., manual increment), an empty
+    # invoices list is returned.
+    # **Note: This endpoint is currently experimental and its interface may
+    # change in future releases.
+    # Please contact support before building production integrations against
+    # this endpoint.**
+    # @param [String] block_id Required parameter: TODO: type description here
+    # @return [ApiResponse] Complete http response with raw body and status code.
+    def list_credit_block_invoices(block_id)
+      @api_call
+        .request(new_request_builder(HttpMethodEnum::GET,
+                                     '/credit_blocks/{block_id}/invoices',
+                                     Server::DEFAULT)
+                   .template_param(new_parameter(block_id, key: 'block_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(CreditBlockInvoicesResponse.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
+
+    # Returns a paginated list of unexpired, non-zero credit blocks for a
+    # customer.
+    # If `include_all_blocks` is set to `true`, all credit blocks (including
+    # expired and depleted blocks) will be included in
+    # the response.
+    # Note that `currency` defaults to credits if not specified. To use a real
+    # world currency, set `currency` to an ISO 4217 string.
+    # Results can be filtered by the block's `effective_date` using the
+    # `effective_date[gte]`, `effective_date[gt]`,
+    # `effective_date[lt]`, and `effective_date[lte]` query parameters. This
+    # filters on when the credit block
+    # becomes effective, which may differ from creation time for backdated
+    # credits.
+    # @param [String] external_customer_id Required parameter: TODO: type
+    # description here
+    # @param [Integer] limit Optional parameter: Example:20
+    # @param [String] cursor Optional parameter: TODO: type description here
+    # @param [String] currency Optional parameter: TODO: type description here
+    # @param [TrueClass | FalseClass] include_all_blocks Optional parameter:
+    # Example:false
+    # @param [DateTime] effective_date_gte Optional parameter: TODO: type
+    # description here
+    # @param [DateTime] effective_date_gt Optional parameter: TODO: type
+    # description here
+    # @param [DateTime] effective_date_lt Optional parameter: TODO: type
+    # description here
+    # @param [DateTime] effective_date_lte Optional parameter: TODO: type
+    # description here
+    # @return [ApiResponse] Complete http response with raw body and status code.
+    def fetch_customer_credits_external_id(external_customer_id: nil,
+                                           limit: 20,
+                                           cursor: nil,
+                                           currency: nil,
+                                           include_all_blocks: false,
+                                           effective_date_gte: nil,
+                                           effective_date_gt: nil,
+                                           effective_date_lt: nil,
+                                           effective_date_lte: nil)
+      @api_call
+        .request(new_request_builder(HttpMethodEnum::GET,
+                                     '/customers/external_customer_id/{external_customer_id}/credits',
+                                     Server::DEFAULT)
+                   .template_param(new_parameter(external_customer_id, key: 'external_customer_id')
+                                    .should_encode(true))
+                   .query_param(new_parameter(limit, key: 'limit'))
+                   .query_param(new_parameter(cursor, key: 'cursor'))
+                   .query_param(new_parameter(currency, key: 'currency'))
+                   .query_param(new_parameter(include_all_blocks, key: 'include_all_blocks'))
+                   .query_param(new_parameter(effective_date_gte, key: 'effective_date[gte]'))
+                   .query_param(new_parameter(effective_date_gt, key: 'effective_date[gt]'))
+                   .query_param(new_parameter(effective_date_lt, key: 'effective_date[lt]'))
+                   .query_param(new_parameter(effective_date_lte, key: 'effective_date[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(CustomerCreditBalances.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
+
+    # The credits ledger provides _auditing_ functionality over Orb's credits
+    # system with a list of actions that have
+    # taken place to modify a customer's credit balance. This [paginated
+    # endpoint](/api-reference/pagination) lists these
+    # entries, starting from the most recent ledger entry.
+    # More details on using Orb's real-time credit feature are
+    # [here](/product-catalog/prepurchase).
+    # There are four major types of modifications to credit balance, detailed
+    # below.
+    # ## Increment
+    # Credits (which optionally expire on a future date) can be added via the
+    # API
+    # ([Add Ledger Entry](create-ledger-entry)). The ledger entry for such an
+    # action will always contain the total
+    # eligible starting and ending balance for the customer at the time the
+    # entry was added to the ledger.
+    # ## Decrement
+    # Deductions can occur as a result of an API call to create a ledger entry
+    # (see
+    # [Add Ledger Entry](create-ledger-entry)), or automatically as a result of
+    # incurring usage. Both ledger entries
+    # present the `decrement` entry type.
+    # As usage for a customer is reported into Orb, credits may be deducted
+    # according to the customer's plan
+    # configuration. An automated deduction of this type will result in a ledger
+    # entry, also with a starting and ending
+    # balance. Each day's usage for a particular price, invoice, and block will
+    # be grouped into a single entry.
+    # By default, Orb uses an algorithm that automatically deducts from the
+    # *soonest expiring credit block* first in
+    # order to ensure that all credits are utilized appropriately. As an
+    # example, if trial credits with an expiration date
+    # of 2 weeks from now are present for a customer, they will be used before
+    # any deductions take place from a
+    # non-expiring credit block.
+    # If there are multiple blocks with the same expiration date, Orb will
+    # deduct from the block with the
+    # *lower cost basis* first (e.g. trial credits with a \$0 cost basis before
+    # paid credits with a \$5.00 cost basis).
+    # It's also possible for a single usage event's deduction to _span_ credit
+    # blocks. In this case, Orb will deduct from
+    # the next block, ending at the credit block which consists of unexpiring
+    # credits. Each of these deductions will lead
+    # to a _separate_ ledger entry, one per credit block that is deducted from.
+    # By default, the customer's total credit
+    # balance in Orb can be negative as a result of a decrement.
+    # ## Expiration change
+    # The expiry of credits can be changed as a result of the API (See [Add
+    # Ledger Entry](create-ledger-entry)). This will
+    # create a ledger entry that specifies the balance as well as the initial
+    # and target expiry dates.
+    # Note that for this entry type, `starting_balance` will equal
+    # `ending_balance`, and the `amount` represents the
+    # balance transferred. The credit block linked to the ledger entry is the
+    # source credit block from which there was an
+    # expiration change.
+    # ## Credits expiry
+    # When a set of credits expire on pre-set expiration date, the customer's
+    # balance automatically reflects this change
+    # and adds an entry to the ledger indicating this event. Note that credit
+    # expiry should always happen close to a date
+    # boundary in the customer's timezone.
+    # ## Void initiated
+    # Credit blocks can be voided via the API. The `amount` on this entry
+    # corresponds to the number of credits that were
+    # remaining in the block at time of void. `void_reason` will be populated if
+    # the void is created with a reason.
+    # ## Void
+    # When a set of credits is voided, the customer's balance automatically
+    # reflects this change and adds an entry to the
+    # ledger indicating this event.
+    # ## Amendment
+    # When credits are added to a customer's balance as a result of a
+    # correction, this entry will be added to the ledger
+    # to indicate the adjustment of credits.
+    # @param [String] external_customer_id Required parameter: TODO: type
+    # description here
+    # @param [Integer] limit Optional parameter: Example:20
+    # @param [String] cursor Optional parameter: TODO: type description here
+    # @param [String] currency Optional parameter: TODO: type description here
+    # @param [String] minimum_amount Optional parameter: TODO: type description
+    # here
+    # @param [EntryType] entry_type Optional parameter: Example:
+    # @param [EntryStatus] entry_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 fetch_customer_credits_ledger_external_id(external_customer_id: nil,
+                                                  limit: 20,
+                                                  cursor: nil,
+                                                  currency: nil,
+                                                  minimum_amount: nil,
+                                                  entry_type: nil,
+                                                  entry_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,
+                                     '/customers/external_customer_id/{external_customer_id}/credits/ledger',
+                                     Server::DEFAULT)
+                   .template_param(new_parameter(external_customer_id, key: 'external_customer_id')
+                                    .should_encode(true))
+                   .query_param(new_parameter(limit, key: 'limit'))
+                   .query_param(new_parameter(cursor, key: 'cursor'))
+                   .query_param(new_parameter(currency, key: 'currency'))
+                   .query_param(new_parameter(minimum_amount, key: 'minimum_amount'))
+                   .query_param(new_parameter(entry_type, key: 'entry_type'))
+                   .query_param(new_parameter(entry_status, key: 'entry_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(CreditLedgerEntries.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 you to create a new ledger entry for a specified
+    # customer's balance. This can be used to
+    # increment balance, deduct credits, and change the expiry date of existing
+    # credits.
+    # ## Effects of adding a ledger entry
+    # 1. After calling this endpoint, [Fetch Credit
+    # Balance](fetch-customer-credits) will return a credit block that
+    #   represents the changes (i.e. balance changes or transfers).
+    # 2. A ledger entry will be added to the credits ledger for this customer,
+    # and therefore returned in the
+    #   [View Credits Ledger](fetch-customer-credits-ledger) response as well as
+    # serialized in the response to this request. In
+    #   the case of deductions without a specified block, multiple ledger
+    # entries may be created if the deduction spans
+    #   credit blocks.
+    # 3. If `invoice_settings` is specified, an invoice will be created that
+    # reflects the cost of the credits (based on
+    #   `amount` and `per_unit_cost_basis`).
+    # ## Adding credits
+    #   Adding credits is done by creating an entry of type `increment`. This
+    # requires the caller to specify a number of
+    #   credits as well as an optional expiry date in `YYYY-MM-DD` format. Orb
+    # also recommends specifying a description
+    #   to assist with auditing. When adding credits, the caller can also
+    # specify a cost basis per-credit, to indicate
+    #   how much in USD a customer paid for a single credit in a block. This can
+    # later be used for revenue recognition.
+    # The following snippet illustrates a sample request body to increment
+    # credits which will expire in January of 2022.
+    # ```json
+    # {
+    #   "entry_type": "increment",
+    #   "amount": 100,
+    #   "expiry_date": "2022-12-28",
+    #   "per_unit_cost_basis": "0.20",
+    #   "description": "Purchased 100 credits"
+    # }
+    # ```
+    # Note that an `increment` entry always creates a new credit block (defined
+    # by the optional `effective_date` and
+    # `expiry_date`); it never modifies an existing block.
+    # ### Invoicing for credits
+    # By default, Orb manipulates the credit ledger but does not charge for
+    # credits. However, if you pass
+    # `invoice_settings` in the body of this request, Orb will also generate a
+    # one-off invoice for the customer for the
+    # credits pre-purchase. Note that you _must_ provide the
+    # `per_unit_cost_basis`, since the total charges on the
+    # invoice are calculated by multiplying the cost basis with the number of
+    # credit units added. If you invoice or handle payment
+    # of credits outside of Orb (i.e. marketplace customers), set `mark_as_paid`
+    # in the `invoice_settings` to `true` to prevent
+    # duplicate invoicing effects.
+    # * if `per_unit_cost_basis` is greater than zero, an invoice will be
+    # generated and `invoice_settings` must be included
+    # * if `invoice_settings` is passed, one of either `custom_due_date` or
+    # `net_terms` is required to determine the due date
+    # ## Deducting Credits
+    # Orb allows you to deduct credits from a customer by creating an entry of
+    # type `decrement`. A `decrement` entry
+    # records credits as usage and immediately recognizes revenue at the block's
+    # `per_unit_cost_basis`.
+    # For most credit removals, use `void` (no revenue impact) or
+    # `expiration_change` (revenue recognized on expiration)
+    # instead. Only use `decrement` when credits were genuinely consumed outside
+    # of normal event ingestion.
+    # Orb matches the algorithm for automatic deductions for determining which
+    # credit blocks to decrement from. In the
+    # case that the deduction leads to multiple ledger entries, the response
+    # from this endpoint will be the final
+    # deduction. Orb also optionally allows specifying a description to assist
+    # with auditing.
+    # The following snippet illustrates a sample request body to decrement
+    # credits.
+    # ```json
+    # {
+    #   "entry_type": "decrement",
+    #   "amount": 20,
+    #   "description": "Removing excess credits"
+    # }
+    # ```
+    # ## Changing credits expiry
+    # If you'd like to change when existing credits expire, you should create a
+    # ledger entry of type `expiration_change`.
+    # For this entry, the required parameter `expiry_date` identifies the
+    # _originating_ block, and the required parameter
+    # `target_expiry_date` identifies when the transferred credits should now
+    # expire. A new credit block will be created
+    # with expiry date `target_expiry_date`, with the same cost basis data as
+    # the original credit block, if present.
+    # Note that the balance of the block with the given `expiry_date` must be at
+    # least equal to the desired transfer
+    # amount determined by the `amount` parameter.
+    # The following snippet illustrates a sample request body to extend the
+    # expiration date of credits by one year:
+    # ```json
+    # {
+    #   "entry_type": "expiration_change",
+    #   "amount": 10,
+    #   "expiry_date": "2022-12-28",
+    #   "block_id": "UiUhFWeLHPrBY4Ad",
+    #   "target_expiry_date": "2023-12-28",
+    #   "description": "Extending credit validity"
+    # }
+    # ```
+    # ## Voiding credits
+    # If you'd like to void a credit block, create a ledger entry of type
+    # `void`. For this entry, `block_id` is required
+    # to identify the block, and `amount` indicates how many credits to void, up
+    # to the block's initial balance. Pass
+    # in a `void_reason` of `refund` if the void is due to a refund.
+    # ## Amendment
+    # If you'd like to undo a decrement on a credit block, create a ledger entry
+    # of type `amendment`. For this entry, `block_id`
+    # is required to identify the block that was originally decremented from,
+    # and `amount` indicates how many credits to return
+    # to the customer, up to the block's initial balance.
+    # @param [String] external_customer_id Required parameter: TODO: type
+    # description here
+    # @param [AddIncrementCreditLedgerEntryRequestParams |
+    # AddDecrementCreditLedgerEntryRequestParams |
+    # AddExpirationChangeCreditLedgerEntryRequestParams |
+    # AddVoidCreditLedgerEntryRequestParams |
+    # AddAmendmentCreditLedgerEntryRequestParams] body Required parameter: TODO:
+    # type description here
+    # @return [ApiResponse] Complete http response with raw body and status code.
+    def create_ledger_entry_external_id(external_customer_id: nil,
+                                        body)
+      @api_call
+        .request(new_request_builder(HttpMethodEnum::POST,
+                                     '/customers/external_customer_id/{external_customer_id}/credits/ledger_entry',
+                                     Server::DEFAULT)
+                   .template_param(new_parameter(external_customer_id, key: 'external_customer_id')
+                                    .should_encode(true))
+                   .header_param(new_parameter('application/json', key: 'Content-Type'))
+                   .body_param(new_parameter(body)
+                                .is_required(true)
+                                .validator(proc do |value|
+                                  UnionTypeLookUp.get(:AddCreditLedgerEntryRequestParams)
+                                                 .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(:CreditLedgerEntry),
+                        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
+
+    # TODO: type endpoint description here
+    # @param [String] external_customer_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_top_ups_external_id(external_customer_id: nil,
+                                 limit: 20,
+                                 cursor: nil)
+      @api_call
+        .request(new_request_builder(HttpMethodEnum::GET,
+                                     '/customers/external_customer_id/{external_customer_id}/credits/top_ups',
+                                     Server::DEFAULT)
+                   .template_param(new_parameter(external_customer_id, key: 'external_customer_id')
+                                    .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(TopUps.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 you to create a new top-up for a specified customer's
+    # balance.
+    # While this top-up is active, the customer's balance will added in
+    # increments of
+    # the specified amount whenever the balance reaches the specified threshold.
+    # If a top-up already exists for this customer in the same currency,
+    # the existing top-up will be replaced.
+    # @param [String] external_customer_id Required parameter: TODO: type
+    # description here
+    # @param [AddCreditTopUpRequestParams] body Required parameter: TODO: type
+    # description here
+    # @return [ApiResponse] Complete http response with raw body and status code.
+    def create_top_up_external_id(external_customer_id: nil,
+                                  body)
+      @api_call
+        .request(new_request_builder(HttpMethodEnum::POST,
+                                     '/customers/external_customer_id/{external_customer_id}/credits/top_ups',
+                                     Server::DEFAULT)
+                   .template_param(new_parameter(external_customer_id, key: 'external_customer_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(TopUp.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 deactivates the top-up and voids any invoices associated with pending
+    # credit blocks purchased through the top-up.
+    # @param [String] top_up_id Required parameter: TODO: type description
+    # here
+    # @param [String] external_customer_id Required parameter: TODO: type
+    # description here
+    # @return [ApiResponse] Complete http response with raw body and status code.
+    def delete_top_up_external_id(top_up_id,
+                                  external_customer_id: nil)
+      @api_call
+        .request(new_request_builder(HttpMethodEnum::DELETE,
+                                     '/customers/external_customer_id/{external_customer_id}/credits/top_ups/{top_up_id}',
+                                     Server::DEFAULT)
+                   .template_param(new_parameter(top_up_id, key: 'top_up_id')
+                                    .is_required(true)
+                                    .should_encode(true))
+                   .template_param(new_parameter(external_customer_id, key: 'external_customer_id')
+                                    .should_encode(true))
+                   .auth(Single.new('APIKeyAuth')))
+        .response(new_response_handler
+                    .is_response_void(true)
+                    .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
+
+    # Returns a paginated list of unexpired, non-zero credit blocks for a
+    # customer.
+    # If `include_all_blocks` is set to `true`, all credit blocks (including
+    # expired and depleted blocks) will be included in
+    # the response.
+    # Note that `currency` defaults to credits if not specified. To use a real
+    # world currency, set `currency` to an ISO 4217 string.
+    # Results can be filtered by the block's `effective_date` using the
+    # `effective_date[gte]`, `effective_date[gt]`,
+    # `effective_date[lt]`, and `effective_date[lte]` query parameters. This
+    # filters on when the credit block
+    # becomes effective, which may differ from creation time for backdated
+    # credits.
+    # @param [String] customer_id Required parameter: TODO: type description
+    # here
+    # @param [Integer] limit Optional parameter: Example:20
+    # @param [String] cursor Optional parameter: TODO: type description here
+    # @param [String] currency Optional parameter: TODO: type description here
+    # @param [TrueClass | FalseClass] include_all_blocks Optional parameter:
+    # Example:false
+    # @param [DateTime] effective_date_gte Optional parameter: TODO: type
+    # description here
+    # @param [DateTime] effective_date_gt Optional parameter: TODO: type
+    # description here
+    # @param [DateTime] effective_date_lt Optional parameter: TODO: type
+    # description here
+    # @param [DateTime] effective_date_lte Optional parameter: TODO: type
+    # description here
+    # @return [ApiResponse] Complete http response with raw body and status code.
+    def fetch_customer_credits(customer_id: nil,
+                               limit: 20,
+                               cursor: nil,
+                               currency: nil,
+                               include_all_blocks: false,
+                               effective_date_gte: nil,
+                               effective_date_gt: nil,
+                               effective_date_lt: nil,
+                               effective_date_lte: nil)
+      @api_call
+        .request(new_request_builder(HttpMethodEnum::GET,
+                                     '/customers/{customer_id}/credits',
+                                     Server::DEFAULT)
+                   .template_param(new_parameter(customer_id, key: 'customer_id')
+                                    .should_encode(true))
+                   .query_param(new_parameter(limit, key: 'limit'))
+                   .query_param(new_parameter(cursor, key: 'cursor'))
+                   .query_param(new_parameter(currency, key: 'currency'))
+                   .query_param(new_parameter(include_all_blocks, key: 'include_all_blocks'))
+                   .query_param(new_parameter(effective_date_gte, key: 'effective_date[gte]'))
+                   .query_param(new_parameter(effective_date_gt, key: 'effective_date[gt]'))
+                   .query_param(new_parameter(effective_date_lt, key: 'effective_date[lt]'))
+                   .query_param(new_parameter(effective_date_lte, key: 'effective_date[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(CustomerCreditBalances.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
+
+    # The credits ledger provides _auditing_ functionality over Orb's credits
+    # system with a list of actions that have
+    # taken place to modify a customer's credit balance. This [paginated
+    # endpoint](/api-reference/pagination) lists these
+    # entries, starting from the most recent ledger entry.
+    # More details on using Orb's real-time credit feature are
+    # [here](/product-catalog/prepurchase).
+    # There are four major types of modifications to credit balance, detailed
+    # below.
+    # ## Increment
+    # Credits (which optionally expire on a future date) can be added via the
+    # API
+    # ([Add Ledger Entry](create-ledger-entry)). The ledger entry for such an
+    # action will always contain the total
+    # eligible starting and ending balance for the customer at the time the
+    # entry was added to the ledger.
+    # ## Decrement
+    # Deductions can occur as a result of an API call to create a ledger entry
+    # (see
+    # [Add Ledger Entry](create-ledger-entry)), or automatically as a result of
+    # incurring usage. Both ledger entries
+    # present the `decrement` entry type.
+    # As usage for a customer is reported into Orb, credits may be deducted
+    # according to the customer's plan
+    # configuration. An automated deduction of this type will result in a ledger
+    # entry, also with a starting and ending
+    # balance. Each day's usage for a particular price, invoice, and block will
+    # be grouped into a single entry.
+    # By default, Orb uses an algorithm that automatically deducts from the
+    # *soonest expiring credit block* first in
+    # order to ensure that all credits are utilized appropriately. As an
+    # example, if trial credits with an expiration date
+    # of 2 weeks from now are present for a customer, they will be used before
+    # any deductions take place from a
+    # non-expiring credit block.
+    # If there are multiple blocks with the same expiration date, Orb will
+    # deduct from the block with the
+    # *lower cost basis* first (e.g. trial credits with a \$0 cost basis before
+    # paid credits with a \$5.00 cost basis).
+    # It's also possible for a single usage event's deduction to _span_ credit
+    # blocks. In this case, Orb will deduct from
+    # the next block, ending at the credit block which consists of unexpiring
+    # credits. Each of these deductions will lead
+    # to a _separate_ ledger entry, one per credit block that is deducted from.
+    # By default, the customer's total credit
+    # balance in Orb can be negative as a result of a decrement.
+    # ## Expiration change
+    # The expiry of credits can be changed as a result of the API (See [Add
+    # Ledger Entry](create-ledger-entry)). This will
+    # create a ledger entry that specifies the balance as well as the initial
+    # and target expiry dates.
+    # Note that for this entry type, `starting_balance` will equal
+    # `ending_balance`, and the `amount` represents the
+    # balance transferred. The credit block linked to the ledger entry is the
+    # source credit block from which there was an
+    # expiration change.
+    # ## Credits expiry
+    # When a set of credits expire on pre-set expiration date, the customer's
+    # balance automatically reflects this change
+    # and adds an entry to the ledger indicating this event. Note that credit
+    # expiry should always happen close to a date
+    # boundary in the customer's timezone.
+    # ## Void initiated
+    # Credit blocks can be voided via the API. The `amount` on this entry
+    # corresponds to the number of credits that were
+    # remaining in the block at time of void. `void_reason` will be populated if
+    # the void is created with a reason.
+    # ## Void
+    # When a set of credits is voided, the customer's balance automatically
+    # reflects this change and adds an entry to the
+    # ledger indicating this event.
+    # ## Amendment
+    # When credits are added to a customer's balance as a result of a
+    # correction, this entry will be added to the ledger
+    # to indicate the adjustment of credits.
+    # @param [String] customer_id Required parameter: TODO: type description
+    # here
+    # @param [Integer] limit Optional parameter: Example:20
+    # @param [String] cursor Optional parameter: TODO: type description here
+    # @param [String] currency Optional parameter: TODO: type description here
+    # @param [String] minimum_amount Optional parameter: TODO: type description
+    # here
+    # @param [EntryType] entry_type Optional parameter: Example:
+    # @param [EntryStatus] entry_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 fetch_customer_credits_ledger(customer_id: nil,
+                                      limit: 20,
+                                      cursor: nil,
+                                      currency: nil,
+                                      minimum_amount: nil,
+                                      entry_type: nil,
+                                      entry_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,
+                                     '/customers/{customer_id}/credits/ledger',
+                                     Server::DEFAULT)
+                   .template_param(new_parameter(customer_id, key: 'customer_id')
+                                    .should_encode(true))
+                   .query_param(new_parameter(limit, key: 'limit'))
+                   .query_param(new_parameter(cursor, key: 'cursor'))
+                   .query_param(new_parameter(currency, key: 'currency'))
+                   .query_param(new_parameter(minimum_amount, key: 'minimum_amount'))
+                   .query_param(new_parameter(entry_type, key: 'entry_type'))
+                   .query_param(new_parameter(entry_status, key: 'entry_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(CreditLedgerEntries.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 you to create a new ledger entry for a specified
+    # customer's balance. This can be used to
+    # increment balance, deduct credits, and change the expiry date of existing
+    # credits.
+    # ## Effects of adding a ledger entry
+    # 1. After calling this endpoint, [Fetch Credit
+    # Balance](fetch-customer-credits) will return a credit block that
+    #   represents the changes (i.e. balance changes or transfers).
+    # 2. A ledger entry will be added to the credits ledger for this customer,
+    # and therefore returned in the
+    #   [View Credits Ledger](fetch-customer-credits-ledger) response as well as
+    # serialized in the response to this request. In
+    #   the case of deductions without a specified block, multiple ledger
+    # entries may be created if the deduction spans
+    #   credit blocks.
+    # 3. If `invoice_settings` is specified, an invoice will be created that
+    # reflects the cost of the credits (based on
+    #   `amount` and `per_unit_cost_basis`).
+    # ## Adding credits
+    #   Adding credits is done by creating an entry of type `increment`. This
+    # requires the caller to specify a number of
+    #   credits as well as an optional expiry date in `YYYY-MM-DD` format. Orb
+    # also recommends specifying a description
+    #   to assist with auditing. When adding credits, the caller can also
+    # specify a cost basis per-credit, to indicate
+    #   how much in USD a customer paid for a single credit in a block. This can
+    # later be used for revenue recognition.
+    # The following snippet illustrates a sample request body to increment
+    # credits which will expire in January of 2022.
+    # ```json
+    # {
+    #   "entry_type": "increment",
+    #   "amount": 100,
+    #   "expiry_date": "2022-12-28",
+    #   "per_unit_cost_basis": "0.20",
+    #   "description": "Purchased 100 credits"
+    # }
+    # ```
+    # Note that an `increment` entry always creates a new credit block (defined
+    # by the optional `effective_date` and
+    # `expiry_date`); it never modifies an existing block.
+    # ### Invoicing for credits
+    # By default, Orb manipulates the credit ledger but does not charge for
+    # credits. However, if you pass
+    # `invoice_settings` in the body of this request, Orb will also generate a
+    # one-off invoice for the customer for the
+    # credits pre-purchase. Note that you _must_ provide the
+    # `per_unit_cost_basis`, since the total charges on the
+    # invoice are calculated by multiplying the cost basis with the number of
+    # credit units added. If you invoice or handle payment
+    # of credits outside of Orb (i.e. marketplace customers), set `mark_as_paid`
+    # in the `invoice_settings` to `true` to prevent
+    # duplicate invoicing effects.
+    # * if `per_unit_cost_basis` is greater than zero, an invoice will be
+    # generated and `invoice_settings` must be included
+    # * if `invoice_settings` is passed, one of either `custom_due_date` or
+    # `net_terms` is required to determine the due date
+    # ## Deducting Credits
+    # Orb allows you to deduct credits from a customer by creating an entry of
+    # type `decrement`. A `decrement` entry
+    # records credits as usage and immediately recognizes revenue at the block's
+    # `per_unit_cost_basis`.
+    # For most credit removals, use `void` (no revenue impact) or
+    # `expiration_change` (revenue recognized on expiration)
+    # instead. Only use `decrement` when credits were genuinely consumed outside
+    # of normal event ingestion.
+    # Orb matches the algorithm for automatic deductions for determining which
+    # credit blocks to decrement from. In the
+    # case that the deduction leads to multiple ledger entries, the response
+    # from this endpoint will be the final
+    # deduction. Orb also optionally allows specifying a description to assist
+    # with auditing.
+    # The following snippet illustrates a sample request body to decrement
+    # credits.
+    # ```json
+    # {
+    #   "entry_type": "decrement",
+    #   "amount": 20,
+    #   "description": "Removing excess credits"
+    # }
+    # ```
+    # ## Changing credits expiry
+    # If you'd like to change when existing credits expire, you should create a
+    # ledger entry of type `expiration_change`.
+    # For this entry, the required parameter `expiry_date` identifies the
+    # _originating_ block, and the required parameter
+    # `target_expiry_date` identifies when the transferred credits should now
+    # expire. A new credit block will be created
+    # with expiry date `target_expiry_date`, with the same cost basis data as
+    # the original credit block, if present.
+    # Note that the balance of the block with the given `expiry_date` must be at
+    # least equal to the desired transfer
+    # amount determined by the `amount` parameter.
+    # The following snippet illustrates a sample request body to extend the
+    # expiration date of credits by one year:
+    # ```json
+    # {
+    #   "entry_type": "expiration_change",
+    #   "amount": 10,
+    #   "expiry_date": "2022-12-28",
+    #   "block_id": "UiUhFWeLHPrBY4Ad",
+    #   "target_expiry_date": "2023-12-28",
+    #   "description": "Extending credit validity"
+    # }
+    # ```
+    # ## Voiding credits
+    # If you'd like to void a credit block, create a ledger entry of type
+    # `void`. For this entry, `block_id` is required
+    # to identify the block, and `amount` indicates how many credits to void, up
+    # to the block's initial balance. Pass
+    # in a `void_reason` of `refund` if the void is due to a refund.
+    # ## Amendment
+    # If you'd like to undo a decrement on a credit block, create a ledger entry
+    # of type `amendment`. For this entry, `block_id`
+    # is required to identify the block that was originally decremented from,
+    # and `amount` indicates how many credits to return
+    # to the customer, up to the block's initial balance.
+    # @param [String] customer_id Required parameter: TODO: type description
+    # here
+    # @param [AddIncrementCreditLedgerEntryRequestParams |
+    # AddDecrementCreditLedgerEntryRequestParams |
+    # AddExpirationChangeCreditLedgerEntryRequestParams |
+    # AddVoidCreditLedgerEntryRequestParams |
+    # AddAmendmentCreditLedgerEntryRequestParams] body Required parameter: TODO:
+    # type description here
+    # @return [ApiResponse] Complete http response with raw body and status code.
+    def create_ledger_entry(customer_id: nil,
+                            body)
+      @api_call
+        .request(new_request_builder(HttpMethodEnum::POST,
+                                     '/customers/{customer_id}/credits/ledger_entry',
+                                     Server::DEFAULT)
+                   .template_param(new_parameter(customer_id, key: 'customer_id')
+                                    .should_encode(true))
+                   .header_param(new_parameter('application/json', key: 'Content-Type'))
+                   .body_param(new_parameter(body)
+                                .is_required(true)
+                                .validator(proc do |value|
+                                  UnionTypeLookUp.get(:AddCreditLedgerEntryRequestParams)
+                                                 .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(:CreditLedgerEntry),
+                        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
+
+    # TODO: type endpoint description here
+    # @param [String] customer_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_top_ups(customer_id: nil,
+                     limit: 20,
+                     cursor: nil)
+      @api_call
+        .request(new_request_builder(HttpMethodEnum::GET,
+                                     '/customers/{customer_id}/credits/top_ups',
+                                     Server::DEFAULT)
+                   .template_param(new_parameter(customer_id, key: 'customer_id')
+                                    .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(TopUps.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 you to create a new top-up for a specified customer's
+    # balance.
+    # While this top-up is active, the customer's balance will added in
+    # increments of
+    # the specified amount whenever the balance reaches the specified threshold.
+    # If a top-up already exists for this customer in the same currency,
+    # the existing top-up will be replaced.
+    # @param [String] customer_id Required parameter: TODO: type description
+    # here
+    # @param [AddCreditTopUpRequestParams] body Required parameter: TODO: type
+    # description here
+    # @return [ApiResponse] Complete http response with raw body and status code.
+    def create_top_up(customer_id: nil,
+                      body)
+      @api_call
+        .request(new_request_builder(HttpMethodEnum::POST,
+                                     '/customers/{customer_id}/credits/top_ups',
+                                     Server::DEFAULT)
+                   .template_param(new_parameter(customer_id, key: 'customer_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(TopUp.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 deactivates the top-up and voids any invoices associated with pending
+    # credit blocks purchased through the top-up.
+    # @param [String] top_up_id Required parameter: TODO: type description
+    # here
+    # @param [String] customer_id Required parameter: TODO: type description
+    # here
+    # @return [ApiResponse] Complete http response with raw body and status code.
+    def delete_top_up(top_up_id,
+                      customer_id: nil)
+      @api_call
+        .request(new_request_builder(HttpMethodEnum::DELETE,
+                                     '/customers/{customer_id}/credits/top_ups/{top_up_id}',
+                                     Server::DEFAULT)
+                   .template_param(new_parameter(top_up_id, key: 'top_up_id')
+                                    .is_required(true)
+                                    .should_encode(true))
+                   .template_param(new_parameter(customer_id, key: 'customer_id')
+                                    .should_encode(true))
+                   .auth(Single.new('APIKeyAuth')))
+        .response(new_response_handler
+                    .is_response_void(true)
+                    .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