lockstep_sdk 2022.4.32.0

data/lib/lockstep_sdk/models/contact_model.rb

@@ -0,0 +1,227 @@
+#
+# 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 Contact contains information about a person or role within a Company.
+    # You can use Contacts to track information about who is responsible for a specific project,
+    # who handles invoices, or information about which role at a particular customer or
+    # vendor you should speak with about invoices.
+    class ContactModel
+
+        ##
+        # Initialize the ContactModel using the provided prototype
+        def initialize(params = {})
+            @contact_id = params.dig(:contact_id)
+            @company_id = params.dig(:company_id)
+            @group_key = params.dig(:group_key)
+            @erp_key = params.dig(:erp_key)
+            @contact_name = params.dig(:contact_name)
+            @contact_code = params.dig(:contact_code)
+            @title = params.dig(:title)
+            @role_code = params.dig(:role_code)
+            @email_address = params.dig(:email_address)
+            @phone = params.dig(:phone)
+            @fax = params.dig(:fax)
+            @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_code = params.dig(:country_code)
+            @is_active = params.dig(:is_active)
+            @webpage_url = params.dig(:webpage_url)
+            @picture_url = params.dig(:picture_url)
+            @created = params.dig(:created)
+            @created_user_id = params.dig(:created_user_id)
+            @modified = params.dig(:modified)
+            @modified_user_id = params.dig(:modified_user_id)
+            @app_enrollment_id = params.dig(:app_enrollment_id)
+            @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] The unique ID of this record, automatically assigned by Lockstep when this record is added to the Lockstep platform. For the ID of this record in its originating financial system, see `ErpKey`.
+        attr_accessor :contact_id
+
+        ##
+        # @return [Uuid] The ID of the company to which this contact belongs.
+        attr_accessor :company_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 unique ID of this record as it was known in its originating financial system. If this company record was imported from a financial system, it will have the value `ErpKey` set to the original primary key number of the record as it was known in the originating financial system. If this record was not imported, this value will be `null`. For more information, see [Identity Columns](https://developer.lockstep.io/docs/identity-columns).
+        attr_accessor :erp_key
+
+        ##
+        # @return [String] The name of the contact.
+        attr_accessor :contact_name
+
+        ##
+        # @return [String] A friendly human-readable code that describes this Contact.
+        attr_accessor :contact_code
+
+        ##
+        # @return [String] The title of the contact.
+        attr_accessor :title
+
+        ##
+        # @return [String] The role code for the contact.
+        attr_accessor :role_code
+
+        ##
+        # @return [Email] The email address of the contact.
+        attr_accessor :email_address
+
+        ##
+        # @return [String] The phone number of the contact.
+        attr_accessor :phone
+
+        ##
+        # @return [String] The fax number of the contact.
+        attr_accessor :fax
+
+        ##
+        # @return [String] The first line of the address.
+        attr_accessor :address1
+
+        ##
+        # @return [String] The second line of the address.
+        attr_accessor :address2
+
+        ##
+        # @return [String] The third line of the address.
+        attr_accessor :address3
+
+        ##
+        # @return [String] The city of the address.
+        attr_accessor :city
+
+        ##
+        # @return [String] The state/region of the address.
+        attr_accessor :state_region
+
+        ##
+        # @return [String] The postal/zip code of the address.
+        attr_accessor :postal_code
+
+        ##
+        # @return [String] The two character country code of the address. This will be validated by the /api/v1/countries data set
+        attr_accessor :country_code
+
+        ##
+        # @return [Boolean] Flag indicating if the contact is active.
+        attr_accessor :is_active
+
+        ##
+        # @return [Uri] The webpage url of the contact.
+        attr_accessor :webpage_url
+
+        ##
+        # @return [Uri] The picture/avatar url of the contact.
+        attr_accessor :picture_url
+
+        ##
+        # @return [Date-time] The date on which this record was created.
+        attr_accessor :created
+
+        ##
+        # @return [Uuid] The ID of the user who created this contact.
+        attr_accessor :created_user_id
+
+        ##
+        # @return [Date-time] The date on which this record was last modified.
+        attr_accessor :modified
+
+        ##
+        # @return [Uuid] The ID of the user who last modified this contact.
+        attr_accessor :modified_user_id
+
+        ##
+        # @return [Uuid] AppEnrollmentId for this record; used for mapping purposes.
+        attr_accessor :app_enrollment_id
+
+        ##
+        # @return [NoteModel] All notes attached to this company. To retrieve this collection, specify `Notes` in the "Include" parameter for your query.
+        attr_accessor :notes
+
+        ##
+        # @return [AttachmentModel] All attachments attached to this company. To retrieve this collection, specify `Attachments` in the "Include" parameter for your query.
+        attr_accessor :attachments
+
+        ##
+        # @return [CustomFieldDefinitionModel] All definitions attached to this contact. 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 contact. To retrieve this collection, specify `Attachments` 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={})
+            {
+                'contactId' => @contact_id,
+                'companyId' => @company_id,
+                'groupKey' => @group_key,
+                'erpKey' => @erp_key,
+                'contactName' => @contact_name,
+                'contactCode' => @contact_code,
+                'title' => @title,
+                'roleCode' => @role_code,
+                'emailAddress' => @email_address,
+                'phone' => @phone,
+                'fax' => @fax,
+                'address1' => @address1,
+                'address2' => @address2,
+                'address3' => @address3,
+                'city' => @city,
+                'stateRegion' => @state_region,
+                'postalCode' => @postal_code,
+                'countryCode' => @country_code,
+                'isActive' => @is_active,
+                'webpageUrl' => @webpage_url,
+                'pictureUrl' => @picture_url,
+                'created' => @created,
+                'createdUserId' => @created_user_id,
+                'modified' => @modified,
+                'modifiedUserId' => @modified_user_id,
+                'appEnrollmentId' => @app_enrollment_id,
+                '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/country_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
+
+    ##
+    # Country model for ISO-3166
+    class CountryModel
+
+        ##
+        # Initialize the CountryModel using the provided prototype
+        def initialize(params = {})
+            @name = params.dig(:name)
+            @alpha2 = params.dig(:alpha2)
+            @alpha3 = params.dig(:alpha3)
+            @country_code = params.dig(:country_code)
+            @region = params.dig(:region)
+            @sub_region = params.dig(:sub_region)
+            @intermediate_region = params.dig(:intermediate_region)
+            @region_code = params.dig(:region_code)
+            @sub_region_code = params.dig(:sub_region_code)
+            @intermediate_region_code = params.dig(:intermediate_region_code)
+            @french_name = params.dig(:french_name)
+            @aliases = params.dig(:aliases)
+        end
+
+        ##
+        # @return [String] Name of the country
+        attr_accessor :name
+
+        ##
+        # @return [String] 2 letter alphabetic code for the given country
+        attr_accessor :alpha2
+
+        ##
+        # @return [String] 3 letter alphabetic code for the given country
+        attr_accessor :alpha3
+
+        ##
+        # @return [Int32] Unique 3 digit number for the given country
+        attr_accessor :country_code
+
+        ##
+        # @return [String] Region of the country
+        attr_accessor :region
+
+        ##
+        # @return [String] Subregion of the country
+        attr_accessor :sub_region
+
+        ##
+        # @return [String] Intermediate region of the country
+        attr_accessor :intermediate_region
+
+        ##
+        # @return [Int32] Numeric code for a region
+        attr_accessor :region_code
+
+        ##
+        # @return [Int32] Numeric code for a subregion
+        attr_accessor :sub_region_code
+
+        ##
+        # @return [Int32] Numeric code for an intermediate region
+        attr_accessor :intermediate_region_code
+
+        ##
+        # @return [String] French name of the country
+        attr_accessor :french_name
+
+        ##
+        # @return [String] A different name for a country
+        attr_accessor :aliases
+
+        ##
+        # @return [object] This object as a JSON key-value structure
+        def as_json(options={})
+            {
+                'name' => @name,
+                'alpha2' => @alpha2,
+                'alpha3' => @alpha3,
+                'countryCode' => @country_code,
+                'region' => @region,
+                'subRegion' => @sub_region,
+                'intermediateRegion' => @intermediate_region,
+                'regionCode' => @region_code,
+                'subRegionCode' => @sub_region_code,
+                'intermediateRegionCode' => @intermediate_region_code,
+                'frenchName' => @french_name,
+                '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/credit_memo_applied_model.rb

@@ -0,0 +1,150 @@
+#
+# 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
+
+    ##
+    # Credit Memos reflect credits granted to a customer for various reasons, such as discounts or refunds.
+    # Credit Memos may be applied to Invoices as Payments. When a Credit Memo is applied as payment to an Invoice,
+    # Lockstep creates a Credit Memo Application record to track the amount from the Credit Memo that was applied
+    # as payment to the Invoice. You can examine Credit Memo Application records to track which Invoices were paid
+    # using this Credit.
+    class CreditMemoAppliedModel
+
+        ##
+        # Initialize the CreditMemoAppliedModel using the provided prototype
+        def initialize(params = {})
+            @credit_memo_applied_id = params.dig(:credit_memo_applied_id)
+            @group_key = params.dig(:group_key)
+            @invoice_id = params.dig(:invoice_id)
+            @credit_memo_invoice_id = params.dig(:credit_memo_invoice_id)
+            @erp_key = params.dig(:erp_key)
+            @entry_number = params.dig(:entry_number)
+            @apply_to_invoice_date = params.dig(:apply_to_invoice_date)
+            @credit_memo_applied_amount = params.dig(:credit_memo_applied_amount)
+            @created = params.dig(:created)
+            @created_user_id = params.dig(:created_user_id)
+            @modified = params.dig(:modified)
+            @modified_user_id = params.dig(:modified_user_id)
+            @app_enrollment_id = params.dig(:app_enrollment_id)
+            @attachments = params.dig(:attachments)
+            @notes = params.dig(:notes)
+            @custom_field_definitions = params.dig(:custom_field_definitions)
+            @custom_field_values = params.dig(:custom_field_values)
+        end
+
+        ##
+        # @return [Uuid] The unique ID of this record, automatically assigned by Lockstep when this record is added to the Lockstep platform. For the ID of this record in its originating financial system, see `ErpKey`.
+        attr_accessor :credit_memo_applied_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 [Uuid] The id of the invoice
+        attr_accessor :invoice_id
+
+        ##
+        # @return [Uuid] The id of the credit memo invoice
+        attr_accessor :credit_memo_invoice_id
+
+        ##
+        # @return [String] The unique ID of this record as it was known in its originating financial system. If this company record was imported from a financial system, it will have the value `ErpKey` set to the original primary key number of the record as it was known in the originating financial system. If this record was not imported, this value will be `null`. For more information, see [Identity Columns](https://developer.lockstep.io/docs/identity-columns).
+        attr_accessor :erp_key
+
+        ##
+        # @return [Int32] Reference number for the applied credit memo.
+        attr_accessor :entry_number
+
+        ##
+        # @return [Date-time] Date payment applied to credit memo.
+        attr_accessor :apply_to_invoice_date
+
+        ##
+        # @return [Double] Amount applied to credit memo.
+        attr_accessor :credit_memo_applied_amount
+
+        ##
+        # @return [Date-time] Date credit memo applied record was created.
+        attr_accessor :created
+
+        ##
+        # @return [Uuid] The id of the user who created this applied credit memo.
+        attr_accessor :created_user_id
+
+        ##
+        # @return [Date-time] Date credit memo applied record was modified.
+        attr_accessor :modified
+
+        ##
+        # @return [Uuid] The id of the user who modified this applied credit memo.
+        attr_accessor :modified_user_id
+
+        ##
+        # @return [Uuid] AppEnrollmentId for this record; used for mapping purposes.
+        attr_accessor :app_enrollment_id
+
+        ##
+        # @return [AttachmentModel] All attachments attached to applied Credit Memo. To retrieve this collection, specify `Attachments` in the "Include" parameter for your query.
+        attr_accessor :attachments
+
+        ##
+        # @return [NoteModel] All notes attached to this applied Credit Memo. To retrieve this collection, specify `Notes` in the "Include" parameter for your query.
+        attr_accessor :notes
+
+        ##
+        # @return [CustomFieldDefinitionModel] All definitions attached to this applied Credit Memo. 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 Credit Memo. 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={})
+            {
+                'creditMemoAppliedId' => @credit_memo_applied_id,
+                'groupKey' => @group_key,
+                'invoiceId' => @invoice_id,
+                'creditMemoInvoiceId' => @credit_memo_invoice_id,
+                'erpKey' => @erp_key,
+                'entryNumber' => @entry_number,
+                'applyToInvoiceDate' => @apply_to_invoice_date,
+                'creditMemoAppliedAmount' => @credit_memo_applied_amount,
+                'created' => @created,
+                'createdUserId' => @created_user_id,
+                'modified' => @modified,
+                'modifiedUserId' => @modified_user_id,
+                'appEnrollmentId' => @app_enrollment_id,
+                'attachments' => @attachments,
+                'notes' => @notes,
+                '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/credit_memo_invoice_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
+
+    ##
+    # Contains information about a credit memo invoice
+    class CreditMemoInvoiceModel
+
+        ##
+        # Initialize the CreditMemoInvoiceModel using the provided prototype
+        def initialize(params = {})
+            @group_key = params.dig(:group_key)
+            @credit_memo_applied_id = params.dig(:credit_memo_applied_id)
+            @invoice_id = params.dig(:invoice_id)
+            @credit_memo_invoice_id = params.dig(:credit_memo_invoice_id)
+            @apply_to_invoice_date = params.dig(:apply_to_invoice_date)
+            @credit_memo_applied_amount = params.dig(:credit_memo_applied_amount)
+            @reference_code = params.dig(:reference_code)
+            @company_id = params.dig(:company_id)
+            @customer_id = params.dig(:customer_id)
+            @invoice_status_code = params.dig(:invoice_status_code)
+            @total_amount = params.dig(:total_amount)
+            @outstanding_balance_amount = params.dig(:outstanding_balance_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 [Uuid] The unique ID of this record, automatically assigned by Lockstep when this record is added to the Lockstep platform.
+        attr_accessor :credit_memo_applied_id
+
+        ##
+        # @return [Uuid] The id of the invoice
+        attr_accessor :invoice_id
+
+        ##
+        # @return [Uuid] The id of the credit memo invoice
+        attr_accessor :credit_memo_invoice_id
+
+        ##
+        # @return [Date] Date invoice applied to credit memo.
+        attr_accessor :apply_to_invoice_date
+
+        ##
+        # @return [Double] Amount applied to credit memo.
+        attr_accessor :credit_memo_applied_amount
+
+        ##
+        # @return [String] An additional reference code that is sometimes used to identify this invoice. The meaning of this field is specific to the ERP or accounting system used by the user.
+        attr_accessor :reference_code
+
+        ##
+        # @return [Uuid] The ID number of the company that created this invoice.
+        attr_accessor :company_id
+
+        ##
+        # @return [Uuid] The ID number of the counterparty for the invoice, for example, a customer or vendor.
+        attr_accessor :customer_id
+
+        ##
+        # @return [String] A code identifying the status of this invoice.
+        attr_accessor :invoice_status_code
+
+        ##
+        # @return [Double] The total value of this invoice, inclusive of all taxes and line items.
+        attr_accessor :total_amount
+
+        ##
+        # @return [Double] The remaining balance value of this invoice.
+        attr_accessor :outstanding_balance_amount
+
+        ##
+        # @return [object] This object as a JSON key-value structure
+        def as_json(options={})
+            {
+                'groupKey' => @group_key,
+                'creditMemoAppliedId' => @credit_memo_applied_id,
+                'invoiceId' => @invoice_id,
+                'creditMemoInvoiceId' => @credit_memo_invoice_id,
+                'applyToInvoiceDate' => @apply_to_invoice_date,
+                'creditMemoAppliedAmount' => @credit_memo_applied_amount,
+                'referenceCode' => @reference_code,
+                'companyId' => @company_id,
+                'customerId' => @customer_id,
+                'invoiceStatusCode' => @invoice_status_code,
+                'totalAmount' => @total_amount,
+                'outstandingBalanceAmount' => @outstanding_balance_amount,
+            }
+        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/currency_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
+
+    ##
+    # Represents an ISO-4217 currency code definition
+    class CurrencyModel
+
+        ##
+        # Initialize the CurrencyModel using the provided prototype
+        def initialize(params = {})
+            @alpha_code = params.dig(:alpha_code)
+            @numeric_code = params.dig(:numeric_code)
+            @currency_name = params.dig(:currency_name)
+            @minor_unit = params.dig(:minor_unit)
+            @symbol = params.dig(:symbol)
+        end
+
+        ##
+        # @return [String] Alphabetic code for the given currency
+        attr_accessor :alpha_code
+
+        ##
+        # @return [String] Numeric code for the given currency
+        attr_accessor :numeric_code
+
+        ##
+        # @return [String] Name of currency
+        attr_accessor :currency_name
+
+        ##
+        # @return [Int32] Number of places after the decimal for this currency
+        attr_accessor :minor_unit
+
+        ##
+        # @return [String] Symbol for the given currency
+        attr_accessor :symbol
+
+        ##
+        # @return [object] This object as a JSON key-value structure
+        def as_json(options={})
+            {
+                'alphaCode' => @alpha_code,
+                'numericCode' => @numeric_code,
+                'currencyName' => @currency_name,
+                'minorUnit' => @minor_unit,
+                'symbol' => @symbol,
+            }
+        end
+
+        ##
+        # @return [String] This object converted to a JSON string
+        def to_json(*options)
+            "[#{as_json(*options).to_json(*options)}]"
+        end
+    end
+end