vericred_client 0.0.11 → 0.0.18

data/lib/vericred_client/models/dental_plan_benefits.rb

@@ -0,0 +1,616 @@
+=begin
+#Vericred API
+
+#Vericred's API allows you to search for Health Plans that a specific doctor
+accepts.
+
+## Getting Started
+
+Visit our [Developer Portal](https://developers.vericred.com) to
+create an account.
+
+Once you have created an account, you can create one Application for
+Production and another for our Sandbox (select the appropriate Plan when
+you create the Application).
+
+## SDKs
+
+Our API follows standard REST conventions, so you can use any HTTP client
+to integrate with us. You will likely find it easier to use one of our
+[autogenerated SDKs](https://github.com/vericred/?query=vericred-),
+which we make available for several common programming languages.
+
+## Authentication
+
+To authenticate, pass the API Key you created in the Developer Portal as
+a `Vericred-Api-Key` header.
+
+`curl -H 'Vericred-Api-Key: YOUR_KEY' "https://api.vericred.com/providers?search_term=Foo&zip_code=11215"`
+
+## Versioning
+
+Vericred's API default to the latest version.  However, if you need a specific
+version, you can request it with an `Accept-Version` header.
+
+The current version is `v3`.  Previous versions are `v1` and `v2`.
+
+`curl -H 'Vericred-Api-Key: YOUR_KEY' -H 'Accept-Version: v2' "https://api.vericred.com/providers?search_term=Foo&zip_code=11215"`
+
+## Pagination
+
+Endpoints that accept `page` and `per_page` parameters are paginated. They expose
+four additional fields that contain data about your position in the response,
+namely `Total`, `Per-Page`, `Link`, and `Page` as described in [RFC-5988](https://tools.ietf.org/html/rfc5988).
+
+For example, to display 5 results per page and view the second page of a
+`GET` to `/networks`, your final request would be `GET /networks?....page=2&per_page=5`.
+
+## Sideloading
+
+When we return multiple levels of an object graph (e.g. `Provider`s and their `State`s
+we sideload the associated data.  In this example, we would provide an Array of
+`State`s and a `state_id` for each provider.  This is done primarily to reduce the
+payload size since many of the `Provider`s will share a `State`
+
+```
+{
+  providers: [{ id: 1, state_id: 1}, { id: 2, state_id: 1 }],
+  states: [{ id: 1, code: 'NY' }]
+}
+```
+
+If you need the second level of the object graph, you can just match the
+corresponding id.
+
+## Selecting specific data
+
+All endpoints allow you to specify which fields you would like to return.
+This allows you to limit the response to contain only the data you need.
+
+For example, let's take a request that returns the following JSON by default
+
+```
+{
+  provider: {
+    id: 1,
+    name: 'John',
+    phone: '1234567890',
+    field_we_dont_care_about: 'value_we_dont_care_about'
+  },
+  states: [{
+    id: 1,
+    name: 'New York',
+    code: 'NY',
+    field_we_dont_care_about: 'value_we_dont_care_about'
+  }]
+}
+```
+
+To limit our results to only return the fields we care about, we specify the
+`select` query string parameter for the corresponding fields in the JSON
+document.
+
+In this case, we want to select `name` and `phone` from the `provider` key,
+so we would add the parameters `select=provider.name,provider.phone`.
+We also want the `name` and `code` from the `states` key, so we would
+add the parameters `select=states.name,states.code`.  The id field of
+each document is always returned whether or not it is requested.
+
+Our final request would be `GET /providers/12345?select=provider.name,provider.phone,states.name,states.code`
+
+The response would be
+
+```
+{
+  provider: {
+    id: 1,
+    name: 'John',
+    phone: '1234567890'
+  },
+  states: [{
+    id: 1,
+    name: 'New York',
+    code: 'NY'
+  }]
+}
+```
+
+## Benefits summary format
+Benefit cost-share strings are formatted to capture:
+ * Network tiers
+ * Compound or conditional cost-share
+ * Limits on the cost-share
+ * Benefit-specific maximum out-of-pocket costs
+
+**Example #1**
+As an example, we would represent [this Summary of Benefits & Coverage](https://s3.amazonaws.com/vericred-data/SBC/2017/33602TX0780032.pdf) as:
+
+* **Hospital stay facility fees**:
+  - Network Provider: `$400 copay/admit plus 20% coinsurance`
+  - Out-of-Network Provider: `$1,500 copay/admit plus 50% coinsurance`
+  - Vericred's format for this benefit: `In-Network: $400 before deductible then 20% after deductible / Out-of-Network: $1,500 before deductible then 50% after deductible`
+
+* **Rehabilitation services:**
+  - Network Provider: `20% coinsurance`
+  - Out-of-Network Provider: `50% coinsurance`
+  - Limitations & Exceptions: `35 visit maximum per benefit period combined with Chiropractic care.`
+  - Vericred's format for this benefit: `In-Network: 20% after deductible / Out-of-Network: 50% after deductible | limit: 35 visit(s) per Benefit Period`
+
+**Example #2**
+In [this other Summary of Benefits & Coverage](https://s3.amazonaws.com/vericred-data/SBC/2017/40733CA0110568.pdf), the **specialty_drugs** cost-share has a maximum out-of-pocket for in-network pharmacies.
+* **Specialty drugs:**
+  - Network Provider: `40% coinsurance up to a $500 maximum for up to a 30 day supply`
+  - Out-of-Network Provider `Not covered`
+  - Vericred's format for this benefit: `In-Network: 40% after deductible, up to $500 per script / Out-of-Network: 100%`
+
+**BNF**
+
+Here's a description of the benefits summary string, represented as a context-free grammar:
+
+```
+root                      ::= coverage
+
+coverage                  ::= (simple_coverage | tiered_coverage) (space pipe space coverage_modifier)?
+tiered_coverage           ::= tier (space slash space tier)*
+tier                      ::= tier_name colon space (tier_coverage | not_applicable)
+tier_coverage             ::= simple_coverage (space (then | or | and) space simple_coverage)* tier_limitation?
+simple_coverage           ::= (pre_coverage_limitation space)? coverage_amount (space post_coverage_limitation)? (comma? space coverage_condition)?
+coverage_modifier         ::= limit_condition colon space (((simple_coverage | simple_limitation) (semicolon space see_carrier_documentation)?) | see_carrier_documentation | waived_if_admitted | shared_across_tiers)
+waived_if_admitted        ::= ("copay" space)? "waived if admitted"
+simple_limitation         ::= pre_coverage_limitation space "copay applies"
+tier_name                 ::= "In-Network-Tier-2" | "Out-of-Network" | "In-Network"
+limit_condition           ::= "limit" | "condition"
+tier_limitation           ::= comma space "up to" space (currency | (integer space time_unit plural?)) (space post_coverage_limitation)?
+coverage_amount           ::= currency | unlimited | included | unknown | percentage | (digits space (treatment_unit | time_unit) plural?)
+pre_coverage_limitation   ::= first space digits space time_unit plural?
+post_coverage_limitation  ::= (((then space currency) | "per condition") space)? "per" space (treatment_unit | (integer space time_unit) | time_unit) plural?
+coverage_condition        ::= ("before deductible" | "after deductible" | "penalty" | allowance | "in-state" | "out-of-state") (space allowance)?
+allowance                 ::= upto_allowance | after_allowance
+upto_allowance            ::= "up to" space (currency space)? "allowance"
+after_allowance           ::= "after" space (currency space)? "allowance"
+see_carrier_documentation ::= "see carrier documentation for more information"
+shared_across_tiers       ::= "shared across all tiers"
+unknown                   ::= "unknown"
+unlimited                 ::= /[uU]nlimited/
+included                  ::= /[iI]ncluded in [mM]edical/
+time_unit                 ::= /[hH]our/ | (((/[cC]alendar/ | /[cC]ontract/) space)? /[yY]ear/) | /[mM]onth/ | /[dD]ay/ | /[wW]eek/ | /[vV]isit/ | /[lL]ifetime/ | ((((/[bB]enefit/ plural?) | /[eE]ligibility/) space)? /[pP]eriod/)
+treatment_unit            ::= /[pP]erson/ | /[gG]roup/ | /[cC]ondition/ | /[sS]cript/ | /[vV]isit/ | /[eE]xam/ | /[iI]tem/ | /[sS]tay/ | /[tT]reatment/ | /[aA]dmission/ | /[eE]pisode/
+comma                     ::= ","
+colon                     ::= ":"
+semicolon                 ::= ";"
+pipe                      ::= "|"
+slash                     ::= "/"
+plural                    ::= "(s)" | "s"
+then                      ::= "then" | ("," space) | space
+or                        ::= "or"
+and                       ::= "and"
+not_applicable            ::= "Not Applicable" | "N/A" | "NA"
+first                     ::= "first"
+currency                  ::= "$" number
+percentage                ::= number "%"
+number                    ::= float | integer
+float                     ::= digits "." digits
+integer                   ::= /[0-9]/+ (comma_int | under_int)*
+comma_int                 ::= ("," /[0-9]/*3) !"_"
+under_int                 ::= ("_" /[0-9]/*3) !","
+digits                    ::= /[0-9]/+ ("_" /[0-9]/+)*
+space                     ::= /[ \t]/+
+```
+
+
+
+OpenAPI spec version: 1.0.0
+
+Generated by: https://github.com/swagger-api/swagger-codegen.git
+
+Licensed under the Apache License, Version 2.0 (the "License");
+you may not use this file except in compliance with the License.
+You may obtain a copy of the License at
+
+http://www.apache.org/licenses/LICENSE-2.0
+
+Unless required by applicable law or agreed to in writing, software
+distributed under the License is distributed on an "AS IS" BASIS,
+WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+See the License for the specific language governing permissions and
+limitations under the License.
+
+=end
+
+require 'date'
+
+module VericredClient
+
+  class DentalPlanBenefits
+    # Individual Deductible benefit string
+    attr_accessor :individual_deductible
+
+    # Family Deductible benefit string
+    attr_accessor :family_deductible
+
+    # Individual Annual Max benefit string
+    attr_accessor :individual_annual_max
+
+    # Family Max Annual Max benefit string
+    attr_accessor :family_max_annual_max
+
+    # Individual MOOP benefit string
+    attr_accessor :individual_moop
+
+    # Family MOOP benefit string
+    attr_accessor :family_moop
+
+    # Office Visits benefit string
+    attr_accessor :office_visits
+
+    # Radiograph - Bitewings benefit string
+    attr_accessor :radiograph_bitewings
+
+    # Radiograph - Other benefit string
+    attr_accessor :radiograph_other
+
+    # Fluoride Treatment benefit string
+    attr_accessor :fluoride_treatment
+
+    # Space Maintainers benefit string
+    attr_accessor :space_maintainers
+
+    # Prophylaxis Cleaning benefit string
+    attr_accessor :prophylaxis_cleaning
+
+    # Sealant benefit string
+    attr_accessor :sealant
+
+    # Fillings - Amalgram benefit string
+    attr_accessor :fillings_amalgram
+
+    # Fillings - Composite benefit string
+    attr_accessor :fillings_composite
+
+    # Emergency Treatment benefit string
+    attr_accessor :emergency_treatment
+
+    # Restorative benefit string
+    attr_accessor :restorative
+
+    # Surgery - Anesthesia benefit string
+    attr_accessor :surgery_anesthesia
+
+    # Surgery - Extraction benefit string
+    attr_accessor :surgery_extraction
+
+    # Endodontics benefit string
+    attr_accessor :endodontics
+
+    # Periodontics benefit string
+    attr_accessor :periodontics
+
+    # Orthodontics - Adult benefit string
+    attr_accessor :orthodontics_adult
+
+    # Orthodontics - Child benefit string
+    attr_accessor :orthodontics_child
+
+
+    # Attribute mapping from ruby-style variable name to JSON key.
+    def self.attribute_map
+      {
+        :'individual_deductible' => :'individual_deductible',
+        :'family_deductible' => :'family_deductible',
+        :'individual_annual_max' => :'individual_annual_max',
+        :'family_max_annual_max' => :'family_max_annual_max',
+        :'individual_moop' => :'individual_moop',
+        :'family_moop' => :'family_moop',
+        :'office_visits' => :'office_visits',
+        :'radiograph_bitewings' => :'radiograph_bitewings',
+        :'radiograph_other' => :'radiograph_other',
+        :'fluoride_treatment' => :'fluoride_treatment',
+        :'space_maintainers' => :'space_maintainers',
+        :'prophylaxis_cleaning' => :'prophylaxis_cleaning',
+        :'sealant' => :'sealant',
+        :'fillings_amalgram' => :'fillings_amalgram',
+        :'fillings_composite' => :'fillings_composite',
+        :'emergency_treatment' => :'emergency_treatment',
+        :'restorative' => :'restorative',
+        :'surgery_anesthesia' => :'surgery_anesthesia',
+        :'surgery_extraction' => :'surgery_extraction',
+        :'endodontics' => :'endodontics',
+        :'periodontics' => :'periodontics',
+        :'orthodontics_adult' => :'orthodontics_adult',
+        :'orthodontics_child' => :'orthodontics_child'
+      }
+    end
+
+    # Attribute type mapping.
+    def self.swagger_types
+      {
+        :'individual_deductible' => :'String',
+        :'family_deductible' => :'String',
+        :'individual_annual_max' => :'String',
+        :'family_max_annual_max' => :'String',
+        :'individual_moop' => :'String',
+        :'family_moop' => :'String',
+        :'office_visits' => :'String',
+        :'radiograph_bitewings' => :'String',
+        :'radiograph_other' => :'String',
+        :'fluoride_treatment' => :'String',
+        :'space_maintainers' => :'String',
+        :'prophylaxis_cleaning' => :'String',
+        :'sealant' => :'String',
+        :'fillings_amalgram' => :'String',
+        :'fillings_composite' => :'String',
+        :'emergency_treatment' => :'String',
+        :'restorative' => :'String',
+        :'surgery_anesthesia' => :'String',
+        :'surgery_extraction' => :'String',
+        :'endodontics' => :'String',
+        :'periodontics' => :'String',
+        :'orthodontics_adult' => :'String',
+        :'orthodontics_child' => :'String'
+      }
+    end
+
+    # Initializes the object
+    # @param [Hash] attributes Model attributes in the form of hash
+    def initialize(attributes = {})
+      return unless attributes.is_a?(Hash)
+
+      # convert string to symbol for hash key
+      attributes = attributes.each_with_object({}){|(k,v), h| h[k.to_sym] = v}
+
+      if attributes.has_key?(:'individual_deductible')
+        self.individual_deductible = attributes[:'individual_deductible']
+      end
+
+      if attributes.has_key?(:'family_deductible')
+        self.family_deductible = attributes[:'family_deductible']
+      end
+
+      if attributes.has_key?(:'individual_annual_max')
+        self.individual_annual_max = attributes[:'individual_annual_max']
+      end
+
+      if attributes.has_key?(:'family_max_annual_max')
+        self.family_max_annual_max = attributes[:'family_max_annual_max']
+      end
+
+      if attributes.has_key?(:'individual_moop')
+        self.individual_moop = attributes[:'individual_moop']
+      end
+
+      if attributes.has_key?(:'family_moop')
+        self.family_moop = attributes[:'family_moop']
+      end
+
+      if attributes.has_key?(:'office_visits')
+        self.office_visits = attributes[:'office_visits']
+      end
+
+      if attributes.has_key?(:'radiograph_bitewings')
+        self.radiograph_bitewings = attributes[:'radiograph_bitewings']
+      end
+
+      if attributes.has_key?(:'radiograph_other')
+        self.radiograph_other = attributes[:'radiograph_other']
+      end
+
+      if attributes.has_key?(:'fluoride_treatment')
+        self.fluoride_treatment = attributes[:'fluoride_treatment']
+      end
+
+      if attributes.has_key?(:'space_maintainers')
+        self.space_maintainers = attributes[:'space_maintainers']
+      end
+
+      if attributes.has_key?(:'prophylaxis_cleaning')
+        self.prophylaxis_cleaning = attributes[:'prophylaxis_cleaning']
+      end
+
+      if attributes.has_key?(:'sealant')
+        self.sealant = attributes[:'sealant']
+      end
+
+      if attributes.has_key?(:'fillings_amalgram')
+        self.fillings_amalgram = attributes[:'fillings_amalgram']
+      end
+
+      if attributes.has_key?(:'fillings_composite')
+        self.fillings_composite = attributes[:'fillings_composite']
+      end
+
+      if attributes.has_key?(:'emergency_treatment')
+        self.emergency_treatment = attributes[:'emergency_treatment']
+      end
+
+      if attributes.has_key?(:'restorative')
+        self.restorative = attributes[:'restorative']
+      end
+
+      if attributes.has_key?(:'surgery_anesthesia')
+        self.surgery_anesthesia = attributes[:'surgery_anesthesia']
+      end
+
+      if attributes.has_key?(:'surgery_extraction')
+        self.surgery_extraction = attributes[:'surgery_extraction']
+      end
+
+      if attributes.has_key?(:'endodontics')
+        self.endodontics = attributes[:'endodontics']
+      end
+
+      if attributes.has_key?(:'periodontics')
+        self.periodontics = attributes[:'periodontics']
+      end
+
+      if attributes.has_key?(:'orthodontics_adult')
+        self.orthodontics_adult = attributes[:'orthodontics_adult']
+      end
+
+      if attributes.has_key?(:'orthodontics_child')
+        self.orthodontics_child = attributes[:'orthodontics_child']
+      end
+
+    end
+
+    # Show invalid properties with the reasons. Usually used together with valid?
+    # @return Array for valid properies with the reasons
+    def list_invalid_properties
+      invalid_properties = Array.new
+      return 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?
+      return 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 &&
+          individual_deductible == o.individual_deductible &&
+          family_deductible == o.family_deductible &&
+          individual_annual_max == o.individual_annual_max &&
+          family_max_annual_max == o.family_max_annual_max &&
+          individual_moop == o.individual_moop &&
+          family_moop == o.family_moop &&
+          office_visits == o.office_visits &&
+          radiograph_bitewings == o.radiograph_bitewings &&
+          radiograph_other == o.radiograph_other &&
+          fluoride_treatment == o.fluoride_treatment &&
+          space_maintainers == o.space_maintainers &&
+          prophylaxis_cleaning == o.prophylaxis_cleaning &&
+          sealant == o.sealant &&
+          fillings_amalgram == o.fillings_amalgram &&
+          fillings_composite == o.fillings_composite &&
+          emergency_treatment == o.emergency_treatment &&
+          restorative == o.restorative &&
+          surgery_anesthesia == o.surgery_anesthesia &&
+          surgery_extraction == o.surgery_extraction &&
+          endodontics == o.endodontics &&
+          periodontics == o.periodontics &&
+          orthodontics_adult == o.orthodontics_adult &&
+          orthodontics_child == o.orthodontics_child
+    end
+
+    # @see the `==` method
+    # @param [Object] Object to be compared
+    def eql?(o)
+      self == o
+    end
+
+    # Calculates hash code according to all attributes.
+    # @return [Fixnum] Hash code
+    def hash
+      [individual_deductible, family_deductible, individual_annual_max, family_max_annual_max, individual_moop, family_moop, office_visits, radiograph_bitewings, radiograph_other, fluoride_treatment, space_maintainers, prophylaxis_cleaning, sealant, fillings_amalgram, fillings_composite, emergency_treatment, restorative, surgery_anesthesia, surgery_extraction, endodontics, periodontics, orthodontics_adult, orthodontics_child].hash
+    end
+
+    # Builds the object from hash
+    # @param [Hash] attributes Model attributes in the form of hash
+    # @return [Object] Returns the model itself
+    def build_from_hash(attributes)
+      return nil unless attributes.is_a?(Hash)
+      self.class.swagger_types.each_pair do |key, type|
+        if type =~ /\AArray<(.*)>/i
+          # check to ensure the input is an array given that the the attribute
+          # is documented as an array but the input is not
+          if attributes[self.class.attribute_map[key]].is_a?(Array)
+            self.send("#{key}=", attributes[self.class.attribute_map[key]].map{ |v| _deserialize($1, v) } )
+          end
+        elsif !attributes[self.class.attribute_map[key]].nil?
+          self.send("#{key}=", _deserialize(type, attributes[self.class.attribute_map[key]]))
+        end # or else data not found in attributes(hash), not an issue as the data can be optional
+      end
+
+      self
+    end
+
+    # Deserializes the data based on type
+    # @param string type Data type
+    # @param string value Value to be deserialized
+    # @return [Object] Deserialized data
+    def _deserialize(type, value)
+      case type.to_sym
+      when :DateTime
+        DateTime.parse(value)
+      when :Date
+        Date.parse(value)
+      when :String
+        value.to_s
+      when :Integer
+        value.to_i
+      when :Float
+        value.to_f
+      when :BOOLEAN
+        if value.to_s =~ /\A(true|t|yes|y|1)\z/i
+          true
+        else
+          false
+        end
+      when :Object
+        # generic object (usually a Hash), return directly
+        value
+      when /\AArray<(?<inner_type>.+)>\z/
+        inner_type = Regexp.last_match[:inner_type]
+        value.map { |v| _deserialize(inner_type, v) }
+      when /\AHash<(?<k_type>.+), (?<v_type>.+)>\z/
+        k_type = Regexp.last_match[:k_type]
+        v_type = Regexp.last_match[:v_type]
+        {}.tap do |hash|
+          value.each do |k, v|
+            hash[_deserialize(k_type, k)] = _deserialize(v_type, v)
+          end
+        end
+      else # model
+        temp_model = VericredClient.const_get(type).new
+        temp_model.build_from_hash(value)
+      end
+    end
+
+    # Returns the string representation of the object
+    # @return [String] String presentation of the object
+    def to_s
+      to_hash.to_s
+    end
+
+    # to_body is an alias to to_hash (backward compatibility)
+    # @return [Hash] Returns the object in the form of hash
+    def to_body
+      to_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)
+        next if value.nil?
+        hash[param] = _to_hash(value)
+      end
+      hash
+    end
+
+    # Outputs non-array value in the form of hash
+    # For object, use to_hash. Otherwise, just return the value
+    # @param [Object] value Any valid value
+    # @return [Hash] Returns the value in the form of hash
+    def _to_hash(value)
+      if value.is_a?(Array)
+        value.compact.map{ |v| _to_hash(v) }
+      elsif value.is_a?(Hash)
+        {}.tap do |hash|
+          value.each { |k, v| hash[k] = _to_hash(v) }
+        end
+      elsif value.respond_to? :to_hash
+        value.to_hash
+      else
+        value
+      end
+    end
+
+  end
+
+end