spaire 0.1.0 → 0.1.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 5c3af25f0c4363a1f8307706fa709277845c8a0aad75b424886d5408b2182bf8
-  data.tar.gz: 139ab02839f7707224200dcb3b11c04fa740321c6cf5f6bd6bc08f95108839c8
+  metadata.gz: dfb7bc9275e2f87415c4d037d026608581ebbe666b6aa52ad84a3034660506d2
+  data.tar.gz: 59a38466c9ce48e4455883641b7a92ce92ed42a3b7dfa36bf2f9885631bff7ad
 SHA512:
-  metadata.gz: b082c8c1a5f8043024f516d92d7e8a502a8a06dd560b2676118176ce50ff546d7743fed9a0ea47499dce8c8860dc2a6c7bb6403bbde55f5615cb26d5a881f230
-  data.tar.gz: 37af71e6ea2cdc20d6558d0065691bc4e75ccf8cfae2d56a557a5d03cc9722ad0f831fa04913bdc2b484fe7949e01743f6a8c3096aa5f84ca58c6b3873285b14
+  metadata.gz: 9f2e3891d94cc38bdbd3b301636e1fef705f53c1cdf2d059a750f79809d2cc7958aa61c81ea1f5f0a79d9b0ae0f24165cf8eed9d481be9b051474cc4caf9f811
+  data.tar.gz: e30e2dd4a6308f8bdf2b5db17aa5d8a2f4bba2ce7eadcf3398cace027b50fa03da41ca180b78a3e93e1f30c237b88ff2f5e293252da9c6b5fdbdb40573a656c3

data/lib/open_api_sdk/client_invoices.rb

@@ -424,6 +424,166 @@ module OpenApiSDK
       end
     end
 
+    sig {
+      params(
+        request: Models::Components::ClientInvoicePreviewRequest,
+        timeout_ms: T.nilable(Integer),
+        http_headers: T.nilable(T::Hash[T.any(String, Symbol), String])
+      )
+        .returns(Models::Operations::ClientInvoicesPreviewClientInvoicePdfResponse)
+    }
+    def preview_client_invoice_pdf(request:, timeout_ms: nil, http_headers: nil)
+      # preview_client_invoice_pdf - Preview Client Invoice PDF
+      # Generate a real PDF preview from form data without creating anything.
+      #
+      # **Scopes**: `client_invoices:read`
+      url, params = @sdk_configuration.get_server_details
+      base_url = Utils.template_url(url, params)
+      url = "#{base_url}/v1/client-invoices/preview-pdf"
+      headers = {}
+      headers = T.cast(headers, T::Hash[String, String])
+      req_content_type, data, form = Utils.serialize_request_body(request, false, false, :request, :json)
+      headers["content-type"] = req_content_type
+      raise StandardError, "request body is required" if data.nil? && form.nil?
+
+      if form && !form.empty?
+        body = Utils.encode_form(form)
+      elsif Utils.match_content_type(req_content_type, "application/x-www-form-urlencoded")
+        body = URI.encode_www_form(T.cast(data, T::Hash[Symbol, Object]))
+      else
+        body = data
+      end
+
+      headers["Accept"] = "application/json"
+      headers["user-agent"] = @sdk_configuration.user_agent
+
+      security = @sdk_configuration.security_source&.call
+
+      timeout = (timeout_ms.to_f / 1000) unless timeout_ms.nil?
+      timeout ||= @sdk_configuration.timeout
+
+      connection = @sdk_configuration.client
+
+      hook_ctx = SDKHooks::HookContext.new(
+        config: @sdk_configuration,
+        base_url: base_url,
+        oauth2_scopes: nil,
+        operation_id: "client_invoices:preview_client_invoice_pdf",
+        security_source: @sdk_configuration.security_source
+      )
+
+      error = T.let(nil, T.nilable(StandardError))
+      http_response = T.let(nil, T.nilable(Faraday::Response))
+
+      begin
+        http_response = T.must(connection).post(url) do |req|
+          req.body = body
+          req.headers.merge!(headers)
+          req.options.timeout = timeout unless timeout.nil?
+          Utils.configure_request_security(req, security)
+          http_headers&.each do |key, value|
+            req.headers[key.to_s] = value
+          end
+
+          @sdk_configuration.hooks.before_request(
+            hook_ctx: SDKHooks::BeforeRequestHookContext.new(
+              hook_ctx: hook_ctx
+            ),
+            request: req
+          )
+        end
+
+      rescue StandardError => e
+        error = e
+      ensure
+        if http_response.nil? || Utils.error_status?(http_response.status)
+          http_response = @sdk_configuration.hooks.after_error(
+            error: error,
+            hook_ctx: SDKHooks::AfterErrorHookContext.new(
+              hook_ctx: hook_ctx
+            ),
+            response: http_response
+          )
+        else
+          http_response = @sdk_configuration.hooks.after_success(
+            hook_ctx: SDKHooks::AfterSuccessHookContext.new(
+              hook_ctx: hook_ctx
+            ),
+            response: http_response
+          )
+        end
+
+        if http_response.nil?
+          raise error if !error.nil?
+          raise "no response"
+        end
+      end
+
+      content_type = http_response.headers.fetch("Content-Type", "application/octet-stream")
+      if Utils.match_status_code(http_response.status, ["200"])
+        http_response = @sdk_configuration.hooks.after_success(
+          hook_ctx: SDKHooks::AfterSuccessHookContext.new(
+            hook_ctx: hook_ctx
+          ),
+          response: http_response
+        )
+        return Models::Operations::ClientInvoicesPreviewClientInvoicePdfResponse.new(
+          status_code: http_response.status,
+          content_type: content_type,
+          raw_response: http_response
+        )
+      elsif Utils.match_status_code(http_response.status, ["422"])
+        if Utils.match_content_type(content_type, "application/json")
+          http_response = @sdk_configuration.hooks.after_success(
+            hook_ctx: SDKHooks::AfterSuccessHookContext.new(
+              hook_ctx: hook_ctx
+            ),
+            response: http_response
+          )
+          response_data = http_response.env.response_body
+          obj = Crystalline.unmarshal_json(JSON.parse(response_data), Models::Errors::HTTPValidationError)
+          raise obj
+        else
+          raise(
+            ::OpenApiSDK::Models::Errors::APIError.new(
+              status_code: http_response.status,
+              body: http_response.env.response_body,
+              raw_response: http_response
+            ),
+            "Unknown content type received"
+          )
+        end
+      elsif Utils.match_status_code(http_response.status, ["4XX"])
+        raise(
+          ::OpenApiSDK::Models::Errors::APIError.new(
+            status_code: http_response.status,
+            body: http_response.env.response_body,
+            raw_response: http_response
+          ),
+          "API error occurred"
+        )
+      elsif Utils.match_status_code(http_response.status, ["5XX"])
+        raise(
+          ::OpenApiSDK::Models::Errors::APIError.new(
+            status_code: http_response.status,
+            body: http_response.env.response_body,
+            raw_response: http_response
+          ),
+          "API error occurred"
+        )
+      else
+        raise(
+          ::OpenApiSDK::Models::Errors::APIError.new(
+            status_code: http_response.status,
+            body: http_response.env.response_body,
+            raw_response: http_response
+          ),
+          "Unknown status code received"
+        )
+
+      end
+    end
+
     sig {
       params(
         id: ::String,

data/lib/open_api_sdk/models/components/clientinvoicecreate.rb

@@ -76,6 +76,18 @@ module OpenApiSDK
           Crystalline::Nilable.new(Crystalline::Boolean.new),
           {'format_json': {'letter_case': ::OpenApiSDK::Utils.field_name("include_payment_link")}}
         )
+        # Whether to show the organization logo on the PDF.
+        field(
+          :show_logo,
+          Crystalline::Nilable.new(Crystalline::Boolean.new),
+          {'format_json': {'letter_case': ::OpenApiSDK::Utils.field_name("show_logo")}}
+        )
+        # Whether to show 'via spaire' label under the logo.
+        field(
+          :show_mor_attribution,
+          Crystalline::Nilable.new(Crystalline::Boolean.new),
+          {'format_json': {'letter_case': ::OpenApiSDK::Utils.field_name("show_mor_attribution")}}
+        )
         # Arbitrary key-value metadata to attach to the invoice.
         field(
           :user_metadata,
@@ -95,6 +107,8 @@ module OpenApiSDK
             discount_amount: T.nilable(::Integer),
             discount_label: T.nilable(::String),
             include_payment_link: T.nilable(T::Boolean),
+            show_logo: T.nilable(T::Boolean),
+            show_mor_attribution: T.nilable(T::Boolean),
             user_metadata: T.nilable(T::Hash[Symbol, ::Object])
           )
             .void
@@ -110,6 +124,8 @@ module OpenApiSDK
           discount_amount: 0,
           discount_label: nil,
           include_payment_link: true,
+          show_logo: true,
+          show_mor_attribution: true,
           user_metadata: nil
         )
           @customer_id = customer_id
@@ -122,6 +138,8 @@ module OpenApiSDK
           @discount_amount = discount_amount
           @discount_label = discount_label
           @include_payment_link = include_payment_link
+          @show_logo = show_logo
+          @show_mor_attribution = show_mor_attribution
           @user_metadata = user_metadata
         end
 
@@ -138,6 +156,8 @@ module OpenApiSDK
           return false unless @discount_amount == other.discount_amount
           return false unless @discount_label == other.discount_label
           return false unless @include_payment_link == other.include_payment_link
+          return false unless @show_logo == other.show_logo
+          return false unless @show_mor_attribution == other.show_mor_attribution
           return false unless @user_metadata == other.user_metadata
           true
         end

data/lib/open_api_sdk/models/components/clientinvoicecreate.rbi

@@ -66,6 +66,18 @@ class OpenApiSDK::Models::Components::ClientInvoiceCreate
   def include_payment_link=(str_)
   end
 
+  def show_logo
+  end
+
+  def show_logo=(str_)
+  end
+
+  def show_mor_attribution
+  end
+
+  def show_mor_attribution=(str_)
+  end
+
   def user_metadata
   end
 

data/lib/open_api_sdk/models/components/clientinvoicelineitempreview.rb

@@ -0,0 +1,54 @@
+# Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+
+# typed: true
+# frozen_string_literal: true
+
+module OpenApiSDK
+  module Models
+    module Components
+      # Relaxed line item for preview — allows zero amounts for in-progress editing.
+      class ClientInvoiceLineItemPreview
+        extend T::Sig
+        include Crystalline::MetadataFields
+
+        # Line item description.
+        field(
+          :description,
+          Crystalline::Nilable.new(::String),
+          {'format_json': {'letter_case': ::OpenApiSDK::Utils.field_name("description")}}
+        )
+        # Quantity.
+        field(
+          :quantity,
+          Crystalline::Nilable.new(::Integer),
+          {'format_json': {'letter_case': ::OpenApiSDK::Utils.field_name("quantity")}}
+        )
+        # Unit price in cents (0 allowed for preview).
+        field(
+          :unit_amount,
+          Crystalline::Nilable.new(::Integer),
+          {'format_json': {'letter_case': ::OpenApiSDK::Utils.field_name("unit_amount")}}
+        )
+
+        sig {
+          params(description: T.nilable(::String), quantity: T.nilable(::Integer), unit_amount: T.nilable(::Integer))
+            .void
+        }
+        def initialize(description: "—", quantity: 1, unit_amount: 0)
+          @description = description
+          @quantity = quantity
+          @unit_amount = unit_amount
+        end
+
+        sig { params(other: T.untyped).returns(T::Boolean) }
+        def ==(other)
+          return false unless other.is_a?(self.class)
+          return false unless @description == other.description
+          return false unless @quantity == other.quantity
+          return false unless @unit_amount == other.unit_amount
+          true
+        end
+      end
+    end
+  end
+end

data/lib/open_api_sdk/models/components/clientinvoicelineitempreview.rbi

@@ -0,0 +1,26 @@
+# typed: true
+# frozen_string_literal: true
+
+class OpenApiSDK::Models::Components::ClientInvoiceLineItemPreview
+  extend ::Crystalline::MetadataFields::ClassMethods
+end
+
+class OpenApiSDK::Models::Components::ClientInvoiceLineItemPreview
+  def description
+  end
+
+  def description=(str_)
+  end
+
+  def quantity
+  end
+
+  def quantity=(str_)
+  end
+
+  def unit_amount
+  end
+
+  def unit_amount=(str_)
+  end
+end

data/lib/open_api_sdk/models/components/clientinvoicepreviewrequest.rb

@@ -0,0 +1,247 @@
+# Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+
+# typed: true
+# frozen_string_literal: true
+
+module OpenApiSDK
+  module Models
+    module Components
+      # Request body for generating a real-time PDF preview without persisting.
+      class ClientInvoicePreviewRequest
+        extend T::Sig
+        include Crystalline::MetadataFields
+
+        # Organization ID.
+        field(
+          :organization_id,
+          ::String,
+          {'format_json': {'letter_case': ::OpenApiSDK::Utils.field_name("organization_id"), required: true}}
+        )
+        # ISO 4217 currency code.
+        field(
+          :currency,
+          ::String,
+          {'format_json': {'letter_case': ::OpenApiSDK::Utils.field_name("currency"), required: true}}
+        )
+        # Invoice line items.
+        field(
+          :line_items,
+          Crystalline::Array.new(Models::Components::ClientInvoiceLineItemPreview),
+          {'format_json': {'letter_case': ::OpenApiSDK::Utils.field_name("line_items"), required: true}}
+        )
+        # Optional customer ID to pull name/address from.
+        field(
+          :customer_id,
+          Crystalline::Nilable.new(::String),
+          {'format_json': {'letter_case': ::OpenApiSDK::Utils.field_name("customer_id")}}
+        )
+
+        field(
+          :due_date,
+          Crystalline::Nilable.new(::Date),
+          {
+            'format_json': {
+              'letter_case': ::OpenApiSDK::Utils.field_name("due_date"),
+              'decoder': ::OpenApiSDK::Utils.date_from_iso_format(true)
+            }
+          }
+        )
+
+        field(
+          :memo,
+          Crystalline::Nilable.new(::String),
+          {'format_json': {'letter_case': ::OpenApiSDK::Utils.field_name("memo")}}
+        )
+
+        field(
+          :po_number,
+          Crystalline::Nilable.new(::String),
+          {'format_json': {'letter_case': ::OpenApiSDK::Utils.field_name("po_number")}}
+        )
+
+        field(
+          :on_behalf_of_label,
+          Crystalline::Nilable.new(::String),
+          {'format_json': {'letter_case': ::OpenApiSDK::Utils.field_name("on_behalf_of_label")}}
+        )
+
+        field(
+          :discount_amount,
+          Crystalline::Nilable.new(::Integer),
+          {'format_json': {'letter_case': ::OpenApiSDK::Utils.field_name("discount_amount")}}
+        )
+
+        field(
+          :discount_label,
+          Crystalline::Nilable.new(::String),
+          {'format_json': {'letter_case': ::OpenApiSDK::Utils.field_name("discount_label")}}
+        )
+
+        field(
+          :include_payment_link,
+          Crystalline::Nilable.new(Crystalline::Boolean.new),
+          {'format_json': {'letter_case': ::OpenApiSDK::Utils.field_name("include_payment_link")}}
+        )
+
+        field(
+          :checkout_link_url,
+          Crystalline::Nilable.new(::String),
+          {'format_json': {'letter_case': ::OpenApiSDK::Utils.field_name("checkout_link_url")}}
+        )
+        # Whether to show the organization logo on the PDF.
+        field(
+          :show_logo,
+          Crystalline::Nilable.new(Crystalline::Boolean.new),
+          {'format_json': {'letter_case': ::OpenApiSDK::Utils.field_name("show_logo")}}
+        )
+        # Whether to show 'via spaire' label under the logo.
+        field(
+          :show_mor_attribution,
+          Crystalline::Nilable.new(Crystalline::Boolean.new),
+          {'format_json': {'letter_case': ::OpenApiSDK::Utils.field_name("show_mor_attribution")}}
+        )
+
+        field(
+          :billing_name,
+          Crystalline::Nilable.new(::String),
+          {'format_json': {'letter_case': ::OpenApiSDK::Utils.field_name("billing_name")}}
+        )
+
+        field(
+          :billing_line1,
+          Crystalline::Nilable.new(::String),
+          {'format_json': {'letter_case': ::OpenApiSDK::Utils.field_name("billing_line1")}}
+        )
+
+        field(
+          :billing_line2,
+          Crystalline::Nilable.new(::String),
+          {'format_json': {'letter_case': ::OpenApiSDK::Utils.field_name("billing_line2")}}
+        )
+
+        field(
+          :billing_city,
+          Crystalline::Nilable.new(::String),
+          {'format_json': {'letter_case': ::OpenApiSDK::Utils.field_name("billing_city")}}
+        )
+
+        field(
+          :billing_state,
+          Crystalline::Nilable.new(::String),
+          {'format_json': {'letter_case': ::OpenApiSDK::Utils.field_name("billing_state")}}
+        )
+
+        field(
+          :billing_postal_code,
+          Crystalline::Nilable.new(::String),
+          {'format_json': {'letter_case': ::OpenApiSDK::Utils.field_name("billing_postal_code")}}
+        )
+
+        field(
+          :billing_country,
+          Crystalline::Nilable.new(::String),
+          {'format_json': {'letter_case': ::OpenApiSDK::Utils.field_name("billing_country")}}
+        )
+
+        sig {
+          params(
+            organization_id: ::String,
+            currency: ::String,
+            line_items: T::Array[Models::Components::ClientInvoiceLineItemPreview],
+            customer_id: T.nilable(::String),
+            due_date: T.nilable(::Date),
+            memo: T.nilable(::String),
+            po_number: T.nilable(::String),
+            on_behalf_of_label: T.nilable(::String),
+            discount_amount: T.nilable(::Integer),
+            discount_label: T.nilable(::String),
+            include_payment_link: T.nilable(T::Boolean),
+            checkout_link_url: T.nilable(::String),
+            show_logo: T.nilable(T::Boolean),
+            show_mor_attribution: T.nilable(T::Boolean),
+            billing_name: T.nilable(::String),
+            billing_line1: T.nilable(::String),
+            billing_line2: T.nilable(::String),
+            billing_city: T.nilable(::String),
+            billing_state: T.nilable(::String),
+            billing_postal_code: T.nilable(::String),
+            billing_country: T.nilable(::String)
+          )
+            .void
+        }
+        def initialize(
+          organization_id:,
+          currency:,
+          line_items:,
+          customer_id: nil,
+          due_date: nil,
+          memo: nil,
+          po_number: nil,
+          on_behalf_of_label: nil,
+          discount_amount: 0,
+          discount_label: nil,
+          include_payment_link: true,
+          checkout_link_url: nil,
+          show_logo: true,
+          show_mor_attribution: true,
+          billing_name: nil,
+          billing_line1: nil,
+          billing_line2: nil,
+          billing_city: nil,
+          billing_state: nil,
+          billing_postal_code: nil,
+          billing_country: nil
+        )
+          @organization_id = organization_id
+          @currency = currency
+          @line_items = line_items
+          @customer_id = customer_id
+          @due_date = due_date
+          @memo = memo
+          @po_number = po_number
+          @on_behalf_of_label = on_behalf_of_label
+          @discount_amount = discount_amount
+          @discount_label = discount_label
+          @include_payment_link = include_payment_link
+          @checkout_link_url = checkout_link_url
+          @show_logo = show_logo
+          @show_mor_attribution = show_mor_attribution
+          @billing_name = billing_name
+          @billing_line1 = billing_line1
+          @billing_line2 = billing_line2
+          @billing_city = billing_city
+          @billing_state = billing_state
+          @billing_postal_code = billing_postal_code
+          @billing_country = billing_country
+        end
+
+        sig { params(other: T.untyped).returns(T::Boolean) }
+        def ==(other)
+          return false unless other.is_a?(self.class)
+          return false unless @organization_id == other.organization_id
+          return false unless @currency == other.currency
+          return false unless @line_items == other.line_items
+          return false unless @customer_id == other.customer_id
+          return false unless @due_date == other.due_date
+          return false unless @memo == other.memo
+          return false unless @po_number == other.po_number
+          return false unless @on_behalf_of_label == other.on_behalf_of_label
+          return false unless @discount_amount == other.discount_amount
+          return false unless @discount_label == other.discount_label
+          return false unless @include_payment_link == other.include_payment_link
+          return false unless @checkout_link_url == other.checkout_link_url
+          return false unless @show_logo == other.show_logo
+          return false unless @show_mor_attribution == other.show_mor_attribution
+          return false unless @billing_name == other.billing_name
+          return false unless @billing_line1 == other.billing_line1
+          return false unless @billing_line2 == other.billing_line2
+          return false unless @billing_city == other.billing_city
+          return false unless @billing_state == other.billing_state
+          return false unless @billing_postal_code == other.billing_postal_code
+          return false unless @billing_country == other.billing_country
+          true
+        end
+      end
+    end
+  end
+end