fdx-apimatic-sdk 0.0.1

data/lib/fdx_v660_api/models/hateoas_link1.rb

@@ -0,0 +1,149 @@
+# fdx_v660_api
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+module FdxV660Api
+  # Resource URL for retrieving next dataset
+  class HateoasLink1 < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # URL to invoke the action on the resource
+    # @return [String]
+    attr_accessor :href
+
+    # HTTP Method to use for the request
+    # @return [HttpActionType2]
+    attr_accessor :action
+
+    # Relation of this link to its containing entity, as defined by IETF RFC5988
+    # with many relation values specified in its [Section
+    # 6.2.2](https://datatracker.ietf.org/doc/html/rfc5988#section-6.2.2), for
+    # example:
+    #   * `self` - Link to the current resource latest state or with more detail
+    #   * `prev` - Previous page in a paginated result set
+    #   * `next` - Subsequent page in a paginated result set
+    #   * `first` - First page in a paginated result set
+    #   * `last` - Last page in a paginated result set
+    #   * `related` - Link to a related resource, like a Transaction's
+    # referenceTransactionId
+    #   * `up` - Link to a related 'parent' resource, like a child account's
+    # parent account
+    #   * `payment` - Link to a payment-scheduling endpoint
+    # Specific to FDX, `rel` values can contain a data cluster or
+    # space-delimited list of data clusters which link to the referenced data
+    # type(s), for example:
+    #   * `ACCOUNT_DETAILED` - Link to the account's details via
+    # `/accounts/{accountId}`
+    #   * `PAYMENT_SUPPORT` - Link to the account's ID and bank ID for payments
+    # or transfers via `/accounts/{accountId}/payment-networks`
+    #   * `CUSTOMER_CONTACT` - Link to the account's customer contact details
+    # via `/accounts/{accountId}/contact`
+    #   * `TRANSACTIONS` - Link to the account's transactions list via
+    # `/accounts/{accountId}/transactions`
+    #   * `REWARDS` - Link to the account's reward program via
+    # `/reward-programs/{rewardProgramId}`
+    #   * `TRANSACTIONS REWARDS` - Specific link to the account's transaction
+    # rewards via `/accounts/{accountId}/reward-transactions`
+    #   * `STATEMENTS` - Link to the account's statements list via
+    # `/accounts/{accountId}/statements`
+    #   * `IMAGES` - Link to the transaction's images list via
+    # `/accounts/{accountId}/transaction-images/{imageId}`
+    # @return [String]
+    attr_accessor :rel
+
+    # Content-types that can be used in the Accept header
+    # @return [Array[ContentTypes]]
+    attr_accessor :types
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['href'] = 'href'
+      @_hash['action'] = 'action'
+      @_hash['rel'] = 'rel'
+      @_hash['types'] = 'types'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        action
+        rel
+        types
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(href:, action: SKIP, rel: SKIP, types: SKIP,
+                   additional_properties: nil)
+      # Add additional model properties to the instance
+      additional_properties = {} if additional_properties.nil?
+
+      @href = href
+      @action = action unless action == SKIP
+      @rel = rel unless rel == SKIP
+      @types = types unless types == 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.
+      href = hash.key?('href') ? hash['href'] : nil
+      action = hash.key?('action') ? hash['action'] : SKIP
+      rel = hash.key?('rel') ? hash['rel'] : SKIP
+      types = hash.key?('types') ? hash['types'] : 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.
+      HateoasLink1.new(href: href,
+                       action: action,
+                       rel: rel,
+                       types: types,
+                       additional_properties: additional_properties)
+    end
+
+    # Validates an instance of the object from a given value.
+    # @param [HateoasLink1 | Hash] The value against the validation is performed.
+    def self.validate(value)
+      if value.instance_of? self
+        return APIHelper.valid_type?(value.href,
+                                     ->(val) { val.instance_of? String })
+      end
+
+      return false unless value.instance_of? Hash
+
+      APIHelper.valid_type?(value['href'],
+                            ->(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} href: #{@href}, action: #{@action}, rel: #{@rel}, types: #{@types},"\
+      " 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} href: #{@href.inspect}, action: #{@action.inspect}, rel: #{@rel.inspect},"\
+      " types: #{@types.inspect}, additional_properties: #{@additional_properties}>"
+    end
+  end
+end

data/lib/fdx_v660_api/models/hateoas_link2.rb

@@ -0,0 +1,149 @@
+# fdx_v660_api
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+module FdxV660Api
+  # Resource URL for retrieving previous dataset
+  class HateoasLink2 < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # URL to invoke the action on the resource
+    # @return [String]
+    attr_accessor :href
+
+    # HTTP Method to use for the request
+    # @return [HttpActionType2]
+    attr_accessor :action
+
+    # Relation of this link to its containing entity, as defined by IETF RFC5988
+    # with many relation values specified in its [Section
+    # 6.2.2](https://datatracker.ietf.org/doc/html/rfc5988#section-6.2.2), for
+    # example:
+    #   * `self` - Link to the current resource latest state or with more detail
+    #   * `prev` - Previous page in a paginated result set
+    #   * `next` - Subsequent page in a paginated result set
+    #   * `first` - First page in a paginated result set
+    #   * `last` - Last page in a paginated result set
+    #   * `related` - Link to a related resource, like a Transaction's
+    # referenceTransactionId
+    #   * `up` - Link to a related 'parent' resource, like a child account's
+    # parent account
+    #   * `payment` - Link to a payment-scheduling endpoint
+    # Specific to FDX, `rel` values can contain a data cluster or
+    # space-delimited list of data clusters which link to the referenced data
+    # type(s), for example:
+    #   * `ACCOUNT_DETAILED` - Link to the account's details via
+    # `/accounts/{accountId}`
+    #   * `PAYMENT_SUPPORT` - Link to the account's ID and bank ID for payments
+    # or transfers via `/accounts/{accountId}/payment-networks`
+    #   * `CUSTOMER_CONTACT` - Link to the account's customer contact details
+    # via `/accounts/{accountId}/contact`
+    #   * `TRANSACTIONS` - Link to the account's transactions list via
+    # `/accounts/{accountId}/transactions`
+    #   * `REWARDS` - Link to the account's reward program via
+    # `/reward-programs/{rewardProgramId}`
+    #   * `TRANSACTIONS REWARDS` - Specific link to the account's transaction
+    # rewards via `/accounts/{accountId}/reward-transactions`
+    #   * `STATEMENTS` - Link to the account's statements list via
+    # `/accounts/{accountId}/statements`
+    #   * `IMAGES` - Link to the transaction's images list via
+    # `/accounts/{accountId}/transaction-images/{imageId}`
+    # @return [String]
+    attr_accessor :rel
+
+    # Content-types that can be used in the Accept header
+    # @return [Array[ContentTypes]]
+    attr_accessor :types
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['href'] = 'href'
+      @_hash['action'] = 'action'
+      @_hash['rel'] = 'rel'
+      @_hash['types'] = 'types'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        action
+        rel
+        types
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(href:, action: SKIP, rel: SKIP, types: SKIP,
+                   additional_properties: nil)
+      # Add additional model properties to the instance
+      additional_properties = {} if additional_properties.nil?
+
+      @href = href
+      @action = action unless action == SKIP
+      @rel = rel unless rel == SKIP
+      @types = types unless types == 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.
+      href = hash.key?('href') ? hash['href'] : nil
+      action = hash.key?('action') ? hash['action'] : SKIP
+      rel = hash.key?('rel') ? hash['rel'] : SKIP
+      types = hash.key?('types') ? hash['types'] : 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.
+      HateoasLink2.new(href: href,
+                       action: action,
+                       rel: rel,
+                       types: types,
+                       additional_properties: additional_properties)
+    end
+
+    # Validates an instance of the object from a given value.
+    # @param [HateoasLink2 | Hash] The value against the validation is performed.
+    def self.validate(value)
+      if value.instance_of? self
+        return APIHelper.valid_type?(value.href,
+                                     ->(val) { val.instance_of? String })
+      end
+
+      return false unless value.instance_of? Hash
+
+      APIHelper.valid_type?(value['href'],
+                            ->(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} href: #{@href}, action: #{@action}, rel: #{@rel}, types: #{@types},"\
+      " 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} href: #{@href.inspect}, action: #{@action.inspect}, rel: #{@rel.inspect},"\
+      " types: #{@types.inspect}, additional_properties: #{@additional_properties}>"
+    end
+  end
+end

data/lib/fdx_v660_api/models/hateoas_link3.rb

@@ -0,0 +1,135 @@
+# fdx_v660_api
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+module FdxV660Api
+  # URL to retrieve further details related to notification
+  class HateoasLink3 < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # URL to invoke the action on the resource
+    # @return [String]
+    attr_accessor :href
+
+    # HTTP Method to use for the request
+    # @return [HttpActionType2]
+    attr_accessor :action
+
+    # Relation of this link to its containing entity, as defined by IETF RFC5988
+    # with many relation values specified in its [Section
+    # 6.2.2](https://datatracker.ietf.org/doc/html/rfc5988#section-6.2.2), for
+    # example:
+    #   * `self` - Link to the current resource latest state or with more detail
+    #   * `prev` - Previous page in a paginated result set
+    #   * `next` - Subsequent page in a paginated result set
+    #   * `first` - First page in a paginated result set
+    #   * `last` - Last page in a paginated result set
+    #   * `related` - Link to a related resource, like a Transaction's
+    # referenceTransactionId
+    #   * `up` - Link to a related 'parent' resource, like a child account's
+    # parent account
+    #   * `payment` - Link to a payment-scheduling endpoint
+    # Specific to FDX, `rel` values can contain a data cluster or
+    # space-delimited list of data clusters which link to the referenced data
+    # type(s), for example:
+    #   * `ACCOUNT_DETAILED` - Link to the account's details via
+    # `/accounts/{accountId}`
+    #   * `PAYMENT_SUPPORT` - Link to the account's ID and bank ID for payments
+    # or transfers via `/accounts/{accountId}/payment-networks`
+    #   * `CUSTOMER_CONTACT` - Link to the account's customer contact details
+    # via `/accounts/{accountId}/contact`
+    #   * `TRANSACTIONS` - Link to the account's transactions list via
+    # `/accounts/{accountId}/transactions`
+    #   * `REWARDS` - Link to the account's reward program via
+    # `/reward-programs/{rewardProgramId}`
+    #   * `TRANSACTIONS REWARDS` - Specific link to the account's transaction
+    # rewards via `/accounts/{accountId}/reward-transactions`
+    #   * `STATEMENTS` - Link to the account's statements list via
+    # `/accounts/{accountId}/statements`
+    #   * `IMAGES` - Link to the transaction's images list via
+    # `/accounts/{accountId}/transaction-images/{imageId}`
+    # @return [String]
+    attr_accessor :rel
+
+    # Content-types that can be used in the Accept header
+    # @return [Array[ContentTypes]]
+    attr_accessor :types
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['href'] = 'href'
+      @_hash['action'] = 'action'
+      @_hash['rel'] = 'rel'
+      @_hash['types'] = 'types'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        action
+        rel
+        types
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(href:, action: SKIP, rel: SKIP, types: SKIP,
+                   additional_properties: nil)
+      # Add additional model properties to the instance
+      additional_properties = {} if additional_properties.nil?
+
+      @href = href
+      @action = action unless action == SKIP
+      @rel = rel unless rel == SKIP
+      @types = types unless types == 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.
+      href = hash.key?('href') ? hash['href'] : nil
+      action = hash.key?('action') ? hash['action'] : SKIP
+      rel = hash.key?('rel') ? hash['rel'] : SKIP
+      types = hash.key?('types') ? hash['types'] : 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.
+      HateoasLink3.new(href: href,
+                       action: action,
+                       rel: rel,
+                       types: types,
+                       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} href: #{@href}, action: #{@action}, rel: #{@rel}, types: #{@types},"\
+      " 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} href: #{@href.inspect}, action: #{@action.inspect}, rel: #{@rel.inspect},"\
+      " types: #{@types.inspect}, additional_properties: #{@additional_properties}>"
+    end
+  end
+end

data/lib/fdx_v660_api/models/hateoas_link4.rb

@@ -0,0 +1,137 @@
+# fdx_v660_api
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+module FdxV660Api
+  # General HATEOAS link for this API, specifying supported action (GET, POST,
+  # etc) and contentTypes (application/json, image/png, etc), but without any
+  # path parameter values
+  class HateoasLink4 < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # URL to invoke the action on the resource
+    # @return [String]
+    attr_accessor :href
+
+    # HTTP Method to use for the request
+    # @return [HttpActionType2]
+    attr_accessor :action
+
+    # Relation of this link to its containing entity, as defined by IETF RFC5988
+    # with many relation values specified in its [Section
+    # 6.2.2](https://datatracker.ietf.org/doc/html/rfc5988#section-6.2.2), for
+    # example:
+    #   * `self` - Link to the current resource latest state or with more detail
+    #   * `prev` - Previous page in a paginated result set
+    #   * `next` - Subsequent page in a paginated result set
+    #   * `first` - First page in a paginated result set
+    #   * `last` - Last page in a paginated result set
+    #   * `related` - Link to a related resource, like a Transaction's
+    # referenceTransactionId
+    #   * `up` - Link to a related 'parent' resource, like a child account's
+    # parent account
+    #   * `payment` - Link to a payment-scheduling endpoint
+    # Specific to FDX, `rel` values can contain a data cluster or
+    # space-delimited list of data clusters which link to the referenced data
+    # type(s), for example:
+    #   * `ACCOUNT_DETAILED` - Link to the account's details via
+    # `/accounts/{accountId}`
+    #   * `PAYMENT_SUPPORT` - Link to the account's ID and bank ID for payments
+    # or transfers via `/accounts/{accountId}/payment-networks`
+    #   * `CUSTOMER_CONTACT` - Link to the account's customer contact details
+    # via `/accounts/{accountId}/contact`
+    #   * `TRANSACTIONS` - Link to the account's transactions list via
+    # `/accounts/{accountId}/transactions`
+    #   * `REWARDS` - Link to the account's reward program via
+    # `/reward-programs/{rewardProgramId}`
+    #   * `TRANSACTIONS REWARDS` - Specific link to the account's transaction
+    # rewards via `/accounts/{accountId}/reward-transactions`
+    #   * `STATEMENTS` - Link to the account's statements list via
+    # `/accounts/{accountId}/statements`
+    #   * `IMAGES` - Link to the transaction's images list via
+    # `/accounts/{accountId}/transaction-images/{imageId}`
+    # @return [String]
+    attr_accessor :rel
+
+    # Content-types that can be used in the Accept header
+    # @return [Array[ContentTypes]]
+    attr_accessor :types
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['href'] = 'href'
+      @_hash['action'] = 'action'
+      @_hash['rel'] = 'rel'
+      @_hash['types'] = 'types'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        action
+        rel
+        types
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(href:, action: SKIP, rel: SKIP, types: SKIP,
+                   additional_properties: nil)
+      # Add additional model properties to the instance
+      additional_properties = {} if additional_properties.nil?
+
+      @href = href
+      @action = action unless action == SKIP
+      @rel = rel unless rel == SKIP
+      @types = types unless types == 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.
+      href = hash.key?('href') ? hash['href'] : nil
+      action = hash.key?('action') ? hash['action'] : SKIP
+      rel = hash.key?('rel') ? hash['rel'] : SKIP
+      types = hash.key?('types') ? hash['types'] : 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.
+      HateoasLink4.new(href: href,
+                       action: action,
+                       rel: rel,
+                       types: types,
+                       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} href: #{@href}, action: #{@action}, rel: #{@rel}, types: #{@types},"\
+      " 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} href: #{@href.inspect}, action: #{@action.inspect}, rel: #{@rel.inspect},"\
+      " types: #{@types.inspect}, additional_properties: #{@additional_properties}>"
+    end
+  end
+end