Class: CandidApiClient::Commons::Types::ResourcePage

Inherits:
Object
  • Object
show all
Defined in:
lib/candidhealth/commons/types/resource_page.rb

Constant Summary collapse

OMIT =
Object.new

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(prev_page_token: OMIT, next_page_token: OMIT, additional_properties: nil) ⇒ CandidApiClient::Commons::Types::ResourcePage

Parameters:

  • prev_page_token (String) (defaults to: OMIT)
  • next_page_token (String) (defaults to: OMIT)
  • additional_properties (OpenStruct) (defaults to: nil)

    Additional properties unmapped to the current class definition



26
27
28
29
30
31
32
33
# File 'lib/candidhealth/commons/types/resource_page.rb', line 26

def initialize(prev_page_token: OMIT, next_page_token: OMIT, additional_properties: nil)
  @prev_page_token = prev_page_token if prev_page_token != OMIT
  @next_page_token = next_page_token if next_page_token != OMIT
  @additional_properties = additional_properties
  @_field_set = { "prev_page_token": prev_page_token, "next_page_token": next_page_token }.reject do |_k, v|
    v == OMIT
  end
end

Instance Attribute Details

#additional_propertiesOpenStruct (readonly)

Returns Additional properties unmapped to the current class definition.

Returns:

  • (OpenStruct)

    Additional properties unmapped to the current class definition



15
16
17
# File 'lib/candidhealth/commons/types/resource_page.rb', line 15

def additional_properties
  @additional_properties
end

#next_page_tokenString (readonly)

Returns:

  • (String)


13
14
15
# File 'lib/candidhealth/commons/types/resource_page.rb', line 13

def next_page_token
  @next_page_token
end

#prev_page_tokenString (readonly)

Returns:

  • (String)


11
12
13
# File 'lib/candidhealth/commons/types/resource_page.rb', line 11

def prev_page_token
  @prev_page_token
end

Class Method Details

.from_json(json_object:) ⇒ CandidApiClient::Commons::Types::ResourcePage

Deserialize a JSON object to an instance of ResourcePage

Parameters:

  • json_object (String)

Returns:



39
40
41
42
43
44
45
46
47
48
# File 'lib/candidhealth/commons/types/resource_page.rb', line 39

def self.from_json(json_object:)
  struct = JSON.parse(json_object, object_class: OpenStruct)
  prev_page_token = struct["prev_page_token"]
  next_page_token = struct["next_page_token"]
  new(
    prev_page_token: prev_page_token,
    next_page_token: next_page_token,
    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)


63
64
65
66
# File 'lib/candidhealth/commons/types/resource_page.rb', line 63

def self.validate_raw(obj:)
  obj.prev_page_token&.is_a?(String) != false || raise("Passed value for field obj.prev_page_token is not the expected type, validation failed.")
  obj.next_page_token&.is_a?(String) != false || raise("Passed value for field obj.next_page_token is not the expected type, validation failed.")
end

Instance Method Details

#to_json(*_args) ⇒ String

Serialize an instance of ResourcePage to a JSON object

Returns:

  • (String)


53
54
55
# File 'lib/candidhealth/commons/types/resource_page.rb', line 53

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