merge_ruby_client 0.0.3 → 0.0.5

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

@@ -16,12 +16,12 @@ require "async"
 module Merge
   module Crm
     class EngagementsClient
+      # @return [Merge::RequestClient]
       attr_reader :request_client
 
-      # @param request_client [RequestClient]
-      # @return [Crm::EngagementsClient]
+      # @param request_client [Merge::RequestClient]
+      # @return [Merge::Crm::EngagementsClient]
       def initialize(request_client:)
-        # @type [RequestClient]
         @request_client = request_client
       end
 
@@ -30,21 +30,32 @@ module Merge
       # @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 expand [ENGAGEMENTS_LIST_REQUEST_EXPAND] Which relations should be returned in expanded form. Multiple relation names should be comma separated without spaces.
+      # @param expand [Merge::Crm::Engagements::EngagementsListRequestExpand] 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 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 modified_before [DateTime] If provided, only objects synced by Merge before this date time will be
+      #  returned.
       # @param page_size [Integer] Number of results to return per page.
       # @param remote_id [String] The API provider's ID for the given object.
       # @param started_after [DateTime] If provided, will only return engagements started after this datetime.
       # @param started_before [DateTime] If provided, will only return engagements started before this datetime.
-      # @param request_options [RequestOptions]
-      # @return [Crm::PaginatedEngagementList]
+      # @param request_options [Merge::RequestOptions]
+      # @return [Merge::Crm::PaginatedEngagementList]
+      # @example
+      #  api = Merge::Client.new(
+      #    environment: Environment::PRODUCTION,
+      #    base_url: "https://api.example.com",
+      #    api_key: "YOUR_AUTH_TOKEN"
+      #  )
+      #  api.crm.list
       def list(created_after: nil, created_before: nil, cursor: nil, expand: nil, include_deleted_data: nil,
                include_remote_data: nil, include_remote_fields: nil, modified_after: nil, modified_before: nil, page_size: nil, remote_id: nil, started_after: nil, started_before: nil, request_options: nil)
-        response = @request_client.conn.get("/api/crm/v1/engagements") do |req|
+        response = @request_client.conn.get 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?
@@ -65,31 +76,39 @@ module Merge
             "started_after": started_after,
             "started_before": started_before
           }.compact
+          req.url "#{@request_client.get_url(request_options: request_options)}/crm/v1/engagements"
         end
-        Crm::PaginatedEngagementList.from_json(json_object: response.body)
+        Merge::Crm::PaginatedEngagementList.from_json(json_object: response.body)
       end
 
       # Creates an `Engagement` 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::EngagementRequest, as a Hash
+      # @param model [Hash] Request of type Merge::Crm::EngagementRequest, as a Hash
       #   * :owner (Hash)
       #   * :content (String)
       #   * :subject (String)
-      #   * :direction (DIRECTION_ENUM)
+      #   * :direction (Merge::Crm::DirectionEnum)
       #   * :engagement_type (Hash)
       #   * :start_time (DateTime)
       #   * :end_time (DateTime)
       #   * :account (Hash)
-      #   * :contacts (Array<Crm::EngagementRequestContactsItem>)
-      #   * :integration_params (Hash{String => String})
-      #   * :linked_account_params (Hash{String => String})
-      #   * :remote_fields (Array<Crm::RemoteFieldRequest>)
-      # @param request_options [RequestOptions]
-      # @return [Crm::EngagementResponse]
+      #   * :contacts (Array<Merge::Crm::EngagementRequestContactsItem>)
+      #   * :integration_params (Hash{String => Object})
+      #   * :linked_account_params (Hash{String => Object})
+      #   * :remote_fields (Array<Merge::Crm::RemoteFieldRequest>)
+      # @param request_options [Merge::RequestOptions]
+      # @return [Merge::Crm::EngagementResponse]
+      # @example
+      #  api = Merge::Client.new(
+      #    environment: Environment::PRODUCTION,
+      #    base_url: "https://api.example.com",
+      #    api_key: "YOUR_AUTH_TOKEN"
+      #  )
+      #  api.crm.create(model: {  })
       def create(model:, is_debug_mode: nil, run_async: nil, request_options: nil)
-        response = @request_client.conn.post("/api/crm/v1/engagements") do |req|
+        response = @request_client.conn.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?
@@ -100,20 +119,31 @@ module Merge
             "run_async": run_async
           }.compact
           req.body = { **(request_options&.additional_body_parameters || {}), model: model }.compact
+          req.url "#{@request_client.get_url(request_options: request_options)}/crm/v1/engagements"
         end
-        Crm::EngagementResponse.from_json(json_object: response.body)
+        Merge::Crm::EngagementResponse.from_json(json_object: response.body)
       end
 
       # Returns an `Engagement` object with the given `id`.
       #
       # @param id [String]
-      # @param expand [ENGAGEMENTS_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::Engagement]
+      # @param expand [Merge::Crm::Engagements::EngagementsRetrieveRequestExpand] 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 [Merge::RequestOptions]
+      # @return [Merge::Crm::Engagement]
+      # @example
+      #  api = Merge::Client.new(
+      #    environment: Environment::PRODUCTION,
+      #    base_url: "https://api.example.com",
+      #    api_key: "YOUR_AUTH_TOKEN"
+      #  )
+      #  api.crm.retrieve(id: "id")
       def retrieve(id:, expand: nil, include_remote_data: nil, include_remote_fields: nil, request_options: nil)
-        response = @request_client.conn.get("/api/crm/v1/engagements/#{id}") do |req|
+        response = @request_client.conn.get 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?
@@ -124,8 +154,9 @@ module Merge
             "include_remote_data": include_remote_data,
             "include_remote_fields": include_remote_fields
           }.compact
+          req.url "#{@request_client.get_url(request_options: request_options)}/crm/v1/engagements/#{id}"
         end
-        Crm::Engagement.from_json(json_object: response.body)
+        Merge::Crm::Engagement.from_json(json_object: response.body)
       end
 
       # Updates an `Engagement` object with the given `id`.
@@ -133,23 +164,30 @@ module Merge
       # @param id [String]
       # @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::PatchedEngagementRequest, as a Hash
+      # @param model [Hash] Request of type Merge::Crm::PatchedEngagementRequest, as a Hash
       #   * :owner (String)
       #   * :content (String)
       #   * :subject (String)
-      #   * :direction (DIRECTION_ENUM)
+      #   * :direction (Merge::Crm::DirectionEnum)
       #   * :engagement_type (String)
       #   * :start_time (DateTime)
       #   * :end_time (DateTime)
       #   * :account (String)
       #   * :contacts (Array<String>)
-      #   * :integration_params (Hash{String => String})
-      #   * :linked_account_params (Hash{String => String})
-      #   * :remote_fields (Array<Crm::RemoteFieldRequest>)
-      # @param request_options [RequestOptions]
-      # @return [Crm::EngagementResponse]
+      #   * :integration_params (Hash{String => Object})
+      #   * :linked_account_params (Hash{String => Object})
+      #   * :remote_fields (Array<Merge::Crm::RemoteFieldRequest>)
+      # @param request_options [Merge::RequestOptions]
+      # @return [Merge::Crm::EngagementResponse]
+      # @example
+      #  api = Merge::Client.new(
+      #    environment: Environment::PRODUCTION,
+      #    base_url: "https://api.example.com",
+      #    api_key: "YOUR_AUTH_TOKEN"
+      #  )
+      #  api.crm.partial_update(id: "id", model: {  })
       def partial_update(id:, model:, is_debug_mode: nil, run_async: nil, request_options: nil)
-        response = @request_client.conn.patch("/api/crm/v1/engagements/#{id}") do |req|
+        response = @request_client.conn.patch 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?
@@ -160,51 +198,77 @@ module Merge
             "run_async": run_async
           }.compact
           req.body = { **(request_options&.additional_body_parameters || {}), model: model }.compact
+          req.url "#{@request_client.get_url(request_options: request_options)}/crm/v1/engagements/#{id}"
         end
-        Crm::EngagementResponse.from_json(json_object: response.body)
+        Merge::Crm::EngagementResponse.from_json(json_object: response.body)
       end
 
       # Returns metadata for `Engagement` PATCHs.
       #
       # @param id [String]
-      # @param request_options [RequestOptions]
-      # @return [Crm::MetaResponse]
+      # @param request_options [Merge::RequestOptions]
+      # @return [Merge::Crm::MetaResponse]
+      # @example
+      #  api = Merge::Client.new(
+      #    environment: Environment::PRODUCTION,
+      #    base_url: "https://api.example.com",
+      #    api_key: "YOUR_AUTH_TOKEN"
+      #  )
+      #  api.crm.meta_patch_retrieve(id: "id")
       def meta_patch_retrieve(id:, request_options: nil)
-        response = @request_client.conn.get("/api/crm/v1/engagements/meta/patch/#{id}") do |req|
+        response = @request_client.conn.get 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.url "#{@request_client.get_url(request_options: request_options)}/crm/v1/engagements/meta/patch/#{id}"
         end
-        Crm::MetaResponse.from_json(json_object: response.body)
+        Merge::Crm::MetaResponse.from_json(json_object: response.body)
       end
 
       # Returns metadata for `Engagement` POSTs.
       #
-      # @param request_options [RequestOptions]
-      # @return [Crm::MetaResponse]
+      # @param request_options [Merge::RequestOptions]
+      # @return [Merge::Crm::MetaResponse]
+      # @example
+      #  api = Merge::Client.new(
+      #    environment: Environment::PRODUCTION,
+      #    base_url: "https://api.example.com",
+      #    api_key: "YOUR_AUTH_TOKEN"
+      #  )
+      #  api.crm.meta_post_retrieve
       def meta_post_retrieve(request_options: nil)
-        response = @request_client.conn.get("/api/crm/v1/engagements/meta/post") do |req|
+        response = @request_client.conn.get 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.url "#{@request_client.get_url(request_options: request_options)}/crm/v1/engagements/meta/post"
         end
-        Crm::MetaResponse.from_json(json_object: response.body)
+        Merge::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 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]
+      # @param request_options [Merge::RequestOptions]
+      # @return [Merge::Crm::PaginatedRemoteFieldClassList]
+      # @example
+      #  api = Merge::Client.new(
+      #    environment: Environment::PRODUCTION,
+      #    base_url: "https://api.example.com",
+      #    api_key: "YOUR_AUTH_TOKEN"
+      #  )
+      #  api.crm.remote_field_classes_list
       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/engagements/remote-field-classes") do |req|
+        response = @request_client.conn.get 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?
@@ -217,18 +281,19 @@ module Merge
             "include_remote_fields": include_remote_fields,
             "page_size": page_size
           }.compact
+          req.url "#{@request_client.get_url(request_options: request_options)}/crm/v1/engagements/remote-field-classes"
         end
-        Crm::PaginatedRemoteFieldClassList.from_json(json_object: response.body)
+        Merge::Crm::PaginatedRemoteFieldClassList.from_json(json_object: response.body)
       end
     end
 
     class AsyncEngagementsClient
+      # @return [Merge::AsyncRequestClient]
       attr_reader :request_client
 
-      # @param request_client [AsyncRequestClient]
-      # @return [Crm::AsyncEngagementsClient]
+      # @param request_client [Merge::AsyncRequestClient]
+      # @return [Merge::Crm::AsyncEngagementsClient]
       def initialize(request_client:)
-        # @type [AsyncRequestClient]
         @request_client = request_client
       end
 
@@ -237,22 +302,33 @@ module Merge
       # @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 expand [ENGAGEMENTS_LIST_REQUEST_EXPAND] Which relations should be returned in expanded form. Multiple relation names should be comma separated without spaces.
+      # @param expand [Merge::Crm::Engagements::EngagementsListRequestExpand] 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 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 modified_before [DateTime] If provided, only objects synced by Merge before this date time will be
+      #  returned.
       # @param page_size [Integer] Number of results to return per page.
       # @param remote_id [String] The API provider's ID for the given object.
       # @param started_after [DateTime] If provided, will only return engagements started after this datetime.
       # @param started_before [DateTime] If provided, will only return engagements started before this datetime.
-      # @param request_options [RequestOptions]
-      # @return [Crm::PaginatedEngagementList]
+      # @param request_options [Merge::RequestOptions]
+      # @return [Merge::Crm::PaginatedEngagementList]
+      # @example
+      #  api = Merge::Client.new(
+      #    environment: Environment::PRODUCTION,
+      #    base_url: "https://api.example.com",
+      #    api_key: "YOUR_AUTH_TOKEN"
+      #  )
+      #  api.crm.list
       def list(created_after: nil, created_before: nil, cursor: nil, expand: nil, include_deleted_data: nil,
                include_remote_data: nil, include_remote_fields: nil, modified_after: nil, modified_before: nil, page_size: nil, remote_id: nil, started_after: nil, started_before: nil, request_options: nil)
         Async do
-          response = @request_client.conn.get("/api/crm/v1/engagements") do |req|
+          response = @request_client.conn.get 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?
@@ -273,8 +349,9 @@ module Merge
               "started_after": started_after,
               "started_before": started_before
             }.compact
+            req.url "#{@request_client.get_url(request_options: request_options)}/crm/v1/engagements"
           end
-          Crm::PaginatedEngagementList.from_json(json_object: response.body)
+          Merge::Crm::PaginatedEngagementList.from_json(json_object: response.body)
         end
       end
 
@@ -282,24 +359,31 @@ module Merge
       #
       # @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::EngagementRequest, as a Hash
+      # @param model [Hash] Request of type Merge::Crm::EngagementRequest, as a Hash
       #   * :owner (Hash)
       #   * :content (String)
       #   * :subject (String)
-      #   * :direction (DIRECTION_ENUM)
+      #   * :direction (Merge::Crm::DirectionEnum)
       #   * :engagement_type (Hash)
       #   * :start_time (DateTime)
       #   * :end_time (DateTime)
       #   * :account (Hash)
-      #   * :contacts (Array<Crm::EngagementRequestContactsItem>)
-      #   * :integration_params (Hash{String => String})
-      #   * :linked_account_params (Hash{String => String})
-      #   * :remote_fields (Array<Crm::RemoteFieldRequest>)
-      # @param request_options [RequestOptions]
-      # @return [Crm::EngagementResponse]
+      #   * :contacts (Array<Merge::Crm::EngagementRequestContactsItem>)
+      #   * :integration_params (Hash{String => Object})
+      #   * :linked_account_params (Hash{String => Object})
+      #   * :remote_fields (Array<Merge::Crm::RemoteFieldRequest>)
+      # @param request_options [Merge::RequestOptions]
+      # @return [Merge::Crm::EngagementResponse]
+      # @example
+      #  api = Merge::Client.new(
+      #    environment: Environment::PRODUCTION,
+      #    base_url: "https://api.example.com",
+      #    api_key: "YOUR_AUTH_TOKEN"
+      #  )
+      #  api.crm.create(model: {  })
       def create(model:, is_debug_mode: nil, run_async: nil, request_options: nil)
         Async do
-          response = @request_client.conn.post("/api/crm/v1/engagements") do |req|
+          response = @request_client.conn.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?
@@ -310,22 +394,33 @@ module Merge
               "run_async": run_async
             }.compact
             req.body = { **(request_options&.additional_body_parameters || {}), model: model }.compact
+            req.url "#{@request_client.get_url(request_options: request_options)}/crm/v1/engagements"
           end
-          Crm::EngagementResponse.from_json(json_object: response.body)
+          Merge::Crm::EngagementResponse.from_json(json_object: response.body)
         end
       end
 
       # Returns an `Engagement` object with the given `id`.
       #
       # @param id [String]
-      # @param expand [ENGAGEMENTS_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::Engagement]
+      # @param expand [Merge::Crm::Engagements::EngagementsRetrieveRequestExpand] 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 [Merge::RequestOptions]
+      # @return [Merge::Crm::Engagement]
+      # @example
+      #  api = Merge::Client.new(
+      #    environment: Environment::PRODUCTION,
+      #    base_url: "https://api.example.com",
+      #    api_key: "YOUR_AUTH_TOKEN"
+      #  )
+      #  api.crm.retrieve(id: "id")
       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/engagements/#{id}") do |req|
+          response = @request_client.conn.get 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?
@@ -336,8 +431,9 @@ module Merge
               "include_remote_data": include_remote_data,
               "include_remote_fields": include_remote_fields
             }.compact
+            req.url "#{@request_client.get_url(request_options: request_options)}/crm/v1/engagements/#{id}"
           end
-          Crm::Engagement.from_json(json_object: response.body)
+          Merge::Crm::Engagement.from_json(json_object: response.body)
         end
       end
 
@@ -346,24 +442,31 @@ module Merge
       # @param id [String]
       # @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::PatchedEngagementRequest, as a Hash
+      # @param model [Hash] Request of type Merge::Crm::PatchedEngagementRequest, as a Hash
       #   * :owner (String)
       #   * :content (String)
       #   * :subject (String)
-      #   * :direction (DIRECTION_ENUM)
+      #   * :direction (Merge::Crm::DirectionEnum)
       #   * :engagement_type (String)
       #   * :start_time (DateTime)
       #   * :end_time (DateTime)
       #   * :account (String)
       #   * :contacts (Array<String>)
-      #   * :integration_params (Hash{String => String})
-      #   * :linked_account_params (Hash{String => String})
-      #   * :remote_fields (Array<Crm::RemoteFieldRequest>)
-      # @param request_options [RequestOptions]
-      # @return [Crm::EngagementResponse]
+      #   * :integration_params (Hash{String => Object})
+      #   * :linked_account_params (Hash{String => Object})
+      #   * :remote_fields (Array<Merge::Crm::RemoteFieldRequest>)
+      # @param request_options [Merge::RequestOptions]
+      # @return [Merge::Crm::EngagementResponse]
+      # @example
+      #  api = Merge::Client.new(
+      #    environment: Environment::PRODUCTION,
+      #    base_url: "https://api.example.com",
+      #    api_key: "YOUR_AUTH_TOKEN"
+      #  )
+      #  api.crm.partial_update(id: "id", model: {  })
       def partial_update(id:, model:, is_debug_mode: nil, run_async: nil, request_options: nil)
         Async do
-          response = @request_client.conn.patch("/api/crm/v1/engagements/#{id}") do |req|
+          response = @request_client.conn.patch 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?
@@ -374,41 +477,58 @@ module Merge
               "run_async": run_async
             }.compact
             req.body = { **(request_options&.additional_body_parameters || {}), model: model }.compact
+            req.url "#{@request_client.get_url(request_options: request_options)}/crm/v1/engagements/#{id}"
           end
-          Crm::EngagementResponse.from_json(json_object: response.body)
+          Merge::Crm::EngagementResponse.from_json(json_object: response.body)
         end
       end
 
       # Returns metadata for `Engagement` PATCHs.
       #
       # @param id [String]
-      # @param request_options [RequestOptions]
-      # @return [Crm::MetaResponse]
+      # @param request_options [Merge::RequestOptions]
+      # @return [Merge::Crm::MetaResponse]
+      # @example
+      #  api = Merge::Client.new(
+      #    environment: Environment::PRODUCTION,
+      #    base_url: "https://api.example.com",
+      #    api_key: "YOUR_AUTH_TOKEN"
+      #  )
+      #  api.crm.meta_patch_retrieve(id: "id")
       def meta_patch_retrieve(id:, request_options: nil)
         Async do
-          response = @request_client.conn.get("/api/crm/v1/engagements/meta/patch/#{id}") do |req|
+          response = @request_client.conn.get 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.url "#{@request_client.get_url(request_options: request_options)}/crm/v1/engagements/meta/patch/#{id}"
           end
-          Crm::MetaResponse.from_json(json_object: response.body)
+          Merge::Crm::MetaResponse.from_json(json_object: response.body)
         end
       end
 
       # Returns metadata for `Engagement` POSTs.
       #
-      # @param request_options [RequestOptions]
-      # @return [Crm::MetaResponse]
+      # @param request_options [Merge::RequestOptions]
+      # @return [Merge::Crm::MetaResponse]
+      # @example
+      #  api = Merge::Client.new(
+      #    environment: Environment::PRODUCTION,
+      #    base_url: "https://api.example.com",
+      #    api_key: "YOUR_AUTH_TOKEN"
+      #  )
+      #  api.crm.meta_post_retrieve
       def meta_post_retrieve(request_options: nil)
         Async do
-          response = @request_client.conn.get("/api/crm/v1/engagements/meta/post") do |req|
+          response = @request_client.conn.get 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.url "#{@request_client.get_url(request_options: request_options)}/crm/v1/engagements/meta/post"
           end
-          Crm::MetaResponse.from_json(json_object: response.body)
+          Merge::Crm::MetaResponse.from_json(json_object: response.body)
         end
       end
 
@@ -416,15 +536,24 @@ module Merge
       #
       # @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 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]
+      # @param request_options [Merge::RequestOptions]
+      # @return [Merge::Crm::PaginatedRemoteFieldClassList]
+      # @example
+      #  api = Merge::Client.new(
+      #    environment: Environment::PRODUCTION,
+      #    base_url: "https://api.example.com",
+      #    api_key: "YOUR_AUTH_TOKEN"
+      #  )
+      #  api.crm.remote_field_classes_list
       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/engagements/remote-field-classes") do |req|
+          response = @request_client.conn.get 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?
@@ -437,8 +566,9 @@ module Merge
               "include_remote_fields": include_remote_fields,
               "page_size": page_size
             }.compact
+            req.url "#{@request_client.get_url(request_options: request_options)}/crm/v1/engagements/remote-field-classes"
           end
-          Crm::PaginatedRemoteFieldClassList.from_json(json_object: response.body)
+          Merge::Crm::PaginatedRemoteFieldClassList.from_json(json_object: response.body)
         end
       end
     end

data/lib/merge_ruby_client/crm/engagements/types/engagements_list_request_expand.rb

@@ -3,24 +3,23 @@
 module Merge
   module Crm
     class Engagements
-      # @type [ENGAGEMENTS_LIST_REQUEST_EXPAND]
-      ENGAGEMENTS_LIST_REQUEST_EXPAND = {
-        account: "account",
-        account_engagement_type: "account,engagement_type",
-        contacts: "contacts",
-        contacts_account: "contacts,account",
-        contacts_account_engagement_type: "contacts,account,engagement_type",
-        contacts_engagement_type: "contacts,engagement_type",
-        contacts_owner: "contacts,owner",
-        contacts_owner_account: "contacts,owner,account",
-        contacts_owner_account_engagement_type: "contacts,owner,account,engagement_type",
-        contacts_owner_engagement_type: "contacts,owner,engagement_type",
-        engagement_type: "engagement_type",
-        owner: "owner",
-        owner_account: "owner,account",
-        owner_account_engagement_type: "owner,account,engagement_type",
-        owner_engagement_type: "owner,engagement_type"
-      }.freeze
+      class EngagementsListRequestExpand
+        ACCOUNT = "account"
+        ACCOUNT_ENGAGEMENT_TYPE = "account,engagement_type"
+        CONTACTS = "contacts"
+        CONTACTS_ACCOUNT = "contacts,account"
+        CONTACTS_ACCOUNT_ENGAGEMENT_TYPE = "contacts,account,engagement_type"
+        CONTACTS_ENGAGEMENT_TYPE = "contacts,engagement_type"
+        CONTACTS_OWNER = "contacts,owner"
+        CONTACTS_OWNER_ACCOUNT = "contacts,owner,account"
+        CONTACTS_OWNER_ACCOUNT_ENGAGEMENT_TYPE = "contacts,owner,account,engagement_type"
+        CONTACTS_OWNER_ENGAGEMENT_TYPE = "contacts,owner,engagement_type"
+        ENGAGEMENT_TYPE = "engagement_type"
+        OWNER = "owner"
+        OWNER_ACCOUNT = "owner,account"
+        OWNER_ACCOUNT_ENGAGEMENT_TYPE = "owner,account,engagement_type"
+        OWNER_ENGAGEMENT_TYPE = "owner,engagement_type"
+      end
     end
   end
 end