fdx-apimatic-sdk 0.0.1

data/lib/fdx_v660_api/models/notification_payload_entity2.rb

@@ -0,0 +1,125 @@
+# fdx_v660_api
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+module FdxV660Api
+  # Notification-specific key-value paired data
+  class NotificationPayloadEntity2 < 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.
+      NotificationPayloadEntity2.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

data/lib/fdx_v660_api/models/notification_payload_id_type.rb

@@ -0,0 +1,56 @@
+# fdx_v660_api
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+module FdxV660Api
+  # Type of entity causing origination of a notification
+  class NotificationPayloadIdType
+    NOTIFICATION_PAYLOAD_ID_TYPE = [
+      # TODO: Write general description for ACCOUNT
+      ACCOUNT = 'ACCOUNT'.freeze,
+
+      # TODO: Write general description for CONSENT
+      CONSENT = 'CONSENT'.freeze,
+
+      # TODO: Write general description for CUSTOMER
+      CUSTOMER = 'CUSTOMER'.freeze,
+
+      # TODO: Write general description for MAINTENANCE
+      MAINTENANCE = 'MAINTENANCE'.freeze,
+
+      # TODO: Write general description for PARTY
+      PARTY = 'PARTY'.freeze,
+
+      # TODO: Write general description for PAYMENT_NETWORK
+      PAYMENT_NETWORK = 'PAYMENT_NETWORK'.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 = ACCOUNT)
+      return default_value if value.nil?
+
+      str = value.to_s.strip
+
+      case str.downcase
+      when 'account' then ACCOUNT
+      when 'consent' then CONSENT
+      when 'customer' then CUSTOMER
+      when 'maintenance' then MAINTENANCE
+      when 'party' then PARTY
+      when 'payment_network' then PAYMENT_NETWORK
+      when 'tokenized_account_number' then TOKENIZED_ACCOUNT_NUMBER
+      else
+        default_value
+      end
+    end
+  end
+end

data/lib/fdx_v660_api/models/notification_payload_id_type2.rb

@@ -0,0 +1,56 @@
+# fdx_v660_api
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+module FdxV660Api
+  # Type of entity causing origination of the notification with the given ID
+  class NotificationPayloadIdType2
+    NOTIFICATION_PAYLOAD_ID_TYPE2 = [
+      # TODO: Write general description for ACCOUNT
+      ACCOUNT = 'ACCOUNT'.freeze,
+
+      # TODO: Write general description for CONSENT
+      CONSENT = 'CONSENT'.freeze,
+
+      # TODO: Write general description for CUSTOMER
+      CUSTOMER = 'CUSTOMER'.freeze,
+
+      # TODO: Write general description for MAINTENANCE
+      MAINTENANCE = 'MAINTENANCE'.freeze,
+
+      # TODO: Write general description for PARTY
+      PARTY = 'PARTY'.freeze,
+
+      # TODO: Write general description for PAYMENT_NETWORK
+      PAYMENT_NETWORK = 'PAYMENT_NETWORK'.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 = ACCOUNT)
+      return default_value if value.nil?
+
+      str = value.to_s.strip
+
+      case str.downcase
+      when 'account' then ACCOUNT
+      when 'consent' then CONSENT
+      when 'customer' then CUSTOMER
+      when 'maintenance' then MAINTENANCE
+      when 'party' then PARTY
+      when 'payment_network' then PAYMENT_NETWORK
+      when 'tokenized_account_number' then TOKENIZED_ACCOUNT_NUMBER
+      else
+        default_value
+      end
+    end
+  end
+end

data/lib/fdx_v660_api/models/notification_priority.rb

@@ -0,0 +1,40 @@
+# fdx_v660_api
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+module FdxV660Api
+  # Priority of notification
+  class NotificationPriority
+    NOTIFICATION_PRIORITY = [
+      # TODO: Write general description for HIGH
+      HIGH = 'HIGH'.freeze,
+
+      # TODO: Write general description for MEDIUM
+      MEDIUM = 'MEDIUM'.freeze,
+
+      # TODO: Write general description for LOW
+      LOW = 'LOW'.freeze
+    ].freeze
+
+    def self.validate(value)
+      return false if value.nil?
+
+      true
+    end
+
+    def self.from_value(value, default_value = HIGH)
+      return default_value if value.nil?
+
+      str = value.to_s.strip
+
+      case str.downcase
+      when 'high' then HIGH
+      when 'medium' then MEDIUM
+      when 'low' then LOW
+      else
+        default_value
+      end
+    end
+  end
+end

data/lib/fdx_v660_api/models/notification_priority2.rb

@@ -0,0 +1,40 @@
+# fdx_v660_api
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+module FdxV660Api
+  # Notification priority
+  class NotificationPriority2
+    NOTIFICATION_PRIORITY2 = [
+      # TODO: Write general description for HIGH
+      HIGH = 'HIGH'.freeze,
+
+      # TODO: Write general description for MEDIUM
+      MEDIUM = 'MEDIUM'.freeze,
+
+      # TODO: Write general description for LOW
+      LOW = 'LOW'.freeze
+    ].freeze
+
+    def self.validate(value)
+      return false if value.nil?
+
+      true
+    end
+
+    def self.from_value(value, default_value = HIGH)
+      return default_value if value.nil?
+
+      str = value.to_s.strip
+
+      case str.downcase
+      when 'high' then HIGH
+      when 'medium' then MEDIUM
+      when 'low' then LOW
+      else
+        default_value
+      end
+    end
+  end
+end

data/lib/fdx_v660_api/models/notification_severity.rb

@@ -0,0 +1,48 @@
+# fdx_v660_api
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+module FdxV660Api
+  # Severity level of notification
+  class NotificationSeverity
+    NOTIFICATION_SEVERITY = [
+      # TODO: Write general description for EMERGENCY
+      EMERGENCY = 'EMERGENCY'.freeze,
+
+      # TODO: Write general description for ALERT
+      ALERT = 'ALERT'.freeze,
+
+      # TODO: Write general description for WARNING
+      WARNING = 'WARNING'.freeze,
+
+      # TODO: Write general description for NOTICE
+      NOTICE = 'NOTICE'.freeze,
+
+      # TODO: Write general description for INFO
+      INFO = 'INFO'.freeze
+    ].freeze
+
+    def self.validate(value)
+      return false if value.nil?
+
+      true
+    end
+
+    def self.from_value(value, default_value = EMERGENCY)
+      return default_value if value.nil?
+
+      str = value.to_s.strip
+
+      case str.downcase
+      when 'emergency' then EMERGENCY
+      when 'alert' then ALERT
+      when 'warning' then WARNING
+      when 'notice' then NOTICE
+      when 'info' then INFO
+      else
+        default_value
+      end
+    end
+  end
+end

data/lib/fdx_v660_api/models/notification_severity2.rb

@@ -0,0 +1,48 @@
+# fdx_v660_api
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+module FdxV660Api
+  # Notification severity
+  class NotificationSeverity2
+    NOTIFICATION_SEVERITY2 = [
+      # TODO: Write general description for EMERGENCY
+      EMERGENCY = 'EMERGENCY'.freeze,
+
+      # TODO: Write general description for ALERT
+      ALERT = 'ALERT'.freeze,
+
+      # TODO: Write general description for WARNING
+      WARNING = 'WARNING'.freeze,
+
+      # TODO: Write general description for NOTICE
+      NOTICE = 'NOTICE'.freeze,
+
+      # TODO: Write general description for INFO
+      INFO = 'INFO'.freeze
+    ].freeze
+
+    def self.validate(value)
+      return false if value.nil?
+
+      true
+    end
+
+    def self.from_value(value, default_value = EMERGENCY)
+      return default_value if value.nil?
+
+      str = value.to_s.strip
+
+      case str.downcase
+      when 'emergency' then EMERGENCY
+      when 'alert' then ALERT
+      when 'warning' then WARNING
+      when 'notice' then NOTICE
+      when 'info' then INFO
+      else
+        default_value
+      end
+    end
+  end
+end

data/lib/fdx_v660_api/models/notification_subscription_entity.rb

@@ -0,0 +1,123 @@
+# fdx_v660_api
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+module FdxV660Api
+  # Provides the fields of a notification subscription
+  class NotificationSubscriptionEntity < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # Type of notification
+    # @return [EventType1]
+    attr_accessor :type
+
+    # Category of notification
+    # @return [NotificationCategory1]
+    attr_accessor :category
+
+    # Callback URL. Previous callback URL will be updated with latest.
+    # @return [String]
+    attr_accessor :callback_url
+
+    # The Party who is subscribing to the notification
+    # @return [PartyEntity3]
+    attr_accessor :subscriber
+
+    # Effective date of notification
+    # @return [Date]
+    attr_accessor :effective_date
+
+    # Subscription id of notification
+    # @return [String]
+    attr_accessor :subscription_id
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['type'] = 'type'
+      @_hash['category'] = 'category'
+      @_hash['callback_url'] = 'callbackUrl'
+      @_hash['subscriber'] = 'subscriber'
+      @_hash['effective_date'] = 'effectiveDate'
+      @_hash['subscription_id'] = 'subscriptionId'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        effective_date
+        subscription_id
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(type:, category:, callback_url:, subscriber:,
+                   effective_date: SKIP, subscription_id: SKIP,
+                   additional_properties: nil)
+      # Add additional model properties to the instance
+      additional_properties = {} if additional_properties.nil?
+
+      @type = type
+      @category = category
+      @callback_url = callback_url
+      @subscriber = subscriber
+      @effective_date = effective_date unless effective_date == SKIP
+      @subscription_id = subscription_id unless subscription_id == 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.
+      type = hash.key?('type') ? hash['type'] : nil
+      category = hash.key?('category') ? hash['category'] : nil
+      callback_url = hash.key?('callbackUrl') ? hash['callbackUrl'] : nil
+      subscriber = PartyEntity3.from_hash(hash['subscriber']) if hash['subscriber']
+      effective_date = hash.key?('effectiveDate') ? hash['effectiveDate'] : SKIP
+      subscription_id =
+        hash.key?('subscriptionId') ? hash['subscriptionId'] : 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.
+      NotificationSubscriptionEntity.new(type: type,
+                                         category: category,
+                                         callback_url: callback_url,
+                                         subscriber: subscriber,
+                                         effective_date: effective_date,
+                                         subscription_id: subscription_id,
+                                         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} type: #{@type}, category: #{@category}, callback_url: #{@callback_url},"\
+      " subscriber: #{@subscriber}, effective_date: #{@effective_date}, subscription_id:"\
+      " #{@subscription_id}, 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}, category: #{@category.inspect}, callback_url:"\
+      " #{@callback_url.inspect}, subscriber: #{@subscriber.inspect}, effective_date:"\
+      " #{@effective_date.inspect}, subscription_id: #{@subscription_id.inspect},"\
+      " additional_properties: #{@additional_properties}>"
+    end
+  end
+end

data/lib/fdx_v660_api/models/notifications_entity.rb

@@ -0,0 +1,104 @@
+# fdx_v660_api
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+module FdxV660Api
+  # A paginated array of Notifications
+  class NotificationsEntity < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # Page keys for navigating result sets
+    # @return [PageMetadata]
+    attr_accessor :page
+
+    # Resource URLs for navigating result sets
+    # @return [PageMetadataLinks1]
+    attr_accessor :links
+
+    # An array of Notifications
+    # @return [Array[NotificationEntity]]
+    attr_accessor :notifications
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['page'] = 'page'
+      @_hash['links'] = 'links'
+      @_hash['notifications'] = 'notifications'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        page
+        links
+        notifications
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(page: SKIP, links: SKIP, notifications: SKIP,
+                   additional_properties: nil)
+      # Add additional model properties to the instance
+      additional_properties = {} if additional_properties.nil?
+
+      @page = page unless page == SKIP
+      @links = links unless links == SKIP
+      @notifications = notifications unless notifications == 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.
+      page = PageMetadata.from_hash(hash['page']) if hash['page']
+      links = PageMetadataLinks1.from_hash(hash['links']) if hash['links']
+      # Parameter is an array, so we need to iterate through it
+      notifications = nil
+      unless hash['notifications'].nil?
+        notifications = []
+        hash['notifications'].each do |structure|
+          notifications << (NotificationEntity.from_hash(structure) if structure)
+        end
+      end
+
+      notifications = SKIP unless hash.key?('notifications')
+
+      # 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.
+      NotificationsEntity.new(page: page,
+                              links: links,
+                              notifications: notifications,
+                              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} page: #{@page}, links: #{@links}, notifications: #{@notifications},"\
+      " 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} page: #{@page.inspect}, links: #{@links.inspect}, notifications:"\
+      " #{@notifications.inspect}, additional_properties: #{@additional_properties}>"
+    end
+  end
+end