Class: LockstepSdk::AppEnrollmentModel

Inherits:
Object
  • Object
show all
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

Instance Method Summary collapse

Constructor Details

#initialize(params = {}) ⇒ AppEnrollmentModel

Initialize the AppEnrollmentModel using the provided prototype



29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
# File 'lib/lockstep_sdk/models/app_enrollment_model.rb', line 29

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

#appApplicationModel

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.

Returns:

  • (ApplicationModel)

    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.



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

def app
  @app
end

#app_enrollment_idUuid

Returns The unique ID of this record, automatically assigned by Lockstep when this record is added to the Lockstep platform.

Returns:

  • (Uuid)

    The unique ID of this record, automatically assigned by Lockstep when this record is added to the Lockstep platform.



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

def app_enrollment_id
  @app_enrollment_id
end

#app_idUuid

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.

Returns:

  • (Uuid)

    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.



52
53
54
# File 'lib/lockstep_sdk/models/app_enrollment_model.rb', line 52

def app_id
  @app_id
end

#connector_infoConnectorInfoModel

Returns Optional data necessary to create an app enrollment for a supported connector. Only enter relevant fields for the given connector.

Returns:

  • (ConnectorInfoModel)

    Optional data necessary to create an app enrollment for a supported connector. Only enter relevant fields for the given connector.



82
83
84
# File 'lib/lockstep_sdk/models/app_enrollment_model.rb', line 82

def connector_info
  @connector_info
end

#createdDate-time

Returns Created date.

Returns:

  • (Date-time)

    Created date



58
59
60
# File 'lib/lockstep_sdk/models/app_enrollment_model.rb', line 58

def created
  @created
end

#created_user_idUuid

Returns Created user ID.

Returns:

  • (Uuid)

    Created user ID



60
61
62
# File 'lib/lockstep_sdk/models/app_enrollment_model.rb', line 60

def created_user_id
  @created_user_id
end

#cron_settingsString

Returns Stores schedule information for the application enrollment see en.wikipedia.org/wiki/Cron.

Returns:



66
67
68
# File 'lib/lockstep_sdk/models/app_enrollment_model.rb', line 66

def cron_settings
  @cron_settings
end

#custom_field_definitionsCustomFieldDefinitionModel

Returns All definitions attached to this app. To retrieve this collection, specify `CustomFieldValues` in the “Include” parameter for your query.

Returns:

  • (CustomFieldDefinitionModel)

    All definitions attached to this app. To retrieve this collection, specify `CustomFieldValues` in the “Include” parameter for your query.



72
73
74
# File 'lib/lockstep_sdk/models/app_enrollment_model.rb', line 72

def custom_field_definitions
  @custom_field_definitions
end

#custom_field_valuesCustomFieldValueModel

Returns All values attached to this app. To retrieve this collection, specify `CustomFieldValues` in the “Include” parameter for your query.

Returns:

  • (CustomFieldValueModel)

    All values attached to this app. To retrieve this collection, specify `CustomFieldValues` in the “Include” parameter for your query.



74
75
76
# File 'lib/lockstep_sdk/models/app_enrollment_model.rb', line 74

def custom_field_values
  @custom_field_values
end

#erp_infoErpInfoDataModel

Returns Use `ConnectorInfo` instead.

Returns:



80
81
82
# File 'lib/lockstep_sdk/models/app_enrollment_model.rb', line 80

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



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

def group_key
  @group_key
end

#is_activeBoolean

Returns Determines whether the app enrollment is in use.

Returns:

  • (Boolean)

    Determines whether the app enrollment is in use



56
57
58
# File 'lib/lockstep_sdk/models/app_enrollment_model.rb', line 56

def is_active
  @is_active
end

#last_successful_syncSyncRequestModel

Returns Data about the last successful sync associated with this enrollment.

Returns:

  • (SyncRequestModel)

    Data about the last successful sync associated with this enrollment



78
79
80
# File 'lib/lockstep_sdk/models/app_enrollment_model.rb', line 78

def last_successful_sync
  @last_successful_sync
end

#last_syncSyncRequestModel

Returns Data about the last sync attached to this app enrollment To retrieve this collection, specify `LastSync` in the “Include” parameter for your query.

Returns:

  • (SyncRequestModel)

    Data about the last sync attached to this app enrollment To retrieve this collection, specify `LastSync` in the “Include” parameter for your query.



76
77
78
# File 'lib/lockstep_sdk/models/app_enrollment_model.rb', line 76

def last_sync
  @last_sync
end

#modifiedDate-time

Returns Last modified date.

Returns:

  • (Date-time)

    Last modified date



62
63
64
# File 'lib/lockstep_sdk/models/app_enrollment_model.rb', line 62

def modified
  @modified
end

#modified_user_idUuid

Returns Last user ID to modify.

Returns:

  • (Uuid)

    Last user ID to modify



64
65
66
# File 'lib/lockstep_sdk/models/app_enrollment_model.rb', line 64

def modified_user_id
  @modified_user_id
end

#sync_schedule_is_activeBoolean

Returns Flag indicating if the Sync process should be ran on the specified schedule.

Returns:

  • (Boolean)

    Flag indicating if the Sync process should be ran on the specified schedule



68
69
70
# File 'lib/lockstep_sdk/models/app_enrollment_model.rb', line 68

def sync_schedule_is_active
  @sync_schedule_is_active
end