orb-apiamtic-sdk 0.0.1

data/lib/api_reference/apis/invoice_api.rb

@@ -0,0 +1,933 @@
+# api_reference
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+module ApiReference
+  # InvoiceApi
+  class InvoiceApi < BaseApi
+    # This creates a one-off fixed fee invoice line item on an Invoice.
+    # This can only be done for invoices that are in a `draft` status.
+    # The behavior depends on which parameters are provided:
+    # - If `item_id` is provided without `name`: The item is looked up by ID,
+    # and the item's name
+    #   is used for the line item.
+    # - If `name` is provided without `item_id`: An item with the given name is
+    # searched for in the account.
+    #   If found, that item is used. If not found, a new item is created with
+    # that name.
+    #   The new item's name is used for the line item.
+    # - If both `item_id` and `name` are provided: The item is looked up by ID
+    # for association,
+    #   but the provided `name` is used for the line item (not the item's name).
+    # @param [CreateInvoiceLineItemParams] body Required parameter: TODO: type
+    # description here
+    # @return [ApiResponse] Complete http response with raw body and status code.
+    def create_invoice_line_item(body)
+      @api_call
+        .request(new_request_builder(HttpMethodEnum::POST,
+                                     '/invoice_line_items',
+                                     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(InvoiceLineItem.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 [`Invoice`](/core-concepts#invoice)s
+    # for an account in a list format.
+    # The list of invoices is ordered starting from the most recently issued
+    # invoice date. The response also includes
+    # [`pagination_metadata`](/api-reference/pagination), which lets the caller
+    # retrieve the next page of results if they
+    # exist.
+    # By default, this only returns invoices that are `issued`, `paid`, or
+    # `synced`.
+    # When fetching any `draft` invoices, this returns the last-computed invoice
+    # values for each draft invoice, which may
+    # not always be up-to-date since Orb regularly refreshes invoices
+    # asynchronously.
+    # If you don't need line item details, minimums, maximums, or discounts,
+    # prefer the
+    # [list invoices summary](/api-reference/invoice/list-invoices-summary)
+    # endpoint for better performance.
+    # @param [String] customer_id Optional parameter: TODO: type description
+    # here
+    # @param [String] external_customer_id Optional parameter: TODO: type
+    # description here
+    # @param [String] subscription_id Optional parameter: TODO: type description
+    # here
+    # @param [Array[Status23]] status Optional parameter: TODO: type description
+    # here
+    # @param [String] due_date_window Optional parameter: TODO: type description
+    # here
+    # @param [DateType] date_type Optional parameter: Example:invoice_date
+    # @param [Date] due_date Optional parameter: TODO: type description here
+    # @param [Date] due_date_gt Optional parameter: TODO: type description
+    # here
+    # @param [Date] due_date_lt Optional parameter: TODO: type description
+    # here
+    # @param [String] amount Optional parameter: TODO: type description here
+    # @param [String] amount_gt Optional parameter: TODO: type description
+    # here
+    # @param [String] amount_lt Optional parameter: TODO: type description
+    # here
+    # @param [TrueClass | FalseClass] is_recurring Optional parameter: TODO:
+    # type description here
+    # @param [Integer] limit Optional parameter: Example:20
+    # @param [String] cursor Optional parameter: TODO: type description here
+    # @param [DateTime] invoice_date_gte Optional parameter: TODO: type
+    # description here
+    # @param [DateTime] invoice_date_gt Optional parameter: TODO: type
+    # description here
+    # @param [DateTime] invoice_date_lt Optional parameter: TODO: type
+    # description here
+    # @param [DateTime] invoice_date_lte Optional parameter: TODO: type
+    # description here
+    # @return [ApiResponse] Complete http response with raw body and status code.
+    def list_invoices(customer_id: nil,
+                      external_customer_id: nil,
+                      subscription_id: nil,
+                      status: nil,
+                      due_date_window: nil,
+                      date_type: DateType::INVOICE_DATE,
+                      due_date: nil,
+                      due_date_gt: nil,
+                      due_date_lt: nil,
+                      amount: nil,
+                      amount_gt: nil,
+                      amount_lt: nil,
+                      is_recurring: nil,
+                      limit: 20,
+                      cursor: nil,
+                      invoice_date_gte: nil,
+                      invoice_date_gt: nil,
+                      invoice_date_lt: nil,
+                      invoice_date_lte: nil)
+      @api_call
+        .request(new_request_builder(HttpMethodEnum::GET,
+                                     '/invoices',
+                                     Server::DEFAULT)
+                   .query_param(new_parameter(customer_id, key: 'customer_id'))
+                   .query_param(new_parameter(external_customer_id, key: 'external_customer_id'))
+                   .query_param(new_parameter(subscription_id, key: 'subscription_id'))
+                   .query_param(new_parameter(status, key: 'status[]'))
+                   .query_param(new_parameter(due_date_window, key: 'due_date_window'))
+                   .query_param(new_parameter(date_type, key: 'date_type'))
+                   .query_param(new_parameter(due_date, key: 'due_date'))
+                   .query_param(new_parameter(due_date_gt, key: 'due_date[gt]'))
+                   .query_param(new_parameter(due_date_lt, key: 'due_date[lt]'))
+                   .query_param(new_parameter(amount, key: 'amount'))
+                   .query_param(new_parameter(amount_gt, key: 'amount[gt]'))
+                   .query_param(new_parameter(amount_lt, key: 'amount[lt]'))
+                   .query_param(new_parameter(is_recurring, key: 'is_recurring'))
+                   .query_param(new_parameter(limit, key: 'limit'))
+                   .query_param(new_parameter(cursor, key: 'cursor'))
+                   .query_param(new_parameter(invoice_date_gte, key: 'invoice_date[gte]'))
+                   .query_param(new_parameter(invoice_date_gt, key: 'invoice_date[gt]'))
+                   .query_param(new_parameter(invoice_date_lt, key: 'invoice_date[lt]'))
+                   .query_param(new_parameter(invoice_date_lte, key: 'invoice_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(Invoices.method(:from_hash))
+                    .is_api_response(true)
+                    .local_error('400',
+                                 'Bad Request',
+                                 APIException)
+                    .local_error('401',
+                                 'Unauthorized',
+                                 AuthorizationErrorException)
+                    .local_error('404',
+                                 'Not Found',
+                                 APIException)
+                    .local_error('409',
+                                 'Conflict',
+                                 IdempotencyRequestMismatchException)
+                    .local_error('413',
+                                 'Content Too Large',
+                                 APIException)
+                    .local_error('429',
+                                 'Too Many Requests',
+                                 TooManyRequestsException)
+                    .local_error('500',
+                                 'Internal Server Error',
+                                 ServerErrorException))
+        .execute
+    end
+
+    # This endpoint is used to create a one-off invoice for a customer.
+    # @param [CreateOneOffInvoiceParams] body Required parameter: TODO: type
+    # description here
+    # @return [ApiResponse] Complete http response with raw body and status code.
+    def create_invoice(body)
+      @api_call
+        .request(new_request_builder(HttpMethodEnum::POST,
+                                     '/invoices',
+                                     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(Invoice.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 is a lighter-weight endpoint that returns a list of all
+    # [`Invoice`](/core-concepts#invoice) summaries for an account in a
+    # list format.
+    # These invoice summaries do not include line item details, minimums,
+    # maximums, and discounts, making this endpoint more
+    # efficient.
+    # The list of invoices is ordered starting from the most recently issued
+    # invoice date. The response also includes
+    # [`pagination_metadata`](/api-reference/pagination), which lets the caller
+    # retrieve the next page of results if they
+    # exist.
+    # By default, this only returns invoices that are `issued`, `paid`, or
+    # `synced`.
+    # When fetching any `draft` invoices, this returns the last-computed invoice
+    # values for each draft invoice, which may
+    # not always be up-to-date since Orb regularly refreshes invoices
+    # asynchronously.
+    # @param [String] customer_id Optional parameter: TODO: type description
+    # here
+    # @param [String] external_customer_id Optional parameter: TODO: type
+    # description here
+    # @param [String] subscription_id Optional parameter: TODO: type description
+    # here
+    # @param [Array[Status23]] status Optional parameter: TODO: type description
+    # here
+    # @param [String] due_date_window Optional parameter: TODO: type description
+    # here
+    # @param [DateType] date_type Optional parameter: Example:invoice_date
+    # @param [Date] due_date Optional parameter: TODO: type description here
+    # @param [Date] due_date_gt Optional parameter: TODO: type description
+    # here
+    # @param [Date] due_date_lt Optional parameter: TODO: type description
+    # here
+    # @param [String] amount Optional parameter: TODO: type description here
+    # @param [String] amount_gt Optional parameter: TODO: type description
+    # here
+    # @param [String] amount_lt Optional parameter: TODO: type description
+    # here
+    # @param [TrueClass | FalseClass] is_recurring Optional parameter: TODO:
+    # type description here
+    # @param [Integer] limit Optional parameter: Example:20
+    # @param [String] cursor Optional parameter: TODO: type description here
+    # @param [DateTime] invoice_date_gte Optional parameter: TODO: type
+    # description here
+    # @param [DateTime] invoice_date_gt Optional parameter: TODO: type
+    # description here
+    # @param [DateTime] invoice_date_lt Optional parameter: TODO: type
+    # description here
+    # @param [DateTime] invoice_date_lte Optional parameter: TODO: type
+    # description here
+    # @return [ApiResponse] Complete http response with raw body and status code.
+    def list_invoices_summary(customer_id: nil,
+                              external_customer_id: nil,
+                              subscription_id: nil,
+                              status: nil,
+                              due_date_window: nil,
+                              date_type: DateType::INVOICE_DATE,
+                              due_date: nil,
+                              due_date_gt: nil,
+                              due_date_lt: nil,
+                              amount: nil,
+                              amount_gt: nil,
+                              amount_lt: nil,
+                              is_recurring: nil,
+                              limit: 20,
+                              cursor: nil,
+                              invoice_date_gte: nil,
+                              invoice_date_gt: nil,
+                              invoice_date_lt: nil,
+                              invoice_date_lte: nil)
+      @api_call
+        .request(new_request_builder(HttpMethodEnum::GET,
+                                     '/invoices/summary',
+                                     Server::DEFAULT)
+                   .query_param(new_parameter(customer_id, key: 'customer_id'))
+                   .query_param(new_parameter(external_customer_id, key: 'external_customer_id'))
+                   .query_param(new_parameter(subscription_id, key: 'subscription_id'))
+                   .query_param(new_parameter(status, key: 'status[]'))
+                   .query_param(new_parameter(due_date_window, key: 'due_date_window'))
+                   .query_param(new_parameter(date_type, key: 'date_type'))
+                   .query_param(new_parameter(due_date, key: 'due_date'))
+                   .query_param(new_parameter(due_date_gt, key: 'due_date[gt]'))
+                   .query_param(new_parameter(due_date_lt, key: 'due_date[lt]'))
+                   .query_param(new_parameter(amount, key: 'amount'))
+                   .query_param(new_parameter(amount_gt, key: 'amount[gt]'))
+                   .query_param(new_parameter(amount_lt, key: 'amount[lt]'))
+                   .query_param(new_parameter(is_recurring, key: 'is_recurring'))
+                   .query_param(new_parameter(limit, key: 'limit'))
+                   .query_param(new_parameter(cursor, key: 'cursor'))
+                   .query_param(new_parameter(invoice_date_gte, key: 'invoice_date[gte]'))
+                   .query_param(new_parameter(invoice_date_gt, key: 'invoice_date[gt]'))
+                   .query_param(new_parameter(invoice_date_lt, key: 'invoice_date[lt]'))
+                   .query_param(new_parameter(invoice_date_lte, key: 'invoice_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(InvoiceSummarys.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 an eligible invoice to be issued manually. This is
+    # only possible with invoices where status is `draft`,
+    # `will_auto_issue` is false, and an `eligible_to_issue_at` is a time in the
+    # past. Issuing an invoice could possibly trigger
+    # side effects, some of which could be customer-visible (e.g. sending
+    # emails, auto-collecting payment,
+    # syncing the invoice to external providers, etc).
+    # This is a lighter-weight alternative to the issue invoice endpoint,
+    # returning an invoice summary without any line item details.
+    # @param [String] invoice_id Required parameter: TODO: type description
+    # here
+    # @param [IssueInvoiceRequestParams] body Optional parameter: TODO: type
+    # description here
+    # @return [ApiResponse] Complete http response with raw body and status code.
+    def issue_invoice_summary(invoice_id,
+                              body: nil)
+      @api_call
+        .request(new_request_builder(HttpMethodEnum::POST,
+                                     '/invoices/summary/{invoice_id}/issue',
+                                     Server::DEFAULT)
+                   .template_param(new_parameter(invoice_id, key: 'invoice_id')
+                                    .is_required(true)
+                                    .should_encode(true))
+                   .header_param(new_parameter('application/json', key: 'Content-Type'))
+                   .body_param(new_parameter(body))
+                   .header_param(new_parameter('application/json', key: 'accept'))
+                   .body_serializer(proc do |param| param.to_json unless param.nil? end)
+                   .auth(Single.new('APIKeyAuth')))
+        .response(new_response_handler
+                    .deserializer(APIHelper.method(:custom_type_deserializer))
+                    .deserialize_into(InvoiceSummary.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 fetch the upcoming
+    # [invoice](/core-concepts#invoice) for the current billing
+    # period given a subscription.
+    # @param [String] subscription_id Required parameter: TODO: type description
+    # here
+    # @return [ApiResponse] Complete http response with raw body and status code.
+    def fetch_upcoming_invoice(subscription_id)
+      @api_call
+        .request(new_request_builder(HttpMethodEnum::GET,
+                                     '/invoices/upcoming',
+                                     Server::DEFAULT)
+                   .query_param(new_parameter(subscription_id, key: 'subscription_id')
+                                 .is_required(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(UpcomingInvoice.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 an [`Invoice`](/core-concepts#invoice)
+    # given an identifier.
+    # @param [String] invoice_id Required parameter: TODO: type description
+    # here
+    # @return [ApiResponse] Complete http response with raw body and status code.
+    def fetch_invoice(invoice_id)
+      @api_call
+        .request(new_request_builder(HttpMethodEnum::GET,
+                                     '/invoices/{invoice_id}',
+                                     Server::DEFAULT)
+                   .template_param(new_parameter(invoice_id, key: 'invoice_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(Invoice.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 update the `metadata`, `net_terms`,
+    # `due_date`, `invoice_date`, and `auto_collection`
+    # properties on an invoice. If you pass null for the metadata value, it will
+    # clear any existing metadata for that invoice.
+    # `metadata` can be modified regardless of invoice state.
+    # `net_terms`, `due_date`, `invoice_date`, and `auto_collection` can only be
+    # modified if the invoice is in a `draft` state.
+    # `invoice_date` can only be modified for non-subscription invoices.
+    # @param [String] invoice_id Required parameter: TODO: type description
+    # here
+    # @param [UpdateInvoiceRequestParams] body Required parameter: TODO: type
+    # description here
+    # @return [ApiResponse] Complete http response with raw body and status code.
+    def update_invoice(invoice_id,
+                       body)
+      @api_call
+        .request(new_request_builder(HttpMethodEnum::PUT,
+                                     '/invoices/{invoice_id}',
+                                     Server::DEFAULT)
+                   .template_param(new_parameter(invoice_id, key: 'invoice_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(Invoice.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 an invoice line item from a draft invoice.
+    # This endpoint only allows deletion of one-off line items (not
+    # subscription-based line items).
+    # The invoice must be in a draft status for this operation to succeed.
+    # @param [String] invoice_id Required parameter: TODO: type description
+    # here
+    # @param [String] line_item_id Required parameter: TODO: type description
+    # here
+    # @return [ApiResponse] Complete http response with raw body and status code.
+    def delete_invoice_line_item(invoice_id,
+                                 line_item_id)
+      @api_call
+        .request(new_request_builder(HttpMethodEnum::DELETE,
+                                     '/invoices/{invoice_id}/invoice_line_items/{line_item_id}',
+                                     Server::DEFAULT)
+                   .template_param(new_parameter(invoice_id, key: 'invoice_id')
+                                    .is_required(true)
+                                    .should_encode(true))
+                   .template_param(new_parameter(line_item_id, key: 'line_item_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 allows an eligible invoice to be issued manually. This is
+    # only possible with invoices where status is `draft`,
+    # `will_auto_issue` is false, and an `eligible_to_issue_at` is a time in the
+    # past. Issuing an invoice could possibly trigger
+    # side effects, some of which could be customer-visible (e.g. sending
+    # emails, auto-collecting payment,
+    # syncing the invoice to external providers, etc).
+    # @param [String] invoice_id Required parameter: TODO: type description
+    # here
+    # @param [IssueInvoiceRequestParams] body Optional parameter: TODO: type
+    # description here
+    # @return [ApiResponse] Complete http response with raw body and status code.
+    def issue_invoice(invoice_id,
+                      body: nil)
+      @api_call
+        .request(new_request_builder(HttpMethodEnum::POST,
+                                     '/invoices/{invoice_id}/issue',
+                                     Server::DEFAULT)
+                   .template_param(new_parameter(invoice_id, key: 'invoice_id')
+                                    .is_required(true)
+                                    .should_encode(true))
+                   .header_param(new_parameter('application/json', key: 'Content-Type'))
+                   .body_param(new_parameter(body))
+                   .header_param(new_parameter('application/json', key: 'accept'))
+                   .body_serializer(proc do |param| param.to_json unless param.nil? end)
+                   .auth(Single.new('APIKeyAuth')))
+        .response(new_response_handler
+                    .deserializer(APIHelper.method(:custom_type_deserializer))
+                    .deserialize_into(Invoice.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 an invoice's status to be set to the `paid` status.
+    # This can only be done to invoices that are in
+    # the `issued` or `synced` status.
+    # @param [String] invoice_id Required parameter: TODO: type description
+    # here
+    # @param [MarkAsPaidRequestParams] body Required parameter: TODO: type
+    # description here
+    # @return [ApiResponse] Complete http response with raw body and status code.
+    def mark_invoice_as_paid(invoice_id,
+                             body)
+      @api_call
+        .request(new_request_builder(HttpMethodEnum::POST,
+                                     '/invoices/{invoice_id}/mark_paid',
+                                     Server::DEFAULT)
+                   .template_param(new_parameter(invoice_id, key: 'invoice_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(Invoice.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 collects payment for an invoice. By default, it uses the
+    # customer's default payment method.
+    # Optionally, a shared payment token (SPT) can be provided to pay using
+    # agent-granted credentials instead.
+    # This action can only be taken on invoices with status "issued".
+    # @param [String] invoice_id Required parameter: TODO: type description
+    # here
+    # @param [PayInvoiceParams] body Optional parameter: TODO: type description
+    # here
+    # @return [ApiResponse] Complete http response with raw body and status code.
+    def pay_invoice(invoice_id,
+                    body: nil)
+      @api_call
+        .request(new_request_builder(HttpMethodEnum::POST,
+                                     '/invoices/{invoice_id}/pay',
+                                     Server::DEFAULT)
+                   .template_param(new_parameter(invoice_id, key: 'invoice_id')
+                                    .is_required(true)
+                                    .should_encode(true))
+                   .header_param(new_parameter('application/json', key: 'Content-Type'))
+                   .body_param(new_parameter(body))
+                   .header_param(new_parameter('application/json', key: 'accept'))
+                   .body_serializer(proc do |param| param.to_json unless param.nil? end)
+                   .auth(Single.new('APIKeyAuth')))
+        .response(new_response_handler
+                    .deserializer(APIHelper.method(:custom_type_deserializer))
+                    .deserialize_into(Invoice.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 triggers a regeneration of the PDF for a finalized invoice.
+    # The invoice must be finalized (`issued`, `paid`, `synced`, or `void`) and
+    # must already have an
+    # existing PDF. The original PDF is archived (not permanently deleted) to
+    # maintain an audit trail.
+    # **Important Legal Considerations:**
+    # Regenerating invoice PDFs may not be permitted in all jurisdictions. Many
+    # tax authorities require
+    # that issued invoices remain unmodified. Before using this endpoint, ensure
+    # that:
+    # - Your local tax regulations permit modification of issued billing
+    # documents
+    # - You have a legitimate business reason (e.g., fixing template errors,
+    # updating branding)
+    # - You maintain proper records of the original PDF (archived automatically
+    # by Orb)
+    # Recommended use cases:
+    # - Correcting template rendering issues
+    # - Applying updated company branding
+    # - Updating customer data that was incorrect at issuance
+    # @param [String] invoice_id Required parameter: TODO: type description
+    # here
+    # @return [ApiResponse] Complete http response with raw body and status code.
+    def regenerate_invoice_pdf(invoice_id)
+      @api_call
+        .request(new_request_builder(HttpMethodEnum::POST,
+                                     '/invoices/{invoice_id}/regenerate_invoice_pdf',
+                                     Server::DEFAULT)
+                   .template_param(new_parameter(invoice_id, key: 'invoice_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(Invoice.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 triggers a regeneration of the receipt PDF for a paid
+    # invoice.
+    # The invoice must be in `paid` status and must already have an existing
+    # receipt PDF.
+    # The original PDF is archived (not permanently deleted) to maintain an
+    # audit trail.
+    # **Important Legal Considerations:**
+    # Regenerating receipt PDFs may not be permitted in all jurisdictions. Many
+    # tax authorities require
+    # that issued receipts remain unmodified. Before using this endpoint, ensure
+    # that:
+    # - Your local tax regulations permit modification of issued billing
+    # documents
+    # - You have a legitimate business reason (e.g., fixing template errors,
+    # updating branding)
+    # - You maintain proper records of the original PDF (archived automatically
+    # by Orb)
+    # Recommended use cases:
+    # - Correcting template rendering issues
+    # - Applying updated company branding
+    # - Updating customer data that was incorrect at issuance
+    # @param [String] invoice_id Required parameter: TODO: type description
+    # here
+    # @return [ApiResponse] Complete http response with raw body and status code.
+    def regenerate_receipt_pdf(invoice_id)
+      @api_call
+        .request(new_request_builder(HttpMethodEnum::POST,
+                                     '/invoices/{invoice_id}/regenerate_receipt_pdf',
+                                     Server::DEFAULT)
+                   .template_param(new_parameter(invoice_id, key: 'invoice_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(Invoice.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 an invoice's status to be set to the `void` status.
+    # This can only be done to invoices that are in
+    # the `issued` status.
+    # If the associated invoice has used the customer balance to change the
+    # amount due, the customer balance operation
+    # will be reverted. For example, if the invoice used \$10 of customer
+    # balance, that amount will be added back to the
+    # customer balance upon voiding.
+    # If the invoice was used to purchase a credit block, but the invoice is not
+    # yet paid, the credit block will be voided. If the
+    # invoice was created due to a top-up, the top-up will be disabled.
+    # @param [String] invoice_id Required parameter: TODO: type description
+    # here
+    # @return [ApiResponse] Complete http response with raw body and status code.
+    def void_invoice(invoice_id)
+      @api_call
+        .request(new_request_builder(HttpMethodEnum::POST,
+                                     '/invoices/{invoice_id}/void',
+                                     Server::DEFAULT)
+                   .template_param(new_parameter(invoice_id, key: 'invoice_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(Invoice.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