fdx-api-sdk-ruby 1.0.0

data/lib/fdx_api/models/notification_entity.rb

@@ -0,0 +1,169 @@
+# fdx_api
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+require 'date'
+module FdxApi
+  # Provides the base fields of a notification. Clients will read the `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
+
+    # Type of notification
+    # @return [NotificationType]
+    attr_accessor :type
+
+    # 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 [PartyEntity]
+    attr_accessor :publisher
+
+    # Subscriber to this notification
+    # @return [PartyEntity]
+    attr_accessor :subscriber
+
+    # Notification-specific key-value paired data
+    # @return [NotificationPayloadEntity2]
+    attr_accessor :notification_payload
+
+    # URL to retrieve further details related to notification
+    # @return [HateoasLink]
+    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['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[
+        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:, 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
+      @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 = PartyEntity.from_hash(hash['publisher']) if hash['publisher']
+      notification_payload = NotificationPayloadEntity2.from_hash(hash['notificationPayload']) if
+        hash['notificationPayload']
+      severity = hash.key?('severity') ? hash['severity'] : SKIP
+      priority = hash.key?('priority') ? hash['priority'] : SKIP
+      subscriber = PartyEntity.from_hash(hash['subscriber']) if hash['subscriber']
+      url = HateoasLink.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,
+                             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}, 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},"\
+      " 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_api/models/notification_payload_entity.rb

@@ -0,0 +1,95 @@
+# fdx_api
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+module FdxApi
+  # Custom key-value pairs payload for a notification
+  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
+
+    # Custom key-value pairs for a notification
+    # @return [FiAttributeEntity]
+    attr_accessor :custom_fields
+
+    # 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['custom_fields'] = 'customFields'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        id
+        id_type
+        custom_fields
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(id: SKIP, id_type: SKIP, custom_fields: 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
+      @custom_fields = custom_fields unless custom_fields == 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
+      custom_fields = FiAttributeEntity.from_hash(hash['customFields']) if hash['customFields']
+
+      # 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,
+                                    custom_fields: custom_fields,
+                                    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}, custom_fields: #{@custom_fields},"\
+      " 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}, custom_fields:"\
+      " #{@custom_fields.inspect}, additional_properties: #{@additional_properties}>"
+    end
+  end
+end

data/lib/fdx_api/models/notification_payload_entity2.rb

@@ -0,0 +1,95 @@
+# fdx_api
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+module FdxApi
+  # 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
+
+    # Custom key-value pairs for a notification
+    # @return [FiAttributeEntity]
+    attr_accessor :custom_fields
+
+    # 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['custom_fields'] = 'customFields'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        id
+        id_type
+        custom_fields
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(id: SKIP, id_type: SKIP, custom_fields: 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
+      @custom_fields = custom_fields unless custom_fields == 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
+      custom_fields = FiAttributeEntity.from_hash(hash['customFields']) if hash['customFields']
+
+      # 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,
+                                     custom_fields: custom_fields,
+                                     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}, custom_fields: #{@custom_fields},"\
+      " 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}, custom_fields:"\
+      " #{@custom_fields.inspect}, additional_properties: #{@additional_properties}>"
+    end
+  end
+end

data/lib/fdx_api/models/notification_payload_id_type.rb

@@ -0,0 +1,32 @@
+# fdx_api
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+module FdxApi
+  # 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
+    ].freeze
+
+    def self.validate(value)
+      return false if value.nil?
+
+      true
+    end
+  end
+end

data/lib/fdx_api/models/notification_payload_id_type2.rb

@@ -0,0 +1,32 @@
+# fdx_api
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+module FdxApi
+  # 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
+    ].freeze
+
+    def self.validate(value)
+      return false if value.nil?
+
+      true
+    end
+  end
+end

data/lib/fdx_api/models/notification_priority.rb

@@ -0,0 +1,26 @@
+# fdx_api
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+module FdxApi
+  # 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
+  end
+end

data/lib/fdx_api/models/notification_priority2.rb

@@ -0,0 +1,26 @@
+# fdx_api
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+module FdxApi
+  # 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
+  end
+end

data/lib/fdx_api/models/notification_severity.rb

@@ -0,0 +1,32 @@
+# fdx_api
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+module FdxApi
+  # 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
+  end
+end

data/lib/fdx_api/models/notification_severity2.rb

@@ -0,0 +1,32 @@
+# fdx_api
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+module FdxApi
+  # 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
+  end
+end

data/lib/fdx_api/models/notification_subscription_entity.rb

@@ -0,0 +1,123 @@
+# fdx_api
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+module FdxApi
+  # Provides the fields of a notification subscription
+  class NotificationSubscriptionEntity < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # Type of notification
+    # @return [NotificationType]
+    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 [PartyEntity]
+    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 = PartyEntity.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