Class: Courier::Users::Tokens::DeleteUserTokenOpts

Inherits:
Object
  • Object
show all
Defined in:
lib/trycourier/users/tokens/types/delete_user_token_opts.rb

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(user_id:, token:, additional_properties: nil) ⇒ Users::Tokens::DeleteUserTokenOpts

Parameters:

  • user_id (String)
  • token (String)
  • additional_properties (OpenStruct) (defaults to: nil) —

    Additional properties unmapped to the current class definition



15
16
17
18
19
20
21
22
 
# File 'lib/trycourier/users/tokens/types/delete_user_token_opts.rb', line 15

def initialize(user_id:, token:, additional_properties: nil)
  # @type [String]
  @user_id = user_id
  # @type [String]
  @token = token
  # @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/users/tokens/types/delete_user_token_opts.rb', line 9

def additional_properties
  @additional_properties
end

#token ⇒ Object (readonly)

Returns the value of attribute token.



9
10
11
 
# File 'lib/trycourier/users/tokens/types/delete_user_token_opts.rb', line 9

def token
  @token
end

#user_id ⇒ Object (readonly)

Returns the value of attribute user_id.



9
10
11
 
# File 'lib/trycourier/users/tokens/types/delete_user_token_opts.rb', line 9

def user_id
  @user_id
end

Class Method Details

.from_json(json_object:) ⇒ Users::Tokens::DeleteUserTokenOpts

Deserialize a JSON object to an instance of DeleteUserTokenOpts

Parameters:

  • json_object (JSON)

Returns:



28
29
30
31
32
33
34
 
# File 'lib/trycourier/users/tokens/types/delete_user_token_opts.rb', line 28

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


47
48
49
50
 
# File 'lib/trycourier/users/tokens/types/delete_user_token_opts.rb', line 47

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

Instance Method Details

#to_json(*_args) ⇒ JSON

Serialize an instance of DeleteUserTokenOpts to a JSON object

Returns:

  • (JSON) 


39
40
41
 
# File 'lib/trycourier/users/tokens/types/delete_user_token_opts.rb', line 39

def to_json(*_args)
  { "user_id": @user_id, "token": @token }.to_json
end