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



24
25
26
27
28
29
30
# File 'lib/lockstep_sdk/models/attachment_header_info_model.rb', line 24

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_idUuid

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



35
36
37
# File 'lib/lockstep_sdk/models/attachment_header_info_model.rb', line 35

def company_id
  @company_id
end

#group_keyUuid

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).



33
34
35
# File 'lib/lockstep_sdk/models/attachment_header_info_model.rb', line 33

def group_key
  @group_key
end

#total_activeInt32

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.



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

def total_active
  @total_active
end

#total_archivedInt32

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.



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

def total_archived
  @total_archived
end

#total_attachmentsInt32

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.



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

def total_attachments
  @total_attachments
end