Class: LockstepSdk::AttachmentHeaderInfoModel

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

Overview

Aggregated Attachment status information.

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(params = {}) ⇒ AttachmentHeaderInfoModel

Initialize the AttachmentHeaderInfoModel using the provided prototype



28
29
30
31
32
33
34
 
# File 'lib/lockstep_sdk/models/attachment_header_info_model.rb', line 28

def initialize(params = {})
    @group_key = params.dig(:group_key)
    @company_id = params.dig(:company_id)
    @total_attachments = params.dig(:total_attachments)
    @total_archived = params.dig(:total_archived)
    @total_active = params.dig(:total_active)
end

Instance Attribute Details

#company_id ⇒ Uuid

Returns The CompanyId associated with the attachment status report. Providing a null value will return an attachment summary for all attachments associated to the provided GroupKey.

Returns:

  • (Uuid) —

    The CompanyId associated with the attachment status report. Providing a null value will return an attachment summary for all attachments associated to the provided GroupKey



42
43
44
 
# File 'lib/lockstep_sdk/models/attachment_header_info_model.rb', line 42

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



38
39
40
 
# File 'lib/lockstep_sdk/models/attachment_header_info_model.rb', line 38

def group_key
  @group_key
end

#total_active ⇒ Int32

Returns The total number of active attachments associated with the provided GroupKey and CompanyId.

Returns:

  • (Int32) —

    The total number of active attachments associated with the provided GroupKey and CompanyId.



54
55
56
 
# File 'lib/lockstep_sdk/models/attachment_header_info_model.rb', line 54

def total_active
  @total_active
end

#total_archived ⇒ Int32

Returns The total number of archived attachments associated with the provided GroupKey and CompanyId.

Returns:

  • (Int32) —

    The total number of archived attachments associated with the provided GroupKey and CompanyId.



50
51
52
 
# File 'lib/lockstep_sdk/models/attachment_header_info_model.rb', line 50

def total_archived
  @total_archived
end

#total_attachments ⇒ Int32

Returns The total number of attachments associated with the provided GroupKey and CompanyId.

Returns:

  • (Int32) —

    The total number of attachments associated with the provided GroupKey and CompanyId.



46
47
48
 
# File 'lib/lockstep_sdk/models/attachment_header_info_model.rb', line 46

def total_attachments
  @total_attachments
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



58
59
60
61
62
63
64
65
66
 
# File 'lib/lockstep_sdk/models/attachment_header_info_model.rb', line 58

def as_json(options={})
    {
        'groupKey' => @group_key,
        'companyId' => @company_id,
        'totalAttachments' => @total_attachments,
        'totalArchived' => @total_archived,
        'totalActive' => @total_active,
    }
end

#to_json(*options) ⇒ String

Returns This object converted to a JSON string.

Returns:

  • (String) —

    This object converted to a JSON string



70
71
72
 
# File 'lib/lockstep_sdk/models/attachment_header_info_model.rb', line 70

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