lockstep_sdk 2022.4.32.0

data/lib/lockstep_sdk/models/provisioning_response_model.rb

@@ -0,0 +1,86 @@
+#
+# 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 'json'
+
+module LockstepSdk
+
+    ##
+    # Represents the response to either a successful or failed account provisioning
+    class ProvisioningResponseModel
+
+        ##
+        # Initialize the ProvisioningResponseModel using the provided prototype
+        def initialize(params = {})
+            @user_name = params.dig(:user_name)
+            @account_name = params.dig(:account_name)
+            @user_id = params.dig(:user_id)
+            @group_key = params.dig(:group_key)
+            @app_enrollment_id = params.dig(:app_enrollment_id)
+            @sync_request_id = params.dig(:sync_request_id)
+            @error_message = params.dig(:error_message)
+        end
+
+        ##
+        # @return [String] If provisioning is successful, contains the username of the created user.
+        attr_accessor :user_name
+
+        ##
+        # @return [String] If provisioning is successful, contains subscription account name of created user.
+        attr_accessor :account_name
+
+        ##
+        # @return [Uuid] If provisioning is successful, contains the unique identifier of the created user.
+        attr_accessor :user_id
+
+        ##
+        # @return [Uuid] If provisioning is successful, contains the group key of the created user.
+        attr_accessor :group_key
+
+        ##
+        # @return [Uuid] If provisioning is successful, contains the app enrollment id of the created app enrollment.
+        attr_accessor :app_enrollment_id
+
+        ##
+        # @return [Uuid] if provisioning is successful, contains the sync request id of the sync that was started for the app enrollment.
+        attr_accessor :sync_request_id
+
+        ##
+        # @return [String] The error message(s).
+        attr_accessor :error_message
+
+        ##
+        # @return [object] This object as a JSON key-value structure
+        def as_json(options={})
+            {
+                'userName' => @user_name,
+                'accountName' => @account_name,
+                'userId' => @user_id,
+                'groupKey' => @group_key,
+                'appEnrollmentId' => @app_enrollment_id,
+                'syncRequestId' => @sync_request_id,
+                'errorMessage' => @error_message,
+            }
+        end
+
+        ##
+        # @return [String] This object converted to a JSON string
+        def to_json(*options)
+            "[#{as_json(*options).to_json(*options)}]"
+        end
+    end
+end

data/lib/lockstep_sdk/models/risk_rate_model.rb

@@ -0,0 +1,98 @@
+#
+# 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 'json'
+
+module LockstepSdk
+
+    ##
+    # Represents a risk rate calculation for a single month
+    class RiskRateModel
+
+        ##
+        # Initialize the RiskRateModel using the provided prototype
+        def initialize(params = {})
+            @group_key = params.dig(:group_key)
+            @report_period = params.dig(:report_period)
+            @invoice_month_name = params.dig(:invoice_month_name)
+            @total_invoice_count = params.dig(:total_invoice_count)
+            @total_invoice_amount = params.dig(:total_invoice_amount)
+            @at_risk_count = params.dig(:at_risk_count)
+            @at_risk_amount = params.dig(:at_risk_amount)
+            @at_risk_count_percentage = params.dig(:at_risk_count_percentage)
+            @at_risk_percentage = params.dig(:at_risk_percentage)
+        end
+
+        ##
+        # @return [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](https://developer.lockstep.io/docs/accounts-and-groupkeys).
+        attr_accessor :group_key
+
+        ##
+        # @return [Date-time] The month the risk rate was calculated for
+        attr_accessor :report_period
+
+        ##
+        # @return [String] The string name of the month the risk rate was calculated for
+        attr_accessor :invoice_month_name
+
+        ##
+        # @return [Int32] The count of all invoices in the calculation month
+        attr_accessor :total_invoice_count
+
+        ##
+        # @return [Double] The sum of the total amount for invoices in the calculation month
+        attr_accessor :total_invoice_amount
+
+        ##
+        # @return [Int32] The count of open invoices over 90 days from the calculation month
+        attr_accessor :at_risk_count
+
+        ##
+        # @return [Double] The sum of the outstanding balance of open invoices over 90 days from the calculation month
+        attr_accessor :at_risk_amount
+
+        ##
+        # @return [Double] The percentage of all open invoices for the calculation month that are over 90 days based on count
+        attr_accessor :at_risk_count_percentage
+
+        ##
+        # @return [Double] The percentage of all open invoices for the calculation month that are over 90 days based on outstanding balance
+        attr_accessor :at_risk_percentage
+
+        ##
+        # @return [object] This object as a JSON key-value structure
+        def as_json(options={})
+            {
+                'groupKey' => @group_key,
+                'reportPeriod' => @report_period,
+                'invoiceMonthName' => @invoice_month_name,
+                'totalInvoiceCount' => @total_invoice_count,
+                'totalInvoiceAmount' => @total_invoice_amount,
+                'atRiskCount' => @at_risk_count,
+                'atRiskAmount' => @at_risk_amount,
+                'atRiskCountPercentage' => @at_risk_count_percentage,
+                'atRiskPercentage' => @at_risk_percentage,
+            }
+        end
+
+        ##
+        # @return [String] This object converted to a JSON string
+        def to_json(*options)
+            "[#{as_json(*options).to_json(*options)}]"
+        end
+    end
+end

data/lib/lockstep_sdk/models/state_model.rb

@@ -0,0 +1,62 @@
+#
+# 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 'json'
+
+module LockstepSdk
+
+    ##
+    # State model for ISO-3166-2
+    class StateModel
+
+        ##
+        # Initialize the StateModel using the provided prototype
+        def initialize(params = {})
+            @name = params.dig(:name)
+            @alpha2 = params.dig(:alpha2)
+            @aliases = params.dig(:aliases)
+        end
+
+        ##
+        # @return [String] Name of the state
+        attr_accessor :name
+
+        ##
+        # @return [String] 2 letter alphabetic code for the given state
+        attr_accessor :alpha2
+
+        ##
+        # @return [String] A different name for a state
+        attr_accessor :aliases
+
+        ##
+        # @return [object] This object as a JSON key-value structure
+        def as_json(options={})
+            {
+                'name' => @name,
+                'alpha2' => @alpha2,
+                'aliases' => @aliases,
+            }
+        end
+
+        ##
+        # @return [String] This object converted to a JSON string
+        def to_json(*options)
+            "[#{as_json(*options).to_json(*options)}]"
+        end
+    end
+end

data/lib/lockstep_sdk/models/status_model.rb

@@ -0,0 +1,128 @@
+#
+# 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 'json'
+
+module LockstepSdk
+
+    ##
+    # Represents the status of a user's credentials
+    class StatusModel
+
+        ##
+        # Initialize the StatusModel using the provided prototype
+        def initialize(params = {})
+            @user_name = params.dig(:user_name)
+            @account_name = params.dig(:account_name)
+            @account_company_id = params.dig(:account_company_id)
+            @user_id = params.dig(:user_id)
+            @group_key = params.dig(:group_key)
+            @logged_in = params.dig(:logged_in)
+            @error_message = params.dig(:error_message)
+            @roles = params.dig(:roles)
+            @last_logged_in = params.dig(:last_logged_in)
+            @api_key_id = params.dig(:api_key_id)
+            @user_status = params.dig(:user_status)
+            @environment = params.dig(:environment)
+            @version = params.dig(:version)
+            @dependencies = params.dig(:dependencies)
+        end
+
+        ##
+        # @return [String] If authentication is successful, contains the username of the logged-in user.
+        attr_accessor :user_name
+
+        ##
+        # @return [String] If authentication is successful, contains subscription account name of logged-in user.
+        attr_accessor :account_name
+
+        ##
+        # @return [Uuid] If authentication is successful, contains subscription account company id of logged-in user.
+        attr_accessor :account_company_id
+
+        ##
+        # @return [Uuid] If authentication is successful, contains the unique identifier of the logged-in user.
+        attr_accessor :user_id
+
+        ##
+        # @return [Uuid] If authentication is successful, contains the group key of the logged-in user.
+        attr_accessor :group_key
+
+        ##
+        # @return [Boolean] Returns true if authentication for this API was successful.
+        attr_accessor :logged_in
+
+        ##
+        # @return [String] The error message.
+        attr_accessor :error_message
+
+        ##
+        # @return [String] The set of roles for this user.
+        attr_accessor :roles
+
+        ##
+        # @return [Date-time] Date and time user has last logged into Azure B2C.
+        attr_accessor :last_logged_in
+
+        ##
+        # @return [Uuid] The id of the API key used to authenticate.
+        attr_accessor :api_key_id
+
+        ##
+        # @return [String] If authentication is successful, contains the user status of the logged-in user.
+        attr_accessor :user_status
+
+        ##
+        # @return [String] The environment currently being used
+        attr_accessor :environment
+
+        ##
+        # @return [String] The version currently being used
+        attr_accessor :version
+
+        ##
+        # @return [Object] Statuses for the dependencies of this api. OK if the dependency is working.
+        attr_accessor :dependencies
+
+        ##
+        # @return [object] This object as a JSON key-value structure
+        def as_json(options={})
+            {
+                'userName' => @user_name,
+                'accountName' => @account_name,
+                'accountCompanyId' => @account_company_id,
+                'userId' => @user_id,
+                'groupKey' => @group_key,
+                'loggedIn' => @logged_in,
+                'errorMessage' => @error_message,
+                'roles' => @roles,
+                'lastLoggedIn' => @last_logged_in,
+                'apiKeyId' => @api_key_id,
+                'userStatus' => @user_status,
+                'environment' => @environment,
+                'version' => @version,
+                'dependencies' => @dependencies,
+            }
+        end
+
+        ##
+        # @return [String] This object converted to a JSON string
+        def to_json(*options)
+            "[#{as_json(*options).to_json(*options)}]"
+        end
+    end
+end

data/lib/lockstep_sdk/models/sync_entity_result_model.rb

@@ -0,0 +1,74 @@
+#
+# 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 'json'
+
+module LockstepSdk
+
+    ##
+    # Contains information about a sync process for an entity.
+    class SyncEntityResultModel
+
+        ##
+        # Initialize the SyncEntityResultModel using the provided prototype
+        def initialize(params = {})
+            @insert_count = params.dig(:insert_count)
+            @update_count = params.dig(:update_count)
+            @skip_count = params.dig(:skip_count)
+            @error_count = params.dig(:error_count)
+            @errors = params.dig(:errors)
+        end
+
+        ##
+        # @return [Int32] The number of entities inserted
+        attr_accessor :insert_count
+
+        ##
+        # @return [Int32] The number of entities updated
+        attr_accessor :update_count
+
+        ##
+        # @return [Int32] The number of entities skipped
+        attr_accessor :skip_count
+
+        ##
+        # @return [Int32] The number of errors encountered during sync
+        attr_accessor :error_count
+
+        ##
+        # @return [Object] The errors encountered during sync keyed by ERP key
+        attr_accessor :errors
+
+        ##
+        # @return [object] This object as a JSON key-value structure
+        def as_json(options={})
+            {
+                'insertCount' => @insert_count,
+                'updateCount' => @update_count,
+                'skipCount' => @skip_count,
+                'errorCount' => @error_count,
+                'errors' => @errors,
+            }
+        end
+
+        ##
+        # @return [String] This object converted to a JSON string
+        def to_json(*options)
+            "[#{as_json(*options).to_json(*options)}]"
+        end
+    end
+end

data/lib/lockstep_sdk/models/sync_request_model.rb

@@ -0,0 +1,98 @@
+#
+# 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 'json'
+
+module LockstepSdk
+
+    ##
+    # Represents a user request to sync data
+    class SyncRequestModel
+
+        ##
+        # Initialize the SyncRequestModel using the provided prototype
+        def initialize(params = {})
+            @sync_request_id = params.dig(:sync_request_id)
+            @group_key = params.dig(:group_key)
+            @status_code = params.dig(:status_code)
+            @process_result_message = params.dig(:process_result_message)
+            @app_enrollment_id = params.dig(:app_enrollment_id)
+            @created = params.dig(:created)
+            @modified = params.dig(:modified)
+            @modified_user_id = params.dig(:modified_user_id)
+            @details = params.dig(:details)
+        end
+
+        ##
+        # @return [Uuid] The unique ID of this record, automatically assigned by Lockstep when this record is added to the Lockstep platform.
+        attr_accessor :sync_request_id
+
+        ##
+        # @return [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](https://developer.lockstep.io/docs/accounts-and-groupkeys).
+        attr_accessor :group_key
+
+        ##
+        # @return [String] Potential values = Cancelled, Ready, In Progress, Success, Failed
+        attr_accessor :status_code
+
+        ##
+        # @return [String] Message containing information about the sync request results
+        attr_accessor :process_result_message
+
+        ##
+        # @return [Uuid] App enrollment sync request is for
+        attr_accessor :app_enrollment_id
+
+        ##
+        # @return [Date-time] The date this sync request was created
+        attr_accessor :created
+
+        ##
+        # @return [Date-time] The date this sync request was last modified
+        attr_accessor :modified
+
+        ##
+        # @return [Uuid] The ID number of the user who most recently modified this sync request.
+        attr_accessor :modified_user_id
+
+        ##
+        # @return [Object] The detailed results from the sync. To retrieve this collection, set `includeDetails` to true in your GET requests.
+        attr_accessor :details
+
+        ##
+        # @return [object] This object as a JSON key-value structure
+        def as_json(options={})
+            {
+                'syncRequestId' => @sync_request_id,
+                'groupKey' => @group_key,
+                'statusCode' => @status_code,
+                'processResultMessage' => @process_result_message,
+                'appEnrollmentId' => @app_enrollment_id,
+                'created' => @created,
+                'modified' => @modified,
+                'modifiedUserId' => @modified_user_id,
+                'details' => @details,
+            }
+        end
+
+        ##
+        # @return [String] This object converted to a JSON string
+        def to_json(*options)
+            "[#{as_json(*options).to_json(*options)}]"
+        end
+    end
+end

data/lib/lockstep_sdk/models/sync_submit_model.rb

@@ -0,0 +1,50 @@
+#
+# 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 'json'
+
+module LockstepSdk
+
+    ##
+    # Model representing information for a sync request
+    class SyncSubmitModel
+
+        ##
+        # Initialize the SyncSubmitModel using the provided prototype
+        def initialize(params = {})
+            @app_enrollment_id = params.dig(:app_enrollment_id)
+        end
+
+        ##
+        # @return [Uuid] The identifier of the app enrollment
+        attr_accessor :app_enrollment_id
+
+        ##
+        # @return [object] This object as a JSON key-value structure
+        def as_json(options={})
+            {
+                'appEnrollmentId' => @app_enrollment_id,
+            }
+        end
+
+        ##
+        # @return [String] This object converted to a JSON string
+        def to_json(*options)
+            "[#{as_json(*options).to_json(*options)}]"
+        end
+    end
+end

data/lib/lockstep_sdk/models/transfer_owner_model.rb

@@ -0,0 +1,56 @@
+#
+# 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 'json'
+
+module LockstepSdk
+
+    ##
+    # Model from the transfer ownership process.
+    class TransferOwnerModel
+
+        ##
+        # Initialize the TransferOwnerModel using the provided prototype
+        def initialize(params = {})
+            @previous_owner = params.dig(:previous_owner)
+            @new_owner = params.dig(:new_owner)
+        end
+
+        ##
+        # @return [UserAccountModel] The previous owner of the account.
+        attr_accessor :previous_owner
+
+        ##
+        # @return [UserAccountModel] The new owner of the account.
+        attr_accessor :new_owner
+
+        ##
+        # @return [object] This object as a JSON key-value structure
+        def as_json(options={})
+            {
+                'previousOwner' => @previous_owner,
+                'newOwner' => @new_owner,
+            }
+        end
+
+        ##
+        # @return [String] This object converted to a JSON string
+        def to_json(*options)
+            "[#{as_json(*options).to_json(*options)}]"
+        end
+    end
+end