Class: Courier::Send::Timeouts

Inherits:
Object
  • Object
show all
Defined in:
lib/trycourier/send/types/timeouts.rb

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(provider: nil, channel: nil, additional_properties: nil) ⇒ Send::Timeouts

Parameters:

  • provider (Integer) (defaults to: nil)
  • channel (Integer) (defaults to: nil)
  • 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/send/types/timeouts.rb', line 14

def initialize(provider: nil, channel: nil, additional_properties: nil)
  # @type [Integer]
  @provider = provider
  # @type [Integer]
  @channel = channel
  # @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/send/types/timeouts.rb', line 8

def additional_properties
  @additional_properties
end

#channel ⇒ Object (readonly)

Returns the value of attribute channel.



8
9
10
 
# File 'lib/trycourier/send/types/timeouts.rb', line 8

def channel
  @channel
end

#provider ⇒ Object (readonly)

Returns the value of attribute provider.



8
9
10
 
# File 'lib/trycourier/send/types/timeouts.rb', line 8

def provider
  @provider
end

Class Method Details

.from_json(json_object:) ⇒ Send::Timeouts

Deserialize a JSON object to an instance of Timeouts

Parameters:

  • json_object (JSON)

Returns:



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

def self.from_json(json_object:)
  struct = JSON.parse(json_object, object_class: OpenStruct)
  JSON.parse(json_object)
  provider = struct.provider
  channel = struct.channel
  new(provider: provider, channel: channel, 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/send/types/timeouts.rb', line 46

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

Instance Method Details

#to_json(*_args) ⇒ JSON

Serialize an instance of Timeouts to a JSON object

Returns:

  • (JSON) 


38
39
40
 
# File 'lib/trycourier/send/types/timeouts.rb', line 38

def to_json(*_args)
  { "provider": @provider, "channel": @channel }.to_json
end