Class: LockstepSdk::NoteModel

Inherits:
Object
  • Object
show all
Defined in:
lib/lockstep_sdk/models/note_model.rb

Overview

A note is a customizable text string that can be attached to various account attributes within Lockstep. You can use notes for internal communication, correspondence with clients, or personal reminders. The Note Model represents a note and a number of different metadata attributes related to the creation, storage, and ownership of the note.

See [Extensibility](developer.lockstep.io/docs/extensibility) for more information.

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(params = {}) ⇒ NoteModel

Initialize the NoteModel using the provided prototype



30
31
32
33
34
35
36
37
38
39
40
41
42
43
 
# File 'lib/lockstep_sdk/models/note_model.rb', line 30

def initialize(params = {})
    @note_id = params.dig(:note_id)
    @group_key = params.dig(:group_key)
    @table_key = params.dig(:table_key)
    @object_key = params.dig(:object_key)
    @note_text = params.dig(:note_text)
    @note_type = params.dig(:note_type)
    @is_archived = params.dig(:is_archived)
    @created = params.dig(:created)
    @created_user_id = params.dig(:created_user_id)
    @created_user_name = params.dig(:created_user_name)
    @app_enrollment_id = params.dig(:app_enrollment_id)
    @recipient_name = params.dig(:recipient_name)
end

Instance Attribute Details

#app_enrollment_id ⇒ Uuid 



87
88
89
 
# File 'lib/lockstep_sdk/models/note_model.rb', line 87

def app_enrollment_id
  @app_enrollment_id
end

#created ⇒ Date-time 



75
76
77
 
# File 'lib/lockstep_sdk/models/note_model.rb', line 75

def created
  @created
end

#created_user_id ⇒ Uuid 



79
80
81
 
# File 'lib/lockstep_sdk/models/note_model.rb', line 79

def created_user_id
  @created_user_id
end

#created_user_name ⇒ String 



83
84
85
 
# File 'lib/lockstep_sdk/models/note_model.rb', line 83

def created_user_name
  @created_user_name
end

#group_key ⇒ Uuid 



51
52
53
 
# File 'lib/lockstep_sdk/models/note_model.rb', line 51

def group_key
  @group_key
end

#is_archived ⇒ Boolean 



71
72
73
 
# File 'lib/lockstep_sdk/models/note_model.rb', line 71

def is_archived
  @is_archived
end

#note_id ⇒ Uuid 



47
48
49
 
# File 'lib/lockstep_sdk/models/note_model.rb', line 47

def note_id
  @note_id
end

#note_text ⇒ String 



63
64
65
 
# File 'lib/lockstep_sdk/models/note_model.rb', line 63

def note_text
  @note_text
end

#note_type ⇒ String 



67
68
69
 
# File 'lib/lockstep_sdk/models/note_model.rb', line 67

def note_type
  @note_type
end

#object_key ⇒ Uuid 



59
60
61
 
# File 'lib/lockstep_sdk/models/note_model.rb', line 59

def object_key
  @object_key
end

#recipient_name ⇒ String 



91
92
93
 
# File 'lib/lockstep_sdk/models/note_model.rb', line 91

def recipient_name
  @recipient_name
end

#table_key ⇒ String 



55
56
57
 
# File 'lib/lockstep_sdk/models/note_model.rb', line 55

def table_key
  @table_key
end

Instance Method Details

#as_json(options = {}) ⇒ object 



95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
 
# File 'lib/lockstep_sdk/models/note_model.rb', line 95

def as_json(options={})
    {
        'noteId' => @note_id,
        'groupKey' => @group_key,
        'tableKey' => @table_key,
        'objectKey' => @object_key,
        'noteText' => @note_text,
        'noteType' => @note_type,
        'isArchived' => @is_archived,
        'created' => @created,
        'createdUserId' => @created_user_id,
        'createdUserName' => @created_user_name,
        'appEnrollmentId' => @app_enrollment_id,
        'recipientName' => @recipient_name,
    }
end

#to_json(*options) ⇒ String 



114
115
116
 
# File 'lib/lockstep_sdk/models/note_model.rb', line 114

def to_json(*options)
    "[#{as_json(*options).to_json(*options)}]"
end