orb-apiamtic-sdk 0.0.1

data/lib/api_reference/models/invoice_line_item.rb

@@ -0,0 +1,359 @@
+# api_reference
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+require 'date'
+module ApiReference
+  # InvoiceLineItem Model.
+  class InvoiceLineItem < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # The final amount for a line item after all adjustments and pre paid
+    # credits have been applied.
+    # @return [String]
+    attr_accessor :amount
+
+    # The end date of the range of time applied for this line item's price.
+    # @return [DateTime]
+    attr_accessor :end_date
+
+    # [DEPRECATED] For configured prices that are split by a grouping key, this
+    # will be populated with the key and a value. The `amount` and `subtotal`
+    # will be the values for this particular grouping.
+    # @return [String]
+    attr_accessor :grouping
+
+    # All adjustments applied to the line item in the order they were applied
+    # based on invoice calculations (ie. usage discounts -> amount discounts ->
+    # percentage discounts -> minimums -> maximums).
+    # @return [Array[Object]]
+    attr_accessor :adjustments
+
+    # The name of the price associated with this line item.
+    # @return [String]
+    attr_accessor :name
+
+    # Either the fixed fee quantity or the usage during the service period.
+    # @return [Float]
+    attr_accessor :quantity
+
+    # The start date of the range of time applied for this line item's price.
+    # @return [DateTime]
+    attr_accessor :start_date
+
+    # The line amount before any adjustments.
+    # @return [String]
+    attr_accessor :subtotal
+
+    # The line amount after any adjustments and before overage conversion,
+    # credits and partial invoicing.
+    # @return [String]
+    attr_accessor :adjusted_subtotal
+
+    # The number of prepaid credits applied.
+    # @return [String]
+    attr_accessor :credits_applied
+
+    # Any amount applied from a partial invoice
+    # @return [String]
+    attr_accessor :partially_invoiced_amount
+
+    # For complex pricing structures, the line item can be broken down further
+    # in `sub_line_items`.
+    # @return [Array[Object]]
+    attr_accessor :sub_line_items
+
+    # An array of tax rates and their incurred tax amounts. Empty if no tax
+    # integration is configured.
+    # @return [Array[TaxAmount]]
+    attr_accessor :tax_amounts
+
+    # A unique ID for this line item.
+    # @return [String]
+    attr_accessor :id
+
+    # The Price resource represents a price that can be billed on a
+    # subscription, resulting in a charge on an invoice in
+    # the form of an invoice line item. Prices take a quantity and determine an
+    # amount to bill.
+    # Orb supports a few different pricing models out of the box. Each of these
+    # models is serialized differently in a
+    # given Price object. The model_type field determines the key for the
+    # configuration object that is present.
+    # For more on the types of prices, see [the core concepts
+    # documentation](/core-concepts#plan-and-price)
+    # @return [Object]
+    attr_accessor :price
+
+    # A list of customer ids that were used to calculate the usage for this line
+    # item.
+    # @return [Array[String]]
+    attr_accessor :usage_customer_ids
+
+    # An additional filter that was used to calculate the usage for this line
+    # item.
+    # @return [String]
+    attr_accessor :filter
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['amount'] = 'amount'
+      @_hash['end_date'] = 'end_date'
+      @_hash['grouping'] = 'grouping'
+      @_hash['adjustments'] = 'adjustments'
+      @_hash['name'] = 'name'
+      @_hash['quantity'] = 'quantity'
+      @_hash['start_date'] = 'start_date'
+      @_hash['subtotal'] = 'subtotal'
+      @_hash['adjusted_subtotal'] = 'adjusted_subtotal'
+      @_hash['credits_applied'] = 'credits_applied'
+      @_hash['partially_invoiced_amount'] = 'partially_invoiced_amount'
+      @_hash['sub_line_items'] = 'sub_line_items'
+      @_hash['tax_amounts'] = 'tax_amounts'
+      @_hash['id'] = 'id'
+      @_hash['price'] = 'price'
+      @_hash['usage_customer_ids'] = 'usage_customer_ids'
+      @_hash['filter'] = 'filter'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      []
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      %w[
+        grouping
+        usage_customer_ids
+        filter
+      ]
+    end
+
+    def initialize(amount:, end_date:, grouping:, adjustments:, name:,
+                   quantity:, start_date:, subtotal:, adjusted_subtotal:,
+                   credits_applied:, partially_invoiced_amount:,
+                   sub_line_items:, tax_amounts:, id:, price:,
+                   usage_customer_ids:, filter:, additional_properties: nil)
+      # Add additional model properties to the instance
+      additional_properties = {} if additional_properties.nil?
+
+      @amount = amount
+      @end_date = end_date
+      @grouping = grouping
+      @adjustments = adjustments
+      @name = name
+      @quantity = quantity
+      @start_date = start_date
+      @subtotal = subtotal
+      @adjusted_subtotal = adjusted_subtotal
+      @credits_applied = credits_applied
+      @partially_invoiced_amount = partially_invoiced_amount
+      @sub_line_items = sub_line_items
+      @tax_amounts = tax_amounts
+      @id = id
+      @price = price
+      @usage_customer_ids = usage_customer_ids
+      @filter = filter
+      @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.
+      amount = hash.key?('amount') ? hash['amount'] : nil
+      end_date = if hash.key?('end_date')
+                   (DateTimeHelper.from_rfc3339(hash['end_date']) if hash['end_date'])
+                 end
+      grouping = hash.key?('grouping') ? hash['grouping'] : nil
+      adjustments = hash.key?('adjustments') ? APIHelper.deserialize_union_type(
+        UnionTypeLookUp.get(:MonetaryAdjustment), hash['adjustments']
+      ) : nil
+      name = hash.key?('name') ? hash['name'] : nil
+      quantity = hash.key?('quantity') ? hash['quantity'] : nil
+      start_date = if hash.key?('start_date')
+                     (DateTimeHelper.from_rfc3339(hash['start_date']) if hash['start_date'])
+                   end
+      subtotal = hash.key?('subtotal') ? hash['subtotal'] : nil
+      adjusted_subtotal =
+        hash.key?('adjusted_subtotal') ? hash['adjusted_subtotal'] : nil
+      credits_applied =
+        hash.key?('credits_applied') ? hash['credits_applied'] : nil
+      partially_invoiced_amount =
+        hash.key?('partially_invoiced_amount') ? hash['partially_invoiced_amount'] : nil
+      sub_line_items = hash.key?('sub_line_items') ? APIHelper.deserialize_union_type(
+        UnionTypeLookUp.get(:InvoiceSubLineItem), hash['sub_line_items']
+      ) : nil
+      # Parameter is an array, so we need to iterate through it
+      tax_amounts = nil
+      unless hash['tax_amounts'].nil?
+        tax_amounts = []
+        hash['tax_amounts'].each do |structure|
+          tax_amounts << (TaxAmount.from_hash(structure) if structure)
+        end
+      end
+
+      tax_amounts = nil unless hash.key?('tax_amounts')
+      id = hash.key?('id') ? hash['id'] : nil
+      price = hash.key?('price') ? APIHelper.deserialize_union_type(
+        UnionTypeLookUp.get(:Price), hash['price']
+      ) : nil
+      usage_customer_ids =
+        hash.key?('usage_customer_ids') ? hash['usage_customer_ids'] : nil
+      filter = hash.key?('filter') ? hash['filter'] : nil
+
+      # 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.
+      InvoiceLineItem.new(amount: amount,
+                          end_date: end_date,
+                          grouping: grouping,
+                          adjustments: adjustments,
+                          name: name,
+                          quantity: quantity,
+                          start_date: start_date,
+                          subtotal: subtotal,
+                          adjusted_subtotal: adjusted_subtotal,
+                          credits_applied: credits_applied,
+                          partially_invoiced_amount: partially_invoiced_amount,
+                          sub_line_items: sub_line_items,
+                          tax_amounts: tax_amounts,
+                          id: id,
+                          price: price,
+                          usage_customer_ids: usage_customer_ids,
+                          filter: filter,
+                          additional_properties: additional_properties)
+    end
+
+    def to_custom_end_date
+      DateTimeHelper.to_rfc3339(end_date)
+    end
+
+    def to_custom_start_date
+      DateTimeHelper.to_rfc3339(start_date)
+    end
+
+    # Validates an instance of the object from a given value.
+    # @param [InvoiceLineItem | Hash] The value against the validation is performed.
+    def self.validate(value)
+      if value.instance_of? self
+        return (
+          APIHelper.valid_type?(value.amount,
+                                ->(val) { val.instance_of? String }) and
+            APIHelper.valid_type?(value.end_date,
+                                  ->(val) { val.instance_of? DateTime }) and
+            APIHelper.valid_type?(value.grouping,
+                                  ->(val) { val.instance_of? String }) and
+            UnionTypeLookUp.get(:MonetaryAdjustment)
+                           .validate(value.adjustments) and
+            APIHelper.valid_type?(value.name,
+                                  ->(val) { val.instance_of? String }) and
+            APIHelper.valid_type?(value.quantity,
+                                  ->(val) { val.instance_of? Float }) and
+            APIHelper.valid_type?(value.start_date,
+                                  ->(val) { val.instance_of? DateTime }) and
+            APIHelper.valid_type?(value.subtotal,
+                                  ->(val) { val.instance_of? String }) and
+            APIHelper.valid_type?(value.adjusted_subtotal,
+                                  ->(val) { val.instance_of? String }) and
+            APIHelper.valid_type?(value.credits_applied,
+                                  ->(val) { val.instance_of? String }) and
+            APIHelper.valid_type?(value.partially_invoiced_amount,
+                                  ->(val) { val.instance_of? String }) and
+            UnionTypeLookUp.get(:InvoiceSubLineItem)
+                           .validate(value.sub_line_items) and
+            APIHelper.valid_type?(value.tax_amounts,
+                                  ->(val) { TaxAmount.validate(val) },
+                                  is_model_hash: true,
+                                  is_inner_model_hash: true) and
+            APIHelper.valid_type?(value.id,
+                                  ->(val) { val.instance_of? String }) and
+            UnionTypeLookUp.get(:Price)
+                           .validate(value.price) and
+            APIHelper.valid_type?(value.usage_customer_ids,
+                                  ->(val) { val.instance_of? String }) and
+            APIHelper.valid_type?(value.filter,
+                                  ->(val) { val.instance_of? String })
+        )
+      end
+
+      return false unless value.instance_of? Hash
+
+      (
+        APIHelper.valid_type?(value['amount'],
+                              ->(val) { val.instance_of? String }) and
+          APIHelper.valid_type?(value['end_date'],
+                                ->(val) { val.instance_of? String }) and
+          APIHelper.valid_type?(value['grouping'],
+                                ->(val) { val.instance_of? String }) and
+          UnionTypeLookUp.get(:MonetaryAdjustment)
+                         .validate(value['adjustments']) and
+          APIHelper.valid_type?(value['name'],
+                                ->(val) { val.instance_of? String }) and
+          APIHelper.valid_type?(value['quantity'],
+                                ->(val) { val.instance_of? Float }) and
+          APIHelper.valid_type?(value['start_date'],
+                                ->(val) { val.instance_of? String }) and
+          APIHelper.valid_type?(value['subtotal'],
+                                ->(val) { val.instance_of? String }) and
+          APIHelper.valid_type?(value['adjusted_subtotal'],
+                                ->(val) { val.instance_of? String }) and
+          APIHelper.valid_type?(value['credits_applied'],
+                                ->(val) { val.instance_of? String }) and
+          APIHelper.valid_type?(value['partially_invoiced_amount'],
+                                ->(val) { val.instance_of? String }) and
+          UnionTypeLookUp.get(:InvoiceSubLineItem)
+                         .validate(value['sub_line_items']) and
+          APIHelper.valid_type?(value['tax_amounts'],
+                                ->(val) { TaxAmount.validate(val) },
+                                is_model_hash: true,
+                                is_inner_model_hash: true) and
+          APIHelper.valid_type?(value['id'],
+                                ->(val) { val.instance_of? String }) and
+          UnionTypeLookUp.get(:Price)
+                         .validate(value['price']) and
+          APIHelper.valid_type?(value['usage_customer_ids'],
+                                ->(val) { val.instance_of? String }) and
+          APIHelper.valid_type?(value['filter'],
+                                ->(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} amount: #{@amount}, end_date: #{@end_date}, grouping: #{@grouping},"\
+      " adjustments: #{@adjustments}, name: #{@name}, quantity: #{@quantity}, start_date:"\
+      " #{@start_date}, subtotal: #{@subtotal}, adjusted_subtotal: #{@adjusted_subtotal},"\
+      " credits_applied: #{@credits_applied}, partially_invoiced_amount:"\
+      " #{@partially_invoiced_amount}, sub_line_items: #{@sub_line_items}, tax_amounts:"\
+      " #{@tax_amounts}, id: #{@id}, price: #{@price}, usage_customer_ids: #{@usage_customer_ids},"\
+      " filter: #{@filter}, 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} amount: #{@amount.inspect}, end_date: #{@end_date.inspect}, grouping:"\
+      " #{@grouping.inspect}, adjustments: #{@adjustments.inspect}, name: #{@name.inspect},"\
+      " quantity: #{@quantity.inspect}, start_date: #{@start_date.inspect}, subtotal:"\
+      " #{@subtotal.inspect}, adjusted_subtotal: #{@adjusted_subtotal.inspect}, credits_applied:"\
+      " #{@credits_applied.inspect}, partially_invoiced_amount:"\
+      " #{@partially_invoiced_amount.inspect}, sub_line_items: #{@sub_line_items.inspect},"\
+      " tax_amounts: #{@tax_amounts.inspect}, id: #{@id.inspect}, price: #{@price.inspect},"\
+      " usage_customer_ids: #{@usage_customer_ids.inspect}, filter: #{@filter.inspect},"\
+      " additional_properties: #{@additional_properties}>"
+    end
+  end
+end

data/lib/api_reference/models/invoice_line_item_params.rb

@@ -0,0 +1,157 @@
+# api_reference
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+module ApiReference
+  # InvoiceLineItemParams Model.
+  class InvoiceLineItemParams < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # A date string to specify the line item's start date in the customer's
+    # timezone.
+    # @return [Date]
+    attr_accessor :start_date
+
+    # A date string to specify the line item's end date in the customer's
+    # timezone.
+    # @return [Date]
+    attr_accessor :end_date
+
+    # The number of units on the line item
+    # @return [Float]
+    attr_accessor :quantity
+
+    # The name of the line item.
+    # @return [String]
+    attr_accessor :name
+
+    # The name of the line item.
+    # @return [String]
+    attr_accessor :item_id
+
+    # The name of the line item.
+    # @return [String]
+    attr_reader :model_type
+
+    # Configuration for unit pricing
+    # @return [UnitConfig]
+    attr_accessor :unit_config
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['start_date'] = 'start_date'
+      @_hash['end_date'] = 'end_date'
+      @_hash['quantity'] = 'quantity'
+      @_hash['name'] = 'name'
+      @_hash['item_id'] = 'item_id'
+      @_hash['model_type'] = 'model_type'
+      @_hash['unit_config'] = 'unit_config'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      []
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(start_date:, end_date:, quantity:, name:, item_id:,
+                   unit_config:)
+      @start_date = start_date
+      @end_date = end_date
+      @quantity = quantity
+      @name = name
+      @item_id = item_id
+      @model_type = 'unit'
+      @unit_config = unit_config
+    end
+
+    # Creates an instance of the object from a hash.
+    def self.from_hash(hash)
+      return nil unless hash
+
+      # Extract variables from the hash.
+      start_date = hash.key?('start_date') ? hash['start_date'] : nil
+      end_date = hash.key?('end_date') ? hash['end_date'] : nil
+      quantity = hash.key?('quantity') ? hash['quantity'] : nil
+      name = hash.key?('name') ? hash['name'] : nil
+      item_id = hash.key?('item_id') ? hash['item_id'] : nil
+      unit_config = UnitConfig.from_hash(hash['unit_config']) if hash['unit_config']
+
+      # Create object from extracted values.
+      InvoiceLineItemParams.new(start_date: start_date,
+                                end_date: end_date,
+                                quantity: quantity,
+                                name: name,
+                                item_id: item_id,
+                                unit_config: unit_config)
+    end
+
+    # Validates an instance of the object from a given value.
+    # @param [InvoiceLineItemParams | Hash] The value against the validation is performed.
+    def self.validate(value)
+      if value.instance_of? self
+        return (
+          APIHelper.valid_type?(value.start_date,
+                                ->(val) { val.instance_of? String }) and
+            APIHelper.valid_type?(value.end_date,
+                                  ->(val) { val.instance_of? String }) and
+            APIHelper.valid_type?(value.quantity,
+                                  ->(val) { val.instance_of? Float }) and
+            APIHelper.valid_type?(value.name,
+                                  ->(val) { val.instance_of? String }) and
+            APIHelper.valid_type?(value.item_id,
+                                  ->(val) { val.instance_of? String }) and
+            APIHelper.valid_type?(value.model_type,
+                                  ->(val) { val.instance_of? String }) and
+            APIHelper.valid_type?(value.unit_config,
+                                  ->(val) { UnitConfig.validate(val) },
+                                  is_model_hash: true)
+        )
+      end
+
+      return false unless value.instance_of? Hash
+
+      (
+        APIHelper.valid_type?(value['start_date'],
+                              ->(val) { val.instance_of? String }) and
+          APIHelper.valid_type?(value['end_date'],
+                                ->(val) { val.instance_of? String }) and
+          APIHelper.valid_type?(value['quantity'],
+                                ->(val) { val.instance_of? Float }) and
+          APIHelper.valid_type?(value['name'],
+                                ->(val) { val.instance_of? String }) and
+          APIHelper.valid_type?(value['item_id'],
+                                ->(val) { val.instance_of? String }) and
+          APIHelper.valid_type?(value['model_type'],
+                                ->(val) { val.instance_of? String }) and
+          APIHelper.valid_type?(value['unit_config'],
+                                ->(val) { UnitConfig.validate(val) },
+                                is_model_hash: true)
+      )
+    end
+
+    # Provides a human-readable string representation of the object.
+    def to_s
+      class_name = self.class.name.split('::').last
+      "<#{class_name} start_date: #{@start_date}, end_date: #{@end_date}, quantity: #{@quantity},"\
+      " name: #{@name}, item_id: #{@item_id}, model_type: #{@model_type}, unit_config:"\
+      " #{@unit_config}>"
+    end
+
+    # Provides a debugging-friendly string with detailed object information.
+    def inspect
+      class_name = self.class.name.split('::').last
+      "<#{class_name} start_date: #{@start_date.inspect}, end_date: #{@end_date.inspect},"\
+      " quantity: #{@quantity.inspect}, name: #{@name.inspect}, item_id: #{@item_id.inspect},"\
+      " model_type: #{@model_type.inspect}, unit_config: #{@unit_config.inspect}>"
+    end
+  end
+end

data/lib/api_reference/models/invoice_minified.rb

@@ -0,0 +1,112 @@
+# api_reference
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+module ApiReference
+  # InvoiceMinified Model.
+  class InvoiceMinified < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # TODO: Write general description for this method
+    # @return [String]
+    attr_accessor :id
+
+    # TODO: Write general description for this method
+    # @return [String]
+    attr_accessor :invoice_number
+
+    # TODO: Write general description for this method
+    # @return [Status1]
+    attr_accessor :status
+
+    # TODO: Write general description for this method
+    # @return [CustomerMinified]
+    attr_accessor :customer
+
+    # TODO: Write general description for this method
+    # @return [SubscriptionMinified]
+    attr_accessor :subscription
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['id'] = 'id'
+      @_hash['invoice_number'] = 'invoice_number'
+      @_hash['status'] = 'status'
+      @_hash['customer'] = 'customer'
+      @_hash['subscription'] = 'subscription'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      []
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      %w[
+        subscription
+      ]
+    end
+
+    def initialize(id:, invoice_number:, status:, customer:, subscription:,
+                   additional_properties: nil)
+      # Add additional model properties to the instance
+      additional_properties = {} if additional_properties.nil?
+
+      @id = id
+      @invoice_number = invoice_number
+      @status = status
+      @customer = customer
+      @subscription = subscription
+      @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
+      invoice_number =
+        hash.key?('invoice_number') ? hash['invoice_number'] : nil
+      status = hash.key?('status') ? hash['status'] : nil
+      customer = CustomerMinified.from_hash(hash['customer']) if hash['customer']
+      subscription = SubscriptionMinified.from_hash(hash['subscription']) if hash['subscription']
+
+      # 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.
+      InvoiceMinified.new(id: id,
+                          invoice_number: invoice_number,
+                          status: status,
+                          customer: customer,
+                          subscription: subscription,
+                          additional_properties: additional_properties)
+    end
+
+    # Provides a human-readable string representation of the object.
+    def to_s
+      class_name = self.class.name.split('::').last
+      "<#{class_name} id: #{@id}, invoice_number: #{@invoice_number}, status: #{@status},"\
+      " customer: #{@customer}, subscription: #{@subscription}, 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}, invoice_number: #{@invoice_number.inspect}, status:"\
+      " #{@status.inspect}, customer: #{@customer.inspect}, subscription:"\
+      " #{@subscription.inspect}, additional_properties: #{@additional_properties}>"
+    end
+  end
+end

data/lib/api_reference/models/invoice_source.rb

@@ -0,0 +1,40 @@
+# api_reference
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+module ApiReference
+  # Invoice Source.
+  class InvoiceSource
+    INVOICE_SOURCE = [
+      # TODO: Write general description for SUBSCRIPTION
+      SUBSCRIPTION = 'subscription'.freeze,
+
+      # TODO: Write general description for PARTIAL
+      PARTIAL = 'partial'.freeze,
+
+      # TODO: Write general description for ONE_OFF
+      ONE_OFF = 'one_off'.freeze
+    ].freeze
+
+    def self.validate(value)
+      return false if value.nil?
+
+      true
+    end
+
+    def self.from_value(value, default_value = SUBSCRIPTION)
+      return default_value if value.nil?
+
+      str = value.to_s.strip
+
+      case str.downcase
+      when 'subscription' then SUBSCRIPTION
+      when 'partial' then PARTIAL
+      when 'one_off' then ONE_OFF
+      else
+        default_value
+      end
+    end
+  end
+end