lockstep_sdk 2022.35.5.0 → 2022.37.24.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 158f24f63ab345bbe1d63c0f33494b605deb19cc1b1b697fea51b035451a43e8
-  data.tar.gz: 380f399812617bef853f621eddcf2662300bd09a289d3bce33979efcc9ebe86e
+  metadata.gz: fd37da4137c0bf7969030f035d3749ced22345aa218fb2c62cf38e5bca8f4809
+  data.tar.gz: b611b8d4ed34dd3efd034d5b8a49b879a6e67a3da822d4a6ca61df7fd81ead45
 SHA512:
-  metadata.gz: 3a021c80ca8c9d918b613ac077488548228a4595d2366abbefb290532d5872c243abf8487e12b7ac995ef0542396c2e30d781eea322e83ca6da23662094884b5
-  data.tar.gz: 38db337ad9ca648f87a219a5716915862c94afcc3706c2d33228fb3c917f8099395b48a45db0f8dd308d36e41ff5efd97454d746ff0343899ed371cceaa31dc4
+  metadata.gz: 1ba58f7b225be03e33e103eb81f8ace42d5ad60b18daaaee404e7ee88da945c39574207e5fe3459b3476a5f6faa0eacafd630db5c91e807be5774542146bf18d
+  data.tar.gz: df5ec2a9657572588d4273daf9aadedf8f69b3502bd7900de6d7dea1212fe8c53396205428e4339a71ea30159ae51e965af526a57995e8f88795031e6b1c0ee6

data/lib/lockstep_sdk/clients/app_enrollments_client.rb

@@ -84,11 +84,11 @@ class AppEnrollmentsClient
     end
 
     ##
-    # Updates the OAuth settings associated with this App Enrollment
+    # Updates the settings associated with this App Enrollment
     #
     # @param id [uuid] The unique ID number of the App Enrollment to reconnect
     # @param body [AppEnrollmentReconnectRequest] Information to reconnect the App Enrollment
-    def reconnect_app_enrollment_oauth(id:, body:)
+    def reconnect_app_enrollment(id:, body:)
         path = "/api/v1/AppEnrollments/#{id}/reconnect"
         @connection.request(:post, path, body, nil)
     end

data/lib/lockstep_sdk/clients/profiles_client.rb

@@ -27,7 +27,7 @@ class ProfilesClient
     ##
     # Retrieves the Public Company Profile specified by the public url slug.
     #
-    # A Public Company Profile makes available the following information: <list type="bullet"><item>Company Name</item><item>Company Logo Url</item><item>Description</item><item>Website</item></list>
+    # A Public Company Profile makes available the following information: <ul><li>Company Name</li><li>Company Logo Url</li><li>Description</li><li>Website</li></ul>
     #
     # @param url_slug [string] 
     def retrieve_public_company_profile(url_slug:)
@@ -36,9 +36,13 @@ class ProfilesClient
     end
 
     ##
-    # Queries Public Company Profiles <p> More information on querying can be found on the [Searchlight Query Language](https://developer.lockstep.io/docs/querying-with-searchlight) page on the Lockstep Developer website. </p><p> A Public Company Profile makes available the following information:
+    # Queries Public Company Profiles
     #
-    # <list type="bullet"><item>`Company Name`  </item><item>`Company Logo Url`  </item><item>`Description`  </item><item>`Website`  </item></list></p>
+    # More information on querying can be found on the [Searchlight Query Language](https://developer.lockstep.io/docs/querying-with-searchlight) page on the Lockstep Developer website.
+    #
+    # A Public Company Profile makes available the following information:
+    #
+    # <ul><li>Company Name</li><li>Company Logo Url</li><li>Description</li><li>Website</li></ul>
     #
     # @param filter [string] The filter for this query. See [Searchlight Query Language](https://developer.lockstep.io/docs/querying-with-searchlight)
     # @param order [string] The sort order for the results, in the [Searchlight order syntax](https://github.com/tspence/csharp-searchlight).

data/lib/lockstep_sdk/clients/reports_client.rb

@@ -55,7 +55,7 @@ class ReportsClient
     #
     # @param report_date [date-time] Optional: Specify the specific report date to generate the from (default UTC now)
     def daily_sales_outstanding(report_date:)
-        path = "/api/v1/Reports/dailysalesoutstanding"
+        path = "/api/v1/Reports/daily-sales-outstanding"
         params = {:reportDate => report_date}
         @connection.request(:get, path, nil, params)
     end
@@ -108,7 +108,7 @@ class ReportsClient
     # Risk Rate is a metric that indicates the percentage of total AR balance left unpaid after 90 days.  You can use this report to identify the percentage of invoice value that is not being collected in a timely manner.
     #
     def risk_rates()
-        path = "/api/v1/Reports/riskrates"
+        path = "/api/v1/Reports/risk-rates"
         @connection.request(:get, path, nil, nil)
     end
 

data/lib/lockstep_sdk/clients/webhooks_client.rb

@@ -68,7 +68,7 @@ class WebhooksClient
     #
     # @param id [uuid] The unique Lockstep Platform ID number of the Webhook to update.
     def regenerate_client_secret(id:)
-        path = "/api/v1/Webhooks/#{id}/regenerateclientsecret"
+        path = "/api/v1/Webhooks/#{id}/regenerate-client-secret"
         @connection.request(:patch, path, nil, nil)
     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-2022 Lockstep, Inc.
-# @version    2022.35.5
+# @version    2022.37.24
 # @link       https://github.com/Lockstep-Network/lockstep-sdk-ruby
 #
 
@@ -170,7 +170,7 @@ module lockstep_sdk
         #
         # @param env [string] Either "sbx", "prd", or the URI of the server, ending in a slash (/)
         def initialize(env)
-            @version = "2022.35.5.0"
+            @version = "2022.37.24.0"
             @env = case env
                 when "sbx"
                     "https://api.sbx.lockstep.io/"
@@ -277,7 +277,7 @@ module lockstep_sdk
             request["Accept"] = 'application/json'
             request["Content-Type"] = 'application/*+json'
             request["SdkType"] = 'Ruby'
-            request["SdkVersion"] = '2022.35.5.0'
+            request["SdkVersion"] = '2022.37.24.0'
             request["MachineName"] = Socket.gethostname
             request.body = body
 

data/lib/lockstep_sdk/models/ap_header_info_model.rb

@@ -24,6 +24,7 @@ module LockstepSdk
         # Initialize the ApHeaderInfoModel using the provided prototype
         def initialize(params = {})
             @group_key = params.dig(:group_key)
+            @report_date = params.dig(:report_date)
             @report_period = params.dig(:report_period)
             @total_vendors = params.dig(:total_vendors)
             @total_bills = params.dig(:total_bills)
@@ -55,6 +56,10 @@ module LockstepSdk
         # @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 [Date-time] The date of the report
+        attr_accessor :report_date
+
         ##
         # @return [Date-time] The date of the report
         attr_accessor :report_period
@@ -160,6 +165,7 @@ module LockstepSdk
         def as_json(options={})
             {
                 'groupKey' => @group_key,
+                'reportDate' => @report_date,
                 'reportPeriod' => @report_period,
                 'totalVendors' => @total_vendors,
                 'totalBills' => @total_bills,

data/lib/lockstep_sdk/models/app_enrollment_reconnect_request.rb

@@ -24,17 +24,41 @@ module LockstepSdk
         # Initialize the AppEnrollmentReconnectRequest using the provided prototype
         def initialize(params = {})
             @auth_code = params.dig(:auth_code)
+            @username = params.dig(:username)
+            @password = params.dig(:password)
+            @token_id = params.dig(:token_id)
+            @token_secret = params.dig(:token_secret)
         end
 
         ##
         # @return [String] The OAuth authentication code.
         attr_accessor :auth_code
 
+        ##
+        # @return [String] The OAuth authentication code.
+        attr_accessor :username
+
+        ##
+        # @return [String] The password for the web services account with access permissions.
+        attr_accessor :password
+
+        ##
+        # @return [String] The access token id for the connector enrollment.
+        attr_accessor :token_id
+
+        ##
+        # @return [String] The access token secret for the connector enrollment.
+        attr_accessor :token_secret
+
         ##
         # @return [object] This object as a JSON key-value structure
         def as_json(options={})
             {
                 'authCode' => @auth_code,
+                'username' => @username,
+                'password' => @password,
+                'tokenId' => @token_id,
+                'tokenSecret' => @token_secret,
             }
         end
 

data/lib/lockstep_sdk/models/application_model.rb

@@ -46,6 +46,7 @@ module LockstepSdk
             @is_active = params.dig(:is_active)
             @wiki_url = params.dig(:wiki_url)
             @group_key = params.dig(:group_key)
+            @b2_cclient_id = params.dig(:b2_cclient_id)
             @notes = params.dig(:notes)
             @attachments = params.dig(:attachments)
             @custom_field_definitions = params.dig(:custom_field_definitions)
@@ -112,6 +113,10 @@ module LockstepSdk
         # @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 B2C Client ID of the application
+        attr_accessor :b2_cclient_id
+
         ##
         # @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 `Application` and the `ObjectKey` set to the `ApplicationId` 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
@@ -147,6 +152,7 @@ module LockstepSdk
                 'isActive' => @is_active,
                 'wikiURL' => @wiki_url,
                 'groupKey' => @group_key,
+                'b2CClientId' => @b2_cclient_id,
                 'notes' => @notes,
                 'attachments' => @attachments,
                 'customFieldDefinitions' => @custom_field_definitions,

data/lib/lockstep_sdk/models/ar_header_info_model.rb

@@ -24,6 +24,7 @@ module LockstepSdk
         # Initialize the ArHeaderInfoModel using the provided prototype
         def initialize(params = {})
             @group_key = params.dig(:group_key)
+            @report_date = params.dig(:report_date)
             @report_period = params.dig(:report_period)
             @total_customers = params.dig(:total_customers)
             @total_invoices = params.dig(:total_invoices)
@@ -58,6 +59,10 @@ module LockstepSdk
 
         ##
         # @return [Date] The date of the report
+        attr_accessor :report_date
+
+        ##
+        # @return [String] The date of the report
         attr_accessor :report_period
 
         ##
@@ -165,6 +170,7 @@ module LockstepSdk
         def as_json(options={})
             {
                 'groupKey' => @group_key,
+                'reportDate' => @report_date,
                 'reportPeriod' => @report_period,
                 'totalCustomers' => @total_customers,
                 'totalInvoices' => @total_invoices,

data/lib/lockstep_sdk/models/risk_rate_model.rb

@@ -25,6 +25,7 @@ module LockstepSdk
         def initialize(params = {})
             @group_key = params.dig(:group_key)
             @report_period = params.dig(:report_period)
+            @report_date = params.dig(:report_date)
             @invoice_month_name = params.dig(:invoice_month_name)
             @total_invoice_count = params.dig(:total_invoice_count)
             @total_invoice_amount = params.dig(:total_invoice_amount)
@@ -42,6 +43,10 @@ module LockstepSdk
         # @return [Date-time] The month the risk rate was calculated for
         attr_accessor :report_period
 
+        ##
+        # @return [Date-time] The month the risk rate was calculated for
+        attr_accessor :report_date
+
         ##
         # @return [String] The string name of the month the risk rate was calculated for
         attr_accessor :invoice_month_name
@@ -76,6 +81,7 @@ module LockstepSdk
             {
                 'groupKey' => @group_key,
                 'reportPeriod' => @report_period,
+                'reportDate' => @report_date,
                 'invoiceMonthName' => @invoice_month_name,
                 'totalInvoiceCount' => @total_invoice_count,
                 'totalInvoiceAmount' => @total_invoice_amount,

data/lib/lockstep_sdk/version.rb

@@ -1,3 +1,3 @@
 module LockstepSdk
-    VERSION = "2022.35.5.0"
+    VERSION = "2022.37.24.0"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: lockstep_sdk
 version: !ruby/object:Gem::Version
-  version: 2022.35.5.0
+  version: 2022.37.24.0
 platform: ruby
 authors:
 - Lockstep
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2022-09-02 00:00:00.000000000 Z
+date: 2022-09-16 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: awrence
@@ -110,7 +110,6 @@ files:
 - lib/lockstep_sdk/models/dpo_summary_group_total_model.rb
 - lib/lockstep_sdk/models/dpo_summary_model.rb
 - lib/lockstep_sdk/models/email_model.rb
-- lib/lockstep_sdk/models/erp_info_model.rb
 - lib/lockstep_sdk/models/erp_model.rb
 - lib/lockstep_sdk/models/error_result.rb
 - lib/lockstep_sdk/models/financial_account_balance_history_model.rb
@@ -147,9 +146,6 @@ files:
 - lib/lockstep_sdk/models/payment_model.rb
 - lib/lockstep_sdk/models/payment_summary_model.rb
 - lib/lockstep_sdk/models/payment_sync_model.rb
-- lib/lockstep_sdk/models/provisioning_finalize_request_model.rb
-- lib/lockstep_sdk/models/provisioning_model.rb
-- lib/lockstep_sdk/models/provisioning_response_model.rb
 - lib/lockstep_sdk/models/public_company_profile_model.rb
 - lib/lockstep_sdk/models/risk_rate_model.rb
 - lib/lockstep_sdk/models/state_model.rb

data/lib/lockstep_sdk/models/erp_info_model.rb

@@ -1,53 +0,0 @@
-#
-# Lockstep Platform SDK 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     Lockstep Network <support@lockstep.io>
-# @copyright  2021-2022 Lockstep, Inc.
-# @link       https://github.com/Lockstep-Network/lockstep-sdk-ruby
-#
-
-
-require 'json'
-
-module LockstepSdk
-
-    ##
-    # Represents the ERP object sent in a provisioning request
-    class ErpInfoModel
-
-        ##
-        # Initialize the ErpInfoModel using the provided prototype
-        def initialize(params = {})
-            @app_id = params.dig(:app_id)
-            @data = params.dig(:data)
-        end
-
-        ##
-        # @return [Uuid] The id of the ERP's App
-        attr_accessor :app_id
-
-        ##
-        # @return [ConnectorInfoModel] The data required to store for connector access
-        attr_accessor :data
-
-        ##
-        # @return [object] This object as a JSON key-value structure
-        def as_json(options={})
-            {
-                'appId' => @app_id,
-                'data' => @data,
-            }
-        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/provisioning_finalize_request_model.rb

@@ -1,71 +0,0 @@
-#
-# Lockstep Platform SDK 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     Lockstep Network <support@lockstep.io>
-# @copyright  2021-2022 Lockstep, Inc.
-# @link       https://github.com/Lockstep-Network/lockstep-sdk-ruby
-#
-
-
-require 'json'
-
-module LockstepSdk
-
-    ##
-    # Represents the data to finalize onboarding for a user
-    class ProvisioningFinalizeRequestModel
-
-        ##
-        # Initialize the ProvisioningFinalizeRequestModel using the provided prototype
-        def initialize(params = {})
-            @full_name = params.dig(:full_name)
-            @time_zone = params.dig(:time_zone)
-            @default_currency = params.dig(:default_currency)
-            @company = params.dig(:company)
-            @email_connector = params.dig(:email_connector)
-        end
-
-        ##
-        # @return [String] The full name of the user
-        attr_accessor :full_name
-
-        ##
-        # @return [String] The time zone of the user
-        attr_accessor :time_zone
-
-        ##
-        # @return [String] The default currency of the user
-        attr_accessor :default_currency
-
-        ##
-        # @return [CompanyModel] The company information for the user and group
-        attr_accessor :company
-
-        ##
-        # @return [ErpInfoModel] Optional connector information needed to enroll user to their email connector
-        attr_accessor :email_connector
-
-        ##
-        # @return [object] This object as a JSON key-value structure
-        def as_json(options={})
-            {
-                'fullName' => @full_name,
-                'timeZone' => @time_zone,
-                'defaultCurrency' => @default_currency,
-                'company' => @company,
-                'emailConnector' => @email_connector,
-            }
-        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/provisioning_model.rb

@@ -1,53 +0,0 @@
-#
-# Lockstep Platform SDK 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     Lockstep Network <support@lockstep.io>
-# @copyright  2021-2022 Lockstep, Inc.
-# @link       https://github.com/Lockstep-Network/lockstep-sdk-ruby
-#
-
-
-require 'json'
-
-module LockstepSdk
-
-    ##
-    # Represents the data sent during the onboarding flow
-    class ProvisioningModel
-
-        ##
-        # Initialize the ProvisioningModel using the provided prototype
-        def initialize(params = {})
-            @full_name = params.dig(:full_name)
-            @erp = params.dig(:erp)
-        end
-
-        ##
-        # @return [String] The full name of the new user
-        attr_accessor :full_name
-
-        ##
-        # @return [ErpInfoModel] The information necessary to enroll the user in their ERP
-        attr_accessor :erp
-
-        ##
-        # @return [object] This object as a JSON key-value structure
-        def as_json(options={})
-            {
-                'fullName' => @full_name,
-                'erp' => @erp,
-            }
-        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/provisioning_response_model.rb

@@ -1,83 +0,0 @@
-#
-# Lockstep Platform SDK 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     Lockstep Network <support@lockstep.io>
-# @copyright  2021-2022 Lockstep, Inc.
-# @link       https://github.com/Lockstep-Network/lockstep-sdk-ruby
-#
-
-
-require 'json'
-
-module LockstepSdk
-
-    ##
-    # Represents the response to either a successful or failed account provisioning
-    class ProvisioningResponseModel
-
-        ##
-        # Initialize the ProvisioningResponseModel using the provided prototype
-        def initialize(params = {})
-            @user_name = params.dig(:user_name)
-            @account_name = params.dig(:account_name)
-            @user_id = params.dig(:user_id)
-            @group_key = params.dig(:group_key)
-            @app_enrollment_id = params.dig(:app_enrollment_id)
-            @sync_request_id = params.dig(:sync_request_id)
-            @error_message = params.dig(:error_message)
-        end
-
-        ##
-        # @return [String] If provisioning is successful, contains the username of the created user.
-        attr_accessor :user_name
-
-        ##
-        # @return [String] If provisioning is successful, contains subscription account name of created user.
-        attr_accessor :account_name
-
-        ##
-        # @return [Uuid] If provisioning is successful, contains the unique identifier of the created user.
-        attr_accessor :user_id
-
-        ##
-        # @return [Uuid] If provisioning is successful, contains the group key of the created user.
-        attr_accessor :group_key
-
-        ##
-        # @return [Uuid] If provisioning is successful, contains the app enrollment id of the created app enrollment.
-        attr_accessor :app_enrollment_id
-
-        ##
-        # @return [Uuid] if provisioning is successful, contains the sync request id of the sync that was started for the app enrollment.
-        attr_accessor :sync_request_id
-
-        ##
-        # @return [String] The error message(s).
-        attr_accessor :error_message
-
-        ##
-        # @return [object] This object as a JSON key-value structure
-        def as_json(options={})
-            {
-                'userName' => @user_name,
-                'accountName' => @account_name,
-                'userId' => @user_id,
-                'groupKey' => @group_key,
-                'appEnrollmentId' => @app_enrollment_id,
-                'syncRequestId' => @sync_request_id,
-                '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