apimatic-cp-sdk 0.0.1

data/lib/cell_point_api/models/transaction_failure.rb

@@ -0,0 +1,222 @@
+# cell_point_api
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+module CellPointApi
+  # Details about a failure that happened on a transaction.
+  class TransactionFailure < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # Which business module the failure happened in.
+    # <table>
+    #   <thead>
+    #     <tr>
+    #       <th>Module</th>
+    #       <th>Description</th>
+    #     </tr>
+    #   </thead>
+    #   <tbody>
+    #     <tr>
+    #       <td>PRE_AUTHORIZATION</td>
+    #       <td>Failure happened during pre-authorization checks.</td>
+    #     </tr>
+    #     <tr>
+    #       <td>PAYMENT_PROCESSOR</td>
+    #       <td>Failure happened when processing the payment.</td>
+    #            
+    #     </tr>
+    #     <tr>
+    #       <td>FOREIGN_EXCHANGE</td>
+    #       <td>Failure happened in foreign exchange (FX).</td>
+    #     </tr>
+    #     <tr>
+    #       <td>THREE_D_SECURE</td>
+    #       <td>Failure happened during 3DSecure flow.</td>
+    #     </tr>
+    #     <tr>
+    #       <td>FRAUD</td>
+    #       <td>Failure happened in fraud checks.</td>
+    #     </tr>
+    #   </tbody>
+    # </table>
+    # @return [FailureModule]
+    attr_accessor :mmodule
+
+    # Category of transaction failure.
+    # <table>
+    #   <thead>
+    #     <tr>
+    #       <th>Category</th>
+    #       <th>Description</th>
+    #     </tr>
+    #   </thead>
+    #   <tbody>
+    #     <tr>
+    #       <td>USER_ERROR</td>
+    #       <td>The buyer has entered invalid details during the payment
+    # session.</td>
+    #     </tr>
+    #     <tr>
+    #       <td>INTEGRATION_ERROR</td>
+    #       <td>There is an error with the integration between us and an
+    # external system for this request. Example - provider does not support
+    # decimal. Or MID does not exist.</td>
+    #     </tr>
+    #     <tr>
+    #       <td>SECURITY_ERROR</td>
+    #       <td>
+    #         Payment failed to pass additional security screening verification.
+    #         EXAMPLES:
+    #           - CARD_BLOCKED
+    #           - AVS_FAILED
+    #           - FRAUD_SUSPICION
+    #           - 3DS_FAILED
+    #       </td>
+    #     </tr>
+    #     <tr>
+    #       <td>TECHNICAL_ERROR</td>
+    #       <td>Transient errors that are happening due to unavailable of some
+    # system (possibly downstream).</td>
+    #     </tr>
+    #     <tr>
+    #       <td>TRANSACTION_ERROR</td>
+    #       <td>Transaction related errors.</td>
+    #     </tr>
+    #   </tbody>
+    # </table>
+    # @return [FailureCategory]
+    attr_accessor :category
+
+    # Exact reason for the failure.
+    # Examples:
+    #   - INVALID_CARD_NUMBER
+    #   - CARD_BLOCKED
+    #   - AVS_FAILED
+    #   - FRAUD_SUSPICION
+    #   - 3DS_FAILED
+    #   - INVALID_MID
+    #   - CONNECTION_TIMEOUT
+    # @return [String]
+    attr_accessor :reason
+
+    # Human readable reason for the failure.
+    # @return [String]
+    attr_accessor :description
+
+    # Amount that was attempted.
+    # @return [NonNegativeAmount]
+    attr_accessor :attempted_amount
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['mmodule'] = 'module'
+      @_hash['category'] = 'category'
+      @_hash['reason'] = 'reason'
+      @_hash['description'] = 'description'
+      @_hash['attempted_amount'] = 'attemptedAmount'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        attempted_amount
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(mmodule:, category:, reason:, description:,
+                   attempted_amount: SKIP, additional_properties: nil)
+      # Add additional model properties to the instance
+      additional_properties = {} if additional_properties.nil?
+
+      @mmodule = mmodule
+      @category = category
+      @reason = reason
+      @description = description
+      @attempted_amount = attempted_amount unless attempted_amount == 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.
+      mmodule = hash.key?('module') ? hash['module'] : nil
+      category = hash.key?('category') ? hash['category'] : nil
+      reason = hash.key?('reason') ? hash['reason'] : nil
+      description = hash.key?('description') ? hash['description'] : nil
+      attempted_amount = NonNegativeAmount.from_hash(hash['attemptedAmount']) if
+        hash['attemptedAmount']
+
+      # 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.
+      TransactionFailure.new(mmodule: mmodule,
+                             category: category,
+                             reason: reason,
+                             description: description,
+                             attempted_amount: attempted_amount,
+                             additional_properties: additional_properties)
+    end
+
+    # Validates an instance of the object from a given value.
+    # @param [TransactionFailure | Hash] The value against the validation is performed.
+    def self.validate(value)
+      if value.instance_of? self
+        return (
+          APIHelper.valid_type?(value.mmodule,
+                                ->(val) { FailureModule.validate(val) }) and
+            APIHelper.valid_type?(value.category,
+                                  ->(val) { FailureCategory.validate(val) }) and
+            APIHelper.valid_type?(value.reason,
+                                  ->(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['module'],
+                              ->(val) { FailureModule.validate(val) }) and
+          APIHelper.valid_type?(value['category'],
+                                ->(val) { FailureCategory.validate(val) }) and
+          APIHelper.valid_type?(value['reason'],
+                                ->(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} mmodule: #{@mmodule}, category: #{@category}, reason: #{@reason},"\
+      " description: #{@description}, attempted_amount: #{@attempted_amount},"\
+      " 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} mmodule: #{@mmodule.inspect}, category: #{@category.inspect}, reason:"\
+      " #{@reason.inspect}, description: #{@description.inspect}, attempted_amount:"\
+      " #{@attempted_amount.inspect}, additional_properties: #{@additional_properties}>"
+    end
+  end
+end

data/lib/cell_point_api/models/travel_journey.rb

@@ -0,0 +1,139 @@
+# cell_point_api
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+module CellPointApi
+  # Traveling from an origin to a destination. May have multiple Travel Legs as
+  # part of a journey to get to the final destination.  Note that during a
+  # One-Way itinerary, there will be exactly 1 journey.  On a Round-Trip
+  # itinerary, there will be exactly 2 journeys. Multi-City may have between 2+
+  # journeys.
+  class TravelJourney < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # Segment of the journey. 
+    # Given an the following `ItineraryType`, here are the example
+    # JourneySegment to use:
+    # <table>
+    # <thead>
+    #   <tr>
+    #     <th>Itinerary Type</th>
+    #     <th>Journey Segment</th>
+    #     <th>Description</th>
+    #   </tr>
+    # </thead>
+    # <tbody>
+    #   <tr>
+    #     <td>ONE_WAY</td>
+    #     <td>OUTBOUND</td>
+    #     <td>Single Journey</td>
+    #   </tr>
+    #   <tr>
+    #     <td>ROUND_TRIP</td>
+    #     <td>OUTBOUND</td>
+    #     <td>First Journey, leaving.</td>
+    #   </tr>
+    #   <tr>
+    #     <td>ROUND_TRIP</td>
+    #     <td>INBOUND</td>
+    #     <td>Second Journey, returning.</td>
+    #   </tr>
+    #   <tr>
+    #     <td>MULTI_CITY</td>
+    #     <td>MULTI_CITY_1</td>
+    #     <td>First Journey </td>
+    #   </tr>
+    #   <tr>
+    #     <td>MULTI_CITY</td>
+    #     <td>MULTI_CITY_2</td>
+    #     <td>Second Journey </td>
+    #   </tr>
+    #   <tr>
+    #     <td>MULTI_CITY</td>
+    #     <td>MULTI_CITY_3</td>
+    #     <td>Third Journey </td>
+    #   </tr>
+    # </tbody>
+    # </table>
+    # @return [JourneySegment]
+    attr_accessor :journey_segment
+
+    # A collection of travel legs that make up the journey.
+    # @return [Array[TravelLeg]]
+    attr_accessor :legs
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['journey_segment'] = 'journeySegment'
+      @_hash['legs'] = 'legs'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      []
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(journey_segment:, legs:, additional_properties: nil)
+      # Add additional model properties to the instance
+      additional_properties = {} if additional_properties.nil?
+
+      @journey_segment = journey_segment
+      @legs = legs
+      @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.
+      journey_segment =
+        hash.key?('journeySegment') ? hash['journeySegment'] : nil
+      # Parameter is an array, so we need to iterate through it
+      legs = nil
+      unless hash['legs'].nil?
+        legs = []
+        hash['legs'].each do |structure|
+          legs << (TravelLeg.from_hash(structure) if structure)
+        end
+      end
+
+      legs = nil unless hash.key?('legs')
+
+      # 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.
+      TravelJourney.new(journey_segment: journey_segment,
+                        legs: legs,
+                        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} journey_segment: #{@journey_segment}, legs: #{@legs},"\
+      " 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} journey_segment: #{@journey_segment.inspect}, legs: #{@legs.inspect},"\
+      " additional_properties: #{@additional_properties}>"
+    end
+  end
+end

data/lib/cell_point_api/models/travel_leg.rb

@@ -0,0 +1,194 @@
+# cell_point_api
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+require 'date'
+module CellPointApi
+  # Leg in the journey.
+  class TravelLeg < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # Identifier for leg that is unique within this order.
+    # This identifier should be used for any reference to this travel leg
+    # elsewhere,
+    # such as linking this specific leg to an ancillary in the price summary.
+    # How this identifier is generated is up to the merchant, as long as it is
+    # unique within the order.
+    # @return [String]
+    attr_accessor :id
+
+    # The travel airport details.
+    # @return [Airport]
+    attr_accessor :origin
+
+    # The travel airport details.
+    # @return [Airport]
+    attr_accessor :destination
+
+    # The date and time of departure.
+    # @return [DateTime]
+    attr_accessor :departure_time
+
+    # The date and time of arrival.
+    # @return [DateTime]
+    attr_accessor :arrival_time
+
+    # IATA code for the class of service for this leg of the trip, such as coach
+    # or first class.
+    # @return [String]
+    attr_accessor :booking_class_code
+
+    # Service level purchased, i.e. Economy, Business, First.
+    # @return [String]
+    attr_accessor :service_level
+
+    # Carrier of this flight.
+    # > In case of codeshare, this is the marketing flight number.
+    # @return [Carrier]
+    attr_accessor :carrier
+
+    # Number assigned to this individual flight.
+    # > In case of codeshare, this is the marketing flight number.
+    # @return [String]
+    attr_accessor :flight_number
+
+    # Information about codesharing agreement for this flight.
+    # @return [Codeshare]
+    attr_accessor :codeshare
+
+    # Information about codesharing agreement for this flight.
+    # @return [TrueClass | FalseClass]
+    attr_accessor :stop_over_allowed
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['id'] = 'id'
+      @_hash['origin'] = 'origin'
+      @_hash['destination'] = 'destination'
+      @_hash['departure_time'] = 'departureTime'
+      @_hash['arrival_time'] = 'arrivalTime'
+      @_hash['booking_class_code'] = 'bookingClassCode'
+      @_hash['service_level'] = 'serviceLevel'
+      @_hash['carrier'] = 'carrier'
+      @_hash['flight_number'] = 'flightNumber'
+      @_hash['codeshare'] = 'codeshare'
+      @_hash['stop_over_allowed'] = 'stopOverAllowed'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        booking_class_code
+        service_level
+        carrier
+        flight_number
+        codeshare
+        stop_over_allowed
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(id:, origin:, destination:, departure_time:, arrival_time:,
+                   booking_class_code: SKIP, service_level: SKIP, carrier: SKIP,
+                   flight_number: SKIP, codeshare: SKIP,
+                   stop_over_allowed: SKIP, additional_properties: nil)
+      # Add additional model properties to the instance
+      additional_properties = {} if additional_properties.nil?
+
+      @id = id
+      @origin = origin
+      @destination = destination
+      @departure_time = departure_time
+      @arrival_time = arrival_time
+      @booking_class_code = booking_class_code unless booking_class_code == SKIP
+      @service_level = service_level unless service_level == SKIP
+      @carrier = carrier unless carrier == SKIP
+      @flight_number = flight_number unless flight_number == SKIP
+      @codeshare = codeshare unless codeshare == SKIP
+      @stop_over_allowed = stop_over_allowed unless stop_over_allowed == 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.
+      id = hash.key?('id') ? hash['id'] : nil
+      origin = Airport.from_hash(hash['origin']) if hash['origin']
+      destination = Airport.from_hash(hash['destination']) if hash['destination']
+      departure_time = if hash.key?('departureTime')
+                         (DateTimeHelper.from_rfc3339(hash['departureTime']) if hash['departureTime'])
+                       end
+      arrival_time = if hash.key?('arrivalTime')
+                       (DateTimeHelper.from_rfc3339(hash['arrivalTime']) if hash['arrivalTime'])
+                     end
+      booking_class_code =
+        hash.key?('bookingClassCode') ? hash['bookingClassCode'] : SKIP
+      service_level = hash.key?('serviceLevel') ? hash['serviceLevel'] : SKIP
+      carrier = Carrier.from_hash(hash['carrier']) if hash['carrier']
+      flight_number = hash.key?('flightNumber') ? hash['flightNumber'] : SKIP
+      codeshare = Codeshare.from_hash(hash['codeshare']) if hash['codeshare']
+      stop_over_allowed =
+        hash.key?('stopOverAllowed') ? hash['stopOverAllowed'] : 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.
+      TravelLeg.new(id: id,
+                    origin: origin,
+                    destination: destination,
+                    departure_time: departure_time,
+                    arrival_time: arrival_time,
+                    booking_class_code: booking_class_code,
+                    service_level: service_level,
+                    carrier: carrier,
+                    flight_number: flight_number,
+                    codeshare: codeshare,
+                    stop_over_allowed: stop_over_allowed,
+                    additional_properties: additional_properties)
+    end
+
+    def to_custom_departure_time
+      DateTimeHelper.to_rfc3339(departure_time)
+    end
+
+    def to_custom_arrival_time
+      DateTimeHelper.to_rfc3339(arrival_time)
+    end
+
+    # Provides a human-readable string representation of the object.
+    def to_s
+      class_name = self.class.name.split('::').last
+      "<#{class_name} id: #{@id}, origin: #{@origin}, destination: #{@destination},"\
+      " departure_time: #{@departure_time}, arrival_time: #{@arrival_time}, booking_class_code:"\
+      " #{@booking_class_code}, service_level: #{@service_level}, carrier: #{@carrier},"\
+      " flight_number: #{@flight_number}, codeshare: #{@codeshare}, stop_over_allowed:"\
+      " #{@stop_over_allowed}, 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}, origin: #{@origin.inspect}, destination:"\
+      " #{@destination.inspect}, departure_time: #{@departure_time.inspect}, arrival_time:"\
+      " #{@arrival_time.inspect}, booking_class_code: #{@booking_class_code.inspect},"\
+      " service_level: #{@service_level.inspect}, carrier: #{@carrier.inspect}, flight_number:"\
+      " #{@flight_number.inspect}, codeshare: #{@codeshare.inspect}, stop_over_allowed:"\
+      " #{@stop_over_allowed.inspect}, additional_properties: #{@additional_properties}>"
+    end
+  end
+end

data/lib/cell_point_api/models/trigger_bulk_request.rb

@@ -0,0 +1,83 @@
+# cell_point_api
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+module CellPointApi
+  # Request object for triggering bulk payments.
+  class TriggerBulkRequest < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # List of actions to be performed in bulk.
+    # @return [Array[TransactionAction]]
+    attr_accessor :bulk_actions
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['bulk_actions'] = 'bulkActions'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      []
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(bulk_actions:, additional_properties: nil)
+      # Add additional model properties to the instance
+      additional_properties = {} if additional_properties.nil?
+
+      @bulk_actions = bulk_actions
+      @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
+      bulk_actions = nil
+      unless hash['bulkActions'].nil?
+        bulk_actions = []
+        hash['bulkActions'].each do |structure|
+          bulk_actions << (TransactionAction.from_hash(structure) if structure)
+        end
+      end
+
+      bulk_actions = nil unless hash.key?('bulkActions')
+
+      # 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.
+      TriggerBulkRequest.new(bulk_actions: bulk_actions,
+                             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} bulk_actions: #{@bulk_actions}, 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} bulk_actions: #{@bulk_actions.inspect}, additional_properties:"\
+      " #{@additional_properties}>"
+    end
+  end
+end