Class: LockstepSdk::GroupAccountModel

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

Overview

Represents an account for an entire group

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(params = {}) ⇒ GroupAccountModel

Initialize the GroupAccountModel using the provided prototype



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

def initialize(params = {})
    @group_key = params.dig(:group_key)
    @group_name = params.dig(:group_name)
    @primary_user_id = params.dig(:primary_user_id)
    @group_company_id = params.dig(:group_company_id)
    @base_currency_code = params.dig(:base_currency_code)
    @is_active = params.dig(:is_active)
    @onboarding_scheduled = params.dig(:onboarding_scheduled)
    @created = params.dig(:created)
    @created_user_id = params.dig(:created_user_id)
    @modified = params.dig(:modified)
    @modified_user_id = params.dig(:modified_user_id)
end

Instance Attribute Details

#base_currency_code ⇒ String

Returns Base Currency of the group.

Returns:

  • (String) —

    Base Currency of the group



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

def base_currency_code
  @base_currency_code
end

#created ⇒ Date-time

Returns The date this group account was created.

Returns:

  • (Date-time) —

    The date this group account was created



69
70
71
 
# File 'lib/lockstep_sdk/models/group_account_model.rb', line 69

def created
  @created
end

#created_user_id ⇒ Uuid

Returns The ID of the user who created this group account.

Returns:

  • (Uuid) —

    The ID of the user who created this group account



73
74
75
 
# File 'lib/lockstep_sdk/models/group_account_model.rb', line 73

def created_user_id
  @created_user_id
end

#group_company_id ⇒ Uuid

Returns The CompanyId of the Company the group is associated with.

Returns:

  • (Uuid) —

    The CompanyId of the Company the group is associated with



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

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



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

def group_key
  @group_key
end

#group_name ⇒ String

Returns The name of the group.

Returns:

  • (String) —

    The name of the group



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

def group_name
  @group_name
end

#is_active ⇒ Boolean

Returns The active status of the group.

Returns:

  • (Boolean) —

    The active status of the group



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

def is_active
  @is_active
end

#modified ⇒ Date-time

Returns The date this group account was last modified.

Returns:

  • (Date-time) —

    The date this group account was last modified



77
78
79
 
# File 'lib/lockstep_sdk/models/group_account_model.rb', line 77

def modified
  @modified
end

#modified_user_id ⇒ Uuid

Returns The ID of the user who last modified this group account.

Returns:

  • (Uuid) —

    The ID of the user who last modified this group account



81
82
83
 
# File 'lib/lockstep_sdk/models/group_account_model.rb', line 81

def modified_user_id
  @modified_user_id
end

#onboarding_scheduled ⇒ Boolean

Returns The onboarding session status of the group.

Returns:

  • (Boolean) —

    The onboarding session status of the group



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

def onboarding_scheduled
  @onboarding_scheduled
end

#primary_user_id ⇒ Uuid

Returns The primary user for the group.

Returns:

  • (Uuid) —

    The primary user for the group



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

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



85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
 
# File 'lib/lockstep_sdk/models/group_account_model.rb', line 85

def as_json(options={})
    {
        'groupKey' => @group_key,
        'groupName' => @group_name,
        'primaryUserId' => @primary_user_id,
        'groupCompanyId' => @group_company_id,
        'baseCurrencyCode' => @base_currency_code,
        'isActive' => @is_active,
        'onboardingScheduled' => @onboarding_scheduled,
        'created' => @created,
        'createdUserId' => @created_user_id,
        'modified' => @modified,
        'modifiedUserId' => @modified_user_id,
    }
end

#to_json(*options) ⇒ String

Returns This object converted to a JSON string.

Returns:

  • (String) —

    This object converted to a JSON string



103
104
105
 
# File 'lib/lockstep_sdk/models/group_account_model.rb', line 103

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