Class: CandidApiClient::ClinicalTrials::V1::Types::ClinicalTrial

Inherits:
Object
  • Object
show all
Defined in:
lib/candidhealth/clinical_trials/v_1/types/clinical_trial.rb

Constant Summary collapse

OMIT = 
Object.new

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(clinical_trial_id:, non_insurance_payer_id:, is_active:, name:, clinical_trial_number:, clinical_trial_phase: OMIT, additional_properties: nil) ⇒ CandidApiClient::ClinicalTrials::V1::Types::ClinicalTrial

Parameters:

  • clinical_trial_id (String)
  • non_insurance_payer_id (String)
  • is_active (Boolean)
  • name (String)
  • clinical_trial_number (String) —

    Must be 8 characters long

  • clinical_trial_phase (CandidApiClient::ClinicalTrials::V1::Types::ClinicalTrialPhase) (defaults to: OMIT)
  • additional_properties (OpenStruct) (defaults to: nil) —

    Additional properties unmapped to the current class definition



40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
 
# File 'lib/candidhealth/clinical_trials/v_1/types/clinical_trial.rb', line 40

def initialize(clinical_trial_id:, non_insurance_payer_id:, is_active:, name:, clinical_trial_number:,
               clinical_trial_phase: OMIT, additional_properties: nil)
  @clinical_trial_id = clinical_trial_id
  @non_insurance_payer_id = non_insurance_payer_id
  @is_active = is_active
  @name = name
  @clinical_trial_number = clinical_trial_number
  @clinical_trial_phase = clinical_trial_phase if clinical_trial_phase != OMIT
  @additional_properties = additional_properties
  @_field_set = {
    "clinical_trial_id": clinical_trial_id,
    "non_insurance_payer_id": non_insurance_payer_id,
    "is_active": is_active,
    "name": name,
    "clinical_trial_number": clinical_trial_number,
    "clinical_trial_phase": clinical_trial_phase
  }.reject do |_k, v|
    v == OMIT
  end
end

Instance Attribute Details

#additional_properties ⇒ OpenStruct (readonly)

Returns Additional properties unmapped to the current class definition.

Returns:

  • (OpenStruct) —

    Additional properties unmapped to the current class definition



25
26
27
 
# File 'lib/candidhealth/clinical_trials/v_1/types/clinical_trial.rb', line 25

def additional_properties
  @additional_properties
end

#clinical_trial_id ⇒ String (readonly)

Returns:

  • (String) 


13
14
15
 
# File 'lib/candidhealth/clinical_trials/v_1/types/clinical_trial.rb', line 13

def clinical_trial_id
  @clinical_trial_id
end

#clinical_trial_number ⇒ String (readonly)

Returns Must be 8 characters long.

Returns:

  • (String) —

    Must be 8 characters long



21
22
23
 
# File 'lib/candidhealth/clinical_trials/v_1/types/clinical_trial.rb', line 21

def clinical_trial_number
  @clinical_trial_number
end

#clinical_trial_phase ⇒ CandidApiClient::ClinicalTrials::V1::Types::ClinicalTrialPhase (readonly)

Returns:



23
24
25
 
# File 'lib/candidhealth/clinical_trials/v_1/types/clinical_trial.rb', line 23

def clinical_trial_phase
  @clinical_trial_phase
end

#is_active ⇒ Boolean (readonly)

Returns:

  • (Boolean) 


17
18
19
 
# File 'lib/candidhealth/clinical_trials/v_1/types/clinical_trial.rb', line 17

def is_active
  @is_active
end

#name ⇒ String (readonly)

Returns:

  • (String) 


19
20
21
 
# File 'lib/candidhealth/clinical_trials/v_1/types/clinical_trial.rb', line 19

def name
  @name
end

#non_insurance_payer_id ⇒ String (readonly)

Returns:

  • (String) 


15
16
17
 
# File 'lib/candidhealth/clinical_trials/v_1/types/clinical_trial.rb', line 15

def non_insurance_payer_id
  @non_insurance_payer_id
end

Class Method Details

.from_json(json_object:) ⇒ CandidApiClient::ClinicalTrials::V1::Types::ClinicalTrial

Deserialize a JSON object to an instance of ClinicalTrial

Parameters:

  • json_object (String)

Returns:



65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
 
# File 'lib/candidhealth/clinical_trials/v_1/types/clinical_trial.rb', line 65

def self.from_json(json_object:)
  struct = JSON.parse(json_object, object_class: OpenStruct)
  clinical_trial_id = struct["clinical_trial_id"]
  non_insurance_payer_id = struct["non_insurance_payer_id"]
  is_active = struct["is_active"]
  name = struct["name"]
  clinical_trial_number = struct["clinical_trial_number"]
  clinical_trial_phase = struct["clinical_trial_phase"]
  new(
    clinical_trial_id: clinical_trial_id,
    non_insurance_payer_id: non_insurance_payer_id,
    is_active: is_active,
    name: name,
    clinical_trial_number: clinical_trial_number,
    clinical_trial_phase: clinical_trial_phase,
    additional_properties: struct
  )
end

.validate_raw(obj:) ⇒ Void

Leveraged for Union-type generation, validate_raw attempts to parse the given

hash and check each fields type against the current object's property
definitions.

Parameters:

  • obj (Object)

Returns:

  • (Void) 


97
98
99
100
101
102
103
104
 
# File 'lib/candidhealth/clinical_trials/v_1/types/clinical_trial.rb', line 97

def self.validate_raw(obj:)
  obj.clinical_trial_id.is_a?(String) != false || raise("Passed value for field obj.clinical_trial_id is not the expected type, validation failed.")
  obj.non_insurance_payer_id.is_a?(String) != false || raise("Passed value for field obj.non_insurance_payer_id is not the expected type, validation failed.")
  obj.is_active.is_a?(Boolean) != false || raise("Passed value for field obj.is_active is not the expected type, validation failed.")
  obj.name.is_a?(String) != false || raise("Passed value for field obj.name is not the expected type, validation failed.")
  obj.clinical_trial_number.is_a?(String) != false || raise("Passed value for field obj.clinical_trial_number is not the expected type, validation failed.")
  obj.clinical_trial_phase&.is_a?(CandidApiClient::ClinicalTrials::V1::Types::ClinicalTrialPhase) != false || raise("Passed value for field obj.clinical_trial_phase is not the expected type, validation failed.")
end

Instance Method Details

#to_json(*_args) ⇒ String

Serialize an instance of ClinicalTrial to a JSON object

Returns:

  • (String) 


87
88
89
 
# File 'lib/candidhealth/clinical_trials/v_1/types/clinical_trial.rb', line 87

def to_json(*_args)
  @_field_set&.to_json
end