merge_ruby_client 0.0.3 → 0.0.5

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

@@ -17,12 +17,12 @@ require "async"
 module Merge
   module Crm
     class OpportunitiesClient
+      # @return [Merge::RequestClient]
       attr_reader :request_client
 
-      # @param request_client [RequestClient]
-      # @return [Crm::OpportunitiesClient]
+      # @param request_client [Merge::RequestClient]
+      # @return [Merge::Crm::OpportunitiesClient]
       def initialize(request_client:)
-        # @type [RequestClient]
         @request_client = request_client
       end
 
@@ -32,27 +32,41 @@ 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 [OPPORTUNITIES_LIST_REQUEST_EXPAND] Which relations should be returned in expanded form. Multiple relation names should be comma separated without spaces.
+      # @param expand [Merge::Crm::Opportunities::OpportunitiesListRequestExpand] 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 owner_id [String] If provided, will only return opportunities with this owner.
       # @param page_size [Integer] Number of results to return per page.
       # @param remote_fields [String] Deprecated. Use show_enum_origins.
       # @param remote_id [String] The API provider's ID for the given object.
-      # @param show_enum_origins [String] Which fields should be returned in non-normalized form.
+      # @param show_enum_origins [String] A comma separated list of enum field names for which you'd like the original
+      #  values to be returned, instead of Merge's normalized enum values. [Learn
+      #  e](https://help.merge.dev/en/articles/8950958-show_enum_origins-query-parameter)
       # @param stage_id [String] If provided, will only return opportunities with this stage.
-      # @param status [OPPORTUNITIES_LIST_REQUEST_STATUS] If provided, will only return opportunities with this status. Options: ('OPEN', 'WON', 'LOST')
-      #   - `OPEN` - OPEN
-      #   - `WON` - WON
-      #   - `LOST` - LOST
-      # @param request_options [RequestOptions]
-      # @return [Crm::PaginatedOpportunityList]
+      # @param status [Merge::Crm::Opportunities::OpportunitiesListRequestStatus] If provided, will only return opportunities with this status. Options: ('OPEN',
+      #  'WON', 'LOST')
+      #  - `OPEN` - OPEN
+      #  - `WON` - WON
+      #  - `LOST` - LOST
+      # @param request_options [Merge::RequestOptions]
+      # @return [Merge::Crm::PaginatedOpportunityList]
+      # @example
+      #  api = Merge::Client.new(
+      #    environment: Environment::PRODUCTION,
+      #    base_url: "https://api.example.com",
+      #    api_key: "YOUR_AUTH_TOKEN"
+      #  )
+      #  api.crm.list
       def list(account_id: nil, 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, owner_id: nil, page_size: nil, remote_fields: nil, remote_id: nil, show_enum_origins: nil, stage_id: nil, status: nil, request_options: nil)
-        response = @request_client.conn.get("/api/crm/v1/opportunities") 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?
@@ -77,31 +91,39 @@ module Merge
             "stage_id": stage_id,
             "status": status
           }.compact
+          req.url "#{@request_client.get_url(request_options: request_options)}/crm/v1/opportunities"
         end
-        Crm::PaginatedOpportunityList.from_json(json_object: response.body)
+        Merge::Crm::PaginatedOpportunityList.from_json(json_object: response.body)
       end
 
       # Creates an `Opportunity` 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::OpportunityRequest, as a Hash
+      # @param model [Hash] Request of type Merge::Crm::OpportunityRequest, as a Hash
       #   * :name (String)
       #   * :description (String)
       #   * :amount (Integer)
       #   * :owner (Hash)
       #   * :account (Hash)
       #   * :stage (Hash)
-      #   * :status (OPPORTUNITY_STATUS_ENUM)
+      #   * :status (Merge::Crm::OpportunityStatusEnum)
       #   * :last_activity_at (DateTime)
       #   * :close_date (DateTime)
-      #   * :integration_params (Hash{String => String})
-      #   * :linked_account_params (Hash{String => String})
-      #   * :remote_fields (Array<Crm::RemoteFieldRequest>)
-      # @param request_options [RequestOptions]
-      # @return [Crm::OpportunityResponse]
+      #   * :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::OpportunityResponse]
+      # @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/opportunities") 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?
@@ -112,23 +134,36 @@ 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/opportunities"
         end
-        Crm::OpportunityResponse.from_json(json_object: response.body)
+        Merge::Crm::OpportunityResponse.from_json(json_object: response.body)
       end
 
       # Returns an `Opportunity` object with the given `id`.
       #
       # @param id [String]
-      # @param expand [OPPORTUNITIES_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 expand [Merge::Crm::Opportunities::OpportunitiesRetrieveRequestExpand] 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 remote_fields [String] Deprecated. Use show_enum_origins.
-      # @param show_enum_origins [String] Which fields should be returned in non-normalized form.
-      # @param request_options [RequestOptions]
-      # @return [Crm::Opportunity]
+      # @param show_enum_origins [String] A comma separated list of enum field names for which you'd like the original
+      #  values to be returned, instead of Merge's normalized enum values. [Learn
+      #  e](https://help.merge.dev/en/articles/8950958-show_enum_origins-query-parameter)
+      # @param request_options [Merge::RequestOptions]
+      # @return [Merge::Crm::Opportunity]
+      # @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, remote_fields: nil,
                    show_enum_origins: nil, request_options: nil)
-        response = @request_client.conn.get("/api/crm/v1/opportunities/#{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?
@@ -141,8 +176,9 @@ module Merge
             "remote_fields": remote_fields,
             "show_enum_origins": show_enum_origins
           }.compact
+          req.url "#{@request_client.get_url(request_options: request_options)}/crm/v1/opportunities/#{id}"
         end
-        Crm::Opportunity.from_json(json_object: response.body)
+        Merge::Crm::Opportunity.from_json(json_object: response.body)
       end
 
       # Updates an `Opportunity` object with the given `id`.
@@ -150,23 +186,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::PatchedOpportunityRequest, as a Hash
+      # @param model [Hash] Request of type Merge::Crm::PatchedOpportunityRequest, as a Hash
       #   * :name (String)
       #   * :description (String)
       #   * :amount (Integer)
       #   * :owner (String)
       #   * :account (String)
       #   * :stage (String)
-      #   * :status (OPPORTUNITY_STATUS_ENUM)
+      #   * :status (Merge::Crm::OpportunityStatusEnum)
       #   * :last_activity_at (DateTime)
       #   * :close_date (DateTime)
-      #   * :integration_params (Hash{String => String})
-      #   * :linked_account_params (Hash{String => String})
-      #   * :remote_fields (Array<Crm::RemoteFieldRequest>)
-      # @param request_options [RequestOptions]
-      # @return [Crm::OpportunityResponse]
+      #   * :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::OpportunityResponse]
+      # @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/opportunities/#{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?
@@ -177,51 +220,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/opportunities/#{id}"
         end
-        Crm::OpportunityResponse.from_json(json_object: response.body)
+        Merge::Crm::OpportunityResponse.from_json(json_object: response.body)
       end
 
       # Returns metadata for `Opportunity` 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/opportunities/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/opportunities/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 `Opportunity` 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/opportunities/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/opportunities/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/opportunities/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?
@@ -234,18 +303,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/opportunities/remote-field-classes"
         end
-        Crm::PaginatedRemoteFieldClassList.from_json(json_object: response.body)
+        Merge::Crm::PaginatedRemoteFieldClassList.from_json(json_object: response.body)
       end
     end
 
     class AsyncOpportunitiesClient
+      # @return [Merge::AsyncRequestClient]
       attr_reader :request_client
 
-      # @param request_client [AsyncRequestClient]
-      # @return [Crm::AsyncOpportunitiesClient]
+      # @param request_client [Merge::AsyncRequestClient]
+      # @return [Merge::Crm::AsyncOpportunitiesClient]
       def initialize(request_client:)
-        # @type [AsyncRequestClient]
         @request_client = request_client
       end
 
@@ -255,28 +325,42 @@ 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 [OPPORTUNITIES_LIST_REQUEST_EXPAND] Which relations should be returned in expanded form. Multiple relation names should be comma separated without spaces.
+      # @param expand [Merge::Crm::Opportunities::OpportunitiesListRequestExpand] 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 owner_id [String] If provided, will only return opportunities with this owner.
       # @param page_size [Integer] Number of results to return per page.
       # @param remote_fields [String] Deprecated. Use show_enum_origins.
       # @param remote_id [String] The API provider's ID for the given object.
-      # @param show_enum_origins [String] Which fields should be returned in non-normalized form.
+      # @param show_enum_origins [String] A comma separated list of enum field names for which you'd like the original
+      #  values to be returned, instead of Merge's normalized enum values. [Learn
+      #  e](https://help.merge.dev/en/articles/8950958-show_enum_origins-query-parameter)
       # @param stage_id [String] If provided, will only return opportunities with this stage.
-      # @param status [OPPORTUNITIES_LIST_REQUEST_STATUS] If provided, will only return opportunities with this status. Options: ('OPEN', 'WON', 'LOST')
-      #   - `OPEN` - OPEN
-      #   - `WON` - WON
-      #   - `LOST` - LOST
-      # @param request_options [RequestOptions]
-      # @return [Crm::PaginatedOpportunityList]
+      # @param status [Merge::Crm::Opportunities::OpportunitiesListRequestStatus] If provided, will only return opportunities with this status. Options: ('OPEN',
+      #  'WON', 'LOST')
+      #  - `OPEN` - OPEN
+      #  - `WON` - WON
+      #  - `LOST` - LOST
+      # @param request_options [Merge::RequestOptions]
+      # @return [Merge::Crm::PaginatedOpportunityList]
+      # @example
+      #  api = Merge::Client.new(
+      #    environment: Environment::PRODUCTION,
+      #    base_url: "https://api.example.com",
+      #    api_key: "YOUR_AUTH_TOKEN"
+      #  )
+      #  api.crm.list
       def list(account_id: nil, 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, owner_id: nil, page_size: nil, remote_fields: nil, remote_id: nil, show_enum_origins: nil, stage_id: nil, status: nil, request_options: nil)
         Async do
-          response = @request_client.conn.get("/api/crm/v1/opportunities") 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?
@@ -301,8 +385,9 @@ module Merge
               "stage_id": stage_id,
               "status": status
             }.compact
+            req.url "#{@request_client.get_url(request_options: request_options)}/crm/v1/opportunities"
           end
-          Crm::PaginatedOpportunityList.from_json(json_object: response.body)
+          Merge::Crm::PaginatedOpportunityList.from_json(json_object: response.body)
         end
       end
 
@@ -310,24 +395,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::OpportunityRequest, as a Hash
+      # @param model [Hash] Request of type Merge::Crm::OpportunityRequest, as a Hash
       #   * :name (String)
       #   * :description (String)
       #   * :amount (Integer)
       #   * :owner (Hash)
       #   * :account (Hash)
       #   * :stage (Hash)
-      #   * :status (OPPORTUNITY_STATUS_ENUM)
+      #   * :status (Merge::Crm::OpportunityStatusEnum)
       #   * :last_activity_at (DateTime)
       #   * :close_date (DateTime)
-      #   * :integration_params (Hash{String => String})
-      #   * :linked_account_params (Hash{String => String})
-      #   * :remote_fields (Array<Crm::RemoteFieldRequest>)
-      # @param request_options [RequestOptions]
-      # @return [Crm::OpportunityResponse]
+      #   * :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::OpportunityResponse]
+      # @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/opportunities") 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?
@@ -338,25 +430,38 @@ 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/opportunities"
           end
-          Crm::OpportunityResponse.from_json(json_object: response.body)
+          Merge::Crm::OpportunityResponse.from_json(json_object: response.body)
         end
       end
 
       # Returns an `Opportunity` object with the given `id`.
       #
       # @param id [String]
-      # @param expand [OPPORTUNITIES_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 expand [Merge::Crm::Opportunities::OpportunitiesRetrieveRequestExpand] 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 remote_fields [String] Deprecated. Use show_enum_origins.
-      # @param show_enum_origins [String] Which fields should be returned in non-normalized form.
-      # @param request_options [RequestOptions]
-      # @return [Crm::Opportunity]
+      # @param show_enum_origins [String] A comma separated list of enum field names for which you'd like the original
+      #  values to be returned, instead of Merge's normalized enum values. [Learn
+      #  e](https://help.merge.dev/en/articles/8950958-show_enum_origins-query-parameter)
+      # @param request_options [Merge::RequestOptions]
+      # @return [Merge::Crm::Opportunity]
+      # @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, remote_fields: nil,
                    show_enum_origins: nil, request_options: nil)
         Async do
-          response = @request_client.conn.get("/api/crm/v1/opportunities/#{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?
@@ -369,8 +474,9 @@ module Merge
               "remote_fields": remote_fields,
               "show_enum_origins": show_enum_origins
             }.compact
+            req.url "#{@request_client.get_url(request_options: request_options)}/crm/v1/opportunities/#{id}"
           end
-          Crm::Opportunity.from_json(json_object: response.body)
+          Merge::Crm::Opportunity.from_json(json_object: response.body)
         end
       end
 
@@ -379,24 +485,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::PatchedOpportunityRequest, as a Hash
+      # @param model [Hash] Request of type Merge::Crm::PatchedOpportunityRequest, as a Hash
       #   * :name (String)
       #   * :description (String)
       #   * :amount (Integer)
       #   * :owner (String)
       #   * :account (String)
       #   * :stage (String)
-      #   * :status (OPPORTUNITY_STATUS_ENUM)
+      #   * :status (Merge::Crm::OpportunityStatusEnum)
       #   * :last_activity_at (DateTime)
       #   * :close_date (DateTime)
-      #   * :integration_params (Hash{String => String})
-      #   * :linked_account_params (Hash{String => String})
-      #   * :remote_fields (Array<Crm::RemoteFieldRequest>)
-      # @param request_options [RequestOptions]
-      # @return [Crm::OpportunityResponse]
+      #   * :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::OpportunityResponse]
+      # @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/opportunities/#{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?
@@ -407,41 +520,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/opportunities/#{id}"
           end
-          Crm::OpportunityResponse.from_json(json_object: response.body)
+          Merge::Crm::OpportunityResponse.from_json(json_object: response.body)
         end
       end
 
       # Returns metadata for `Opportunity` 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/opportunities/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/opportunities/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 `Opportunity` 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/opportunities/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/opportunities/meta/post"
           end
-          Crm::MetaResponse.from_json(json_object: response.body)
+          Merge::Crm::MetaResponse.from_json(json_object: response.body)
         end
       end
 
@@ -449,15 +579,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/opportunities/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?
@@ -470,8 +609,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/opportunities/remote-field-classes"
           end
-          Crm::PaginatedRemoteFieldClassList.from_json(json_object: response.body)
+          Merge::Crm::PaginatedRemoteFieldClassList.from_json(json_object: response.body)
         end
       end
     end