lockstep_sdk 2023.11.28.0 → 2023.13.37.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: dc1ed33c76a8102443c13fe87194a85b766cb7fe507f696d0ec6a32e5bff01d1
-  data.tar.gz: 381aae0f3e80a840b7aafa210df73d9e2349f0a380ef66562e8f5a00bc5b0a4a
+  metadata.gz: 94c3d82bb006438d2d6083a2a1f777ec72d8e3e53a8e9f9d15f97c739c5c7fa3
+  data.tar.gz: f4a97901a63f1ff48303b5439c197a013255e160aea87e32e5e4da928381a147
 SHA512:
-  metadata.gz: b104bc2508ef1428c60f3d3004af74d666697028cac43b7b289f5f9e8cec3b1f2333245603247cba12fec53fa6aa9676842aa6c576d0ae81837d1bcfc8477b46
-  data.tar.gz: 8ae4e1fc63e8c4181c1e4c4ed8ac9bf1a1eaf84cfc03b81144e9f63540e644355d8d3246c506ce4f9fe6d864817d9f3e0931752b59e639218b971df54ef3995f
+  metadata.gz: 15a56c02466b9db83340d47aaca8d230fbd44be948d30c034c302a203ebb1309a3286522d15195fe59704676e4dcdef012b7d50f303a37929df5dd69b7e12a91
+  data.tar.gz: c92e2b1e5e991cc98029cecd28adfcd780a643bd223bc1682bdfc7e7a1d7bf68bd60fbe351b77df0ba2e0818638ac1d7b899dddbe04e7863e1f0c1bdcc929ce2

data/lib/lockstep_sdk/clients/transcriptions_client.rb

@@ -151,4 +151,15 @@ class TranscriptionsClient
         params = {:filter => filter, :include => include_param, :order => order, :pageSize => page_size, :pageNumber => page_number}
         @connection.request(:get, path, nil, params)
     end
+
+    ##
+    # Retrieves the Email Reply Generator Response containing a list of email reply suggestions
+    #
+    # An Email Reply Generator Request represents an email to be sent for a list of email reply suggestions.
+    #
+    # @param body [EmailReplyGeneratorRequest] The Email Reply Generator Request to be sent
+    def retrieve_an_emailreplygeneratorresponse(body:)
+        path = "/api/v1/Transcriptions/email-reply-suggestions"
+        @connection.request(:post, path, body, nil)
+    end
 end

data/lib/lockstep_sdk/lockstep_api.rb

@@ -9,7 +9,7 @@
 # @author     Lockstep Network <support@lockstep.io>
 #             Manish Narayan B S <manish.n@lockstep.io>, Rishi Rajkumar Jawahar <rjawahar@lockstep.io>
 # @copyright  2021-2023 Lockstep, Inc.
-# @version    2023.11.28
+# @version    2023.13.37
 # @link       https://github.com/Lockstep-Network/lockstep-sdk-ruby
 #
 
@@ -194,7 +194,7 @@ module lockstep_sdk
         #
         # @param env [string] Either "sbx", "prd", or the URI of the server, ending in a slash (/)
         def initialize(env)
-            @version = "2023.11.28.0"
+            @version = "2023.13.37.0"
             @env = case env
                 when "sbx"
                     "https://api.sbx.lockstep.io/"
@@ -307,7 +307,7 @@ module lockstep_sdk
             request["Accept"] = 'application/json'
             request["Content-Type"] = 'application/*+json'
             request["SdkType"] = 'Ruby'
-            request["SdkVersion"] = '2023.11.28.0'
+            request["SdkVersion"] = '2023.13.37.0'
             request["MachineName"] = Socket.gethostname
             request.body = body
 

data/lib/lockstep_sdk/models/credit_memo_applied_model.rb

@@ -32,6 +32,8 @@ module LockstepSdk
             @invoice_id = params.dig(:invoice_id)
             @credit_memo_invoice_id = params.dig(:credit_memo_invoice_id)
             @erp_key = params.dig(:erp_key)
+            @erp_write_status = params.dig(:erp_write_status)
+            @erp_write_status_name = params.dig(:erp_write_status_name)
             @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)
@@ -40,6 +42,7 @@ module LockstepSdk
             @modified = params.dig(:modified)
             @modified_user_id = params.dig(:modified_user_id)
             @app_enrollment_id = params.dig(:app_enrollment_id)
+            @source_modified_date = params.dig(:source_modified_date)
             @attachments = params.dig(:attachments)
             @notes = params.dig(:notes)
             @custom_field_definitions = params.dig(:custom_field_definitions)
@@ -68,6 +71,14 @@ module LockstepSdk
         # @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 [ErpWriteStatuses] Possible statuses for a record that supports ERP write.
+        attr_accessor :erp_write_status
+
+        ##
+        # @return [String] The name of the ErpWriteStatus for this credit memo application
+        attr_accessor :erp_write_status_name
+
         ##
         # @return [Int32] Reference number for the applied credit memo.
         attr_accessor :entry_number
@@ -100,6 +111,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 [Date-time] The date on which this record was last modified in source ERP.
+        attr_accessor :source_modified_date
+
         ##
         # @return [AttachmentModel] A collection of attachments linked to this record. To retrieve this collection, specify `Attachments` in the `include` parameter when retrieving data. To create an attachment, use the [Upload Attachment](https://developer.lockstep.io/reference/post_api-v1-attachments) endpoint with the `TableKey` to `CreditMemoApplied` and the `ObjectKey` set to the `CreditMemoAppliedId` for this record. For more information on extensibility, see [linking extensible metadata to objects](https://developer.lockstep.io/docs/custom-fields#linking-metadata-to-an-object).
         attr_accessor :attachments
@@ -133,6 +148,8 @@ module LockstepSdk
                 'invoiceId' => @invoice_id,
                 'creditMemoInvoiceId' => @credit_memo_invoice_id,
                 'erpKey' => @erp_key,
+                'erpWriteStatus' => @erp_write_status,
+                'erpWriteStatusName' => @erp_write_status_name,
                 'entryNumber' => @entry_number,
                 'applyToInvoiceDate' => @apply_to_invoice_date,
                 'creditMemoAppliedAmount' => @credit_memo_applied_amount,
@@ -141,6 +158,7 @@ module LockstepSdk
                 'modified' => @modified,
                 'modifiedUserId' => @modified_user_id,
                 'appEnrollmentId' => @app_enrollment_id,
+                'sourceModifiedDate' => @source_modified_date,
                 'attachments' => @attachments,
                 'notes' => @notes,
                 'customFieldDefinitions' => @custom_field_definitions,

data/lib/lockstep_sdk/models/email_reply_generator_request.rb

@@ -0,0 +1,59 @@
+#
+# 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
+
+    ##
+    # Represents the request to the SAGE GMS API
+    class EmailReplyGeneratorRequest
+
+        ##
+        # Initialize the EmailReplyGeneratorRequest using the provided prototype
+        def initialize(params = {})
+            @date = params.dig(:date)
+            @body = params.dig(:body)
+            @subject = params.dig(:subject)
+        end
+
+        ##
+        # @return [Date-time] The date associated with the email
+        attr_accessor :date
+
+        ##
+        # @return [String] The body associated with the email
+        attr_accessor :body
+
+        ##
+        # @return [String] The subject associated with the email
+        attr_accessor :subject
+
+        ##
+        # @return [object] This object as a JSON key-value structure
+        def as_json(options={})
+            {
+                'date' => @date,
+                'body' => @body,
+                'subject' => @subject,
+            }
+        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/email_reply_generator_response.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
+
+    ##
+    # Represents the response from SAGE GMS API
+    class EmailReplyGeneratorResponse
+
+        ##
+        # Initialize the EmailReplyGeneratorResponse using the provided prototype
+        def initialize(params = {})
+            @message_id = params.dig(:message_id)
+            @suggestions = params.dig(:suggestions)
+        end
+
+        ##
+        # @return [Uuid] The id for this request in the GMS system
+        attr_accessor :message_id
+
+        ##
+        # @return [EmailReplyGeneratorSuggestions] A list of suggested email reply responses
+        attr_accessor :suggestions
+
+        ##
+        # @return [object] This object as a JSON key-value structure
+        def as_json(options={})
+            {
+                'message_id' => @message_id,
+                'suggestions' => @suggestions,
+            }
+        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/email_reply_generator_suggestions.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
+
+    ##
+    # Represents the email reply suggestion from the SAGE GMS API
+    class EmailReplyGeneratorSuggestions
+
+        ##
+        # Initialize the EmailReplyGeneratorSuggestions using the provided prototype
+        def initialize(params = {})
+            @kind = params.dig(:kind)
+            @body = params.dig(:body)
+        end
+
+        ##
+        # @return [String] The kind of reply generated by the GMS Api
+        attr_accessor :kind
+
+        ##
+        # @return [String] The body of the reply generated by the GMS Api
+        attr_accessor :body
+
+        ##
+        # @return [object] This object as a JSON key-value structure
+        def as_json(options={})
+            {
+                'kind' => @kind,
+                'body' => @body,
+            }
+        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/financial_account_balance_history_model.rb

@@ -33,6 +33,8 @@ module LockstepSdk
             @period_end_date = params.dig(:period_end_date)
             @status = params.dig(:status)
             @balance = params.dig(:balance)
+            @balance_type = params.dig(:balance_type)
+            @balance_type_name = params.dig(:balance_type_name)
             @created = params.dig(:created)
             @created_user_id = params.dig(:created_user_id)
             @modified = params.dig(:modified)
@@ -79,6 +81,14 @@ module LockstepSdk
         # @return [Double] The current or end balance of this period.
         attr_accessor :balance
 
+        ##
+        # @return [FinancialAccountBalanceType] Financial Account Balance Types
+        attr_accessor :balance_type
+
+        ##
+        # @return [String] The name of the BalanceType for this record.
+        attr_accessor :balance_type_name
+
         ##
         # @return [Date-time] The date on which this financial account balance history record was created.
         attr_accessor :created
@@ -109,6 +119,8 @@ module LockstepSdk
                 'periodEndDate' => @period_end_date,
                 'status' => @status,
                 'balance' => @balance,
+                'balanceType' => @balance_type,
+                'balanceTypeName' => @balance_type_name,
                 'created' => @created,
                 'createdUserId' => @created_user_id,
                 'modified' => @modified,

data/lib/lockstep_sdk/models/financial_account_balance_history_sync_model.rb

@@ -42,6 +42,7 @@ module LockstepSdk
             @period_end_date = params.dig(:period_end_date)
             @status = params.dig(:status)
             @balance = params.dig(:balance)
+            @balance_type = params.dig(:balance_type)
         end
 
         ##
@@ -76,6 +77,10 @@ module LockstepSdk
         # @return [Double] The current or end balance of this period.
         attr_accessor :balance
 
+        ##
+        # @return [FinancialAccountBalanceType] The balance type of this period. If left null, the balance type will be determined by the balance.
+        attr_accessor :balance_type
+
         ##
         # @return [object] This object as a JSON key-value structure
         def as_json(options={})
@@ -88,6 +93,7 @@ module LockstepSdk
                 'periodEndDate' => @period_end_date,
                 'status' => @status,
                 'balance' => @balance,
+                'balanceType' => @balance_type,
             }
         end
 

data/lib/lockstep_sdk/models/payment_applied_model.rb

@@ -31,6 +31,8 @@ module LockstepSdk
             @invoice_id = params.dig(:invoice_id)
             @payment_id = params.dig(:payment_id)
             @erp_key = params.dig(:erp_key)
+            @erp_write_status = params.dig(:erp_write_status)
+            @erp_write_status_name = params.dig(:erp_write_status_name)
             @entry_number = params.dig(:entry_number)
             @apply_to_invoice_date = params.dig(:apply_to_invoice_date)
             @payment_applied_amount = params.dig(:payment_applied_amount)
@@ -39,6 +41,7 @@ module LockstepSdk
             @modified = params.dig(:modified)
             @modified_user_id = params.dig(:modified_user_id)
             @app_enrollment_id = params.dig(:app_enrollment_id)
+            @source_modified_date = params.dig(:source_modified_date)
             @payment = params.dig(:payment)
             @invoice = params.dig(:invoice)
         end
@@ -63,6 +66,14 @@ module LockstepSdk
         # @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 [ErpWriteStatuses] Possible statuses for a record that supports ERP write.
+        attr_accessor :erp_write_status
+
+        ##
+        # @return [String] The name of the ErpWriteStatus for this payment application
+        attr_accessor :erp_write_status_name
+
         ##
         # @return [Int32] The entry number of this payment application. This is often a journal entry number, confirmation code, or other identifying field for this payment application.
         attr_accessor :entry_number
@@ -95,6 +106,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 [Date-time] The date on which this record was last modified in source ERP.
+        attr_accessor :source_modified_date
+
         ##
         # @return [PaymentModel] The payment associated with this applied payment
         attr_accessor :payment
@@ -112,6 +127,8 @@ module LockstepSdk
                 'invoiceId' => @invoice_id,
                 'paymentId' => @payment_id,
                 'erpKey' => @erp_key,
+                'erpWriteStatus' => @erp_write_status,
+                'erpWriteStatusName' => @erp_write_status_name,
                 'entryNumber' => @entry_number,
                 'applyToInvoiceDate' => @apply_to_invoice_date,
                 'paymentAppliedAmount' => @payment_applied_amount,
@@ -120,6 +137,7 @@ module LockstepSdk
                 'modified' => @modified,
                 'modifiedUserId' => @modified_user_id,
                 'appEnrollmentId' => @app_enrollment_id,
+                'sourceModifiedDate' => @source_modified_date,
                 'payment' => @payment,
                 'invoice' => @invoice,
             }

data/lib/lockstep_sdk/models/payment_detail_model.rb

@@ -31,6 +31,8 @@ module LockstepSdk
             @reference_code = params.dig(:reference_code)
             @primary_contact = params.dig(:primary_contact)
             @email = params.dig(:email)
+            @erp_write_status = params.dig(:erp_write_status)
+            @erp_write_status_name = params.dig(:erp_write_status_name)
             @currency_code = params.dig(:currency_code)
             @payment_amount = params.dig(:payment_amount)
             @unapplied_amount = params.dig(:unapplied_amount)
@@ -84,6 +86,14 @@ module LockstepSdk
         # @return [String] The Email address of the Customer.
         attr_accessor :email
 
+        ##
+        # @return [ErpWriteStatuses] Possible statuses for a record that supports ERP write.
+        attr_accessor :erp_write_status
+
+        ##
+        # @return [String] The name of the ErpWriteStatus for this payment
+        attr_accessor :erp_write_status_name
+
         ##
         # @return [String] The currency code of the payment.
         attr_accessor :currency_code
@@ -172,6 +182,8 @@ module LockstepSdk
                 'referenceCode' => @reference_code,
                 'primaryContact' => @primary_contact,
                 'email' => @email,
+                'erpWriteStatus' => @erp_write_status,
+                'erpWriteStatusName' => @erp_write_status_name,
                 'currencyCode' => @currency_code,
                 'paymentAmount' => @payment_amount,
                 'unappliedAmount' => @unapplied_amount,

data/lib/lockstep_sdk/models/payment_model.rb

@@ -33,6 +33,8 @@ module LockstepSdk
             @payment_id = params.dig(:payment_id)
             @company_id = params.dig(:company_id)
             @erp_key = params.dig(:erp_key)
+            @erp_write_status = params.dig(:erp_write_status)
+            @erp_write_status_name = params.dig(:erp_write_status_name)
             @payment_type = params.dig(:payment_type)
             @tender_type = params.dig(:tender_type)
             @is_open = params.dig(:is_open)
@@ -54,6 +56,7 @@ module LockstepSdk
             @base_currency_payment_amount = params.dig(:base_currency_payment_amount)
             @base_currency_unapplied_amount = params.dig(:base_currency_unapplied_amount)
             @service_fabric_status = params.dig(:service_fabric_status)
+            @source_modified_date = params.dig(:source_modified_date)
             @applications = params.dig(:applications)
             @notes = params.dig(:notes)
             @attachments = params.dig(:attachments)
@@ -77,6 +80,14 @@ module LockstepSdk
         # @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 [ErpWriteStatuses] Possible statuses for a record that supports ERP write.
+        attr_accessor :erp_write_status
+
+        ##
+        # @return [String] The name of the ErpWriteStatus for this Payment
+        attr_accessor :erp_write_status_name
+
         ##
         # @return [String] The type of payment, AR Payment or AP Payment. Recognized PaymentType values are: * `AR Payment` - A payment made by a Customer to the Company * `AP Payment` - A payment made by the Company to a Vendor
         attr_accessor :payment_type
@@ -161,6 +172,10 @@ module LockstepSdk
         # @return [String] The status of this payment within Service Fabric. "UNAUTHORISED" "PENDING" "PAID" "PAID_OFFLINE" "FAILED" "CANCELLED" "REJECTED" "REFUNDED" "PARTIALLY" "PARTIALLY_REFUNDED"
         attr_accessor :service_fabric_status
 
+        ##
+        # @return [Date-time] The date on which this record was last modified in source ERP.
+        attr_accessor :source_modified_date
+
         ##
         # @return [PaymentAppliedModel] All applications this payment is associated with. To retrieve this collection, specify `Applications` in the "Include" parameter for your query.
         attr_accessor :applications
@@ -189,6 +204,8 @@ module LockstepSdk
                 'paymentId' => @payment_id,
                 'companyId' => @company_id,
                 'erpKey' => @erp_key,
+                'erpWriteStatus' => @erp_write_status,
+                'erpWriteStatusName' => @erp_write_status_name,
                 'paymentType' => @payment_type,
                 'tenderType' => @tender_type,
                 'isOpen' => @is_open,
@@ -210,6 +227,7 @@ module LockstepSdk
                 'baseCurrencyPaymentAmount' => @base_currency_payment_amount,
                 'baseCurrencyUnappliedAmount' => @base_currency_unapplied_amount,
                 'serviceFabricStatus' => @service_fabric_status,
+                'sourceModifiedDate' => @source_modified_date,
                 'applications' => @applications,
                 'notes' => @notes,
                 'attachments' => @attachments,

data/lib/lockstep_sdk/models/sync_entity_result_model.rb

@@ -29,6 +29,7 @@ module LockstepSdk
             @skip_count = params.dig(:skip_count)
             @error_count = params.dig(:error_count)
             @errors = params.dig(:errors)
+            @skips = params.dig(:skips)
         end
 
         ##
@@ -55,6 +56,10 @@ module LockstepSdk
         # @return [Object] The errors encountered during sync keyed by ERP key
         attr_accessor :errors
 
+        ##
+        # @return [Object] The records that were skipped during sync keyed by ERP key
+        attr_accessor :skips
+
         ##
         # @return [object] This object as a JSON key-value structure
         def as_json(options={})
@@ -65,6 +70,7 @@ module LockstepSdk
                 'skipCount' => @skip_count,
                 'errorCount' => @error_count,
                 'errors' => @errors,
+                'skips' => @skips,
             }
         end
 

data/lib/lockstep_sdk/version.rb

@@ -1,3 +1,3 @@
 module LockstepSdk
-    VERSION = "2023.11.28.0"
+    VERSION = "2023.13.37.0"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: lockstep_sdk
 version: !ruby/object:Gem::Version
-  version: 2023.11.28.0
+  version: 2023.13.37.0
 platform: ruby
 authors:
 - Lockstep
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2023-03-22 00:00:00.000000000 Z
+date: 2023-03-31 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: awrence
@@ -120,6 +120,9 @@ files:
 - lib/lockstep_sdk/models/developer_account_submit_model.rb
 - lib/lockstep_sdk/models/dpo_summary_group_total_model.rb
 - lib/lockstep_sdk/models/dpo_summary_model.rb
+- lib/lockstep_sdk/models/email_reply_generator_request.rb
+- lib/lockstep_sdk/models/email_reply_generator_response.rb
+- lib/lockstep_sdk/models/email_reply_generator_suggestions.rb
 - lib/lockstep_sdk/models/erp_model.rb
 - lib/lockstep_sdk/models/error_result.rb
 - lib/lockstep_sdk/models/feature_flags_request_model.rb