lockstep_sdk 2022.37.24.0 → 2023.1.3.0

data/lib/lockstep_sdk/clients/emails_client.rb

@@ -1,105 +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 'awrence'
-
-class EmailsClient
-
-    ##
-    # Initialize the EmailsClient class with an API client instance.
-    # @param connection [LockstepApi] The API client object for this connection
-    def initialize(connection)
-        @connection = connection
-    end
-
-
-    ##
-    # Retrieves the email with the specified email identifier.
-    #
-    # An Email represents a communication sent from one company to another.  The creator of the email is identified by the `CompanyId` field, recipient(s) by the `EmailTo` field, and cc recipient(s) by the 'EmailCC' field. The Email Model represents an email and a number of different metadata attributes related to the creation, storage, and ownership of the email.
-    #
-    # @param id [uuid] The unique ID number of the Email to retrieve.
-    # @param include_param [string] To fetch additional data on this object, specify the list of elements to retrieve. Available collections: Attachments, CustomFields, Notes, ResponseOrigin
-    def retrieve_email(id:, include_param:)
-        path = "/api/v1/Emails/#{id}"
-        params = {:include => include_param}
-        @connection.request(:get, path, nil, params)
-    end
-
-    ##
-    # Updates an existing Email with the information supplied to this PATCH call.
-    #
-    # The PATCH method allows you to change specific values on the object while leaving other values alone.  As input you should supply a list of field names and new values.  If you do not provide the name of a field, that field will remain unchanged.  This allows you to ensure that you are only updating the specific fields desired.
-    #
-    # An Email represents a communication sent from one company to another.  The creator of the email is identified by the `CompanyId` field, recipient(s) by the `EmailTo` field, and cc recipient(s) by the 'EmailCC' field. The Email Model represents an email and a number of different metadata attributes related to the creation, storage, and ownership of the email.
-    #
-    # @param id [uuid] The unique Lockstep Platform ID number of the email to update
-    # @param body [object] A list of changes to apply to this Email
-    def update_email(id:, body:)
-        path = "/api/v1/Emails/#{id}"
-        @connection.request(:patch, path, body.to_camelback_keys.to_json, nil)
-    end
-
-    ##
-    # Deletes the Email referred to by this unique identifier.
-    #
-    # An Email represents a communication sent from one company to another.  The creator of the email is identified by the `CompanyId` field, recipient(s) by the `EmailTo` field, and cc recipient(s) by the 'EmailCC' field. The Email Model represents an email and a number of different metadata attributes related to the creation, storage, and ownership of the email.
-    #
-    # @param id [uuid] The unique Lockstep Platform ID number of the Email to delete
-    def delete_email(id:)
-        path = "/api/v1/Emails/#{id}"
-        @connection.request(:delete, path, nil, nil)
-    end
-
-    ##
-    # Retrieves a signature logo for the email with the specified identifier and increments 'ViewCount'.
-    #
-    # An Email represents a communication sent from one company to another.  The creator of the email is identified by the `CompanyId` field, recipient(s) by the `EmailTo` field, and cc recipient(s) by the 'EmailCC' field. The Email Model represents an email and a number of different metadata attributes related to the creation, storage, and ownership of the email.
-    #
-    # @param email_id [uuid] The unique ID number of the Email to retrieve.
-    # @param nonce [uuid] The random nonce applied at time of url creation.
-    def retrieve_email_logo(email_id:, nonce:)
-        path = "/api/v1/Emails/#{emailId}/logo/#{nonce}"
-        @connection.request(:get, path, nil, nil)
-    end
-
-    ##
-    # Creates one or more emails from the specified array of Email Models
-    #
-    # An Email represents a communication sent from one company to another.  The creator of the email is identified by the `CompanyId` field, recipient(s) by the `EmailTo` field, and cc recipient(s) by the 'EmailCC' field. The Email Model represents an email and a number of different metadata attributes related to the creation, storage, and ownership of the email.
-    #
-    # @param body [EmailModel] The array of emails to be created
-    def create_emails(body:)
-        path = "/api/v1/Emails"
-        @connection.request(:post, path, body, nil)
-    end
-
-    ##
-    # Queries Emails on the Lockstep Platform using the specified filtering, sorting, nested fetch, and pagination rules requested.
-    #
-    # 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.
-    #
-    # An Email represents a communication sent from one company to another.  The creator of the email is identified by the `CompanyId` field, recipient(s) by the `EmailTo` field, and cc recipient(s) by the 'EmailCC' field. The Email Model represents an email and a number of different metadata attributes related to the creation, storage, and ownership of the email.
-    #
-    # @param filter [string] The filter to use to select from the list of available applications, in the [Searchlight query syntax](https://github.com/tspence/csharp-searchlight).
-    # @param include_param [string] To fetch additional data on this object, specify the list of elements to retrieve. Available collections: Attachments, CustomFields, Notes, ResponseOrigin
-    # @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). See [Searchlight Query Language](https://developer.lockstep.io/docs/querying-with-searchlight)
-    # @param page_number [int32] The page number for results (default 0). See [Searchlight Query Language](https://developer.lockstep.io/docs/querying-with-searchlight)
-    def query_emails(filter:, include_param:, order:, page_size:, page_number:)
-        path = "/api/v1/Emails/query"
-        params = {:filter => filter, :include => include_param, :order => order, :pageSize => page_size, :pageNumber => page_number}
-        @connection.request(:get, path, nil, params)
-    end
-end

data/lib/lockstep_sdk/clients/payment_applications_client.rb

@@ -1,93 +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 'awrence'
-
-class PaymentApplicationsClient
-
-    ##
-    # Initialize the PaymentApplicationsClient class with an API client instance.
-    # @param connection [LockstepApi] The API client object for this connection
-    def initialize(connection)
-        @connection = connection
-    end
-
-
-    ##
-    # Retrieves the Payment Application specified by this unique identifier, optionally including nested data sets.
-    #
-    # A Payment Application is created by a business who receives a Payment from a customer.  A customer may make a single Payment to match an Invoice exactly, a partial Payment for an Invoice, or a single Payment may be made for multiple smaller Invoices.  The Payment Application contains information about which Invoices are connected to which Payments and for which amounts.
-    #
-    # @param id [uuid] The unique Lockstep Platform ID number of this Payment Application; NOT the customer's ERP key
-    # @param include_param [string] To fetch additional data on this object, specify the list of elements to retrieve. Available collections: Invoice, Payment
-    def retrieve_payment_application(id:, include_param:)
-        path = "/api/v1/PaymentApplications/#{id}"
-        params = {:include => include_param}
-        @connection.request(:get, path, nil, params)
-    end
-
-    ##
-    # Updates an existing Payment Application with the information supplied to this PATCH call.
-    #
-    # The PATCH method allows you to change specific values on the object while leaving other values alone.  As input you should supply a list of field names and new values.  If you do not provide the name of a field, that field will remain unchanged.  This allows you to ensure that you are only updating the specific fields desired.
-    #
-    # A Payment Application is created by a business who receives a Payment from a customer.  A customer may make a single Payment to match an Invoice exactly, a partial Payment for an Invoice, or a single Payment may be made for multiple smaller Invoices.  The Payment Application contains information about which Invoices are connected to which Payments and for which amounts.
-    #
-    # @param id [uuid] The unique Lockstep Platform ID number of the Payment Application to update; NOT the customer's ERP key
-    # @param body [object] A list of changes to apply to this Payment Application
-    def update_payment_application(id:, body:)
-        path = "/api/v1/PaymentApplications/#{id}"
-        @connection.request(:patch, path, body.to_camelback_keys.to_json, nil)
-    end
-
-    ##
-    # Deletes the Payment Application referred to by this unique identifier.
-    #
-    # A Payment Application is created by a business who receives a Payment from a customer.  A customer may make a single Payment to match an Invoice exactly, a partial Payment for an Invoice, or a single Payment may be made for multiple smaller Invoices.  The Payment Application contains information about which Invoices are connected to which Payments and for which amounts.
-    #
-    # @param id [uuid] The unique Lockstep Platform ID number of the Payment Application to delete; NOT the customer's ERP key
-    def delete_payment_application(id:)
-        path = "/api/v1/PaymentApplications/#{id}"
-        @connection.request(:delete, path, nil, nil)
-    end
-
-    ##
-    # Creates one or more Payment Applications within this account and returns the records as created.
-    #
-    # A Payment Application is created by a business who receives a Payment from a customer.  A customer may make a single Payment to match an Invoice exactly, a partial Payment for an Invoice, or a single Payment may be made for multiple smaller Invoices.  The Payment Application contains information about which Invoices are connected to which Payments and for which amounts.
-    #
-    # @param body [PaymentAppliedModel] The Payment Applications to create
-    def create_payment_applications(body:)
-        path = "/api/v1/PaymentApplications"
-        @connection.request(:post, path, body, nil)
-    end
-
-    ##
-    # Queries Payment Applications for this account using the specified filtering, sorting, nested fetch, and pagination rules requested.
-    #
-    # 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 Payment Application is created by a business who receives a Payment from a customer.  A customer may make a single Payment to match an Invoice exactly, a partial Payment for an Invoice, or a single Payment may be made for multiple smaller Invoices.  The Payment Application contains information about which Invoices are connected to which Payments and for which amounts.
-    #
-    # @param filter [string] The filter for this query. See [Searchlight Query Language](https://developer.lockstep.io/docs/querying-with-searchlight)
-    # @param include_param [string] To fetch additional data on this object, specify the list of elements to retrieve. Available collections: Invoice
-    # @param order [string] The sort order for this query. See See [Searchlight Query Language](https://developer.lockstep.io/docs/querying-with-searchlight)
-    # @param page_size [int32] The page size for results (default 200). See [Searchlight Query Language](https://developer.lockstep.io/docs/querying-with-searchlight)
-    # @param page_number [int32] The page number for results (default 0). See [Searchlight Query Language](https://developer.lockstep.io/docs/querying-with-searchlight)
-    def query_payment_applications(filter:, include_param:, order:, page_size:, page_number:)
-        path = "/api/v1/PaymentApplications/query"
-        params = {:filter => filter, :include => include_param, :order => order, :pageSize => page_size, :pageNumber => page_number}
-        @connection.request(:get, path, nil, params)
-    end
-end

data/lib/lockstep_sdk/models/activity_model.rb

@@ -1,218 +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
-
-    ##
-    # 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 activity 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] 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 `Activity` and the `ObjectKey` set to the `ActivityId` 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 [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 `Activity` and the `ObjectKey` set to the `ActivityId` 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 [CustomFieldDefinitionModel] A collection of custom fields linked to this record. To retrieve this collection, specify `CustomFieldDefinitions` 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 `Activity` and the `ObjectKey` set to the `ActivityId` 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_definitions
-
-        ##
-        # @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 `Activity` and the `ObjectKey` set to the `ActivityId` 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
-
-        ##
-        # @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

@@ -1,101 +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 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

@@ -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 links between an Activity and another record.
-    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