Class: Privy::Models::UserSetCustomMetadataParams

Inherits:

Internal::Type::BaseModel

• Object
• Internal::Type::BaseModel
• Privy::Models::UserSetCustomMetadataParams

Extended by:

Internal::Type::RequestParameters::Converter

Includes:

Internal::Type::RequestParameters

Defined in:

lib/privy/models/user_set_custom_metadata_params.rb

Overview

See Also:

• Resources::Users#set_custom_metadata

Instance Attribute Summary

• #custom_metadata ⇒ Hash{Symbol=>String, Float, Boolean}

  Custom metadata associated with the user.

• #user_id ⇒ String

  ID of the user.

Attributes included from Internal::Type::RequestParameters

#request_options

Instance Method Summary

• #initialize(user_id:, custom_metadata:, request_options: {}) ⇒ Object constructor

Methods included from Internal::Type::RequestParameters::Converter

dump_request

Methods included from Internal::Type::RequestParameters

included

Methods inherited from Internal::Type::BaseModel

==, #==, #[], coerce, #deconstruct_keys, #deep_to_h, dump, fields, hash, #hash, inherited, inspect, #inspect, known_fields, optional, recursively_to_h, required, #to_h, #to_json, #to_s, to_sorbet_type, #to_yaml

Methods included from Internal::Type::Converter

#coerce, coerce, #dump, dump, #inspect, inspect, meta_info, new_coerce_state, type_info

Methods included from Internal::Util::SorbetRuntimeSupport

#const_missing, #define_sorbet_constant!, #sorbet_constant_defined?, #to_sorbet_type, to_sorbet_type

Constructor Details

#initialize(user_id:, custom_metadata:, request_options: {}) ⇒ Object

Parameters:

• user_id (String) —

  ID of the user.

• custom_metadata (Hash{Symbol=>String, Float, Boolean}) —

  Custom metadata associated with the user.

• request_options (Privy::RequestOptions, Hash{Symbol=>Object}) (defaults to: {})

# File 'lib/privy/models/user_set_custom_metadata_params.rb', line 22

Instance Attribute Details

#custom_metadata ⇒ Hash{Symbol=>String, Float, Boolean}

Custom metadata associated with the user.

Returns:

• (Hash{Symbol=>String, Float, Boolean})

# File 'lib/privy/models/user_set_custom_metadata_params.rb', line 20

required :custom_metadata, -> { Privy::Internal::Type::HashOf[union: Privy::CustomMetadataItem] }

#user_id ⇒ String

ID of the user.

Returns:

• (String)

# File 'lib/privy/models/user_set_custom_metadata_params.rb', line 14

required :user_id, String