vericred_client 0.0.4 → 0.0.5

data/lib/vericred_client/models/request_providers_search.rb

@@ -0,0 +1,372 @@
+=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://vericred.3scale.net) 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).
+
+## 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
+
+Most endpoints are not paginated.  It will be noted in the documentation if/when
+an endpoint is paginated.
+
+When pagination is present, a `meta` stanza will be present in the response
+with the total number of records
+
+```
+{
+  things: [{ id: 1 }, { id: 2 }],
+  meta: { total: 500 }
+}
+```
+
+## 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,staes.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'
+  }]
+}
+```
+
+
+
+OpenAPI spec version: 1.0.0
+
+Generated by: https://github.com/swagger-api/swagger-codegen.git
+
+
+=end
+
+require 'date'
+
+module VericredClient
+  class RequestProvidersSearch
+    # Limit results to Providers who accept at least one insurance
+        plan.  Note that the inverse of this filter is not supported and
+        any value will evaluate to true
+    attr_accessor :accepts_insurance
+
+    # List of HIOS ids
+    attr_accessor :hios_ids
+
+    # Page number
+    attr_accessor :page
+
+    # Number of records to return per page
+    attr_accessor :per_page
+
+    # Radius (in miles) to use to limit results
+    attr_accessor :radius
+
+    # String to search by
+    attr_accessor :search_term
+
+    # Zip Code to search near
+    attr_accessor :zip_code
+
+    # Either organization or individual
+    attr_accessor :type
+
+    # Attribute mapping from ruby-style variable name to JSON key.
+    def self.attribute_map
+      {
+        :'accepts_insurance' => :'accepts_insurance',
+        :'hios_ids' => :'hios_ids',
+        :'page' => :'page',
+        :'per_page' => :'per_page',
+        :'radius' => :'radius',
+        :'search_term' => :'search_term',
+        :'zip_code' => :'zip_code',
+        :'type' => :'type'
+      }
+    end
+
+    # Attribute type mapping.
+    def self.swagger_types
+      {
+        :'accepts_insurance' => :'BOOLEAN',
+        :'hios_ids' => :'Array<String>',
+        :'page' => :'Integer',
+        :'per_page' => :'Integer',
+        :'radius' => :'Integer',
+        :'search_term' => :'String',
+        :'zip_code' => :'String',
+        :'type' => :'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?(:'accepts_insurance')
+        self.accepts_insurance = attributes[:'accepts_insurance']
+      end
+
+      if attributes.has_key?(:'hios_ids')
+        if (value = attributes[:'hios_ids']).is_a?(Array)
+          self.hios_ids = value
+        end
+      end
+
+      if attributes.has_key?(:'page')
+        self.page = attributes[:'page']
+      end
+
+      if attributes.has_key?(:'per_page')
+        self.per_page = attributes[:'per_page']
+      end
+
+      if attributes.has_key?(:'radius')
+        self.radius = attributes[:'radius']
+      end
+
+      if attributes.has_key?(:'search_term')
+        self.search_term = attributes[:'search_term']
+      end
+
+      if attributes.has_key?(:'zip_code')
+        self.zip_code = attributes[:'zip_code']
+      end
+
+      if attributes.has_key?(:'type')
+        self.type = attributes[:'type']
+      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?
+    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 &&
+          accepts_insurance == o.accepts_insurance &&
+          hios_ids == o.hios_ids &&
+          page == o.page &&
+          per_page == o.per_page &&
+          radius == o.radius &&
+          search_term == o.search_term &&
+          zip_code == o.zip_code &&
+          type == o.type
+    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
+      [accepts_insurance, hios_ids, page, per_page, radius, search_term, zip_code, type].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 =~ /^Array<(.*)>/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 =~ /^(true|t|yes|y|1)$/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

data/lib/vericred_client/models/state.rb

@@ -6,7 +6,7 @@ accepts.
 
 ## Getting Started
 
-Visit our [Developer Portal](https://vericred.3scale.net/access_code?access_code=vericred&cms_token=3545ca52af07bde85b7c0c3aa9d1985e) to
+Visit our [Developer Portal](https://vericred.3scale.net) to
 create an account.
 
 Once you have created an account, you can create one Application for
@@ -127,15 +127,18 @@ require 'date'
 
 module VericredClient
   class State
+    # Primary Key of State
+    attr_accessor :id
+
+    # Name of state
+    attr_accessor :name
+
     # 2 letter code for state
     attr_accessor :code
 
     # National FIPs number
     attr_accessor :fips_number
 
-    # Primary Key of State
-    attr_accessor :id
-
     # Last date this state is live for individuals
     attr_accessor :last_date_for_individual
 
@@ -148,34 +151,31 @@ module VericredClient
     # Is this State available for individuals
     attr_accessor :live_for_consumers
 
-    # Name of state
-    attr_accessor :name
-
     # Attribute mapping from ruby-style variable name to JSON key.
     def self.attribute_map
       {
+        :'id' => :'id',
+        :'name' => :'name',
         :'code' => :'code',
         :'fips_number' => :'fips_number',
-        :'id' => :'id',
         :'last_date_for_individual' => :'last_date_for_individual',
         :'last_date_for_shop' => :'last_date_for_shop',
         :'live_for_business' => :'live_for_business',
-        :'live_for_consumers' => :'live_for_consumers',
-        :'name' => :'name'
+        :'live_for_consumers' => :'live_for_consumers'
       }
     end
 
     # Attribute type mapping.
     def self.swagger_types
       {
+        :'id' => :'Integer',
+        :'name' => :'String',
         :'code' => :'String',
         :'fips_number' => :'String',
-        :'id' => :'Integer',
         :'last_date_for_individual' => :'Date',
         :'last_date_for_shop' => :'Date',
         :'live_for_business' => :'BOOLEAN',
-        :'live_for_consumers' => :'BOOLEAN',
-        :'name' => :'String'
+        :'live_for_consumers' => :'BOOLEAN'
       }
     end
 
@@ -187,6 +187,14 @@ module VericredClient
       # convert string to symbol for hash key
       attributes = attributes.each_with_object({}){|(k,v), h| h[k.to_sym] = v}
 
+      if attributes.has_key?(:'id')
+        self.id = attributes[:'id']
+      end
+
+      if attributes.has_key?(:'name')
+        self.name = attributes[:'name']
+      end
+
       if attributes.has_key?(:'code')
         self.code = attributes[:'code']
       end
@@ -195,10 +203,6 @@ module VericredClient
         self.fips_number = attributes[:'fips_number']
       end
 
-      if attributes.has_key?(:'id')
-        self.id = attributes[:'id']
-      end
-
       if attributes.has_key?(:'last_date_for_individual')
         self.last_date_for_individual = attributes[:'last_date_for_individual']
       end
@@ -209,18 +213,10 @@ module VericredClient
 
       if attributes.has_key?(:'live_for_business')
         self.live_for_business = attributes[:'live_for_business']
-      else
-        self.live_for_business = false
       end
 
       if attributes.has_key?(:'live_for_consumers')
         self.live_for_consumers = attributes[:'live_for_consumers']
-      else
-        self.live_for_consumers = false
-      end
-
-      if attributes.has_key?(:'name')
-        self.name = attributes[:'name']
       end
 
     end
@@ -242,14 +238,14 @@ module VericredClient
     def ==(o)
       return true if self.equal?(o)
       self.class == o.class &&
+          id == o.id &&
+          name == o.name &&
           code == o.code &&
           fips_number == o.fips_number &&
-          id == o.id &&
           last_date_for_individual == o.last_date_for_individual &&
           last_date_for_shop == o.last_date_for_shop &&
           live_for_business == o.live_for_business &&
-          live_for_consumers == o.live_for_consumers &&
-          name == o.name
+          live_for_consumers == o.live_for_consumers
     end
 
     # @see the `==` method
@@ -261,7 +257,7 @@ module VericredClient
     # Calculates hash code according to all attributes.
     # @return [Fixnum] Hash code
     def hash
-      [code, fips_number, id, last_date_for_individual, last_date_for_shop, live_for_business, live_for_consumers, name].hash
+      [id, name, code, fips_number, last_date_for_individual, last_date_for_shop, live_for_business, live_for_consumers].hash
     end
 
     # Builds the object from hash

data/lib/vericred_client/models/zip_code.rb

@@ -6,7 +6,7 @@ accepts.
 
 ## Getting Started
 
-Visit our [Developer Portal](https://vericred.3scale.net/access_code?access_code=vericred&cms_token=3545ca52af07bde85b7c0c3aa9d1985e) to
+Visit our [Developer Portal](https://vericred.3scale.net) to
 create an account.
 
 Once you have created an account, you can create one Application for