Class: LockstepSdk::AppEnrollmentModel
- Inherits:
-
Object
- Object
- LockstepSdk::AppEnrollmentModel
- Defined in:
- lib/lockstep_sdk/models/app_enrollment_model.rb
Overview
An AppEnrollment represents an app that has been enrolled to the current account. When you sign up for an app using the Lockstep Platform, you obtain an enrollment record for that app. Example types of apps include connectors and feature enhancement apps. The App Enrollment object contains information about this app, its configuration, and settings.
See [Applications and Enrollments](developer.lockstep.io/docs/applications-and-enrollments) for more information.
Instance Attribute Summary collapse
-
#app ⇒ ApplicationModel
The Application to which this AppEnrollment belongs.
-
#app_enrollment_id ⇒ Uuid
The unique ID of this record, automatically assigned by Lockstep when this record is added to the Lockstep platform.
-
#app_id ⇒ Uuid
The ID number of the Application that this enrollment represents.
-
#connector_info ⇒ ConnectorInfoModel
Optional data necessary to create an app enrollment for a supported connector.
-
#created ⇒ Date-time
Created date.
-
#created_user_id ⇒ Uuid
Created user ID.
-
#cron_settings ⇒ String
Stores schedule information for the application enrollment see en.wikipedia.org/wiki/Cron.
-
#custom_field_definitions ⇒ CustomFieldDefinitionModel
All definitions attached to this app.
-
#custom_field_values ⇒ CustomFieldValueModel
All values attached to this app.
-
#erp_info ⇒ ErpInfoDataModel
Use `ConnectorInfo` instead.
-
#group_key ⇒ Uuid
The GroupKey uniquely identifies a single Lockstep Platform account.
-
#is_active ⇒ Boolean
Determines whether the app enrollment is in use.
-
#last_successful_sync ⇒ SyncRequestModel
Data about the last successful sync associated with this enrollment.
-
#last_sync ⇒ SyncRequestModel
Data about the last sync attached to this app enrollment To retrieve this collection, specify `LastSync` in the “Include” parameter for your query.
-
#modified ⇒ Date-time
Last modified date.
-
#modified_user_id ⇒ Uuid
Last user ID to modify.
-
#sync_schedule_is_active ⇒ Boolean
Flag indicating if the Sync process should be ran on the specified schedule.
Instance Method Summary collapse
-
#as_json(options = {}) ⇒ object
This object as a JSON key-value structure.
-
#initialize(params = {}) ⇒ AppEnrollmentModel
constructor
Initialize the AppEnrollmentModel using the provided prototype.
-
#to_json(*options) ⇒ String
This object converted to a JSON string.
Constructor Details
#initialize(params = {}) ⇒ AppEnrollmentModel
Initialize the AppEnrollmentModel using the provided prototype
33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 |
# File 'lib/lockstep_sdk/models/app_enrollment_model.rb', line 33 def initialize(params = {}) @app_enrollment_id = params.dig(:app_enrollment_id) @app_id = params.dig(:app_id) @group_key = params.dig(:group_key) @is_active = params.dig(:is_active) @created = params.dig(:created) @created_user_id = params.dig(:created_user_id) @modified = params.dig(:modified) @modified_user_id = params.dig(:modified_user_id) @cron_settings = params.dig(:cron_settings) @sync_schedule_is_active = params.dig(:sync_schedule_is_active) @app = params.dig(:app) @custom_field_definitions = params.dig(:custom_field_definitions) @custom_field_values = params.dig(:custom_field_values) @last_sync = params.dig(:last_sync) @last_successful_sync = params.dig(:last_successful_sync) @erp_info = params.dig(:erp_info) @connector_info = params.dig(:connector_info) end |
Instance Attribute Details
#app ⇒ ApplicationModel
Returns The Application to which this AppEnrollment belongs. Contains general name, description, logo, and other metadata about this application. To retrieve this object, specify `App` in the “Include” parameter for your query.
95 96 97 |
# File 'lib/lockstep_sdk/models/app_enrollment_model.rb', line 95 def app @app end |
#app_enrollment_id ⇒ Uuid
Returns The unique ID of this record, automatically assigned by Lockstep when this record is added to the Lockstep platform.
55 56 57 |
# File 'lib/lockstep_sdk/models/app_enrollment_model.rb', line 55 def app_enrollment_id @app_enrollment_id end |
#app_id ⇒ Uuid
Returns The ID number of the Application that this enrollment represents. You can fetch information about this Application object by specifying `App` in the “Include” parameter for your request.
59 60 61 |
# File 'lib/lockstep_sdk/models/app_enrollment_model.rb', line 59 def app_id @app_id end |
#connector_info ⇒ ConnectorInfoModel
Returns Optional data necessary to create an app enrollment for a supported connector. Only enter relevant fields for the given connector.
119 120 121 |
# File 'lib/lockstep_sdk/models/app_enrollment_model.rb', line 119 def connector_info @connector_info end |
#created ⇒ Date-time
Returns Created date.
71 72 73 |
# File 'lib/lockstep_sdk/models/app_enrollment_model.rb', line 71 def created @created end |
#created_user_id ⇒ Uuid
Returns Created user ID.
75 76 77 |
# File 'lib/lockstep_sdk/models/app_enrollment_model.rb', line 75 def created_user_id @created_user_id end |
#cron_settings ⇒ String
Returns Stores schedule information for the application enrollment see en.wikipedia.org/wiki/Cron.
87 88 89 |
# File 'lib/lockstep_sdk/models/app_enrollment_model.rb', line 87 def cron_settings @cron_settings end |
#custom_field_definitions ⇒ CustomFieldDefinitionModel
Returns All definitions attached to this app. To retrieve this collection, specify `CustomFieldValues` in the “Include” parameter for your query.
99 100 101 |
# File 'lib/lockstep_sdk/models/app_enrollment_model.rb', line 99 def custom_field_definitions @custom_field_definitions end |
#custom_field_values ⇒ CustomFieldValueModel
Returns All values attached to this app. To retrieve this collection, specify `CustomFieldValues` in the “Include” parameter for your query.
103 104 105 |
# File 'lib/lockstep_sdk/models/app_enrollment_model.rb', line 103 def custom_field_values @custom_field_values end |
#erp_info ⇒ ErpInfoDataModel
Returns Use `ConnectorInfo` instead.
115 116 117 |
# File 'lib/lockstep_sdk/models/app_enrollment_model.rb', line 115 def erp_info @erp_info 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).
63 64 65 |
# File 'lib/lockstep_sdk/models/app_enrollment_model.rb', line 63 def group_key @group_key end |
#is_active ⇒ Boolean
Returns Determines whether the app enrollment is in use.
67 68 69 |
# File 'lib/lockstep_sdk/models/app_enrollment_model.rb', line 67 def is_active @is_active end |
#last_successful_sync ⇒ SyncRequestModel
Returns Data about the last successful sync associated with this enrollment.
111 112 113 |
# File 'lib/lockstep_sdk/models/app_enrollment_model.rb', line 111 def last_successful_sync @last_successful_sync end |
#last_sync ⇒ SyncRequestModel
Returns Data about the last sync attached to this app enrollment To retrieve this collection, specify `LastSync` in the “Include” parameter for your query.
107 108 109 |
# File 'lib/lockstep_sdk/models/app_enrollment_model.rb', line 107 def last_sync @last_sync end |
#modified ⇒ Date-time
Returns Last modified date.
79 80 81 |
# File 'lib/lockstep_sdk/models/app_enrollment_model.rb', line 79 def modified @modified end |
#modified_user_id ⇒ Uuid
Returns Last user ID to modify.
83 84 85 |
# File 'lib/lockstep_sdk/models/app_enrollment_model.rb', line 83 def modified_user_id @modified_user_id end |
#sync_schedule_is_active ⇒ Boolean
Returns Flag indicating if the Sync process should be ran on the specified schedule.
91 92 93 |
# File 'lib/lockstep_sdk/models/app_enrollment_model.rb', line 91 def sync_schedule_is_active @sync_schedule_is_active end |
Instance Method Details
#as_json(options = {}) ⇒ object
Returns This object as a JSON key-value structure.
123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 |
# File 'lib/lockstep_sdk/models/app_enrollment_model.rb', line 123 def as_json(={}) { 'appEnrollmentId' => @app_enrollment_id, 'appId' => @app_id, 'groupKey' => @group_key, 'isActive' => @is_active, 'created' => @created, 'createdUserId' => @created_user_id, 'modified' => @modified, 'modifiedUserId' => @modified_user_id, 'cronSettings' => @cron_settings, 'syncScheduleIsActive' => @sync_schedule_is_active, 'app' => @app, 'customFieldDefinitions' => @custom_field_definitions, 'customFieldValues' => @custom_field_values, 'lastSync' => @last_sync, 'lastSuccessfulSync' => @last_successful_sync, 'erpInfo' => @erp_info, 'connectorInfo' => @connector_info, } end |
#to_json(*options) ⇒ String
Returns This object converted to a JSON string.
147 148 149 |
# File 'lib/lockstep_sdk/models/app_enrollment_model.rb', line 147 def to_json(*) "[#{as_json(*).to_json(*)}]" end |