Class: LockstepSdk::ApplicationModel

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

Overview

An Application represents a feature available to customers within the Lockstep Platform. You can create Applications by working with your Lockstep business development manager and publish them on the platform so that customers can browse and find your Application on the Lockstep Platform Marketplace. When a customer adds an Application to their account, they obtain an AppEnrollment which represents that customer’s instance of this Application. The customer-specific AppEnrollment contains a customer’s configuration data for the Application, which is not customer-specific.

See [Applications and Enrollments](developer.lockstep.io/docs/applications-and-enrollments) for more information. –swaggerCategory:Platform

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(params = {}) ⇒ ApplicationModel

Initialize the ApplicationModel using the provided prototype



33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
 
# File 'lib/lockstep_sdk/models/application_model.rb', line 33

def initialize(params = {})
    @app_id = params.dig(:app_id)
    @name = params.dig(:name)
    @description = params.dig(:description)
    @app_type = params.dig(:app_type)
    @owner_id = params.dig(:owner_id)
    @project_url = params.dig(:project_url)
    @icon_url = params.dig(:icon_url)
    @price_terms = params.dig(:price_terms)
    @created_user_id = params.dig(:created_user_id)
    @modified_user_id = params.dig(:modified_user_id)
    @created = params.dig(:created)
    @modified = params.dig(:modified)
    @is_active = params.dig(:is_active)
    @wiki_url = params.dig(:wiki_url)
    @group_key = params.dig(:group_key)
    @b2_cclient_id = params.dig(:b2_cclient_id)
    @notes = params.dig(:notes)
    @attachments = params.dig(:attachments)
    @custom_field_definitions = params.dig(:custom_field_definitions)
    @custom_field_values = params.dig(:custom_field_values)
end

Instance Attribute Details

#app_id ⇒ Uuid

Returns A unique code identifying this application.

Returns:

  • (Uuid) —

    A unique code identifying this application



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

def app_id
  @app_id
end

#app_type ⇒ String

Returns Tag for what type of app this is.

Returns:

  • (String) —

    Tag for what type of app this is



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

def app_type
  @app_type
end

#attachments ⇒ AttachmentModel

Returns A collection of attachments linked to this record. To retrieve this collection, specify ‘Attachments` in the `include` parameter when retrieving data. To create an attachment, use the [Upload Attachment](developer.lockstep.io/reference/post_api-v1-attachments) endpoint with the `TableKey` to `Application` and the `ObjectKey` set to the `ApplicationId` for this record. For more information on extensibility, see [linking extensible metadata to objects](developer.lockstep.io/docs/custom-fields#linking-metadata-to-an-object).

Returns:



126
127
128
 
# File 'lib/lockstep_sdk/models/application_model.rb', line 126

def attachments
  @attachments
end

#b2_cclient_id ⇒ Uuid

Returns The B2C Client ID of the application.

Returns:

  • (Uuid) —

    The B2C Client ID of the application



118
119
120
 
# File 'lib/lockstep_sdk/models/application_model.rb', line 118

def b2_cclient_id
  @b2_cclient_id
end

#created ⇒ Date-time

Returns The date this application was created.

Returns:

  • (Date-time) —

    The date this application was created



98
99
100
 
# File 'lib/lockstep_sdk/models/application_model.rb', line 98

def created
  @created
end

#created_user_id ⇒ Uuid

Returns The ID of the user who created this application.

Returns:

  • (Uuid) —

    The ID of the user who created this application



90
91
92
 
# File 'lib/lockstep_sdk/models/application_model.rb', line 90

def created_user_id
  @created_user_id
end

#custom_field_definitions ⇒ CustomFieldDefinitionModel

Returns A collection of custom fields linked to this record. To retrieve this collection, specify ‘CustomFieldDefinitions` in the `include` parameter when retrieving data. To create a custom field, use the [Create Custom Field](developer.lockstep.io/reference/post_api-v1-customfieldvalues) endpoint with the `TableKey` to `Application` and the `ObjectKey` set to the `ApplicationId` for this record. For more information on extensibility, see [linking extensible metadata to objects](developer.lockstep.io/docs/custom-fields#linking-metadata-to-an-object).

Returns:



130
131
132
 
# File 'lib/lockstep_sdk/models/application_model.rb', line 130

def custom_field_definitions
  @custom_field_definitions
end

#custom_field_values ⇒ CustomFieldValueModel

Returns A collection of custom fields linked to this record. To retrieve this collection, specify ‘CustomFieldValues` in the `include` parameter when retrieving data. To create a custom field, use the [Create Custom Field](developer.lockstep.io/reference/post_api-v1-customfieldvalues) endpoint with the `TableKey` to `Application` and the `ObjectKey` set to the `ApplicationId` for this record. For more information on extensibility, see [linking extensible metadata to objects](developer.lockstep.io/docs/custom-fields#linking-metadata-to-an-object).

Returns:



134
135
136
 
# File 'lib/lockstep_sdk/models/application_model.rb', line 134

def custom_field_values
  @custom_field_values
end

#description ⇒ String

Returns Brief summary of this application shown as a subtitle.

Returns:

  • (String) —

    Brief summary of this application shown as a subtitle



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

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



114
115
116
 
# File 'lib/lockstep_sdk/models/application_model.rb', line 114

def group_key
  @group_key
end

#icon_url ⇒ Uri

Returns The URL for the icon for this application.

Returns:

  • (Uri) —

    The URL for the icon for this application



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

def icon_url
  @icon_url
end

#is_active ⇒ Boolean

Returns Flag indicating if the application is active.

Returns:

  • (Boolean) —

    Flag indicating if the application is active.



106
107
108
 
# File 'lib/lockstep_sdk/models/application_model.rb', line 106

def is_active
  @is_active
end

#modified ⇒ Date-time

Returns The date this application was last modified.

Returns:

  • (Date-time) —

    The date this application was last modified



102
103
104
 
# File 'lib/lockstep_sdk/models/application_model.rb', line 102

def modified
  @modified
end

#modified_user_id ⇒ Uuid

Returns The ID of the user who last modified this application.

Returns:

  • (Uuid) —

    The ID of the user who last modified this application



94
95
96
 
# File 'lib/lockstep_sdk/models/application_model.rb', line 94

def modified_user_id
  @modified_user_id
end

#name ⇒ String

Returns The name of this application.

Returns:

  • (String) —

    The name of this application



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

def name
  @name
end

#notes ⇒ NoteModel

Returns A collection of notes linked to this record. To retrieve this collection, specify ‘Notes` in the `include` parameter when retrieving data. To create a note, use the [Create Note](developer.lockstep.io/reference/post_api-v1-notes) endpoint with the `TableKey` to `Application` and the `ObjectKey` set to the `ApplicationId` for this record. For more information on extensibility, see [linking extensible metadata to objects](developer.lockstep.io/docs/custom-fields#linking-metadata-to-an-object).

Returns:



122
123
124
 
# File 'lib/lockstep_sdk/models/application_model.rb', line 122

def notes
  @notes
end

#owner_id ⇒ Uuid

Returns The ID of the owner.

Returns:

  • (Uuid) —

    The ID of the owner



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

def owner_id
  @owner_id
end

#price_terms ⇒ String

Returns The description of the price for this application.

Returns:

  • (String) —

    The description of the price for this application



86
87
88
 
# File 'lib/lockstep_sdk/models/application_model.rb', line 86

def price_terms
  @price_terms
end

#project_url ⇒ Uri

Returns The URL to visit for more information about this application.

Returns:

  • (Uri) —

    The URL to visit for more information about this application



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

def project_url
  @project_url
end

#wiki_url ⇒ Uri

Returns URL to the Wiki for the Application.

Returns:

  • (Uri) —

    URL to the Wiki for the Application



110
111
112
 
# File 'lib/lockstep_sdk/models/application_model.rb', line 110

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



138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
 
# File 'lib/lockstep_sdk/models/application_model.rb', line 138

def as_json(options={})
    {
        'appId' => @app_id,
        'name' => @name,
        'description' => @description,
        'appType' => @app_type,
        'ownerId' => @owner_id,
        'projectUrl' => @project_url,
        'iconUrl' => @icon_url,
        'priceTerms' => @price_terms,
        'createdUserId' => @created_user_id,
        'modifiedUserId' => @modified_user_id,
        'created' => @created,
        'modified' => @modified,
        'isActive' => @is_active,
        'wikiURL' => @wiki_url,
        'groupKey' => @group_key,
        'b2CClientId' => @b2_cclient_id,
        'notes' => @notes,
        'attachments' => @attachments,
        'customFieldDefinitions' => @custom_field_definitions,
        'customFieldValues' => @custom_field_values,
    }
end

#to_json(*options) ⇒ String

Returns This object converted to a JSON string.

Returns:

  • (String) —

    This object converted to a JSON string



165
166
167
 
# File 'lib/lockstep_sdk/models/application_model.rb', line 165

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