apimatic-cp-sdk 0.0.1

data/lib/cell_point_api/models/refund_method.rb

@@ -0,0 +1,36 @@
+# cell_point_api
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+module CellPointApi
+  # Method of refunding the payment.
+  class RefundMethod
+    REFUND_METHOD = [
+      # TODO: Write general description for ORIGINAL_PAYMENT_METHOD
+      ORIGINAL_PAYMENT_METHOD = 'ORIGINAL_PAYMENT_METHOD'.freeze,
+
+      # TODO: Write general description for VOUCHER
+      VOUCHER = 'VOUCHER'.freeze
+    ].freeze
+
+    def self.validate(value)
+      return false if value.nil?
+
+      REFUND_METHOD.include?(value)
+    end
+
+    def self.from_value(value, default_value = ORIGINAL_PAYMENT_METHOD)
+      return default_value if value.nil?
+
+      str = value.to_s.strip
+
+      case str.downcase
+      when 'original_payment_method' then ORIGINAL_PAYMENT_METHOD
+      when 'voucher' then VOUCHER
+      else
+        default_value
+      end
+    end
+  end
+end

data/lib/cell_point_api/models/refund_order_group_post201_response.rb

@@ -0,0 +1,91 @@
+# cell_point_api
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+module CellPointApi
+  # Response containing the refunds created.
+  class RefundOrderGroupPost201Response < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # TODO: Write general description for this method
+    # @return [Array[RefundItem]]
+    attr_accessor :refunds
+
+    # Custom data associated with the refund.
+    # @return [Object]
+    attr_accessor :custom
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['refunds'] = 'refunds'
+      @_hash['custom'] = 'custom'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      []
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(refunds:, custom:, additional_properties: nil)
+      # Add additional model properties to the instance
+      additional_properties = {} if additional_properties.nil?
+
+      @refunds = refunds
+      @custom = custom
+      @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
+      refunds = nil
+      unless hash['refunds'].nil?
+        refunds = []
+        hash['refunds'].each do |structure|
+          refunds << (RefundItem.from_hash(structure) if structure)
+        end
+      end
+
+      refunds = nil unless hash.key?('refunds')
+      custom = hash.key?('custom') ? hash['custom'] : 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.
+      RefundOrderGroupPost201Response.new(refunds: refunds,
+                                          custom: custom,
+                                          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} refunds: #{@refunds}, custom: #{@custom}, 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} refunds: #{@refunds.inspect}, custom: #{@custom.inspect},"\
+      " additional_properties: #{@additional_properties}>"
+    end
+  end
+end

data/lib/cell_point_api/models/refund_reason.rb

@@ -0,0 +1,104 @@
+# cell_point_api
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+module CellPointApi
+  # Optional merchant-defined reason for the refund.
+  class RefundReason < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # Merchant-defined code for the reason of the refund.
+    # @return [String]
+    attr_accessor :code
+
+    # Human-readable reason for the refund.
+    # @return [String]
+    attr_accessor :description
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['code'] = 'code'
+      @_hash['description'] = 'description'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      []
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(code:, description:, additional_properties: nil)
+      # Add additional model properties to the instance
+      additional_properties = {} if additional_properties.nil?
+
+      @code = code
+      @description = description
+      @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.
+      code = hash.key?('code') ? hash['code'] : nil
+      description = hash.key?('description') ? hash['description'] : 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.
+      RefundReason.new(code: code,
+                       description: description,
+                       additional_properties: additional_properties)
+    end
+
+    # Validates an instance of the object from a given value.
+    # @param [RefundReason | Hash] The value against the validation is performed.
+    def self.validate(value)
+      if value.instance_of? self
+        return (
+          APIHelper.valid_type?(value.code,
+                                ->(val) { val.instance_of? String }) and
+            APIHelper.valid_type?(value.description,
+                                  ->(val) { val.instance_of? String })
+        )
+      end
+
+      return false unless value.instance_of? Hash
+
+      (
+        APIHelper.valid_type?(value['code'],
+                              ->(val) { val.instance_of? String }) and
+          APIHelper.valid_type?(value['description'],
+                                ->(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} code: #{@code}, description: #{@description}, 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} code: #{@code.inspect}, description: #{@description.inspect},"\
+      " additional_properties: #{@additional_properties}>"
+    end
+  end
+end

data/lib/cell_point_api/models/refund_request.rb

@@ -0,0 +1,161 @@
+# cell_point_api
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+module CellPointApi
+  # Contains the refund request object.
+  class RefundRequest < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # Unique identifier for this refund action.
+    # @return [String]
+    attr_accessor :id
+
+    # Optional merchant-defined reason for the refund.
+    # @return [RefundReason]
+    attr_accessor :reason
+
+    # Type of refund to do, either partial or full. The actual refund however
+    # can be for any amount regardless of this type.
+    # The reason being that there may be fees so the refund can be full even
+    # though some amount is kept.
+    # @return [RefundType]
+    attr_accessor :refund_type
+
+    # Amount to refund.
+    # - The currency must be the same as the one used to pay.
+    # - The value must be equal to or smaller than the total paid amount minus
+    # the already refunded amount.
+    # @return [NonNegativeAmount]
+    attr_accessor :amount
+
+    # A means of grouping line items together into separate authorizations for
+    # Aggregate Payments.
+    # @return [Array[AuthorizationGroup]]
+    attr_accessor :authorization_groups
+
+    # Merchant configured channels, must be 1-5 alpha-characters.
+    # Typical examples include:
+    # - IBE - Internet Booking Engine
+    # - CC - Customer Care
+    # @return [String]
+    attr_accessor :channel
+
+    # Optional note to be added to the transaction.
+    # @return [String]
+    attr_accessor :note
+
+    # Custom data to send as part of the refund request.
+    # @return [Hash[String, Object]]
+    attr_accessor :custom
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['id'] = 'id'
+      @_hash['reason'] = 'reason'
+      @_hash['refund_type'] = 'refundType'
+      @_hash['amount'] = 'amount'
+      @_hash['authorization_groups'] = 'authorizationGroups'
+      @_hash['channel'] = 'channel'
+      @_hash['note'] = 'note'
+      @_hash['custom'] = 'custom'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        id
+        reason
+        authorization_groups
+        channel
+        note
+        custom
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(refund_type:, amount:, id: SKIP, reason: SKIP,
+                   authorization_groups: SKIP, channel: SKIP, note: SKIP,
+                   custom: SKIP, additional_properties: nil)
+      # Add additional model properties to the instance
+      additional_properties = {} if additional_properties.nil?
+
+      @id = id unless id == SKIP
+      @reason = reason unless reason == SKIP
+      @refund_type = refund_type
+      @amount = amount
+      @authorization_groups = authorization_groups unless authorization_groups == SKIP
+      @channel = channel unless channel == SKIP
+      @note = note unless note == SKIP
+      @custom = custom unless custom == 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.
+      refund_type = hash.key?('refundType') ? hash['refundType'] : nil
+      amount = NonNegativeAmount.from_hash(hash['amount']) if hash['amount']
+      id = hash.key?('id') ? hash['id'] : SKIP
+      reason = RefundReason.from_hash(hash['reason']) if hash['reason']
+      # Parameter is an array, so we need to iterate through it
+      authorization_groups = nil
+      unless hash['authorizationGroups'].nil?
+        authorization_groups = []
+        hash['authorizationGroups'].each do |structure|
+          authorization_groups << (AuthorizationGroup.from_hash(structure) if structure)
+        end
+      end
+
+      authorization_groups = SKIP unless hash.key?('authorizationGroups')
+      channel = hash.key?('channel') ? hash['channel'] : SKIP
+      note = hash.key?('note') ? hash['note'] : SKIP
+      custom = hash.key?('custom') ? hash['custom'] : 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.
+      RefundRequest.new(refund_type: refund_type,
+                        amount: amount,
+                        id: id,
+                        reason: reason,
+                        authorization_groups: authorization_groups,
+                        channel: channel,
+                        note: note,
+                        custom: custom,
+                        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}, reason: #{@reason}, refund_type: #{@refund_type}, amount:"\
+      " #{@amount}, authorization_groups: #{@authorization_groups}, channel: #{@channel}, note:"\
+      " #{@note}, custom: #{@custom}, 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}, reason: #{@reason.inspect}, refund_type:"\
+      " #{@refund_type.inspect}, amount: #{@amount.inspect}, authorization_groups:"\
+      " #{@authorization_groups.inspect}, channel: #{@channel.inspect}, note: #{@note.inspect},"\
+      " custom: #{@custom.inspect}, additional_properties: #{@additional_properties}>"
+    end
+  end
+end

data/lib/cell_point_api/models/refund_status.rb

@@ -0,0 +1,44 @@
+# cell_point_api
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+module CellPointApi
+  # Status of the refund.
+  class RefundStatus
+    REFUND_STATUS = [
+      # TODO: Write general description for REFUND_INITIATED
+      REFUND_INITIATED = 'REFUND_INITIATED'.freeze,
+
+      # TODO: Write general description for REFUND_FAILED
+      REFUND_FAILED = 'REFUND_FAILED'.freeze,
+
+      # TODO: Write general description for REFUNDED
+      REFUNDED = 'REFUNDED'.freeze,
+
+      # TODO: Write general description for CLOSED
+      CLOSED = 'CLOSED'.freeze
+    ].freeze
+
+    def self.validate(value)
+      return false if value.nil?
+
+      REFUND_STATUS.include?(value)
+    end
+
+    def self.from_value(value, default_value = REFUND_INITIATED)
+      return default_value if value.nil?
+
+      str = value.to_s.strip
+
+      case str.downcase
+      when 'refund_initiated' then REFUND_INITIATED
+      when 'refund_failed' then REFUND_FAILED
+      when 'refunded' then REFUNDED
+      when 'closed' then CLOSED
+      else
+        default_value
+      end
+    end
+  end
+end