lockstep_sdk 2022.4.32.0

data/lib/lockstep_sdk/models/aging_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
+
+    ##
+    # Represents an aging record
+    class AgingModel
+
+        ##
+        # Initialize the AgingModel using the provided prototype
+        def initialize(params = {})
+            @bucket = params.dig(:bucket)
+            @currency_code = params.dig(:currency_code)
+            @outstanding_balance = params.dig(:outstanding_balance)
+        end
+
+        ##
+        # @return [Int32] Aging bucket of outstanding balance data (days past due date of invoice)
+        attr_accessor :bucket
+
+        ##
+        # @return [String] Currency code of aging bucket
+        attr_accessor :currency_code
+
+        ##
+        # @return [Double] Outstanding balance for the given aging bucket
+        attr_accessor :outstanding_balance
+
+        ##
+        # @return [object] This object as a JSON key-value structure
+        def as_json(options={})
+            {
+                'bucket' => @bucket,
+                'currencyCode' => @currency_code,
+                'outstandingBalance' => @outstanding_balance,
+            }
+        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/api_key_model.rb

@@ -0,0 +1,116 @@
+#
+# 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
+
+    ##
+    # 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).
+    class ApiKeyModel
+
+        ##
+        # Initialize the ApiKeyModel using the provided prototype
+        def initialize(params = {})
+            @api_key_id = params.dig(:api_key_id)
+            @group_key = params.dig(:group_key)
+            @name = params.dig(:name)
+            @environment = params.dig(:environment)
+            @api_key = params.dig(:api_key)
+            @key_prefix = params.dig(:key_prefix)
+            @created = params.dig(:created)
+            @created_user_id = params.dig(:created_user_id)
+            @revoked = params.dig(:revoked)
+            @revoked_user_id = params.dig(:revoked_user_id)
+            @expires = params.dig(:expires)
+        end
+
+        ##
+        # @return [Uuid] The unique identifier for the API key.
+        attr_accessor :api_key_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] The name of the API key.
+        attr_accessor :name
+
+        ##
+        # @return [String] For convenience, a call to createApiKey will contain the name of the environment for this API key, typically SBX or PRD. This can help you distinguish between keys created on the Sandbox environment from those created on Production.
+        attr_accessor :environment
+
+        ##
+        # @return [String] The API key to use for authentication. This will only be returned upon creation of the API key. All other times, this value will be `null`. For more information, see [API Keys](https://developer.lockstep.io/docs/api-keys).
+        attr_accessor :api_key
+
+        ##
+        # @return [String] The first 10 characters of the API key. This information can be used to ensure that you are looking at the correct API Key, but cannot be used for authentication.
+        attr_accessor :key_prefix
+
+        ##
+        # @return [Date-time] The date the API key was created.
+        attr_accessor :created
+
+        ##
+        # @return [Uuid] The user that created the API key.
+        attr_accessor :created_user_id
+
+        ##
+        # @return [Date-time] The date the API key was revoked.
+        attr_accessor :revoked
+
+        ##
+        # @return [Uuid] The user who revoked the API key.
+        attr_accessor :revoked_user_id
+
+        ##
+        # @return [Date-time] The UTC datetime when the API key expires.
+        attr_accessor :expires
+
+        ##
+        # @return [object] This object as a JSON key-value structure
+        def as_json(options={})
+            {
+                'apiKeyId' => @api_key_id,
+                'groupKey' => @group_key,
+                'name' => @name,
+                'environment' => @environment,
+                'apiKey' => @api_key,
+                'keyPrefix' => @key_prefix,
+                'created' => @created,
+                'createdUserId' => @created_user_id,
+                'revoked' => @revoked,
+                'revokedUserId' => @revoked_user_id,
+                'expires' => @expires,
+            }
+        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/app_enrollment_custom_field_model.rb

@@ -0,0 +1,110 @@
+#
+# 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
+
+    ##
+    # App enrollment and custom field merged into one
+    class AppEnrollmentCustomFieldModel
+
+        ##
+        # Initialize the AppEnrollmentCustomFieldModel using the provided prototype
+        def initialize(params = {})
+            @app_enrollment_id = params.dig(:app_enrollment_id)
+            @app_id = params.dig(:app_id)
+            @name = params.dig(:name)
+            @app_type = params.dig(:app_type)
+            @group_key = params.dig(:group_key)
+            @custom_field_definition_id = params.dig(:custom_field_definition_id)
+            @custom_field_label = params.dig(:custom_field_label)
+            @data_type = params.dig(:data_type)
+            @sort_order = params.dig(:sort_order)
+            @string_value = params.dig(:string_value)
+            @numeric_value = params.dig(:numeric_value)
+        end
+
+        ##
+        # @return [Uuid] Unique id for the app enrollment
+        attr_accessor :app_enrollment_id
+
+        ##
+        # @return [Uuid] Id of enrolled app
+        attr_accessor :app_id
+
+        ##
+        # @return [String] The name of the application
+        attr_accessor :name
+
+        ##
+        # @return [String] Tag for what type of app the application is
+        attr_accessor :app_type
+
+        ##
+        # @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 [Uuid] Unique Id for the custom field definition
+        attr_accessor :custom_field_definition_id
+
+        ##
+        # @return [String] Text to display in-application for custom field
+        attr_accessor :custom_field_label
+
+        ##
+        # @return [String] Data type of the custom field definition
+        attr_accessor :data_type
+
+        ##
+        # @return [Int32] Used for display logic when multiple app enrollment custom fields exist
+        attr_accessor :sort_order
+
+        ##
+        # @return [String] String of data for field
+        attr_accessor :string_value
+
+        ##
+        # @return [Double] Number data for field
+        attr_accessor :numeric_value
+
+        ##
+        # @return [object] This object as a JSON key-value structure
+        def as_json(options={})
+            {
+                'appEnrollmentId' => @app_enrollment_id,
+                'appId' => @app_id,
+                'name' => @name,
+                'appType' => @app_type,
+                'groupKey' => @group_key,
+                'customFieldDefinitionId' => @custom_field_definition_id,
+                'customFieldLabel' => @custom_field_label,
+                'dataType' => @data_type,
+                'sortOrder' => @sort_order,
+                'stringValue' => @string_value,
+                'numericValue' => @numeric_value,
+            }
+        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/app_enrollment_model.rb

@@ -0,0 +1,151 @@
+#
+# 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
+
+    ##
+    # An AppEnrollment 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.
+    class AppEnrollmentModel
+
+        ##
+        # Initialize the AppEnrollmentModel using the provided prototype
+        def initialize(params = {})
+            @app_enrollment_id = params.dig(:app_enrollment_id)
+            @app_id = params.dig(:app_id)
+            @group_key = params.dig(:group_key)
+            @is_active = params.dig(:is_active)
+            @created = params.dig(:created)
+            @created_user_id = params.dig(:created_user_id)
+            @modified = params.dig(:modified)
+            @modified_user_id = params.dig(:modified_user_id)
+            @cron_settings = params.dig(:cron_settings)
+            @sync_schedule_is_active = params.dig(:sync_schedule_is_active)
+            @app = params.dig(:app)
+            @custom_field_definitions = params.dig(:custom_field_definitions)
+            @custom_field_values = params.dig(:custom_field_values)
+            @last_sync = params.dig(:last_sync)
+            @last_successful_sync = params.dig(:last_successful_sync)
+            @erp_info = params.dig(:erp_info)
+            @connector_info = params.dig(:connector_info)
+        end
+
+        ##
+        # @return [Uuid] The unique ID of this record, automatically assigned by Lockstep when this record is added to the Lockstep platform.
+        attr_accessor :app_enrollment_id
+
+        ##
+        # @return [Uuid] The ID number of the Application that this enrollment represents. You can fetch information about this Application object by specifying `App` in the "Include" parameter for your request.
+        attr_accessor :app_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 [Boolean] Determines whether the app enrollment is in use
+        attr_accessor :is_active
+
+        ##
+        # @return [Date-time] Created date
+        attr_accessor :created
+
+        ##
+        # @return [Uuid] Created user ID
+        attr_accessor :created_user_id
+
+        ##
+        # @return [Date-time] Last modified date
+        attr_accessor :modified
+
+        ##
+        # @return [Uuid] Last user ID to modify
+        attr_accessor :modified_user_id
+
+        ##
+        # @return [String] Stores schedule information for the application enrollment see https://en.wikipedia.org/wiki/Cron
+        attr_accessor :cron_settings
+
+        ##
+        # @return [Boolean] Flag indicating if the Sync process should be ran on the specified schedule
+        attr_accessor :sync_schedule_is_active
+
+        ##
+        # @return [ApplicationModel] The Application to which this AppEnrollment belongs. Contains general name, description, logo, and other metadata about this application. To retrieve this object, specify `App` in the "Include" parameter for your query.
+        attr_accessor :app
+
+        ##
+        # @return [CustomFieldDefinitionModel] All definitions attached to this app. To retrieve this collection, specify `CustomFieldValues` in the "Include" parameter for your query.
+        attr_accessor :custom_field_definitions
+
+        ##
+        # @return [CustomFieldValueModel] All values attached to this app. To retrieve this collection, specify `CustomFieldValues` in the "Include" parameter for your query.
+        attr_accessor :custom_field_values
+
+        ##
+        # @return [SyncRequestModel] Data about the last sync attached to this app enrollment To retrieve this collection, specify `LastSync` in the "Include" parameter for your query.
+        attr_accessor :last_sync
+
+        ##
+        # @return [SyncRequestModel] Data about the last successful sync associated with this enrollment
+        attr_accessor :last_successful_sync
+
+        ##
+        # @return [ErpInfoDataModel] Use `ConnectorInfo` instead.
+        attr_accessor :erp_info
+
+        ##
+        # @return [ConnectorInfoModel] Optional data necessary to create an app enrollment for a supported connector. Only enter relevant fields for the given connector.
+        attr_accessor :connector_info
+
+        ##
+        # @return [object] This object as a JSON key-value structure
+        def as_json(options={})
+            {
+                'appEnrollmentId' => @app_enrollment_id,
+                'appId' => @app_id,
+                'groupKey' => @group_key,
+                'isActive' => @is_active,
+                'created' => @created,
+                'createdUserId' => @created_user_id,
+                'modified' => @modified,
+                'modifiedUserId' => @modified_user_id,
+                'cronSettings' => @cron_settings,
+                'syncScheduleIsActive' => @sync_schedule_is_active,
+                'app' => @app,
+                'customFieldDefinitions' => @custom_field_definitions,
+                'customFieldValues' => @custom_field_values,
+                'lastSync' => @last_sync,
+                'lastSuccessfulSync' => @last_successful_sync,
+                'erpInfo' => @erp_info,
+                'connectorInfo' => @connector_info,
+            }
+        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/application_model.rb

@@ -0,0 +1,166 @@
+#
+# 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
+
+    ##
+    # 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.
+    # --swaggerCategory:Platform
+    class ApplicationModel
+
+        ##
+        # Initialize the ApplicationModel using the provided prototype
+        def initialize(params = {})
+            @app_id = params.dig(:app_id)
+            @name = params.dig(:name)
+            @description = params.dig(:description)
+            @app_type = params.dig(:app_type)
+            @owner_id = params.dig(:owner_id)
+            @project_url = params.dig(:project_url)
+            @icon_url = params.dig(:icon_url)
+            @price_terms = params.dig(:price_terms)
+            @created_user_id = params.dig(:created_user_id)
+            @modified_user_id = params.dig(:modified_user_id)
+            @created = params.dig(:created)
+            @modified = params.dig(:modified)
+            @is_active = params.dig(:is_active)
+            @wiki_url = params.dig(:wiki_url)
+            @group_key = params.dig(:group_key)
+            @notes = params.dig(:notes)
+            @attachments = params.dig(:attachments)
+            @custom_field_definitions = params.dig(:custom_field_definitions)
+            @custom_field_values = params.dig(:custom_field_values)
+        end
+
+        ##
+        # @return [Uuid] A unique code identifying this application
+        attr_accessor :app_id
+
+        ##
+        # @return [String] The name of this application
+        attr_accessor :name
+
+        ##
+        # @return [String] Brief summary of this application shown as a subtitle
+        attr_accessor :description
+
+        ##
+        # @return [String] Tag for what type of app this is
+        attr_accessor :app_type
+
+        ##
+        # @return [Uuid] The ID of the owner
+        attr_accessor :owner_id
+
+        ##
+        # @return [Uri] The URL to visit for more information about this application
+        attr_accessor :project_url
+
+        ##
+        # @return [Uri] The URL for the icon for this application
+        attr_accessor :icon_url
+
+        ##
+        # @return [String] The description of the price for this application
+        attr_accessor :price_terms
+
+        ##
+        # @return [Uuid] The ID of the user who created this application
+        attr_accessor :created_user_id
+
+        ##
+        # @return [Uuid] The ID of the user who last modified this application
+        attr_accessor :modified_user_id
+
+        ##
+        # @return [Date-time] The date this application was created
+        attr_accessor :created
+
+        ##
+        # @return [Date-time] The date this application was last modified
+        attr_accessor :modified
+
+        ##
+        # @return [Boolean] Flag indicating if the application is active.
+        attr_accessor :is_active
+
+        ##
+        # @return [Uri] URL to the Wiki for the Application
+        attr_accessor :wiki_url
+
+        ##
+        # @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 [NoteModel] All notes attached to this app. To retrieve this collection, specify `Notes` in the "Include" parameter for your query.
+        attr_accessor :notes
+
+        ##
+        # @return [AttachmentModel] All attachments attached to this app. To retrieve this collection, specify `Attachments` in the "Include" parameter for your query.
+        attr_accessor :attachments
+
+        ##
+        # @return [CustomFieldDefinitionModel] All definitions attached to the application. To retrieve this collection, specify `CustomFieldValues` in the "Include" parameter for your query.
+        attr_accessor :custom_field_definitions
+
+        ##
+        # @return [CustomFieldValueModel] All values attached to the application. To retrieve this collection, specify `CustomFieldValues` in the "Include" parameter for your query.
+        attr_accessor :custom_field_values
+
+        ##
+        # @return [object] This object as a JSON key-value structure
+        def as_json(options={})
+            {
+                'appId' => @app_id,
+                'name' => @name,
+                'description' => @description,
+                'appType' => @app_type,
+                'ownerId' => @owner_id,
+                'projectUrl' => @project_url,
+                'iconUrl' => @icon_url,
+                'priceTerms' => @price_terms,
+                'createdUserId' => @created_user_id,
+                'modifiedUserId' => @modified_user_id,
+                'created' => @created,
+                'modified' => @modified,
+                'isActive' => @is_active,
+                'wikiURL' => @wiki_url,
+                'groupKey' => @group_key,
+                'notes' => @notes,
+                'attachments' => @attachments,
+                'customFieldDefinitions' => @custom_field_definitions,
+                'customFieldValues' => @custom_field_values,
+            }
+        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/ar_aging_header_info_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
+
+    ##
+    # Aggregated Accounts Receivable Aging information.
+    class ArAgingHeaderInfoModel
+
+        ##
+        # Initialize the ArAgingHeaderInfoModel using the provided prototype
+        def initialize(params = {})
+            @group_key = params.dig(:group_key)
+            @report_bucket = params.dig(:report_bucket)
+            @total_customers = params.dig(:total_customers)
+            @total_invoices_outstanding = params.dig(:total_invoices_outstanding)
+            @total_outstanding_amount = params.dig(:total_outstanding_amount)
+            @total_ar_amount = params.dig(:total_ar_amount)
+            @percentage_of_total_ar = params.dig(:percentage_of_total_ar)
+        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 [String] The aging bucket this data belongs to.
+        attr_accessor :report_bucket
+
+        ##
+        # @return [Int32] The total number of customers.
+        attr_accessor :total_customers
+
+        ##
+        # @return [Int32] The total number of invoices outstanding.
+        attr_accessor :total_invoices_outstanding
+
+        ##
+        # @return [Double] The total amount outstanding.
+        attr_accessor :total_outstanding_amount
+
+        ##
+        # @return [Double] The total amount for AR.
+        attr_accessor :total_ar_amount
+
+        ##
+        # @return [Double] Portion of Total AR this data represents.
+        attr_accessor :percentage_of_total_ar
+
+        ##
+        # @return [object] This object as a JSON key-value structure
+        def as_json(options={})
+            {
+                'groupKey' => @group_key,
+                'reportBucket' => @report_bucket,
+                'totalCustomers' => @total_customers,
+                'totalInvoicesOutstanding' => @total_invoices_outstanding,
+                'totalOutstandingAmount' => @total_outstanding_amount,
+                'totalArAmount' => @total_ar_amount,
+                'percentageOfTotalAr' => @percentage_of_total_ar,
+            }
+        end
+
+        ##
+        # @return [String] This object converted to a JSON string
+        def to_json(*options)
+            "[#{as_json(*options).to_json(*options)}]"
+        end
+    end
+end