fdx-api-sdk-ruby 1.0.0

data/lib/fdx_api/models/merchant_entity1.rb

@@ -0,0 +1,159 @@
+# fdx_api
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+require 'date'
+module FdxApi
+  # When payee is a merchant, typically a business from which goods or services
+  # are rendered, this field will be populated
+  class MerchantEntity1 < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # User defined name for the merchant. Used by the customer to identify the
+    # merchant. Not used by the system to process payments
+    # @return [String]
+    attr_accessor :display_name
+
+    # Name of the merchant used to execute the payment
+    # @return [CustomerNameEntity]
+    attr_accessor :name
+
+    # Address of the merchant used to execute the payment
+    # @return [DeliveryAddress1]
+    attr_accessor :address
+
+    # Phone number of the merchant used to execute the payment
+    # @return [TelephoneNumber]
+    attr_accessor :phone
+
+    # Account identifier(s) the customer has with the merchant
+    # @return [Array[String]]
+    attr_accessor :merchant_account_ids
+
+    # Persistent unique identifier for a merchant payee
+    # @return [String]
+    attr_accessor :payee_id
+
+    # Defines the Merchant's lifecycle
+    # @return [PartyStatus3]
+    attr_accessor :status
+
+    # Describes when the entity will be automatically deleted. The entity will
+    # not go into the "DELETED" state. If this value is null or not provided,
+    # the entity will not expire automatically
+    # @return [DateTime]
+    attr_accessor :expires_timestamp
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['display_name'] = 'displayName'
+      @_hash['name'] = 'name'
+      @_hash['address'] = 'address'
+      @_hash['phone'] = 'phone'
+      @_hash['merchant_account_ids'] = 'merchantAccountIds'
+      @_hash['payee_id'] = 'payeeId'
+      @_hash['status'] = 'status'
+      @_hash['expires_timestamp'] = 'expiresTimestamp'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        display_name
+        name
+        address
+        phone
+        merchant_account_ids
+        payee_id
+        expires_timestamp
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(status:, display_name: SKIP, name: SKIP, address: SKIP,
+                   phone: SKIP, merchant_account_ids: SKIP, payee_id: SKIP,
+                   expires_timestamp: SKIP, additional_properties: nil)
+      # Add additional model properties to the instance
+      additional_properties = {} if additional_properties.nil?
+
+      @display_name = display_name unless display_name == SKIP
+      @name = name unless name == SKIP
+      @address = address unless address == SKIP
+      @phone = phone unless phone == SKIP
+      @merchant_account_ids = merchant_account_ids unless merchant_account_ids == SKIP
+      @payee_id = payee_id unless payee_id == SKIP
+      @status = status
+      @expires_timestamp = expires_timestamp unless expires_timestamp == 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.
+      status = hash.key?('status') ? hash['status'] : nil
+      display_name = hash.key?('displayName') ? hash['displayName'] : SKIP
+      name = CustomerNameEntity.from_hash(hash['name']) if hash['name']
+      address = DeliveryAddress1.from_hash(hash['address']) if hash['address']
+      phone = TelephoneNumber.from_hash(hash['phone']) if hash['phone']
+      merchant_account_ids =
+        hash.key?('merchantAccountIds') ? hash['merchantAccountIds'] : SKIP
+      payee_id = hash.key?('payeeId') ? hash['payeeId'] : SKIP
+      expires_timestamp = if hash.key?('expiresTimestamp')
+                            (DateTimeHelper.from_rfc3339(hash['expiresTimestamp']) if hash['expiresTimestamp'])
+                          else
+                            SKIP
+                          end
+
+      # 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.
+      MerchantEntity1.new(status: status,
+                          display_name: display_name,
+                          name: name,
+                          address: address,
+                          phone: phone,
+                          merchant_account_ids: merchant_account_ids,
+                          payee_id: payee_id,
+                          expires_timestamp: expires_timestamp,
+                          additional_properties: additional_properties)
+    end
+
+    def to_custom_expires_timestamp
+      DateTimeHelper.to_rfc3339(expires_timestamp)
+    end
+
+    # Provides a human-readable string representation of the object.
+    def to_s
+      class_name = self.class.name.split('::').last
+      "<#{class_name} display_name: #{@display_name}, name: #{@name}, address: #{@address},"\
+      " phone: #{@phone}, merchant_account_ids: #{@merchant_account_ids}, payee_id: #{@payee_id},"\
+      " status: #{@status}, expires_timestamp: #{@expires_timestamp}, 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} display_name: #{@display_name.inspect}, name: #{@name.inspect}, address:"\
+      " #{@address.inspect}, phone: #{@phone.inspect}, merchant_account_ids:"\
+      " #{@merchant_account_ids.inspect}, payee_id: #{@payee_id.inspect}, status:"\
+      " #{@status.inspect}, expires_timestamp: #{@expires_timestamp.inspect},"\
+      " additional_properties: #{@additional_properties}>"
+    end
+  end
+end

data/lib/fdx_api/models/merchant_for_update_entity.rb

@@ -0,0 +1,118 @@
+# fdx_api
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+module FdxApi
+  # Merchant's fields to be updated. Describes the fields that can be updated by
+  # the client. Supported fields could be server dependent
+  class MerchantForUpdateEntity < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # User defined name for the merchant. Used by the customer to identify the
+    # merchant. Not used by the system to process payments
+    # @return [String]
+    attr_accessor :display_name
+
+    # Name of the merchant used to execute the payment
+    # @return [CustomerNameEntity]
+    attr_accessor :name
+
+    # Address of the merchant used to execute the payment
+    # @return [DeliveryAddress1]
+    attr_accessor :address
+
+    # Phone number of the merchant used to execute the payment
+    # @return [TelephoneNumber]
+    attr_accessor :phone
+
+    # Account identifier(s) the customer has with the merchant
+    # @return [Array[String]]
+    attr_accessor :merchant_account_ids
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['display_name'] = 'displayName'
+      @_hash['name'] = 'name'
+      @_hash['address'] = 'address'
+      @_hash['phone'] = 'phone'
+      @_hash['merchant_account_ids'] = 'merchantAccountIds'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        display_name
+        name
+        address
+        phone
+        merchant_account_ids
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(display_name: SKIP, name: SKIP, address: SKIP, phone: SKIP,
+                   merchant_account_ids: SKIP, additional_properties: nil)
+      # Add additional model properties to the instance
+      additional_properties = {} if additional_properties.nil?
+
+      @display_name = display_name unless display_name == SKIP
+      @name = name unless name == SKIP
+      @address = address unless address == SKIP
+      @phone = phone unless phone == SKIP
+      @merchant_account_ids = merchant_account_ids unless merchant_account_ids == 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.
+      display_name = hash.key?('displayName') ? hash['displayName'] : SKIP
+      name = CustomerNameEntity.from_hash(hash['name']) if hash['name']
+      address = DeliveryAddress1.from_hash(hash['address']) if hash['address']
+      phone = TelephoneNumber.from_hash(hash['phone']) if hash['phone']
+      merchant_account_ids =
+        hash.key?('merchantAccountIds') ? hash['merchantAccountIds'] : 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.
+      MerchantForUpdateEntity.new(display_name: display_name,
+                                  name: name,
+                                  address: address,
+                                  phone: phone,
+                                  merchant_account_ids: merchant_account_ids,
+                                  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} display_name: #{@display_name}, name: #{@name}, address: #{@address},"\
+      " phone: #{@phone}, merchant_account_ids: #{@merchant_account_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} display_name: #{@display_name.inspect}, name: #{@name.inspect}, address:"\
+      " #{@address.inspect}, phone: #{@phone.inspect}, merchant_account_ids:"\
+      " #{@merchant_account_ids.inspect}, additional_properties: #{@additional_properties}>"
+    end
+  end
+end

data/lib/fdx_api/models/merchant_for_update_entity1.rb

@@ -0,0 +1,118 @@
+# fdx_api
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+module FdxApi
+  # When payee is a merchant, typically a business from which goods or services
+  # are rendered, this field will be populated
+  class MerchantForUpdateEntity1 < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # User defined name for the merchant. Used by the customer to identify the
+    # merchant. Not used by the system to process payments
+    # @return [String]
+    attr_accessor :display_name
+
+    # Name of the merchant used to execute the payment
+    # @return [CustomerNameEntity]
+    attr_accessor :name
+
+    # Address of the merchant used to execute the payment
+    # @return [DeliveryAddress1]
+    attr_accessor :address
+
+    # Phone number of the merchant used to execute the payment
+    # @return [TelephoneNumber]
+    attr_accessor :phone
+
+    # Account identifier(s) the customer has with the merchant
+    # @return [Array[String]]
+    attr_accessor :merchant_account_ids
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['display_name'] = 'displayName'
+      @_hash['name'] = 'name'
+      @_hash['address'] = 'address'
+      @_hash['phone'] = 'phone'
+      @_hash['merchant_account_ids'] = 'merchantAccountIds'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        display_name
+        name
+        address
+        phone
+        merchant_account_ids
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(display_name: SKIP, name: SKIP, address: SKIP, phone: SKIP,
+                   merchant_account_ids: SKIP, additional_properties: nil)
+      # Add additional model properties to the instance
+      additional_properties = {} if additional_properties.nil?
+
+      @display_name = display_name unless display_name == SKIP
+      @name = name unless name == SKIP
+      @address = address unless address == SKIP
+      @phone = phone unless phone == SKIP
+      @merchant_account_ids = merchant_account_ids unless merchant_account_ids == 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.
+      display_name = hash.key?('displayName') ? hash['displayName'] : SKIP
+      name = CustomerNameEntity.from_hash(hash['name']) if hash['name']
+      address = DeliveryAddress1.from_hash(hash['address']) if hash['address']
+      phone = TelephoneNumber.from_hash(hash['phone']) if hash['phone']
+      merchant_account_ids =
+        hash.key?('merchantAccountIds') ? hash['merchantAccountIds'] : 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.
+      MerchantForUpdateEntity1.new(display_name: display_name,
+                                   name: name,
+                                   address: address,
+                                   phone: phone,
+                                   merchant_account_ids: merchant_account_ids,
+                                   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} display_name: #{@display_name}, name: #{@name}, address: #{@address},"\
+      " phone: #{@phone}, merchant_account_ids: #{@merchant_account_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} display_name: #{@display_name.inspect}, name: #{@name.inspect}, address:"\
+      " #{@address.inspect}, phone: #{@phone.inspect}, merchant_account_ids:"\
+      " #{@merchant_account_ids.inspect}, additional_properties: #{@additional_properties}>"
+    end
+  end
+end

data/lib/fdx_api/models/message_format.rb

@@ -0,0 +1,20 @@
+# fdx_api
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+module FdxApi
+  # Message format used in /capability API
+  class MessageFormat
+    MESSAGE_FORMAT = [
+      # TODO: Write general description for JSON
+      JSON = 'JSON'.freeze
+    ].freeze
+
+    def self.validate(value)
+      return false if value.nil?
+
+      true
+    end
+  end
+end

data/lib/fdx_api/models/message_format2.rb

@@ -0,0 +1,20 @@
+# fdx_api
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+module FdxApi
+  # Defaults to JSON
+  class MessageFormat2
+    MESSAGE_FORMAT2 = [
+      # TODO: Write general description for JSON
+      JSON = 'JSON'.freeze
+    ].freeze
+
+    def self.validate(value)
+      return false if value.nil?
+
+      true
+    end
+  end
+end

data/lib/fdx_api/models/monetary_amount.rb

@@ -0,0 +1,84 @@
+# fdx_api
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+module FdxApi
+  # The amount and currency of the base pay rate of employee
+  class MonetaryAmount < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # The monetary amount
+    # @return [Float]
+    attr_accessor :amount
+
+    # Currency code of the monetary amount
+    # @return [Iso4217CurrencyCode]
+    attr_accessor :currency
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['amount'] = 'amount'
+      @_hash['currency'] = 'currency'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        currency
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(amount:, currency: SKIP, additional_properties: nil)
+      # Add additional model properties to the instance
+      additional_properties = {} if additional_properties.nil?
+
+      @amount = amount
+      @currency = currency unless currency == 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.
+      amount = hash.key?('amount') ? hash['amount'] : nil
+      currency = hash.key?('currency') ? hash['currency'] : 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.
+      MonetaryAmount.new(amount: amount,
+                         currency: currency,
+                         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} amount: #{@amount}, currency: #{@currency}, 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} amount: #{@amount.inspect}, currency: #{@currency.inspect},"\
+      " additional_properties: #{@additional_properties}>"
+    end
+  end
+end

data/lib/fdx_api/models/monetary_amount1.rb

@@ -0,0 +1,84 @@
+# fdx_api
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+module FdxApi
+  # Total gross pay for covered period
+  class MonetaryAmount1 < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # The monetary amount
+    # @return [Float]
+    attr_accessor :amount
+
+    # Currency code of the monetary amount
+    # @return [Iso4217CurrencyCode]
+    attr_accessor :currency
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['amount'] = 'amount'
+      @_hash['currency'] = 'currency'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        currency
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(amount:, currency: SKIP, additional_properties: nil)
+      # Add additional model properties to the instance
+      additional_properties = {} if additional_properties.nil?
+
+      @amount = amount
+      @currency = currency unless currency == 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.
+      amount = hash.key?('amount') ? hash['amount'] : nil
+      currency = hash.key?('currency') ? hash['currency'] : 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.
+      MonetaryAmount1.new(amount: amount,
+                          currency: currency,
+                          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} amount: #{@amount}, currency: #{@currency}, 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} amount: #{@amount.inspect}, currency: #{@currency.inspect},"\
+      " additional_properties: #{@additional_properties}>"
+    end
+  end
+end

data/lib/fdx_api/models/monetary_amount2.rb

@@ -0,0 +1,84 @@
+# fdx_api
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+module FdxApi
+  # Base pay part of Gross pay for covered period
+  class MonetaryAmount2 < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # The monetary amount
+    # @return [Float]
+    attr_accessor :amount
+
+    # Currency code of the monetary amount
+    # @return [Iso4217CurrencyCode]
+    attr_accessor :currency
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['amount'] = 'amount'
+      @_hash['currency'] = 'currency'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        currency
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(amount:, currency: SKIP, additional_properties: nil)
+      # Add additional model properties to the instance
+      additional_properties = {} if additional_properties.nil?
+
+      @amount = amount
+      @currency = currency unless currency == 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.
+      amount = hash.key?('amount') ? hash['amount'] : nil
+      currency = hash.key?('currency') ? hash['currency'] : 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.
+      MonetaryAmount2.new(amount: amount,
+                          currency: currency,
+                          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} amount: #{@amount}, currency: #{@currency}, 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} amount: #{@amount.inspect}, currency: #{@currency.inspect},"\
+      " additional_properties: #{@additional_properties}>"
+    end
+  end
+end