orb-apiamtic-sdk 0.0.1

data/lib/api_reference/models/credit_note_line_item_params.rb

@@ -0,0 +1,116 @@
+# api_reference
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+module ApiReference
+  # CreditNoteLineItemParams Model.
+  class CreditNoteLineItemParams < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # The ID of the line item to credit.
+    # @return [String]
+    attr_accessor :invoice_line_item_id
+
+    # The total amount in the invoice's currency to credit this line item.
+    # @return [String]
+    attr_accessor :amount
+
+    # A date string to specify this line item's credit note service period start
+    # date in the customer's timezone. If provided, this will be used for this
+    # specific line item. If not provided, will use the global start_date if
+    # available, otherwise defaults to the original invoice line item's start
+    # date. This date is inclusive.
+    # @return [Date]
+    attr_accessor :start_date
+
+    # A date string to specify this line item's credit note service period end
+    # date in the customer's timezone. If provided, this will be used for this
+    # specific line item. If not provided, will use the global end_date if
+    # available, otherwise defaults to the original invoice line item's end
+    # date. This date is inclusive.
+    # @return [Date]
+    attr_accessor :end_date
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['invoice_line_item_id'] = 'invoice_line_item_id'
+      @_hash['amount'] = 'amount'
+      @_hash['start_date'] = 'start_date'
+      @_hash['end_date'] = 'end_date'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        start_date
+        end_date
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      %w[
+        start_date
+        end_date
+      ]
+    end
+
+    def initialize(invoice_line_item_id:, amount:, start_date: SKIP,
+                   end_date: SKIP, additional_properties: nil)
+      # Add additional model properties to the instance
+      additional_properties = {} if additional_properties.nil?
+
+      @invoice_line_item_id = invoice_line_item_id
+      @amount = amount
+      @start_date = start_date unless start_date == SKIP
+      @end_date = end_date unless end_date == SKIP
+      @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.
+      invoice_line_item_id =
+        hash.key?('invoice_line_item_id') ? hash['invoice_line_item_id'] : nil
+      amount = hash.key?('amount') ? hash['amount'] : nil
+      start_date = hash.key?('start_date') ? hash['start_date'] : SKIP
+      end_date = hash.key?('end_date') ? hash['end_date'] : 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.
+      CreditNoteLineItemParams.new(invoice_line_item_id: invoice_line_item_id,
+                                   amount: amount,
+                                   start_date: start_date,
+                                   end_date: end_date,
+                                   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} invoice_line_item_id: #{@invoice_line_item_id}, amount: #{@amount},"\
+      " start_date: #{@start_date}, end_date: #{@end_date}, 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} invoice_line_item_id: #{@invoice_line_item_id.inspect}, amount:"\
+      " #{@amount.inspect}, start_date: #{@start_date.inspect}, end_date: #{@end_date.inspect},"\
+      " additional_properties: #{@additional_properties}>"
+    end
+  end
+end

data/lib/api_reference/models/credit_note_summary.rb

@@ -0,0 +1,181 @@
+# api_reference
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+require 'date'
+module ApiReference
+  # CreditNoteSummary Model.
+  class CreditNoteSummary < 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 :credit_note_number
+
+    # TODO: Write general description for this method
+    # @return [String]
+    attr_accessor :reason
+
+    # TODO: Write general description for this method
+    # @return [String]
+    attr_accessor :total
+
+    # If the credit note has a status of `void`, this gives a timestamp when the
+    # credit note was voided.
+    # @return [DateTime]
+    attr_accessor :voided_at
+
+    # If the credit note has a status of `void`, this gives a timestamp when the
+    # credit note was voided.
+    # @return [String]
+    attr_accessor :type
+
+    # An optional memo supplied on the credit note.
+    # @return [String]
+    attr_accessor :memo
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['id'] = 'id'
+      @_hash['credit_note_number'] = 'credit_note_number'
+      @_hash['reason'] = 'reason'
+      @_hash['total'] = 'total'
+      @_hash['voided_at'] = 'voided_at'
+      @_hash['type'] = 'type'
+      @_hash['memo'] = 'memo'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      []
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      %w[
+        voided_at
+        memo
+      ]
+    end
+
+    def initialize(id:, credit_note_number:, reason:, total:, voided_at:, type:,
+                   memo:, additional_properties: nil)
+      # Add additional model properties to the instance
+      additional_properties = {} if additional_properties.nil?
+
+      @id = id
+      @credit_note_number = credit_note_number
+      @reason = reason
+      @total = total
+      @voided_at = voided_at
+      @type = type
+      @memo = memo
+      @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
+      credit_note_number =
+        hash.key?('credit_note_number') ? hash['credit_note_number'] : nil
+      reason = hash.key?('reason') ? hash['reason'] : nil
+      total = hash.key?('total') ? hash['total'] : nil
+      voided_at = if hash.key?('voided_at')
+                    (DateTimeHelper.from_rfc3339(hash['voided_at']) if hash['voided_at'])
+                  end
+      type = hash.key?('type') ? hash['type'] : nil
+      memo = hash.key?('memo') ? hash['memo'] : 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.
+      CreditNoteSummary.new(id: id,
+                            credit_note_number: credit_note_number,
+                            reason: reason,
+                            total: total,
+                            voided_at: voided_at,
+                            type: type,
+                            memo: memo,
+                            additional_properties: additional_properties)
+    end
+
+    def to_custom_voided_at
+      DateTimeHelper.to_rfc3339(voided_at)
+    end
+
+    # Validates an instance of the object from a given value.
+    # @param [CreditNoteSummary | 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.credit_note_number,
+                                  ->(val) { val.instance_of? String }) and
+            APIHelper.valid_type?(value.reason,
+                                  ->(val) { val.instance_of? String }) and
+            APIHelper.valid_type?(value.total,
+                                  ->(val) { val.instance_of? String }) and
+            APIHelper.valid_type?(value.voided_at,
+                                  ->(val) { val.instance_of? DateTime }) and
+            APIHelper.valid_type?(value.type,
+                                  ->(val) { val.instance_of? String }) and
+            APIHelper.valid_type?(value.memo,
+                                  ->(val) { val.instance_of? String })
+        )
+      end
+
+      return false unless value.instance_of? Hash
+
+      (
+        APIHelper.valid_type?(value['id'],
+                              ->(val) { val.instance_of? String }) and
+          APIHelper.valid_type?(value['credit_note_number'],
+                                ->(val) { val.instance_of? String }) and
+          APIHelper.valid_type?(value['reason'],
+                                ->(val) { val.instance_of? String }) and
+          APIHelper.valid_type?(value['total'],
+                                ->(val) { val.instance_of? String }) and
+          APIHelper.valid_type?(value['voided_at'],
+                                ->(val) { val.instance_of? String }) and
+          APIHelper.valid_type?(value['type'],
+                                ->(val) { val.instance_of? String }) and
+          APIHelper.valid_type?(value['memo'],
+                                ->(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}, credit_note_number: #{@credit_note_number}, reason: #{@reason},"\
+      " total: #{@total}, voided_at: #{@voided_at}, type: #{@type}, memo: #{@memo},"\
+      " 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}, credit_note_number: #{@credit_note_number.inspect},"\
+      " reason: #{@reason.inspect}, total: #{@total.inspect}, voided_at: #{@voided_at.inspect},"\
+      " type: #{@type.inspect}, memo: #{@memo.inspect}, additional_properties:"\
+      " #{@additional_properties}>"
+    end
+  end
+end

data/lib/api_reference/models/credit_note_tiny.rb

@@ -0,0 +1,86 @@
+# api_reference
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+module ApiReference
+  # CreditNoteTiny Model.
+  class CreditNoteTiny < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # The id of the Credit note
+    # @return [String]
+    attr_accessor :id
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['id'] = 'id'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      []
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(id:, additional_properties: nil)
+      # Add additional model properties to the instance
+      additional_properties = {} if additional_properties.nil?
+
+      @id = 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.
+      id = hash.key?('id') ? hash['id'] : 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.
+      CreditNoteTiny.new(id: id,
+                         additional_properties: additional_properties)
+    end
+
+    # Validates an instance of the object from a given value.
+    # @param [CreditNoteTiny | 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 })
+      end
+
+      return false unless value.instance_of? Hash
+
+      APIHelper.valid_type?(value['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} id: #{@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} id: #{@id.inspect}, additional_properties: #{@additional_properties}>"
+    end
+  end
+end

data/lib/api_reference/models/credit_notes.rb

@@ -0,0 +1,92 @@
+# api_reference
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+module ApiReference
+  # CreditNotes Model.
+  class CreditNotes < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # TODO: Write general description for this method
+    # @return [Array[CreditNote]]
+    attr_accessor :data
+
+    # TODO: Write general description for this method
+    # @return [PaginationMetadata]
+    attr_accessor :pagination_metadata
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['data'] = 'data'
+      @_hash['pagination_metadata'] = 'pagination_metadata'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      []
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(data:, pagination_metadata:, additional_properties: nil)
+      # Add additional model properties to the instance
+      additional_properties = {} if additional_properties.nil?
+
+      @data = data
+      @pagination_metadata = pagination_metadata
+      @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.
+      # Parameter is an array, so we need to iterate through it
+      data = nil
+      unless hash['data'].nil?
+        data = []
+        hash['data'].each do |structure|
+          data << (CreditNote.from_hash(structure) if structure)
+        end
+      end
+
+      data = nil unless hash.key?('data')
+      pagination_metadata = PaginationMetadata.from_hash(hash['pagination_metadata']) if
+        hash['pagination_metadata']
+
+      # 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.
+      CreditNotes.new(data: data,
+                      pagination_metadata: pagination_metadata,
+                      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} data: #{@data}, pagination_metadata: #{@pagination_metadata},"\
+      " 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} data: #{@data.inspect}, pagination_metadata:"\
+      " #{@pagination_metadata.inspect}, additional_properties: #{@additional_properties}>"
+    end
+  end
+end

data/lib/api_reference/models/cumulative_grouped_allocation_config.rb

@@ -0,0 +1,94 @@
+# api_reference
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+module ApiReference
+  # Configuration for cumulative grouped allocation pricing. This rating
+  # function groups usage by a grouping key and applies both per-group and
+  # cumulative allocations. For each group (ordered by group value), it
+  # calculates the larger of the group overage and the incremental cumulative
+  # overage.
+  class CumulativeGroupedAllocationConfig < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # The event property used to group usage before applying allocations
+    # @return [String]
+    attr_accessor :grouping_key
+
+    # The allocation per individual group
+    # @return [String]
+    attr_accessor :group_allocation
+
+    # The overall allocation across all groups
+    # @return [String]
+    attr_accessor :cumulative_allocation
+
+    # The amount to charge for each unit outside of the allocation
+    # @return [String]
+    attr_accessor :unit_amount
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['grouping_key'] = 'grouping_key'
+      @_hash['group_allocation'] = 'group_allocation'
+      @_hash['cumulative_allocation'] = 'cumulative_allocation'
+      @_hash['unit_amount'] = 'unit_amount'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      []
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(grouping_key:, group_allocation:, cumulative_allocation:,
+                   unit_amount:)
+      @grouping_key = grouping_key
+      @group_allocation = group_allocation
+      @cumulative_allocation = cumulative_allocation
+      @unit_amount = unit_amount
+    end
+
+    # Creates an instance of the object from a hash.
+    def self.from_hash(hash)
+      return nil unless hash
+
+      # Extract variables from the hash.
+      grouping_key = hash.key?('grouping_key') ? hash['grouping_key'] : nil
+      group_allocation =
+        hash.key?('group_allocation') ? hash['group_allocation'] : nil
+      cumulative_allocation =
+        hash.key?('cumulative_allocation') ? hash['cumulative_allocation'] : nil
+      unit_amount = hash.key?('unit_amount') ? hash['unit_amount'] : nil
+
+      # Create object from extracted values.
+      CumulativeGroupedAllocationConfig.new(grouping_key: grouping_key,
+                                            group_allocation: group_allocation,
+                                            cumulative_allocation: cumulative_allocation,
+                                            unit_amount: unit_amount)
+    end
+
+    # Provides a human-readable string representation of the object.
+    def to_s
+      class_name = self.class.name.split('::').last
+      "<#{class_name} grouping_key: #{@grouping_key}, group_allocation: #{@group_allocation},"\
+      " cumulative_allocation: #{@cumulative_allocation}, unit_amount: #{@unit_amount}>"
+    end
+
+    # Provides a debugging-friendly string with detailed object information.
+    def inspect
+      class_name = self.class.name.split('::').last
+      "<#{class_name} grouping_key: #{@grouping_key.inspect}, group_allocation:"\
+      " #{@group_allocation.inspect}, cumulative_allocation: #{@cumulative_allocation.inspect},"\
+      " unit_amount: #{@unit_amount.inspect}>"
+    end
+  end
+end

data/lib/api_reference/models/cumulative_grouped_allocation_config1.rb

@@ -0,0 +1,120 @@
+# api_reference
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+module ApiReference
+  # Configuration for cumulative_grouped_allocation pricing
+  class CumulativeGroupedAllocationConfig1 < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # The event property used to group usage before applying allocations
+    # @return [String]
+    attr_accessor :grouping_key
+
+    # The allocation per individual group
+    # @return [String]
+    attr_accessor :group_allocation
+
+    # The overall allocation across all groups
+    # @return [String]
+    attr_accessor :cumulative_allocation
+
+    # The amount to charge for each unit outside of the allocation
+    # @return [String]
+    attr_accessor :unit_amount
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['grouping_key'] = 'grouping_key'
+      @_hash['group_allocation'] = 'group_allocation'
+      @_hash['cumulative_allocation'] = 'cumulative_allocation'
+      @_hash['unit_amount'] = 'unit_amount'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      []
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(grouping_key:, group_allocation:, cumulative_allocation:,
+                   unit_amount:)
+      @grouping_key = grouping_key
+      @group_allocation = group_allocation
+      @cumulative_allocation = cumulative_allocation
+      @unit_amount = unit_amount
+    end
+
+    # Creates an instance of the object from a hash.
+    def self.from_hash(hash)
+      return nil unless hash
+
+      # Extract variables from the hash.
+      grouping_key = hash.key?('grouping_key') ? hash['grouping_key'] : nil
+      group_allocation =
+        hash.key?('group_allocation') ? hash['group_allocation'] : nil
+      cumulative_allocation =
+        hash.key?('cumulative_allocation') ? hash['cumulative_allocation'] : nil
+      unit_amount = hash.key?('unit_amount') ? hash['unit_amount'] : nil
+
+      # Create object from extracted values.
+      CumulativeGroupedAllocationConfig1.new(grouping_key: grouping_key,
+                                             group_allocation: group_allocation,
+                                             cumulative_allocation: cumulative_allocation,
+                                             unit_amount: unit_amount)
+    end
+
+    # Validates an instance of the object from a given value.
+    # @param [CumulativeGroupedAllocationConfig1 | Hash] The value against the validation is performed.
+    def self.validate(value)
+      if value.instance_of? self
+        return (
+          APIHelper.valid_type?(value.grouping_key,
+                                ->(val) { val.instance_of? String }) and
+            APIHelper.valid_type?(value.group_allocation,
+                                  ->(val) { val.instance_of? String }) and
+            APIHelper.valid_type?(value.cumulative_allocation,
+                                  ->(val) { val.instance_of? String }) and
+            APIHelper.valid_type?(value.unit_amount,
+                                  ->(val) { val.instance_of? String })
+        )
+      end
+
+      return false unless value.instance_of? Hash
+
+      (
+        APIHelper.valid_type?(value['grouping_key'],
+                              ->(val) { val.instance_of? String }) and
+          APIHelper.valid_type?(value['group_allocation'],
+                                ->(val) { val.instance_of? String }) and
+          APIHelper.valid_type?(value['cumulative_allocation'],
+                                ->(val) { val.instance_of? String }) and
+          APIHelper.valid_type?(value['unit_amount'],
+                                ->(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} grouping_key: #{@grouping_key}, group_allocation: #{@group_allocation},"\
+      " cumulative_allocation: #{@cumulative_allocation}, unit_amount: #{@unit_amount}>"
+    end
+
+    # Provides a debugging-friendly string with detailed object information.
+    def inspect
+      class_name = self.class.name.split('::').last
+      "<#{class_name} grouping_key: #{@grouping_key.inspect}, group_allocation:"\
+      " #{@group_allocation.inspect}, cumulative_allocation: #{@cumulative_allocation.inspect},"\
+      " unit_amount: #{@unit_amount.inspect}>"
+    end
+  end
+end