Class: LockstepSdk::AttachmentModel

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

Overview

Represents a user uploaded attachment

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(params = {}) ⇒ AttachmentModel

Initialize the AttachmentModel using the provided prototype



24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
 
# File 'lib/lockstep_sdk/models/attachment_model.rb', line 24

def initialize(params = {})
    @attachment_id = params.dig(:attachment_id)
    @group_key = params.dig(:group_key)
    @table_key = params.dig(:table_key)
    @object_key = params.dig(:object_key)
    @file_name = params.dig(:file_name)
    @file_ext = params.dig(:file_ext)
    @attachment_type_id = params.dig(:attachment_type_id)
    @is_archived = params.dig(:is_archived)
    @origin_attachment_id = params.dig(:origin_attachment_id)
    @view_internal = params.dig(:view_internal)
    @view_external = params.dig(:view_external)
    @created = params.dig(:created)
    @created_user_id = params.dig(:created_user_id)
end

Instance Attribute Details

#attachment_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.



41
42
43
 
# File 'lib/lockstep_sdk/models/attachment_model.rb', line 41

def attachment_id
  @attachment_id
end

#attachment_type_id ⇒ Uuid

Returns Corresponding AttachmentType object to describe this attachment.

Returns:

  • (Uuid) —

    Corresponding AttachmentType object to describe this attachment



53
54
55
 
# File 'lib/lockstep_sdk/models/attachment_model.rb', line 53

def attachment_type_id
  @attachment_type_id
end

#created ⇒ Date-time

Returns The date the attachment was created.

Returns:

  • (Date-time) —

    The date the attachment was created



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

def created
  @created
end

#created_user_id ⇒ Uuid

Returns Id of the user who made the file.

Returns:

  • (Uuid) —

    Id of the user who made the file



65
66
67
 
# File 'lib/lockstep_sdk/models/attachment_model.rb', line 65

def created_user_id
  @created_user_id
end

#file_ext ⇒ String

Returns Extension type of the file.

Returns:

  • (String) —

    Extension type of the file



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

def file_ext
  @file_ext
end

#file_name ⇒ String

Returns Name of the file.

Returns:

  • (String) —

    Name of the file



49
50
51
 
# File 'lib/lockstep_sdk/models/attachment_model.rb', line 49

def file_name
  @file_name
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).



43
44
45
 
# File 'lib/lockstep_sdk/models/attachment_model.rb', line 43

def group_key
  @group_key
end

#is_archived ⇒ Boolean

Returns Flag indicating the attachment was archived.

Returns:

  • (Boolean) —

    Flag indicating the attachment was archived



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

def is_archived
  @is_archived
end

#object_key ⇒ Uuid

Returns The ID of the object the attachment is associated with.

Returns:

  • (Uuid) —

    The ID of the object the attachment is associated with



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

def object_key
  @object_key
end

#origin_attachment_id ⇒ Uuid

Returns:

  • (Uuid) 


57
58
59
 
# File 'lib/lockstep_sdk/models/attachment_model.rb', line 57

def origin_attachment_id
  @origin_attachment_id
end

#table_key ⇒ String

Returns The name of the table the attachment is associated with.

Returns:

  • (String) —

    The name of the table the attachment is associated with



45
46
47
 
# File 'lib/lockstep_sdk/models/attachment_model.rb', line 45

def table_key
  @table_key
end

#view_external ⇒ Boolean

Returns Flag for if Vendors and customers can see this file.

Returns:

  • (Boolean) —

    Flag for if Vendors and customers can see this file



61
62
63
 
# File 'lib/lockstep_sdk/models/attachment_model.rb', line 61

def view_external
  @view_external
end

#view_internal ⇒ Boolean

Returns Flag for if LS clients can see this file.

Returns:

  • (Boolean) —

    Flag for if LS clients can see this file



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

def view_internal
  @view_internal
end