Class: CandidApiClient::PayerPlanGroups::V1::V1Client

Inherits:
Object
  • Object
show all
Defined in:
lib/candidhealth/payer_plan_groups/v_1/client.rb

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(request_client:) ⇒ CandidApiClient::PayerPlanGroups::V1::V1Client

Parameters:



21
22
23
 
# File 'lib/candidhealth/payer_plan_groups/v_1/client.rb', line 21

def initialize(request_client:)
  @request_client = request_client
end

Instance Attribute Details

#request_client ⇒ CandidApiClient::RequestClient (readonly)

Returns:



17
18
19
 
# File 'lib/candidhealth/payer_plan_groups/v_1/client.rb', line 17

def request_client
  @request_client
end

Instance Method Details

#create(request:, request_options: nil) ⇒ CandidApiClient::PayerPlanGroups::V1::Types::PayerPlanGroup

Create a payer plan group

Examples:

api = CandidApiClient::Client.new(base_url: "https://api.example.com", environment: CandidApiClient::Environment::PRODUCTION)
api.payer_plan_groups.v_1.create(request: { plan_group_name: "plan_group_name", payer_uuid: "d5e9c84f-c2b2-4bf4-b4b0-7ffd7a9ffc32", plan_type: SELF_PAY })

Parameters:

  • request (Hash) —

    Request of type CandidApiClient::PayerPlanGroups::V1::Types::MutablePayerPlanGroup, as a Hash

    • :plan_group_name (String)

    • :payer_uuid (String)

    • :plan_type (CandidApiClient::Commons::Types::SourceOfPaymentCode)

  • request_options (CandidApiClient::RequestOptions) (defaults to: nil)

Returns:



112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
 
# File 'lib/candidhealth/payer_plan_groups/v_1/client.rb', line 112

def create(request:, request_options: nil)
  response = @request_client.conn.post do |req|
    req.options.timeout = request_options.timeout_in_seconds unless request_options&.timeout_in_seconds.nil?
    req.headers["Authorization"] = request_options.token unless request_options&.token.nil?
    req.headers = {
  **(req.headers || {}),
  **@request_client.get_headers,
  **(request_options&.additional_headers || {})
    }.compact
    req.body = { **(request || {}), **(request_options&.additional_body_parameters || {}) }.compact
    req.url "#{@request_client.get_url(environment: CandidApi,
                                       request_options: request_options)}/api/payer-plan-groups/v1"
  end
  CandidApiClient::PayerPlanGroups::V1::Types::PayerPlanGroup.from_json(json_object: response.body)
end

#deactivate(payer_plan_group_id:, request_options: nil) ⇒ CandidApiClient::PayerPlanGroups::V1::Types::PayerPlanGroup

Marks the payer plan group as deactivated

Examples:

api = CandidApiClient::Client.new(base_url: "https://api.example.com", environment: CandidApiClient::Environment::PRODUCTION)
api.payer_plan_groups.v_1.deactivate(payer_plan_group_id: "d5e9c84f-c2b2-4bf4-b4b0-7ffd7a9ffc32")

Parameters:

Returns:



164
165
166
167
168
169
170
171
172
173
174
175
176
177
 
# File 'lib/candidhealth/payer_plan_groups/v_1/client.rb', line 164

def deactivate(payer_plan_group_id:, request_options: nil)
  response = @request_client.conn.patch do |req|
    req.options.timeout = request_options.timeout_in_seconds unless request_options&.timeout_in_seconds.nil?
    req.headers["Authorization"] = request_options.token unless request_options&.token.nil?
    req.headers = {
  **(req.headers || {}),
  **@request_client.get_headers,
  **(request_options&.additional_headers || {})
    }.compact
    req.url "#{@request_client.get_url(environment: CandidApi,
                                       request_options: request_options)}/api/payer-plan-groups/v1/#{payer_plan_group_id}"
  end
  CandidApiClient::PayerPlanGroups::V1::Types::PayerPlanGroup.from_json(json_object: response.body)
end

#get(payer_plan_group_id:, request_options: nil) ⇒ CandidApiClient::PayerPlanGroups::V1::Types::PayerPlanGroup

Return a plan group with a given ID.

Examples:

api = CandidApiClient::Client.new(base_url: "https://api.example.com", environment: CandidApiClient::Environment::PRODUCTION)
api.payer_plan_groups.v_1.get(payer_plan_group_id: "d5e9c84f-c2b2-4bf4-b4b0-7ffd7a9ffc32")

Parameters:

Returns:



86
87
88
89
90
91
92
93
94
95
96
97
98
99
 
# File 'lib/candidhealth/payer_plan_groups/v_1/client.rb', line 86

def get(payer_plan_group_id:, request_options: nil)
  response = @request_client.conn.get do |req|
    req.options.timeout = request_options.timeout_in_seconds unless request_options&.timeout_in_seconds.nil?
    req.headers["Authorization"] = request_options.token unless request_options&.token.nil?
    req.headers = {
  **(req.headers || {}),
  **@request_client.get_headers,
  **(request_options&.additional_headers || {})
    }.compact
    req.url "#{@request_client.get_url(environment: CandidApi,
                                       request_options: request_options)}/api/payer-plan-groups/v1/#{payer_plan_group_id}"
  end
  CandidApiClient::PayerPlanGroups::V1::Types::PayerPlanGroup.from_json(json_object: response.body)
end

#get_multi(plan_group_name: nil, payer_uuid: nil, payer_id: nil, plan_type: nil, is_active: nil, payer_plan_group_id: nil, limit: nil, sort_by_similarity: nil, sort: nil, sort_direction: nil, page_token: nil, request_options: nil) ⇒ CandidApiClient::PayerPlanGroups::V1::Types::PayerPlanGroupPage

Returns all payer plan groups matching filter criteria.

Examples:

api = CandidApiClient::Client.new(base_url: "https://api.example.com", environment: CandidApiClient::Environment::PRODUCTION)
api.payer_plan_groups.v_1.get_multi

Parameters:

  • plan_group_name (String) (defaults to: nil)
  • payer_uuid (String) (defaults to: nil)
  • payer_id (String) (defaults to: nil)
  • plan_type (CandidApiClient::Commons::Types::SourceOfPaymentCode) (defaults to: nil)
  • is_active (Boolean) (defaults to: nil)
  • payer_plan_group_id (String) (defaults to: nil)
  • limit (Integer) (defaults to: nil) —

    Defaults to 100. Cannot exc

  • sort_by_similarity (String) (defaults to: nil) —

    If this property is passed, the results will be ordered by those that contain a payer_id, payer_name, plan_group_name, or payer_address most similar to the value passed. This will take precedence over the sort and sort_direction properties. This will always sort in order of most similar to least similar.

  • sort (CandidApiClient::PayerPlanGroups::V1::Types::PayerPlanGroupSortField) (defaults to: nil) —

    Defaults to plan_group_name. If sort_by_similarity is passed, that sort will takes precedence over this property.

  • sort_direction (CandidApiClient::Commons::Types::SortDirection) (defaults to: nil) —

    Sort direction. Defaults to ascending order if not provided.

  • page_token (String) (defaults to: nil)
  • request_options (CandidApiClient::RequestOptions) (defaults to: nil)

Returns:



48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
 
# File 'lib/candidhealth/payer_plan_groups/v_1/client.rb', line 48

def get_multi(plan_group_name: nil, payer_uuid: nil, payer_id: nil, plan_type: nil, is_active: nil,
              payer_plan_group_id: nil, limit: nil, sort_by_similarity: nil, sort: nil, sort_direction: nil, page_token: nil, request_options: nil)
  response = @request_client.conn.get do |req|
    req.options.timeout = request_options.timeout_in_seconds unless request_options&.timeout_in_seconds.nil?
    req.headers["Authorization"] = request_options.token unless request_options&.token.nil?
    req.headers = {
  **(req.headers || {}),
  **@request_client.get_headers,
  **(request_options&.additional_headers || {})
    }.compact
    req.params = {
      **(request_options&.additional_query_parameters || {}),
      "plan_group_name": plan_group_name,
      "payer_uuid": payer_uuid,
      "payer_id": payer_id,
      "plan_type": plan_type,
      "is_active": is_active,
      "payer_plan_group_id": payer_plan_group_id,
      "limit": limit,
      "sort_by_similarity": sort_by_similarity,
      "sort": sort,
      "sort_direction": sort_direction,
      "page_token": page_token
    }.compact
    req.url "#{@request_client.get_url(environment: CandidApi,
                                       request_options: request_options)}/api/payer-plan-groups/v1"
  end
  CandidApiClient::PayerPlanGroups::V1::Types::PayerPlanGroupPage.from_json(json_object: response.body)
end

#update(payer_plan_group_id:, request:, request_options: nil) ⇒ CandidApiClient::PayerPlanGroups::V1::Types::PayerPlanGroup

Update any of the fields on a payer plan group

Examples:

api = CandidApiClient::Client.new(base_url: "https://api.example.com", environment: CandidApiClient::Environment::PRODUCTION)
api.payer_plan_groups.v_1.update(payer_plan_group_id: "d5e9c84f-c2b2-4bf4-b4b0-7ffd7a9ffc32", request: { plan_group_name: "plan_group_name", payer_uuid: "d5e9c84f-c2b2-4bf4-b4b0-7ffd7a9ffc32", plan_type: SELF_PAY })

Parameters:

  • payer_plan_group_id (String)
  • request (Hash) —

    Request of type CandidApiClient::PayerPlanGroups::V1::Types::MutablePayerPlanGroup, as a Hash

    • :plan_group_name (String)

    • :payer_uuid (String)

    • :plan_type (CandidApiClient::Commons::Types::SourceOfPaymentCode)

  • request_options (CandidApiClient::RequestOptions) (defaults to: nil)

Returns:



140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
 
# File 'lib/candidhealth/payer_plan_groups/v_1/client.rb', line 140

def update(payer_plan_group_id:, request:, request_options: nil)
  response = @request_client.conn.put do |req|
    req.options.timeout = request_options.timeout_in_seconds unless request_options&.timeout_in_seconds.nil?
    req.headers["Authorization"] = request_options.token unless request_options&.token.nil?
    req.headers = {
  **(req.headers || {}),
  **@request_client.get_headers,
  **(request_options&.additional_headers || {})
    }.compact
    req.body = { **(request || {}), **(request_options&.additional_body_parameters || {}) }.compact
    req.url "#{@request_client.get_url(environment: CandidApi,
                                       request_options: request_options)}/api/payer-plan-groups/v1/#{payer_plan_group_id}"
  end
  CandidApiClient::PayerPlanGroups::V1::Types::PayerPlanGroup.from_json(json_object: response.body)
end