lockstep_sdk 2022.33.14.0 → 2022.35.5.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: ff91eee944f6ed1299763d2652ae74b4cd0dde8ae9b0df52e682d014f7dc34f9
-  data.tar.gz: 47ec24af6e5b7282423ca45b5949a677fc5c22064761fb9a646f22aa806db59f
+  metadata.gz: 158f24f63ab345bbe1d63c0f33494b605deb19cc1b1b697fea51b035451a43e8
+  data.tar.gz: 380f399812617bef853f621eddcf2662300bd09a289d3bce33979efcc9ebe86e
 SHA512:
-  metadata.gz: 9c21ea30bfefb763acf318b3afc43fc087bfdca695e492c1ebde895aa1dbc641c8c058402bc7d26e96ab1eafe66caa34655217441b55f8ca4ca89377e23330c0
-  data.tar.gz: 13ee2ae0e4a5f5d866f8ba163658e142b9f7bb677dc44250e5b9cebe748e9aae11d5d95943d02d4a7f5f724ebe81e4d1b1d03ea9d6868f98850a3cbff50b85a5
+  metadata.gz: 3a021c80ca8c9d918b613ac077488548228a4595d2366abbefb290532d5872c243abf8487e12b7ac995ef0542396c2e30d781eea322e83ca6da23662094884b5
+  data.tar.gz: 38db337ad9ca648f87a219a5716915862c94afcc3706c2d33228fb3c917f8099395b48a45db0f8dd308d36e41ff5efd97454d746ff0343899ed371cceaa31dc4

data/lib/lockstep_sdk/clients/profiles_client.rb

@@ -0,0 +1,52 @@
+#
+# 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 'awrence'
+
+class ProfilesClient
+
+    ##
+    # Initialize the ProfilesClient class with an API client instance.
+    # @param connection [LockstepApi] The API client object for this connection
+    def initialize(connection)
+        @connection = connection
+    end
+
+
+    ##
+    # 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>
+    #
+    # @param url_slug [string] 
+    def retrieve_public_company_profile(url_slug:)
+        path = "/api/v1/Profiles/companies/#{urlSlug}"
+        @connection.request(:get, path, nil, nil)
+    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:
+    #
+    # <list type="bullet"><item>`Company Name`  </item><item>`Company Logo Url`  </item><item>`Description`  </item><item>`Website`  </item></list></p>
+    #
+    # @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).
+    # @param page_size [int32] The page size for results (default 200, maximum of 10,000)
+    # @param page_number [int32] The page number for results (default 0)
+    def query_public_company_profiles(filter:, order:, page_size:, page_number:)
+        path = "/api/v1/Profiles/companies/query"
+        params = {:filter => filter, :order => order, :pageSize => page_size, :pageNumber => page_number}
+        @connection.request(:get, path, nil, params)
+    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-2022 Lockstep, Inc.
-# @version    2022.33.14
+# @version    2022.35.5
 # @link       https://github.com/Lockstep-Network/lockstep-sdk-ruby
 #
 
@@ -128,6 +128,10 @@ module lockstep_sdk
         # @return [PaymentsClient] Client object for Payments endpoints
         attr_accessor :payments
 
+        ##
+        # @return [ProfilesClient] Client object for Profiles endpoints
+        attr_accessor :profiles
+
         ##
         # @return [ProvisioningClient] Client object for Provisioning endpoints
         attr_accessor :provisioning
@@ -166,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.33.14.0"
+            @version = "2022.35.5.0"
             @env = case env
                 when "sbx"
                     "https://api.sbx.lockstep.io/"
@@ -201,6 +205,7 @@ module lockstep_sdk
             @notes = NotesClient.new(self)
             @payment_applications = PaymentApplicationsClient.new(self)
             @payments = PaymentsClient.new(self)
+            @profiles = ProfilesClient.new(self)
             @provisioning = ProvisioningClient.new(self)
             @reports = ReportsClient.new(self)
             @status = StatusClient.new(self)
@@ -272,7 +277,7 @@ module lockstep_sdk
             request["Accept"] = 'application/json'
             request["Content-Type"] = 'application/*+json'
             request["SdkType"] = 'Ruby'
-            request["SdkVersion"] = '2022.33.14.0'
+            request["SdkVersion"] = '2022.35.5.0'
             request["MachineName"] = Socket.gethostname
             request.body = body
 

data/lib/lockstep_sdk/models/company_model.rb

@@ -65,6 +65,7 @@ module LockstepSdk
             @website = params.dig(:website)
             @app_enrollment_id = params.dig(:app_enrollment_id)
             @email_address = params.dig(:email_address)
+            @public_url_slug = params.dig(:public_url_slug)
             @notes = params.dig(:notes)
             @attachments = params.dig(:attachments)
             @contacts = params.dig(:contacts)
@@ -226,6 +227,10 @@ module LockstepSdk
         # @return [Email] Company Email Address
         attr_accessor :email_address
 
+        ##
+        # @return [String] The public url slug for the Company.
+        attr_accessor :public_url_slug
+
         ##
         # @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 `Company` and the `ObjectKey` set to the `CompanyId` 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
@@ -296,6 +301,7 @@ module LockstepSdk
                 'website' => @website,
                 'appEnrollmentId' => @app_enrollment_id,
                 'emailAddress' => @email_address,
+                'publicUrlSlug' => @public_url_slug,
                 'notes' => @notes,
                 'attachments' => @attachments,
                 'contacts' => @contacts,

data/lib/lockstep_sdk/models/public_company_profile_model.rb

@@ -0,0 +1,77 @@
+#
+# 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
+
+    ##
+    # Contains Public Company Profile data.
+    class PublicCompanyProfileModel
+
+        ##
+        # Initialize the PublicCompanyProfileModel using the provided prototype
+        def initialize(params = {})
+            @company_id = params.dig(:company_id)
+            @company_name = params.dig(:company_name)
+            @company_logo_url = params.dig(:company_logo_url)
+            @website = params.dig(:website)
+            @description = params.dig(:description)
+            @public_url_slug = params.dig(:public_url_slug)
+        end
+
+        ##
+        # @return [Uuid] The unique ID of the company associated with this profile.
+        attr_accessor :company_id
+
+        ##
+        # @return [String] The short name of the company associated with this profile.
+        attr_accessor :company_name
+
+        ##
+        # @return [String] The URL of this company's logo, if known.
+        attr_accessor :company_logo_url
+
+        ##
+        # @return [String] Website URL for the company associated with this profile.
+        attr_accessor :website
+
+        ##
+        # @return [String] Description of the company associated with this profile.
+        attr_accessor :description
+
+        ##
+        # @return [String] The public url slug for this Public Company Profile.
+        attr_accessor :public_url_slug
+
+        ##
+        # @return [object] This object as a JSON key-value structure
+        def as_json(options={})
+            {
+                'companyId' => @company_id,
+                'companyName' => @company_name,
+                'companyLogoUrl' => @company_logo_url,
+                'website' => @website,
+                'description' => @description,
+                'publicUrlSlug' => @public_url_slug,
+            }
+        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/version.rb

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

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: lockstep_sdk
 version: !ruby/object:Gem::Version
-  version: 2022.33.14.0
+  version: 2022.35.5.0
 platform: ruby
 authors:
 - Lockstep
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2022-08-18 00:00:00.000000000 Z
+date: 2022-09-02 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: awrence
@@ -56,6 +56,7 @@ files:
 - lib/lockstep_sdk/clients/notes_client.rb
 - lib/lockstep_sdk/clients/payment_applications_client.rb
 - lib/lockstep_sdk/clients/payments_client.rb
+- lib/lockstep_sdk/clients/profiles_client.rb
 - lib/lockstep_sdk/clients/provisioning_client.rb
 - lib/lockstep_sdk/clients/reports_client.rb
 - lib/lockstep_sdk/clients/status_client.rb
@@ -149,6 +150,7 @@ files:
 - 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
 - lib/lockstep_sdk/models/status_model.rb