fdx-apimatic-sdk 0.0.1

data/lib/fdx_v660_api/models/name_and_address1.rb

@@ -0,0 +1,185 @@
+# fdx_v660_api
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+module FdxV660Api
+  # INSURED'S name and address. Deprecated with FDX V6.6, instead use
+  # `individualName` and `address` fields on insured
+  class NameAndAddress1 < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # Address line 1
+    # @return [String]
+    attr_accessor :line1
+
+    # Address line 2
+    # @return [String]
+    attr_accessor :line2
+
+    # Address line 3
+    # @return [String]
+    attr_accessor :line3
+
+    # City
+    # @return [String]
+    attr_accessor :city
+
+    # State, Province, Territory, Canton or Prefecture. From [Universal Postal
+    # Union](https://www.upu.int/en/Postal-Solutions/Programmes-Services/Address
+    # ing-Solutions#addressing-s42-standard) as of 2-26-2020, [S42 International
+    # Address
+    # Standards](https://www.upu.int/UPU/media/upu/documents/PostCode/S42_Intern
+    # ational-Addressing-Standards.pdf). For U.S. addresses can be a 2-character
+    # code from `StateCode`. For Canadian addresses can be a 2-character code
+    # from `ProvinceTerritoryCode`
+    # @return [String]
+    attr_accessor :region
+
+    # Postal code
+    # @return [String]
+    attr_accessor :postal_code
+
+    # Country code
+    # @return [Iso3166CountryCode1]
+    attr_accessor :country
+
+    # Text name for type of unit, such as Suite, Apt./Apartment, Room, Floor, or
+    # Dept./Department. Does not appear on tax forms, for use in creating a
+    # postal address from a tax form recipient address
+    # @return [String]
+    attr_accessor :unit_type
+
+    # The number component of the address location's unit, can contain letters
+    # as appropriate
+    # @return [String]
+    attr_accessor :unit_number
+
+    # Name line 1
+    # @return [String]
+    attr_accessor :name1
+
+    # Name line 2
+    # @return [String]
+    attr_accessor :name2
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['line1'] = 'line1'
+      @_hash['line2'] = 'line2'
+      @_hash['line3'] = 'line3'
+      @_hash['city'] = 'city'
+      @_hash['region'] = 'region'
+      @_hash['postal_code'] = 'postalCode'
+      @_hash['country'] = 'country'
+      @_hash['unit_type'] = 'unitType'
+      @_hash['unit_number'] = 'unitNumber'
+      @_hash['name1'] = 'name1'
+      @_hash['name2'] = 'name2'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        line1
+        line2
+        line3
+        city
+        region
+        postal_code
+        country
+        unit_type
+        unit_number
+        name1
+        name2
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(line1: SKIP, line2: SKIP, line3: SKIP, city: SKIP,
+                   region: SKIP, postal_code: SKIP, country: SKIP,
+                   unit_type: SKIP, unit_number: SKIP, name1: SKIP, name2: SKIP,
+                   additional_properties: nil)
+      # Add additional model properties to the instance
+      additional_properties = {} if additional_properties.nil?
+
+      @line1 = line1 unless line1 == SKIP
+      @line2 = line2 unless line2 == SKIP
+      @line3 = line3 unless line3 == SKIP
+      @city = city unless city == SKIP
+      @region = region unless region == SKIP
+      @postal_code = postal_code unless postal_code == SKIP
+      @country = country unless country == SKIP
+      @unit_type = unit_type unless unit_type == SKIP
+      @unit_number = unit_number unless unit_number == SKIP
+      @name1 = name1 unless name1 == SKIP
+      @name2 = name2 unless name2 == 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.
+      line1 = hash.key?('line1') ? hash['line1'] : SKIP
+      line2 = hash.key?('line2') ? hash['line2'] : SKIP
+      line3 = hash.key?('line3') ? hash['line3'] : SKIP
+      city = hash.key?('city') ? hash['city'] : SKIP
+      region = hash.key?('region') ? hash['region'] : SKIP
+      postal_code = hash.key?('postalCode') ? hash['postalCode'] : SKIP
+      country = hash.key?('country') ? hash['country'] : SKIP
+      unit_type = hash.key?('unitType') ? hash['unitType'] : SKIP
+      unit_number = hash.key?('unitNumber') ? hash['unitNumber'] : SKIP
+      name1 = hash.key?('name1') ? hash['name1'] : SKIP
+      name2 = hash.key?('name2') ? hash['name2'] : 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.
+      NameAndAddress1.new(line1: line1,
+                          line2: line2,
+                          line3: line3,
+                          city: city,
+                          region: region,
+                          postal_code: postal_code,
+                          country: country,
+                          unit_type: unit_type,
+                          unit_number: unit_number,
+                          name1: name1,
+                          name2: name2,
+                          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} line1: #{@line1}, line2: #{@line2}, line3: #{@line3}, city: #{@city},"\
+      " region: #{@region}, postal_code: #{@postal_code}, country: #{@country}, unit_type:"\
+      " #{@unit_type}, unit_number: #{@unit_number}, name1: #{@name1}, name2: #{@name2},"\
+      " 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} line1: #{@line1.inspect}, line2: #{@line2.inspect}, line3:"\
+      " #{@line3.inspect}, city: #{@city.inspect}, region: #{@region.inspect}, postal_code:"\
+      " #{@postal_code.inspect}, country: #{@country.inspect}, unit_type: #{@unit_type.inspect},"\
+      " unit_number: #{@unit_number.inspect}, name1: #{@name1.inspect}, name2: #{@name2.inspect},"\
+      " additional_properties: #{@additional_properties}>"
+    end
+  end
+end

data/lib/fdx_v660_api/models/notification_category.rb

@@ -0,0 +1,52 @@
+# fdx_v660_api
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+module FdxV660Api
+  # Category of Notification
+  class NotificationCategory
+    NOTIFICATION_CATEGORY = [
+      # TODO: Write general description for CONSENT
+      CONSENT = 'CONSENT'.freeze,
+
+      # TODO: Write general description for FRAUD
+      FRAUD = 'FRAUD'.freeze,
+
+      # TODO: Write general description for MAINTENANCE
+      MAINTENANCE = 'MAINTENANCE'.freeze,
+
+      # TODO: Write general description for NEW_DATA
+      NEW_DATA = 'NEW_DATA'.freeze,
+
+      # TODO: Write general description for SECURITY
+      SECURITY = 'SECURITY'.freeze,
+
+      # TODO: Write general description for TOKENIZED_ACCOUNT_NUMBER
+      TOKENIZED_ACCOUNT_NUMBER = 'TOKENIZED_ACCOUNT_NUMBER'.freeze
+    ].freeze
+
+    def self.validate(value)
+      return false if value.nil?
+
+      true
+    end
+
+    def self.from_value(value, default_value = CONSENT)
+      return default_value if value.nil?
+
+      str = value.to_s.strip
+
+      case str.downcase
+      when 'consent' then CONSENT
+      when 'fraud' then FRAUD
+      when 'maintenance' then MAINTENANCE
+      when 'new_data' then NEW_DATA
+      when 'security' then SECURITY
+      when 'tokenized_account_number' then TOKENIZED_ACCOUNT_NUMBER
+      else
+        default_value
+      end
+    end
+  end
+end

data/lib/fdx_v660_api/models/notification_category1.rb

@@ -0,0 +1,52 @@
+# fdx_v660_api
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+module FdxV660Api
+  # Category of notification
+  class NotificationCategory1
+    NOTIFICATION_CATEGORY1 = [
+      # TODO: Write general description for CONSENT
+      CONSENT = 'CONSENT'.freeze,
+
+      # TODO: Write general description for FRAUD
+      FRAUD = 'FRAUD'.freeze,
+
+      # TODO: Write general description for MAINTENANCE
+      MAINTENANCE = 'MAINTENANCE'.freeze,
+
+      # TODO: Write general description for NEW_DATA
+      NEW_DATA = 'NEW_DATA'.freeze,
+
+      # TODO: Write general description for SECURITY
+      SECURITY = 'SECURITY'.freeze,
+
+      # TODO: Write general description for TOKENIZED_ACCOUNT_NUMBER
+      TOKENIZED_ACCOUNT_NUMBER = 'TOKENIZED_ACCOUNT_NUMBER'.freeze
+    ].freeze
+
+    def self.validate(value)
+      return false if value.nil?
+
+      true
+    end
+
+    def self.from_value(value, default_value = CONSENT)
+      return default_value if value.nil?
+
+      str = value.to_s.strip
+
+      case str.downcase
+      when 'consent' then CONSENT
+      when 'fraud' then FRAUD
+      when 'maintenance' then MAINTENANCE
+      when 'new_data' then NEW_DATA
+      when 'security' then SECURITY
+      when 'tokenized_account_number' then TOKENIZED_ACCOUNT_NUMBER
+      else
+        default_value
+      end
+    end
+  end
+end

data/lib/fdx_v660_api/models/notification_entity.rb

@@ -0,0 +1,180 @@
+# fdx_v660_api
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+require 'date'
+module FdxV660Api
+  # Provides the base fields of a notification. Clients will read the EventType
+  # in `type` property to determine the expected notification payload
+  class NotificationEntity < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # Id of notification
+    # @return [String]
+    attr_accessor :notification_id
+
+    # The type of the event which the notification is about
+    # @return [EventType]
+    attr_accessor :type
+
+    # An optional initiator-defined event subtype code or description if the
+    # event type needs to be further categorized or described.
+    # @return [String]
+    attr_accessor :subtype
+
+    # Time notification was sent
+    # @return [DateTime]
+    attr_accessor :sent_on
+
+    # Category of notification
+    # @return [NotificationCategory1]
+    attr_accessor :category
+
+    # Notification severity
+    # @return [NotificationSeverity2]
+    attr_accessor :severity
+
+    # Notification priority
+    # @return [NotificationPriority2]
+    attr_accessor :priority
+
+    # Publisher of notification
+    # @return [PartyEntity1]
+    attr_accessor :publisher
+
+    # Subscriber to this notification
+    # @return [PartyEntity2]
+    attr_accessor :subscriber
+
+    # Notification-specific key-value paired data
+    # @return [NotificationPayloadEntity2]
+    attr_accessor :notification_payload
+
+    # URL to retrieve further details related to notification
+    # @return [HateoasLink3]
+    attr_accessor :url
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['notification_id'] = 'notificationId'
+      @_hash['type'] = 'type'
+      @_hash['subtype'] = 'subtype'
+      @_hash['sent_on'] = 'sentOn'
+      @_hash['category'] = 'category'
+      @_hash['severity'] = 'severity'
+      @_hash['priority'] = 'priority'
+      @_hash['publisher'] = 'publisher'
+      @_hash['subscriber'] = 'subscriber'
+      @_hash['notification_payload'] = 'notificationPayload'
+      @_hash['url'] = 'url'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        subtype
+        severity
+        priority
+        subscriber
+        url
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(notification_id:, type:, sent_on:, category:, publisher:,
+                   notification_payload:, subtype: SKIP, severity: SKIP,
+                   priority: SKIP, subscriber: SKIP, url: SKIP,
+                   additional_properties: nil)
+      # Add additional model properties to the instance
+      additional_properties = {} if additional_properties.nil?
+
+      @notification_id = notification_id
+      @type = type
+      @subtype = subtype unless subtype == SKIP
+      @sent_on = sent_on
+      @category = category
+      @severity = severity unless severity == SKIP
+      @priority = priority unless priority == SKIP
+      @publisher = publisher
+      @subscriber = subscriber unless subscriber == SKIP
+      @notification_payload = notification_payload
+      @url = url unless url == 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.
+      notification_id =
+        hash.key?('notificationId') ? hash['notificationId'] : nil
+      type = hash.key?('type') ? hash['type'] : nil
+      sent_on = if hash.key?('sentOn')
+                  (DateTimeHelper.from_rfc3339(hash['sentOn']) if hash['sentOn'])
+                end
+      category = hash.key?('category') ? hash['category'] : nil
+      publisher = PartyEntity1.from_hash(hash['publisher']) if hash['publisher']
+      notification_payload = NotificationPayloadEntity2.from_hash(hash['notificationPayload']) if
+        hash['notificationPayload']
+      subtype = hash.key?('subtype') ? hash['subtype'] : SKIP
+      severity = hash.key?('severity') ? hash['severity'] : SKIP
+      priority = hash.key?('priority') ? hash['priority'] : SKIP
+      subscriber = PartyEntity2.from_hash(hash['subscriber']) if hash['subscriber']
+      url = HateoasLink3.from_hash(hash['url']) if hash['url']
+
+      # 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.
+      NotificationEntity.new(notification_id: notification_id,
+                             type: type,
+                             sent_on: sent_on,
+                             category: category,
+                             publisher: publisher,
+                             notification_payload: notification_payload,
+                             subtype: subtype,
+                             severity: severity,
+                             priority: priority,
+                             subscriber: subscriber,
+                             url: url,
+                             additional_properties: additional_properties)
+    end
+
+    def to_custom_sent_on
+      DateTimeHelper.to_rfc3339(sent_on)
+    end
+
+    # Provides a human-readable string representation of the object.
+    def to_s
+      class_name = self.class.name.split('::').last
+      "<#{class_name} notification_id: #{@notification_id}, type: #{@type}, subtype: #{@subtype},"\
+      " sent_on: #{@sent_on}, category: #{@category}, severity: #{@severity}, priority:"\
+      " #{@priority}, publisher: #{@publisher}, subscriber: #{@subscriber}, notification_payload:"\
+      " #{@notification_payload}, url: #{@url}, 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} notification_id: #{@notification_id.inspect}, type: #{@type.inspect},"\
+      " subtype: #{@subtype.inspect}, sent_on: #{@sent_on.inspect}, category:"\
+      " #{@category.inspect}, severity: #{@severity.inspect}, priority: #{@priority.inspect},"\
+      " publisher: #{@publisher.inspect}, subscriber: #{@subscriber.inspect},"\
+      " notification_payload: #{@notification_payload.inspect}, url: #{@url.inspect},"\
+      " additional_properties: #{@additional_properties}>"
+    end
+  end
+end

data/lib/fdx_v660_api/models/notification_payload_entity.rb

@@ -0,0 +1,125 @@
+# fdx_v660_api
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+module FdxV660Api
+  # The payload data of event for which notification is being sent
+  class NotificationPayloadEntity < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # ID for the origination entity related to the notification
+    # @return [String]
+    attr_accessor :id
+
+    # Type of entity causing origination of the notification with the given ID
+    # @return [NotificationPayloadIdType2]
+    attr_accessor :id_type
+
+    # Reason and initiator of change event reported in this notification
+    # @return [LifecycleEventEntity1]
+    attr_accessor :event
+
+    # A single custom key-value pair for a notification. Deprecated in release
+    # v6.6 and replaced with `attributes` array
+    # @return [FiAttributeEntity1]
+    attr_accessor :custom_fields
+
+    # Array of custom key-value pairs for a notification
+    # @return [Array[FiAttributeEntity]]
+    attr_accessor :attributes
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['id'] = 'id'
+      @_hash['id_type'] = 'idType'
+      @_hash['event'] = 'event'
+      @_hash['custom_fields'] = 'customFields'
+      @_hash['attributes'] = 'attributes'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        id
+        id_type
+        event
+        custom_fields
+        attributes
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(id: SKIP, id_type: SKIP, event: SKIP, custom_fields: SKIP,
+                   attributes: SKIP, additional_properties: nil)
+      # Add additional model properties to the instance
+      additional_properties = {} if additional_properties.nil?
+
+      @id = id unless id == SKIP
+      @id_type = id_type unless id_type == SKIP
+      @event = event unless event == SKIP
+      @custom_fields = custom_fields unless custom_fields == SKIP
+      @attributes = attributes unless attributes == 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'] : SKIP
+      id_type = hash.key?('idType') ? hash['idType'] : SKIP
+      event = LifecycleEventEntity1.from_hash(hash['event']) if hash['event']
+      custom_fields = FiAttributeEntity1.from_hash(hash['customFields']) if hash['customFields']
+      # Parameter is an array, so we need to iterate through it
+      attributes = nil
+      unless hash['attributes'].nil?
+        attributes = []
+        hash['attributes'].each do |structure|
+          attributes << (FiAttributeEntity.from_hash(structure) if structure)
+        end
+      end
+
+      attributes = SKIP unless hash.key?('attributes')
+
+      # 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.
+      NotificationPayloadEntity.new(id: id,
+                                    id_type: id_type,
+                                    event: event,
+                                    custom_fields: custom_fields,
+                                    attributes: attributes,
+                                    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}, id_type: #{@id_type}, event: #{@event}, custom_fields:"\
+      " #{@custom_fields}, attributes: #{@attributes}, 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}, id_type: #{@id_type.inspect}, event: #{@event.inspect},"\
+      " custom_fields: #{@custom_fields.inspect}, attributes: #{@attributes.inspect},"\
+      " additional_properties: #{@additional_properties}>"
+    end
+  end
+end