merge_ruby_client 0.0.1

data/lib/merge_ruby_client/crm/leads/client.rb

@@ -0,0 +1,357 @@
+# frozen_string_literal: true
+
+require_relative "../../../requests"
+require "date"
+require_relative "types/leads_list_request_expand"
+require_relative "../types/paginated_lead_list"
+require_relative "../types/lead_request"
+require_relative "../types/lead_response"
+require_relative "types/leads_retrieve_request_expand"
+require_relative "../types/lead"
+require_relative "../types/meta_response"
+require_relative "../types/paginated_remote_field_class_list"
+require "async"
+
+module Merge
+  module Crm
+    class LeadsClient
+      attr_reader :request_client
+
+      # @param request_client [RequestClient]
+      # @return [Crm::LeadsClient]
+      def initialize(request_client:)
+        # @type [RequestClient]
+        @request_client = request_client
+      end
+
+      # Returns a list of `Lead` objects.
+      #
+      # @param converted_account_id [String] If provided, will only return leads with this account.
+      # @param converted_contact_id [String] If provided, will only return leads with this contact.
+      # @param created_after [DateTime] If provided, will only return objects created after this datetime.
+      # @param created_before [DateTime] If provided, will only return objects created before this datetime.
+      # @param cursor [String] The pagination cursor value.
+      # @param email_addresses [String] If provided, will only return contacts matching the email addresses; multiple email_addresses can be separated by commas.
+      # @param expand [LEADS_LIST_REQUEST_EXPAND] Which relations should be returned in expanded form. Multiple relation names should be comma separated without spaces.
+      # @param include_deleted_data [Boolean] Whether to include data that was marked as deleted by third party webhooks.
+      # @param include_remote_data [Boolean] Whether to include the original data Merge fetched from the third-party to produce these models.
+      # @param include_remote_fields [Boolean] Whether to include all remote fields, including fields that Merge did not map to common models, in a normalized format.
+      # @param modified_after [DateTime] If provided, only objects synced by Merge after this date time will be returned.
+      # @param modified_before [DateTime] If provided, only objects synced by Merge before this date time will be returned.
+      # @param owner_id [String] If provided, will only return leads with this owner.
+      # @param page_size [Integer] Number of results to return per page.
+      # @param phone_numbers [String] If provided, will only return contacts matching the phone numbers; multiple phone numbers can be separated by commas.
+      # @param remote_id [String] The API provider's ID for the given object.
+      # @param request_options [RequestOptions]
+      # @return [Crm::PaginatedLeadList]
+      def list(converted_account_id: nil, converted_contact_id: nil, created_after: nil, created_before: nil,
+               cursor: nil, email_addresses: nil, expand: nil, include_deleted_data: nil, include_remote_data: nil, include_remote_fields: nil, modified_after: nil, modified_before: nil, owner_id: nil, page_size: nil, phone_numbers: nil, remote_id: nil, request_options: nil)
+        response = @request_client.conn.get("/api/crm/v1/leads") do |req|
+          req.options.timeout = request_options.timeout_in_seconds unless request_options&.timeout_in_seconds.nil?
+          req.headers["Authorization"] = request_options.api_key unless request_options&.api_key.nil?
+          req.headers["X-Account-Token"] = request_options.account_token unless request_options&.account_token.nil?
+          req.headers = { **req.headers, **(request_options&.additional_headers || {}) }.compact
+          req.params = {
+            **(request_options&.additional_query_parameters || {}),
+            "converted_account_id": converted_account_id,
+            "converted_contact_id": converted_contact_id,
+            "created_after": created_after,
+            "created_before": created_before,
+            "cursor": cursor,
+            "email_addresses": email_addresses,
+            "expand": expand,
+            "include_deleted_data": include_deleted_data,
+            "include_remote_data": include_remote_data,
+            "include_remote_fields": include_remote_fields,
+            "modified_after": modified_after,
+            "modified_before": modified_before,
+            "owner_id": owner_id,
+            "page_size": page_size,
+            "phone_numbers": phone_numbers,
+            "remote_id": remote_id
+          }.compact
+        end
+        Crm::PaginatedLeadList.from_json(json_object: response.body)
+      end
+
+      # Creates a `Lead` object with the given values.
+      #
+      # @param is_debug_mode [Boolean] Whether to include debug fields (such as log file links) in the response.
+      # @param run_async [Boolean] Whether or not third-party updates should be run asynchronously.
+      # @param model [Hash] Request of type Crm::LeadRequest, as a Hash
+      #   * :owner (Hash)
+      #   * :lead_source (String)
+      #   * :title (String)
+      #   * :company (String)
+      #   * :first_name (String)
+      #   * :last_name (String)
+      #   * :addresses (Array<Crm::AddressRequest>)
+      #   * :email_addresses (Array<Crm::EmailAddressRequest>)
+      #   * :phone_numbers (Array<Crm::PhoneNumberRequest>)
+      #   * :converted_date (DateTime)
+      #   * :converted_contact (Hash)
+      #   * :converted_account (Hash)
+      #   * :integration_params (Hash{String => String})
+      #   * :linked_account_params (Hash{String => String})
+      #   * :remote_fields (Array<Crm::RemoteFieldRequest>)
+      # @param request_options [RequestOptions]
+      # @return [Crm::LeadResponse]
+      def create(model:, is_debug_mode: nil, run_async: nil, request_options: nil)
+        response = @request_client.conn.post("/api/crm/v1/leads") do |req|
+          req.options.timeout = request_options.timeout_in_seconds unless request_options&.timeout_in_seconds.nil?
+          req.headers["Authorization"] = request_options.api_key unless request_options&.api_key.nil?
+          req.headers["X-Account-Token"] = request_options.account_token unless request_options&.account_token.nil?
+          req.headers = { **req.headers, **(request_options&.additional_headers || {}) }.compact
+          req.params = {
+            **(request_options&.additional_query_parameters || {}),
+            "is_debug_mode": is_debug_mode,
+            "run_async": run_async
+          }.compact
+          req.body = { **(request_options&.additional_body_parameters || {}), model: model }.compact
+        end
+        Crm::LeadResponse.from_json(json_object: response.body)
+      end
+
+      # Returns a `Lead` object with the given `id`.
+      #
+      # @param id [String]
+      # @param expand [LEADS_RETRIEVE_REQUEST_EXPAND] Which relations should be returned in expanded form. Multiple relation names should be comma separated without spaces.
+      # @param include_remote_data [Boolean] Whether to include the original data Merge fetched from the third-party to produce these models.
+      # @param include_remote_fields [Boolean] Whether to include all remote fields, including fields that Merge did not map to common models, in a normalized format.
+      # @param request_options [RequestOptions]
+      # @return [Crm::Lead]
+      def retrieve(id:, expand: nil, include_remote_data: nil, include_remote_fields: nil, request_options: nil)
+        response = @request_client.conn.get("/api/crm/v1/leads/#{id}") do |req|
+          req.options.timeout = request_options.timeout_in_seconds unless request_options&.timeout_in_seconds.nil?
+          req.headers["Authorization"] = request_options.api_key unless request_options&.api_key.nil?
+          req.headers["X-Account-Token"] = request_options.account_token unless request_options&.account_token.nil?
+          req.headers = { **req.headers, **(request_options&.additional_headers || {}) }.compact
+          req.params = {
+            **(request_options&.additional_query_parameters || {}),
+            "expand": expand,
+            "include_remote_data": include_remote_data,
+            "include_remote_fields": include_remote_fields
+          }.compact
+        end
+        Crm::Lead.from_json(json_object: response.body)
+      end
+
+      # Returns metadata for `Lead` POSTs.
+      #
+      # @param request_options [RequestOptions]
+      # @return [Crm::MetaResponse]
+      def meta_post_retrieve(request_options: nil)
+        response = @request_client.conn.get("/api/crm/v1/leads/meta/post") do |req|
+          req.options.timeout = request_options.timeout_in_seconds unless request_options&.timeout_in_seconds.nil?
+          req.headers["Authorization"] = request_options.api_key unless request_options&.api_key.nil?
+          req.headers["X-Account-Token"] = request_options.account_token unless request_options&.account_token.nil?
+          req.headers = { **req.headers, **(request_options&.additional_headers || {}) }.compact
+        end
+        Crm::MetaResponse.from_json(json_object: response.body)
+      end
+
+      # Returns a list of `RemoteFieldClass` objects.
+      #
+      # @param cursor [String] The pagination cursor value.
+      # @param include_deleted_data [Boolean] Whether to include data that was marked as deleted by third party webhooks.
+      # @param include_remote_data [Boolean] Whether to include the original data Merge fetched from the third-party to produce these models.
+      # @param include_remote_fields [Boolean] Whether to include all remote fields, including fields that Merge did not map to common models, in a normalized format.
+      # @param page_size [Integer] Number of results to return per page.
+      # @param request_options [RequestOptions]
+      # @return [Crm::PaginatedRemoteFieldClassList]
+      def remote_field_classes_list(cursor: nil, include_deleted_data: nil, include_remote_data: nil,
+                                    include_remote_fields: nil, page_size: nil, request_options: nil)
+        response = @request_client.conn.get("/api/crm/v1/leads/remote-field-classes") do |req|
+          req.options.timeout = request_options.timeout_in_seconds unless request_options&.timeout_in_seconds.nil?
+          req.headers["Authorization"] = request_options.api_key unless request_options&.api_key.nil?
+          req.headers["X-Account-Token"] = request_options.account_token unless request_options&.account_token.nil?
+          req.headers = { **req.headers, **(request_options&.additional_headers || {}) }.compact
+          req.params = {
+            **(request_options&.additional_query_parameters || {}),
+            "cursor": cursor,
+            "include_deleted_data": include_deleted_data,
+            "include_remote_data": include_remote_data,
+            "include_remote_fields": include_remote_fields,
+            "page_size": page_size
+          }.compact
+        end
+        Crm::PaginatedRemoteFieldClassList.from_json(json_object: response.body)
+      end
+    end
+
+    class AsyncLeadsClient
+      attr_reader :request_client
+
+      # @param request_client [AsyncRequestClient]
+      # @return [Crm::AsyncLeadsClient]
+      def initialize(request_client:)
+        # @type [AsyncRequestClient]
+        @request_client = request_client
+      end
+
+      # Returns a list of `Lead` objects.
+      #
+      # @param converted_account_id [String] If provided, will only return leads with this account.
+      # @param converted_contact_id [String] If provided, will only return leads with this contact.
+      # @param created_after [DateTime] If provided, will only return objects created after this datetime.
+      # @param created_before [DateTime] If provided, will only return objects created before this datetime.
+      # @param cursor [String] The pagination cursor value.
+      # @param email_addresses [String] If provided, will only return contacts matching the email addresses; multiple email_addresses can be separated by commas.
+      # @param expand [LEADS_LIST_REQUEST_EXPAND] Which relations should be returned in expanded form. Multiple relation names should be comma separated without spaces.
+      # @param include_deleted_data [Boolean] Whether to include data that was marked as deleted by third party webhooks.
+      # @param include_remote_data [Boolean] Whether to include the original data Merge fetched from the third-party to produce these models.
+      # @param include_remote_fields [Boolean] Whether to include all remote fields, including fields that Merge did not map to common models, in a normalized format.
+      # @param modified_after [DateTime] If provided, only objects synced by Merge after this date time will be returned.
+      # @param modified_before [DateTime] If provided, only objects synced by Merge before this date time will be returned.
+      # @param owner_id [String] If provided, will only return leads with this owner.
+      # @param page_size [Integer] Number of results to return per page.
+      # @param phone_numbers [String] If provided, will only return contacts matching the phone numbers; multiple phone numbers can be separated by commas.
+      # @param remote_id [String] The API provider's ID for the given object.
+      # @param request_options [RequestOptions]
+      # @return [Crm::PaginatedLeadList]
+      def list(converted_account_id: nil, converted_contact_id: nil, created_after: nil, created_before: nil,
+               cursor: nil, email_addresses: nil, expand: nil, include_deleted_data: nil, include_remote_data: nil, include_remote_fields: nil, modified_after: nil, modified_before: nil, owner_id: nil, page_size: nil, phone_numbers: nil, remote_id: nil, request_options: nil)
+        Async do
+          response = @request_client.conn.get("/api/crm/v1/leads") do |req|
+            req.options.timeout = request_options.timeout_in_seconds unless request_options&.timeout_in_seconds.nil?
+            req.headers["Authorization"] = request_options.api_key unless request_options&.api_key.nil?
+            req.headers["X-Account-Token"] = request_options.account_token unless request_options&.account_token.nil?
+            req.headers = { **req.headers, **(request_options&.additional_headers || {}) }.compact
+            req.params = {
+              **(request_options&.additional_query_parameters || {}),
+              "converted_account_id": converted_account_id,
+              "converted_contact_id": converted_contact_id,
+              "created_after": created_after,
+              "created_before": created_before,
+              "cursor": cursor,
+              "email_addresses": email_addresses,
+              "expand": expand,
+              "include_deleted_data": include_deleted_data,
+              "include_remote_data": include_remote_data,
+              "include_remote_fields": include_remote_fields,
+              "modified_after": modified_after,
+              "modified_before": modified_before,
+              "owner_id": owner_id,
+              "page_size": page_size,
+              "phone_numbers": phone_numbers,
+              "remote_id": remote_id
+            }.compact
+          end
+          Crm::PaginatedLeadList.from_json(json_object: response.body)
+        end
+      end
+
+      # Creates a `Lead` object with the given values.
+      #
+      # @param is_debug_mode [Boolean] Whether to include debug fields (such as log file links) in the response.
+      # @param run_async [Boolean] Whether or not third-party updates should be run asynchronously.
+      # @param model [Hash] Request of type Crm::LeadRequest, as a Hash
+      #   * :owner (Hash)
+      #   * :lead_source (String)
+      #   * :title (String)
+      #   * :company (String)
+      #   * :first_name (String)
+      #   * :last_name (String)
+      #   * :addresses (Array<Crm::AddressRequest>)
+      #   * :email_addresses (Array<Crm::EmailAddressRequest>)
+      #   * :phone_numbers (Array<Crm::PhoneNumberRequest>)
+      #   * :converted_date (DateTime)
+      #   * :converted_contact (Hash)
+      #   * :converted_account (Hash)
+      #   * :integration_params (Hash{String => String})
+      #   * :linked_account_params (Hash{String => String})
+      #   * :remote_fields (Array<Crm::RemoteFieldRequest>)
+      # @param request_options [RequestOptions]
+      # @return [Crm::LeadResponse]
+      def create(model:, is_debug_mode: nil, run_async: nil, request_options: nil)
+        Async do
+          response = @request_client.conn.post("/api/crm/v1/leads") do |req|
+            req.options.timeout = request_options.timeout_in_seconds unless request_options&.timeout_in_seconds.nil?
+            req.headers["Authorization"] = request_options.api_key unless request_options&.api_key.nil?
+            req.headers["X-Account-Token"] = request_options.account_token unless request_options&.account_token.nil?
+            req.headers = { **req.headers, **(request_options&.additional_headers || {}) }.compact
+            req.params = {
+              **(request_options&.additional_query_parameters || {}),
+              "is_debug_mode": is_debug_mode,
+              "run_async": run_async
+            }.compact
+            req.body = { **(request_options&.additional_body_parameters || {}), model: model }.compact
+          end
+          Crm::LeadResponse.from_json(json_object: response.body)
+        end
+      end
+
+      # Returns a `Lead` object with the given `id`.
+      #
+      # @param id [String]
+      # @param expand [LEADS_RETRIEVE_REQUEST_EXPAND] Which relations should be returned in expanded form. Multiple relation names should be comma separated without spaces.
+      # @param include_remote_data [Boolean] Whether to include the original data Merge fetched from the third-party to produce these models.
+      # @param include_remote_fields [Boolean] Whether to include all remote fields, including fields that Merge did not map to common models, in a normalized format.
+      # @param request_options [RequestOptions]
+      # @return [Crm::Lead]
+      def retrieve(id:, expand: nil, include_remote_data: nil, include_remote_fields: nil, request_options: nil)
+        Async do
+          response = @request_client.conn.get("/api/crm/v1/leads/#{id}") do |req|
+            req.options.timeout = request_options.timeout_in_seconds unless request_options&.timeout_in_seconds.nil?
+            req.headers["Authorization"] = request_options.api_key unless request_options&.api_key.nil?
+            req.headers["X-Account-Token"] = request_options.account_token unless request_options&.account_token.nil?
+            req.headers = { **req.headers, **(request_options&.additional_headers || {}) }.compact
+            req.params = {
+              **(request_options&.additional_query_parameters || {}),
+              "expand": expand,
+              "include_remote_data": include_remote_data,
+              "include_remote_fields": include_remote_fields
+            }.compact
+          end
+          Crm::Lead.from_json(json_object: response.body)
+        end
+      end
+
+      # Returns metadata for `Lead` POSTs.
+      #
+      # @param request_options [RequestOptions]
+      # @return [Crm::MetaResponse]
+      def meta_post_retrieve(request_options: nil)
+        Async do
+          response = @request_client.conn.get("/api/crm/v1/leads/meta/post") do |req|
+            req.options.timeout = request_options.timeout_in_seconds unless request_options&.timeout_in_seconds.nil?
+            req.headers["Authorization"] = request_options.api_key unless request_options&.api_key.nil?
+            req.headers["X-Account-Token"] = request_options.account_token unless request_options&.account_token.nil?
+            req.headers = { **req.headers, **(request_options&.additional_headers || {}) }.compact
+          end
+          Crm::MetaResponse.from_json(json_object: response.body)
+        end
+      end
+
+      # Returns a list of `RemoteFieldClass` objects.
+      #
+      # @param cursor [String] The pagination cursor value.
+      # @param include_deleted_data [Boolean] Whether to include data that was marked as deleted by third party webhooks.
+      # @param include_remote_data [Boolean] Whether to include the original data Merge fetched from the third-party to produce these models.
+      # @param include_remote_fields [Boolean] Whether to include all remote fields, including fields that Merge did not map to common models, in a normalized format.
+      # @param page_size [Integer] Number of results to return per page.
+      # @param request_options [RequestOptions]
+      # @return [Crm::PaginatedRemoteFieldClassList]
+      def remote_field_classes_list(cursor: nil, include_deleted_data: nil, include_remote_data: nil,
+                                    include_remote_fields: nil, page_size: nil, request_options: nil)
+        Async do
+          response = @request_client.conn.get("/api/crm/v1/leads/remote-field-classes") do |req|
+            req.options.timeout = request_options.timeout_in_seconds unless request_options&.timeout_in_seconds.nil?
+            req.headers["Authorization"] = request_options.api_key unless request_options&.api_key.nil?
+            req.headers["X-Account-Token"] = request_options.account_token unless request_options&.account_token.nil?
+            req.headers = { **req.headers, **(request_options&.additional_headers || {}) }.compact
+            req.params = {
+              **(request_options&.additional_query_parameters || {}),
+              "cursor": cursor,
+              "include_deleted_data": include_deleted_data,
+              "include_remote_data": include_remote_data,
+              "include_remote_fields": include_remote_fields,
+              "page_size": page_size
+            }.compact
+          end
+          Crm::PaginatedRemoteFieldClassList.from_json(json_object: response.body)
+        end
+      end
+    end
+  end
+end

data/lib/merge_ruby_client/crm/leads/types/leads_list_request_expand.rb

@@ -0,0 +1,18 @@
+# frozen_string_literal: true
+
+module Merge
+  module Crm
+    class Leads
+      # @type [LEADS_LIST_REQUEST_EXPAND]
+      LEADS_LIST_REQUEST_EXPAND = {
+        converted_account: "converted_account",
+        converted_contact: "converted_contact",
+        converted_contact_converted_account: "converted_contact,converted_account",
+        owner: "owner",
+        owner_converted_account: "owner,converted_account",
+        owner_converted_contact: "owner,converted_contact",
+        owner_converted_contact_converted_account: "owner,converted_contact,converted_account"
+      }.freeze
+    end
+  end
+end

data/lib/merge_ruby_client/crm/leads/types/leads_retrieve_request_expand.rb

@@ -0,0 +1,18 @@
+# frozen_string_literal: true
+
+module Merge
+  module Crm
+    class Leads
+      # @type [LEADS_RETRIEVE_REQUEST_EXPAND]
+      LEADS_RETRIEVE_REQUEST_EXPAND = {
+        converted_account: "converted_account",
+        converted_contact: "converted_contact",
+        converted_contact_converted_account: "converted_contact,converted_account",
+        owner: "owner",
+        owner_converted_account: "owner,converted_account",
+        owner_converted_contact: "owner,converted_contact",
+        owner_converted_contact_converted_account: "owner,converted_contact,converted_account"
+      }.freeze
+    end
+  end
+end

data/lib/merge_ruby_client/crm/link_token/client.rb

@@ -0,0 +1,109 @@
+# frozen_string_literal: true
+
+require_relative "../../../requests"
+require_relative "../types/categories_enum"
+require_relative "../types/common_model_scopes_body_request"
+require_relative "../types/link_token"
+require "async"
+
+module Merge
+  module Crm
+    class LinkTokenClient
+      attr_reader :request_client
+
+      # @param request_client [RequestClient]
+      # @return [Crm::LinkTokenClient]
+      def initialize(request_client:)
+        # @type [RequestClient]
+        @request_client = request_client
+      end
+
+      # Creates a link token to be used when linking a new end user.
+      #
+      # @param end_user_email_address [String] Your end user's email address. This is purely for identification purposes - setting this value will not cause any emails to be sent.
+      # @param end_user_organization_name [String] Your end user's organization.
+      # @param end_user_origin_id [String] This unique identifier typically represents the ID for your end user in your product's database. This value must be distinct from other Linked Accounts' unique identifiers.
+      # @param categories [Array<Crm::CATEGORIES_ENUM>] The integration categories to show in Merge Link.
+      # @param integration [String] The slug of a specific pre-selected integration for this linking flow token. For examples of slugs, see https://docs.merge.dev/guides/merge-link/single-integration/.
+      # @param link_expiry_mins [Integer] An integer number of minutes between [30, 720 or 10080 if for a Magic Link URL] for how long this token is valid. Defaults to 30.
+      # @param should_create_magic_link_url [Boolean] Whether to generate a Magic Link URL. Defaults to false. For more information on Magic Link, see https://merge.dev/blog/integrations-fast-say-hello-to-magic-link.
+      # @param common_models [Array<Hash>] An array of objects to specify the models and fields that will be disabled for a given Linked Account. Each object uses model_id, enabled_actions, and disabled_fields to specify the model, method, and fields that are scoped for a given Linked Account.Request of type Array<Crm::CommonModelScopesBodyRequest>, as a Hash
+      #   * :model_id (String)
+      #   * :enabled_actions (Array<Crm::ENABLED_ACTIONS_ENUM>)
+      #   * :disabled_fields (Array<String>)
+      # @param request_options [RequestOptions]
+      # @return [Crm::LinkToken]
+      def create(end_user_email_address:, end_user_organization_name:, end_user_origin_id:, categories:,
+                 integration: nil, link_expiry_mins: nil, should_create_magic_link_url: nil, common_models: nil, request_options: nil)
+        response = @request_client.conn.post("/api/crm/v1/link-token") do |req|
+          req.options.timeout = request_options.timeout_in_seconds unless request_options&.timeout_in_seconds.nil?
+          req.headers["Authorization"] = request_options.api_key unless request_options&.api_key.nil?
+          req.headers["X-Account-Token"] = request_options.account_token unless request_options&.account_token.nil?
+          req.headers = { **req.headers, **(request_options&.additional_headers || {}) }.compact
+          req.body = {
+            **(request_options&.additional_body_parameters || {}),
+            end_user_email_address: end_user_email_address,
+            end_user_organization_name: end_user_organization_name,
+            end_user_origin_id: end_user_origin_id,
+            categories: categories,
+            integration: integration,
+            link_expiry_mins: link_expiry_mins,
+            should_create_magic_link_url: should_create_magic_link_url,
+            common_models: common_models
+          }.compact
+        end
+        Crm::LinkToken.from_json(json_object: response.body)
+      end
+    end
+
+    class AsyncLinkTokenClient
+      attr_reader :request_client
+
+      # @param request_client [AsyncRequestClient]
+      # @return [Crm::AsyncLinkTokenClient]
+      def initialize(request_client:)
+        # @type [AsyncRequestClient]
+        @request_client = request_client
+      end
+
+      # Creates a link token to be used when linking a new end user.
+      #
+      # @param end_user_email_address [String] Your end user's email address. This is purely for identification purposes - setting this value will not cause any emails to be sent.
+      # @param end_user_organization_name [String] Your end user's organization.
+      # @param end_user_origin_id [String] This unique identifier typically represents the ID for your end user in your product's database. This value must be distinct from other Linked Accounts' unique identifiers.
+      # @param categories [Array<Crm::CATEGORIES_ENUM>] The integration categories to show in Merge Link.
+      # @param integration [String] The slug of a specific pre-selected integration for this linking flow token. For examples of slugs, see https://docs.merge.dev/guides/merge-link/single-integration/.
+      # @param link_expiry_mins [Integer] An integer number of minutes between [30, 720 or 10080 if for a Magic Link URL] for how long this token is valid. Defaults to 30.
+      # @param should_create_magic_link_url [Boolean] Whether to generate a Magic Link URL. Defaults to false. For more information on Magic Link, see https://merge.dev/blog/integrations-fast-say-hello-to-magic-link.
+      # @param common_models [Array<Hash>] An array of objects to specify the models and fields that will be disabled for a given Linked Account. Each object uses model_id, enabled_actions, and disabled_fields to specify the model, method, and fields that are scoped for a given Linked Account.Request of type Array<Crm::CommonModelScopesBodyRequest>, as a Hash
+      #   * :model_id (String)
+      #   * :enabled_actions (Array<Crm::ENABLED_ACTIONS_ENUM>)
+      #   * :disabled_fields (Array<String>)
+      # @param request_options [RequestOptions]
+      # @return [Crm::LinkToken]
+      def create(end_user_email_address:, end_user_organization_name:, end_user_origin_id:, categories:,
+                 integration: nil, link_expiry_mins: nil, should_create_magic_link_url: nil, common_models: nil, request_options: nil)
+        Async do
+          response = @request_client.conn.post("/api/crm/v1/link-token") do |req|
+            req.options.timeout = request_options.timeout_in_seconds unless request_options&.timeout_in_seconds.nil?
+            req.headers["Authorization"] = request_options.api_key unless request_options&.api_key.nil?
+            req.headers["X-Account-Token"] = request_options.account_token unless request_options&.account_token.nil?
+            req.headers = { **req.headers, **(request_options&.additional_headers || {}) }.compact
+            req.body = {
+              **(request_options&.additional_body_parameters || {}),
+              end_user_email_address: end_user_email_address,
+              end_user_organization_name: end_user_organization_name,
+              end_user_origin_id: end_user_origin_id,
+              categories: categories,
+              integration: integration,
+              link_expiry_mins: link_expiry_mins,
+              should_create_magic_link_url: should_create_magic_link_url,
+              common_models: common_models
+            }.compact
+          end
+          Crm::LinkToken.from_json(json_object: response.body)
+        end
+      end
+    end
+  end
+end

data/lib/merge_ruby_client/crm/linked_accounts/client.rb

@@ -0,0 +1,136 @@
+# frozen_string_literal: true
+
+require_relative "../../../requests"
+require_relative "types/linked_accounts_list_request_category"
+require_relative "../types/paginated_account_details_and_actions_list"
+require "async"
+
+module Merge
+  module Crm
+    class LinkedAccountsClient
+      attr_reader :request_client
+
+      # @param request_client [RequestClient]
+      # @return [Crm::LinkedAccountsClient]
+      def initialize(request_client:)
+        # @type [RequestClient]
+        @request_client = request_client
+      end
+
+      # List linked accounts for your organization.
+      #
+      # @param category [LINKED_ACCOUNTS_LIST_REQUEST_CATEGORY] Options: ('hris', 'ats', 'accounting', 'ticketing', 'crm', 'mktg', 'filestorage')
+      #   - `hris` - hris
+      #   - `ats` - ats
+      #   - `accounting` - accounting
+      #   - `ticketing` - ticketing
+      #   - `crm` - crm
+      #   - `mktg` - mktg
+      #   - `filestorage` - filestorage
+      # @param cursor [String] The pagination cursor value.
+      # @param end_user_email_address [String] If provided, will only return linked accounts associated with the given email address.
+      # @param end_user_organization_name [String] If provided, will only return linked accounts associated with the given organization name.
+      # @param end_user_origin_id [String] If provided, will only return linked accounts associated with the given origin ID.
+      # @param end_user_origin_ids [String] Comma-separated list of EndUser origin IDs, making it possible to specify multiple EndUsers at once.
+      # @param id [String]
+      # @param ids [String] Comma-separated list of LinkedAccount IDs, making it possible to specify multiple LinkedAccounts at once.
+      # @param include_duplicates [Boolean] If `true`, will include complete production duplicates of the account specified by the `id` query parameter in the response. `id` must be for a complete production linked account.
+      # @param integration_name [String] If provided, will only return linked accounts associated with the given integration name.
+      # @param is_test_account [String] If included, will only include test linked accounts. If not included, will only include non-test linked accounts.
+      # @param page_size [Integer] Number of results to return per page.
+      # @param status [String] Filter by status. Options: `COMPLETE`, `INCOMPLETE`, `RELINK_NEEDED`
+      # @param request_options [RequestOptions]
+      # @return [Crm::PaginatedAccountDetailsAndActionsList]
+      def list(category: nil, cursor: nil, end_user_email_address: nil, end_user_organization_name: nil,
+               end_user_origin_id: nil, end_user_origin_ids: nil, id: nil, ids: nil, include_duplicates: nil, integration_name: nil, is_test_account: nil, page_size: nil, status: nil, request_options: nil)
+        response = @request_client.conn.get("/api/crm/v1/linked-accounts") do |req|
+          req.options.timeout = request_options.timeout_in_seconds unless request_options&.timeout_in_seconds.nil?
+          req.headers["Authorization"] = request_options.api_key unless request_options&.api_key.nil?
+          req.headers["X-Account-Token"] = request_options.account_token unless request_options&.account_token.nil?
+          req.headers = { **req.headers, **(request_options&.additional_headers || {}) }.compact
+          req.params = {
+            **(request_options&.additional_query_parameters || {}),
+            "category": category,
+            "cursor": cursor,
+            "end_user_email_address": end_user_email_address,
+            "end_user_organization_name": end_user_organization_name,
+            "end_user_origin_id": end_user_origin_id,
+            "end_user_origin_ids": end_user_origin_ids,
+            "id": id,
+            "ids": ids,
+            "include_duplicates": include_duplicates,
+            "integration_name": integration_name,
+            "is_test_account": is_test_account,
+            "page_size": page_size,
+            "status": status
+          }.compact
+        end
+        Crm::PaginatedAccountDetailsAndActionsList.from_json(json_object: response.body)
+      end
+    end
+
+    class AsyncLinkedAccountsClient
+      attr_reader :request_client
+
+      # @param request_client [AsyncRequestClient]
+      # @return [Crm::AsyncLinkedAccountsClient]
+      def initialize(request_client:)
+        # @type [AsyncRequestClient]
+        @request_client = request_client
+      end
+
+      # List linked accounts for your organization.
+      #
+      # @param category [LINKED_ACCOUNTS_LIST_REQUEST_CATEGORY] Options: ('hris', 'ats', 'accounting', 'ticketing', 'crm', 'mktg', 'filestorage')
+      #   - `hris` - hris
+      #   - `ats` - ats
+      #   - `accounting` - accounting
+      #   - `ticketing` - ticketing
+      #   - `crm` - crm
+      #   - `mktg` - mktg
+      #   - `filestorage` - filestorage
+      # @param cursor [String] The pagination cursor value.
+      # @param end_user_email_address [String] If provided, will only return linked accounts associated with the given email address.
+      # @param end_user_organization_name [String] If provided, will only return linked accounts associated with the given organization name.
+      # @param end_user_origin_id [String] If provided, will only return linked accounts associated with the given origin ID.
+      # @param end_user_origin_ids [String] Comma-separated list of EndUser origin IDs, making it possible to specify multiple EndUsers at once.
+      # @param id [String]
+      # @param ids [String] Comma-separated list of LinkedAccount IDs, making it possible to specify multiple LinkedAccounts at once.
+      # @param include_duplicates [Boolean] If `true`, will include complete production duplicates of the account specified by the `id` query parameter in the response. `id` must be for a complete production linked account.
+      # @param integration_name [String] If provided, will only return linked accounts associated with the given integration name.
+      # @param is_test_account [String] If included, will only include test linked accounts. If not included, will only include non-test linked accounts.
+      # @param page_size [Integer] Number of results to return per page.
+      # @param status [String] Filter by status. Options: `COMPLETE`, `INCOMPLETE`, `RELINK_NEEDED`
+      # @param request_options [RequestOptions]
+      # @return [Crm::PaginatedAccountDetailsAndActionsList]
+      def list(category: nil, cursor: nil, end_user_email_address: nil, end_user_organization_name: nil,
+               end_user_origin_id: nil, end_user_origin_ids: nil, id: nil, ids: nil, include_duplicates: nil, integration_name: nil, is_test_account: nil, page_size: nil, status: nil, request_options: nil)
+        Async do
+          response = @request_client.conn.get("/api/crm/v1/linked-accounts") do |req|
+            req.options.timeout = request_options.timeout_in_seconds unless request_options&.timeout_in_seconds.nil?
+            req.headers["Authorization"] = request_options.api_key unless request_options&.api_key.nil?
+            req.headers["X-Account-Token"] = request_options.account_token unless request_options&.account_token.nil?
+            req.headers = { **req.headers, **(request_options&.additional_headers || {}) }.compact
+            req.params = {
+              **(request_options&.additional_query_parameters || {}),
+              "category": category,
+              "cursor": cursor,
+              "end_user_email_address": end_user_email_address,
+              "end_user_organization_name": end_user_organization_name,
+              "end_user_origin_id": end_user_origin_id,
+              "end_user_origin_ids": end_user_origin_ids,
+              "id": id,
+              "ids": ids,
+              "include_duplicates": include_duplicates,
+              "integration_name": integration_name,
+              "is_test_account": is_test_account,
+              "page_size": page_size,
+              "status": status
+            }.compact
+          end
+          Crm::PaginatedAccountDetailsAndActionsList.from_json(json_object: response.body)
+        end
+      end
+    end
+  end
+end