vericred_client 0.0.6 → 0.0.7

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (65) hide show
  1. checksums.yaml +4 -4
  2. data/README.md +26 -20
  3. data/docs/CarrierSubsidiary.md +1 -0
  4. data/docs/DrugsApi.md +20 -14
  5. data/docs/NetworksApi.md +17 -4
  6. data/docs/Plan.md +3 -0
  7. data/docs/PlanCounty.md +0 -1
  8. data/docs/PlanCountyBulk.md +0 -1
  9. data/docs/PlanSearchResult.md +3 -0
  10. data/docs/PlanZipCounty.md +10 -0
  11. data/docs/PlansApi.md +17 -2
  12. data/docs/ProvidersApi.md +18 -8
  13. data/docs/RequestPlanFind.md +3 -0
  14. data/docs/ZipCountiesApi.md +10 -7
  15. data/lib/vericred_client/api/drugs_api.rb +7 -18
  16. data/lib/vericred_client/api/networks_api.rb +14 -13
  17. data/lib/vericred_client/api/plans_api.rb +24 -13
  18. data/lib/vericred_client/api/providers_api.rb +7 -15
  19. data/lib/vericred_client/api/zip_counties_api.rb +6 -14
  20. data/lib/vericred_client/api_client.rb +6 -10
  21. data/lib/vericred_client/api_error.rb +5 -10
  22. data/lib/vericred_client/configuration.rb +7 -0
  23. data/lib/vericred_client/models/applicant.rb +5 -10
  24. data/lib/vericred_client/models/base.rb +5 -10
  25. data/lib/vericred_client/models/carrier.rb +5 -10
  26. data/lib/vericred_client/models/carrier_subsidiary.rb +19 -14
  27. data/lib/vericred_client/models/county.rb +5 -10
  28. data/lib/vericred_client/models/county_bulk.rb +5 -10
  29. data/lib/vericred_client/models/drug.rb +5 -10
  30. data/lib/vericred_client/models/drug_coverage.rb +5 -10
  31. data/lib/vericred_client/models/drug_coverage_response.rb +5 -10
  32. data/lib/vericred_client/models/drug_package.rb +5 -10
  33. data/lib/vericred_client/models/drug_search_response.rb +5 -10
  34. data/lib/vericred_client/models/meta.rb +5 -10
  35. data/lib/vericred_client/models/network.rb +5 -10
  36. data/lib/vericred_client/models/network_search_response.rb +5 -10
  37. data/lib/vericred_client/models/plan.rb +36 -11
  38. data/lib/vericred_client/models/plan_county.rb +6 -21
  39. data/lib/vericred_client/models/plan_county_bulk.rb +6 -21
  40. data/lib/vericred_client/models/plan_search_response.rb +5 -10
  41. data/lib/vericred_client/models/plan_search_result.rb +36 -11
  42. data/lib/vericred_client/models/plan_zip_county.rb +313 -0
  43. data/lib/vericred_client/models/pricing.rb +5 -10
  44. data/lib/vericred_client/models/provider.rb +5 -10
  45. data/lib/vericred_client/models/provider_show_response.rb +5 -10
  46. data/lib/vericred_client/models/providers_search_response.rb +5 -10
  47. data/lib/vericred_client/models/rating_area.rb +5 -10
  48. data/lib/vericred_client/models/request_plan_find.rb +36 -11
  49. data/lib/vericred_client/models/request_plan_find_applicant.rb +5 -10
  50. data/lib/vericred_client/models/request_plan_find_provider.rb +5 -10
  51. data/lib/vericred_client/models/request_providers_search.rb +5 -10
  52. data/lib/vericred_client/models/state.rb +5 -10
  53. data/lib/vericred_client/models/zip_code.rb +5 -10
  54. data/lib/vericred_client/models/zip_counties_response.rb +5 -10
  55. data/lib/vericred_client/models/zip_county.rb +5 -10
  56. data/lib/vericred_client/models/zip_county_bulk.rb +5 -10
  57. data/lib/vericred_client/models/zip_county_response.rb +5 -10
  58. data/lib/vericred_client/version.rb +6 -11
  59. data/lib/vericred_client.rb +6 -10
  60. data/spec/api/drugs_api_spec.rb +5 -12
  61. data/spec/api/networks_api_spec.rb +8 -11
  62. data/spec/api/plans_api_spec.rb +14 -11
  63. data/spec/api/providers_api_spec.rb +5 -11
  64. data/spec/api/zip_counties_api_spec.rb +5 -11
  65. metadata +4 -2
@@ -31,17 +31,12 @@ The current version is `v3`. Previous versions are `v1` and `v2`.
31
31
 
32
32
  ## Pagination
33
33
 
34
- Most endpoints are not paginated. It will be noted in the documentation if/when
35
- an endpoint is paginated.
34
+ Endpoints that accept `page` and `per_page` parameters are paginated. They expose
35
+ four additional fields that contain data about your position in the response,
36
+ namely `Total`, `Per-Page`, `Link`, and `Page` as described in [RFC-5988](https://tools.ietf.org/html/rfc5988).
36
37
 
37
- When pagination is present, a `meta` stanza will be present in the response
38
- with the total number of records
39
-
40
- ```
41
- {
42
- things: [{ id: 1 }, { id: 2 }],
43
- meta: { total: 500 }
44
- }
38
+ For example, to display 5 results per page and view the second page of a
39
+ `GET` to `/networks`, your final request would be `GET /networks?....page=2&per_page=5`.
45
40
  ```
46
41
 
47
42
  ## Sideloading
@@ -136,9 +131,11 @@ module VericredClient
136
131
  # Networks
137
132
  # A network is a list of the doctors, other health care providers,
138
133
  and hospitals that a plan has contracted with to provide medical care to
139
- its members.
134
+ its members. This endpoint is paginated.
140
135
  # @param carrier_id Carrier HIOS Issuer ID
141
136
  # @param [Hash] opts the optional parameters
137
+ # @option opts [Integer] :page Page of paginated response
138
+ # @option opts [Integer] :per_page Responses per page
142
139
  # @return [NetworkSearchResponse]
143
140
  def list_networks(carrier_id, opts = {})
144
141
  data, _status_code, _headers = list_networks_with_http_info(carrier_id, opts)
@@ -148,9 +145,11 @@ its members.
148
145
  # Networks
149
146
  # A network is a list of the doctors, other health care providers,
150
147
  and hospitals that a plan has contracted with to provide medical care to
151
- its members.
148
+ its members. This endpoint is paginated.
152
149
  # @param carrier_id Carrier HIOS Issuer ID
153
150
  # @param [Hash] opts the optional parameters
151
+ # @option opts [Integer] :page Page of paginated response
152
+ # @option opts [Integer] :per_page Responses per page
154
153
  # @return [Array<(NetworkSearchResponse, Fixnum, Hash)>] NetworkSearchResponse data, response status code and response headers
155
154
  def list_networks_with_http_info(carrier_id, opts = {})
156
155
  if @api_client.config.debugging
@@ -164,6 +163,8 @@ its members.
164
163
  # query parameters
165
164
  query_params = {}
166
165
  query_params[:'carrier_id'] = carrier_id
166
+ query_params[:'page'] = opts[:'page'] if opts[:'page']
167
+ query_params[:'per_page'] = opts[:'per_page'] if opts[:'per_page']
167
168
 
168
169
  # header parameters
169
170
  header_params = {}
@@ -181,7 +182,7 @@ its members.
181
182
 
182
183
  # http body (model)
183
184
  post_body = nil
184
- auth_names = []
185
+ auth_names = ['Vericred-Api-Key']
185
186
  data, status_code, headers = @api_client.call_api(:GET, local_var_path,
186
187
  :header_params => header_params,
187
188
  :query_params => query_params,
@@ -31,17 +31,12 @@ The current version is `v3`. Previous versions are `v1` and `v2`.
31
31
 
32
32
  ## Pagination
33
33
 
34
- Most endpoints are not paginated. It will be noted in the documentation if/when
35
- an endpoint is paginated.
34
+ Endpoints that accept `page` and `per_page` parameters are paginated. They expose
35
+ four additional fields that contain data about your position in the response,
36
+ namely `Total`, `Per-Page`, `Link`, and `Page` as described in [RFC-5988](https://tools.ietf.org/html/rfc5988).
36
37
 
37
- When pagination is present, a `meta` stanza will be present in the response
38
- with the total number of records
39
-
40
- ```
41
- {
42
- things: [{ id: 1 }, { id: 2 }],
43
- meta: { total: 500 }
44
- }
38
+ For example, to display 5 results per page and view the second page of a
39
+ `GET` to `/networks`, your final request would be `GET /networks?....page=2&per_page=5`.
45
40
  ```
46
41
 
47
42
  ## Sideloading
@@ -138,7 +133,7 @@ module VericredClient
138
133
 
139
134
  Searching for a set of plans requires a `zip_code` and `fips_code`
140
135
  code. These are used to determine pricing and availabity
141
- of health plans.
136
+ of health plans. This endpoint is paginated.
142
137
 
143
138
  Optionally, you may provide a list of Applicants or Providers
144
139
 
@@ -195,6 +190,14 @@ and return it for each plan. If no values are provided, the
195
190
 
196
191
  `GET /plans?zip_code=07451&fips_code=33025&household_size=4&household_income=40000`
197
192
 
193
+
194
+ ### Sorting
195
+
196
+ Plans can be sorted by the `premium`, `carrier_name`, `level`, and `plan_type` fields,
197
+ by either ascending (as `asc`) or descending (as `dsc) sort under the `sort` field.
198
+
199
+ For example, to sort plans by level, the sort parameter would be `level:asc`.
200
+
198
201
  # @param [Hash] opts the optional parameters
199
202
  # @option opts [RequestPlanFind] :body
200
203
  # @return [PlanSearchResponse]
@@ -208,7 +211,7 @@ and return it for each plan. If no values are provided, the
208
211
 
209
212
  Searching for a set of plans requires a &#x60;zip_code&#x60; and &#x60;fips_code&#x60;
210
213
  code. These are used to determine pricing and availabity
211
- of health plans.
214
+ of health plans. This endpoint is paginated.
212
215
 
213
216
  Optionally, you may provide a list of Applicants or Providers
214
217
 
@@ -265,6 +268,14 @@ and return it for each plan. If no values are provided, the
265
268
 
266
269
  &#x60;GET /plans?zip_code&#x3D;07451&amp;fips_code&#x3D;33025&amp;household_size&#x3D;4&amp;household_income&#x3D;40000&#x60;
267
270
 
271
+
272
+ ### Sorting
273
+
274
+ Plans can be sorted by the &#x60;premium&#x60;, &#x60;carrier_name&#x60;, &#x60;level&#x60;, and &#x60;plan_type&#x60; fields,
275
+ by either ascending (as &#x60;asc&#x60;) or descending (as &#x60;dsc) sort under the &#x60;sort&#x60; field.
276
+
277
+ For example, to sort plans by level, the sort parameter would be &#x60;level:asc&#x60;.
278
+
268
279
  # @param [Hash] opts the optional parameters
269
280
  # @option opts [RequestPlanFind] :body
270
281
  # @return [Array<(PlanSearchResponse, Fixnum, Hash)>] PlanSearchResponse data, response status code and response headers
@@ -294,7 +305,7 @@ and return it for each plan. If no values are provided, the
294
305
 
295
306
  # http body (model)
296
307
  post_body = @api_client.object_to_http_body(opts[:'body'])
297
- auth_names = []
308
+ auth_names = ['Vericred-Api-Key']
298
309
  data, status_code, headers = @api_client.call_api(:POST, local_var_path,
299
310
  :header_params => header_params,
300
311
  :query_params => query_params,
@@ -31,17 +31,12 @@ The current version is `v3`. Previous versions are `v1` and `v2`.
31
31
 
32
32
  ## Pagination
33
33
 
34
- Most endpoints are not paginated. It will be noted in the documentation if/when
35
- an endpoint is paginated.
34
+ Endpoints that accept `page` and `per_page` parameters are paginated. They expose
35
+ four additional fields that contain data about your position in the response,
36
+ namely `Total`, `Per-Page`, `Link`, and `Page` as described in [RFC-5988](https://tools.ietf.org/html/rfc5988).
36
37
 
37
- When pagination is present, a `meta` stanza will be present in the response
38
- with the total number of records
39
-
40
- ```
41
- {
42
- things: [{ id: 1 }, { id: 2 }],
43
- meta: { total: 500 }
44
- }
38
+ For example, to display 5 results per page and view the second page of a
39
+ `GET` to `/networks`, your final request would be `GET /networks?....page=2&per_page=5`.
45
40
  ```
46
41
 
47
42
  ## Sideloading
@@ -137,7 +132,6 @@ module VericredClient
137
132
  # To retrieve a specific provider, just perform a GET using his NPI number
138
133
  # @param npi NPI number
139
134
  # @param [Hash] opts the optional parameters
140
- # @option opts [String] :vericred_api_key API Key
141
135
  # @return [ProviderShowResponse]
142
136
  def get_provider(npi, opts = {})
143
137
  data, _status_code, _headers = get_provider_with_http_info(npi, opts)
@@ -148,7 +142,6 @@ module VericredClient
148
142
  # To retrieve a specific provider, just perform a GET using his NPI number
149
143
  # @param npi NPI number
150
144
  # @param [Hash] opts the optional parameters
151
- # @option opts [String] :vericred_api_key API Key
152
145
  # @return [Array<(ProviderShowResponse, Fixnum, Hash)>] ProviderShowResponse data, response status code and response headers
153
146
  def get_provider_with_http_info(npi, opts = {})
154
147
  if @api_client.config.debugging
@@ -172,14 +165,13 @@ module VericredClient
172
165
  # HTTP header 'Content-Type'
173
166
  local_header_content_type = []
174
167
  header_params['Content-Type'] = @api_client.select_header_content_type(local_header_content_type)
175
- header_params[:'Vericred-Api-Key'] = opts[:'vericred_api_key'] if opts[:'vericred_api_key']
176
168
 
177
169
  # form parameters
178
170
  form_params = {}
179
171
 
180
172
  # http body (model)
181
173
  post_body = nil
182
- auth_names = []
174
+ auth_names = ['Vericred-Api-Key']
183
175
  data, status_code, headers = @api_client.call_api(:GET, local_var_path,
184
176
  :header_params => header_params,
185
177
  :query_params => query_params,
@@ -260,7 +252,7 @@ Specialty name search. So, searching &quot;John Smith nose&quot; would return
260
252
 
261
253
  # http body (model)
262
254
  post_body = @api_client.object_to_http_body(opts[:'body'])
263
- auth_names = []
255
+ auth_names = ['Vericred-Api-Key']
264
256
  data, status_code, headers = @api_client.call_api(:POST, local_var_path,
265
257
  :header_params => header_params,
266
258
  :query_params => query_params,
@@ -31,17 +31,12 @@ The current version is `v3`. Previous versions are `v1` and `v2`.
31
31
 
32
32
  ## Pagination
33
33
 
34
- Most endpoints are not paginated. It will be noted in the documentation if/when
35
- an endpoint is paginated.
34
+ Endpoints that accept `page` and `per_page` parameters are paginated. They expose
35
+ four additional fields that contain data about your position in the response,
36
+ namely `Total`, `Per-Page`, `Link`, and `Page` as described in [RFC-5988](https://tools.ietf.org/html/rfc5988).
36
37
 
37
- When pagination is present, a `meta` stanza will be present in the response
38
- with the total number of records
39
-
40
- ```
41
- {
42
- things: [{ id: 1 }, { id: 2 }],
43
- meta: { total: 500 }
44
- }
38
+ For example, to display 5 results per page and view the second page of a
39
+ `GET` to `/networks`, your final request would be `GET /networks?....page=2&per_page=5`.
45
40
  ```
46
41
 
47
42
  ## Sideloading
@@ -137,7 +132,6 @@ module VericredClient
137
132
  # Our `Plan` endpoints require a zip code and a fips (county) code. This is because plan pricing requires both of these elements. Users are unlikely to know their fips code, so we provide this endpoint to look up a `ZipCounty` by zip code and return both the selected zip and fips codes.
138
133
  # @param zip_prefix Partial five-digit Zip
139
134
  # @param [Hash] opts the optional parameters
140
- # @option opts [String] :vericred_api_key API Key
141
135
  # @return [ZipCountyResponse]
142
136
  def get_zip_counties(zip_prefix, opts = {})
143
137
  data, _status_code, _headers = get_zip_counties_with_http_info(zip_prefix, opts)
@@ -148,7 +142,6 @@ module VericredClient
148
142
  # Our &#x60;Plan&#x60; endpoints require a zip code and a fips (county) code. This is because plan pricing requires both of these elements. Users are unlikely to know their fips code, so we provide this endpoint to look up a &#x60;ZipCounty&#x60; by zip code and return both the selected zip and fips codes.
149
143
  # @param zip_prefix Partial five-digit Zip
150
144
  # @param [Hash] opts the optional parameters
151
- # @option opts [String] :vericred_api_key API Key
152
145
  # @return [Array<(ZipCountyResponse, Fixnum, Hash)>] ZipCountyResponse data, response status code and response headers
153
146
  def get_zip_counties_with_http_info(zip_prefix, opts = {})
154
147
  if @api_client.config.debugging
@@ -173,14 +166,13 @@ module VericredClient
173
166
  # HTTP header 'Content-Type'
174
167
  local_header_content_type = []
175
168
  header_params['Content-Type'] = @api_client.select_header_content_type(local_header_content_type)
176
- header_params[:'Vericred-Api-Key'] = opts[:'vericred_api_key'] if opts[:'vericred_api_key']
177
169
 
178
170
  # form parameters
179
171
  form_params = {}
180
172
 
181
173
  # http body (model)
182
174
  post_body = nil
183
- auth_names = []
175
+ auth_names = ['Vericred-Api-Key']
184
176
  data, status_code, headers = @api_client.call_api(:GET, local_var_path,
185
177
  :header_params => header_params,
186
178
  :query_params => query_params,
@@ -31,17 +31,12 @@ The current version is `v3`. Previous versions are `v1` and `v2`.
31
31
 
32
32
  ## Pagination
33
33
 
34
- Most endpoints are not paginated. It will be noted in the documentation if/when
35
- an endpoint is paginated.
34
+ Endpoints that accept `page` and `per_page` parameters are paginated. They expose
35
+ four additional fields that contain data about your position in the response,
36
+ namely `Total`, `Per-Page`, `Link`, and `Page` as described in [RFC-5988](https://tools.ietf.org/html/rfc5988).
36
37
 
37
- When pagination is present, a `meta` stanza will be present in the response
38
- with the total number of records
39
-
40
- ```
41
- {
42
- things: [{ id: 1 }, { id: 2 }],
43
- meta: { total: 500 }
44
- }
38
+ For example, to display 5 results per page and view the second page of a
39
+ `GET` to `/networks`, your final request would be `GET /networks?....page=2&per_page=5`.
45
40
  ```
46
41
 
47
42
  ## Sideloading
@@ -199,6 +194,7 @@ module VericredClient
199
194
  query_params = opts[:query_params] || {}
200
195
  form_params = opts[:form_params] || {}
201
196
 
197
+ update_params_for_auth! header_params, query_params, opts[:auth_names]
202
198
 
203
199
  req_opts = {
204
200
  :method => http_method,
@@ -31,17 +31,12 @@ The current version is `v3`. Previous versions are `v1` and `v2`.
31
31
 
32
32
  ## Pagination
33
33
 
34
- Most endpoints are not paginated. It will be noted in the documentation if/when
35
- an endpoint is paginated.
34
+ Endpoints that accept `page` and `per_page` parameters are paginated. They expose
35
+ four additional fields that contain data about your position in the response,
36
+ namely `Total`, `Per-Page`, `Link`, and `Page` as described in [RFC-5988](https://tools.ietf.org/html/rfc5988).
36
37
 
37
- When pagination is present, a `meta` stanza will be present in the response
38
- with the total number of records
39
-
40
- ```
41
- {
42
- things: [{ id: 1 }, { id: 2 }],
43
- meta: { total: 500 }
44
- }
38
+ For example, to display 5 results per page and view the second page of a
39
+ `GET` to `/networks`, your final request would be `GET /networks?....page=2&per_page=5`.
45
40
  ```
46
41
 
47
42
  ## Sideloading
@@ -157,6 +157,13 @@ module VericredClient
157
157
  # Returns Auth Settings hash for api client.
158
158
  def auth_settings
159
159
  {
160
+ 'Vericred-Api-Key' =>
161
+ {
162
+ type: 'api_key',
163
+ in: 'header',
164
+ key: 'Vericred-Api-Key',
165
+ value: api_key_with_prefix('Vericred-Api-Key')
166
+ },
160
167
  }
161
168
  end
162
169
  end
@@ -31,17 +31,12 @@ The current version is `v3`. Previous versions are `v1` and `v2`.
31
31
 
32
32
  ## Pagination
33
33
 
34
- Most endpoints are not paginated. It will be noted in the documentation if/when
35
- an endpoint is paginated.
34
+ Endpoints that accept `page` and `per_page` parameters are paginated. They expose
35
+ four additional fields that contain data about your position in the response,
36
+ namely `Total`, `Per-Page`, `Link`, and `Page` as described in [RFC-5988](https://tools.ietf.org/html/rfc5988).
36
37
 
37
- When pagination is present, a `meta` stanza will be present in the response
38
- with the total number of records
39
-
40
- ```
41
- {
42
- things: [{ id: 1 }, { id: 2 }],
43
- meta: { total: 500 }
44
- }
38
+ For example, to display 5 results per page and view the second page of a
39
+ `GET` to `/networks`, your final request would be `GET /networks?....page=2&per_page=5`.
45
40
  ```
46
41
 
47
42
  ## Sideloading
@@ -31,17 +31,12 @@ The current version is `v3`. Previous versions are `v1` and `v2`.
31
31
 
32
32
  ## Pagination
33
33
 
34
- Most endpoints are not paginated. It will be noted in the documentation if/when
35
- an endpoint is paginated.
34
+ Endpoints that accept `page` and `per_page` parameters are paginated. They expose
35
+ four additional fields that contain data about your position in the response,
36
+ namely `Total`, `Per-Page`, `Link`, and `Page` as described in [RFC-5988](https://tools.ietf.org/html/rfc5988).
36
37
 
37
- When pagination is present, a `meta` stanza will be present in the response
38
- with the total number of records
39
-
40
- ```
41
- {
42
- things: [{ id: 1 }, { id: 2 }],
43
- meta: { total: 500 }
44
- }
38
+ For example, to display 5 results per page and view the second page of a
39
+ `GET` to `/networks`, your final request would be `GET /networks?....page=2&per_page=5`.
45
40
  ```
46
41
 
47
42
  ## Sideloading
@@ -31,17 +31,12 @@ The current version is `v3`. Previous versions are `v1` and `v2`.
31
31
 
32
32
  ## Pagination
33
33
 
34
- Most endpoints are not paginated. It will be noted in the documentation if/when
35
- an endpoint is paginated.
34
+ Endpoints that accept `page` and `per_page` parameters are paginated. They expose
35
+ four additional fields that contain data about your position in the response,
36
+ namely `Total`, `Per-Page`, `Link`, and `Page` as described in [RFC-5988](https://tools.ietf.org/html/rfc5988).
36
37
 
37
- When pagination is present, a `meta` stanza will be present in the response
38
- with the total number of records
39
-
40
- ```
41
- {
42
- things: [{ id: 1 }, { id: 2 }],
43
- meta: { total: 500 }
44
- }
38
+ For example, to display 5 results per page and view the second page of a
39
+ `GET` to `/networks`, your final request would be `GET /networks?....page=2&per_page=5`.
45
40
  ```
46
41
 
47
42
  ## Sideloading
@@ -31,17 +31,12 @@ The current version is `v3`. Previous versions are `v1` and `v2`.
31
31
 
32
32
  ## Pagination
33
33
 
34
- Most endpoints are not paginated. It will be noted in the documentation if/when
35
- an endpoint is paginated.
34
+ Endpoints that accept `page` and `per_page` parameters are paginated. They expose
35
+ four additional fields that contain data about your position in the response,
36
+ namely `Total`, `Per-Page`, `Link`, and `Page` as described in [RFC-5988](https://tools.ietf.org/html/rfc5988).
36
37
 
37
- When pagination is present, a `meta` stanza will be present in the response
38
- with the total number of records
39
-
40
- ```
41
- {
42
- things: [{ id: 1 }, { id: 2 }],
43
- meta: { total: 500 }
44
- }
38
+ For example, to display 5 results per page and view the second page of a
39
+ `GET` to `/networks`, your final request would be `GET /networks?....page=2&per_page=5`.
45
40
  ```
46
41
 
47
42
  ## Sideloading
@@ -133,11 +128,15 @@ module VericredClient
133
128
  # Subsidiary name
134
129
  attr_accessor :name
135
130
 
131
+ # Parent Carrier Name
132
+ attr_accessor :alternate_name
133
+
136
134
  # Attribute mapping from ruby-style variable name to JSON key.
137
135
  def self.attribute_map
138
136
  {
139
137
  :'id' => :'id',
140
- :'name' => :'name'
138
+ :'name' => :'name',
139
+ :'alternate_name' => :'alternate_name'
141
140
  }
142
141
  end
143
142
 
@@ -145,7 +144,8 @@ module VericredClient
145
144
  def self.swagger_types
146
145
  {
147
146
  :'id' => :'Integer',
148
- :'name' => :'String'
147
+ :'name' => :'String',
148
+ :'alternate_name' => :'String'
149
149
  }
150
150
  end
151
151
 
@@ -165,6 +165,10 @@ module VericredClient
165
165
  self.name = attributes[:'name']
166
166
  end
167
167
 
168
+ if attributes.has_key?(:'alternate_name')
169
+ self.alternate_name = attributes[:'alternate_name']
170
+ end
171
+
168
172
  end
169
173
 
170
174
  # Show invalid properties with the reasons. Usually used together with valid?
@@ -185,7 +189,8 @@ module VericredClient
185
189
  return true if self.equal?(o)
186
190
  self.class == o.class &&
187
191
  id == o.id &&
188
- name == o.name
192
+ name == o.name &&
193
+ alternate_name == o.alternate_name
189
194
  end
190
195
 
191
196
  # @see the `==` method
@@ -197,7 +202,7 @@ module VericredClient
197
202
  # Calculates hash code according to all attributes.
198
203
  # @return [Fixnum] Hash code
199
204
  def hash
200
- [id, name].hash
205
+ [id, name, alternate_name].hash
201
206
  end
202
207
 
203
208
  # Builds the object from hash
@@ -31,17 +31,12 @@ The current version is `v3`. Previous versions are `v1` and `v2`.
31
31
 
32
32
  ## Pagination
33
33
 
34
- Most endpoints are not paginated. It will be noted in the documentation if/when
35
- an endpoint is paginated.
34
+ Endpoints that accept `page` and `per_page` parameters are paginated. They expose
35
+ four additional fields that contain data about your position in the response,
36
+ namely `Total`, `Per-Page`, `Link`, and `Page` as described in [RFC-5988](https://tools.ietf.org/html/rfc5988).
36
37
 
37
- When pagination is present, a `meta` stanza will be present in the response
38
- with the total number of records
39
-
40
- ```
41
- {
42
- things: [{ id: 1 }, { id: 2 }],
43
- meta: { total: 500 }
44
- }
38
+ For example, to display 5 results per page and view the second page of a
39
+ `GET` to `/networks`, your final request would be `GET /networks?....page=2&per_page=5`.
45
40
  ```
46
41
 
47
42
  ## Sideloading
@@ -31,17 +31,12 @@ The current version is `v3`. Previous versions are `v1` and `v2`.
31
31
 
32
32
  ## Pagination
33
33
 
34
- Most endpoints are not paginated. It will be noted in the documentation if/when
35
- an endpoint is paginated.
34
+ Endpoints that accept `page` and `per_page` parameters are paginated. They expose
35
+ four additional fields that contain data about your position in the response,
36
+ namely `Total`, `Per-Page`, `Link`, and `Page` as described in [RFC-5988](https://tools.ietf.org/html/rfc5988).
36
37
 
37
- When pagination is present, a `meta` stanza will be present in the response
38
- with the total number of records
39
-
40
- ```
41
- {
42
- things: [{ id: 1 }, { id: 2 }],
43
- meta: { total: 500 }
44
- }
38
+ For example, to display 5 results per page and view the second page of a
39
+ `GET` to `/networks`, your final request would be `GET /networks?....page=2&per_page=5`.
45
40
  ```
46
41
 
47
42
  ## Sideloading
@@ -31,17 +31,12 @@ The current version is `v3`. Previous versions are `v1` and `v2`.
31
31
 
32
32
  ## Pagination
33
33
 
34
- Most endpoints are not paginated. It will be noted in the documentation if/when
35
- an endpoint is paginated.
34
+ Endpoints that accept `page` and `per_page` parameters are paginated. They expose
35
+ four additional fields that contain data about your position in the response,
36
+ namely `Total`, `Per-Page`, `Link`, and `Page` as described in [RFC-5988](https://tools.ietf.org/html/rfc5988).
36
37
 
37
- When pagination is present, a `meta` stanza will be present in the response
38
- with the total number of records
39
-
40
- ```
41
- {
42
- things: [{ id: 1 }, { id: 2 }],
43
- meta: { total: 500 }
44
- }
38
+ For example, to display 5 results per page and view the second page of a
39
+ `GET` to `/networks`, your final request would be `GET /networks?....page=2&per_page=5`.
45
40
  ```
46
41
 
47
42
  ## Sideloading
@@ -31,17 +31,12 @@ The current version is `v3`. Previous versions are `v1` and `v2`.
31
31
 
32
32
  ## Pagination
33
33
 
34
- Most endpoints are not paginated. It will be noted in the documentation if/when
35
- an endpoint is paginated.
34
+ Endpoints that accept `page` and `per_page` parameters are paginated. They expose
35
+ four additional fields that contain data about your position in the response,
36
+ namely `Total`, `Per-Page`, `Link`, and `Page` as described in [RFC-5988](https://tools.ietf.org/html/rfc5988).
36
37
 
37
- When pagination is present, a `meta` stanza will be present in the response
38
- with the total number of records
39
-
40
- ```
41
- {
42
- things: [{ id: 1 }, { id: 2 }],
43
- meta: { total: 500 }
44
- }
38
+ For example, to display 5 results per page and view the second page of a
39
+ `GET` to `/networks`, your final request would be `GET /networks?....page=2&per_page=5`.
45
40
  ```
46
41
 
47
42
  ## Sideloading
@@ -31,17 +31,12 @@ The current version is `v3`. Previous versions are `v1` and `v2`.
31
31
 
32
32
  ## Pagination
33
33
 
34
- Most endpoints are not paginated. It will be noted in the documentation if/when
35
- an endpoint is paginated.
34
+ Endpoints that accept `page` and `per_page` parameters are paginated. They expose
35
+ four additional fields that contain data about your position in the response,
36
+ namely `Total`, `Per-Page`, `Link`, and `Page` as described in [RFC-5988](https://tools.ietf.org/html/rfc5988).
36
37
 
37
- When pagination is present, a `meta` stanza will be present in the response
38
- with the total number of records
39
-
40
- ```
41
- {
42
- things: [{ id: 1 }, { id: 2 }],
43
- meta: { total: 500 }
44
- }
38
+ For example, to display 5 results per page and view the second page of a
39
+ `GET` to `/networks`, your final request would be `GET /networks?....page=2&per_page=5`.
45
40
  ```
46
41
 
47
42
  ## Sideloading
@@ -31,17 +31,12 @@ The current version is `v3`. Previous versions are `v1` and `v2`.
31
31
 
32
32
  ## Pagination
33
33
 
34
- Most endpoints are not paginated. It will be noted in the documentation if/when
35
- an endpoint is paginated.
34
+ Endpoints that accept `page` and `per_page` parameters are paginated. They expose
35
+ four additional fields that contain data about your position in the response,
36
+ namely `Total`, `Per-Page`, `Link`, and `Page` as described in [RFC-5988](https://tools.ietf.org/html/rfc5988).
36
37
 
37
- When pagination is present, a `meta` stanza will be present in the response
38
- with the total number of records
39
-
40
- ```
41
- {
42
- things: [{ id: 1 }, { id: 2 }],
43
- meta: { total: 500 }
44
- }
38
+ For example, to display 5 results per page and view the second page of a
39
+ `GET` to `/networks`, your final request would be `GET /networks?....page=2&per_page=5`.
45
40
  ```
46
41
 
47
42
  ## Sideloading