Class: LockstepSdk::CustomFieldValueModel
- Inherits:
-
Object
- Object
- LockstepSdk::CustomFieldValueModel
- Defined in:
- lib/lockstep_sdk/models/custom_field_value_model.rb
Overview
A Custom Field represents metadata added to an object within the Lockstep Platform. Lockstep provides a core definition for each object. The core definition is intended to represent a level of compatibility that provides support across most accounting systems and products. When a user or developer requires information beyond this core definition, you can use Custom Fields to represent this information.
See [Extensibility](developer.lockstep.io/docs/extensibility) for more information.
Instance Attribute Summary collapse
-
#app_enrollment_id ⇒ Uuid
AppEnrollmentId for this record; used for mapping purposes.
-
#created ⇒ Date-time
Date created.
-
#created_user_id ⇒ Uuid
Id of user who created this value.
-
#custom_field_definition ⇒ CustomFieldDefinitionModel
Definition of the value.
-
#custom_field_definition_id ⇒ Uuid
The unique ID of this record, automatically assigned by Lockstep when this record is added to the Lockstep platform.
-
#group_key ⇒ Uuid
The GroupKey uniquely identifies a single Lockstep Platform account.
-
#modified ⇒ Date-time
Date modified.
-
#modified_user_id ⇒ Uuid
Id of user who modified this value.
-
#numeric_value ⇒ Double
Number data for field.
-
#record_key ⇒ Uuid
Additional key if source table doesn't have a unique id.
-
#string_value ⇒ String
String of data for field.
Instance Method Summary collapse
-
#initialize(params = {}) ⇒ CustomFieldValueModel
constructor
Initialize the CustomFieldValueModel using the provided prototype.
Constructor Details
#initialize(params = {}) ⇒ CustomFieldValueModel
Initialize the CustomFieldValueModel using the provided prototype
29 30 31 32 33 34 35 36 37 38 39 40 41 |
# File 'lib/lockstep_sdk/models/custom_field_value_model.rb', line 29 def initialize(params = {}) @group_key = params.dig(:group_key) @custom_field_definition_id = params.dig(:custom_field_definition_id) @record_key = params.dig(:record_key) @string_value = params.dig(:string_value) @numeric_value = params.dig(:numeric_value) @created = params.dig(:created) @created_user_id = params.dig(:created_user_id) @modified = params.dig(:modified) @modified_user_id = params.dig(:modified_user_id) @app_enrollment_id = params.dig(:app_enrollment_id) @custom_field_definition = params.dig(:custom_field_definition) end |
Instance Attribute Details
#app_enrollment_id ⇒ Uuid
Returns AppEnrollmentId for this record; used for mapping purposes.
62 63 64 |
# File 'lib/lockstep_sdk/models/custom_field_value_model.rb', line 62 def app_enrollment_id @app_enrollment_id end |
#created ⇒ Date-time
Returns Date created.
54 55 56 |
# File 'lib/lockstep_sdk/models/custom_field_value_model.rb', line 54 def created @created end |
#created_user_id ⇒ Uuid
Returns Id of user who created this value.
56 57 58 |
# File 'lib/lockstep_sdk/models/custom_field_value_model.rb', line 56 def created_user_id @created_user_id end |
#custom_field_definition ⇒ CustomFieldDefinitionModel
Returns Definition of the value.
64 65 66 |
# File 'lib/lockstep_sdk/models/custom_field_value_model.rb', line 64 def custom_field_definition @custom_field_definition end |
#custom_field_definition_id ⇒ Uuid
Returns The unique ID of this record, automatically assigned by Lockstep when this record is added to the Lockstep platform.
46 47 48 |
# File 'lib/lockstep_sdk/models/custom_field_value_model.rb', line 46 def custom_field_definition_id @custom_field_definition_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).
44 45 46 |
# File 'lib/lockstep_sdk/models/custom_field_value_model.rb', line 44 def group_key @group_key end |
#modified ⇒ Date-time
Returns Date modified.
58 59 60 |
# File 'lib/lockstep_sdk/models/custom_field_value_model.rb', line 58 def modified @modified end |
#modified_user_id ⇒ Uuid
Returns Id of user who modified this value.
60 61 62 |
# File 'lib/lockstep_sdk/models/custom_field_value_model.rb', line 60 def modified_user_id @modified_user_id end |
#numeric_value ⇒ Double
Returns Number data for field.
52 53 54 |
# File 'lib/lockstep_sdk/models/custom_field_value_model.rb', line 52 def numeric_value @numeric_value end |
#record_key ⇒ Uuid
Returns Additional key if source table doesn't have a unique id.
48 49 50 |
# File 'lib/lockstep_sdk/models/custom_field_value_model.rb', line 48 def record_key @record_key end |
#string_value ⇒ String
Returns String of data for field.
50 51 52 |
# File 'lib/lockstep_sdk/models/custom_field_value_model.rb', line 50 def string_value @string_value end |