orb-apiamtic-sdk 0.0.1

data/lib/api_reference/models/payment_method.rb

@@ -0,0 +1,188 @@
+# api_reference
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+require 'date'
+module ApiReference
+  # A payment method represents a customer's stored payment instrument held with
+  # an external payment provider (such as Adyen or Stripe). The serialization is
+  # intentionally minimal for now; provider-pulled details (e.g. card display
+  # metadata) will be added over time.
+  class PaymentMethod < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # The Orb-assigned unique identifier for the payment method.
+    # @return [String]
+    attr_accessor :id
+
+    # The type of the underlying payment instrument, e.g. `card` or
+    # `us_bank_account`.
+    # @return [PaymentMethodType]
+    attr_accessor :payment_method_type
+
+    # The external payment provider this method belongs to, derived from the
+    # linked payment gateway connection (e.g. `adyen` or `stripe`). Null if the
+    # connection has been removed.
+    # @return [String]
+    attr_accessor :provider_type
+
+    # The identifier of this payment method in the external payment provider.
+    # @return [String]
+    attr_accessor :external_payment_method_id
+
+    # The ID of the Orb customer this payment method is attached to.
+    # @return [String]
+    attr_accessor :customer_id
+
+    # Whether this is the customer's default payment method.
+    # @return [TrueClass | FalseClass]
+    attr_accessor :default
+
+    # The time at which the payment method was created.
+    # @return [DateTime]
+    attr_accessor :created_at
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['id'] = 'id'
+      @_hash['payment_method_type'] = 'payment_method_type'
+      @_hash['provider_type'] = 'provider_type'
+      @_hash['external_payment_method_id'] = 'external_payment_method_id'
+      @_hash['customer_id'] = 'customer_id'
+      @_hash['default'] = 'default'
+      @_hash['created_at'] = 'created_at'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      []
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      %w[
+        provider_type
+      ]
+    end
+
+    def initialize(id:, payment_method_type:, provider_type:,
+                   external_payment_method_id:, customer_id:, default:,
+                   created_at:, additional_properties: nil)
+      # Add additional model properties to the instance
+      additional_properties = {} if additional_properties.nil?
+
+      @id = id
+      @payment_method_type = payment_method_type
+      @provider_type = provider_type
+      @external_payment_method_id = external_payment_method_id
+      @customer_id = customer_id
+      @default = default
+      @created_at = created_at
+      @additional_properties = additional_properties
+    end
+
+    # Creates an instance of the object from a hash.
+    def self.from_hash(hash)
+      return nil unless hash
+
+      # Extract variables from the hash.
+      id = hash.key?('id') ? hash['id'] : nil
+      payment_method_type =
+        hash.key?('payment_method_type') ? hash['payment_method_type'] : nil
+      provider_type = hash.key?('provider_type') ? hash['provider_type'] : nil
+      external_payment_method_id =
+        hash.key?('external_payment_method_id') ? hash['external_payment_method_id'] : nil
+      customer_id = hash.key?('customer_id') ? hash['customer_id'] : nil
+      default = hash.key?('default') ? hash['default'] : nil
+      created_at = if hash.key?('created_at')
+                     (DateTimeHelper.from_rfc3339(hash['created_at']) if hash['created_at'])
+                   end
+
+      # Create a new hash for additional properties, removing known properties.
+      new_hash = hash.reject { |k, _| names.value?(k) }
+
+      additional_properties = APIHelper.get_additional_properties(
+        new_hash, proc { |value| value }
+      )
+
+      # Create object from extracted values.
+      PaymentMethod.new(id: id,
+                        payment_method_type: payment_method_type,
+                        provider_type: provider_type,
+                        external_payment_method_id: external_payment_method_id,
+                        customer_id: customer_id,
+                        default: default,
+                        created_at: created_at,
+                        additional_properties: additional_properties)
+    end
+
+    def to_custom_created_at
+      DateTimeHelper.to_rfc3339(created_at)
+    end
+
+    # Validates an instance of the object from a given value.
+    # @param [PaymentMethod | Hash] The value against the validation is performed.
+    def self.validate(value)
+      if value.instance_of? self
+        return (
+          APIHelper.valid_type?(value.id,
+                                ->(val) { val.instance_of? String }) and
+            APIHelper.valid_type?(value.payment_method_type,
+                                  ->(val) { PaymentMethodType.validate(val) }) and
+            APIHelper.valid_type?(value.provider_type,
+                                  ->(val) { val.instance_of? String }) and
+            APIHelper.valid_type?(value.external_payment_method_id,
+                                  ->(val) { val.instance_of? String }) and
+            APIHelper.valid_type?(value.customer_id,
+                                  ->(val) { val.instance_of? String }) and
+            APIHelper.valid_type?(value.default,
+                                  ->(val) { val.instance_of? TrueClass or val.instance_of? FalseClass }) and
+            APIHelper.valid_type?(value.created_at,
+                                  ->(val) { val.instance_of? DateTime })
+        )
+      end
+
+      return false unless value.instance_of? Hash
+
+      (
+        APIHelper.valid_type?(value['id'],
+                              ->(val) { val.instance_of? String }) and
+          APIHelper.valid_type?(value['payment_method_type'],
+                                ->(val) { PaymentMethodType.validate(val) }) and
+          APIHelper.valid_type?(value['provider_type'],
+                                ->(val) { val.instance_of? String }) and
+          APIHelper.valid_type?(value['external_payment_method_id'],
+                                ->(val) { val.instance_of? String }) and
+          APIHelper.valid_type?(value['customer_id'],
+                                ->(val) { val.instance_of? String }) and
+          APIHelper.valid_type?(value['default'],
+                                ->(val) { val.instance_of? TrueClass or val.instance_of? FalseClass }) and
+          APIHelper.valid_type?(value['created_at'],
+                                ->(val) { val.instance_of? String })
+      )
+    end
+
+    # Provides a human-readable string representation of the object.
+    def to_s
+      class_name = self.class.name.split('::').last
+      "<#{class_name} id: #{@id}, payment_method_type: #{@payment_method_type}, provider_type:"\
+      " #{@provider_type}, external_payment_method_id: #{@external_payment_method_id},"\
+      " customer_id: #{@customer_id}, default: #{@default}, created_at: #{@created_at},"\
+      " additional_properties: #{@additional_properties}>"
+    end
+
+    # Provides a debugging-friendly string with detailed object information.
+    def inspect
+      class_name = self.class.name.split('::').last
+      "<#{class_name} id: #{@id.inspect}, payment_method_type: #{@payment_method_type.inspect},"\
+      " provider_type: #{@provider_type.inspect}, external_payment_method_id:"\
+      " #{@external_payment_method_id.inspect}, customer_id: #{@customer_id.inspect}, default:"\
+      " #{@default.inspect}, created_at: #{@created_at.inspect}, additional_properties:"\
+      " #{@additional_properties}>"
+    end
+  end
+end

data/lib/api_reference/models/payment_method_type.rb

@@ -0,0 +1,49 @@
+# api_reference
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+module ApiReference
+  # The type of the underlying payment instrument, e.g. `card` or
+  # `us_bank_account`.
+  class PaymentMethodType
+    PAYMENT_METHOD_TYPE = [
+      # TODO: Write general description for CARD
+      CARD = 'card'.freeze,
+
+      # TODO: Write general description for US_BANK_ACCOUNT
+      US_BANK_ACCOUNT = 'us_bank_account'.freeze,
+
+      # TODO: Write general description for LINK
+      LINK = 'link'.freeze,
+
+      # TODO: Write general description for AMAZON_PAY
+      AMAZON_PAY = 'amazon_pay'.freeze,
+
+      # TODO: Write general description for CRYPTO
+      CRYPTO = 'crypto'.freeze
+    ].freeze
+
+    def self.validate(value)
+      return false if value.nil?
+
+      true
+    end
+
+    def self.from_value(value, default_value = CARD)
+      return default_value if value.nil?
+
+      str = value.to_s.strip
+
+      case str.downcase
+      when 'card' then CARD
+      when 'us_bank_account' then US_BANK_ACCOUNT
+      when 'link' then LINK
+      when 'amazon_pay' then AMAZON_PAY
+      when 'crypto' then CRYPTO
+      else
+        default_value
+      end
+    end
+  end
+end

data/lib/api_reference/models/payment_provider.rb

@@ -0,0 +1,36 @@
+# api_reference
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+module ApiReference
+  # Payment Provider.
+  class PaymentProvider
+    PAYMENT_PROVIDER = [
+      # TODO: Write general description for STRIPE
+      STRIPE = 'stripe'.freeze,
+
+      # TODO: Write general description for ADYEN
+      ADYEN = 'adyen'.freeze
+    ].freeze
+
+    def self.validate(value)
+      return false if value.nil?
+
+      true
+    end
+
+    def self.from_value(value, default_value = STRIPE)
+      return default_value if value.nil?
+
+      str = value.to_s.strip
+
+      case str.downcase
+      when 'stripe' then STRIPE
+      when 'adyen' then ADYEN
+      else
+        default_value
+      end
+    end
+  end
+end

data/lib/api_reference/models/payment_provider1.rb

@@ -0,0 +1,52 @@
+# api_reference
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+module ApiReference
+  # Payment Provider1.
+  class PaymentProvider1
+    PAYMENT_PROVIDER1 = [
+      # TODO: Write general description for QUICKBOOKS
+      QUICKBOOKS = 'quickbooks'.freeze,
+
+      # TODO: Write general description for ENUM_BILLCOM
+      ENUM_BILLCOM = 'bill.com'.freeze,
+
+      # TODO: Write general description for STRIPE_CHARGE
+      STRIPE_CHARGE = 'stripe_charge'.freeze,
+
+      # TODO: Write general description for STRIPE_INVOICE
+      STRIPE_INVOICE = 'stripe_invoice'.freeze,
+
+      # TODO: Write general description for NETSUITE
+      NETSUITE = 'netsuite'.freeze,
+
+      # TODO: Write general description for ADYEN
+      ADYEN = 'adyen'.freeze
+    ].freeze
+
+    def self.validate(value)
+      return false if value.nil?
+
+      true
+    end
+
+    def self.from_value(value, default_value = QUICKBOOKS)
+      return default_value if value.nil?
+
+      str = value.to_s.strip
+
+      case str.downcase
+      when 'quickbooks' then QUICKBOOKS
+      when 'enum_billcom' then ENUM_BILLCOM
+      when 'stripe_charge' then STRIPE_CHARGE
+      when 'stripe_invoice' then STRIPE_INVOICE
+      when 'netsuite' then NETSUITE
+      when 'adyen' then ADYEN
+      else
+        default_value
+      end
+    end
+  end
+end

data/lib/api_reference/models/per_price_cost.rb

@@ -0,0 +1,145 @@
+# api_reference
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+module ApiReference
+  # PerPriceCost Model.
+  class PerPriceCost < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # The price's quantity for the timeframe
+    # @return [Float]
+    attr_accessor :quantity
+
+    # Price's contributions for the timeframe, excluding any minimums and
+    # discounts.
+    # @return [String]
+    attr_accessor :subtotal
+
+    # Price's contributions for the timeframe, including minimums and discounts.
+    # @return [String]
+    attr_accessor :total
+
+    # The price object
+    # @return [Object]
+    attr_accessor :price
+
+    # The price the cost is associated with
+    # @return [String]
+    attr_accessor :price_id
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['quantity'] = 'quantity'
+      @_hash['subtotal'] = 'subtotal'
+      @_hash['total'] = 'total'
+      @_hash['price'] = 'price'
+      @_hash['price_id'] = 'price_id'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        quantity
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      %w[
+        quantity
+      ]
+    end
+
+    def initialize(subtotal:, total:, price:, price_id:, quantity: SKIP,
+                   additional_properties: nil)
+      # Add additional model properties to the instance
+      additional_properties = {} if additional_properties.nil?
+
+      @quantity = quantity unless quantity == SKIP
+      @subtotal = subtotal
+      @total = total
+      @price = price
+      @price_id = price_id
+      @additional_properties = additional_properties
+    end
+
+    # Creates an instance of the object from a hash.
+    def self.from_hash(hash)
+      return nil unless hash
+
+      # Extract variables from the hash.
+      subtotal = hash.key?('subtotal') ? hash['subtotal'] : nil
+      total = hash.key?('total') ? hash['total'] : nil
+      price = hash.key?('price') ? APIHelper.deserialize_union_type(
+        UnionTypeLookUp.get(:PerPriceCostPrice), hash['price']
+      ) : nil
+      price_id = hash.key?('price_id') ? hash['price_id'] : nil
+      quantity = hash.key?('quantity') ? hash['quantity'] : SKIP
+
+      # Create a new hash for additional properties, removing known properties.
+      new_hash = hash.reject { |k, _| names.value?(k) }
+
+      additional_properties = APIHelper.get_additional_properties(
+        new_hash, proc { |value| value }
+      )
+
+      # Create object from extracted values.
+      PerPriceCost.new(subtotal: subtotal,
+                       total: total,
+                       price: price,
+                       price_id: price_id,
+                       quantity: quantity,
+                       additional_properties: additional_properties)
+    end
+
+    # Validates an instance of the object from a given value.
+    # @param [PerPriceCost | Hash] The value against the validation is performed.
+    def self.validate(value)
+      if value.instance_of? self
+        return (
+          APIHelper.valid_type?(value.subtotal,
+                                ->(val) { val.instance_of? String }) and
+            APIHelper.valid_type?(value.total,
+                                  ->(val) { val.instance_of? String }) and
+            UnionTypeLookUp.get(:PerPriceCostPrice)
+                           .validate(value.price) and
+            APIHelper.valid_type?(value.price_id,
+                                  ->(val) { val.instance_of? String })
+        )
+      end
+
+      return false unless value.instance_of? Hash
+
+      (
+        APIHelper.valid_type?(value['subtotal'],
+                              ->(val) { val.instance_of? String }) and
+          APIHelper.valid_type?(value['total'],
+                                ->(val) { val.instance_of? String }) and
+          UnionTypeLookUp.get(:PerPriceCostPrice)
+                         .validate(value['price']) and
+          APIHelper.valid_type?(value['price_id'],
+                                ->(val) { val.instance_of? String })
+      )
+    end
+
+    # Provides a human-readable string representation of the object.
+    def to_s
+      class_name = self.class.name.split('::').last
+      "<#{class_name} quantity: #{@quantity}, subtotal: #{@subtotal}, total: #{@total}, price:"\
+      " #{@price}, price_id: #{@price_id}, additional_properties: #{@additional_properties}>"
+    end
+
+    # Provides a debugging-friendly string with detailed object information.
+    def inspect
+      class_name = self.class.name.split('::').last
+      "<#{class_name} quantity: #{@quantity.inspect}, subtotal: #{@subtotal.inspect}, total:"\
+      " #{@total.inspect}, price: #{@price.inspect}, price_id: #{@price_id.inspect},"\
+      " additional_properties: #{@additional_properties}>"
+    end
+  end
+end

data/lib/api_reference/models/percent_composite_config.rb

@@ -0,0 +1,109 @@
+# api_reference
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+module ApiReference
+  # Configuration for a percent composite price. Charges ``percent`` of the sum
+  # of upstream subtotals matched by this price's composite filters. Optional
+  # ``minimum_amount`` and ``maximum_amount`` clamp the computed amount — leave
+  # both null for a pure pass-through percentage. Canonical bounded use case —
+  # service charge of the form "monthly fee = greater of X% of usage and $A,
+  # capped at $B":     PercentCompositeConfig(         percent=Decimal("0.08"),
+  #        minimum_amount=MonetaryAmount(Decimal("5000")),
+  # maximum_amount=MonetaryAmount(Decimal("50000")),     )     upstream sum $0
+  #        → fee $5,000 (minimum_amount)     upstream sum $50,000     → fee
+  # $5,000 (minimum_amount; 8% = $4K < minimum_amount)     upstream sum $100,000
+  #    → fee $8,000 (within bounds)     upstream sum $1,000,000  → fee $50,000
+  # (maximum_amount)
+  class PercentCompositeConfig < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # Fraction of the component subtotals to charge (0 < percent <= 1).
+    # @return [Float]
+    attr_accessor :percent
+
+    # Minimum amount to charge. If unset, the fee is bounded below by 0.
+    # @return [String]
+    attr_accessor :minimum_amount
+
+    # Maximum amount to charge. If unset, the fee has no upper bound.
+    # @return [String]
+    attr_accessor :maximum_amount
+
+    # If true, the minimum_amount is prorated based on the service period. The
+    # maximum_amount is an absolute cap (never prorated), and the percent
+    # applied to upstream subtotals is never prorated either.
+    # @return [TrueClass | FalseClass]
+    attr_accessor :prorated
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['percent'] = 'percent'
+      @_hash['minimum_amount'] = 'minimum_amount'
+      @_hash['maximum_amount'] = 'maximum_amount'
+      @_hash['prorated'] = 'prorated'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        minimum_amount
+        maximum_amount
+        prorated
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      %w[
+        minimum_amount
+        maximum_amount
+      ]
+    end
+
+    def initialize(percent:, minimum_amount: SKIP, maximum_amount: SKIP,
+                   prorated: SKIP)
+      @percent = percent
+      @minimum_amount = minimum_amount unless minimum_amount == SKIP
+      @maximum_amount = maximum_amount unless maximum_amount == SKIP
+      @prorated = prorated unless prorated == SKIP
+    end
+
+    # Creates an instance of the object from a hash.
+    def self.from_hash(hash)
+      return nil unless hash
+
+      # Extract variables from the hash.
+      percent = hash.key?('percent') ? hash['percent'] : nil
+      minimum_amount =
+        hash.key?('minimum_amount') ? hash['minimum_amount'] : SKIP
+      maximum_amount =
+        hash.key?('maximum_amount') ? hash['maximum_amount'] : SKIP
+      prorated = hash.key?('prorated') ? hash['prorated'] : SKIP
+
+      # Create object from extracted values.
+      PercentCompositeConfig.new(percent: percent,
+                                 minimum_amount: minimum_amount,
+                                 maximum_amount: maximum_amount,
+                                 prorated: prorated)
+    end
+
+    # Provides a human-readable string representation of the object.
+    def to_s
+      class_name = self.class.name.split('::').last
+      "<#{class_name} percent: #{@percent}, minimum_amount: #{@minimum_amount}, maximum_amount:"\
+      " #{@maximum_amount}, prorated: #{@prorated}>"
+    end
+
+    # Provides a debugging-friendly string with detailed object information.
+    def inspect
+      class_name = self.class.name.split('::').last
+      "<#{class_name} percent: #{@percent.inspect}, minimum_amount: #{@minimum_amount.inspect},"\
+      " maximum_amount: #{@maximum_amount.inspect}, prorated: #{@prorated.inspect}>"
+    end
+  end
+end

data/lib/api_reference/models/percent_composite_config1.rb

@@ -0,0 +1,112 @@
+# api_reference
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+module ApiReference
+  # Configuration for percent pricing
+  class PercentCompositeConfig1 < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # Fraction of the component subtotals to charge (0 < percent <= 1).
+    # @return [Float]
+    attr_accessor :percent
+
+    # Minimum amount to charge. If unset, the fee is bounded below by 0.
+    # @return [String]
+    attr_accessor :minimum_amount
+
+    # Maximum amount to charge. If unset, the fee has no upper bound.
+    # @return [String]
+    attr_accessor :maximum_amount
+
+    # If true, the minimum_amount is prorated based on the service period. The
+    # maximum_amount is an absolute cap (never prorated), and the percent
+    # applied to upstream subtotals is never prorated either.
+    # @return [TrueClass | FalseClass]
+    attr_accessor :prorated
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['percent'] = 'percent'
+      @_hash['minimum_amount'] = 'minimum_amount'
+      @_hash['maximum_amount'] = 'maximum_amount'
+      @_hash['prorated'] = 'prorated'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        minimum_amount
+        maximum_amount
+        prorated
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      %w[
+        minimum_amount
+        maximum_amount
+      ]
+    end
+
+    def initialize(percent:, minimum_amount: SKIP, maximum_amount: SKIP,
+                   prorated: SKIP)
+      @percent = percent
+      @minimum_amount = minimum_amount unless minimum_amount == SKIP
+      @maximum_amount = maximum_amount unless maximum_amount == SKIP
+      @prorated = prorated unless prorated == SKIP
+    end
+
+    # Creates an instance of the object from a hash.
+    def self.from_hash(hash)
+      return nil unless hash
+
+      # Extract variables from the hash.
+      percent = hash.key?('percent') ? hash['percent'] : nil
+      minimum_amount =
+        hash.key?('minimum_amount') ? hash['minimum_amount'] : SKIP
+      maximum_amount =
+        hash.key?('maximum_amount') ? hash['maximum_amount'] : SKIP
+      prorated = hash.key?('prorated') ? hash['prorated'] : SKIP
+
+      # Create object from extracted values.
+      PercentCompositeConfig1.new(percent: percent,
+                                  minimum_amount: minimum_amount,
+                                  maximum_amount: maximum_amount,
+                                  prorated: prorated)
+    end
+
+    # Validates an instance of the object from a given value.
+    # @param [PercentCompositeConfig1 | Hash] The value against the validation is performed.
+    def self.validate(value)
+      if value.instance_of? self
+        return APIHelper.valid_type?(value.percent,
+                                     ->(val) { val.instance_of? Float })
+      end
+
+      return false unless value.instance_of? Hash
+
+      APIHelper.valid_type?(value['percent'],
+                            ->(val) { val.instance_of? Float })
+    end
+
+    # Provides a human-readable string representation of the object.
+    def to_s
+      class_name = self.class.name.split('::').last
+      "<#{class_name} percent: #{@percent}, minimum_amount: #{@minimum_amount}, maximum_amount:"\
+      " #{@maximum_amount}, prorated: #{@prorated}>"
+    end
+
+    # Provides a debugging-friendly string with detailed object information.
+    def inspect
+      class_name = self.class.name.split('::').last
+      "<#{class_name} percent: #{@percent.inspect}, minimum_amount: #{@minimum_amount.inspect},"\
+      " maximum_amount: #{@maximum_amount.inspect}, prorated: #{@prorated.inspect}>"
+    end
+  end
+end