lockstep_sdk 2022.4.32.0

data/lib/lockstep_sdk/models/transfer_owner_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 used to submit a transfer ownership request
+    class TransferOwnerSubmitModel
+
+        ##
+        # Initialize the TransferOwnerSubmitModel using the provided prototype
+        def initialize(params = {})
+            @target_user_id = params.dig(:target_user_id)
+        end
+
+        ##
+        # @return [Uuid] The ID of the user to transfer ownership to.
+        attr_accessor :target_user_id
+
+        ##
+        # @return [object] This object as a JSON key-value structure
+        def as_json(options={})
+            {
+                'targetUserId' => @target_user_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/user_account_model.rb

@@ -0,0 +1,240 @@
+#
+# 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
+
+    ##
+    # A User represents a person who has the ability to authenticate against the Lockstep Platform and use
+    # services such as Lockstep Inbox.  A User is uniquely identified by an Azure identity, and each user must
+    # have an email address defined within their account.  All Users must validate their email to make use of
+    # Lockstep platform services.  Users may have different privileges and access control rights within the
+    # Lockstep Platform.
+    class UserAccountModel
+
+        ##
+        # Initialize the UserAccountModel using the provided prototype
+        def initialize(params = {})
+            @user_id = params.dig(:user_id)
+            @group_key = params.dig(:group_key)
+            @user_name = params.dig(:user_name)
+            @email = params.dig(:email)
+            @status = params.dig(:status)
+            @created = params.dig(:created)
+            @created_user_id = params.dig(:created_user_id)
+            @modified = params.dig(:modified)
+            @modified_user_id = params.dig(:modified_user_id)
+            @modified_user_name = params.dig(:modified_user_name)
+            @b2_cuser_id = params.dig(:b2_cuser_id)
+            @user_role = params.dig(:user_role)
+            @invite_sent = params.dig(:invite_sent)
+            @phone_number = params.dig(:phone_number)
+            @fax_number = params.dig(:fax_number)
+            @title = params.dig(:title)
+            @accounting_role_code_def_id = params.dig(:accounting_role_code_def_id)
+            @address1 = params.dig(:address1)
+            @address2 = params.dig(:address2)
+            @address3 = params.dig(:address3)
+            @city = params.dig(:city)
+            @state_region = params.dig(:state_region)
+            @postal_code = params.dig(:postal_code)
+            @country = params.dig(:country)
+            @image_url = params.dig(:image_url)
+            @description = params.dig(:description)
+            @b2_clast_logged_in = params.dig(:b2_clast_logged_in)
+            @default_currency_code = params.dig(:default_currency_code)
+            @notes = params.dig(:notes)
+            @attachments = params.dig(:attachments)
+            @custom_field_values = params.dig(:custom_field_values)
+            @accounting_role_code_definition = params.dig(:accounting_role_code_definition)
+        end
+
+        ##
+        # @return [Uuid] The unique ID of this record, automatically assigned by Lockstep when this record is added to the Lockstep platform. This record provides a link to the user's Azure AD B2C OID.
+        attr_accessor :user_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 full name of the user
+        attr_accessor :user_name
+
+        ##
+        # @return [Email] The email of the user
+        attr_accessor :email
+
+        ##
+        # @return [String] The status of the user's account
+        attr_accessor :status
+
+        ##
+        # @return [Date-time] The date that the user account was created
+        attr_accessor :created
+
+        ##
+        # @return [Uuid] The ID of the user who created the user account
+        attr_accessor :created_user_id
+
+        ##
+        # @return [Date-time] The date the user account was last modified
+        attr_accessor :modified
+
+        ##
+        # @return [Uuid] The ID of the user who last modified the user account
+        attr_accessor :modified_user_id
+
+        ##
+        # @return [String] The name of the user who last modified the user account
+        attr_accessor :modified_user_name
+
+        ##
+        # @return [Uuid] The ID of the user in Azure B2C
+        attr_accessor :b2_cuser_id
+
+        ##
+        # @return [Uuid] The id of the Permission Level for the user.
+        attr_accessor :user_role
+
+        ##
+        # @return [Date-time] The date timestamp when the invite was sent to the user.
+        attr_accessor :invite_sent
+
+        ##
+        # @return [String] The phone number of the user.
+        attr_accessor :phone_number
+
+        ##
+        # @return [String] The fax number of the user.
+        attr_accessor :fax_number
+
+        ##
+        # @return [String] The title of the user; free text field
+        attr_accessor :title
+
+        ##
+        # @return [Uuid] FK to the CodeDefinition table; CodeType = 'AccountingRole'
+        attr_accessor :accounting_role_code_def_id
+
+        ##
+        # @return [String] Address Line 1 for this User
+        attr_accessor :address1
+
+        ##
+        # @return [String] Address Line 2 for this User
+        attr_accessor :address2
+
+        ##
+        # @return [String] Address Line 3 for this User
+        attr_accessor :address3
+
+        ##
+        # @return [String] City for this User
+        attr_accessor :city
+
+        ##
+        # @return [String] Region ("state" in the US) for this User
+        attr_accessor :state_region
+
+        ##
+        # @return [String] Postal Code this User
+        attr_accessor :postal_code
+
+        ##
+        # @return [String] Country for this User This will be validated by the /api/v1/countries data set
+        attr_accessor :country
+
+        ##
+        # @return [String] Image URL for this User
+        attr_accessor :image_url
+
+        ##
+        # @return [String] Description for this User.
+        attr_accessor :description
+
+        ##
+        # @return [Date-time] Last date time user logged into Azure B2C.
+        attr_accessor :b2_clast_logged_in
+
+        ##
+        # @return [String] The default currency code used by this user entity. This value can be overridden for invoices in a different currency code. For a list of defined currency codes, see [Query Currencies](https://developer.lockstep.io/reference/get_api-v1-definitions-currencies) This will be validated by the /api/v1/currencies data set
+        attr_accessor :default_currency_code
+
+        ##
+        # @return [NoteModel] All notes attached to this User. To retrieve this collection, specify `Notes` in the "Include" parameter for your query.
+        attr_accessor :notes
+
+        ##
+        # @return [AttachmentModel] All attachments attached to this User. To retrieve this collection, specify `Attachments` in the "Include" parameter for your query.
+        attr_accessor :attachments
+
+        ##
+        # @return [CustomFieldValueModel] All values attached to this User. To retrieve this collection, specify `CustomFieldValues` in the "Include" parameter for your query.
+        attr_accessor :custom_field_values
+
+        ##
+        # @return [CodeDefinitionModel] Accounting role definition for this User. To retrieve this collection, specify `AccountingRole` in the "Include" parameter for your query.
+        attr_accessor :accounting_role_code_definition
+
+        ##
+        # @return [object] This object as a JSON key-value structure
+        def as_json(options={})
+            {
+                'userId' => @user_id,
+                'groupKey' => @group_key,
+                'userName' => @user_name,
+                'email' => @email,
+                'status' => @status,
+                'created' => @created,
+                'createdUserId' => @created_user_id,
+                'modified' => @modified,
+                'modifiedUserId' => @modified_user_id,
+                'modifiedUserName' => @modified_user_name,
+                'b2CUserId' => @b2_cuser_id,
+                'userRole' => @user_role,
+                'inviteSent' => @invite_sent,
+                'phoneNumber' => @phone_number,
+                'faxNumber' => @fax_number,
+                'title' => @title,
+                'accountingRoleCodeDefId' => @accounting_role_code_def_id,
+                'address1' => @address1,
+                'address2' => @address2,
+                'address3' => @address3,
+                'city' => @city,
+                'stateRegion' => @state_region,
+                'postalCode' => @postal_code,
+                'country' => @country,
+                'imageURL' => @image_url,
+                'description' => @description,
+                'b2CLastLoggedIn' => @b2_clast_logged_in,
+                'defaultCurrencyCode' => @default_currency_code,
+                'notes' => @notes,
+                'attachments' => @attachments,
+                'customFieldValues' => @custom_field_values,
+                'accountingRoleCodeDefinition' => @accounting_role_code_definition,
+            }
+        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/user_role_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 a role for a user
+    class UserRoleModel
+
+        ##
+        # Initialize the UserRoleModel using the provided prototype
+        def initialize(params = {})
+            @user_role_id = params.dig(:user_role_id)
+            @group_key = params.dig(:group_key)
+            @user_role_name = params.dig(:user_role_name)
+            @created = params.dig(:created)
+            @created_user_id = params.dig(:created_user_id)
+            @modified = params.dig(:modified)
+            @modified_user_id = params.dig(:modified_user_id)
+        end
+
+        ##
+        # @return [Uuid] The unique ID of this record, automatically assigned by Lockstep when this record is added to the Lockstep platform.
+        attr_accessor :user_role_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 user role
+        attr_accessor :user_role_name
+
+        ##
+        # @return [Date-time] The date that the user role was created
+        attr_accessor :created
+
+        ##
+        # @return [Uuid] The ID of the user who created the user role
+        attr_accessor :created_user_id
+
+        ##
+        # @return [Date-time] The date the user role was last modified
+        attr_accessor :modified
+
+        ##
+        # @return [Uuid] The ID of the user who last modified the user role
+        attr_accessor :modified_user_id
+
+        ##
+        # @return [object] This object as a JSON key-value structure
+        def as_json(options={})
+            {
+                'userRoleId' => @user_role_id,
+                'groupKey' => @group_key,
+                'userRoleName' => @user_role_name,
+                'created' => @created,
+                'createdUserId' => @created_user_id,
+                'modified' => @modified,
+                'modifiedUserId' => @modified_user_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/version.rb

@@ -0,0 +1,3 @@
+module LockstepSdk
+    VERSION = "2022.4.32.0"
+end

metadata

@@ -0,0 +1,150 @@
+--- !ruby/object:Gem::Specification
+name: lockstep_sdk
+version: !ruby/object:Gem::Version
+  version: 2022.4.32.0
+platform: ruby
+authors:
+- Lockstep
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2022-01-28 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: awrence
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+description: "Allows you to work with the Lockstep Platform API for financial systems
+  automation.  The SDK provides rich, \n                     context sensitive help
+  and documentation for all methods and objects."
+email: developer@lockstep.io
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- lib/lockstep_sdk/clients/activities_client.rb
+- lib/lockstep_sdk/clients/api_keys_client.rb
+- lib/lockstep_sdk/clients/app_enrollments_client.rb
+- lib/lockstep_sdk/clients/applications_client.rb
+- lib/lockstep_sdk/clients/attachments_client.rb
+- lib/lockstep_sdk/clients/code_definitions_client.rb
+- lib/lockstep_sdk/clients/companies_client.rb
+- lib/lockstep_sdk/clients/contacts_client.rb
+- lib/lockstep_sdk/clients/credit_memo_applied_client.rb
+- lib/lockstep_sdk/clients/currencies_client.rb
+- lib/lockstep_sdk/clients/custom_field_definitions_client.rb
+- lib/lockstep_sdk/clients/custom_field_values_client.rb
+- lib/lockstep_sdk/clients/definitions_client.rb
+- lib/lockstep_sdk/clients/emails_client.rb
+- lib/lockstep_sdk/clients/invoice_history_client.rb
+- lib/lockstep_sdk/clients/invoices_client.rb
+- lib/lockstep_sdk/clients/leads_client.rb
+- lib/lockstep_sdk/clients/notes_client.rb
+- lib/lockstep_sdk/clients/payment_applications_client.rb
+- lib/lockstep_sdk/clients/payments_client.rb
+- lib/lockstep_sdk/clients/provisioning_client.rb
+- lib/lockstep_sdk/clients/reports_client.rb
+- lib/lockstep_sdk/clients/status_client.rb
+- lib/lockstep_sdk/clients/sync_client.rb
+- lib/lockstep_sdk/clients/user_accounts_client.rb
+- lib/lockstep_sdk/clients/user_roles_client.rb
+- lib/lockstep_sdk/lockstep_api.rb
+- lib/lockstep_sdk/models/activity_model.rb
+- lib/lockstep_sdk/models/activity_stream_item_model.rb
+- lib/lockstep_sdk/models/activity_xref_model.rb
+- lib/lockstep_sdk/models/aging_model.rb
+- lib/lockstep_sdk/models/api_key_model.rb
+- lib/lockstep_sdk/models/app_enrollment_custom_field_model.rb
+- lib/lockstep_sdk/models/app_enrollment_model.rb
+- lib/lockstep_sdk/models/application_model.rb
+- lib/lockstep_sdk/models/ar_aging_header_info_model.rb
+- lib/lockstep_sdk/models/ar_header_info_model.rb
+- lib/lockstep_sdk/models/at_risk_invoice_summary_model.rb
+- lib/lockstep_sdk/models/attachment_header_info_model.rb
+- lib/lockstep_sdk/models/attachment_model.rb
+- lib/lockstep_sdk/models/bulk_currency_conversion_model.rb
+- lib/lockstep_sdk/models/cashflow_report_model.rb
+- lib/lockstep_sdk/models/code_definition_model.rb
+- lib/lockstep_sdk/models/company_model.rb
+- lib/lockstep_sdk/models/connector_info_model.rb
+- lib/lockstep_sdk/models/contact_model.rb
+- lib/lockstep_sdk/models/country_model.rb
+- lib/lockstep_sdk/models/credit_memo_applied_model.rb
+- lib/lockstep_sdk/models/credit_memo_invoice_model.rb
+- lib/lockstep_sdk/models/currency_model.rb
+- lib/lockstep_sdk/models/currency_rate_model.rb
+- lib/lockstep_sdk/models/custom_field_definition_model.rb
+- lib/lockstep_sdk/models/custom_field_value_model.rb
+- lib/lockstep_sdk/models/customer_details_model.rb
+- lib/lockstep_sdk/models/customer_details_payment_model.rb
+- lib/lockstep_sdk/models/customer_summary_model.rb
+- lib/lockstep_sdk/models/daily_sales_outstanding_report_model.rb
+- lib/lockstep_sdk/models/developer_account_submit_model.rb
+- lib/lockstep_sdk/models/email_model.rb
+- lib/lockstep_sdk/models/erp_info_data_model.rb
+- lib/lockstep_sdk/models/erp_info_model.rb
+- lib/lockstep_sdk/models/erp_model.rb
+- lib/lockstep_sdk/models/invite_data_model.rb
+- lib/lockstep_sdk/models/invite_model.rb
+- lib/lockstep_sdk/models/invite_submit_model.rb
+- lib/lockstep_sdk/models/invoice_address_model.rb
+- lib/lockstep_sdk/models/invoice_history_model.rb
+- lib/lockstep_sdk/models/invoice_line_model.rb
+- lib/lockstep_sdk/models/invoice_model.rb
+- lib/lockstep_sdk/models/invoice_payment_detail_model.rb
+- lib/lockstep_sdk/models/invoice_summary_model.rb
+- lib/lockstep_sdk/models/lead_model.rb
+- lib/lockstep_sdk/models/note_model.rb
+- lib/lockstep_sdk/models/payment_applied_model.rb
+- lib/lockstep_sdk/models/payment_detail_header_model.rb
+- lib/lockstep_sdk/models/payment_detail_model.rb
+- lib/lockstep_sdk/models/payment_model.rb
+- lib/lockstep_sdk/models/payment_summary_model.rb
+- lib/lockstep_sdk/models/provisioning_finalize_request_model.rb
+- lib/lockstep_sdk/models/provisioning_model.rb
+- lib/lockstep_sdk/models/provisioning_response_model.rb
+- lib/lockstep_sdk/models/risk_rate_model.rb
+- lib/lockstep_sdk/models/state_model.rb
+- lib/lockstep_sdk/models/status_model.rb
+- lib/lockstep_sdk/models/sync_entity_result_model.rb
+- lib/lockstep_sdk/models/sync_request_model.rb
+- lib/lockstep_sdk/models/sync_submit_model.rb
+- lib/lockstep_sdk/models/transfer_owner_model.rb
+- lib/lockstep_sdk/models/transfer_owner_submit_model.rb
+- lib/lockstep_sdk/models/user_account_model.rb
+- lib/lockstep_sdk/models/user_role_model.rb
+- lib/lockstep_sdk/version.rb
+homepage: https://developer.lockstep.io
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.3.3
+signing_key: 
+specification_version: 4
+summary: API Client to use the Lockstep Platform API
+test_files: []