vericred_client 0.0.7 → 0.0.8

data/lib/vericred_client/api/zip_counties_api.rb

@@ -1,7 +1,7 @@
 =begin
-Vericred API
+#Vericred API
 
-Vericred's API allows you to search for Health Plans that a specific doctor
+#Vericred's API allows you to search for Health Plans that a specific doctor
 accepts.
 
 ## Getting Started
@@ -37,7 +37,6 @@ namely `Total`, `Per-Page`, `Link`, and `Page` as described in [RFC-5988](https:
 
 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
 
@@ -115,6 +114,17 @@ 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
 
@@ -172,7 +182,7 @@ module VericredClient
 
       # http body (model)
       post_body = nil
-            auth_names = ['Vericred-Api-Key']
+      auth_names = ['Vericred-Api-Key']
       data, status_code, headers = @api_client.call_api(:GET, local_var_path,
         :header_params => header_params,
         :query_params => query_params,

data/lib/vericred_client/api_client.rb

@@ -1,7 +1,7 @@
 =begin
-Vericred API
+#Vericred API
 
-Vericred's API allows you to search for Health Plans that a specific doctor
+#Vericred's API allows you to search for Health Plans that a specific doctor
 accepts.
 
 ## Getting Started
@@ -37,7 +37,6 @@ namely `Total`, `Per-Page`, `Link`, and `Page` as described in [RFC-5988](https:
 
 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
 
@@ -115,6 +114,17 @@ 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
 

data/lib/vericred_client/api_error.rb

@@ -1,7 +1,7 @@
 =begin
-Vericred API
+#Vericred API
 
-Vericred's API allows you to search for Health Plans that a specific doctor
+#Vericred's API allows you to search for Health Plans that a specific doctor
 accepts.
 
 ## Getting Started
@@ -37,7 +37,6 @@ namely `Total`, `Per-Page`, `Link`, and `Page` as described in [RFC-5988](https:
 
 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
 
@@ -115,6 +114,17 @@ 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
 

data/lib/vericred_client/configuration.rb

@@ -1,3 +1,133 @@
+=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
+
+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,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
+
+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 'uri'
 
 module VericredClient

data/lib/vericred_client/models/applicant.rb

@@ -1,7 +1,7 @@
 =begin
-Vericred API
+#Vericred API
 
-Vericred's API allows you to search for Health Plans that a specific doctor
+#Vericred's API allows you to search for Health Plans that a specific doctor
 accepts.
 
 ## Getting Started
@@ -37,7 +37,6 @@ namely `Total`, `Per-Page`, `Link`, and `Page` as described in [RFC-5988](https:
 
 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
 
@@ -115,12 +114,24 @@ 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 Applicant
     # Primary key
     attr_accessor :id
@@ -143,6 +154,7 @@ module VericredClient
     # Applicant's Social Security Number
     attr_accessor :ssn
 
+
     # Attribute mapping from ruby-style variable name to JSON key.
     def self.attribute_map
       {
@@ -217,10 +229,11 @@ module VericredClient
     # 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 
+    # @param [Object] Object to be compared
     def ==(o)
       return true if self.equal?(o)
       self.class == o.class &&
@@ -234,7 +247,7 @@ module VericredClient
     end
 
     # @see the `==` method
-    # @param [Object] Object to be compared 
+    # @param [Object] Object to be compared
     def eql?(o)
       self == o
     end
@@ -333,7 +346,7 @@ module VericredClient
 
     # 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 
+    # @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)
@@ -350,4 +363,5 @@ module VericredClient
     end
 
   end
+
 end

data/lib/vericred_client/models/base.rb

@@ -1,7 +1,7 @@
 =begin
-Vericred API
+#Vericred API
 
-Vericred's API allows you to search for Health Plans that a specific doctor
+#Vericred's API allows you to search for Health Plans that a specific doctor
 accepts.
 
 ## Getting Started
@@ -37,7 +37,6 @@ namely `Total`, `Per-Page`, `Link`, and `Page` as described in [RFC-5988](https:
 
 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
 
@@ -115,16 +114,29 @@ 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 Base
     # Metadata for query
     attr_accessor :meta
 
+
     # Attribute mapping from ruby-style variable name to JSON key.
     def self.attribute_map
       {
@@ -163,10 +175,11 @@ module VericredClient
     # 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 
+    # @param [Object] Object to be compared
     def ==(o)
       return true if self.equal?(o)
       self.class == o.class &&
@@ -174,7 +187,7 @@ module VericredClient
     end
 
     # @see the `==` method
-    # @param [Object] Object to be compared 
+    # @param [Object] Object to be compared
     def eql?(o)
       self == o
     end
@@ -273,7 +286,7 @@ module VericredClient
 
     # 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 
+    # @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)
@@ -290,4 +303,5 @@ module VericredClient
     end
 
   end
+
 end

data/lib/vericred_client/models/carrier.rb

@@ -1,7 +1,7 @@
 =begin
-Vericred API
+#Vericred API
 
-Vericred's API allows you to search for Health Plans that a specific doctor
+#Vericred's API allows you to search for Health Plans that a specific doctor
 accepts.
 
 ## Getting Started
@@ -37,7 +37,6 @@ namely `Total`, `Per-Page`, `Link`, and `Page` as described in [RFC-5988](https:
 
 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
 
@@ -115,12 +114,24 @@ 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 Carrier
     # Primary key
     attr_accessor :id
@@ -131,6 +142,7 @@ module VericredClient
     # URL for the Carrier's logo
     attr_accessor :logo_path
 
+
     # Attribute mapping from ruby-style variable name to JSON key.
     def self.attribute_map
       {
@@ -181,10 +193,11 @@ module VericredClient
     # 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 
+    # @param [Object] Object to be compared
     def ==(o)
       return true if self.equal?(o)
       self.class == o.class &&
@@ -194,7 +207,7 @@ module VericredClient
     end
 
     # @see the `==` method
-    # @param [Object] Object to be compared 
+    # @param [Object] Object to be compared
     def eql?(o)
       self == o
     end
@@ -293,7 +306,7 @@ module VericredClient
 
     # 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 
+    # @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)
@@ -310,4 +323,5 @@ module VericredClient
     end
 
   end
+
 end