flat_api 0.2.0 → 1.0.0

data/lib/flat_api/models/omr_job.rb

@@ -0,0 +1,394 @@
+=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
+  class OmrJob < ApiModelBase
+    # Unique identifier of the OMR job.
+    attr_accessor :id
+
+    attr_accessor :status
+
+    attr_accessor :output
+
+    # Steps this job pauses at for client input, echoing the value set at creation.
+    attr_accessor :interactive_steps
+
+    # Locale hints (BCP 47) the job was created with, used for OCR and as the default main language at the `details` step. 
+    attr_accessor :locales
+
+    # The pending step when `status` is `awaitingInput`. Omitted otherwise.
+    attr_accessor :current_step
+
+    attr_accessor :pending_step
+
+    # Credits that will be or were charged at start (page-based), so a client can show a confirmation before charging.
+    attr_accessor :estimated_credits
+
+    attr_accessor :progress
+
+    attr_accessor :original_file_metadata
+
+    attr_accessor :imported_metadata
+
+    attr_accessor :result
+
+    attr_accessor :retention
+
+    # Stable, engine-agnostic failure code, present when `status` is `error`. Branch on this for custom handling, and render `errorMessage` for the user-facing text.  This is an open string: new codes may be added over time, so keep a generic fallback and never hardcode an exhaustive switch. Current values:  * `NO_MUSIC_DETECTED`: no musical content found (poor scan, rotated page, or tablature). * `CORRUPTED_FILE`: the input file is corrupted and could not be read. * `UNSUPPORTED_FORMAT`: the file format or notation is not supported yet. * `UNSUPPORTED_TABLATURE`: the file is guitar tablature, not supported yet. * `ENCRYPTED_PDF`: the PDF is password-protected. * `TOO_LARGE`: the document is too large or has an unusual shape to process. * `ENGINE_TIMEOUT`: recognition took longer than expected and was stopped. * `GENERIC`: unspecified failure. 
+    attr_accessor :error_code
+
+    # Localized, user-facing error message, present when `status` is `error`. Rendered in the caller's locale and safe to display as-is. Pair with `errorCode` for branching. 
+    attr_accessor :error_message
+
+    # When the job was created.
+    attr_accessor :creation_date
+
+    # When the job was last updated.
+    attr_accessor :modification_date
+
+    class EnumAttributeValidator
+      attr_reader :datatype
+      attr_reader :allowable_values
+
+      def initialize(datatype, allowable_values)
+        @allowable_values = allowable_values.map do |value|
+          case datatype.to_s
+          when /Integer/i
+            value.to_i
+          when /Float/i
+            value.to_f
+          else
+            value
+          end
+        end
+      end
+
+      def valid?(value)
+        !value || allowable_values.include?(value)
+      end
+    end
+
+    # Attribute mapping from ruby-style variable name to JSON key.
+    def self.attribute_map
+      {
+        :'id' => :'id',
+        :'status' => :'status',
+        :'output' => :'output',
+        :'interactive_steps' => :'interactiveSteps',
+        :'locales' => :'locales',
+        :'current_step' => :'currentStep',
+        :'pending_step' => :'pendingStep',
+        :'estimated_credits' => :'estimatedCredits',
+        :'progress' => :'progress',
+        :'original_file_metadata' => :'originalFileMetadata',
+        :'imported_metadata' => :'importedMetadata',
+        :'result' => :'result',
+        :'retention' => :'retention',
+        :'error_code' => :'errorCode',
+        :'error_message' => :'errorMessage',
+        :'creation_date' => :'creationDate',
+        :'modification_date' => :'modificationDate'
+      }
+    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
+      {
+        :'id' => :'String',
+        :'status' => :'OmrJobStatus',
+        :'output' => :'OmrJobOutput',
+        :'interactive_steps' => :'Array<OmrStepName>',
+        :'locales' => :'Array<String>',
+        :'current_step' => :'OmrStepName',
+        :'pending_step' => :'OmrPendingStep',
+        :'estimated_credits' => :'Integer',
+        :'progress' => :'OmrJobProgress',
+        :'original_file_metadata' => :'OmrJobFileMetadata',
+        :'imported_metadata' => :'OmrImportedMetadata',
+        :'result' => :'OmrJobResult',
+        :'retention' => :'OmrJobRetention',
+        :'error_code' => :'String',
+        :'error_message' => :'String',
+        :'creation_date' => :'Time',
+        :'modification_date' => :'Time'
+      }
+    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::OmrJob` 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::OmrJob`. 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?(:'id')
+        self.id = attributes[:'id']
+      else
+        self.id = nil
+      end
+
+      if attributes.key?(:'status')
+        self.status = attributes[:'status']
+      else
+        self.status = nil
+      end
+
+      if attributes.key?(:'output')
+        self.output = attributes[:'output']
+      else
+        self.output = 'library'
+      end
+
+      if attributes.key?(:'interactive_steps')
+        if (value = attributes[:'interactive_steps']).is_a?(Array)
+          self.interactive_steps = value
+        end
+      else
+        self.interactive_steps = nil
+      end
+
+      if attributes.key?(:'locales')
+        if (value = attributes[:'locales']).is_a?(Array)
+          self.locales = value
+        end
+      end
+
+      if attributes.key?(:'current_step')
+        self.current_step = attributes[:'current_step']
+      end
+
+      if attributes.key?(:'pending_step')
+        self.pending_step = attributes[:'pending_step']
+      end
+
+      if attributes.key?(:'estimated_credits')
+        self.estimated_credits = attributes[:'estimated_credits']
+      end
+
+      if attributes.key?(:'progress')
+        self.progress = attributes[:'progress']
+      end
+
+      if attributes.key?(:'original_file_metadata')
+        self.original_file_metadata = attributes[:'original_file_metadata']
+      end
+
+      if attributes.key?(:'imported_metadata')
+        self.imported_metadata = attributes[:'imported_metadata']
+      end
+
+      if attributes.key?(:'result')
+        self.result = attributes[:'result']
+      end
+
+      if attributes.key?(:'retention')
+        self.retention = attributes[:'retention']
+      end
+
+      if attributes.key?(:'error_code')
+        self.error_code = attributes[:'error_code']
+      end
+
+      if attributes.key?(:'error_message')
+        self.error_message = attributes[:'error_message']
+      end
+
+      if attributes.key?(:'creation_date')
+        self.creation_date = attributes[:'creation_date']
+      end
+
+      if attributes.key?(:'modification_date')
+        self.modification_date = attributes[:'modification_date']
+      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 @id.nil?
+        invalid_properties.push('invalid value for "id", id cannot be nil.')
+      end
+
+      if @status.nil?
+        invalid_properties.push('invalid value for "status", status cannot be nil.')
+      end
+
+      if @output.nil?
+        invalid_properties.push('invalid value for "output", output cannot be nil.')
+      end
+
+      if @interactive_steps.nil?
+        invalid_properties.push('invalid value for "interactive_steps", interactive_steps cannot be nil.')
+      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 @id.nil?
+      return false if @status.nil?
+      return false if @output.nil?
+      return false if @interactive_steps.nil?
+      true
+    end
+
+    # Custom attribute writer method with validation
+    # @param [Object] id Value to be assigned
+    def id=(id)
+      if id.nil?
+        fail ArgumentError, 'id cannot be nil'
+      end
+
+      @id = id
+    end
+
+    # Custom attribute writer method with validation
+    # @param [Object] status Value to be assigned
+    def status=(status)
+      if status.nil?
+        fail ArgumentError, 'status cannot be nil'
+      end
+
+      @status = status
+    end
+
+    # Custom attribute writer method with validation
+    # @param [Object] output Value to be assigned
+    def output=(output)
+      if output.nil?
+        fail ArgumentError, 'output cannot be nil'
+      end
+
+      @output = output
+    end
+
+    # Custom attribute writer method with validation
+    # @param [Object] interactive_steps Value to be assigned
+    def interactive_steps=(interactive_steps)
+      if interactive_steps.nil?
+        fail ArgumentError, 'interactive_steps cannot be nil'
+      end
+
+      @interactive_steps = interactive_steps
+    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 &&
+          id == o.id &&
+          status == o.status &&
+          output == o.output &&
+          interactive_steps == o.interactive_steps &&
+          locales == o.locales &&
+          current_step == o.current_step &&
+          pending_step == o.pending_step &&
+          estimated_credits == o.estimated_credits &&
+          progress == o.progress &&
+          original_file_metadata == o.original_file_metadata &&
+          imported_metadata == o.imported_metadata &&
+          result == o.result &&
+          retention == o.retention &&
+          error_code == o.error_code &&
+          error_message == o.error_message &&
+          creation_date == o.creation_date &&
+          modification_date == o.modification_date
+    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
+      [id, status, output, interactive_steps, locales, current_step, pending_step, estimated_credits, progress, original_file_metadata, imported_metadata, result, retention, error_code, error_message, creation_date, modification_date].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

data/lib/flat_api/models/omr_job_creation.rb

@@ -0,0 +1,238 @@
+=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
+  # Parameters to create an OMR job. Send without `files` to create a draft (then add files with `addOmrJobFile` and run `startOmrJob`), or include `files` and `autoStart: true` to import in a single request. 
+  class OmrJobCreation < ApiModelBase
+    attr_accessor :output
+
+    # Steps at which the pipeline should pause for this client. Omit or send `[]` for a fully automatic import. The server only pauses at the steps listed here; declare only steps your client can actually render. 
+    attr_accessor :interactive_steps
+
+    # Locale hints (BCP 47) to improve text and lyric detection, for example `[\"ja\", \"en\"]`. The first entry drives the OCR reader. This is the input hint; the detected main language is confirmed later at the `details` step. 
+    attr_accessor :locales
+
+    # Target collection ID. Only used when `output` is `library`.
+    attr_accessor :collection
+
+    # Optional client-supplied key. A retry with the same key returns the existing job instead of creating a duplicate, for safe retries on flaky networks. 
+    attr_accessor :idempotency_key
+
+    # Optional inline inputs for a one-shot import. For multi-image or mobile capture, omit this and use `addOmrJobFile`.
+    attr_accessor :files
+
+    # Start processing immediately. Only valid when `files` is provided.
+    attr_accessor :auto_start
+
+    class EnumAttributeValidator
+      attr_reader :datatype
+      attr_reader :allowable_values
+
+      def initialize(datatype, allowable_values)
+        @allowable_values = allowable_values.map do |value|
+          case datatype.to_s
+          when /Integer/i
+            value.to_i
+          when /Float/i
+            value.to_f
+          else
+            value
+          end
+        end
+      end
+
+      def valid?(value)
+        !value || allowable_values.include?(value)
+      end
+    end
+
+    # Attribute mapping from ruby-style variable name to JSON key.
+    def self.attribute_map
+      {
+        :'output' => :'output',
+        :'interactive_steps' => :'interactiveSteps',
+        :'locales' => :'locales',
+        :'collection' => :'collection',
+        :'idempotency_key' => :'idempotencyKey',
+        :'files' => :'files',
+        :'auto_start' => :'autoStart'
+      }
+    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
+      {
+        :'output' => :'OmrJobOutput',
+        :'interactive_steps' => :'Array<OmrStepName>',
+        :'locales' => :'Array<String>',
+        :'collection' => :'String',
+        :'idempotency_key' => :'String',
+        :'files' => :'Array<OmrJobInputFile>',
+        :'auto_start' => :'Boolean'
+      }
+    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::OmrJobCreation` 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::OmrJobCreation`. 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?(:'output')
+        self.output = attributes[:'output']
+      else
+        self.output = 'library'
+      end
+
+      if attributes.key?(:'interactive_steps')
+        if (value = attributes[:'interactive_steps']).is_a?(Array)
+          self.interactive_steps = value
+        end
+      end
+
+      if attributes.key?(:'locales')
+        if (value = attributes[:'locales']).is_a?(Array)
+          self.locales = value
+        end
+      end
+
+      if attributes.key?(:'collection')
+        self.collection = attributes[:'collection']
+      end
+
+      if attributes.key?(:'idempotency_key')
+        self.idempotency_key = attributes[:'idempotency_key']
+      end
+
+      if attributes.key?(:'files')
+        if (value = attributes[:'files']).is_a?(Array)
+          self.files = value
+        end
+      end
+
+      if attributes.key?(:'auto_start')
+        self.auto_start = attributes[:'auto_start']
+      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
+      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'
+      true
+    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 &&
+          output == o.output &&
+          interactive_steps == o.interactive_steps &&
+          locales == o.locales &&
+          collection == o.collection &&
+          idempotency_key == o.idempotency_key &&
+          files == o.files &&
+          auto_start == o.auto_start
+    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
+      [output, interactive_steps, locales, collection, idempotency_key, files, auto_start].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