lockstep_sdk 2022.6.49.0 → 2022.9.6.0

data/lib/lockstep_sdk/models/sync_request_model.rb

@@ -60,7 +60,7 @@ module LockstepSdk
         attr_accessor :process_result_message
 
         ##
-        # @return [Uuid] App enrollment sync request is for
+        # @return [Uuid] The AppEnrollmentId of the AppEnrollment object that executed this sync request
         attr_accessor :app_enrollment_id
 
         ##

data/lib/lockstep_sdk/models/user_account_model.rb

@@ -176,15 +176,15 @@ module LockstepSdk
         attr_accessor :default_currency_code
 
         ##
-        # @return [NoteModel] All notes attached to this User. To retrieve this collection, specify `Notes` in the "Include" parameter for your query.
+        # @return [NoteModel] A collection of notes linked to this record. To retrieve this collection, specify `Notes` in the `include` parameter when retrieving data. To create a note, use the [Create Note](https://developer.lockstep.io/reference/post_api-v1-notes) endpoint with the `TableKey` to `UserAccount` and the `ObjectKey` set to the `UserId` 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 :notes
 
         ##
-        # @return [AttachmentModel] All attachments attached to this User. To retrieve this collection, specify `Attachments` in the "Include" parameter for your query.
+        # @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 `UserAccount` and the `ObjectKey` set to the `UserId` 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
 
         ##
-        # @return [CustomFieldValueModel] All values attached to this User. To retrieve this collection, specify `CustomFieldValues` in the "Include" parameter for your query.
+        # @return [CustomFieldValueModel] A collection of custom fields linked to this record. To retrieve this collection, specify `CustomFieldValues` in the `include` parameter when retrieving data. To create a custom field, use the [Create Custom Field](https://developer.lockstep.io/reference/post_api-v1-customfieldvalues) endpoint with the `TableKey` to `UserAccount` and the `ObjectKey` set to the `UserId` 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 :custom_field_values
 
         ##

data/lib/lockstep_sdk/models/webhook_history_table_storage_model.rb

@@ -0,0 +1,103 @@
+#
+# 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.
+# @link       https://github.com/Lockstep-Network/lockstep-sdk-ruby
+#
+
+
+require 'json'
+
+module LockstepSdk
+
+    ##
+    # Represents the Webhook Trigger History
+    class WebhookHistoryTableStorageModel
+
+        ##
+        # Initialize the WebhookHistoryTableStorageModel using the provided prototype
+        def initialize(params = {})
+            @group_key = params.dig(:group_key)
+            @webhook_id = params.dig(:webhook_id)
+            @webhook_history_id = params.dig(:webhook_history_id)
+            @event_type = params.dig(:event_type)
+            @request_sent = params.dig(:request_sent)
+            @is_successful = params.dig(:is_successful)
+            @response_status_code = params.dig(:response_status_code)
+            @process_result_message = params.dig(:process_result_message)
+            @failure_count = params.dig(:failure_count)
+            @timestamp = params.dig(:timestamp)
+        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 WebhookId uniquely identifies the webhook used to send notification that an event action has taken place.
+        attr_accessor :webhook_id
+
+        ##
+        # @return [Uuid] The unique ID of this record, automatically assigned by Lockstep when this record is added to the Lockstep platform.
+        attr_accessor :webhook_history_id
+
+        ##
+        # @return [String] Event type which fired webhook [entity].[action]
+        attr_accessor :event_type
+
+        ##
+        # @return [Boolean] Flag whether request was sent to callback url successfully or blocked by failing or because it was disabled.
+        attr_accessor :request_sent
+
+        ##
+        # @return [Boolean] Flag whether webhook notification was successful overall (if webhook disabled should always return true otherwise depends on the response from the callback url)
+        attr_accessor :is_successful
+
+        ##
+        # @return [String] Response status code that is returned when calling a callback url.
+        attr_accessor :response_status_code
+
+        ##
+        # @return [String] Message containing information about the webhook callback results
+        attr_accessor :process_result_message
+
+        ##
+        # @return [Int32] Number of times message failed to be sent over to callback url before succeeding or failing out. The maximum value should is based on webhook.
+        attr_accessor :failure_count
+
+        ##
+        # @return [Date-time] Timestamp of when a request is sent to a webhook callback. Contains the last time message is sent if failures occur.
+        attr_accessor :timestamp
+
+        ##
+        # @return [object] This object as a JSON key-value structure
+        def as_json(options={})
+            {
+                'groupKey' => @group_key,
+                'webhookId' => @webhook_id,
+                'webhookHistoryId' => @webhook_history_id,
+                'eventType' => @event_type,
+                'requestSent' => @request_sent,
+                'isSuccessful' => @is_successful,
+                'responseStatusCode' => @response_status_code,
+                'processResultMessage' => @process_result_message,
+                'failureCount' => @failure_count,
+                'timestamp' => @timestamp,
+            }
+        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/webhook_model.rb

@@ -44,6 +44,7 @@ module LockstepSdk
             @created_user_id = params.dig(:created_user_id)
             @modified = params.dig(:modified)
             @modified_user_id = params.dig(:modified_user_id)
+            @partition_key = params.dig(:partition_key)
         end
 
         ##
@@ -106,6 +107,10 @@ module LockstepSdk
         # @return [Uuid] The ID of the user who last modified this webhook
         attr_accessor :modified_user_id
 
+        ##
+        # @return [String] The partition key used for the webhook callback history
+        attr_accessor :partition_key
+
         ##
         # @return [object] This object as a JSON key-value structure
         def as_json(options={})
@@ -125,6 +130,7 @@ module LockstepSdk
                 'createdUserId' => @created_user_id,
                 'modified' => @modified,
                 'modifiedUserId' => @modified_user_id,
+                'partitionKey' => @partition_key,
             }
         end
 

data/lib/lockstep_sdk/version.rb

@@ -1,3 +1,3 @@
 module LockstepSdk
-    VERSION = "2022.6.49.0"
+    VERSION = "2022.9.6.0"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: lockstep_sdk
 version: !ruby/object:Gem::Version
-  version: 2022.6.49.0
+  version: 2022.9.6.0
 platform: ruby
 authors:
 - Lockstep
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2022-02-14 00:00:00.000000000 Z
+date: 2022-03-02 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: awrence
@@ -46,6 +46,9 @@ files:
 - lib/lockstep_sdk/clients/custom_field_values_client.rb
 - lib/lockstep_sdk/clients/definitions_client.rb
 - lib/lockstep_sdk/clients/emails_client.rb
+- lib/lockstep_sdk/clients/financial_account_balance_history_client.rb
+- lib/lockstep_sdk/clients/financial_account_client.rb
+- lib/lockstep_sdk/clients/financial_year_settings_client.rb
 - lib/lockstep_sdk/clients/invoice_history_client.rb
 - lib/lockstep_sdk/clients/invoices_client.rb
 - lib/lockstep_sdk/clients/leads_client.rb
@@ -100,6 +103,9 @@ files:
 - lib/lockstep_sdk/models/erp_info_data_model.rb
 - lib/lockstep_sdk/models/erp_info_model.rb
 - lib/lockstep_sdk/models/erp_model.rb
+- lib/lockstep_sdk/models/financial_account_balance_history_model.rb
+- lib/lockstep_sdk/models/financial_account_model.rb
+- lib/lockstep_sdk/models/financial_year_setting_model.rb
 - lib/lockstep_sdk/models/invite_data_model.rb
 - lib/lockstep_sdk/models/invite_model.rb
 - lib/lockstep_sdk/models/invite_submit_model.rb
@@ -134,6 +140,7 @@ files:
 - lib/lockstep_sdk/models/uri_model.rb
 - lib/lockstep_sdk/models/user_account_model.rb
 - lib/lockstep_sdk/models/user_role_model.rb
+- lib/lockstep_sdk/models/webhook_history_table_storage_model.rb
 - lib/lockstep_sdk/models/webhook_model.rb
 - lib/lockstep_sdk/version.rb
 homepage: https://developer.lockstep.io