lockstep_sdk 2022.4.32.0

data/lib/lockstep_sdk/lockstep_api.rb

@@ -0,0 +1,264 @@
+#
+# 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.32.0
+# @link       https://github.com/Lockstep-Network/lockstep-sdk-ruby
+#
+
+require 'net/http'
+require 'openssl'
+require 'uri'
+require 'socket'
+
+project_root = File.dirname(File.absolute_path(__FILE__))
+Dir.glob(project_root + '/clients/*') {|file| require file}
+
+module LockstepSdk
+    class LockstepApi
+    
+        ##
+        # @return [String] The version number of this Lockstep API client
+        attr_accessor :version
+
+        ##
+        # @return [String] The name or URL of the environment
+        attr_accessor :env 
+
+        ##
+        # @return [ActivitiesClient] Client object for Activities endpoints
+        attr_accessor :activities
+
+        ##
+        # @return [ApiKeysClient] Client object for ApiKeys endpoints
+        attr_accessor :api_keys
+
+        ##
+        # @return [AppEnrollmentsClient] Client object for AppEnrollments endpoints
+        attr_accessor :app_enrollments
+
+        ##
+        # @return [ApplicationsClient] Client object for Applications endpoints
+        attr_accessor :applications
+
+        ##
+        # @return [AttachmentsClient] Client object for Attachments endpoints
+        attr_accessor :attachments
+
+        ##
+        # @return [CodeDefinitionsClient] Client object for CodeDefinitions endpoints
+        attr_accessor :code_definitions
+
+        ##
+        # @return [CompaniesClient] Client object for Companies endpoints
+        attr_accessor :companies
+
+        ##
+        # @return [ContactsClient] Client object for Contacts endpoints
+        attr_accessor :contacts
+
+        ##
+        # @return [CreditMemoAppliedClient] Client object for CreditMemoApplied endpoints
+        attr_accessor :credit_memo_applied
+
+        ##
+        # @return [CurrenciesClient] Client object for Currencies endpoints
+        attr_accessor :currencies
+
+        ##
+        # @return [CustomFieldDefinitionsClient] Client object for CustomFieldDefinitions endpoints
+        attr_accessor :custom_field_definitions
+
+        ##
+        # @return [CustomFieldValuesClient] Client object for CustomFieldValues endpoints
+        attr_accessor :custom_field_values
+
+        ##
+        # @return [DefinitionsClient] Client object for Definitions endpoints
+        attr_accessor :definitions
+
+        ##
+        # @return [EmailsClient] Client object for Emails endpoints
+        attr_accessor :emails
+
+        ##
+        # @return [InvoiceHistoryClient] Client object for InvoiceHistory endpoints
+        attr_accessor :invoice_history
+
+        ##
+        # @return [InvoicesClient] Client object for Invoices endpoints
+        attr_accessor :invoices
+
+        ##
+        # @return [LeadsClient] Client object for Leads endpoints
+        attr_accessor :leads
+
+        ##
+        # @return [NotesClient] Client object for Notes endpoints
+        attr_accessor :notes
+
+        ##
+        # @return [PaymentApplicationsClient] Client object for PaymentApplications endpoints
+        attr_accessor :payment_applications
+
+        ##
+        # @return [PaymentsClient] Client object for Payments endpoints
+        attr_accessor :payments
+
+        ##
+        # @return [ProvisioningClient] Client object for Provisioning endpoints
+        attr_accessor :provisioning
+
+        ##
+        # @return [ReportsClient] Client object for Reports endpoints
+        attr_accessor :reports
+
+        ##
+        # @return [StatusClient] Client object for Status endpoints
+        attr_accessor :status
+
+        ##
+        # @return [SyncClient] Client object for Sync endpoints
+        attr_accessor :sync
+
+        ##
+        # @return [UserAccountsClient] Client object for UserAccounts endpoints
+        attr_accessor :user_accounts
+
+        ##
+        # @return [UserRolesClient] Client object for UserRoles endpoints
+        attr_accessor :user_roles
+
+
+        ##
+        # Construct a new Lockstep API client targeting the specified server.
+        #
+        # @param env [string] Either "sbx", "prd", or the URI of the server, ending in a slash (/)
+        def initialize(env)
+            @version = "2022.4.32.0"
+            @env = case env
+                when "sbx"
+                    "https://api.sbx.lockstep.io/"
+                when "prd"
+                    "https://api.lockstep.io/"
+                else
+                    env
+                end
+                
+            # Construct all the clients
+            @activities = ActivitiesClient.new(self)
+            @api_keys = ApiKeysClient.new(self)
+            @app_enrollments = AppEnrollmentsClient.new(self)
+            @applications = ApplicationsClient.new(self)
+            @attachments = AttachmentsClient.new(self)
+            @code_definitions = CodeDefinitionsClient.new(self)
+            @companies = CompaniesClient.new(self)
+            @contacts = ContactsClient.new(self)
+            @credit_memo_applied = CreditMemoAppliedClient.new(self)
+            @currencies = CurrenciesClient.new(self)
+            @custom_field_definitions = CustomFieldDefinitionsClient.new(self)
+            @custom_field_values = CustomFieldValuesClient.new(self)
+            @definitions = DefinitionsClient.new(self)
+            @emails = EmailsClient.new(self)
+            @invoice_history = InvoiceHistoryClient.new(self)
+            @invoices = InvoicesClient.new(self)
+            @leads = LeadsClient.new(self)
+            @notes = NotesClient.new(self)
+            @payment_applications = PaymentApplicationsClient.new(self)
+            @payments = PaymentsClient.new(self)
+            @provisioning = ProvisioningClient.new(self)
+            @reports = ReportsClient.new(self)
+            @status = StatusClient.new(self)
+            @sync = SyncClient.new(self)
+            @user_accounts = UserAccountsClient.new(self)
+            @user_roles = UserRolesClient.new(self)
+        end
+
+        ##
+        # Configure this API client to use API key authentication
+        #
+        # @param api_key [string] The [Lockstep Platform API key](https://developer.lockstep.io/docs/api-keys) to use for authentication
+        def with_api_key(api_key)
+            @bearer_token = nil
+            @api_key = api_key
+        end
+
+        ##
+        # Configure this API client to use JWT Bearer Token authentication
+        #
+        # @param bearer_token [string] The [JWT Bearer Token](https://developer.lockstep.io/docs/jwt-bearer-tokens) to use for authentication
+        def with_bearer_token(bearer_token)
+            @api_key = nil
+            @bearer_token = bearer_token
+        end
+
+        ##
+        # Configure this API to use an application name
+        #
+        # @param app_name [string] The name of the application
+        def with_app_name(app_name)
+            @app_name = app_name
+        end
+
+        ##
+        # Send a request to the API and return the results
+        #
+        # Sends a request to the 
+        def request(method, path, body, params)
+        
+            url = URI(@env + path)
+            if !params.nil?  
+                url.query = URI.encode_www_form(params)
+            end
+            
+            http = Net::HTTP.new(url.host, url.port)
+            http.use_ssl = true
+            
+            request = case method
+                when :get
+                    Net::HTTP::Get.new(url)
+                when :post
+                    Net::HTTP::Post.new(url)
+                when :patch
+                    Net::HTTP::Patch.new(url)
+                when :put
+                    Net::HTTP::Put.new(url)
+                when :delete
+                    Net::HTTP::Delete.new(url)
+                end
+                
+            # Set headers and body for request
+            request["Accept"] = 'application/json'
+            request["Content-Type"] = 'application/*+json'
+            request["SdkType"] = 'Ruby'
+            request["SdkVersion"] = '2022.4.32.0'
+            request["MachineName"] = Socket.gethostname
+            request.body = body
+
+            # If there is an application name
+            if @app_name != nil
+                request["ApplicationName"] = @app_name
+            end
+
+            # Which authentication are we using?
+            if @api_key != nil 
+              request["Api-Key"] = @api_key
+            end
+            if @bearer_token != nil 
+              request["Authorization"] = 'Bearer ' + @bearer_token
+            end
+            
+            # Send the request
+            response = http.request(request)
+            response.read_body
+        end
+    end   
+end  

data/lib/lockstep_sdk/models/activity_model.rb

@@ -0,0 +1,221 @@
+#
+# 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 Activity contains information about work being done on a specific accounting task.
+    # You can use Activities to track information about who has been assigned a specific task,
+    # the current status of the task, the name and description given for the particular task,
+    # the priority of the task, and any amounts collected, paid, or credited for the task.
+    class ActivityModel
+
+        ##
+        # Initialize the ActivityModel using the provided prototype
+        def initialize(params = {})
+            @activity_id = params.dig(:activity_id)
+            @group_key = params.dig(:group_key)
+            @company_id = params.dig(:company_id)
+            @activity_type_code = params.dig(:activity_type_code)
+            @activity_name = params.dig(:activity_name)
+            @activity_description = params.dig(:activity_description)
+            @activity_status = params.dig(:activity_status)
+            @is_open = params.dig(:is_open)
+            @priority = params.dig(:priority)
+            @user_assigned_to = params.dig(:user_assigned_to)
+            @date_assigned = params.dig(:date_assigned)
+            @date_closed = params.dig(:date_closed)
+            @snooze_until_date = params.dig(:snooze_until_date)
+            @created = params.dig(:created)
+            @created_user_id = params.dig(:created_user_id)
+            @modified = params.dig(:modified)
+            @modified_user_id = params.dig(:modified_user_id)
+            @amount_collected = params.dig(:amount_collected)
+            @amount_paid = params.dig(:amount_paid)
+            @credit_given = params.dig(:credit_given)
+            @is_unread = params.dig(:is_unread)
+            @is_archived = params.dig(:is_archived)
+            @company = params.dig(:company)
+            @user_assigned_to_name = params.dig(:user_assigned_to_name)
+            @attachments = params.dig(:attachments)
+            @notes = params.dig(:notes)
+            @custom_field_definitions = params.dig(:custom_field_definitions)
+            @custom_field_values = params.dig(:custom_field_values)
+            @references = params.dig(:references)
+        end
+
+        ##
+        # @return [Uuid] The unique ID of this record, automatically assigned by Lockstep when this record is added to the Lockstep platform.
+        attr_accessor :activity_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 of the company to which this activity belongs.
+        attr_accessor :company_id
+
+        ##
+        # @return [String] The type code of the activity
+        attr_accessor :activity_type_code
+
+        ##
+        # @return [String] The name of the activity. The name is a short name provided by the person who created the activity that can be displayed in a list.
+        attr_accessor :activity_name
+
+        ##
+        # @return [String] A description of the activity. This field contains more detailed text about the activity and can be lengthy.
+        attr_accessor :activity_description
+
+        ##
+        # @return [String] The status of the activity.
+        attr_accessor :activity_status
+
+        ##
+        # @return [Boolean] True if this activity is currently "open", which indicates that the activitiy is currently in progress.
+        attr_accessor :is_open
+
+        ##
+        # @return [String] The priority of the activity.
+        attr_accessor :priority
+
+        ##
+        # @return [Uuid] The ID of the user the activity is assigned to.
+        attr_accessor :user_assigned_to
+
+        ##
+        # @return [Date-time] The date the activity was assigned.
+        attr_accessor :date_assigned
+
+        ##
+        # @return [Date-time] The date the activity was closed.
+        attr_accessor :date_closed
+
+        ##
+        # @return [Date-time] If this activity has been "snoozed", this field will be non-null and will contain the date when the activity will be displayed. Until that date arrives, the activity will remain hidden.
+        attr_accessor :snooze_until_date
+
+        ##
+        # @return [Date-time] The date on which this activity was created.
+        attr_accessor :created
+
+        ##
+        # @return [Uuid] The ID of the user who created this activity.
+        attr_accessor :created_user_id
+
+        ##
+        # @return [Date-time] The date on which this activity was last modified.
+        attr_accessor :modified
+
+        ##
+        # @return [Uuid] The ID of the user who last modified this activity.
+        attr_accessor :modified_user_id
+
+        ##
+        # @return [Double] Amount collected (if any) for the activity.
+        attr_accessor :amount_collected
+
+        ##
+        # @return [Double] Amount paid (if any) for the activity.
+        attr_accessor :amount_paid
+
+        ##
+        # @return [Double] Credit given (if any) for the activity.
+        attr_accessor :credit_given
+
+        ##
+        # @return [Boolean] True if this activity is to be shown in an "unread" state. When an activity is read by a person it is assigned to, this flag is set to false.
+        attr_accessor :is_unread
+
+        ##
+        # @return [Boolean] Activities may be archived when they should be hidden from the user. When this flag is true, this activity should be hidden.
+        attr_accessor :is_archived
+
+        ##
+        # @return [CompanyModel] The company associated with the activity To retrieve this collection, specify `Company` in the "Include" parameter for your query.
+        attr_accessor :company
+
+        ##
+        # @return [String] The name of the user the activity is assigned to
+        attr_accessor :user_assigned_to_name
+
+        ##
+        # @return [AttachmentModel] All attachments attached to applied activity. To retrieve this collection, specify `Attachments` in the "Include" parameter for your query.
+        attr_accessor :attachments
+
+        ##
+        # @return [NoteModel] All notes attached to this applied activity. To retrieve this collection, specify `Notes` in the "Include" parameter for your query.
+        attr_accessor :notes
+
+        ##
+        # @return [CustomFieldDefinitionModel] All definitions attached to this applied activity. To retrieve this collection, specify `CustomFieldValues` in the "Include" parameter for your query.
+        attr_accessor :custom_field_definitions
+
+        ##
+        # @return [CustomFieldValueModel] All values attached to this activity. To retrieve this collection, specify `CustomFieldValues` in the "Include" parameter for your query.
+        attr_accessor :custom_field_values
+
+        ##
+        # @return [ActivityXRefModel] All references attached to this applied activity. To retrieve this collection, specify `References` in the "Include" parameter for your query.
+        attr_accessor :references
+
+        ##
+        # @return [object] This object as a JSON key-value structure
+        def as_json(options={})
+            {
+                'activityId' => @activity_id,
+                'groupKey' => @group_key,
+                'companyId' => @company_id,
+                'activityTypeCode' => @activity_type_code,
+                'activityName' => @activity_name,
+                'activityDescription' => @activity_description,
+                'activityStatus' => @activity_status,
+                'isOpen' => @is_open,
+                'priority' => @priority,
+                'userAssignedTo' => @user_assigned_to,
+                'dateAssigned' => @date_assigned,
+                'dateClosed' => @date_closed,
+                'snoozeUntilDate' => @snooze_until_date,
+                'created' => @created,
+                'createdUserId' => @created_user_id,
+                'modified' => @modified,
+                'modifiedUserId' => @modified_user_id,
+                'amountCollected' => @amount_collected,
+                'amountPaid' => @amount_paid,
+                'creditGiven' => @credit_given,
+                'isUnread' => @is_unread,
+                'isArchived' => @is_archived,
+                'company' => @company,
+                'userAssignedToName' => @user_assigned_to_name,
+                'attachments' => @attachments,
+                'notes' => @notes,
+                'customFieldDefinitions' => @custom_field_definitions,
+                'customFieldValues' => @custom_field_values,
+                'references' => @references,
+            }
+        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/activity_stream_item_model.rb

@@ -0,0 +1,104 @@
+#
+# 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 an item belonging to the activity stream.
+    class ActivityStreamItemModel
+
+        ##
+        # Initialize the ActivityStreamItemModel using the provided prototype
+        def initialize(params = {})
+            @object_key = params.dig(:object_key)
+            @activity_stream_type = params.dig(:activity_stream_type)
+            @text_value = params.dig(:text_value)
+            @created = params.dig(:created)
+            @created_user_id = params.dig(:created_user_id)
+            @group_key = params.dig(:group_key)
+            @from_email_address = params.dig(:from_email_address)
+            @to_email_address = params.dig(:to_email_address)
+            @from_contact_name = params.dig(:from_contact_name)
+            @to_contact_name = params.dig(:to_contact_name)
+        end
+
+        ##
+        # @return [Uuid] The object key of the activity stream item.
+        attr_accessor :object_key
+
+        ##
+        # @return [String] The type code of the activity stream item.
+        attr_accessor :activity_stream_type
+
+        ##
+        # @return [String] The text body description for this Activity Stream Item.
+        attr_accessor :text_value
+
+        ##
+        # @return [Date-time] The date on which this activity stream item was created.
+        attr_accessor :created
+
+        ##
+        # @return [Uuid] The ID of the user who created this activity.
+        attr_accessor :created_user_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 [String] The sender's email address if activity stream item is an Email.
+        attr_accessor :from_email_address
+
+        ##
+        # @return [String] The recipient's email address if activity stream item is an Email.
+        attr_accessor :to_email_address
+
+        ##
+        # @return [String] The name of the contact sending the activity otherwise null.
+        attr_accessor :from_contact_name
+
+        ##
+        # @return [String] The name of the contact sending the activity otherwise null.
+        attr_accessor :to_contact_name
+
+        ##
+        # @return [object] This object as a JSON key-value structure
+        def as_json(options={})
+            {
+                'objectKey' => @object_key,
+                'activityStreamType' => @activity_stream_type,
+                'textValue' => @text_value,
+                'created' => @created,
+                'createdUserId' => @created_user_id,
+                'groupKey' => @group_key,
+                'fromEmailAddress' => @from_email_address,
+                'toEmailAddress' => @to_email_address,
+                'fromContactName' => @from_contact_name,
+                'toContactName' => @to_contact_name,
+            }
+        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/activity_xref_model.rb

@@ -0,0 +1,72 @@
+#
+# 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
+
+    class ActivityXRefModel
+
+        ##
+        # Initialize the ActivityXRefModel using the provided prototype
+        def initialize(params = {})
+            @activity_xref_id = params.dig(:activity_xref_id)
+            @activity_id = params.dig(:activity_id)
+            @group_key = params.dig(:group_key)
+            @table_key = params.dig(:table_key)
+            @object_key = params.dig(:object_key)
+        end
+
+        ##
+        # @return [Uuid] The unique ID of this record, automatically assigned by Lockstep when this is added to the Lockstep platform.
+        attr_accessor :activity_xref_id
+
+        ##
+        # @return [Uuid] The ID of the activity to which this reference belongs.
+        attr_accessor :activity_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 [String] The name of the table the activity reference is associated with
+        attr_accessor :table_key
+
+        ##
+        # @return [String] The ID of the object the activity reference is associated with
+        attr_accessor :object_key
+
+        ##
+        # @return [object] This object as a JSON key-value structure
+        def as_json(options={})
+            {
+                'activityXRefId' => @activity_xref_id,
+                'activityId' => @activity_id,
+                'groupKey' => @group_key,
+                'tableKey' => @table_key,
+                'objectKey' => @object_key,
+            }
+        end
+
+        ##
+        # @return [String] This object converted to a JSON string
+        def to_json(*options)
+            "[#{as_json(*options).to_json(*options)}]"
+        end
+    end
+end