apimatic-cp-sdk 0.0.1

data/lib/cell_point_api/models/fulfilled_lodging_reservation.rb

@@ -0,0 +1,207 @@
+# cell_point_api
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+module CellPointApi
+  # Fulfilled lodging reservation.
+  class FulfilledLodgingReservation < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # Discriminator used to identify the type of line item.
+    # @return [String]
+    attr_reader :type
+
+    # Result of the fulfillment.
+    # On `PARTIAL`, the amount that was fulfilled must be specified.
+    # @return [FulfillmentStatus]
+    attr_accessor :fulfillment_status
+
+    # Conditional property that should be sent if `fulfillmentStatus` is
+    # `PARTIAL`.
+    # `fulfilledPrice` must be less than or equal to original `price`.
+    # @return [Amount]
+    attr_accessor :fulfilled_price
+
+    # What should be shown as the title of the line item on a receipt or billing
+    # summary.
+    # @return [String]
+    attr_accessor :title
+
+    # AuthorizationGroup that the line item should be part of for splitting
+    # authorizations for Aggregate Payments Payments.
+    # If this is set, there must be a matching AuthorizationGroup created in the
+    # PriceSummary.
+    # > NOTE: Items within a Bundle should not have an `authorizationGroupId`,
+    # they will use the same `authorizationGroupId` as the top-level bundle.
+    # @return [String]
+    attr_accessor :authorization_group_id
+
+    # Stock Keeping Unit (SKU) is a product and service identification code for
+    # a specific product.
+    # @return [String]
+    attr_accessor :sku
+
+    # Stock Keeping Unit (SKU) is a product and service identification code for
+    # a specific product.
+    # @return [Integer]
+    attr_accessor :quantity
+
+    # An amount that is a nonnegative number, i.e. {0, 1, 2, 3, 4, 5,…}
+    # @return [NonNegativeAmount]
+    attr_accessor :unit_price
+
+    # Total Price for the line item. Should be equal to `unitPrice` *
+    # `quantity`, if `unitPrice` is specified.
+    # @return [NonNegativeAmount]
+    attr_accessor :total_price
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['type'] = 'type'
+      @_hash['fulfillment_status'] = 'fulfillmentStatus'
+      @_hash['fulfilled_price'] = 'fulfilledPrice'
+      @_hash['title'] = 'title'
+      @_hash['authorization_group_id'] = 'authorizationGroupId'
+      @_hash['sku'] = 'sku'
+      @_hash['quantity'] = 'quantity'
+      @_hash['unit_price'] = 'unitPrice'
+      @_hash['total_price'] = 'totalPrice'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        fulfilled_price
+        authorization_group_id
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(fulfillment_status:, title:, sku:, quantity: 1, unit_price:,
+                   total_price:, fulfilled_price: SKIP,
+                   authorization_group_id: SKIP, additional_properties: nil)
+      # Add additional model properties to the instance
+      additional_properties = {} if additional_properties.nil?
+
+      @type = 'LODGING_RESERVATION'
+      @fulfillment_status = fulfillment_status
+      @fulfilled_price = fulfilled_price unless fulfilled_price == SKIP
+      @title = title
+      @authorization_group_id = authorization_group_id unless authorization_group_id == SKIP
+      @sku = sku
+      @quantity = quantity
+      @unit_price = unit_price
+      @total_price = total_price
+      @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.
+      fulfillment_status =
+        hash.key?('fulfillmentStatus') ? hash['fulfillmentStatus'] : nil
+      title = hash.key?('title') ? hash['title'] : nil
+      sku = hash.key?('sku') ? hash['sku'] : nil
+      quantity = hash['quantity'] ||= 1
+      unit_price = NonNegativeAmount.from_hash(hash['unitPrice']) if hash['unitPrice']
+      total_price = NonNegativeAmount.from_hash(hash['totalPrice']) if hash['totalPrice']
+      fulfilled_price = Amount.from_hash(hash['fulfilledPrice']) if hash['fulfilledPrice']
+      authorization_group_id =
+        hash.key?('authorizationGroupId') ? hash['authorizationGroupId'] : 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.
+      FulfilledLodgingReservation.new(fulfillment_status: fulfillment_status,
+                                      title: title,
+                                      sku: sku,
+                                      quantity: quantity,
+                                      unit_price: unit_price,
+                                      total_price: total_price,
+                                      fulfilled_price: fulfilled_price,
+                                      authorization_group_id: authorization_group_id,
+                                      additional_properties: additional_properties)
+    end
+
+    # Validates an instance of the object from a given value.
+    # @param [FulfilledLodgingReservation | Hash] The value against the validation is performed.
+    def self.validate(value)
+      if value.instance_of? self
+        return (
+          APIHelper.valid_type?(value.type,
+                                ->(val) { val.instance_of? String }) and
+            APIHelper.valid_type?(value.fulfillment_status,
+                                  ->(val) { FulfillmentStatus.validate(val) }) and
+            APIHelper.valid_type?(value.title,
+                                  ->(val) { val.instance_of? String }) and
+            APIHelper.valid_type?(value.sku,
+                                  ->(val) { val.instance_of? String }) and
+            APIHelper.valid_type?(value.quantity,
+                                  ->(val) { val.instance_of? Integer }) and
+            APIHelper.valid_type?(value.unit_price,
+                                  ->(val) { NonNegativeAmount.validate(val) },
+                                  is_model_hash: true) and
+            APIHelper.valid_type?(value.total_price,
+                                  ->(val) { NonNegativeAmount.validate(val) },
+                                  is_model_hash: true)
+        )
+      end
+
+      return false unless value.instance_of? Hash
+
+      (
+        APIHelper.valid_type?(value['type'],
+                              ->(val) { val.instance_of? String }) and
+          APIHelper.valid_type?(value['fulfillmentStatus'],
+                                ->(val) { FulfillmentStatus.validate(val) }) and
+          APIHelper.valid_type?(value['title'],
+                                ->(val) { val.instance_of? String }) and
+          APIHelper.valid_type?(value['sku'],
+                                ->(val) { val.instance_of? String }) and
+          APIHelper.valid_type?(value['quantity'],
+                                ->(val) { val.instance_of? Integer }) and
+          APIHelper.valid_type?(value['unitPrice'],
+                                ->(val) { NonNegativeAmount.validate(val) },
+                                is_model_hash: true) and
+          APIHelper.valid_type?(value['totalPrice'],
+                                ->(val) { NonNegativeAmount.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} type: #{@type}, fulfillment_status: #{@fulfillment_status},"\
+      " fulfilled_price: #{@fulfilled_price}, title: #{@title}, authorization_group_id:"\
+      " #{@authorization_group_id}, sku: #{@sku}, quantity: #{@quantity}, unit_price:"\
+      " #{@unit_price}, total_price: #{@total_price}, 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} type: #{@type.inspect}, fulfillment_status: #{@fulfillment_status.inspect},"\
+      " fulfilled_price: #{@fulfilled_price.inspect}, title: #{@title.inspect},"\
+      " authorization_group_id: #{@authorization_group_id.inspect}, sku: #{@sku.inspect},"\
+      " quantity: #{@quantity.inspect}, unit_price: #{@unit_price.inspect}, total_price:"\
+      " #{@total_price.inspect}, additional_properties: #{@additional_properties}>"
+    end
+  end
+end

data/lib/cell_point_api/models/fulfilled_order.rb

@@ -0,0 +1,148 @@
+# cell_point_api
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+module CellPointApi
+  # Contains the result of the order being fulfilled on the merchant's side.
+  # Includes information on what was fulfilled and unfulfilled so CPD can
+  # appropriately capture or cancel payments.
+  class FulfilledOrder < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # Result of the fulfillment.
+    # On `PARTIAL`, the amount that was fulfilled must be specified.
+    # @return [FulfillmentStatus]
+    attr_accessor :fulfillment_status
+
+    # An amount that is a nonnegative number, i.e. {0, 1, 2, 3, 4, 5,…}
+    # @return [NonNegativeAmount]
+    attr_accessor :fulfilled_order_amount
+
+    # An amount that is a nonnegative number, i.e. {0, 1, 2, 3, 4, 5,…}
+    # @return [NonNegativeAmount]
+    attr_accessor :unfulfilled_order_amount
+
+    # An amount that is a nonnegative number, i.e. {0, 1, 2, 3, 4, 5,…}
+    # @return [Array[FulfilledTaxLine]]
+    attr_accessor :tax_lines
+
+    # An amount that is a nonnegative number, i.e. {0, 1, 2, 3, 4, 5,…}
+    # @return [Array[Object]]
+    attr_accessor :line_items
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['fulfillment_status'] = 'fulfillmentStatus'
+      @_hash['fulfilled_order_amount'] = 'fulfilledOrderAmount'
+      @_hash['unfulfilled_order_amount'] = 'unfulfilledOrderAmount'
+      @_hash['tax_lines'] = 'taxLines'
+      @_hash['line_items'] = 'lineItems'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        fulfilled_order_amount
+        unfulfilled_order_amount
+        tax_lines
+        line_items
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(fulfillment_status:, fulfilled_order_amount: SKIP,
+                   unfulfilled_order_amount: SKIP, tax_lines: SKIP,
+                   line_items: SKIP, additional_properties: nil)
+      # Add additional model properties to the instance
+      additional_properties = {} if additional_properties.nil?
+
+      @fulfillment_status = fulfillment_status
+      @fulfilled_order_amount = fulfilled_order_amount unless fulfilled_order_amount == SKIP
+      @unfulfilled_order_amount = unfulfilled_order_amount unless unfulfilled_order_amount == SKIP
+      @tax_lines = tax_lines unless tax_lines == SKIP
+      @line_items = line_items unless line_items == 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.
+      fulfillment_status =
+        hash.key?('fulfillmentStatus') ? hash['fulfillmentStatus'] : nil
+      fulfilled_order_amount = NonNegativeAmount.from_hash(hash['fulfilledOrderAmount']) if
+        hash['fulfilledOrderAmount']
+      unfulfilled_order_amount = NonNegativeAmount.from_hash(hash['unfulfilledOrderAmount']) if
+        hash['unfulfilledOrderAmount']
+      # Parameter is an array, so we need to iterate through it
+      tax_lines = nil
+      unless hash['taxLines'].nil?
+        tax_lines = []
+        hash['taxLines'].each do |structure|
+          tax_lines << (FulfilledTaxLine.from_hash(structure) if structure)
+        end
+      end
+
+      tax_lines = SKIP unless hash.key?('taxLines')
+      line_items = hash.key?('lineItems') ? APIHelper.deserialize_union_type(
+        UnionTypeLookUp.get(:FulfilledLineItem), hash['lineItems']
+      ) : 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.
+      FulfilledOrder.new(fulfillment_status: fulfillment_status,
+                         fulfilled_order_amount: fulfilled_order_amount,
+                         unfulfilled_order_amount: unfulfilled_order_amount,
+                         tax_lines: tax_lines,
+                         line_items: line_items,
+                         additional_properties: additional_properties)
+    end
+
+    # Validates an instance of the object from a given value.
+    # @param [FulfilledOrder | Hash] The value against the validation is performed.
+    def self.validate(value)
+      if value.instance_of? self
+        return APIHelper.valid_type?(value.fulfillment_status,
+                                     ->(val) { FulfillmentStatus.validate(val) })
+      end
+
+      return false unless value.instance_of? Hash
+
+      APIHelper.valid_type?(value['fulfillmentStatus'],
+                            ->(val) { FulfillmentStatus.validate(val) })
+    end
+
+    # Provides a human-readable string representation of the object.
+    def to_s
+      class_name = self.class.name.split('::').last
+      "<#{class_name} fulfillment_status: #{@fulfillment_status}, fulfilled_order_amount:"\
+      " #{@fulfilled_order_amount}, unfulfilled_order_amount: #{@unfulfilled_order_amount},"\
+      " tax_lines: #{@tax_lines}, line_items: #{@line_items}, 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} fulfillment_status: #{@fulfillment_status.inspect}, fulfilled_order_amount:"\
+      " #{@fulfilled_order_amount.inspect}, unfulfilled_order_amount:"\
+      " #{@unfulfilled_order_amount.inspect}, tax_lines: #{@tax_lines.inspect}, line_items:"\
+      " #{@line_items.inspect}, additional_properties: #{@additional_properties}>"
+    end
+  end
+end

data/lib/cell_point_api/models/fulfilled_product.rb

@@ -0,0 +1,207 @@
+# cell_point_api
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+module CellPointApi
+  # Fulfilled product.
+  class FulfilledProduct < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # Discriminator used to identify the type of line item.
+    # @return [String]
+    attr_reader :type
+
+    # Result of the fulfillment.
+    # On `PARTIAL`, the amount that was fulfilled must be specified.
+    # @return [FulfillmentStatus]
+    attr_accessor :fulfillment_status
+
+    # Conditional property that should be sent if `fulfillmentStatus` is
+    # `PARTIAL`.
+    # `fulfilledPrice` must be less than or equal to original `price`.
+    # @return [Amount]
+    attr_accessor :fulfilled_price
+
+    # What should be shown as the title of the line item on a receipt or billing
+    # summary.
+    # @return [String]
+    attr_accessor :title
+
+    # AuthorizationGroup that the line item should be part of for splitting
+    # authorizations for Aggregate Payments Payments.
+    # If this is set, there must be a matching AuthorizationGroup created in the
+    # PriceSummary.
+    # > NOTE: Items within a Bundle should not have an `authorizationGroupId`,
+    # they will use the same `authorizationGroupId` as the top-level bundle.
+    # @return [String]
+    attr_accessor :authorization_group_id
+
+    # Stock Keeping Unit (SKU) is a product and service identification code for
+    # a specific product.
+    # @return [String]
+    attr_accessor :sku
+
+    # Stock Keeping Unit (SKU) is a product and service identification code for
+    # a specific product.
+    # @return [Integer]
+    attr_accessor :quantity
+
+    # An amount that is a nonnegative number, i.e. {0, 1, 2, 3, 4, 5,…}
+    # @return [NonNegativeAmount]
+    attr_accessor :unit_price
+
+    # Total Price for the line item. Should be equal to `unitPrice` *
+    # `quantity`, if `unitPrice` is specified.
+    # @return [NonNegativeAmount]
+    attr_accessor :total_price
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['type'] = 'type'
+      @_hash['fulfillment_status'] = 'fulfillmentStatus'
+      @_hash['fulfilled_price'] = 'fulfilledPrice'
+      @_hash['title'] = 'title'
+      @_hash['authorization_group_id'] = 'authorizationGroupId'
+      @_hash['sku'] = 'sku'
+      @_hash['quantity'] = 'quantity'
+      @_hash['unit_price'] = 'unitPrice'
+      @_hash['total_price'] = 'totalPrice'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        fulfilled_price
+        authorization_group_id
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(fulfillment_status:, title:, sku:, quantity: 1, unit_price:,
+                   total_price:, fulfilled_price: SKIP,
+                   authorization_group_id: SKIP, additional_properties: nil)
+      # Add additional model properties to the instance
+      additional_properties = {} if additional_properties.nil?
+
+      @type = 'PRODUCT'
+      @fulfillment_status = fulfillment_status
+      @fulfilled_price = fulfilled_price unless fulfilled_price == SKIP
+      @title = title
+      @authorization_group_id = authorization_group_id unless authorization_group_id == SKIP
+      @sku = sku
+      @quantity = quantity
+      @unit_price = unit_price
+      @total_price = total_price
+      @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.
+      fulfillment_status =
+        hash.key?('fulfillmentStatus') ? hash['fulfillmentStatus'] : nil
+      title = hash.key?('title') ? hash['title'] : nil
+      sku = hash.key?('sku') ? hash['sku'] : nil
+      quantity = hash['quantity'] ||= 1
+      unit_price = NonNegativeAmount.from_hash(hash['unitPrice']) if hash['unitPrice']
+      total_price = NonNegativeAmount.from_hash(hash['totalPrice']) if hash['totalPrice']
+      fulfilled_price = Amount.from_hash(hash['fulfilledPrice']) if hash['fulfilledPrice']
+      authorization_group_id =
+        hash.key?('authorizationGroupId') ? hash['authorizationGroupId'] : 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.
+      FulfilledProduct.new(fulfillment_status: fulfillment_status,
+                           title: title,
+                           sku: sku,
+                           quantity: quantity,
+                           unit_price: unit_price,
+                           total_price: total_price,
+                           fulfilled_price: fulfilled_price,
+                           authorization_group_id: authorization_group_id,
+                           additional_properties: additional_properties)
+    end
+
+    # Validates an instance of the object from a given value.
+    # @param [FulfilledProduct | Hash] The value against the validation is performed.
+    def self.validate(value)
+      if value.instance_of? self
+        return (
+          APIHelper.valid_type?(value.type,
+                                ->(val) { val.instance_of? String }) and
+            APIHelper.valid_type?(value.fulfillment_status,
+                                  ->(val) { FulfillmentStatus.validate(val) }) and
+            APIHelper.valid_type?(value.title,
+                                  ->(val) { val.instance_of? String }) and
+            APIHelper.valid_type?(value.sku,
+                                  ->(val) { val.instance_of? String }) and
+            APIHelper.valid_type?(value.quantity,
+                                  ->(val) { val.instance_of? Integer }) and
+            APIHelper.valid_type?(value.unit_price,
+                                  ->(val) { NonNegativeAmount.validate(val) },
+                                  is_model_hash: true) and
+            APIHelper.valid_type?(value.total_price,
+                                  ->(val) { NonNegativeAmount.validate(val) },
+                                  is_model_hash: true)
+        )
+      end
+
+      return false unless value.instance_of? Hash
+
+      (
+        APIHelper.valid_type?(value['type'],
+                              ->(val) { val.instance_of? String }) and
+          APIHelper.valid_type?(value['fulfillmentStatus'],
+                                ->(val) { FulfillmentStatus.validate(val) }) and
+          APIHelper.valid_type?(value['title'],
+                                ->(val) { val.instance_of? String }) and
+          APIHelper.valid_type?(value['sku'],
+                                ->(val) { val.instance_of? String }) and
+          APIHelper.valid_type?(value['quantity'],
+                                ->(val) { val.instance_of? Integer }) and
+          APIHelper.valid_type?(value['unitPrice'],
+                                ->(val) { NonNegativeAmount.validate(val) },
+                                is_model_hash: true) and
+          APIHelper.valid_type?(value['totalPrice'],
+                                ->(val) { NonNegativeAmount.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} type: #{@type}, fulfillment_status: #{@fulfillment_status},"\
+      " fulfilled_price: #{@fulfilled_price}, title: #{@title}, authorization_group_id:"\
+      " #{@authorization_group_id}, sku: #{@sku}, quantity: #{@quantity}, unit_price:"\
+      " #{@unit_price}, total_price: #{@total_price}, 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} type: #{@type.inspect}, fulfillment_status: #{@fulfillment_status.inspect},"\
+      " fulfilled_price: #{@fulfilled_price.inspect}, title: #{@title.inspect},"\
+      " authorization_group_id: #{@authorization_group_id.inspect}, sku: #{@sku.inspect},"\
+      " quantity: #{@quantity.inspect}, unit_price: #{@unit_price.inspect}, total_price:"\
+      " #{@total_price.inspect}, additional_properties: #{@additional_properties}>"
+    end
+  end
+end