Class: Courier::Commons::Paging

Inherits:
Object
  • Object
show all
Defined in:
lib/trycourier/commons/types/paging.rb

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(more:, cursor: nil, additional_properties: nil) ⇒ Commons::Paging

Parameters:

  • cursor (String) (defaults to: nil)
  • more (Boolean)
  • additional_properties (OpenStruct) (defaults to: nil) —

    Additional properties unmapped to the current class definition



14
15
16
17
18
19
20
21
 
# File 'lib/trycourier/commons/types/paging.rb', line 14

def initialize(more:, cursor: nil, additional_properties: nil)
  # @type [String]
  @cursor = cursor
  # @type [Boolean]
  @more = more
  # @type [OpenStruct] Additional properties unmapped to the current class definition
  @additional_properties = additional_properties
end

Instance Attribute Details

#additional_properties ⇒ Object (readonly)

Returns the value of attribute additional_properties.



8
9
10
 
# File 'lib/trycourier/commons/types/paging.rb', line 8

def additional_properties
  @additional_properties
end

#cursor ⇒ Object (readonly)

Returns the value of attribute cursor.



8
9
10
 
# File 'lib/trycourier/commons/types/paging.rb', line 8

def cursor
  @cursor
end

#more ⇒ Object (readonly)

Returns the value of attribute more.



8
9
10
 
# File 'lib/trycourier/commons/types/paging.rb', line 8

def more
  @more
end

Class Method Details

.from_json(json_object:) ⇒ Commons::Paging

Deserialize a JSON object to an instance of Paging

Parameters:

  • json_object (JSON)

Returns:



27
28
29
30
31
32
33
 
# File 'lib/trycourier/commons/types/paging.rb', line 27

def self.from_json(json_object:)
  struct = JSON.parse(json_object, object_class: OpenStruct)
  JSON.parse(json_object)
  cursor = struct.cursor
  more = struct.more
  new(cursor: cursor, more: more, 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) 


46
47
48
49
 
# File 'lib/trycourier/commons/types/paging.rb', line 46

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

Instance Method Details

#to_json(*_args) ⇒ JSON

Serialize an instance of Paging to a JSON object

Returns:

  • (JSON) 


38
39
40
 
# File 'lib/trycourier/commons/types/paging.rb', line 38

def to_json(*_args)
  { "cursor": @cursor, "more": @more }.to_json
end