lockstep_sdk 2022.13.29.0 → 2022.14.30.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 4bc0a65679a4df117c520820d1c94e5db5995b9dca57cc833e66d5e89903d87b
-  data.tar.gz: 182dd8d32fb0cf77b9bcb080bc2a66a0aace3bfb2685c9f33cd72005e341d495
+  metadata.gz: ddabc9b518b210ddca37c92a960c90ca21a66089d16b914fc350bef2bdf212af
+  data.tar.gz: 9e3749fee84c3601176781e6b27ee9d40baf5a29cfd4f4ca61ad3b6b25d8b6c1
 SHA512:
-  metadata.gz: 7f4e2f25b8e60dfecaa2fa0d6e481c382e6c6ecb7e3d3606b0d45ae2fbe06512e1b8107b0efe77db92f8a6bed0cffeb47cbd9280a46afdffcffc7416eb73c3f0
-  data.tar.gz: 6e73e85365d843e4b6222101d768d273635371b131485d53315d769a24b171acb4cf3028e1617d457deaa35841f7d57b4b7b3932b2bebd5db8933b1f0e2aa8c5
+  metadata.gz: 37d4b9c701f44f46d1a753726b3a346f5c4585b1ab5778f1738eca741102e1cae5e7f56dbf47a020949ce110118a726ebeca0d7829ec434cdd097707d9ee2cc5
+  data.tar.gz: 49d36d2a323d269ce421335f788cf5fb84af268102e4dc36244ddadb60b8fbeefbe78ce1b4656e4a5d4d1e35b45cdec839569b0844de781cda829a4efcb42b6c

data/lib/LockstepSdk/lockstep_api.rb

@@ -0,0 +1,287 @@
+#
+# Lockstep Platform SDK 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     Lockstep Network <support@lockstep.io>
+#             Manish Narayan B S <manish.n@lockstep.io>, Rishi Rajkumar Jawahar <rjawahar@lockstep.io>
+# @copyright  2021-2022 Lockstep, Inc.
+# @version    2022.14.30
+# @link       https://github.com/Lockstep-Network/lockstep-sdk-ruby
+#
+
+require 'net/http'
+require 'openssl'
+require 'uri'
+require 'socket'
+
+project_root = File.dirname(File.absolute_path(__FILE__))
+Dir.glob(project_root + '/clients/*') {|file| require file}
+
+module LockstepSdk
+    class LockstepApi
+    
+        ##
+        # @return [String] The version number of this API client
+        attr_accessor :version
+
+        ##
+        # @return [String] The name or URL of the environment
+        attr_accessor :env 
+
+        ##
+        # @return [ActivitiesClient] Client object for Activities endpoints
+        attr_accessor :activities
+
+        ##
+        # @return [ApiKeysClient] Client object for ApiKeys endpoints
+        attr_accessor :api_keys
+
+        ##
+        # @return [AppEnrollmentsClient] Client object for AppEnrollments endpoints
+        attr_accessor :app_enrollments
+
+        ##
+        # @return [ApplicationsClient] Client object for Applications endpoints
+        attr_accessor :applications
+
+        ##
+        # @return [AttachmentsClient] Client object for Attachments endpoints
+        attr_accessor :attachments
+
+        ##
+        # @return [CodeDefinitionsClient] Client object for CodeDefinitions endpoints
+        attr_accessor :code_definitions
+
+        ##
+        # @return [CompaniesClient] Client object for Companies endpoints
+        attr_accessor :companies
+
+        ##
+        # @return [ContactsClient] Client object for Contacts endpoints
+        attr_accessor :contacts
+
+        ##
+        # @return [CreditMemoAppliedClient] Client object for CreditMemoApplied endpoints
+        attr_accessor :credit_memo_applied
+
+        ##
+        # @return [CurrenciesClient] Client object for Currencies endpoints
+        attr_accessor :currencies
+
+        ##
+        # @return [CustomFieldDefinitionsClient] Client object for CustomFieldDefinitions endpoints
+        attr_accessor :custom_field_definitions
+
+        ##
+        # @return [CustomFieldValuesClient] Client object for CustomFieldValues endpoints
+        attr_accessor :custom_field_values
+
+        ##
+        # @return [DefinitionsClient] Client object for Definitions endpoints
+        attr_accessor :definitions
+
+        ##
+        # @return [EmailsClient] Client object for Emails endpoints
+        attr_accessor :emails
+
+        ##
+        # @return [FinancialAccountClient] Client object for FinancialAccount endpoints
+        attr_accessor :financial_account
+
+        ##
+        # @return [FinancialAccountBalanceHistoryClient] Client object for FinancialAccountBalanceHistory endpoints
+        attr_accessor :financial_account_balance_history
+
+        ##
+        # @return [FinancialYearSettingsClient] Client object for FinancialYearSettings endpoints
+        attr_accessor :financial_year_settings
+
+        ##
+        # @return [InvoiceHistoryClient] Client object for InvoiceHistory endpoints
+        attr_accessor :invoice_history
+
+        ##
+        # @return [InvoicesClient] Client object for Invoices endpoints
+        attr_accessor :invoices
+
+        ##
+        # @return [LeadsClient] Client object for Leads endpoints
+        attr_accessor :leads
+
+        ##
+        # @return [NotesClient] Client object for Notes endpoints
+        attr_accessor :notes
+
+        ##
+        # @return [PaymentApplicationsClient] Client object for PaymentApplications endpoints
+        attr_accessor :payment_applications
+
+        ##
+        # @return [PaymentsClient] Client object for Payments endpoints
+        attr_accessor :payments
+
+        ##
+        # @return [ProvisioningClient] Client object for Provisioning endpoints
+        attr_accessor :provisioning
+
+        ##
+        # @return [ReportsClient] Client object for Reports endpoints
+        attr_accessor :reports
+
+        ##
+        # @return [StatusClient] Client object for Status endpoints
+        attr_accessor :status
+
+        ##
+        # @return [SyncClient] Client object for Sync endpoints
+        attr_accessor :sync
+
+        ##
+        # @return [UserAccountsClient] Client object for UserAccounts endpoints
+        attr_accessor :user_accounts
+
+        ##
+        # @return [UserRolesClient] Client object for UserRoles endpoints
+        attr_accessor :user_roles
+
+        ##
+        # @return [WebhooksClient] Client object for Webhooks endpoints
+        attr_accessor :webhooks
+
+
+        ##
+        # Construct a new API client targeting the specified server.
+        #
+        # @param env [string] Either "sbx", "prd", or the URI of the server, ending in a slash (/)
+        def initialize(env)
+            @version = "2022.14.30.0"
+            @env = case env
+                when "sbx"
+                    "https://api.sbx.lockstep.io/"
+                when "prd"
+                    "https://api.lockstep.io/"
+                else
+                    env
+                end
+                
+            # Construct all the clients
+            @activities = ActivitiesClient.new(self)
+            @api_keys = ApiKeysClient.new(self)
+            @app_enrollments = AppEnrollmentsClient.new(self)
+            @applications = ApplicationsClient.new(self)
+            @attachments = AttachmentsClient.new(self)
+            @code_definitions = CodeDefinitionsClient.new(self)
+            @companies = CompaniesClient.new(self)
+            @contacts = ContactsClient.new(self)
+            @credit_memo_applied = CreditMemoAppliedClient.new(self)
+            @currencies = CurrenciesClient.new(self)
+            @custom_field_definitions = CustomFieldDefinitionsClient.new(self)
+            @custom_field_values = CustomFieldValuesClient.new(self)
+            @definitions = DefinitionsClient.new(self)
+            @emails = EmailsClient.new(self)
+            @financial_account = FinancialAccountClient.new(self)
+            @financial_account_balance_history = FinancialAccountBalanceHistoryClient.new(self)
+            @financial_year_settings = FinancialYearSettingsClient.new(self)
+            @invoice_history = InvoiceHistoryClient.new(self)
+            @invoices = InvoicesClient.new(self)
+            @leads = LeadsClient.new(self)
+            @notes = NotesClient.new(self)
+            @payment_applications = PaymentApplicationsClient.new(self)
+            @payments = PaymentsClient.new(self)
+            @provisioning = ProvisioningClient.new(self)
+            @reports = ReportsClient.new(self)
+            @status = StatusClient.new(self)
+            @sync = SyncClient.new(self)
+            @user_accounts = UserAccountsClient.new(self)
+            @user_roles = UserRolesClient.new(self)
+            @webhooks = WebhooksClient.new(self)
+        end
+
+        ##
+        # Configure this API client to use API key authentication
+        #
+        # Authentication is either via [Lockstep Platform API key](https://developer.lockstep.io/docs/api-keys) or [JWT Bearer Token](https://developer.lockstep.io/docs/jwt-bearer-tokens)
+        #
+        # @param api_key [string] The API Key to use for authentication
+        def with_api_key(api_key)
+            @bearer_token = nil
+            @api_key = api_key
+        end
+
+        ##
+        # Configure this API client to use JWT Bearer Token authentication
+        #
+        # Authentication is either via [Lockstep Platform API key](https://developer.lockstep.io/docs/api-keys) or [JWT Bearer Token](https://developer.lockstep.io/docs/jwt-bearer-tokens)
+        #
+        # @param bearer_token [string] The Bearer Token to use for authentication
+        def with_bearer_token(bearer_token)
+            @api_key = nil
+            @bearer_token = bearer_token
+        end
+
+        ##
+        # Configure this API to use an application name
+        #
+        # @param app_name [string] The name of the application
+        def with_app_name(app_name)
+            @app_name = app_name
+        end
+
+        ##
+        # Send a request to the API and return the results
+        #
+        # Sends a request to the 
+        def request(method, path, body, params)
+        
+            url = URI(@env + path)
+            if !params.nil?  
+                url.query = URI.encode_www_form(params)
+            end
+            
+            http = Net::HTTP.new(url.host, url.port)
+            http.use_ssl = true
+            
+            request = case method
+                when :get
+                    Net::HTTP::Get.new(url)
+                when :post
+                    Net::HTTP::Post.new(url)
+                when :patch
+                    Net::HTTP::Patch.new(url)
+                when :put
+                    Net::HTTP::Put.new(url)
+                when :delete
+                    Net::HTTP::Delete.new(url)
+                end
+                
+            # Set headers and body for request
+            request["Accept"] = 'application/json'
+            request["Content-Type"] = 'application/*+json'
+            request["SdkType"] = 'Ruby'
+            request["SdkVersion"] = '2022.14.30.0'
+            request["MachineName"] = Socket.gethostname
+            request.body = body
+
+            # If there is an application name
+            if @app_name != nil
+                request["ApplicationName"] = @app_name
+            end
+
+            # Which authentication are we using?
+            if @api_key != nil 
+              request["Api-Key"] = @api_key
+            end
+            if @bearer_token != nil 
+              request["Authorization"] = 'Bearer ' + @bearer_token
+            end
+            
+            # Send the request
+            response = http.request(request)
+            response.read_body
+        end
+    end   
+end  

data/lib/lockstep_sdk/clients/activities_client.rb

@@ -1,14 +1,12 @@
 #
-# Lockstep Software Development Kit for Ruby
+# Lockstep Platform SDK 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>
+# @author     Lockstep Network <support@lockstep.io>
 # @copyright  2021-2022 Lockstep, Inc.
 # @link       https://github.com/Lockstep-Network/lockstep-sdk-ruby
 #
@@ -19,10 +17,10 @@ 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
+    # Initialize the ActivitiesClient class with an API client instance.
+    # @param connection [LockstepApi] The API client object for this connection
+    def initialize(connection)
+        @connection = connection
     end
 
 
@@ -36,7 +34,7 @@ class ActivitiesClient
     def retrieve_activity(id:, include_param:)
         path = "/api/v1/Activities/#{id}"
         params = {:include => include_param}
-        @lockstepsdk.request(:get, path, nil, params)
+        @connection.request(:get, path, nil, params)
     end
 
     ##
@@ -50,7 +48,7 @@ class ActivitiesClient
     # @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)
+        @connection.request(:patch, path, body.to_camelback_keys.to_json, nil)
     end
 
     ##
@@ -61,7 +59,7 @@ class ActivitiesClient
     # @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)
+        @connection.request(:delete, path, nil, nil)
     end
 
     ##
@@ -72,7 +70,7 @@ class ActivitiesClient
     # @param body [ActivityModel] The Activities to create
     def create_activities(body:)
         path = "/api/v1/Activities"
-        @lockstepsdk.request(:post, path, body, nil)
+        @connection.request(:post, path, body, nil)
     end
 
     ##
@@ -90,7 +88,7 @@ class ActivitiesClient
     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)
+        @connection.request(:get, path, nil, params)
     end
 
     ##
@@ -101,7 +99,7 @@ class ActivitiesClient
     # @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)
+        @connection.request(:get, path, nil, nil)
     end
 
     ##
@@ -113,6 +111,6 @@ class ActivitiesClient
     # @param user_id [uuid] 
     def forward_activity(activity_id:, user_id:)
         path = "/api/v1/Activities/#{activityId}/forward/#{userId}"
-        @lockstepsdk.request(:post, path, nil, nil)
+        @connection.request(:post, path, nil, nil)
     end
 end

data/lib/lockstep_sdk/clients/api_keys_client.rb

@@ -1,14 +1,12 @@
 #
-# Lockstep Software Development Kit for Ruby
+# Lockstep Platform SDK 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>
+# @author     Lockstep Network <support@lockstep.io>
 # @copyright  2021-2022 Lockstep, Inc.
 # @link       https://github.com/Lockstep-Network/lockstep-sdk-ruby
 #
@@ -19,10 +17,10 @@ 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
+    # Initialize the ApiKeysClient class with an API client instance.
+    # @param connection [LockstepApi] The API client object for this connection
+    def initialize(connection)
+        @connection = connection
     end
 
 
@@ -38,7 +36,7 @@ class ApiKeysClient
     def retrieve_api_key(id:, include_param:)
         path = "/api/v1/ApiKeys/#{id}"
         params = {:include => include_param}
-        @lockstepsdk.request(:get, path, nil, params)
+        @connection.request(:get, path, nil, params)
     end
 
     ##
@@ -53,7 +51,7 @@ class ApiKeysClient
     # @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)
+        @connection.request(:delete, path, nil, nil)
     end
 
     ##
@@ -66,7 +64,7 @@ class ApiKeysClient
     # @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)
+        @connection.request(:post, path, body, nil)
     end
 
     ##
@@ -84,6 +82,6 @@ class ApiKeysClient
     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)
+        @connection.request(:get, path, nil, params)
     end
 end

data/lib/lockstep_sdk/clients/app_enrollments_client.rb

@@ -1,14 +1,12 @@
 #
-# Lockstep Software Development Kit for Ruby
+# Lockstep Platform SDK 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>
+# @author     Lockstep Network <support@lockstep.io>
 # @copyright  2021-2022 Lockstep, Inc.
 # @link       https://github.com/Lockstep-Network/lockstep-sdk-ruby
 #
@@ -19,10 +17,10 @@ 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
+    # Initialize the AppEnrollmentsClient class with an API client instance.
+    # @param connection [LockstepApi] The API client object for this connection
+    def initialize(connection)
+        @connection = connection
     end
 
 
@@ -38,7 +36,7 @@ class AppEnrollmentsClient
     def retrieve_app_enrollment(id:, include_param:)
         path = "/api/v1/AppEnrollments/#{id}"
         params = {:include => include_param}
-        @lockstepsdk.request(:get, path, nil, params)
+        @connection.request(:get, path, nil, params)
     end
 
     ##
@@ -54,7 +52,7 @@ class AppEnrollmentsClient
     # @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)
+        @connection.request(:patch, path, body.to_camelback_keys.to_json, nil)
     end
 
     ##
@@ -67,7 +65,7 @@ class AppEnrollmentsClient
     def delete_app_enrollment(id:, remove_enrollment_data:)
         path = "/api/v1/AppEnrollments/#{id}"
         params = {:removeEnrollmentData => remove_enrollment_data}
-        @lockstepsdk.request(:delete, path, nil, params)
+        @connection.request(:delete, path, nil, params)
     end
 
     ##
@@ -80,7 +78,7 @@ class AppEnrollmentsClient
     # @param body [AppEnrollmentModel] The App Enrollments to create
     def create_app_enrollments(body:)
         path = "/api/v1/AppEnrollments"
-        @lockstepsdk.request(:post, path, body, nil)
+        @connection.request(:post, path, body, nil)
     end
 
     ##
@@ -100,7 +98,7 @@ class AppEnrollmentsClient
     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)
+        @connection.request(:get, path, nil, params)
     end
 
     ##
@@ -115,6 +113,6 @@ class AppEnrollmentsClient
     # @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)
+        @connection.request(:get, path, nil, nil)
     end
 end

data/lib/lockstep_sdk/clients/applications_client.rb

@@ -1,14 +1,12 @@
 #
-# Lockstep Software Development Kit for Ruby
+# Lockstep Platform SDK 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>
+# @author     Lockstep Network <support@lockstep.io>
 # @copyright  2021-2022 Lockstep, Inc.
 # @link       https://github.com/Lockstep-Network/lockstep-sdk-ruby
 #
@@ -19,10 +17,10 @@ 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
+    # Initialize the ApplicationsClient class with an API client instance.
+    # @param connection [LockstepApi] The API client object for this connection
+    def initialize(connection)
+        @connection = connection
     end
 
 
@@ -38,7 +36,7 @@ class ApplicationsClient
     def retrieve_application(id:, include_param:)
         path = "/api/v1/Applications/#{id}"
         params = {:include => include_param}
-        @lockstepsdk.request(:get, path, nil, params)
+        @connection.request(:get, path, nil, params)
     end
 
     ##
@@ -54,7 +52,7 @@ class ApplicationsClient
     # @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)
+        @connection.request(:patch, path, body.to_camelback_keys.to_json, nil)
     end
 
     ##
@@ -67,7 +65,7 @@ class ApplicationsClient
     # @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)
+        @connection.request(:delete, path, nil, nil)
     end
 
     ##
@@ -80,7 +78,7 @@ class ApplicationsClient
     # @param body [ApplicationModel] The Applications to create
     def create_applications(body:)
         path = "/api/v1/Applications"
-        @lockstepsdk.request(:post, path, body, nil)
+        @connection.request(:post, path, body, nil)
     end
 
     ##
@@ -100,6 +98,6 @@ class ApplicationsClient
     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)
+        @connection.request(:get, path, nil, params)
     end
 end