Class: Courier::Bulk::BulkGetJobParams

Inherits:
Object
  • Object
show all
Defined in:
lib/trycourier/bulk/types/bulk_get_job_params.rb

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(job_id:, additional_properties: nil) ⇒ Bulk::BulkGetJobParams

Parameters:

  • job_id (String)
  • additional_properties (OpenStruct) (defaults to: nil) —

    Additional properties unmapped to the current class definition



13
14
15
16
17
18
 
# File 'lib/trycourier/bulk/types/bulk_get_job_params.rb', line 13

def initialize(job_id:, additional_properties: nil)
  # @type [String]
  @job_id = job_id
  # @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/bulk/types/bulk_get_job_params.rb', line 8

def additional_properties
  @additional_properties
end

#job_id ⇒ Object (readonly)

Returns the value of attribute job_id.



8
9
10
 
# File 'lib/trycourier/bulk/types/bulk_get_job_params.rb', line 8

def job_id
  @job_id
end

Class Method Details

.from_json(json_object:) ⇒ Bulk::BulkGetJobParams

Deserialize a JSON object to an instance of BulkGetJobParams

Parameters:

  • json_object (JSON)

Returns:



24
25
26
27
28
29
 
# File 'lib/trycourier/bulk/types/bulk_get_job_params.rb', line 24

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


42
43
44
 
# File 'lib/trycourier/bulk/types/bulk_get_job_params.rb', line 42

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

Instance Method Details

#to_json(*_args) ⇒ JSON

Serialize an instance of BulkGetJobParams to a JSON object

Returns:

  • (JSON) 


34
35
36
 
# File 'lib/trycourier/bulk/types/bulk_get_job_params.rb', line 34

def to_json(*_args)
  { "jobId": @job_id }.to_json
end