Class: LockstepSdk::ActivityModel

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

Overview

An Activity contains information about work being done on a specific accounting task. You can use Activities to track information about who has been assigned a specific task, the current status of the task, the name and description given for the particular task, the priority of the task, and any amounts collected, paid, or credited for the task.

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(params = {}) ⇒ ActivityModel

Initialize the ActivityModel using the provided prototype



30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
 
# File 'lib/lockstep_sdk/models/activity_model.rb', line 30

def initialize(params = {})
    @activity_id = params.dig(:activity_id)
    @group_key = params.dig(:group_key)
    @company_id = params.dig(:company_id)
    @activity_type_code = params.dig(:activity_type_code)
    @activity_name = params.dig(:activity_name)
    @activity_description = params.dig(:activity_description)
    @activity_status = params.dig(:activity_status)
    @is_open = params.dig(:is_open)
    @priority = params.dig(:priority)
    @user_assigned_to = params.dig(:user_assigned_to)
    @date_assigned = params.dig(:date_assigned)
    @date_closed = params.dig(:date_closed)
    @snooze_until_date = params.dig(:snooze_until_date)
    @created = params.dig(:created)
    @created_user_id = params.dig(:created_user_id)
    @modified = params.dig(:modified)
    @modified_user_id = params.dig(:modified_user_id)
    @amount_collected = params.dig(:amount_collected)
    @amount_paid = params.dig(:amount_paid)
    @credit_given = params.dig(:credit_given)
    @is_unread = params.dig(:is_unread)
    @is_archived = params.dig(:is_archived)
    @company = params.dig(:company)
    @user_assigned_to_name = params.dig(:user_assigned_to_name)
    @attachments = params.dig(:attachments)
    @notes = params.dig(:notes)
    @custom_field_definitions = params.dig(:custom_field_definitions)
    @custom_field_values = params.dig(:custom_field_values)
    @references = params.dig(:references)
end

Instance Attribute Details

#activity_description ⇒ String

Returns A description of the activity. This field contains more detailed text about the activity and can be lengthy.

Returns:

  • (String) —

    A description of the activity. This field contains more detailed text about the activity and can be lengthy.



84
85
86
 
# File 'lib/lockstep_sdk/models/activity_model.rb', line 84

def activity_description
  @activity_description
end

#activity_id ⇒ Uuid

Returns The unique ID of this record, automatically assigned by Lockstep when this record is added to the Lockstep platform.

Returns:

  • (Uuid) —

    The unique ID of this record, automatically assigned by Lockstep when this record is added to the Lockstep platform.



64
65
66
 
# File 'lib/lockstep_sdk/models/activity_model.rb', line 64

def activity_id
  @activity_id
end

#activity_name ⇒ String

Returns The name of the activity. The name is a short name provided by the person who created the activity that can be displayed in a list.

Returns:

  • (String) —

    The name of the activity. The name is a short name provided by the person who created the activity that can be displayed in a list.



80
81
82
 
# File 'lib/lockstep_sdk/models/activity_model.rb', line 80

def activity_name
  @activity_name
end

#activity_status ⇒ String

Returns The status of the activity.

Returns:

  • (String) —

    The status of the activity.



88
89
90
 
# File 'lib/lockstep_sdk/models/activity_model.rb', line 88

def activity_status
  @activity_status
end

#activity_type_code ⇒ String

Returns The type code of the activity.

Returns:

  • (String) —

    The type code of the activity



76
77
78
 
# File 'lib/lockstep_sdk/models/activity_model.rb', line 76

def activity_type_code
  @activity_type_code
end

#amount_collected ⇒ Double

Returns Amount collected (if any) for the activity.

Returns:

  • (Double) —

    Amount collected (if any) for the activity.



132
133
134
 
# File 'lib/lockstep_sdk/models/activity_model.rb', line 132

def amount_collected
  @amount_collected
end

#amount_paid ⇒ Double

Returns Amount paid (if any) for the activity.

Returns:

  • (Double) —

    Amount paid (if any) for the activity.



136
137
138
 
# File 'lib/lockstep_sdk/models/activity_model.rb', line 136

def amount_paid
  @amount_paid
end

#attachments ⇒ AttachmentModel

Returns A collection of attachments linked to this record. To retrieve this collection, specify ‘Attachments` in the `include` parameter when retrieving data. To create an attachment, use the [Upload Attachment](developer.lockstep.io/reference/post_api-v1-attachments) endpoint with the `TableKey` to `Activity` and the `ObjectKey` set to the `ActivityId` for this record. For more information on extensibility, see [linking extensible metadata to objects](developer.lockstep.io/docs/custom-fields#linking-metadata-to-an-object).

Returns:



160
161
162
 
# File 'lib/lockstep_sdk/models/activity_model.rb', line 160

def attachments
  @attachments
end

#company ⇒ CompanyModel

Returns The company associated with the activity To retrieve this collection, specify ‘Company` in the “Include” parameter for your query.

Returns:

  • (CompanyModel) —

    The company associated with the activity To retrieve this collection, specify ‘Company` in the “Include” parameter for your query.



152
153
154
 
# File 'lib/lockstep_sdk/models/activity_model.rb', line 152

def company
  @company
end

#company_id ⇒ Uuid

Returns The ID of the company to which this activity belongs.

Returns:

  • (Uuid) —

    The ID of the company to which this activity belongs.



72
73
74
 
# File 'lib/lockstep_sdk/models/activity_model.rb', line 72

def company_id
  @company_id
end

#created ⇒ Date-time

Returns The date on which this activity was created.

Returns:

  • (Date-time) —

    The date on which this activity was created.



116
117
118
 
# File 'lib/lockstep_sdk/models/activity_model.rb', line 116

def created
  @created
end

#created_user_id ⇒ Uuid

Returns The ID of the user who created this activity.

Returns:

  • (Uuid) —

    The ID of the user who created this activity.



120
121
122
 
# File 'lib/lockstep_sdk/models/activity_model.rb', line 120

def created_user_id
  @created_user_id
end

#credit_given ⇒ Double

Returns Credit given (if any) for the activity.

Returns:

  • (Double) —

    Credit given (if any) for the activity.



140
141
142
 
# File 'lib/lockstep_sdk/models/activity_model.rb', line 140

def credit_given
  @credit_given
end

#custom_field_definitions ⇒ CustomFieldDefinitionModel

Returns A collection of custom fields linked to this record. To retrieve this collection, specify ‘CustomFieldDefinitions` in the `include` parameter when retrieving data. To create a custom field, use the [Create Custom Field](developer.lockstep.io/reference/post_api-v1-customfieldvalues) endpoint with the `TableKey` to `Activity` and the `ObjectKey` set to the `ActivityId` for this record. For more information on extensibility, see [linking extensible metadata to objects](developer.lockstep.io/docs/custom-fields#linking-metadata-to-an-object).

Returns:



168
169
170
 
# File 'lib/lockstep_sdk/models/activity_model.rb', line 168

def custom_field_definitions
  @custom_field_definitions
end

#custom_field_values ⇒ CustomFieldValueModel

Returns A collection of custom fields linked to this record. To retrieve this collection, specify ‘CustomFieldValues` in the `include` parameter when retrieving data. To create a custom field, use the [Create Custom Field](developer.lockstep.io/reference/post_api-v1-customfieldvalues) endpoint with the `TableKey` to `Activity` and the `ObjectKey` set to the `ActivityId` for this record. For more information on extensibility, see [linking extensible metadata to objects](developer.lockstep.io/docs/custom-fields#linking-metadata-to-an-object).

Returns:



172
173
174
 
# File 'lib/lockstep_sdk/models/activity_model.rb', line 172

def custom_field_values
  @custom_field_values
end

#date_assigned ⇒ Date-time

Returns The date the activity was assigned.

Returns:

  • (Date-time) —

    The date the activity was assigned.



104
105
106
 
# File 'lib/lockstep_sdk/models/activity_model.rb', line 104

def date_assigned
  @date_assigned
end

#date_closed ⇒ Date-time

Returns The date the activity was closed.

Returns:

  • (Date-time) —

    The date the activity was closed.



108
109
110
 
# File 'lib/lockstep_sdk/models/activity_model.rb', line 108

def date_closed
  @date_closed
end

#group_key ⇒ Uuid

Returns The GroupKey uniquely identifies a single Lockstep Platform account. All records for this account will share the same GroupKey value. GroupKey values cannot be changed once created. For more information, see [Accounts and GroupKeys](developer.lockstep.io/docs/accounts-and-groupkeys).

Returns:

  • (Uuid) —

    The GroupKey uniquely identifies a single Lockstep Platform account. All records for this account will share the same GroupKey value. GroupKey values cannot be changed once created. For more information, see [Accounts and GroupKeys](developer.lockstep.io/docs/accounts-and-groupkeys).



68
69
70
 
# File 'lib/lockstep_sdk/models/activity_model.rb', line 68

def group_key
  @group_key
end

#is_archived ⇒ Boolean

Returns Activities may be archived when they should be hidden from the user. When this flag is true, this activity should be hidden.

Returns:

  • (Boolean) —

    Activities may be archived when they should be hidden from the user. When this flag is true, this activity should be hidden.



148
149
150
 
# File 'lib/lockstep_sdk/models/activity_model.rb', line 148

def is_archived
  @is_archived
end

#is_open ⇒ Boolean

Returns True if this activity is currently “open”, which indicates that the activity is currently in progress.

Returns:

  • (Boolean) —

    True if this activity is currently “open”, which indicates that the activity is currently in progress.



92
93
94
 
# File 'lib/lockstep_sdk/models/activity_model.rb', line 92

def is_open
  @is_open
end

#is_unread ⇒ Boolean

Returns True if this activity is to be shown in an “unread” state. When an activity is read by a person it is assigned to, this flag is set to false.

Returns:

  • (Boolean) —

    True if this activity is to be shown in an “unread” state. When an activity is read by a person it is assigned to, this flag is set to false.



144
145
146
 
# File 'lib/lockstep_sdk/models/activity_model.rb', line 144

def is_unread
  @is_unread
end

#modified ⇒ Date-time

Returns The date on which this activity was last modified.

Returns:

  • (Date-time) —

    The date on which this activity was last modified.



124
125
126
 
# File 'lib/lockstep_sdk/models/activity_model.rb', line 124

def modified
  @modified
end

#modified_user_id ⇒ Uuid

Returns The ID of the user who last modified this activity.

Returns:

  • (Uuid) —

    The ID of the user who last modified this activity.



128
129
130
 
# File 'lib/lockstep_sdk/models/activity_model.rb', line 128

def modified_user_id
  @modified_user_id
end

#notes ⇒ NoteModel

Returns A collection of notes linked to this record. To retrieve this collection, specify ‘Notes` in the `include` parameter when retrieving data. To create a note, use the [Create Note](developer.lockstep.io/reference/post_api-v1-notes) endpoint with the `TableKey` to `Activity` and the `ObjectKey` set to the `ActivityId` for this record. For more information on extensibility, see [linking extensible metadata to objects](developer.lockstep.io/docs/custom-fields#linking-metadata-to-an-object).

Returns:



164
165
166
 
# File 'lib/lockstep_sdk/models/activity_model.rb', line 164

def notes
  @notes
end

#priority ⇒ String

Returns The priority of the activity.

Returns:

  • (String) —

    The priority of the activity.



96
97
98
 
# File 'lib/lockstep_sdk/models/activity_model.rb', line 96

def priority
  @priority
end

#references ⇒ ActivityXRefModel

Returns All references attached to this applied activity. To retrieve this collection, specify ‘References` in the “Include” parameter for your query.

Returns:

  • (ActivityXRefModel) —

    All references attached to this applied activity. To retrieve this collection, specify ‘References` in the “Include” parameter for your query.



176
177
178
 
# File 'lib/lockstep_sdk/models/activity_model.rb', line 176

def references
  @references
end

#snooze_until_date ⇒ Date-time

Returns If this activity has been “snoozed”, this field will be non-null and will contain the date when the activity will be displayed. Until that date arrives, the activity will remain hidden.

Returns:

  • (Date-time) —

    If this activity has been “snoozed”, this field will be non-null and will contain the date when the activity will be displayed. Until that date arrives, the activity will remain hidden.



112
113
114
 
# File 'lib/lockstep_sdk/models/activity_model.rb', line 112

def snooze_until_date
  @snooze_until_date
end

#user_assigned_to ⇒ Uuid

Returns The ID of the user the activity is assigned to.

Returns:

  • (Uuid) —

    The ID of the user the activity is assigned to.



100
101
102
 
# File 'lib/lockstep_sdk/models/activity_model.rb', line 100

def user_assigned_to
  @user_assigned_to
end

#user_assigned_to_name ⇒ String

Returns The name of the user the activity is assigned to.

Returns:

  • (String) —

    The name of the user the activity is assigned to



156
157
158
 
# File 'lib/lockstep_sdk/models/activity_model.rb', line 156

def user_assigned_to_name
  @user_assigned_to_name
end

Instance Method Details

#as_json(options = {}) ⇒ object

Returns This object as a JSON key-value structure.

Returns:

  • (object) —

    This object as a JSON key-value structure



180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
 
# File 'lib/lockstep_sdk/models/activity_model.rb', line 180

def as_json(options={})
    {
        'activityId' => @activity_id,
        'groupKey' => @group_key,
        'companyId' => @company_id,
        'activityTypeCode' => @activity_type_code,
        'activityName' => @activity_name,
        'activityDescription' => @activity_description,
        'activityStatus' => @activity_status,
        'isOpen' => @is_open,
        'priority' => @priority,
        'userAssignedTo' => @user_assigned_to,
        'dateAssigned' => @date_assigned,
        'dateClosed' => @date_closed,
        'snoozeUntilDate' => @snooze_until_date,
        'created' => @created,
        'createdUserId' => @created_user_id,
        'modified' => @modified,
        'modifiedUserId' => @modified_user_id,
        'amountCollected' => @amount_collected,
        'amountPaid' => @amount_paid,
        'creditGiven' => @credit_given,
        'isUnread' => @is_unread,
        'isArchived' => @is_archived,
        'company' => @company,
        'userAssignedToName' => @user_assigned_to_name,
        'attachments' => @attachments,
        'notes' => @notes,
        'customFieldDefinitions' => @custom_field_definitions,
        'customFieldValues' => @custom_field_values,
        'references' => @references,
    }
end

#to_json(*options) ⇒ String

Returns This object converted to a JSON string.

Returns:

  • (String) —

    This object converted to a JSON string



216
217
218
 
# File 'lib/lockstep_sdk/models/activity_model.rb', line 216

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