lockstep_sdk 2022.4.32.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 8b854dd68a25a3040b228316da8c16fece271f461d6fde254e48767650d43421
+  data.tar.gz: 268e04ddd7e8e2fd2dc773b978af09bdd281c9b61b83a5d10c122ebd75c31dba
+SHA512:
+  metadata.gz: e949c4841b20bbd085b84d4f4cd3d6d07d047dfb508107e38178a5279a6550475ad2f05657aca9ccdb5fbfe4ec18fcd0b1af6d29369c3c317d466bcf03a73524
+  data.tar.gz: 48366d61bc0e58539793be755743d8f787ca4737d012a69266bc9eca09c2b08daada9f9afdca7bcd75ee5d66bb131b7302156103cbbaf9a4261e28de41fc190e

data/lib/lockstep_sdk/clients/activities_client.rb

@@ -0,0 +1,119 @@
+#
+# Lockstep Software Development Kit for Ruby
+#
+# (c) 2021-2022 Lockstep, Inc.
+#
+# For the full copyright and license information, please view the LICENSE
+# file that was distributed with this source code.
+#
+# @author     Ted Spence <tspence@lockstep.io>
+# @author     Manish Narayan B S <manish.n@lockstep.io>
+# @author     Rishi Rajkumar Jawahar <rjawahar@lockstep.io>
+# @copyright  2021-2022 Lockstep, Inc.
+# @version    2022.4
+# @link       https://github.com/Lockstep-Network/lockstep-sdk-ruby
+#
+
+
+require 'awrence'
+
+class ActivitiesClient
+
+    ##
+    # Initialize the ActivitiesClient class with a lockstepsdk instance.
+    # @param lockstepsdk [LockstepApi] The Lockstep API client object for this connection
+    def initialize(lockstepsdk)
+        @lockstepsdk = lockstepsdk
+    end
+
+
+    ##
+    # Retrieves the Activity specified by this unique identifier, optionally including nested data sets.
+    #
+    # An Activity contains information about work being done on a specific accounting task. You can use Activities to track information about who has been assigned a specific task, the current status of the task, the name and description given for the particular task, the priority of the task, and any amounts collected, paid, or credited for the task.
+    #
+    # @param id [uuid] The unique Lockstep Platform ID number of this Activity
+    # @param include_param [string] To fetch additional data on this object, specify the list of elements to retrieve. Available collections: Company, Attachments, CustomFields, Notes, References, and UserAssignedToName
+    def retrieve_activity(id:, include_param:)
+        path = "/api/v1/Activities/#{id}"
+        params = {:include => include_param}
+        @lockstepsdk.request(:get, path, nil, params)
+    end
+
+    ##
+    # Updates an activity that matches the specified id with the requested information.
+    #
+    # 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.  If you do not provide the name of a field, that field will remain unchanged.  This allows you to ensure that you are only updating the specific fields desired.
+    #
+    # An Activity contains information about work being done on a specific accounting task. You can use Activities to track information about who has been assigned a specific task, the current status of the task, the name and description given for the particular task, the priority of the task, and any amounts collected, paid, or credited for the task.
+    #
+    # @param id [uuid] The unique Lockstep Platform ID number of the Activity to update
+    # @param body [object] A list of changes to apply to this Activity
+    def update_activity(id:, body:)
+        path = "/api/v1/Activities/#{id}"
+        @lockstepsdk.request(:patch, path, body.to_camelback_keys.to_json, nil)
+    end
+
+    ##
+    # Delete the Activity referred to by this unique identifier.
+    #
+    # An Activity contains information about work being done on a specific accounting task. You can use Activities to track information about who has been assigned a specific task, the current status of the task, the name and description given for the particular task, the priority of the task, and any amounts collected, paid, or credited for the task.
+    #
+    # @param id [uuid] The unique Lockstep Platform ID number of the Activity to delete
+    def delete_activity(id:)
+        path = "/api/v1/Activities/#{id}"
+        @lockstepsdk.request(:delete, path, nil, nil)
+    end
+
+    ##
+    # Creates one or more activities from a given model.
+    #
+    # An Activity contains information about work being done on a specific accounting task. You can use Activities to track information about who has been assigned a specific task, the current status of the task, the name and description given for the particular task, the priority of the task, and any amounts collected, paid, or credited for the task.
+    #
+    # @param body [ActivityModel] The Activities to create
+    def create_activities(body:)
+        path = "/api/v1/Activities"
+        @lockstepsdk.request(:post, path, body, nil)
+    end
+
+    ##
+    # Queries Activities for this account using the specified filtering, sorting, nested fetch, and pagination rules requested.
+    #
+    # More information on querying can be found on the [Searchlight Query Language](https://developer.lockstep.io/docs/querying-with-searchlight) page on the Lockstep Developer website.
+    #
+    # An Activity contains information about work being done on a specific accounting task. You can use Activities to track information about who has been assigned a specific task, the current status of the task, the name and description given for the particular task, the priority of the task, and any amounts collected, paid, or credited for the task.
+    #
+    # @param filter [string] The filter for this query. See [Searchlight Query Language](https://developer.lockstep.io/docs/querying-with-searchlight)
+    # @param include_param [string] To fetch additional data on this object, specify the list of elements to retrieve. Available collections: Company, Attachments, CustomFields, Notes, References, and UserAssignedToName
+    # @param order [string] The sort order for this query. See See [Searchlight Query Language](https://developer.lockstep.io/docs/querying-with-searchlight)
+    # @param page_size [int32] The page size for results (default 200). See [Searchlight Query Language](https://developer.lockstep.io/docs/querying-with-searchlight)
+    # @param page_number [int32] The page number for results (default 0). See [Searchlight Query Language](https://developer.lockstep.io/docs/querying-with-searchlight)
+    def query_activities(filter:, include_param:, order:, page_size:, page_number:)
+        path = "/api/v1/Activities/query"
+        params = {:filter => filter, :include => include_param, :order => order, :pageSize => page_size, :pageNumber => page_number}
+        @lockstepsdk.request(:get, path, nil, params)
+    end
+
+    ##
+    # Retrieves a list of items representing the activity stream for the supplied activity id.
+    #
+    # An Activity contains information about work being done on a specific accounting task. You can use Activities to track information about who has been assigned a specific task, the current status of the task, the name and description given for the particular task, the priority of the task, and any amounts collected, paid, or credited for the task.
+    #
+    # @param id [uuid] The unique Lockstep Platform ID number of this Activity
+    def retrieve_activity_stream(id:)
+        path = "/api/v1/Activities/#{id}/stream"
+        @lockstepsdk.request(:get, path, nil, nil)
+    end
+
+    ##
+    # Forwards an activity by creating a new activity with all child references and assigning the new activity to a new user.
+    #
+    # An Activity contains information about work being done on a specific accounting task. You can use Activities to track information about who has been assigned a specific task, the current status of the task, the name and description given for the particular task, the priority of the task, and any amounts collected, paid, or credited for the task.
+    #
+    # @param activity_id [uuid] 
+    # @param user_id [uuid] 
+    def forward_activity(activity_id:, user_id:)
+        path = "/api/v1/Activities/#{activityId}/forward/#{userId}"
+        @lockstepsdk.request(:post, path, nil, nil)
+    end
+end

data/lib/lockstep_sdk/clients/api_keys_client.rb

@@ -0,0 +1,78 @@
+#
+# Lockstep Software Development Kit for Ruby
+#
+# (c) 2021-2022 Lockstep, Inc.
+#
+# For the full copyright and license information, please view the LICENSE
+# file that was distributed with this source code.
+#
+# @author     Ted Spence <tspence@lockstep.io>
+# @author     Manish Narayan B S <manish.n@lockstep.io>
+# @author     Rishi Rajkumar Jawahar <rjawahar@lockstep.io>
+# @copyright  2021-2022 Lockstep, Inc.
+# @version    2022.4
+# @link       https://github.com/Lockstep-Network/lockstep-sdk-ruby
+#
+
+
+require 'awrence'
+
+class ApiKeysClient
+
+    ##
+    # Initialize the ApiKeysClient class with a lockstepsdk instance.
+    # @param lockstepsdk [LockstepApi] The Lockstep API client object for this connection
+    def initialize(lockstepsdk)
+        @lockstepsdk = lockstepsdk
+    end
+
+
+    ##
+    # Retrieves the API Key with this identifier.
+    #
+    # An API Key is an authentication token that you may use with the Lockstep API.  Because API Keys do not have an expiration date, they are well suited for unattended processes.  Each API Key is associated with a user, and may be revoked to prevent it from accessing the Lockstep API. When you create an API Key, make sure to save the value in a secure location.  Lockstep cannot retrieve an API Key once it is created.  For more information, see [API Keys](https://developer.lockstep.io/docs/api-keys).
+    #
+    # @param id [uuid] The unique ID number of the API Key to retrieve
+    # @param include_param [string] To fetch additional data on this object, specify the list of elements to retrieve. No collections are currently available but may be offered in the future.
+    def retrieve_api_key(id:, include_param:)
+        path = "/api/v1/ApiKeys/#{id}"
+        params = {:include => include_param}
+        @lockstepsdk.request(:get, path, nil, params)
+    end
+
+    ##
+    # Immediately revokes the API Key with the specified id so it cannot be used to call the API.  The Lockstep Platform guarantees that revocation will be received by all servers within five minutes of revocation.  API calls made using this API key after the revocation will fail.  A revoked API Key  cannot be un-revoked and may be removed 60 days after revocation.
+    #
+    # An API Key is an authentication token that you may use with the Lockstep API.  Because API Keys do not have an expiration date, they are well suited for unattended processes.  Each API Key is associated with a user, and may be revoked to prevent it from accessing the Lockstep API. When you create an API Key, make sure to save the value in a secure location.  Lockstep cannot retrieve an API Key once it is created.  For more information, see [API Keys](https://developer.lockstep.io/docs/api-keys).
+    #
+    # @param id [uuid] The unique Lockstep Platform ID number of this API Key
+    def revoke_api_key(id:)
+        path = "/api/v1/ApiKeys/#{id}"
+        @lockstepsdk.request(:delete, path, nil, nil)
+    end
+
+    ##
+    # Creates an API key with the specified name.
+    #
+    # An API Key is an authentication token that you may use with the Lockstep API.  Because API Keys do not have an expiration date, they are well suited for unattended processes.  Each API Key is associated with a user, and may be revoked to prevent it from accessing the Lockstep API. When you create an API Key, make sure to save the value in a secure location.  Lockstep cannot retrieve an API Key once it is created.  For more information, see [API Keys](https://developer.lockstep.io/docs/api-keys).
+    #
+    # @param body [ApiKeyModel] Metadata about the API Key to create.
+    def create_api_key(body:)
+        path = "/api/v1/ApiKeys"
+        @lockstepsdk.request(:post, path, body, nil)
+    end
+
+    ##
+    # Queries API Keys for this user using the specified filtering, sorting, nested fetch, and pagination rules requested.  An API Key is an authentication token that you may use with the Lockstep API.  Because API Keys do not have an expiration date, they are well suited for unattended processes.  Each API Key is associated with a user, and may be revoked to prevent it from accessing the Lockstep API. When you create an API Key, make sure to save the value in a secure location.  Lockstep cannot retrieve an API Key once it is created.  For more information, see [API Keys](https://developer.lockstep.io/docs/api-keys).
+    #
+    # @param filter [string] The filter for this query. See [Searchlight Query Language](https://developer.lockstep.io/docs/querying-with-searchlight)
+    # @param include_param [string] To fetch additional data on this object, specify the list of elements to retrieve. No collections are currently available but may be offered in the future.
+    # @param order [string] The sort order for this query. See See [Searchlight Query Language](https://developer.lockstep.io/docs/querying-with-searchlight)
+    # @param page_size [int32] The page size for results (default 200). See [Searchlight Query Language](https://developer.lockstep.io/docs/querying-with-searchlight)
+    # @param page_number [int32] The page number for results (default 0). See [Searchlight Query Language](https://developer.lockstep.io/docs/querying-with-searchlight)
+    def query_api_keys(filter:, include_param:, order:, page_size:, page_number:)
+        path = "/api/v1/ApiKeys/query"
+        params = {:filter => filter, :include => include_param, :order => order, :pageSize => page_size, :pageNumber => page_number}
+        @lockstepsdk.request(:get, path, nil, params)
+    end
+end

data/lib/lockstep_sdk/clients/app_enrollments_client.rb

@@ -0,0 +1,121 @@
+#
+# Lockstep Software Development Kit for Ruby
+#
+# (c) 2021-2022 Lockstep, Inc.
+#
+# For the full copyright and license information, please view the LICENSE
+# file that was distributed with this source code.
+#
+# @author     Ted Spence <tspence@lockstep.io>
+# @author     Manish Narayan B S <manish.n@lockstep.io>
+# @author     Rishi Rajkumar Jawahar <rjawahar@lockstep.io>
+# @copyright  2021-2022 Lockstep, Inc.
+# @version    2022.4
+# @link       https://github.com/Lockstep-Network/lockstep-sdk-ruby
+#
+
+
+require 'awrence'
+
+class AppEnrollmentsClient
+
+    ##
+    # Initialize the AppEnrollmentsClient class with a lockstepsdk instance.
+    # @param lockstepsdk [LockstepApi] The Lockstep API client object for this connection
+    def initialize(lockstepsdk)
+        @lockstepsdk = lockstepsdk
+    end
+
+
+    ##
+    # Retrieves the App Enrollment with this identifier.
+    #
+    # An App Enrollment 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](https://developer.lockstep.io/docs/applications-and-enrollments) for more information.
+    #
+    # @param id [uuid] The unique ID number of the App Enrollment to retrieve
+    # @param include_param [string] To fetch additional data on this object, specify the list of elements to retrieve. Available collections: App, CustomFields, LastSync, LastSuccessfulSync
+    def retrieve_app_enrollment(id:, include_param:)
+        path = "/api/v1/AppEnrollments/#{id}"
+        params = {:include => include_param}
+        @lockstepsdk.request(:get, path, nil, params)
+    end
+
+    ##
+    # Updates an existing App Enrollment 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 App Enrollment 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](https://developer.lockstep.io/docs/applications-and-enrollments) for more information.
+    #
+    # @param id [uuid] The unique ID number of the App Enrollment to update
+    # @param body [object] A list of changes to apply to this App Enrollment
+    def update_app_enrollment(id:, body:)
+        path = "/api/v1/AppEnrollments/#{id}"
+        @lockstepsdk.request(:patch, path, body.to_camelback_keys.to_json, nil)
+    end
+
+    ##
+    # Deletes the App Enrollment referred to by this unique identifier. An App Enrollment 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](https://developer.lockstep.io/docs/applications-and-enrollments) for more information.
+    #
+    # @param id [uuid] The unique ID number of the App Enrollment to delete
+    # @param remove_enrollment_data [boolean] Option to remove all associated app enrollment data when deleting app enrollment (default false)
+    def delete_app_enrollment(id:, remove_enrollment_data:)
+        path = "/api/v1/AppEnrollments/#{id}"
+        params = {:removeEnrollmentData => remove_enrollment_data}
+        @lockstepsdk.request(:delete, path, nil, params)
+    end
+
+    ##
+    # Creates one or more App Enrollments within this account and returns the records as created.
+    #
+    # An App Enrollment 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](https://developer.lockstep.io/docs/applications-and-enrollments) for more information.
+    #
+    # @param body [AppEnrollmentModel] The App Enrollments to create
+    def create_app_enrollments(body:)
+        path = "/api/v1/AppEnrollments"
+        @lockstepsdk.request(:post, path, body, nil)
+    end
+
+    ##
+    # Queries App Enrollments for this account using the specified filtering, sorting, nested fetch, and pagination rules requested.
+    #
+    # More information on querying can be found on the [Searchlight Query Language](https://developer.lockstep.io/docs/querying-with-searchlight) page on the Lockstep Developer website.
+    #
+    # An App Enrollment 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](https://developer.lockstep.io/docs/applications-and-enrollments) for more information.
+    #
+    # @param filter [string] The filter for this query. See [Searchlight Query Language](https://developer.lockstep.io/docs/querying-with-searchlight)
+    # @param include_param [string] To fetch additional data on this object, specify the list of elements to retrieve. Available collections: App, CustomFields, LastSync, LastSuccessfulSync
+    # @param order [string] The sort order for this query. See See [Searchlight Query Language](https://developer.lockstep.io/docs/querying-with-searchlight)
+    # @param page_size [int32] The page size for results (default 200). See [Searchlight Query Language](https://developer.lockstep.io/docs/querying-with-searchlight)
+    # @param page_number [int32] The page number for results (default 0). See [Searchlight Query Language](https://developer.lockstep.io/docs/querying-with-searchlight)
+    def query_app_enrollments(filter:, include_param:, order:, page_size:, page_number:)
+        path = "/api/v1/AppEnrollments/query"
+        params = {:filter => filter, :include => include_param, :order => order, :pageSize => page_size, :pageNumber => page_number}
+        @lockstepsdk.request(:get, path, nil, params)
+    end
+
+    ##
+    # Queries custom fields settings for app enrollment within 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](https://developer.lockstep.io/docs/querying-with-searchlight) page on the Lockstep Developer website.
+    #
+    # An App Enrollment 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](https://developer.lockstep.io/docs/applications-and-enrollments) for more information.
+    #
+    # @param id [uuid] The unique ID number of the App Enrollment for which we retrieve custom fields
+    def query_enrollment_fields(id:)
+        path = "/api/v1/AppEnrollments/settings/#{id}"
+        @lockstepsdk.request(:get, path, nil, nil)
+    end
+end

data/lib/lockstep_sdk/clients/applications_client.rb

@@ -0,0 +1,100 @@
+#
+# Lockstep Software Development Kit for Ruby
+#
+# (c) 2021-2022 Lockstep, Inc.
+#
+# For the full copyright and license information, please view the LICENSE
+# file that was distributed with this source code.
+#
+# @author     Ted Spence <tspence@lockstep.io>
+# @author     Manish Narayan B S <manish.n@lockstep.io>
+# @author     Rishi Rajkumar Jawahar <rjawahar@lockstep.io>
+# @copyright  2021-2022 Lockstep, Inc.
+# @version    2022.4
+# @link       https://github.com/Lockstep-Network/lockstep-sdk-ruby
+#
+
+
+require 'awrence'
+
+class ApplicationsClient
+
+    ##
+    # Initialize the ApplicationsClient class with a lockstepsdk instance.
+    # @param lockstepsdk [LockstepApi] The Lockstep API client object for this connection
+    def initialize(lockstepsdk)
+        @lockstepsdk = lockstepsdk
+    end
+
+
+    ##
+    # 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](https://developer.lockstep.io/docs/applications-and-enrollments) for more information.
+    #
+    # @param id [uuid] The unique ID number of the Application to retrieve
+    # @param include_param [string] To fetch additional data on this object, specify the list of elements to retrieve. Available collections: Notes, Attachments, CustomFields
+    def retrieve_application(id:, include_param:)
+        path = "/api/v1/Applications/#{id}"
+        params = {:include => include_param}
+        @lockstepsdk.request(:get, path, nil, params)
+    end
+
+    ##
+    # 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](https://developer.lockstep.io/docs/applications-and-enrollments) for more information.
+    #
+    # @param id [uuid] The unique ID number of the Application to update
+    # @param body [object] A list of changes to apply to this Application
+    def update_application(id:, body:)
+        path = "/api/v1/Applications/#{id}"
+        @lockstepsdk.request(:patch, path, body.to_camelback_keys.to_json, nil)
+    end
+
+    ##
+    # 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](https://developer.lockstep.io/docs/applications-and-enrollments) for more information.
+    #
+    # @param id [uuid] The unique ID number of the Application to delete
+    def delete_application(id:)
+        path = "/api/v1/Applications/#{id}"
+        @lockstepsdk.request(:delete, path, nil, nil)
+    end
+
+    ##
+    # 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](https://developer.lockstep.io/docs/applications-and-enrollments) for more information.
+    #
+    # @param body [ApplicationModel] The Applications to create
+    def create_applications(body:)
+        path = "/api/v1/Applications"
+        @lockstepsdk.request(:post, path, body, nil)
+    end
+
+    ##
+    # 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](https://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](https://developer.lockstep.io/docs/applications-and-enrollments) for more information.
+    #
+    # @param filter [string] The filter for this query. See [Searchlight Query Language](https://developer.lockstep.io/docs/querying-with-searchlight)
+    # @param include_param [string] To fetch additional data on this object, specify the list of elements to retrieve. Available collections: Notes, Attachments, CustomFields
+    # @param order [string] The sort order for this query. See See [Searchlight Query Language](https://developer.lockstep.io/docs/querying-with-searchlight)
+    # @param page_size [int32] The page size for results (default 200). See [Searchlight Query Language](https://developer.lockstep.io/docs/querying-with-searchlight)
+    # @param page_number [int32] The page number for results (default 0). See [Searchlight Query Language](https://developer.lockstep.io/docs/querying-with-searchlight)
+    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}
+        @lockstepsdk.request(:get, path, nil, params)
+    end
+end

data/lib/lockstep_sdk/clients/attachments_client.rb

@@ -0,0 +1,121 @@
+#
+# Lockstep Software Development Kit for Ruby
+#
+# (c) 2021-2022 Lockstep, Inc.
+#
+# For the full copyright and license information, please view the LICENSE
+# file that was distributed with this source code.
+#
+# @author     Ted Spence <tspence@lockstep.io>
+# @author     Manish Narayan B S <manish.n@lockstep.io>
+# @author     Rishi Rajkumar Jawahar <rjawahar@lockstep.io>
+# @copyright  2021-2022 Lockstep, Inc.
+# @version    2022.4
+# @link       https://github.com/Lockstep-Network/lockstep-sdk-ruby
+#
+
+
+require 'awrence'
+
+class AttachmentsClient
+
+    ##
+    # Initialize the AttachmentsClient class with a lockstepsdk instance.
+    # @param lockstepsdk [LockstepApi] The Lockstep API client object for this connection
+    def initialize(lockstepsdk)
+        @lockstepsdk = lockstepsdk
+    end
+
+
+    ##
+    # Retrieves the Attachment with the provided Attachment identifier.
+    #
+    # An Attachment is a file that can be attached to various account attributes within Lockstep. Attachments can be used for invoices, bills, or any other external files that you wish to track and have access to. Attachments represents an Attachment and a number of different metadata attributes related to the creation, storage, and ownership of the Attachment.
+    #
+    # See [Extensibility](https://developer.lockstep.io/docs/extensibility) for more information.
+    #
+    # @param id [uuid] The unique ID number of the Attachment to retrieve
+    # @param include_param [string] To fetch additional data on this object, specify the list of elements to retrieve. No collections are currently available for querying but may be available in the future.
+    def retrieve_attachment(id:, include_param:)
+        path = "/api/v1/Attachments/#{id}"
+        params = {:include => include_param}
+        @lockstepsdk.request(:get, path, nil, params)
+    end
+
+    ##
+    # Updates an existing Attachment 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.  If you do not provide the name of a field, that field will remain unchanged.  This allows you to ensure that you are only updating the specific fields desired.
+    #
+    # An Attachment is a file that can be attached to various account attributes within Lockstep. Attachments can be used for invoices, bills, or any other external files that you wish to track and have access to. Attachments represents an Attachment and a number of different metadata attributes related to the creation, storage, and ownership of the Attachment.
+    #
+    # See [Extensibility](https://developer.lockstep.io/docs/extensibility) for more information.
+    #
+    # @param id [uuid] The unique Lockstep Platform ID number of the attachment to update
+    # @param body [object] A list of changes to apply to this Attachment
+    def update_attachment(id:, body:)
+        path = "/api/v1/Attachments/#{id}"
+        @lockstepsdk.request(:patch, path, body.to_camelback_keys.to_json, nil)
+    end
+
+    ##
+    # Flag this attachment as archived, which can distinguish between attachments currently active and attachments not intended for active use.  This is similar to deletion but preserves information about the record's existence.
+    #
+    # An Attachment is a file that can be attached to various account attributes within Lockstep. Attachments can be used for invoices, bills, or any other external files that you wish to track and have access to. Attachments represents an Attachment and a number of different metadata attributes related to the creation, storage, and ownership of the Attachment.
+    #
+    # See [Extensibility](https://developer.lockstep.io/docs/extensibility) for more information.
+    #
+    # @param id [uuid] The unique ID number of the Attachment to be archived
+    def archive_attachment(id:)
+        path = "/api/v1/Attachments/#{id}"
+        @lockstepsdk.request(:delete, path, nil, nil)
+    end
+
+    ##
+    # Returns a URI for the Attachment file to be downloaded, based on the ID provided.
+    #
+    # An Attachment is a file that can be attached to various account attributes within Lockstep. Attachments can be used for invoices, bills, or any other external files that you wish to track and have access to. Attachments represents an Attachment and a number of different metadata attributes related to the creation, storage, and ownership of the Attachment.
+    #
+    # See [Extensibility](https://developer.lockstep.io/docs/extensibility) for more information.
+    #
+    # @param id [uuid] The unique ID number of the Attachment whose URI will be returned
+    def download_attachment(id:)
+        path = "/api/v1/Attachments/#{id}/download"
+        @lockstepsdk.request(:get, path, nil, nil)
+    end
+
+    ##
+    # Uploads and creates one or more Attachments from the provided arguments.
+    #
+    # An Attachment is a file that can be attached to various account attributes within Lockstep. Attachments can be used for invoices, bills, or any other external files that you wish to track and have access to. Attachments represents an Attachment and a number of different metadata attributes related to the creation, storage, and ownership of the Attachment.
+    #
+    # See [Extensibility](https://developer.lockstep.io/docs/extensibility) for more information.
+    #
+    # @param table_name [string] The name of the type of object to which this Attachment will be linked
+    # @param object_id [uuid] The unique ID of the object to which this Attachment will be linked
+    def upload_attachment(table_name:, object_id:)
+        path = "/api/v1/Attachments"
+        params = {:tableName => table_name, :objectId => object_id}
+        @lockstepsdk.request(:post, path, nil, params)
+    end
+
+    ##
+    # Queries Attachments for this account using the specified filtering, sorting, nested fetch, and pagination rules requested.
+    #
+    # More information on querying can be found on the [Searchlight Query Language](https://developer.lockstep.io/docs/querying-with-searchlight) page on the Lockstep Developer website.
+    #
+    # An Attachment is a file that can be attached to various account attributes within Lockstep. Attachments can be used for invoices, bills, or any other external files that you wish to track and have access to. Attachments represents an Attachment and a number of different metadata attributes related to the creation, storage, and ownership of the Attachment.
+    #
+    # See [Extensibility](https://developer.lockstep.io/docs/extensibility) for more information.
+    #
+    # @param filter [string] The filter to use to select from the list of available Attachments, in the [Searchlight query syntax](https://github.com/tspence/csharp-searchlight).
+    # @param include_param [string] To fetch additional data on this object, specify the list of elements to retrieve. No collections are currently available for querying but may be available in the future.
+    # @param order [string] The sort order for the results, in the [Searchlight order syntax](https://github.com/tspence/csharp-searchlight).
+    # @param page_size [int32] The page size for results (default 200, maximum of 10,000)
+    # @param page_number [int32] The page number for results (default 0)
+    def query_attachments(filter:, include_param:, order:, page_size:, page_number:)
+        path = "/api/v1/Attachments/query"
+        params = {:filter => filter, :include => include_param, :order => order, :pageSize => page_size, :pageNumber => page_number}
+        @lockstepsdk.request(:get, path, nil, params)
+    end
+end

data/lib/lockstep_sdk/clients/code_definitions_client.rb

@@ -0,0 +1,60 @@
+#
+# Lockstep Software Development Kit for Ruby
+#
+# (c) 2021-2022 Lockstep, Inc.
+#
+# For the full copyright and license information, please view the LICENSE
+# file that was distributed with this source code.
+#
+# @author     Ted Spence <tspence@lockstep.io>
+# @author     Manish Narayan B S <manish.n@lockstep.io>
+# @author     Rishi Rajkumar Jawahar <rjawahar@lockstep.io>
+# @copyright  2021-2022 Lockstep, Inc.
+# @version    2022.4
+# @link       https://github.com/Lockstep-Network/lockstep-sdk-ruby
+#
+
+
+require 'awrence'
+
+class CodeDefinitionsClient
+
+    ##
+    # Initialize the CodeDefinitionsClient class with a lockstepsdk instance.
+    # @param lockstepsdk [LockstepApi] The Lockstep API client object for this connection
+    def initialize(lockstepsdk)
+        @lockstepsdk = lockstepsdk
+    end
+
+
+    ##
+    # Retrieves the CodeDefinition specified by this unique identifier, optionally including nested data sets.
+    #
+    # A CodeDefinition contains information around system code values and their definitions.
+    #
+    # @param id [uuid] The unique Lockstep Platform ID number of this CodeDefinition
+    # @param include_param [string] To fetch additional data on this object, specify the list of elements to retrieve. No collections are currently available but may be offered in the future
+    def retrieve_codedefinition(id:, include_param:)
+        path = "/api/v1/CodeDefinitions/#{id}"
+        params = {:include => include_param}
+        @lockstepsdk.request(:get, path, nil, params)
+    end
+
+    ##
+    # Queries CodeDefinitions for this account using the specified filtering, sorting, nested fetch, and pagination rules requested.
+    #
+    # More information on querying can be found on the [Searchlight Query Language](https://developer.lockstep.io/docs/querying-with-searchlight) page on the Lockstep Developer website.
+    #
+    # A CodeDefinition contains information around system code values and their definitions.
+    #
+    # @param filter [string] The filter for this query. See [Searchlight Query Language](https://developer.lockstep.io/docs/querying-with-searchlight)
+    # @param include_param [string] To fetch additional data on this object, specify the list of elements to retrieve. No collections are currently available but may be offered in the future
+    # @param order [string] The sort order for this query. See See [Searchlight Query Language](https://developer.lockstep.io/docs/querying-with-searchlight)
+    # @param page_size [int32] The page size for results (default 200). See [Searchlight Query Language](https://developer.lockstep.io/docs/querying-with-searchlight)
+    # @param page_number [int32] The page number for results (default 0). See [Searchlight Query Language](https://developer.lockstep.io/docs/querying-with-searchlight)
+    def query_codedefinitions(filter:, include_param:, order:, page_size:, page_number:)
+        path = "/api/v1/CodeDefinitions/query"
+        params = {:filter => filter, :include => include_param, :order => order, :pageSize => page_size, :pageNumber => page_number}
+        @lockstepsdk.request(:get, path, nil, params)
+    end
+end