apimatic-mx-apis-sdk 0.0.1

data/lib/mx_platform_api/models/category_response_body.rb

@@ -0,0 +1,75 @@
+# mx_platform_api
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+module MxPlatformApi
+  # CategoryResponseBody Model.
+  class CategoryResponseBody < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # TODO: Write general description for this method
+    # @return [CategoryResponse]
+    attr_accessor :category
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['category'] = 'category'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        category
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(category: SKIP, additional_properties: nil)
+      # Add additional model properties to the instance
+      additional_properties = {} if additional_properties.nil?
+
+      @category = category unless category == 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.
+      category = CategoryResponse.from_hash(hash['category']) if hash['category']
+
+      # 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.
+      CategoryResponseBody.new(category: category,
+                               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} category: #{@category}, 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} category: #{@category.inspect}, additional_properties:"\
+      " #{@additional_properties}>"
+    end
+  end
+end

data/lib/mx_platform_api/models/category_update_request.rb

@@ -0,0 +1,85 @@
+# mx_platform_api
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+module MxPlatformApi
+  # CategoryUpdateRequest Model.
+  class CategoryUpdateRequest < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # Additional information you can store on the `category`.
+    # @return [String]
+    attr_accessor :metadata
+
+    # The name of the category.
+    # @return [String]
+    attr_accessor :name
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['metadata'] = 'metadata'
+      @_hash['name'] = 'name'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        metadata
+        name
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(metadata: SKIP, name: SKIP, additional_properties: nil)
+      # Add additional model properties to the instance
+      additional_properties = {} if additional_properties.nil?
+
+      @metadata = metadata unless metadata == SKIP
+      @name = name unless name == 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.
+      metadata = hash.key?('metadata') ? hash['metadata'] : SKIP
+      name = hash.key?('name') ? hash['name'] : 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.
+      CategoryUpdateRequest.new(metadata: metadata,
+                                name: name,
+                                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} metadata: #{@metadata}, name: #{@name}, 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} metadata: #{@metadata.inspect}, name: #{@name.inspect},"\
+      " additional_properties: #{@additional_properties}>"
+    end
+  end
+end

data/lib/mx_platform_api/models/category_update_request_body.rb

@@ -0,0 +1,75 @@
+# mx_platform_api
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+module MxPlatformApi
+  # CategoryUpdateRequestBody Model.
+  class CategoryUpdateRequestBody < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # TODO: Write general description for this method
+    # @return [CategoryUpdateRequest]
+    attr_accessor :category
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['category'] = 'category'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        category
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(category: SKIP, additional_properties: nil)
+      # Add additional model properties to the instance
+      additional_properties = {} if additional_properties.nil?
+
+      @category = category unless category == 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.
+      category = CategoryUpdateRequest.from_hash(hash['category']) if hash['category']
+
+      # 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.
+      CategoryUpdateRequestBody.new(category: category,
+                                    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} category: #{@category}, 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} category: #{@category.inspect}, additional_properties:"\
+      " #{@additional_properties}>"
+    end
+  end
+end

data/lib/mx_platform_api/models/challenge_response.rb

@@ -0,0 +1,159 @@
+# mx_platform_api
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+module MxPlatformApi
+  # ChallengeResponse Model.
+  class ChallengeResponse < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # TODO: Write general description for this method
+    # @return [String]
+    attr_accessor :field_name
+
+    # TODO: Write general description for this method
+    # @return [String]
+    attr_accessor :guid
+
+    # TODO: Write general description for this method
+    # @return [String]
+    attr_accessor :image_data
+
+    # TODO: Write general description for this method
+    # @return [Array[ImageOptionResponse]]
+    attr_accessor :image_options
+
+    # TODO: Write general description for this method
+    # @return [String]
+    attr_accessor :label
+
+    # TODO: Write general description for this method
+    # @return [Array[OptionResponse]]
+    attr_accessor :options
+
+    # TODO: Write general description for this method
+    # @return [String]
+    attr_accessor :type
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['field_name'] = 'field_name'
+      @_hash['guid'] = 'guid'
+      @_hash['image_data'] = 'image_data'
+      @_hash['image_options'] = 'image_options'
+      @_hash['label'] = 'label'
+      @_hash['options'] = 'options'
+      @_hash['type'] = 'type'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        field_name
+        guid
+        image_data
+        image_options
+        label
+        options
+        type
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      %w[
+        field_name
+        guid
+        image_data
+        label
+        type
+      ]
+    end
+
+    def initialize(field_name: SKIP, guid: SKIP, image_data: SKIP,
+                   image_options: SKIP, label: SKIP, options: SKIP, type: SKIP,
+                   additional_properties: nil)
+      # Add additional model properties to the instance
+      additional_properties = {} if additional_properties.nil?
+
+      @field_name = field_name unless field_name == SKIP
+      @guid = guid unless guid == SKIP
+      @image_data = image_data unless image_data == SKIP
+      @image_options = image_options unless image_options == SKIP
+      @label = label unless label == SKIP
+      @options = options unless options == SKIP
+      @type = type unless type == 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.
+      field_name = hash.key?('field_name') ? hash['field_name'] : SKIP
+      guid = hash.key?('guid') ? hash['guid'] : SKIP
+      image_data = hash.key?('image_data') ? hash['image_data'] : SKIP
+      # Parameter is an array, so we need to iterate through it
+      image_options = nil
+      unless hash['image_options'].nil?
+        image_options = []
+        hash['image_options'].each do |structure|
+          image_options << (ImageOptionResponse.from_hash(structure) if structure)
+        end
+      end
+
+      image_options = SKIP unless hash.key?('image_options')
+      label = hash.key?('label') ? hash['label'] : SKIP
+      # Parameter is an array, so we need to iterate through it
+      options = nil
+      unless hash['options'].nil?
+        options = []
+        hash['options'].each do |structure|
+          options << (OptionResponse.from_hash(structure) if structure)
+        end
+      end
+
+      options = SKIP unless hash.key?('options')
+      type = hash.key?('type') ? hash['type'] : 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.
+      ChallengeResponse.new(field_name: field_name,
+                            guid: guid,
+                            image_data: image_data,
+                            image_options: image_options,
+                            label: label,
+                            options: options,
+                            type: type,
+                            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} field_name: #{@field_name}, guid: #{@guid}, image_data: #{@image_data},"\
+      " image_options: #{@image_options}, label: #{@label}, options: #{@options}, type: #{@type},"\
+      " 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} field_name: #{@field_name.inspect}, guid: #{@guid.inspect}, image_data:"\
+      " #{@image_data.inspect}, image_options: #{@image_options.inspect}, label:"\
+      " #{@label.inspect}, options: #{@options.inspect}, type: #{@type.inspect},"\
+      " additional_properties: #{@additional_properties}>"
+    end
+  end
+end

data/lib/mx_platform_api/models/challenges_response_body.rb

@@ -0,0 +1,95 @@
+# mx_platform_api
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+module MxPlatformApi
+  # ChallengesResponseBody Model.
+  class ChallengesResponseBody < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # TODO: Write general description for this method
+    # @return [Array[ChallengeResponse]]
+    attr_accessor :challenges
+
+    # TODO: Write general description for this method
+    # @return [PaginationResponse]
+    attr_accessor :pagination
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['challenges'] = 'challenges'
+      @_hash['pagination'] = 'pagination'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        challenges
+        pagination
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(challenges: SKIP, pagination: SKIP,
+                   additional_properties: nil)
+      # Add additional model properties to the instance
+      additional_properties = {} if additional_properties.nil?
+
+      @challenges = challenges unless challenges == SKIP
+      @pagination = pagination unless pagination == 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.
+      # Parameter is an array, so we need to iterate through it
+      challenges = nil
+      unless hash['challenges'].nil?
+        challenges = []
+        hash['challenges'].each do |structure|
+          challenges << (ChallengeResponse.from_hash(structure) if structure)
+        end
+      end
+
+      challenges = SKIP unless hash.key?('challenges')
+      pagination = PaginationResponse.from_hash(hash['pagination']) if hash['pagination']
+
+      # 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.
+      ChallengesResponseBody.new(challenges: challenges,
+                                 pagination: pagination,
+                                 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} challenges: #{@challenges}, pagination: #{@pagination},"\
+      " 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} challenges: #{@challenges.inspect}, pagination: #{@pagination.inspect},"\
+      " additional_properties: #{@additional_properties}>"
+    end
+  end
+end

data/lib/mx_platform_api/models/channel.rb

@@ -0,0 +1,47 @@
+# mx_platform_api
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+module MxPlatformApi
+  # The way the notification will be delivered to the user. All notifications
+  # created through the API will be of notification type `API_NOTIFICATION`,
+  # channel `PUSH`, and will not be associated to an entity. No other channels
+  # are supported.
+  class Channel
+    CHANNEL = [
+      # TODO: Write general description for EMAIL
+      EMAIL = 'EMAIL'.freeze,
+
+      # TODO: Write general description for SMS
+      SMS = 'SMS'.freeze,
+
+      # TODO: Write general description for PUSH
+      PUSH = 'PUSH'.freeze,
+
+      # TODO: Write general description for IN_APP
+      IN_APP = 'IN_APP'.freeze
+    ].freeze
+
+    def self.validate(value)
+      return false if value.nil?
+
+      CHANNEL.include?(value)
+    end
+
+    def self.from_value(value, default_value = EMAIL)
+      return default_value if value.nil?
+
+      str = value.to_s.strip
+
+      case str.downcase
+      when 'email' then EMAIL
+      when 'sms' then SMS
+      when 'push' then PUSH
+      when 'in_app' then IN_APP
+      else
+        default_value
+      end
+    end
+  end
+end

data/lib/mx_platform_api/models/classification.rb

@@ -0,0 +1,85 @@
+# mx_platform_api
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+module MxPlatformApi
+  # Classification Model.
+  class Classification < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # TODO: Write general description for this method
+    # @return [ParentClass]
+    attr_accessor :parent_class
+
+    # TODO: Write general description for this method
+    # @return [String]
+    attr_accessor :guid
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['parent_class'] = 'parent_class'
+      @_hash['guid'] = 'guid'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        parent_class
+        guid
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(parent_class: SKIP, guid: SKIP, additional_properties: nil)
+      # Add additional model properties to the instance
+      additional_properties = {} if additional_properties.nil?
+
+      @parent_class = parent_class unless parent_class == SKIP
+      @guid = guid unless guid == 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.
+      parent_class = hash.key?('parent_class') ? hash['parent_class'] : SKIP
+      guid = hash.key?('guid') ? hash['guid'] : 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.
+      Classification.new(parent_class: parent_class,
+                         guid: guid,
+                         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} parent_class: #{@parent_class}, guid: #{@guid}, 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} parent_class: #{@parent_class.inspect}, guid: #{@guid.inspect},"\
+      " additional_properties: #{@additional_properties}>"
+    end
+  end
+end

data/lib/mx_platform_api/models/color_scheme.rb

@@ -0,0 +1,43 @@
+# mx_platform_api
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+module MxPlatformApi
+  # This option can be passed to any `widget_type` but will not affect [legacy
+  # PFM widgets](/products/experience/pfm/legacy-widget-overviews/). Load the
+  # widget with the specified `color_scheme`; options are `light`, `dark`, and
+  # `browser` (respects user's browser setting). Defaults to `light`.
+  class ColorScheme
+    COLOR_SCHEME = [
+      # TODO: Write general description for LIGHT
+      LIGHT = 'light'.freeze,
+
+      # TODO: Write general description for BROWSER
+      BROWSER = 'browser'.freeze,
+
+      # TODO: Write general description for DARK
+      DARK = 'dark'.freeze
+    ].freeze
+
+    def self.validate(value)
+      return false if value.nil?
+
+      COLOR_SCHEME.include?(value)
+    end
+
+    def self.from_value(value, default_value = LIGHT)
+      return default_value if value.nil?
+
+      str = value.to_s.strip
+
+      case str.downcase
+      when 'light' then LIGHT
+      when 'browser' then BROWSER
+      when 'dark' then DARK
+      else
+        default_value
+      end
+    end
+  end
+end