orb-apiamtic-sdk 0.0.1

data/lib/api_reference/models/amount_discount_interval.rb

@@ -0,0 +1,187 @@
+# api_reference
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+require 'date'
+module ApiReference
+  # AmountDiscountInterval Model.
+  class AmountDiscountInterval < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # TODO: Write general description for this method
+    # @return [String]
+    attr_reader :discount_type
+
+    # Only available if discount_type is `amount`.
+    # @return [String]
+    attr_accessor :amount_discount
+
+    # The start date of the discount interval.
+    # @return [DateTime]
+    attr_accessor :start_date
+
+    # The end date of the discount interval.
+    # @return [DateTime]
+    attr_accessor :end_date
+
+    # The filters that determine which prices this discount interval applies to.
+    # @return [Array[PriceFilter]]
+    attr_accessor :filters
+
+    # The price interval ids that this discount interval applies to.
+    # @return [Array[String]]
+    attr_accessor :applies_to_price_interval_ids
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['discount_type'] = 'discount_type'
+      @_hash['amount_discount'] = 'amount_discount'
+      @_hash['start_date'] = 'start_date'
+      @_hash['end_date'] = 'end_date'
+      @_hash['filters'] = 'filters'
+      @_hash['applies_to_price_interval_ids'] =
+        'applies_to_price_interval_ids'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      []
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      %w[
+        end_date
+      ]
+    end
+
+    def initialize(amount_discount:, start_date:, end_date:, filters:,
+                   applies_to_price_interval_ids:, additional_properties: nil)
+      # Add additional model properties to the instance
+      additional_properties = {} if additional_properties.nil?
+
+      @discount_type = 'amount'
+      @amount_discount = amount_discount
+      @start_date = start_date
+      @end_date = end_date
+      @filters = filters
+      @applies_to_price_interval_ids = applies_to_price_interval_ids
+      @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_discount =
+        hash.key?('amount_discount') ? hash['amount_discount'] : nil
+      start_date = if hash.key?('start_date')
+                     (DateTimeHelper.from_rfc3339(hash['start_date']) if hash['start_date'])
+                   end
+      end_date = if hash.key?('end_date')
+                   (DateTimeHelper.from_rfc3339(hash['end_date']) if hash['end_date'])
+                 end
+      # Parameter is an array, so we need to iterate through it
+      filters = nil
+      unless hash['filters'].nil?
+        filters = []
+        hash['filters'].each do |structure|
+          filters << (PriceFilter.from_hash(structure) if structure)
+        end
+      end
+
+      filters = nil unless hash.key?('filters')
+      applies_to_price_interval_ids =
+        hash.key?('applies_to_price_interval_ids') ? hash['applies_to_price_interval_ids'] : 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.
+      AmountDiscountInterval.new(amount_discount: amount_discount,
+                                 start_date: start_date,
+                                 end_date: end_date,
+                                 filters: filters,
+                                 applies_to_price_interval_ids: applies_to_price_interval_ids,
+                                 additional_properties: additional_properties)
+    end
+
+    def to_custom_start_date
+      DateTimeHelper.to_rfc3339(start_date)
+    end
+
+    def to_custom_end_date
+      DateTimeHelper.to_rfc3339(end_date)
+    end
+
+    # Validates an instance of the object from a given value.
+    # @param [AmountDiscountInterval | Hash] The value against the validation is performed.
+    def self.validate(value)
+      if value.instance_of? self
+        return (
+          APIHelper.valid_type?(value.discount_type,
+                                ->(val) { val.instance_of? String }) and
+            APIHelper.valid_type?(value.amount_discount,
+                                  ->(val) { val.instance_of? String }) and
+            APIHelper.valid_type?(value.start_date,
+                                  ->(val) { val.instance_of? DateTime }) and
+            APIHelper.valid_type?(value.end_date,
+                                  ->(val) { val.instance_of? DateTime }) and
+            APIHelper.valid_type?(value.filters,
+                                  ->(val) { PriceFilter.validate(val) },
+                                  is_model_hash: true,
+                                  is_inner_model_hash: true) and
+            APIHelper.valid_type?(value.applies_to_price_interval_ids,
+                                  ->(val) { val.instance_of? String })
+        )
+      end
+
+      return false unless value.instance_of? Hash
+
+      (
+        APIHelper.valid_type?(value['discount_type'],
+                              ->(val) { val.instance_of? String }) and
+          APIHelper.valid_type?(value['amount_discount'],
+                                ->(val) { val.instance_of? String }) and
+          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['filters'],
+                                ->(val) { PriceFilter.validate(val) },
+                                is_model_hash: true,
+                                is_inner_model_hash: true) and
+          APIHelper.valid_type?(value['applies_to_price_interval_ids'],
+                                ->(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} discount_type: #{@discount_type}, amount_discount: #{@amount_discount},"\
+      " start_date: #{@start_date}, end_date: #{@end_date}, filters: #{@filters},"\
+      " applies_to_price_interval_ids: #{@applies_to_price_interval_ids}, 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} discount_type: #{@discount_type.inspect}, amount_discount:"\
+      " #{@amount_discount.inspect}, start_date: #{@start_date.inspect}, end_date:"\
+      " #{@end_date.inspect}, filters: #{@filters.inspect}, applies_to_price_interval_ids:"\
+      " #{@applies_to_price_interval_ids.inspect}, additional_properties:"\
+      " #{@additional_properties}>"
+    end
+  end
+end

data/lib/api_reference/models/api_pagination_params.rb

@@ -0,0 +1,74 @@
+# api_reference
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+module ApiReference
+  # ApiPaginationParams Model.
+  class ApiPaginationParams < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # The number of items to fetch. Defaults to 20.
+    # @return [Integer]
+    attr_accessor :limit
+
+    # Cursor for pagination. This can be populated by the `next_cursor` value
+    # returned from the initial request.
+    # @return [String]
+    attr_accessor :cursor
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['limit'] = 'limit'
+      @_hash['cursor'] = 'cursor'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        limit
+        cursor
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      %w[
+        cursor
+      ]
+    end
+
+    def initialize(limit: 20, cursor: SKIP)
+      @limit = limit unless limit == SKIP
+      @cursor = cursor unless cursor == 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.
+      limit = hash['limit'] ||= 20
+      cursor = hash.key?('cursor') ? hash['cursor'] : SKIP
+
+      # Create object from extracted values.
+      ApiPaginationParams.new(limit: limit,
+                              cursor: cursor)
+    end
+
+    # Provides a human-readable string representation of the object.
+    def to_s
+      class_name = self.class.name.split('::').last
+      "<#{class_name} limit: #{@limit}, cursor: #{@cursor}>"
+    end
+
+    # Provides a debugging-friendly string with detailed object information.
+    def inspect
+      class_name = self.class.name.split('::').last
+      "<#{class_name} limit: #{@limit.inspect}, cursor: #{@cursor.inspect}>"
+    end
+  end
+end

data/lib/api_reference/models/apply_params.rb

@@ -0,0 +1,136 @@
+# api_reference
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+module ApiReference
+  # ApplyParams Model.
+  class ApplyParams < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # Amount already collected to apply to the customer's balance. If
+    # mark_as_paid is also provided, credit the difference to the customer's
+    # balance.
+    # @return [String]
+    attr_accessor :previously_collected_amount
+
+    # Mark all pending invoices that are payable as paid. If amount is also
+    # provided, mark as paid and credit the difference to the customer's
+    # balance.
+    # @return [TrueClass | FalseClass]
+    attr_accessor :mark_as_paid
+
+    # Description to apply to the balance transaction representing this credit.
+    # @return [String]
+    attr_accessor :description
+
+    # A date string to specify the date the payment was received. Only
+    # applicable when mark_as_paid is true. If not provided, defaults to the
+    # current date.
+    # @return [Date]
+    attr_accessor :payment_received_date
+
+    # An optional external ID to associate with the payment. Only applicable
+    # when mark_as_paid is true.
+    # @return [String]
+    attr_accessor :payment_external_id
+
+    # Optional notes about the payment. Only applicable when mark_as_paid is
+    # true.
+    # @return [String]
+    attr_accessor :payment_notes
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['previously_collected_amount'] = 'previously_collected_amount'
+      @_hash['mark_as_paid'] = 'mark_as_paid'
+      @_hash['description'] = 'description'
+      @_hash['payment_received_date'] = 'payment_received_date'
+      @_hash['payment_external_id'] = 'payment_external_id'
+      @_hash['payment_notes'] = 'payment_notes'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        previously_collected_amount
+        mark_as_paid
+        description
+        payment_received_date
+        payment_external_id
+        payment_notes
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      %w[
+        previously_collected_amount
+        mark_as_paid
+        description
+        payment_received_date
+        payment_external_id
+        payment_notes
+      ]
+    end
+
+    def initialize(previously_collected_amount: SKIP, mark_as_paid: SKIP,
+                   description: SKIP, payment_received_date: SKIP,
+                   payment_external_id: SKIP, payment_notes: SKIP)
+      unless previously_collected_amount == SKIP
+        @previously_collected_amount =
+          previously_collected_amount
+      end
+      @mark_as_paid = mark_as_paid unless mark_as_paid == SKIP
+      @description = description unless description == SKIP
+      @payment_received_date = payment_received_date unless payment_received_date == SKIP
+      @payment_external_id = payment_external_id unless payment_external_id == SKIP
+      @payment_notes = payment_notes unless payment_notes == 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.
+      previously_collected_amount =
+        hash.key?('previously_collected_amount') ? hash['previously_collected_amount'] : SKIP
+      mark_as_paid = hash.key?('mark_as_paid') ? hash['mark_as_paid'] : SKIP
+      description = hash.key?('description') ? hash['description'] : SKIP
+      payment_received_date =
+        hash.key?('payment_received_date') ? hash['payment_received_date'] : SKIP
+      payment_external_id =
+        hash.key?('payment_external_id') ? hash['payment_external_id'] : SKIP
+      payment_notes = hash.key?('payment_notes') ? hash['payment_notes'] : SKIP
+
+      # Create object from extracted values.
+      ApplyParams.new(previously_collected_amount: previously_collected_amount,
+                      mark_as_paid: mark_as_paid,
+                      description: description,
+                      payment_received_date: payment_received_date,
+                      payment_external_id: payment_external_id,
+                      payment_notes: payment_notes)
+    end
+
+    # Provides a human-readable string representation of the object.
+    def to_s
+      class_name = self.class.name.split('::').last
+      "<#{class_name} previously_collected_amount: #{@previously_collected_amount}, mark_as_paid:"\
+      " #{@mark_as_paid}, description: #{@description}, payment_received_date:"\
+      " #{@payment_received_date}, payment_external_id: #{@payment_external_id}, payment_notes:"\
+      " #{@payment_notes}>"
+    end
+
+    # Provides a debugging-friendly string with detailed object information.
+    def inspect
+      class_name = self.class.name.split('::').last
+      "<#{class_name} previously_collected_amount: #{@previously_collected_amount.inspect},"\
+      " mark_as_paid: #{@mark_as_paid.inspect}, description: #{@description.inspect},"\
+      " payment_received_date: #{@payment_received_date.inspect}, payment_external_id:"\
+      " #{@payment_external_id.inspect}, payment_notes: #{@payment_notes.inspect}>"
+    end
+  end
+end

data/lib/api_reference/models/auto_collection.rb

@@ -0,0 +1,157 @@
+# api_reference
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+require 'date'
+module ApiReference
+  # AutoCollection Model.
+  class AutoCollection < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # If the invoice is scheduled for auto-collection, this field will reflect
+    # when the next attempt will occur. If dunning has been exhausted, or
+    # auto-collection is not enabled for this invoice, this field will be
+    # `null`.
+    # @return [DateTime]
+    attr_accessor :next_attempt_at
+
+    # If Orb has ever attempted payment auto-collection for this invoice, this
+    # field will reflect when that attempt occurred. In conjunction with
+    # `next_attempt_at`, this can be used to tell whether the invoice is
+    # currently in dunning (that is, `previously_attempted_at` is non-null, and
+    # `next_attempt_time` is non-null), or if dunning has been exhausted
+    # (`previously_attempted_at` is non-null, but `next_attempt_time` is null).
+    # @return [DateTime]
+    attr_accessor :previously_attempted_at
+
+    # True only if auto-collection is enabled for this invoice.
+    # @return [TrueClass | FalseClass]
+    attr_accessor :enabled
+
+    # Number of auto-collection payment attempts.
+    # @return [Integer]
+    attr_accessor :num_attempts
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['next_attempt_at'] = 'next_attempt_at'
+      @_hash['previously_attempted_at'] = 'previously_attempted_at'
+      @_hash['enabled'] = 'enabled'
+      @_hash['num_attempts'] = 'num_attempts'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      []
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      %w[
+        next_attempt_at
+        previously_attempted_at
+        enabled
+        num_attempts
+      ]
+    end
+
+    def initialize(next_attempt_at:, previously_attempted_at:, enabled:,
+                   num_attempts:, additional_properties: nil)
+      # Add additional model properties to the instance
+      additional_properties = {} if additional_properties.nil?
+
+      @next_attempt_at = next_attempt_at
+      @previously_attempted_at = previously_attempted_at
+      @enabled = enabled
+      @num_attempts = num_attempts
+      @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.
+      next_attempt_at = if hash.key?('next_attempt_at')
+                          (DateTimeHelper.from_rfc3339(hash['next_attempt_at']) if hash['next_attempt_at'])
+                        end
+      previously_attempted_at = if hash.key?('previously_attempted_at')
+                                  (DateTimeHelper.from_rfc3339(hash['previously_attempted_at']) if hash['previously_attempted_at'])
+                                end
+      enabled = hash.key?('enabled') ? hash['enabled'] : nil
+      num_attempts = hash.key?('num_attempts') ? hash['num_attempts'] : 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.
+      AutoCollection.new(next_attempt_at: next_attempt_at,
+                         previously_attempted_at: previously_attempted_at,
+                         enabled: enabled,
+                         num_attempts: num_attempts,
+                         additional_properties: additional_properties)
+    end
+
+    def to_custom_next_attempt_at
+      DateTimeHelper.to_rfc3339(next_attempt_at)
+    end
+
+    def to_custom_previously_attempted_at
+      DateTimeHelper.to_rfc3339(previously_attempted_at)
+    end
+
+    # Validates an instance of the object from a given value.
+    # @param [AutoCollection | Hash] The value against the validation is performed.
+    def self.validate(value)
+      if value.instance_of? self
+        return (
+          APIHelper.valid_type?(value.next_attempt_at,
+                                ->(val) { val.instance_of? DateTime }) and
+            APIHelper.valid_type?(value.previously_attempted_at,
+                                  ->(val) { val.instance_of? DateTime }) and
+            APIHelper.valid_type?(value.enabled,
+                                  ->(val) { val.instance_of? TrueClass or val.instance_of? FalseClass }) and
+            APIHelper.valid_type?(value.num_attempts,
+                                  ->(val) { val.instance_of? Integer })
+        )
+      end
+
+      return false unless value.instance_of? Hash
+
+      (
+        APIHelper.valid_type?(value['next_attempt_at'],
+                              ->(val) { val.instance_of? String }) and
+          APIHelper.valid_type?(value['previously_attempted_at'],
+                                ->(val) { val.instance_of? String }) and
+          APIHelper.valid_type?(value['enabled'],
+                                ->(val) { val.instance_of? TrueClass or val.instance_of? FalseClass }) and
+          APIHelper.valid_type?(value['num_attempts'],
+                                ->(val) { val.instance_of? Integer })
+      )
+    end
+
+    # Provides a human-readable string representation of the object.
+    def to_s
+      class_name = self.class.name.split('::').last
+      "<#{class_name} next_attempt_at: #{@next_attempt_at}, previously_attempted_at:"\
+      " #{@previously_attempted_at}, enabled: #{@enabled}, num_attempts: #{@num_attempts},"\
+      " 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} next_attempt_at: #{@next_attempt_at.inspect}, previously_attempted_at:"\
+      " #{@previously_attempted_at.inspect}, enabled: #{@enabled.inspect}, num_attempts:"\
+      " #{@num_attempts.inspect}, additional_properties: #{@additional_properties}>"
+    end
+  end
+end