Class: ApplicationsClient

Inherits:
Object
  • Object
show all
Defined in:
lib/lockstep_sdk/clients/applications_client.rb

Instance Method Summary collapse

Constructor Details

#initialize(connection) ⇒ ApplicationsClient

Initialize the ApplicationsClient class with an API client instance.

Parameters:

  • connection (LockstepApi) —

    The API client object for this connection



22
23
24
 
# File 'lib/lockstep_sdk/clients/applications_client.rb', line 22

def initialize(connection)
    @connection = connection
end

Instance Method Details

#create_applications(body:) ⇒ Object

Creates one or more Applications and returns the records as created. Applications are universal and available across all accounts.

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.

Parameters:

  • body (ApplicationModel) —

    The Applications to create



79
80
81
82
 
# File 'lib/lockstep_sdk/clients/applications_client.rb', line 79

def create_applications(body:)
    path = "/api/v1/Applications"
    @connection.request(:post, path, body, nil)
end

#delete_application(id:) ⇒ Object

Deletes the Application referred to by this unique identifier. Information about this Application is retained but after the DELETE call, this Application is no longer available for use on the Lockstep Platform.

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.

Parameters:

  • id (uuid) —

    The unique ID number of the Application to delete



66
67
68
69
 
# File 'lib/lockstep_sdk/clients/applications_client.rb', line 66

def delete_application(id:)
    path = "/api/v1/Applications/#{id}"
    @connection.request(:delete, path, nil, nil)
end

#query_applications(filter:, include_param:, order:, page_size:, page_number:) ⇒ Object

Queries Applications on the Lockstep Platform using the specified filtering, sorting, nested fetch, and pagination rules requested.

More information on querying can be found on the [Searchlight Query Language](developer.lockstep.io/docs/querying-with-searchlight) page on the Lockstep Developer website.

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.

Parameters:



98
99
100
101
102
 
# File 'lib/lockstep_sdk/clients/applications_client.rb', line 98

def query_applications(filter:, include_param:, order:, page_size:, page_number:)
    path = "/api/v1/Applications/query"
    params = {:filter => filter, :include => include_param, :order => order, :pageSize => page_size, :pageNumber => page_number}
    @connection.request(:get, path, nil, params)
end

#retrieve_application(id:, include_param:) ⇒ Object

Retrieves the Application with this identifier.

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.

Parameters:

  • id (uuid) —

    The unique ID number of the Application to retrieve

  • include_param (string) —

    To fetch additional data on this object, specify the list of elements to retrieve. Available collections: Notes, Attachments, CustomFields



36
37
38
39
40
 
# File 'lib/lockstep_sdk/clients/applications_client.rb', line 36

def retrieve_application(id:, include_param:)
    path = "/api/v1/Applications/#{id}"
    params = {:include => include_param}
    @connection.request(:get, path, nil, params)
end

#update_application(id:, body:) ⇒ Object

Updates an existing Application with the information supplied to this PATCH call.

The PATCH method allows you to change specific values on the object while leaving other values alone. As input you should supply a list of field names and new values. For example, you can provide the field name “IsActive” and specify the new value “False”; this API will then change the value of IsActive to false.

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.

Parameters:

  • id (uuid) —

    The unique ID number of the Application to update

  • body (object) —

    A list of changes to apply to this Application



53
54
55
56
 
# File 'lib/lockstep_sdk/clients/applications_client.rb', line 53

def update_application(id:, body:)
    path = "/api/v1/Applications/#{id}"
    @connection.request(:patch, path, body.to_camelback_keys.to_json, nil)
end