lockstep_sdk 2022.37.24.0 → 2023.1.3.0

data/lib/lockstep_sdk/models/financial_year_setting_sync_model.rb

@@ -1,13 +1,13 @@
 #
 # Lockstep Platform SDK for Ruby
 #
-# (c) 2021-2022 Lockstep, Inc.
+# (c) 2021-2023 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>
-# @copyright  2021-2022 Lockstep, Inc.
+# @copyright  2021-2023 Lockstep, Inc.
 # @link       https://github.com/Lockstep-Network/lockstep-sdk-ruby
 #
 

data/lib/lockstep_sdk/models/group_account_model.rb

@@ -1,13 +1,13 @@
 #
 # Lockstep Platform SDK for Ruby
 #
-# (c) 2021-2022 Lockstep, Inc.
+# (c) 2021-2023 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>
-# @copyright  2021-2022 Lockstep, Inc.
+# @copyright  2021-2023 Lockstep, Inc.
 # @link       https://github.com/Lockstep-Network/lockstep-sdk-ruby
 #
 
@@ -27,6 +27,7 @@ module LockstepSdk
             @group_name = params.dig(:group_name)
             @primary_user_id = params.dig(:primary_user_id)
             @group_company_id = params.dig(:group_company_id)
+            @base_currency_code = params.dig(:base_currency_code)
             @is_active = params.dig(:is_active)
             @onboarding_scheduled = params.dig(:onboarding_scheduled)
             @created = params.dig(:created)
@@ -51,6 +52,10 @@ module LockstepSdk
         # @return [Uuid] The CompanyId of the Company the group is associated with
         attr_accessor :group_company_id
 
+        ##
+        # @return [String] Base Currency of the group
+        attr_accessor :base_currency_code
+
         ##
         # @return [Boolean] The active status of the group
         attr_accessor :is_active
@@ -83,6 +88,7 @@ module LockstepSdk
                 'groupName' => @group_name,
                 'primaryUserId' => @primary_user_id,
                 'groupCompanyId' => @group_company_id,
+                'baseCurrencyCode' => @base_currency_code,
                 'isActive' => @is_active,
                 'onboardingScheduled' => @onboarding_scheduled,
                 'created' => @created,

data/lib/lockstep_sdk/models/invite_data_model.rb

@@ -1,13 +1,13 @@
 #
 # Lockstep Platform SDK for Ruby
 #
-# (c) 2021-2022 Lockstep, Inc.
+# (c) 2021-2023 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>
-# @copyright  2021-2022 Lockstep, Inc.
+# @copyright  2021-2023 Lockstep, Inc.
 # @link       https://github.com/Lockstep-Network/lockstep-sdk-ruby
 #
 

data/lib/lockstep_sdk/models/invite_model.rb

@@ -1,13 +1,13 @@
 #
 # Lockstep Platform SDK for Ruby
 #
-# (c) 2021-2022 Lockstep, Inc.
+# (c) 2021-2023 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>
-# @copyright  2021-2022 Lockstep, Inc.
+# @copyright  2021-2023 Lockstep, Inc.
 # @link       https://github.com/Lockstep-Network/lockstep-sdk-ruby
 #
 

data/lib/lockstep_sdk/models/invite_submit_model.rb

@@ -1,13 +1,13 @@
 #
 # Lockstep Platform SDK for Ruby
 #
-# (c) 2021-2022 Lockstep, Inc.
+# (c) 2021-2023 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>
-# @copyright  2021-2022 Lockstep, Inc.
+# @copyright  2021-2023 Lockstep, Inc.
 # @link       https://github.com/Lockstep-Network/lockstep-sdk-ruby
 #
 

data/lib/lockstep_sdk/models/invoice_address_model.rb

@@ -1,13 +1,13 @@
 #
 # Lockstep Platform SDK for Ruby
 #
-# (c) 2021-2022 Lockstep, Inc.
+# (c) 2021-2023 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>
-# @copyright  2021-2022 Lockstep, Inc.
+# @copyright  2021-2023 Lockstep, Inc.
 # @link       https://github.com/Lockstep-Network/lockstep-sdk-ruby
 #
 

data/lib/lockstep_sdk/models/invoice_history_model.rb

@@ -1,13 +1,13 @@
 #
 # Lockstep Platform SDK for Ruby
 #
-# (c) 2021-2022 Lockstep, Inc.
+# (c) 2021-2023 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>
-# @copyright  2021-2022 Lockstep, Inc.
+# @copyright  2021-2023 Lockstep, Inc.
 # @link       https://github.com/Lockstep-Network/lockstep-sdk-ruby
 #
 
@@ -58,6 +58,7 @@ module LockstepSdk
             @modified = params.dig(:modified)
             @modified_user_id = params.dig(:modified_user_id)
             @app_enrollment_id = params.dig(:app_enrollment_id)
+            @currency_rate = params.dig(:currency_rate)
         end
 
         ##
@@ -192,6 +193,10 @@ module LockstepSdk
         # @return [Uuid] The AppEnrollmentId of the application that imported this record. For accounts with more than one financial system connected, this field identifies the originating financial system that produced this record. This value is null if this record was not loaded from an external ERP or financial system.
         attr_accessor :app_enrollment_id
 
+        ##
+        # @return [Double] The Currency Rate used to get from the account's base currency to the invoice amount.
+        attr_accessor :currency_rate
+
         ##
         # @return [object] This object as a JSON key-value structure
         def as_json(options={})
@@ -229,6 +234,7 @@ module LockstepSdk
                 'modified' => @modified,
                 'modifiedUserId' => @modified_user_id,
                 'appEnrollmentId' => @app_enrollment_id,
+                'currencyRate' => @currency_rate,
             }
         end
 

data/lib/lockstep_sdk/models/invoice_line_model.rb

@@ -1,13 +1,13 @@
 #
 # Lockstep Platform SDK for Ruby
 #
-# (c) 2021-2022 Lockstep, Inc.
+# (c) 2021-2023 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>
-# @copyright  2021-2022 Lockstep, Inc.
+# @copyright  2021-2023 Lockstep, Inc.
 # @link       https://github.com/Lockstep-Network/lockstep-sdk-ruby
 #
 

data/lib/lockstep_sdk/models/invoice_line_sync_model.rb

@@ -1,13 +1,13 @@
 #
 # Lockstep Platform SDK for Ruby
 #
-# (c) 2021-2022 Lockstep, Inc.
+# (c) 2021-2023 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>
-# @copyright  2021-2022 Lockstep, Inc.
+# @copyright  2021-2023 Lockstep, Inc.
 # @link       https://github.com/Lockstep-Network/lockstep-sdk-ruby
 #
 

data/lib/lockstep_sdk/models/invoice_model.rb

@@ -1,13 +1,13 @@
 #
 # Lockstep Platform SDK for Ruby
 #
-# (c) 2021-2022 Lockstep, Inc.
+# (c) 2021-2023 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>
-# @copyright  2021-2022 Lockstep, Inc.
+# @copyright  2021-2023 Lockstep, Inc.
 # @link       https://github.com/Lockstep-Network/lockstep-sdk-ruby
 #
 
@@ -64,6 +64,7 @@ module LockstepSdk
             @in_dispute = params.dig(:in_dispute)
             @exclude_from_aging = params.dig(:exclude_from_aging)
             @preferred_delivery_method = params.dig(:preferred_delivery_method)
+            @currency_rate = params.dig(:currency_rate)
             @addresses = params.dig(:addresses)
             @lines = params.dig(:lines)
             @payments = params.dig(:payments)
@@ -221,6 +222,10 @@ module LockstepSdk
         # @return [String] Indicates the preferred delivery method for this invoice. Examples include Print, Email, Fax
         attr_accessor :preferred_delivery_method
 
+        ##
+        # @return [Double] The Currency Rate used to get from the account's base currency to the invoice amount.
+        attr_accessor :currency_rate
+
         ##
         # @return [InvoiceAddressModel] All addresses connected to this invoice. To retrieve this collection, specify `Addresses` in the "Include" parameter for your query.
         attr_accessor :addresses
@@ -305,6 +310,7 @@ module LockstepSdk
                 'inDispute' => @in_dispute,
                 'excludeFromAging' => @exclude_from_aging,
                 'preferredDeliveryMethod' => @preferred_delivery_method,
+                'currencyRate' => @currency_rate,
                 'addresses' => @addresses,
                 'lines' => @lines,
                 'payments' => @payments,

data/lib/lockstep_sdk/models/invoice_payment_detail_model.rb

@@ -1,13 +1,13 @@
 #
 # Lockstep Platform SDK for Ruby
 #
-# (c) 2021-2022 Lockstep, Inc.
+# (c) 2021-2023 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>
-# @copyright  2021-2022 Lockstep, Inc.
+# @copyright  2021-2023 Lockstep, Inc.
 # @link       https://github.com/Lockstep-Network/lockstep-sdk-ruby
 #
 
@@ -24,21 +24,34 @@ module LockstepSdk
         # Initialize the InvoicePaymentDetailModel using the provided prototype
         def initialize(params = {})
             @group_key = params.dig(:group_key)
+            @base_currency_code = params.dig(:base_currency_code)
+            @currency_code = params.dig(:currency_code)
             @payment_applied_id = params.dig(:payment_applied_id)
             @invoice_id = params.dig(:invoice_id)
             @payment_id = params.dig(:payment_id)
             @apply_to_invoice_date = params.dig(:apply_to_invoice_date)
             @payment_applied_amount = params.dig(:payment_applied_amount)
+            @base_currency_payment_applied_amount = params.dig(:base_currency_payment_applied_amount)
             @reference_code = params.dig(:reference_code)
             @company_id = params.dig(:company_id)
             @payment_amount = params.dig(:payment_amount)
             @unapplied_amount = params.dig(:unapplied_amount)
+            @base_currency_payment_amount = params.dig(:base_currency_payment_amount)
+            @base_currency_unapplied_amount = params.dig(:base_currency_unapplied_amount)
         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 base currency code of the group.
+        attr_accessor :base_currency_code
+
+        ##
+        # @return [String] The payment's currency code.
+        attr_accessor :currency_code
+
         ##
         # @return [Uuid] The unique identifier of this PaymentApplied record.
         attr_accessor :payment_applied_id
@@ -59,6 +72,10 @@ module LockstepSdk
         # @return [Double] Amount applied to Invoice.
         attr_accessor :payment_applied_amount
 
+        ##
+        # @return [Double] Amount applied to Invoice in the group's base currency.
+        attr_accessor :base_currency_payment_applied_amount
+
         ##
         # @return [String] An additional reference code that is sometimes used to identify this Payment. The meaning of this field is specific to the ERP or accounting system used by the user.
         attr_accessor :reference_code
@@ -75,20 +92,33 @@ module LockstepSdk
         # @return [Double] The remaining balance value of this Payment.
         attr_accessor :unapplied_amount
 
+        ##
+        # @return [Double] The total value of this Payment in the group's base currency.
+        attr_accessor :base_currency_payment_amount
+
+        ##
+        # @return [Double] The remaining balance value of this Payment in the group's base currency.
+        attr_accessor :base_currency_unapplied_amount
+
         ##
         # @return [object] This object as a JSON key-value structure
         def as_json(options={})
             {
                 'groupKey' => @group_key,
+                'baseCurrencyCode' => @base_currency_code,
+                'currencyCode' => @currency_code,
                 'paymentAppliedId' => @payment_applied_id,
                 'invoiceId' => @invoice_id,
                 'paymentId' => @payment_id,
                 'applyToInvoiceDate' => @apply_to_invoice_date,
                 'paymentAppliedAmount' => @payment_applied_amount,
+                'baseCurrencyPaymentAppliedAmount' => @base_currency_payment_applied_amount,
                 'referenceCode' => @reference_code,
                 'companyId' => @company_id,
                 'paymentAmount' => @payment_amount,
                 'unappliedAmount' => @unapplied_amount,
+                'baseCurrencyPaymentAmount' => @base_currency_payment_amount,
+                'baseCurrencyUnappliedAmount' => @base_currency_unapplied_amount,
             }
         end
 

data/lib/lockstep_sdk/models/invoice_summary_model.rb

@@ -1,13 +1,13 @@
 #
 # Lockstep Platform SDK for Ruby
 #
-# (c) 2021-2022 Lockstep, Inc.
+# (c) 2021-2023 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>
-# @copyright  2021-2022 Lockstep, Inc.
+# @copyright  2021-2023 Lockstep, Inc.
 # @link       https://github.com/Lockstep-Network/lockstep-sdk-ruby
 #
 
@@ -32,13 +32,20 @@ module LockstepSdk
             @customer_name = params.dig(:customer_name)
             @status = params.dig(:status)
             @payment_due_date = params.dig(:payment_due_date)
+            @currency_code = params.dig(:currency_code)
             @invoice_amount = params.dig(:invoice_amount)
             @outstanding_balance = params.dig(:outstanding_balance)
+            @base_currency_code = params.dig(:base_currency_code)
+            @base_currency_invoice_amount = params.dig(:base_currency_invoice_amount)
+            @base_currency_outstanding_balance = params.dig(:base_currency_outstanding_balance)
             @invoice_type_code = params.dig(:invoice_type_code)
             @newest_activity = params.dig(:newest_activity)
             @days_past_due = params.dig(:days_past_due)
+            @payment_count = params.dig(:payment_count)
+            @supports_erp_pdf_retrieval = params.dig(:supports_erp_pdf_retrieval)
             @payment_numbers = params.dig(:payment_numbers)
             @payment_ids = params.dig(:payment_ids)
+            @modified = params.dig(:modified)
         end
 
         ##
@@ -77,6 +84,10 @@ module LockstepSdk
         # @return [Date] The due date of the invoice.
         attr_accessor :payment_due_date
 
+        ##
+        # @return [String] The currency code for the invoice.
+        attr_accessor :currency_code
+
         ##
         # @return [Double] The total amount of the Invoice.
         attr_accessor :invoice_amount
@@ -85,6 +96,18 @@ module LockstepSdk
         # @return [Double] The remaining balance value of this invoice.
         attr_accessor :outstanding_balance
 
+        ##
+        # @return [String] The group's base currency code.
+        attr_accessor :base_currency_code
+
+        ##
+        # @return [Double] The invoice amount in the group's base currency
+        attr_accessor :base_currency_invoice_amount
+
+        ##
+        # @return [Double] The outstanding balance amount in the group's base currency
+        attr_accessor :base_currency_outstanding_balance
+
         ##
         # @return [String] A code identifying the type of this Invoice.
         attr_accessor :invoice_type_code
@@ -97,6 +120,14 @@ module LockstepSdk
         # @return [Int32] The number of days this Invoice is past due.
         attr_accessor :days_past_due
 
+        ##
+        # @return [Int32] The number of payments associated to this invoice.
+        attr_accessor :payment_count
+
+        ##
+        # @return [Boolean] Specific invoices have support for pdf retrieval from their respective erp. When this flag is true, an additional call to Invoices/{id}/pdf can be made to retrieve a pdf directly from the erp.
+        attr_accessor :supports_erp_pdf_retrieval
+
         ##
         # @return [String] The memo text of the payments associated to this invoice.
         attr_accessor :payment_numbers
@@ -105,6 +136,10 @@ module LockstepSdk
         # @return [Uuid] The ids of the payments associated to this invoice.
         attr_accessor :payment_ids
 
+        ##
+        # @return [Date-time] The modified date of the invoice.
+        attr_accessor :modified
+
         ##
         # @return [object] This object as a JSON key-value structure
         def as_json(options={})
@@ -118,13 +153,20 @@ module LockstepSdk
                 'customerName' => @customer_name,
                 'status' => @status,
                 'paymentDueDate' => @payment_due_date,
+                'currencyCode' => @currency_code,
                 'invoiceAmount' => @invoice_amount,
                 'outstandingBalance' => @outstanding_balance,
+                'baseCurrencyCode' => @base_currency_code,
+                'baseCurrencyInvoiceAmount' => @base_currency_invoice_amount,
+                'baseCurrencyOutstandingBalance' => @base_currency_outstanding_balance,
                 'invoiceTypeCode' => @invoice_type_code,
                 'newestActivity' => @newest_activity,
                 'daysPastDue' => @days_past_due,
+                'paymentCount' => @payment_count,
+                'supportsErpPdfRetrieval' => @supports_erp_pdf_retrieval,
                 'paymentNumbers' => @payment_numbers,
                 'paymentIds' => @payment_ids,
+                'modified' => @modified,
             }
         end
 

data/lib/lockstep_sdk/models/invoice_summary_model_invoice_summary_totals_model_summary_fetch_result.rb

@@ -0,0 +1,75 @@
+#
+# Lockstep Platform SDK for Ruby
+#
+# (c) 2021-2023 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>
+# @copyright  2021-2023 Lockstep, Inc.
+# @link       https://github.com/Lockstep-Network/lockstep-sdk-ruby
+#
+
+
+require 'json'
+
+module LockstepSdk
+
+    class InvoiceSummaryModelInvoiceSummaryTotalsModelSummaryFetchResult
+
+        ##
+        # Initialize the InvoiceSummaryModelInvoiceSummaryTotalsModelSummaryFetchResult using the provided prototype
+        def initialize(params = {})
+            @records = params.dig(:records)
+            @total_count = params.dig(:total_count)
+            @page_size = params.dig(:page_size)
+            @page_number = params.dig(:page_number)
+            @summary = params.dig(:summary)
+            @aging_summary = params.dig(:aging_summary)
+        end
+
+        ##
+        # @return [InvoiceSummaryModel] 
+        attr_accessor :records
+
+        ##
+        # @return [Int32] 
+        attr_accessor :total_count
+
+        ##
+        # @return [Int32] 
+        attr_accessor :page_size
+
+        ##
+        # @return [Int32] 
+        attr_accessor :page_number
+
+        ##
+        # @return [InvoiceSummaryTotalsModel] The totals for an Invoice Summary
+        attr_accessor :summary
+
+        ##
+        # @return [SummaryAgingTotalsModel] 
+        attr_accessor :aging_summary
+
+        ##
+        # @return [object] This object as a JSON key-value structure
+        def as_json(options={})
+            {
+                'records' => @records,
+                'totalCount' => @total_count,
+                'pageSize' => @page_size,
+                'pageNumber' => @page_number,
+                'summary' => @summary,
+                'agingSummary' => @aging_summary,
+            }
+        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/invoice_summary_totals_model.rb

@@ -0,0 +1,53 @@
+#
+# Lockstep Platform SDK for Ruby
+#
+# (c) 2021-2023 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>
+# @copyright  2021-2023 Lockstep, Inc.
+# @link       https://github.com/Lockstep-Network/lockstep-sdk-ruby
+#
+
+
+require 'json'
+
+module LockstepSdk
+
+    ##
+    # The totals for an Invoice Summary
+    class InvoiceSummaryTotalsModel
+
+        ##
+        # Initialize the InvoiceSummaryTotalsModel using the provided prototype
+        def initialize(params = {})
+            @total_invoice_amount = params.dig(:total_invoice_amount)
+            @total_invoice_balance = params.dig(:total_invoice_balance)
+        end
+
+        ##
+        # @return [Double] The total amount invoiced.
+        attr_accessor :total_invoice_amount
+
+        ##
+        # @return [Double] The total outstanding balance
+        attr_accessor :total_invoice_balance
+
+        ##
+        # @return [object] This object as a JSON key-value structure
+        def as_json(options={})
+            {
+                'totalInvoiceAmount' => @total_invoice_amount,
+                'totalInvoiceBalance' => @total_invoice_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/invoice_sync_model.rb

@@ -1,13 +1,13 @@
 #
 # Lockstep Platform SDK for Ruby
 #
-# (c) 2021-2022 Lockstep, Inc.
+# (c) 2021-2023 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>
-# @copyright  2021-2022 Lockstep, Inc.
+# @copyright  2021-2023 Lockstep, Inc.
 # @link       https://github.com/Lockstep-Network/lockstep-sdk-ruby
 #
 
@@ -85,6 +85,7 @@ module LockstepSdk
             @is_voided = params.dig(:is_voided)
             @in_dispute = params.dig(:in_dispute)
             @preferred_delivery_method = params.dig(:preferred_delivery_method)
+            @currency_rate = params.dig(:currency_rate)
         end
 
         ##
@@ -303,6 +304,10 @@ module LockstepSdk
         # @return [String] Indicates the preferred delivery method for this invoice. Examples include Print, Email, Fax
         attr_accessor :preferred_delivery_method
 
+        ##
+        # @return [Double] The Currency Rate used to get from the account's base currency to the invoice amount.
+        attr_accessor :currency_rate
+
         ##
         # @return [object] This object as a JSON key-value structure
         def as_json(options={})
@@ -361,6 +366,7 @@ module LockstepSdk
                 'isVoided' => @is_voided,
                 'inDispute' => @in_dispute,
                 'preferredDeliveryMethod' => @preferred_delivery_method,
+                'currencyRate' => @currency_rate,
             }
         end
 

data/lib/lockstep_sdk/models/lead_model.rb

@@ -1,13 +1,13 @@
 #
 # Lockstep Platform SDK for Ruby
 #
-# (c) 2021-2022 Lockstep, Inc.
+# (c) 2021-2023 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>
-# @copyright  2021-2022 Lockstep, Inc.
+# @copyright  2021-2023 Lockstep, Inc.
 # @link       https://github.com/Lockstep-Network/lockstep-sdk-ruby
 #
 
@@ -43,7 +43,7 @@ module LockstepSdk
         attr_accessor :company
 
         ##
-        # @return [String] Email of lead
+        # @return [Email] Email of lead
         attr_accessor :email
 
         ##