Class: Courier::Bulk::BulkIngestUsersParams

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

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(users:, additional_properties: nil) ⇒ Bulk::BulkIngestUsersParams

Parameters:

  • users (Array<Bulk::InboundBulkMessageUser>)
  • additional_properties (OpenStruct) (defaults to: nil) —

    Additional properties unmapped to the current class definition



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

def initialize(users:, additional_properties: nil)
  # @type [Array<Bulk::InboundBulkMessageUser>]
  @users = users
  # @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.



9
10
11
 
# File 'lib/trycourier/bulk/types/bulk_ingest_users_params.rb', line 9

def additional_properties
  @additional_properties
end

#users ⇒ Object (readonly)

Returns the value of attribute users.



9
10
11
 
# File 'lib/trycourier/bulk/types/bulk_ingest_users_params.rb', line 9

def users
  @users
end

Class Method Details

.from_json(json_object:) ⇒ Bulk::BulkIngestUsersParams

Deserialize a JSON object to an instance of BulkIngestUsersParams

Parameters:

  • json_object (JSON)

Returns:



25
26
27
28
29
30
31
32
33
 
# File 'lib/trycourier/bulk/types/bulk_ingest_users_params.rb', line 25

def self.from_json(json_object:)
  struct = JSON.parse(json_object, object_class: OpenStruct)
  parsed_json = JSON.parse(json_object)
  users = parsed_json["users"]&.map do |v|
    v = v.to_json
    Bulk::InboundBulkMessageUser.from_json(json_object: v)
  end
  new(users: users, 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
 
# File 'lib/trycourier/bulk/types/bulk_ingest_users_params.rb', line 46

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

Instance Method Details

#to_json(*_args) ⇒ JSON

Serialize an instance of BulkIngestUsersParams to a JSON object

Returns:

  • (JSON) 


38
39
40
 
# File 'lib/trycourier/bulk/types/bulk_ingest_users_params.rb', line 38

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