Class: CandidApiClient::OrganizationServiceFacilities::V2::V2Client

Inherits:
Object
  • Object
show all
Defined in:
lib/candidhealth/organization_service_facilities/v_2/client.rb

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(request_client:) ⇒ CandidApiClient::OrganizationServiceFacilities::V2::V2Client

Parameters:



20
21
22
 
# File 'lib/candidhealth/organization_service_facilities/v_2/client.rb', line 20

def initialize(request_client:)
  @request_client = request_client
end

Instance Attribute Details

#request_client ⇒ CandidApiClient::RequestClient (readonly)

Returns:



16
17
18
 
# File 'lib/candidhealth/organization_service_facilities/v_2/client.rb', line 16

def request_client
  @request_client
end

Instance Method Details

#create(request:, request_options: nil) ⇒ CandidApiClient::OrganizationServiceFacilities::V2::Types::OrganizationServiceFacility

Examples:

api = CandidApiClient::Client.new(base_url: "https://api.example.com", environment: CandidApiClient::Environment::PRODUCTION)
api.organization_service_facilities.v_2.create(request: { name: "Test Service Facility", aliases: ["Test Service Facility Alias"], description: "Test Service Facility Description", status: ACTIVE, operational_status: CLOSED, mode: INSTANCE, type: DIAGNOSTICS_OR_THERAPEUTICS_UNIT, physical_type: SITE, telecoms: ["555-555-5555"], address: { address_1: "123 Main St", address_2: "Apt 1", city: "New York", state: NY, zip_code: "10001", zip_plus_four_code: "1234" } })

Parameters:

  • request (Hash) —

    Request of type CandidApiClient::OrganizationServiceFacilities::V2::Types::OrganizationServiceFacilityCreate, as a Hash

    • :name (String)

    • :aliases (Array<String>)

    • :description (String)

    • :external_id (String)

    • :npi (String)

    • :place_of_service_code (CandidApiClient::Commons::Types::FacilityTypeCode)

    • :status (CandidApiClient::OrganizationServiceFacilities::V2::Types::ServiceFacilityStatus)

    • :operational_status (CandidApiClient::OrganizationServiceFacilities::V2::Types::ServiceFacilityOperationalStatus)

    • :mode (CandidApiClient::OrganizationServiceFacilities::V2::Types::ServiceFacilityMode)

    • :type (CandidApiClient::OrganizationServiceFacilities::V2::Types::ServiceFacilityType)

    • :physical_type (CandidApiClient::OrganizationServiceFacilities::V2::Types::ServiceFacilityPhysicalType)

    • :telecoms (Array<String>)

    • :address (Hash)

      • :zip_plus_four_code (String)

      • :address_1 (String)

      • :address_2 (String)

      • :city (String)

      • :state (CandidApiClient::Commons::Types::State)

      • :zip_code (String)

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

Returns:



137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
 
# File 'lib/candidhealth/organization_service_facilities/v_2/client.rb', line 137

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/organization-service-facilities/v2"
  end
  CandidApiClient::OrganizationServiceFacilities::V2::Types::OrganizationServiceFacility.from_json(json_object: response.body)
end

#delete(organization_service_facility_id:, request_options: nil) ⇒ Void

Examples:

api = CandidApiClient::Client.new(base_url: "https://api.example.com", environment: CandidApiClient::Environment::PRODUCTION)
api.organization_service_facilities.v_2.delete(organization_service_facility_id: "30F55EE6-8C0E-43FC-A7FC-DAC00D5BF569")

Parameters:

Returns:

  • (Void) 


201
202
203
204
205
206
207
208
209
210
211
212
213
 
# File 'lib/candidhealth/organization_service_facilities/v_2/client.rb', line 201

def delete(organization_service_facility_id:, request_options: nil)
  @request_client.conn.delete 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/organization-service-facilities/v2/#{organization_service_facility_id}"
  end
end

#get(organization_service_facility_id:, request_options: nil) ⇒ CandidApiClient::OrganizationServiceFacilities::V2::Types::OrganizationServiceFacility

Examples:

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

Parameters:

Returns:



30
31
32
33
34
35
36
37
38
39
40
41
42
43
 
# File 'lib/candidhealth/organization_service_facilities/v_2/client.rb', line 30

def get(organization_service_facility_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/organization-service-facilities/v2/#{organization_service_facility_id}"
  end
  CandidApiClient::OrganizationServiceFacilities::V2::Types::OrganizationServiceFacility.from_json(json_object: response.body)
end

#get_by_external_id(external_id:, request_options: nil) ⇒ CandidApiClient::OrganizationServiceFacilities::V2::Types::OrganizationServiceFacility

Looks up a single organization service facility by its ‘external_id` field. This

can be useful
for finding service facilities within Candid which are associated with service
facilities in
an external system.

Examples:

api = CandidApiClient::Client.new(base_url: "https://api.example.com", environment: CandidApiClient::Environment::PRODUCTION)
api.organization_service_facilities.v_2.get_by_external_id(external_id: "external_id")

Parameters:

Returns:



97
98
99
100
101
102
103
104
105
106
107
108
109
110
 
# File 'lib/candidhealth/organization_service_facilities/v_2/client.rb', line 97

def get_by_external_id(external_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/organization-service-facilities/v2/external-id/#{external_id}"
  end
  CandidApiClient::OrganizationServiceFacilities::V2::Types::OrganizationServiceFacility.from_json(json_object: response.body)
end

#get_multi(limit: nil, name: nil, organization_service_facility_ids: nil, external_ids: nil, place_of_service_code: nil, page_token: nil, request_options: nil) ⇒ CandidApiClient::OrganizationServiceFacilities::V2::Types::OrganizationServiceFacilityPage

Examples:

api = CandidApiClient::Client.new(base_url: "https://api.example.com", environment: CandidApiClient::Environment::PRODUCTION)
api.organization_service_facilities.v_2.get_multi(
  limit: 100,
  name: "Test Service Facility",
  page_token: "eyJ0b2tlbiI6IjEiLCJwYWdlX3Rva2VuIjoiMiJ9"
)

Parameters:

  • limit (Integer) (defaults to: nil) —

    Limit the number of results returned. Defaults to 100.

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

    Filter to a name or a part of a name.

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

    Filter to the provided organization service facility IDs.

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

    Filter by one or more external_ids.

  • place_of_service_code (CandidApiClient::Commons::Types::FacilityTypeCode) (defaults to: nil) —

    Filter by Place of Service (POS) code.

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

    The page token to continue paging through a previous request.

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

Returns:



60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
 
# File 'lib/candidhealth/organization_service_facilities/v_2/client.rb', line 60

def get_multi(limit: nil, name: nil, organization_service_facility_ids: nil, external_ids: nil,
              place_of_service_code: 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 || {}),
      "limit": limit,
      "name": name,
      "organization_service_facility_ids": organization_service_facility_ids,
      "external_ids": external_ids,
      "place_of_service_code": place_of_service_code,
      "page_token": page_token
    }.compact
    req.url "#{@request_client.get_url(environment: CandidApi,
                                       request_options: request_options)}/api/organization-service-facilities/v2"
  end
  CandidApiClient::OrganizationServiceFacilities::V2::Types::OrganizationServiceFacilityPage.from_json(json_object: response.body)
end

#update(organization_service_facility_id:, request:, request_options: nil) ⇒ CandidApiClient::OrganizationServiceFacilities::V2::Types::OrganizationServiceFacility

Examples:

api = CandidApiClient::Client.new(base_url: "https://api.example.com", environment: CandidApiClient::Environment::PRODUCTION)
api.organization_service_facilities.v_2.update(organization_service_facility_id: "30F55EE6-8C0E-43FC-A7FC-DAC00D5BF569", request: { name: "Test Service Facility", aliases: ["Test Service Facility Alias"], description: "Test Service Facility Description", status: ACTIVE, operational_status: CLOSED, mode: INSTANCE, type: DIAGNOSTICS_OR_THERAPEUTICS_UNIT, physical_type: SITE, telecoms: ["555-555-5555"], address: { address_1: "123 Main St", address_2: "Apt 1", city: "New York", state: NY, zip_code: "10001", zip_plus_four_code: "1234" } })

Parameters:

  • organization_service_facility_id (String)
  • request (Hash) —

    Request of type CandidApiClient::OrganizationServiceFacilities::V2::Types::OrganizationServiceFacilityUpdate, as a Hash

    • :name (String)

    • :aliases (Array<String>)

    • :description (String)

    • :external_id (String)

    • :npi (String)

    • :place_of_service_code (CandidApiClient::Commons::Types::FacilityTypeCode)

    • :status (CandidApiClient::OrganizationServiceFacilities::V2::Types::ServiceFacilityStatus)

    • :operational_status (CandidApiClient::OrganizationServiceFacilities::V2::Types::ServiceFacilityOperationalStatus)

    • :mode (CandidApiClient::OrganizationServiceFacilities::V2::Types::ServiceFacilityMode)

    • :type (CandidApiClient::OrganizationServiceFacilities::V2::Types::ServiceFacilityType)

    • :physical_type (CandidApiClient::OrganizationServiceFacilities::V2::Types::ServiceFacilityPhysicalType)

    • :telecoms (Array<String>)

    • :address (Hash)

      • :zip_plus_four_code (String)

      • :address_1 (String)

      • :address_2 (String)

      • :city (String)

      • :state (CandidApiClient::Commons::Types::State)

      • :zip_code (String)

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

Returns:



179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
 
# File 'lib/candidhealth/organization_service_facilities/v_2/client.rb', line 179

def update(organization_service_facility_id:, request:, 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.body = { **(request || {}), **(request_options&.additional_body_parameters || {}) }.compact
    req.url "#{@request_client.get_url(environment: CandidApi,
                                       request_options: request_options)}/api/organization-service-facilities/v2/#{organization_service_facility_id}"
  end
  CandidApiClient::OrganizationServiceFacilities::V2::Types::OrganizationServiceFacility.from_json(json_object: response.body)
end