orb-apiamtic-sdk 0.0.1

data/lib/api_reference/models/scalable_matrix_with_unit_scaling_factor.rb

@@ -0,0 +1,109 @@
+# api_reference
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+module ApiReference
+  # Configuration for a single matrix scaling factor
+  class ScalableMatrixWithUnitScalingFactor < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # TODO: Write general description for this method
+    # @return [String]
+    attr_accessor :first_dimension_value
+
+    # TODO: Write general description for this method
+    # @return [String]
+    attr_accessor :second_dimension_value
+
+    # TODO: Write general description for this method
+    # @return [String]
+    attr_accessor :scaling_factor
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['first_dimension_value'] = 'first_dimension_value'
+      @_hash['second_dimension_value'] = 'second_dimension_value'
+      @_hash['scaling_factor'] = 'scaling_factor'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        second_dimension_value
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      %w[
+        second_dimension_value
+      ]
+    end
+
+    def initialize(first_dimension_value:, scaling_factor:,
+                   second_dimension_value: SKIP)
+      @first_dimension_value = first_dimension_value
+      @second_dimension_value = second_dimension_value unless second_dimension_value == SKIP
+      @scaling_factor = scaling_factor
+    end
+
+    # Creates an instance of the object from a hash.
+    def self.from_hash(hash)
+      return nil unless hash
+
+      # Extract variables from the hash.
+      first_dimension_value =
+        hash.key?('first_dimension_value') ? hash['first_dimension_value'] : nil
+      scaling_factor =
+        hash.key?('scaling_factor') ? hash['scaling_factor'] : nil
+      second_dimension_value =
+        hash.key?('second_dimension_value') ? hash['second_dimension_value'] : SKIP
+
+      # Create object from extracted values.
+      ScalableMatrixWithUnitScalingFactor.new(first_dimension_value: first_dimension_value,
+                                              scaling_factor: scaling_factor,
+                                              second_dimension_value: second_dimension_value)
+    end
+
+    # Validates an instance of the object from a given value.
+    # @param [ScalableMatrixWithUnitScalingFactor | Hash] The value against the validation is performed.
+    def self.validate(value)
+      if value.instance_of? self
+        return (
+          APIHelper.valid_type?(value.first_dimension_value,
+                                ->(val) { val.instance_of? String }) and
+            APIHelper.valid_type?(value.scaling_factor,
+                                  ->(val) { val.instance_of? String })
+        )
+      end
+
+      return false unless value.instance_of? Hash
+
+      (
+        APIHelper.valid_type?(value['first_dimension_value'],
+                              ->(val) { val.instance_of? String }) and
+          APIHelper.valid_type?(value['scaling_factor'],
+                                ->(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} first_dimension_value: #{@first_dimension_value}, second_dimension_value:"\
+      " #{@second_dimension_value}, scaling_factor: #{@scaling_factor}>"
+    end
+
+    # Provides a debugging-friendly string with detailed object information.
+    def inspect
+      class_name = self.class.name.split('::').last
+      "<#{class_name} first_dimension_value: #{@first_dimension_value.inspect},"\
+      " second_dimension_value: #{@second_dimension_value.inspect}, scaling_factor:"\
+      " #{@scaling_factor.inspect}>"
+    end
+  end
+end

data/lib/api_reference/models/set_default_version.rb

@@ -0,0 +1,60 @@
+# api_reference
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+module ApiReference
+  # SetDefaultVersion Model.
+  class SetDefaultVersion < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # Plan version to set as the default.
+    # @return [Integer]
+    attr_accessor :version
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['version'] = 'version'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      []
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(version:)
+      @version = version
+    end
+
+    # Creates an instance of the object from a hash.
+    def self.from_hash(hash)
+      return nil unless hash
+
+      # Extract variables from the hash.
+      version = hash.key?('version') ? hash['version'] : nil
+
+      # Create object from extracted values.
+      SetDefaultVersion.new(version: version)
+    end
+
+    # Provides a human-readable string representation of the object.
+    def to_s
+      class_name = self.class.name.split('::').last
+      "<#{class_name} version: #{@version}>"
+    end
+
+    # Provides a debugging-friendly string with detailed object information.
+    def inspect
+      class_name = self.class.name.split('::').last
+      "<#{class_name} version: #{@version.inspect}>"
+    end
+  end
+end

data/lib/api_reference/models/start_of_term.rb

@@ -0,0 +1,26 @@
+# api_reference
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+module ApiReference
+  # start_of_term.
+  class StartOfTerm
+    START_OF_TERM = [
+      # TODO: Write general description for START_OF_TERM
+      START_OF_TERM = 'start_of_term'.freeze
+    ].freeze
+
+    def self.validate(value)
+      return false if value.nil?
+
+      true
+    end
+
+    def self.from_value(value, default_value = START_OF_TERM)
+      return default_value if value.nil?
+
+      default_value
+    end
+  end
+end

data/lib/api_reference/models/status.rb

@@ -0,0 +1,40 @@
+# api_reference
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+module ApiReference
+  # Status.
+  class Status
+    STATUS = [
+      # TODO: Write general description for ACTIVE
+      ACTIVE = 'active'.freeze,
+
+      # TODO: Write general description for DRAFT
+      DRAFT = 'draft'.freeze,
+
+      # TODO: Write general description for ARCHIVED
+      ARCHIVED = 'archived'.freeze
+    ].freeze
+
+    def self.validate(value)
+      return false if value.nil?
+
+      true
+    end
+
+    def self.from_value(value, default_value = ACTIVE)
+      return default_value if value.nil?
+
+      str = value.to_s.strip
+
+      case str.downcase
+      when 'active' then ACTIVE
+      when 'draft' then DRAFT
+      when 'archived' then ARCHIVED
+      else
+        default_value
+      end
+    end
+  end
+end

data/lib/api_reference/models/status1.rb

@@ -0,0 +1,48 @@
+# api_reference
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+module ApiReference
+  # Status1.
+  class Status1
+    STATUS1 = [
+      # TODO: Write general description for ISSUED
+      ISSUED = 'issued'.freeze,
+
+      # TODO: Write general description for PAID
+      PAID = 'paid'.freeze,
+
+      # TODO: Write general description for SYNCED
+      SYNCED = 'synced'.freeze,
+
+      # TODO: Write general description for VOID
+      VOID = 'void'.freeze,
+
+      # TODO: Write general description for DRAFT
+      DRAFT = 'draft'.freeze
+    ].freeze
+
+    def self.validate(value)
+      return false if value.nil?
+
+      true
+    end
+
+    def self.from_value(value, default_value = ISSUED)
+      return default_value if value.nil?
+
+      str = value.to_s.strip
+
+      case str.downcase
+      when 'issued' then ISSUED
+      when 'paid' then PAID
+      when 'synced' then SYNCED
+      when 'void' then VOID
+      when 'draft' then DRAFT
+      else
+        default_value
+      end
+    end
+  end
+end

data/lib/api_reference/models/status10.rb

@@ -0,0 +1,40 @@
+# api_reference
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+module ApiReference
+  # The plan status to filter to ('active', 'archived', or 'draft').
+  class Status10
+    STATUS10 = [
+      # TODO: Write general description for ACTIVE
+      ACTIVE = 'active'.freeze,
+
+      # TODO: Write general description for ARCHIVED
+      ARCHIVED = 'archived'.freeze,
+
+      # TODO: Write general description for DRAFT
+      DRAFT = 'draft'.freeze
+    ].freeze
+
+    def self.validate(value)
+      return false if value.nil?
+
+      true
+    end
+
+    def self.from_value(value, default_value = ACTIVE)
+      return default_value if value.nil?
+
+      str = value.to_s.strip
+
+      case str.downcase
+      when 'active' then ACTIVE
+      when 'archived' then ARCHIVED
+      when 'draft' then DRAFT
+      else
+        default_value
+      end
+    end
+  end
+end

data/lib/api_reference/models/status11.rb

@@ -0,0 +1,48 @@
+# api_reference
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+module ApiReference
+  # Status_11.
+  class Status11
+    STATUS11 = [
+      # TODO: Write general description for DRAFT
+      DRAFT = 'draft'.freeze,
+
+      # TODO: Write general description for ISSUED
+      ISSUED = 'issued'.freeze,
+
+      # TODO: Write general description for PAID
+      PAID = 'paid'.freeze,
+
+      # TODO: Write general description for SYNCED
+      SYNCED = 'synced'.freeze,
+
+      # TODO: Write general description for VOID
+      VOID = 'void'.freeze
+    ].freeze
+
+    def self.validate(value)
+      return false if value.nil?
+
+      true
+    end
+
+    def self.from_value(value, default_value = DRAFT)
+      return default_value if value.nil?
+
+      str = value.to_s.strip
+
+      case str.downcase
+      when 'draft' then DRAFT
+      when 'issued' then ISSUED
+      when 'paid' then PAID
+      when 'synced' then SYNCED
+      when 'void' then VOID
+      else
+        default_value
+      end
+    end
+  end
+end

data/lib/api_reference/models/status12.rb

@@ -0,0 +1,40 @@
+# api_reference
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+module ApiReference
+  # Status12.
+  class Status12
+    STATUS12 = [
+      # TODO: Write general description for PENDING
+      PENDING = 'pending'.freeze,
+
+      # TODO: Write general description for APPLIED
+      APPLIED = 'applied'.freeze,
+
+      # TODO: Write general description for CANCELLED
+      CANCELLED = 'cancelled'.freeze
+    ].freeze
+
+    def self.validate(value)
+      return false if value.nil?
+
+      true
+    end
+
+    def self.from_value(value, default_value = PENDING)
+      return default_value if value.nil?
+
+      str = value.to_s.strip
+
+      case str.downcase
+      when 'pending' then PENDING
+      when 'applied' then APPLIED
+      when 'cancelled' then CANCELLED
+      else
+        default_value
+      end
+    end
+  end
+end

data/lib/api_reference/models/status13.rb

@@ -0,0 +1,40 @@
+# api_reference
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+module ApiReference
+  # Status13.
+  class Status13
+    STATUS13 = [
+      # TODO: Write general description for ACTIVE
+      ACTIVE = 'active'.freeze,
+
+      # TODO: Write general description for ENDED
+      ENDED = 'ended'.freeze,
+
+      # TODO: Write general description for UPCOMING
+      UPCOMING = 'upcoming'.freeze
+    ].freeze
+
+    def self.validate(value)
+      return false if value.nil?
+
+      true
+    end
+
+    def self.from_value(value, default_value = ACTIVE)
+      return default_value if value.nil?
+
+      str = value.to_s.strip
+
+      case str.downcase
+      when 'active' then ACTIVE
+      when 'ended' then ENDED
+      when 'upcoming' then UPCOMING
+      else
+        default_value
+      end
+    end
+  end
+end

data/lib/api_reference/models/status14.rb

@@ -0,0 +1,40 @@
+# api_reference
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+module ApiReference
+  # Status_14.
+  class Status14
+    STATUS14 = [
+      # TODO: Write general description for ACTIVE
+      ACTIVE = 'active'.freeze,
+
+      # TODO: Write general description for ENDED
+      ENDED = 'ended'.freeze,
+
+      # TODO: Write general description for UPCOMING
+      UPCOMING = 'upcoming'.freeze
+    ].freeze
+
+    def self.validate(value)
+      return false if value.nil?
+
+      true
+    end
+
+    def self.from_value(value, default_value = ACTIVE)
+      return default_value if value.nil?
+
+      str = value.to_s.strip
+
+      case str.downcase
+      when 'active' then ACTIVE
+      when 'ended' then ENDED
+      when 'upcoming' then UPCOMING
+      else
+        default_value
+      end
+    end
+  end
+end

data/lib/api_reference/models/status17.rb

@@ -0,0 +1,37 @@
+# api_reference
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+module ApiReference
+  # The status of the plan to create (either active or draft). If not specified,
+  # this defaults to active.
+  class Status17
+    STATUS17 = [
+      # TODO: Write general description for ACTIVE
+      ACTIVE = 'active'.freeze,
+
+      # TODO: Write general description for DRAFT
+      DRAFT = 'draft'.freeze
+    ].freeze
+
+    def self.validate(value)
+      return false if value.nil?
+
+      true
+    end
+
+    def self.from_value(value, default_value = ACTIVE)
+      return default_value if value.nil?
+
+      str = value.to_s.strip
+
+      case str.downcase
+      when 'active' then ACTIVE
+      when 'draft' then DRAFT
+      else
+        default_value
+      end
+    end
+  end
+end

data/lib/api_reference/models/status18.rb

@@ -0,0 +1,49 @@
+# api_reference
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+module ApiReference
+  # Current status of the migration: 'not_started', 'in_progress', 'completed',
+  # 'action_needed', or 'canceled'.
+  class Status18
+    STATUS18 = [
+      # TODO: Write general description for NOT_STARTED
+      NOT_STARTED = 'not_started'.freeze,
+
+      # TODO: Write general description for IN_PROGRESS
+      IN_PROGRESS = 'in_progress'.freeze,
+
+      # TODO: Write general description for COMPLETED
+      COMPLETED = 'completed'.freeze,
+
+      # TODO: Write general description for ACTION_NEEDED
+      ACTION_NEEDED = 'action_needed'.freeze,
+
+      # TODO: Write general description for CANCELED
+      CANCELED = 'canceled'.freeze
+    ].freeze
+
+    def self.validate(value)
+      return false if value.nil?
+
+      true
+    end
+
+    def self.from_value(value, default_value = NOT_STARTED)
+      return default_value if value.nil?
+
+      str = value.to_s.strip
+
+      case str.downcase
+      when 'not_started' then NOT_STARTED
+      when 'in_progress' then IN_PROGRESS
+      when 'completed' then COMPLETED
+      when 'action_needed' then ACTION_NEEDED
+      when 'canceled' then CANCELED
+      else
+        default_value
+      end
+    end
+  end
+end

data/lib/api_reference/models/status23.rb

@@ -0,0 +1,48 @@
+# api_reference
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+module ApiReference
+  # Status[]23.
+  class Status23
+    STATUS23 = [
+      # TODO: Write general description for DRAFT
+      DRAFT = 'draft'.freeze,
+
+      # TODO: Write general description for ISSUED
+      ISSUED = 'issued'.freeze,
+
+      # TODO: Write general description for PAID
+      PAID = 'paid'.freeze,
+
+      # TODO: Write general description for SYNCED
+      SYNCED = 'synced'.freeze,
+
+      # TODO: Write general description for VOID
+      VOID = 'void'.freeze
+    ].freeze
+
+    def self.validate(value)
+      return false if value.nil?
+
+      true
+    end
+
+    def self.from_value(value, default_value = DRAFT)
+      return default_value if value.nil?
+
+      str = value.to_s.strip
+
+      case str.downcase
+      when 'draft' then DRAFT
+      when 'issued' then ISSUED
+      when 'paid' then PAID
+      when 'synced' then SYNCED
+      when 'void' then VOID
+      else
+        default_value
+      end
+    end
+  end
+end

data/lib/api_reference/models/status28.rb

@@ -0,0 +1,40 @@
+# api_reference
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+module ApiReference
+  # Status[]28.
+  class Status28
+    STATUS28 = [
+      # TODO: Write general description for ACTIVE
+      ACTIVE = 'active'.freeze,
+
+      # TODO: Write general description for ENDED
+      ENDED = 'ended'.freeze,
+
+      # TODO: Write general description for UPCOMING
+      UPCOMING = 'upcoming'.freeze
+    ].freeze
+
+    def self.validate(value)
+      return false if value.nil?
+
+      true
+    end
+
+    def self.from_value(value, default_value = ACTIVE)
+      return default_value if value.nil?
+
+      str = value.to_s.strip
+
+      case str.downcase
+      when 'active' then ACTIVE
+      when 'ended' then ENDED
+      when 'upcoming' then UPCOMING
+      else
+        default_value
+      end
+    end
+  end
+end