flat_api 0.3.5 → 1.0.0

data/lib/flat_api/models/omr_instrument_override.rb

@@ -0,0 +1,311 @@
+=begin
+#Flat API
+
+#The Flat API allows you to easily extend the abilities of the [Flat Platform](https://flat.io), with a wide range of use cases including the following:  * Creating and importing new music scores using MusicXML, MIDI, Guitar Pro, MuseScore, ABC notation, and many other formats * Browsing, updating, copying, exporting the user's scores (for example in MP3, WAV or MIDI) * Managing educational resources with Flat for Education: creating & updating the organization accounts, the classes, rosters and assignments.  The Flat API is built on HTTP. Our API is RESTful It has predictable resource URLs. It returns HTTP response codes to indicate errors. It also accepts and returns JSON in the HTTP body. The [schema](/swagger.yaml) of this API follows the [OpenAPI Initiative (OAI) specification](https://www.openapis.org/), you can use and work with [compatible Swagger tools](http://swagger.io/open-source-integrations/). This API features Cross-Origin Resource Sharing (CORS) implemented in compliance with [W3C spec](https://www.w3.org/TR/cors/).  You can use your favorite HTTP/REST library for your programming language to use Flat's API. This specification and reference is [available on Github](https://github.com/FlatIO/api-reference).  Getting Started and learn more:  * [API Overview and introduction](https://flat.io/developers/docs/api/) * [Authentication (Personal Access Tokens or OAuth2)](https://flat.io/developers/docs/api/authentication.html) * [SDKs](https://flat.io/developers/docs/api/sdks.html) * [Rate Limits](https://flat.io/developers/docs/api/rate-limits.html) * [Changelog](https://flat.io/developers/docs/api/changelog.html) 
+
+The version of the OpenAPI document: 2.26.1
+Contact: developers@flat.io
+Generated by: https://openapi-generator.tech
+Generator version: 7.24.0
+
+=end
+
+require 'date'
+require 'time'
+
+module FlatApi
+  # Override for a single detected part, matched by `index`. Omitted fields keep the detected value.  To set the instrument you may use **either** `instrumentId` (Flat's instrument id) **or** `midiProgram` (a standard General MIDI program) — whichever your integration prefers; you do not need both. If both are sent, `instrumentId` wins; otherwise `midiProgram` is resolved to the matching instrument; otherwise the detected instrument is kept. `transposeKey` and `partName` apply independently on top. 
+  class OmrInstrumentOverride < ApiModelBase
+    # 0-based position of the part to override, matching the `index` of the detected part.
+    attr_accessor :index
+
+    # Override the resolved instrument with this Flat instrument id, for example `brass.horn`. See the [Instrument IDs reference](https://flat.io/developers/docs/api/instruments) for valid values. Both the dotted `<group>.<instrument>` form (`brass.horn`) and the bare instrument key (`horn`) are accepted. Use this or `midiProgram`. Takes precedence over `midiProgram` when both are set. 
+    attr_accessor :instrument_id
+
+    # Override the part name.
+    attr_accessor :part_name
+
+    # Override the transposition / written key: a pitch class as a letter `A`-`G` with an optional accidental. For example `F` for Horn in F or `Bb` for a B flat clarinet.  The accidental may be ASCII `b` (flat) or `#` (sharp), or the Unicode music glyphs `♭` (U+266D) and `♯` (U+266F). Unicode accidentals are normalized to their ASCII equivalent, so `B♭` is stored and returned as `Bb`. 
+    attr_accessor :transpose_key
+
+    # Override the instrument with a standard General MIDI program number (0-127), resolved server-side to the matching Flat instrument. Use this when you do not want to map Flat instrument ids. Ignored if `instrumentId` is also set. 
+    attr_accessor :midi_program
+
+    # Attribute mapping from ruby-style variable name to JSON key.
+    def self.attribute_map
+      {
+        :'index' => :'index',
+        :'instrument_id' => :'instrumentId',
+        :'part_name' => :'partName',
+        :'transpose_key' => :'transposeKey',
+        :'midi_program' => :'midiProgram'
+      }
+    end
+
+    # Returns attribute mapping this model knows about
+    def self.acceptable_attribute_map
+      attribute_map
+    end
+
+    # Returns all the JSON keys this model knows about
+    def self.acceptable_attributes
+      acceptable_attribute_map.values
+    end
+
+    # Attribute type mapping.
+    def self.openapi_types
+      {
+        :'index' => :'Integer',
+        :'instrument_id' => :'String',
+        :'part_name' => :'String',
+        :'transpose_key' => :'String',
+        :'midi_program' => :'Integer'
+      }
+    end
+
+    # List of attributes with nullable: true
+    def self.openapi_nullable
+      Set.new([
+      ])
+    end
+
+    # Initializes the object
+    # @param [Hash] attributes Model attributes in the form of hash
+    def initialize(attributes = {})
+      if (!attributes.is_a?(Hash))
+        fail ArgumentError, "The input argument (attributes) must be a hash in `FlatApi::OmrInstrumentOverride` initialize method"
+      end
+
+      # check to see if the attribute exists and convert string to symbol for hash key
+      acceptable_attribute_map = self.class.acceptable_attribute_map
+      attributes = attributes.each_with_object({}) { |(k, v), h|
+        if (!acceptable_attribute_map.key?(k.to_sym))
+          fail ArgumentError, "`#{k}` is not a valid attribute in `FlatApi::OmrInstrumentOverride`. Please check the name to make sure it's valid. List of attributes: " + acceptable_attribute_map.keys.inspect
+        end
+        h[k.to_sym] = v
+      }
+
+      if attributes.key?(:'index')
+        self.index = attributes[:'index']
+      else
+        self.index = nil
+      end
+
+      if attributes.key?(:'instrument_id')
+        self.instrument_id = attributes[:'instrument_id']
+      end
+
+      if attributes.key?(:'part_name')
+        self.part_name = attributes[:'part_name']
+      end
+
+      if attributes.key?(:'transpose_key')
+        self.transpose_key = attributes[:'transpose_key']
+      end
+
+      if attributes.key?(:'midi_program')
+        self.midi_program = attributes[:'midi_program']
+      end
+    end
+
+    # Show invalid properties with the reasons. Usually used together with valid?
+    # @return Array for valid properties with the reasons
+    def list_invalid_properties
+      warn '[DEPRECATED] the `list_invalid_properties` method is obsolete'
+      invalid_properties = Array.new
+      if @index.nil?
+        invalid_properties.push('invalid value for "index", index cannot be nil.')
+      end
+
+      if @index < 0
+        invalid_properties.push('invalid value for "index", must be greater than or equal to 0.')
+      end
+
+      if !@instrument_id.nil? && @instrument_id.to_s.length > 100
+        invalid_properties.push('invalid value for "instrument_id", the character length must be smaller than or equal to 100.')
+      end
+
+      if !@instrument_id.nil? && @instrument_id.to_s.length < 1
+        invalid_properties.push('invalid value for "instrument_id", the character length must be greater than or equal to 1.')
+      end
+
+      if !@part_name.nil? && @part_name.to_s.length > 200
+        invalid_properties.push('invalid value for "part_name", the character length must be smaller than or equal to 200.')
+      end
+
+      pattern = Regexp.new(/^[A-G][b♭#♯]?$/)
+      if !@transpose_key.nil? && @transpose_key !~ pattern
+        invalid_properties.push("invalid value for \"transpose_key\", must conform to the pattern #{pattern}.")
+      end
+
+      if !@midi_program.nil? && @midi_program > 127
+        invalid_properties.push('invalid value for "midi_program", must be smaller than or equal to 127.')
+      end
+
+      if !@midi_program.nil? && @midi_program < 0
+        invalid_properties.push('invalid value for "midi_program", must be greater than or equal to 0.')
+      end
+
+      invalid_properties
+    end
+
+    # Check to see if the all the properties in the model are valid
+    # @return true if the model is valid
+    def valid?
+      warn '[DEPRECATED] the `valid?` method is obsolete'
+      return false if @index.nil?
+      return false if @index < 0
+      return false if !@instrument_id.nil? && @instrument_id.to_s.length > 100
+      return false if !@instrument_id.nil? && @instrument_id.to_s.length < 1
+      return false if !@part_name.nil? && @part_name.to_s.length > 200
+      return false if !@transpose_key.nil? && @transpose_key !~ Regexp.new(/^[A-G][b♭#♯]?$/)
+      return false if !@midi_program.nil? && @midi_program > 127
+      return false if !@midi_program.nil? && @midi_program < 0
+      true
+    end
+
+    # Custom attribute writer method with validation
+    # @param [Object] index Value to be assigned
+    def index=(index)
+      if index.nil?
+        fail ArgumentError, 'index cannot be nil'
+      end
+
+      if index < 0
+        fail ArgumentError, 'invalid value for "index", must be greater than or equal to 0.'
+      end
+
+      @index = index
+    end
+
+    # Custom attribute writer method with validation
+    # @param [Object] instrument_id Value to be assigned
+    def instrument_id=(instrument_id)
+      if instrument_id.nil?
+        fail ArgumentError, 'instrument_id cannot be nil'
+      end
+
+      if instrument_id.to_s.length > 100
+        fail ArgumentError, 'invalid value for "instrument_id", the character length must be smaller than or equal to 100.'
+      end
+
+      if instrument_id.to_s.length < 1
+        fail ArgumentError, 'invalid value for "instrument_id", the character length must be greater than or equal to 1.'
+      end
+
+      @instrument_id = instrument_id
+    end
+
+    # Custom attribute writer method with validation
+    # @param [Object] part_name Value to be assigned
+    def part_name=(part_name)
+      if part_name.nil?
+        fail ArgumentError, 'part_name cannot be nil'
+      end
+
+      if part_name.to_s.length > 200
+        fail ArgumentError, 'invalid value for "part_name", the character length must be smaller than or equal to 200.'
+      end
+
+      @part_name = part_name
+    end
+
+    # Custom attribute writer method with validation
+    # @param [Object] transpose_key Value to be assigned
+    def transpose_key=(transpose_key)
+      if transpose_key.nil?
+        fail ArgumentError, 'transpose_key cannot be nil'
+      end
+
+      pattern = Regexp.new(/^[A-G][b♭#♯]?$/)
+      if transpose_key !~ pattern
+        fail ArgumentError, "invalid value for \"transpose_key\", must conform to the pattern #{pattern}."
+      end
+
+      @transpose_key = transpose_key
+    end
+
+    # Custom attribute writer method with validation
+    # @param [Object] midi_program Value to be assigned
+    def midi_program=(midi_program)
+      if midi_program.nil?
+        fail ArgumentError, 'midi_program cannot be nil'
+      end
+
+      if midi_program > 127
+        fail ArgumentError, 'invalid value for "midi_program", must be smaller than or equal to 127.'
+      end
+
+      if midi_program < 0
+        fail ArgumentError, 'invalid value for "midi_program", must be greater than or equal to 0.'
+      end
+
+      @midi_program = midi_program
+    end
+
+    # Checks equality by comparing each attribute.
+    # @param [Object] Object to be compared
+    def ==(o)
+      return true if self.equal?(o)
+      self.class == o.class &&
+          index == o.index &&
+          instrument_id == o.instrument_id &&
+          part_name == o.part_name &&
+          transpose_key == o.transpose_key &&
+          midi_program == o.midi_program
+    end
+
+    # @see the `==` method
+    # @param [Object] Object to be compared
+    def eql?(o)
+      self == o
+    end
+
+    # Calculates hash code according to all attributes.
+    # @return [Integer] Hash code
+    def hash
+      [index, instrument_id, part_name, transpose_key, midi_program].hash
+    end
+
+    # Builds the object from hash
+    # @param [Hash] attributes Model attributes in the form of hash
+    # @return [Object] Returns the model itself
+    def self.build_from_hash(attributes)
+      return nil unless attributes.is_a?(Hash)
+      attributes = attributes.transform_keys(&:to_sym)
+      transformed_hash = {}
+      openapi_types.each_pair do |key, type|
+        if attributes.key?(attribute_map[key]) && attributes[attribute_map[key]].nil?
+          transformed_hash["#{key}"] = nil
+        elsif type =~ /\AArray<(.*)>/i
+          # check to ensure the input is an array given that the attribute
+          # is documented as an array but the input is not
+          if attributes[attribute_map[key]].is_a?(Array)
+            transformed_hash["#{key}"] = attributes[attribute_map[key]].map { |v| _deserialize($1, v) }
+          end
+        elsif !attributes[attribute_map[key]].nil?
+          transformed_hash["#{key}"] = _deserialize(type, attributes[attribute_map[key]])
+        end
+      end
+      new(transformed_hash)
+    end
+
+    # Returns the object in the form of hash
+    # @return [Hash] Returns the object in the form of hash
+    def to_hash
+      hash = {}
+      self.class.attribute_map.each_pair do |attr, param|
+        value = self.send(attr)
+        if value.nil?
+          is_nullable = self.class.openapi_nullable.include?(attr)
+          next if !is_nullable || (is_nullable && !instance_variable_defined?(:"@#{attr}"))
+        end
+
+        hash[param] = _to_hash(value)
+      end
+      hash
+    end
+
+  end
+
+end