lockstep_sdk 2022.4.32.0

data/lib/lockstep_sdk/models/invite_data_model.rb

@@ -0,0 +1,56 @@
+#
+# Lockstep Software Development Kit for Ruby
+#
+# (c) 2021-2022 Lockstep, Inc.
+#
+# For the full copyright and license information, please view the LICENSE
+# file that was distributed with this source code.
+#
+# @author     Ted Spence <tspence@lockstep.io>
+# @author     Manish Narayan B S <manish.n@lockstep.io>
+# @author     Rishi Rajkumar Jawahar <rjawahar@lockstep.io>
+# @copyright  2021-2022 Lockstep, Inc.
+# @version    2022.4
+# @link       https://github.com/Lockstep-Network/lockstep-sdk-ruby
+#
+
+
+require 'json'
+
+module LockstepSdk
+
+    ##
+    # Model containing information about a user for the invite/onboarding process.
+    class InviteDataModel
+
+        ##
+        # Initialize the InviteDataModel using the provided prototype
+        def initialize(params = {})
+            @email = params.dig(:email)
+            @user_status = params.dig(:user_status)
+        end
+
+        ##
+        # @return [String] The email address of the invited user.
+        attr_accessor :email
+
+        ##
+        # @return [String] The status of the user.
+        attr_accessor :user_status
+
+        ##
+        # @return [object] This object as a JSON key-value structure
+        def as_json(options={})
+            {
+                'email' => @email,
+                'userStatus' => @user_status,
+            }
+        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/invite_model.rb

@@ -0,0 +1,68 @@
+#
+# Lockstep Software Development Kit for Ruby
+#
+# (c) 2021-2022 Lockstep, Inc.
+#
+# For the full copyright and license information, please view the LICENSE
+# file that was distributed with this source code.
+#
+# @author     Ted Spence <tspence@lockstep.io>
+# @author     Manish Narayan B S <manish.n@lockstep.io>
+# @author     Rishi Rajkumar Jawahar <rjawahar@lockstep.io>
+# @copyright  2021-2022 Lockstep, Inc.
+# @version    2022.4
+# @link       https://github.com/Lockstep-Network/lockstep-sdk-ruby
+#
+
+
+require 'json'
+
+module LockstepSdk
+
+    ##
+    # Model from the User invite process
+    class InviteModel
+
+        ##
+        # Initialize the InviteModel using the provided prototype
+        def initialize(params = {})
+            @email = params.dig(:email)
+            @success = params.dig(:success)
+            @invited_user = params.dig(:invited_user)
+            @error_message = params.dig(:error_message)
+        end
+
+        ##
+        # @return [String] The invited email address
+        attr_accessor :email
+
+        ##
+        # @return [Boolean] True if the invite was sent successfully
+        attr_accessor :success
+
+        ##
+        # @return [UserAccountModel] The invited user, may be null if the user could not be invited
+        attr_accessor :invited_user
+
+        ##
+        # @return [String] The error message if the invite was not successful
+        attr_accessor :error_message
+
+        ##
+        # @return [object] This object as a JSON key-value structure
+        def as_json(options={})
+            {
+                'email' => @email,
+                'success' => @success,
+                'invitedUser' => @invited_user,
+                'errorMessage' => @error_message,
+            }
+        end
+
+        ##
+        # @return [String] This object converted to a JSON string
+        def to_json(*options)
+            "[#{as_json(*options).to_json(*options)}]"
+        end
+    end
+end

data/lib/lockstep_sdk/models/invite_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 to invite a new user to your accounting group
+    class InviteSubmitModel
+
+        ##
+        # Initialize the InviteSubmitModel using the provided prototype
+        def initialize(params = {})
+            @email = params.dig(:email)
+        end
+
+        ##
+        # @return [Email] The email address of the user to invite
+        attr_accessor :email
+
+        ##
+        # @return [object] This object as a JSON key-value structure
+        def as_json(options={})
+            {
+                'email' => @email,
+            }
+        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_address_model.rb

@@ -0,0 +1,140 @@
+#
+# 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 single address for an invoice
+    class InvoiceAddressModel
+
+        ##
+        # Initialize the InvoiceAddressModel using the provided prototype
+        def initialize(params = {})
+            @invoice_address_id = params.dig(:invoice_address_id)
+            @group_key = params.dig(:group_key)
+            @invoice_id = params.dig(:invoice_id)
+            @line1 = params.dig(:line1)
+            @line2 = params.dig(:line2)
+            @line3 = params.dig(:line3)
+            @city = params.dig(:city)
+            @region = params.dig(:region)
+            @postal_code = params.dig(:postal_code)
+            @country = params.dig(:country)
+            @latitude = params.dig(:latitude)
+            @longitude = params.dig(:longitude)
+            @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 :invoice_address_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 number of the invoice this address belongs to
+        attr_accessor :invoice_id
+
+        ##
+        # @return [String] The first line of the address.
+        attr_accessor :line1
+
+        ##
+        # @return [String] The second line of the address.
+        attr_accessor :line2
+
+        ##
+        # @return [String] The third line of the address.
+        attr_accessor :line3
+
+        ##
+        # @return [String] The name of the city for this address.
+        attr_accessor :city
+
+        ##
+        # @return [String] The state or region part of this address.
+        attr_accessor :region
+
+        ##
+        # @return [String] The postal code for this address.
+        attr_accessor :postal_code
+
+        ##
+        # @return [String] The country for this address.
+        attr_accessor :country
+
+        ##
+        # @return [Float] The latitude of this address, if available.
+        attr_accessor :latitude
+
+        ##
+        # @return [Float] The longitude of this address, if available.
+        attr_accessor :longitude
+
+        ##
+        # @return [Date-time] The date on which this address record was created.
+        attr_accessor :created
+
+        ##
+        # @return [Uuid] The ID number of the user who created this address.
+        attr_accessor :created_user_id
+
+        ##
+        # @return [Date-time] The date on which this address record was last modified.
+        attr_accessor :modified
+
+        ##
+        # @return [Uuid] The ID number of the user who most recently modified this address.
+        attr_accessor :modified_user_id
+
+        ##
+        # @return [object] This object as a JSON key-value structure
+        def as_json(options={})
+            {
+                'invoiceAddressId' => @invoice_address_id,
+                'groupKey' => @group_key,
+                'invoiceId' => @invoice_id,
+                'line1' => @line1,
+                'line2' => @line2,
+                'line3' => @line3,
+                'city' => @city,
+                'region' => @region,
+                'postalCode' => @postal_code,
+                'country' => @country,
+                'latitude' => @latitude,
+                'longitude' => @longitude,
+                '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/models/invoice_history_model.rb

@@ -0,0 +1,238 @@
+#
+# 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 Invoice represents a bill sent from one company to another.  The Lockstep Platform tracks changes to
+    # each Invoice so that you can observe the changes over time.  You can view the InvoiceHistory list to
+    # monitor and observe the changes of this Invoice and track the dates when changes occurred.
+    class InvoiceHistoryModel
+
+        ##
+        # Initialize the InvoiceHistoryModel using the provided prototype
+        def initialize(params = {})
+            @group_key = params.dig(:group_key)
+            @invoice_history_id = params.dig(:invoice_history_id)
+            @invoice_id = params.dig(:invoice_id)
+            @company_id = params.dig(:company_id)
+            @customer_id = params.dig(:customer_id)
+            @erp_key = params.dig(:erp_key)
+            @purchase_order_code = params.dig(:purchase_order_code)
+            @reference_code = params.dig(:reference_code)
+            @salesperson_code = params.dig(:salesperson_code)
+            @salesperson_name = params.dig(:salesperson_name)
+            @invoice_type_code = params.dig(:invoice_type_code)
+            @invoice_status_code = params.dig(:invoice_status_code)
+            @terms_code = params.dig(:terms_code)
+            @special_terms = params.dig(:special_terms)
+            @currency_code = params.dig(:currency_code)
+            @total_amount = params.dig(:total_amount)
+            @sales_tax_amount = params.dig(:sales_tax_amount)
+            @discount_amount = params.dig(:discount_amount)
+            @outstanding_balance_amount = params.dig(:outstanding_balance_amount)
+            @invoice_date = params.dig(:invoice_date)
+            @discount_date = params.dig(:discount_date)
+            @posted_date = params.dig(:posted_date)
+            @invoice_closed_date = params.dig(:invoice_closed_date)
+            @payment_due_date = params.dig(:payment_due_date)
+            @imported_date = params.dig(:imported_date)
+            @primary_origin_address_id = params.dig(:primary_origin_address_id)
+            @primary_bill_to_address_id = params.dig(:primary_bill_to_address_id)
+            @primary_ship_to_address_id = params.dig(:primary_ship_to_address_id)
+            @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 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 number of this invoice history entry.
+        attr_accessor :invoice_history_id
+
+        ##
+        # @return [Uuid] The unique ID of the Invoice represented by this history entry. This ID was automatically assigned by Lockstep to the Invoice record when it was added to the Lockstep platform. For the ID of this record in its originating financial system, see `ErpKey`.
+        attr_accessor :invoice_id
+
+        ##
+        # @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] 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 purchase order code as it exists in the user's ERP or accounting system.
+        attr_accessor :purchase_order_code
+
+        ##
+        # @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 [String] A code identifying the salesperson responsible for writing this invoice.
+        attr_accessor :salesperson_code
+
+        ##
+        # @return [String] A string identifying the salesperson responsible for writing this invoice.
+        attr_accessor :salesperson_name
+
+        ##
+        # @return [String] A code identifying the type of this invoice.
+        attr_accessor :invoice_type_code
+
+        ##
+        # @return [String] A code identifying the status of this invoice.
+        attr_accessor :invoice_status_code
+
+        ##
+        # @return [String] A code identifying the terms given to the purchaser.
+        attr_accessor :terms_code
+
+        ##
+        # @return [String] If the customer negotiated any special terms different from the standard terms above, describe them here.
+        attr_accessor :special_terms
+
+        ##
+        # @return [String] The three-character ISO 4217 currency code used for this invoice. This will be validated by the /api/v1/currencies data set
+        attr_accessor :currency_code
+
+        ##
+        # @return [Double] The total value of this invoice, inclusive of all taxes and line items.
+        attr_accessor :total_amount
+
+        ##
+        # @return [Double] The total sales (or transactional) tax calculated for this invoice.
+        attr_accessor :sales_tax_amount
+
+        ##
+        # @return [Double] The total discounts given by the seller to the buyer on this invoice.
+        attr_accessor :discount_amount
+
+        ##
+        # @return [Double] The remaining balance value of this invoice.
+        attr_accessor :outstanding_balance_amount
+
+        ##
+        # @return [Date] The reporting date for this invoice.
+        attr_accessor :invoice_date
+
+        ##
+        # @return [Date] The date when discounts were adjusted for this invoice.
+        attr_accessor :discount_date
+
+        ##
+        # @return [Date] The date when this invoice posted to the company's general ledger.
+        attr_accessor :posted_date
+
+        ##
+        # @return [Date] The date when the invoice was closed and finalized after completion of all payments and delivery of all products and services.
+        attr_accessor :invoice_closed_date
+
+        ##
+        # @return [Date] The date when the remaining outstanding balance is due.
+        attr_accessor :payment_due_date
+
+        ##
+        # @return [Date-time] The date and time when this record was imported from the user's ERP or accounting system.
+        attr_accessor :imported_date
+
+        ##
+        # @return [Uuid] The ID number of the invoice's origination address
+        attr_accessor :primary_origin_address_id
+
+        ##
+        # @return [Uuid] The ID number of the invoice's bill-to address
+        attr_accessor :primary_bill_to_address_id
+
+        ##
+        # @return [Uuid] The ID number of the invoice's ship-to address
+        attr_accessor :primary_ship_to_address_id
+
+        ##
+        # @return [Date-time] The date on which this invoice record was created.
+        attr_accessor :created
+
+        ##
+        # @return [Uuid] The ID number of the user who created this invoice.
+        attr_accessor :created_user_id
+
+        ##
+        # @return [Date-time] The date on which this invoice record was last modified.
+        attr_accessor :modified
+
+        ##
+        # @return [Uuid] The ID number of the user who most recently modified this invoice.
+        attr_accessor :modified_user_id
+
+        ##
+        # @return [object] This object as a JSON key-value structure
+        def as_json(options={})
+            {
+                'groupKey' => @group_key,
+                'invoiceHistoryId' => @invoice_history_id,
+                'invoiceId' => @invoice_id,
+                'companyId' => @company_id,
+                'customerId' => @customer_id,
+                'erpKey' => @erp_key,
+                'purchaseOrderCode' => @purchase_order_code,
+                'referenceCode' => @reference_code,
+                'salespersonCode' => @salesperson_code,
+                'salespersonName' => @salesperson_name,
+                'invoiceTypeCode' => @invoice_type_code,
+                'invoiceStatusCode' => @invoice_status_code,
+                'termsCode' => @terms_code,
+                'specialTerms' => @special_terms,
+                'currencyCode' => @currency_code,
+                'totalAmount' => @total_amount,
+                'salesTaxAmount' => @sales_tax_amount,
+                'discountAmount' => @discount_amount,
+                'outstandingBalanceAmount' => @outstanding_balance_amount,
+                'invoiceDate' => @invoice_date,
+                'discountDate' => @discount_date,
+                'postedDate' => @posted_date,
+                'invoiceClosedDate' => @invoice_closed_date,
+                'paymentDueDate' => @payment_due_date,
+                'importedDate' => @imported_date,
+                'primaryOriginAddressId' => @primary_origin_address_id,
+                'primaryBillToAddressId' => @primary_bill_to_address_id,
+                'primaryShipToAddressId' => @primary_ship_to_address_id,
+                '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