Class: IubendaApi::ConsentSolution::Subject

Inherits:

ApiStruct::Entity

• Object
• ApiStruct::Entity
• IubendaApi::ConsentSolution::Subject

Defined in:

lib/iubenda_api/consent_solution/subject.rb

Overview

Response serializer class for client service IubendaApi::ConsentSolution::Clients::Subject

Instance Attribute Summary

• #email ⇒ String readonly

  Email of the subject.

• #first_name ⇒ String readonly

  First name of the subject.

• #full_name ⇒ String readonly

  Full name of the subject.

• #id ⇒ String readonly

  ID of the subject.

• #last_name ⇒ String readonly

  Last name of the subject.

• #owner_id ⇒ String readonly

  Owner id of the subject.

• #preferences ⇒ Hash readonly

  Set of key-value pairs with user preferences for the consent action.

• #timestamp ⇒ String readonly

  ISO 8601 timestamp.

• #verified ⇒ Boolean readonly

  Reserved field used to signal whether a subject is verified, for instance via the double opt-in method.

Class Method Summary

• .create(options) ⇒ IubendaApi::ConsentSolution::Subject, ApiStruct::Errors::Entity

  Creates a subject.

• .list(options = {}) ⇒ Array<IubendaApi::ConsentSolution::Subject>, ApiStruct::Errors::Entity

  Gets list of subjects.

• .show(id) ⇒ IubendaApi::ConsentSolution::Subject, ApiStruct::Errors::Entity

  Gets a subject.

• .update(id, options) ⇒ IubendaApi::ConsentSolution::Subject, ApiStruct::Errors::Entity

  Updates a subject.

Instance Attribute Details

#email ⇒ String (readonly)

Returns Email of the subject.

Returns:

• (String) —

  Email of the subject

# File 'lib/iubenda_api/consent_solution/subject.rb', line 83

attr_entity :id, :owner_id, :email, :first_name, :last_name, :full_name, :verified, :preferences, :timestamp

#first_name ⇒ String (readonly)

Returns First name of the subject.

Returns:

• (String) —

  First name of the subject

# File 'lib/iubenda_api/consent_solution/subject.rb', line 83

attr_entity :id, :owner_id, :email, :first_name, :last_name, :full_name, :verified, :preferences, :timestamp

#full_name ⇒ String (readonly)

Returns Full name of the subject.

Returns:

• (String) —

  Full name of the subject

# File 'lib/iubenda_api/consent_solution/subject.rb', line 83

attr_entity :id, :owner_id, :email, :first_name, :last_name, :full_name, :verified, :preferences, :timestamp

#id ⇒ String (readonly)

Returns ID of the subject.

Returns:

• (String) —

  ID of the subject

# File 'lib/iubenda_api/consent_solution/subject.rb', line 83

attr_entity :id, :owner_id, :email, :first_name, :last_name, :full_name, :verified, :preferences, :timestamp

#last_name ⇒ String (readonly)

Returns Last name of the subject.

Returns:

• (String) —

  Last name of the subject

# File 'lib/iubenda_api/consent_solution/subject.rb', line 83

attr_entity :id, :owner_id, :email, :first_name, :last_name, :full_name, :verified, :preferences, :timestamp

#owner_id ⇒ String (readonly)

Returns owner id of the subject.

Returns:

• (String) —

  owner id of the subject

# File 'lib/iubenda_api/consent_solution/subject.rb', line 83

attr_entity :id, :owner_id, :email, :first_name, :last_name, :full_name, :verified, :preferences, :timestamp

#preferences ⇒ Hash (readonly)

Returns Set of key-value pairs with user preferences for the consent action.

Returns:

• (Hash) —

  Set of key-value pairs with user preferences for the consent action

# File 'lib/iubenda_api/consent_solution/subject.rb', line 83

attr_entity :id, :owner_id, :email, :first_name, :last_name, :full_name, :verified, :preferences, :timestamp

#timestamp ⇒ String (readonly)

Returns ISO 8601 timestamp. Operation time, for instance creation time, update time.

Returns:

• (String) —

  ISO 8601 timestamp. Operation time, for instance creation time, update time

# File 'lib/iubenda_api/consent_solution/subject.rb', line 83

attr_entity :id, :owner_id, :email, :first_name, :last_name, :full_name, :verified, :preferences, :timestamp

#verified ⇒ Boolean (readonly)

Returns Reserved field used to signal whether a subject is verified, for instance via the double opt-in method.

Returns:

• (Boolean) —

  Reserved field used to signal whether a subject is verified, for instance via the double opt-in method

# File 'lib/iubenda_api/consent_solution/subject.rb', line 83

attr_entity :id, :owner_id, :email, :first_name, :last_name, :full_name, :verified, :preferences, :timestamp

Class Method Details

.create(options) ⇒ IubendaApi::ConsentSolution::Subject, ApiStruct::Errors::Entity

Creates a subject

Examples:

IubendaApi::ConsentSolution::Subject.create(id: 'testsubject', email: 'subject@example.com', first_name: "John", last_name: "Doe", verified: false) # -> #<IubendaApi::ConsentSolution::Subject id="testsubject" timestamp="2019-11-05T11:33:20.039Z">
IubendaApi::ConsentSolution::Subject.create(id: 'testsubject', email: 'subject@example.com', first_name: "John", last_name: "Doe", verified: false) # -> #<ApiStruct::Errors::Entity body=#<Hashie::Mash message="Invalid authentication credentials"> error=true status=#<HTTP::Response::Status 403 Forbidden>>

Parameters:

• options (Hash) —

  options to send as subject attributes. Options are same as IubendaApi::ConsentSolution::Clients::Subject#create options

Returns:

• (IubendaApi::ConsentSolution::Subject) —

  if created

• (ApiStruct::Errors::Entity) —

  if not found or failed

See Also:

• Clients::Subject#create

# File 'lib/iubenda_api/consent_solution/subject.rb', line 33

.list ⇒ Array<IubendaApi::ConsentSolution::Subject>, ApiStruct::Errors::Entity .list(options) ⇒ Array<IubendaApi::ConsentSolution::Subject>, ApiStruct::Errors::Entity

Gets list of subjects

Examples:

IubendaApi::ConsentSolution::Subject.list(limit: 1) # -> [#<IubendaApi::ConsentSolution::Subject email="john.doe@example.com" first_name="John" full_name=nil id="testsubject" last_name="Doe" owner_id="10240" preferences=nil timestamp="2019-11-05T11:33:20+00:00" verified=false>, ...]
IubendaApi::ConsentSolution::Subject.list(limit: 1) # -> #<ApiStruct::Errors::Entity body=#<Hashie::Mash message="Invalid authentication credentials"> error=true status=#<HTTP::Response::Status 403 Forbidden>>

Overloads:

• .list(options) ⇒ Array<IubendaApi::ConsentSolution::Subject>, ApiStruct::Errors::Entity

  Parameters:

  • options (Hash) —

    options to send as query parameters.

  See Also:

  • Options are same as IubendaApi::ConsentSolution::Clients::Subject#list options

Returns:

• (Array<IubendaApi::ConsentSolution::Subject>) —

  if success

• (ApiStruct::Errors::Entity) —

  if failed

# File 'lib/iubenda_api/consent_solution/subject.rb', line 20

.show(id) ⇒ IubendaApi::ConsentSolution::Subject, ApiStruct::Errors::Entity

Gets a subject

Examples:

IubendaApi::ConsentSolution::Subject.show('testsubject') # -> #<IubendaApi::ConsentSolution::Subject email="john.doe@example.com" first_name="John" full_name=nil id="testsubject" last_name="Doe" owner_id="10240" preferences=nil timestamp="2019-11-05T11:33:20+00:00" verified=false>
IubendaApi::ConsentSolution::Subject.show('notfound') # -> #<ApiStruct::Errors::Entity body=#<Hashie::Mash message="Invalid authentication credentials"> error=true status=#<HTTP::Response::Status 403 Forbidden>>

Parameters:

• id (String) —

  the id of the subject

Returns:

• (IubendaApi::ConsentSolution::Subject) —

  if found

• (ApiStruct::Errors::Entity) —

  if not found or failed

See Also:

• Clients::Subject#show

# File 'lib/iubenda_api/consent_solution/subject.rb', line 8

.update(id, options) ⇒ IubendaApi::ConsentSolution::Subject, ApiStruct::Errors::Entity

Updates a subject

Examples:

IubendaApi::ConsentSolution::Subject.update('testsubject', email: 'subject@example.com') # -> #<IubendaApi::ConsentSolution::Subject id="testsubject" timestamp="2019-11-05T11:33:20.039Z">
IubendaApi::ConsentSolution::Subject.update('testsubject', email: 'subject@example.com') # -> #<ApiStruct::Errors::Entity body=#<Hashie::Mash message="Invalid authentication credentials"> error=true status=#<HTTP::Response::Status 403 Forbidden>>

Parameters:

• options (Hash) —

  options to send as subject attributes. Options are same as IubendaApi::ConsentSolution::Clients::Subject#update options

Returns:

• (IubendaApi::ConsentSolution::Subject) —

  if updated

• (ApiStruct::Errors::Entity) —

  if not found or failed

See Also:

• Clients::Subject#update

# File 'lib/iubenda_api/consent_solution/subject.rb', line 54

client_service IubendaApi::ConsentSolution::Clients::Subject