Class: TrophyApiClient::UpsertedUser

Inherits:
Object
  • Object
show all
Defined in:
lib/trophy_api_client/types/upserted_user.rb

Overview

An object with editable user fields.

Constant Summary collapse

OMIT = 
Object.new

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(id:, email: OMIT, name: OMIT, tz: OMIT, device_tokens: OMIT, subscribe_to_emails: OMIT, attributes: OMIT, additional_properties: nil) ⇒ TrophyApiClient::UpsertedUser

Parameters:

  • id (String) —

    The ID of the user in your database. Must be a string.

  • email (String) (defaults to: OMIT) —

    The user’s email address. Required if subscribeToEmails is true.

  • name (String) (defaults to: OMIT) —

    The name to refer to the user by in emails.

  • tz (String) (defaults to: OMIT) —

    The user’s timezone (used for email scheduling).

  • device_tokens (Array<String>) (defaults to: OMIT) —

    The user’s device tokens, used for push notifications.

  • subscribe_to_emails (Boolean) (defaults to: OMIT) —

    Whether the user should receive Trophy-powered emails. If false, Trophy will not store the user’s email address.

  • attributes (Hash{String => String}) (defaults to: OMIT) —

    User attributes as key-value pairs. Keys must match existing user attributes set up in the Trophy dashboard.

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

    Additional properties unmapped to the current class definition



44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
 
# File 'lib/trophy_api_client/types/upserted_user.rb', line 44

def initialize(id:, email: OMIT, name: OMIT, tz: OMIT, device_tokens: OMIT, subscribe_to_emails: OMIT,
               attributes: OMIT, additional_properties: nil)
  @id = id
  @email = email if email != OMIT
  @name = name if name != OMIT
  @tz = tz if tz != OMIT
  @device_tokens = device_tokens if device_tokens != OMIT
  @subscribe_to_emails = subscribe_to_emails if subscribe_to_emails != OMIT
  @attributes = attributes if attributes != OMIT
  @additional_properties = additional_properties
  @_field_set = {
    "id": id,
    "email": email,
    "name": name,
    "tz": tz,
    "deviceTokens": device_tokens,
    "subscribeToEmails": subscribe_to_emails,
    "attributes": attributes
  }.reject do |_k, v|
    v == OMIT
  end
end

Instance Attribute Details

#additional_properties ⇒ OpenStruct (readonly)

Returns Additional properties unmapped to the current class definition.

Returns:

  • (OpenStruct) —

    Additional properties unmapped to the current class definition



26
27
28
 
# File 'lib/trophy_api_client/types/upserted_user.rb', line 26

def additional_properties
  @additional_properties
end

#attributes ⇒ Hash{String => String} (readonly)

Returns User attributes as key-value pairs. Keys must match existing user attributes set up in the Trophy dashboard.

Returns:

  • (Hash{String => String}) —

    User attributes as key-value pairs. Keys must match existing user attributes set up in the Trophy dashboard.



24
25
26
 
# File 'lib/trophy_api_client/types/upserted_user.rb', line 24

def attributes
  @attributes
end

#device_tokens ⇒ Array<String> (readonly)

Returns The user’s device tokens, used for push notifications.

Returns:

  • (Array<String>) —

    The user’s device tokens, used for push notifications.



18
19
20
 
# File 'lib/trophy_api_client/types/upserted_user.rb', line 18

def device_tokens
  @device_tokens
end

#email ⇒ String (readonly)

Returns The user’s email address. Required if subscribeToEmails is true.

Returns:

  • (String) —

    The user’s email address. Required if subscribeToEmails is true.



12
13
14
 
# File 'lib/trophy_api_client/types/upserted_user.rb', line 12

def email
  @email
end

#id ⇒ String (readonly)

Returns The ID of the user in your database. Must be a string.

Returns:

  • (String) —

    The ID of the user in your database. Must be a string.



10
11
12
 
# File 'lib/trophy_api_client/types/upserted_user.rb', line 10

def id
  @id
end

#name ⇒ String (readonly)

Returns The name to refer to the user by in emails.

Returns:

  • (String) —

    The name to refer to the user by in emails.



14
15
16
 
# File 'lib/trophy_api_client/types/upserted_user.rb', line 14

def name
  @name
end

#subscribe_to_emails ⇒ Boolean (readonly)

Returns Whether the user should receive Trophy-powered emails. If false, Trophy will not store the user’s email address.

Returns:

  • (Boolean) —

    Whether the user should receive Trophy-powered emails. If false, Trophy will not store the user’s email address.



21
22
23
 
# File 'lib/trophy_api_client/types/upserted_user.rb', line 21

def subscribe_to_emails
  @subscribe_to_emails
end

#tz ⇒ String (readonly)

Returns The user’s timezone (used for email scheduling).

Returns:

  • (String) —

    The user’s timezone (used for email scheduling).



16
17
18
 
# File 'lib/trophy_api_client/types/upserted_user.rb', line 16

def tz
  @tz
end

Class Method Details

.from_json(json_object:) ⇒ TrophyApiClient::UpsertedUser

Deserialize a JSON object to an instance of UpsertedUser

Parameters:

  • json_object (String)

Returns:



71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
 
# File 'lib/trophy_api_client/types/upserted_user.rb', line 71

def self.from_json(json_object:)
  struct = JSON.parse(json_object, object_class: OpenStruct)
  parsed_json = JSON.parse(json_object)
  id = parsed_json["id"]
  email = parsed_json["email"]
  name = parsed_json["name"]
  tz = parsed_json["tz"]
  device_tokens = parsed_json["deviceTokens"]
  subscribe_to_emails = parsed_json["subscribeToEmails"]
  attributes = parsed_json["attributes"]
  new(
    id: id,
    email: email,
    name: name,
    tz: tz,
    device_tokens: device_tokens,
    subscribe_to_emails: subscribe_to_emails,
    attributes: attributes,
    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) 


106
107
108
109
110
111
112
113
114
 
# File 'lib/trophy_api_client/types/upserted_user.rb', line 106

def self.validate_raw(obj:)
  obj.id.is_a?(String) != false || raise("Passed value for field obj.id is not the expected type, validation failed.")
  obj.email&.is_a?(String) != false || raise("Passed value for field obj.email is not the expected type, validation failed.")
  obj.name&.is_a?(String) != false || raise("Passed value for field obj.name is not the expected type, validation failed.")
  obj.tz&.is_a?(String) != false || raise("Passed value for field obj.tz is not the expected type, validation failed.")
  obj.device_tokens&.is_a?(Array) != false || raise("Passed value for field obj.device_tokens is not the expected type, validation failed.")
  obj.subscribe_to_emails&.is_a?(Boolean) != false || raise("Passed value for field obj.subscribe_to_emails is not the expected type, validation failed.")
  obj.attributes&.is_a?(Hash) != false || raise("Passed value for field obj.attributes is not the expected type, validation failed.")
end

Instance Method Details

#to_json(*_args) ⇒ String

Serialize an instance of UpsertedUser to a JSON object

Returns:

  • (String) 


96
97
98
 
# File 'lib/trophy_api_client/types/upserted_user.rb', line 96

def to_json(*_args)
  @_field_set&.to_json
end