merge_ruby_client 0.0.3 → 0.1.0

data/lib/merge_ruby_client/ats/applications/types/applications_retrieve_request_expand.rb

@@ -3,40 +3,71 @@
 module Merge
   module Ats
     class Applications
-      # @type [APPLICATIONS_RETRIEVE_REQUEST_EXPAND]
-      APPLICATIONS_RETRIEVE_REQUEST_EXPAND = {
-        candidate: "candidate",
-        candidate_credited_to: "candidate,credited_to",
-        candidate_credited_to_current_stage: "candidate,credited_to,current_stage",
-        candidate_credited_to_current_stage_reject_reason: "candidate,credited_to,current_stage,reject_reason",
-        candidate_credited_to_reject_reason: "candidate,credited_to,reject_reason",
-        candidate_current_stage: "candidate,current_stage",
-        candidate_current_stage_reject_reason: "candidate,current_stage,reject_reason",
-        candidate_job: "candidate,job",
-        candidate_job_credited_to: "candidate,job,credited_to",
-        candidate_job_credited_to_current_stage: "candidate,job,credited_to,current_stage",
-        candidate_job_credited_to_current_stage_reject_reason: "candidate,job,credited_to,current_stage,reject_reason",
-        candidate_job_credited_to_reject_reason: "candidate,job,credited_to,reject_reason",
-        candidate_job_current_stage: "candidate,job,current_stage",
-        candidate_job_current_stage_reject_reason: "candidate,job,current_stage,reject_reason",
-        candidate_job_reject_reason: "candidate,job,reject_reason",
-        candidate_reject_reason: "candidate,reject_reason",
-        credited_to: "credited_to",
-        credited_to_current_stage: "credited_to,current_stage",
-        credited_to_current_stage_reject_reason: "credited_to,current_stage,reject_reason",
-        credited_to_reject_reason: "credited_to,reject_reason",
-        current_stage: "current_stage",
-        current_stage_reject_reason: "current_stage,reject_reason",
-        job: "job",
-        job_credited_to: "job,credited_to",
-        job_credited_to_current_stage: "job,credited_to,current_stage",
-        job_credited_to_current_stage_reject_reason: "job,credited_to,current_stage,reject_reason",
-        job_credited_to_reject_reason: "job,credited_to,reject_reason",
-        job_current_stage: "job,current_stage",
-        job_current_stage_reject_reason: "job,current_stage,reject_reason",
-        job_reject_reason: "job,reject_reason",
-        reject_reason: "reject_reason"
-      }.freeze
+      class ApplicationsRetrieveRequestExpand
+        CANDIDATE = "candidate"
+        CANDIDATE_CREDITED_TO = "candidate,credited_to"
+        CANDIDATE_CREDITED_TO_CURRENT_STAGE = "candidate,credited_to,current_stage"
+        CANDIDATE_CREDITED_TO_CURRENT_STAGE_REJECT_REASON = "candidate,credited_to,current_stage,reject_reason"
+        CANDIDATE_CREDITED_TO_REJECT_REASON = "candidate,credited_to,reject_reason"
+        CANDIDATE_CURRENT_STAGE = "candidate,current_stage"
+        CANDIDATE_CURRENT_STAGE_REJECT_REASON = "candidate,current_stage,reject_reason"
+        CANDIDATE_JOB = "candidate,job"
+        CANDIDATE_JOB_CREDITED_TO = "candidate,job,credited_to"
+        CANDIDATE_JOB_CREDITED_TO_CURRENT_STAGE = "candidate,job,credited_to,current_stage"
+        CANDIDATE_JOB_CREDITED_TO_CURRENT_STAGE_REJECT_REASON = "candidate,job,credited_to,current_stage,reject_reason"
+        CANDIDATE_JOB_CREDITED_TO_REJECT_REASON = "candidate,job,credited_to,reject_reason"
+        CANDIDATE_JOB_CURRENT_STAGE = "candidate,job,current_stage"
+        CANDIDATE_JOB_CURRENT_STAGE_REJECT_REASON = "candidate,job,current_stage,reject_reason"
+        CANDIDATE_JOB_REJECT_REASON = "candidate,job,reject_reason"
+        CANDIDATE_REJECT_REASON = "candidate,reject_reason"
+        CREDITED_TO = "credited_to"
+        CREDITED_TO_CURRENT_STAGE = "credited_to,current_stage"
+        CREDITED_TO_CURRENT_STAGE_REJECT_REASON = "credited_to,current_stage,reject_reason"
+        CREDITED_TO_REJECT_REASON = "credited_to,reject_reason"
+        CURRENT_STAGE = "current_stage"
+        CURRENT_STAGE_REJECT_REASON = "current_stage,reject_reason"
+        JOB = "job"
+        JOB_CREDITED_TO = "job,credited_to"
+        JOB_CREDITED_TO_CURRENT_STAGE = "job,credited_to,current_stage"
+        JOB_CREDITED_TO_CURRENT_STAGE_REJECT_REASON = "job,credited_to,current_stage,reject_reason"
+        JOB_CREDITED_TO_REJECT_REASON = "job,credited_to,reject_reason"
+        JOB_CURRENT_STAGE = "job,current_stage"
+        JOB_CURRENT_STAGE_REJECT_REASON = "job,current_stage,reject_reason"
+        JOB_REJECT_REASON = "job,reject_reason"
+        OFFERS = "offers"
+        OFFERS_CANDIDATE = "offers,candidate"
+        OFFERS_CANDIDATE_CREDITED_TO = "offers,candidate,credited_to"
+        OFFERS_CANDIDATE_CREDITED_TO_CURRENT_STAGE = "offers,candidate,credited_to,current_stage"
+        OFFERS_CANDIDATE_CREDITED_TO_CURRENT_STAGE_REJECT_REASON = "offers,candidate,credited_to,current_stage,reject_reason"
+        OFFERS_CANDIDATE_CREDITED_TO_REJECT_REASON = "offers,candidate,credited_to,reject_reason"
+        OFFERS_CANDIDATE_CURRENT_STAGE = "offers,candidate,current_stage"
+        OFFERS_CANDIDATE_CURRENT_STAGE_REJECT_REASON = "offers,candidate,current_stage,reject_reason"
+        OFFERS_CANDIDATE_JOB = "offers,candidate,job"
+        OFFERS_CANDIDATE_JOB_CREDITED_TO = "offers,candidate,job,credited_to"
+        OFFERS_CANDIDATE_JOB_CREDITED_TO_CURRENT_STAGE = "offers,candidate,job,credited_to,current_stage"
+        OFFERS_CANDIDATE_JOB_CREDITED_TO_CURRENT_STAGE_REJECT_REASON = "offers,candidate,job,credited_to,current_stage,reject_reason"
+        OFFERS_CANDIDATE_JOB_CREDITED_TO_REJECT_REASON = "offers,candidate,job,credited_to,reject_reason"
+        OFFERS_CANDIDATE_JOB_CURRENT_STAGE = "offers,candidate,job,current_stage"
+        OFFERS_CANDIDATE_JOB_CURRENT_STAGE_REJECT_REASON = "offers,candidate,job,current_stage,reject_reason"
+        OFFERS_CANDIDATE_JOB_REJECT_REASON = "offers,candidate,job,reject_reason"
+        OFFERS_CANDIDATE_REJECT_REASON = "offers,candidate,reject_reason"
+        OFFERS_CREDITED_TO = "offers,credited_to"
+        OFFERS_CREDITED_TO_CURRENT_STAGE = "offers,credited_to,current_stage"
+        OFFERS_CREDITED_TO_CURRENT_STAGE_REJECT_REASON = "offers,credited_to,current_stage,reject_reason"
+        OFFERS_CREDITED_TO_REJECT_REASON = "offers,credited_to,reject_reason"
+        OFFERS_CURRENT_STAGE = "offers,current_stage"
+        OFFERS_CURRENT_STAGE_REJECT_REASON = "offers,current_stage,reject_reason"
+        OFFERS_JOB = "offers,job"
+        OFFERS_JOB_CREDITED_TO = "offers,job,credited_to"
+        OFFERS_JOB_CREDITED_TO_CURRENT_STAGE = "offers,job,credited_to,current_stage"
+        OFFERS_JOB_CREDITED_TO_CURRENT_STAGE_REJECT_REASON = "offers,job,credited_to,current_stage,reject_reason"
+        OFFERS_JOB_CREDITED_TO_REJECT_REASON = "offers,job,credited_to,reject_reason"
+        OFFERS_JOB_CURRENT_STAGE = "offers,job,current_stage"
+        OFFERS_JOB_CURRENT_STAGE_REJECT_REASON = "offers,job,current_stage,reject_reason"
+        OFFERS_JOB_REJECT_REASON = "offers,job,reject_reason"
+        OFFERS_REJECT_REASON = "offers,reject_reason"
+        REJECT_REASON = "reject_reason"
+      end
     end
   end
 end

data/lib/merge_ruby_client/ats/async_passthrough/client.rb

@@ -9,105 +9,137 @@ require "async"
 module Merge
   module Ats
     class AsyncPassthroughClient
+      # @return [Merge::RequestClient]
       attr_reader :request_client
 
-      # @param request_client [RequestClient]
-      # @return [Ats::AsyncPassthroughClient]
+      # @param request_client [Merge::RequestClient]
+      # @return [Merge::Ats::AsyncPassthroughClient]
       def initialize(request_client:)
-        # @type [RequestClient]
         @request_client = request_client
       end
 
       # Asynchronously pull data from an endpoint not currently supported by Merge.
       #
-      # @param request [Hash] Request of type Ats::DataPassthroughRequest, as a Hash
-      #   * :method (METHOD_ENUM)
+      # @param request [Hash] Request of type Merge::Ats::DataPassthroughRequest, as a Hash
+      #   * :method (Merge::Ats::MethodEnum)
       #   * :path (String)
       #   * :base_url_override (String)
       #   * :data (String)
-      #   * :multipart_form_data (Array<Ats::MultipartFormFieldRequest>)
-      #   * :headers (Hash{String => String})
-      #   * :request_format (REQUEST_FORMAT_ENUM)
+      #   * :multipart_form_data (Array<Merge::Ats::MultipartFormFieldRequest>)
+      #   * :headers (Hash{String => Object})
+      #   * :request_format (Merge::Ats::RequestFormatEnum)
       #   * :normalize_response (Boolean)
-      # @param request_options [RequestOptions]
-      # @return [Ats::AsyncPassthroughReciept]
+      # @param request_options [Merge::RequestOptions]
+      # @return [Merge::Ats::AsyncPassthroughReciept]
+      # @example
+      #  api = Merge::Client.new(
+      #    environment: Environment::PRODUCTION,
+      #    base_url: "https://api.example.com",
+      #    api_key: "YOUR_AUTH_TOKEN"
+      #  )
+      #  api.ats.create(request: { method: GET, path: "/scooters" })
       def create(request:, request_options: nil)
-        response = @request_client.conn.post("/api/ats/v1/async-passthrough") 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?
           req.headers = { **req.headers, **(request_options&.additional_headers || {}) }.compact
           req.body = { **(request || {}), **(request_options&.additional_body_parameters || {}) }.compact
+          req.url "#{@request_client.get_url(request_options: request_options)}/ats/v1/async-passthrough"
         end
-        Ats::AsyncPassthroughReciept.from_json(json_object: response.body)
+        Merge::Ats::AsyncPassthroughReciept.from_json(json_object: response.body)
       end
 
       # Retrieves data from earlier async-passthrough POST request
       #
       # @param async_passthrough_receipt_id [String]
-      # @param request_options [RequestOptions]
-      # @return [Ats::RemoteResponse]
+      # @param request_options [Merge::RequestOptions]
+      # @return [Merge::Ats::RemoteResponse]
+      # @example
+      #  api = Merge::Client.new(
+      #    environment: Environment::PRODUCTION,
+      #    base_url: "https://api.example.com",
+      #    api_key: "YOUR_AUTH_TOKEN"
+      #  )
+      #  api.ats.retrieve(async_passthrough_receipt_id: "async_passthrough_receipt_id")
       def retrieve(async_passthrough_receipt_id:, request_options: nil)
-        response = @request_client.conn.get("/api/ats/v1/async-passthrough/#{async_passthrough_receipt_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)}/ats/v1/async-passthrough/#{async_passthrough_receipt_id}"
         end
-        Ats::RemoteResponse.from_json(json_object: response.body)
+        Merge::Ats::RemoteResponse.from_json(json_object: response.body)
       end
     end
 
     class AsyncAsyncPassthroughClient
+      # @return [Merge::AsyncRequestClient]
       attr_reader :request_client
 
-      # @param request_client [AsyncRequestClient]
-      # @return [Ats::AsyncAsyncPassthroughClient]
+      # @param request_client [Merge::AsyncRequestClient]
+      # @return [Merge::Ats::AsyncAsyncPassthroughClient]
       def initialize(request_client:)
-        # @type [AsyncRequestClient]
         @request_client = request_client
       end
 
       # Asynchronously pull data from an endpoint not currently supported by Merge.
       #
-      # @param request [Hash] Request of type Ats::DataPassthroughRequest, as a Hash
-      #   * :method (METHOD_ENUM)
+      # @param request [Hash] Request of type Merge::Ats::DataPassthroughRequest, as a Hash
+      #   * :method (Merge::Ats::MethodEnum)
       #   * :path (String)
       #   * :base_url_override (String)
       #   * :data (String)
-      #   * :multipart_form_data (Array<Ats::MultipartFormFieldRequest>)
-      #   * :headers (Hash{String => String})
-      #   * :request_format (REQUEST_FORMAT_ENUM)
+      #   * :multipart_form_data (Array<Merge::Ats::MultipartFormFieldRequest>)
+      #   * :headers (Hash{String => Object})
+      #   * :request_format (Merge::Ats::RequestFormatEnum)
       #   * :normalize_response (Boolean)
-      # @param request_options [RequestOptions]
-      # @return [Ats::AsyncPassthroughReciept]
+      # @param request_options [Merge::RequestOptions]
+      # @return [Merge::Ats::AsyncPassthroughReciept]
+      # @example
+      #  api = Merge::Client.new(
+      #    environment: Environment::PRODUCTION,
+      #    base_url: "https://api.example.com",
+      #    api_key: "YOUR_AUTH_TOKEN"
+      #  )
+      #  api.ats.create(request: { method: GET, path: "/scooters" })
       def create(request:, request_options: nil)
         Async do
-          response = @request_client.conn.post("/api/ats/v1/async-passthrough") 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?
             req.headers = { **req.headers, **(request_options&.additional_headers || {}) }.compact
             req.body = { **(request || {}), **(request_options&.additional_body_parameters || {}) }.compact
+            req.url "#{@request_client.get_url(request_options: request_options)}/ats/v1/async-passthrough"
           end
-          Ats::AsyncPassthroughReciept.from_json(json_object: response.body)
+          Merge::Ats::AsyncPassthroughReciept.from_json(json_object: response.body)
         end
       end
 
       # Retrieves data from earlier async-passthrough POST request
       #
       # @param async_passthrough_receipt_id [String]
-      # @param request_options [RequestOptions]
-      # @return [Ats::RemoteResponse]
+      # @param request_options [Merge::RequestOptions]
+      # @return [Merge::Ats::RemoteResponse]
+      # @example
+      #  api = Merge::Client.new(
+      #    environment: Environment::PRODUCTION,
+      #    base_url: "https://api.example.com",
+      #    api_key: "YOUR_AUTH_TOKEN"
+      #  )
+      #  api.ats.retrieve(async_passthrough_receipt_id: "async_passthrough_receipt_id")
       def retrieve(async_passthrough_receipt_id:, request_options: nil)
         Async do
-          response = @request_client.conn.get("/api/ats/v1/async-passthrough/#{async_passthrough_receipt_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)}/ats/v1/async-passthrough/#{async_passthrough_receipt_id}"
           end
-          Ats::RemoteResponse.from_json(json_object: response.body)
+          Merge::Ats::RemoteResponse.from_json(json_object: response.body)
         end
       end
     end

data/lib/merge_ruby_client/ats/attachments/client.rb

@@ -12,12 +12,12 @@ require "async"
 module Merge
   module Ats
     class AttachmentsClient
+      # @return [Merge::RequestClient]
       attr_reader :request_client
 
-      # @param request_client [RequestClient]
-      # @return [Ats::AttachmentsClient]
+      # @param request_client [Merge::RequestClient]
+      # @return [Merge::Ats::AttachmentsClient]
       def initialize(request_client:)
-        # @type [RequestClient]
         @request_client = request_client
       end
 
@@ -27,20 +27,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 [String] Which relations should be returned in expanded form. Multiple relation names should be comma separated without spaces.
+      # @param expand [String] 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_data [Boolean] Whether to include the original data Merge fetched from the third-party to
+      #  produce these models.
       # @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_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 request_options [RequestOptions]
-      # @return [Ats::PaginatedAttachmentList]
+      # @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::Ats::PaginatedAttachmentList]
+      # @example
+      #  api = Merge::Client.new(
+      #    environment: Environment::PRODUCTION,
+      #    base_url: "https://api.example.com",
+      #    api_key: "YOUR_AUTH_TOKEN"
+      #  )
+      #  api.ats.list
       def list(candidate_id: nil, created_after: nil, created_before: nil, cursor: nil, expand: nil,
                include_deleted_data: nil, include_remote_data: nil, modified_after: nil, modified_before: nil, page_size: nil, remote_fields: nil, remote_id: nil, show_enum_origins: nil, request_options: nil)
-        response = @request_client.conn.get("/api/ats/v1/attachments") 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?
@@ -61,26 +73,34 @@ module Merge
             "remote_id": remote_id,
             "show_enum_origins": show_enum_origins
           }.compact
+          req.url "#{@request_client.get_url(request_options: request_options)}/ats/v1/attachments"
         end
-        Ats::PaginatedAttachmentList.from_json(json_object: response.body)
+        Merge::Ats::PaginatedAttachmentList.from_json(json_object: response.body)
       end
 
       # Creates an `Attachment` 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 Ats::AttachmentRequest, as a Hash
+      # @param model [Hash] Request of type Merge::Ats::AttachmentRequest, as a Hash
       #   * :file_name (String)
       #   * :file_url (String)
       #   * :candidate (String)
-      #   * :attachment_type (ATTACHMENT_TYPE_ENUM)
-      #   * :integration_params (Hash{String => String})
-      #   * :linked_account_params (Hash{String => String})
+      #   * :attachment_type (Merge::Ats::AttachmentTypeEnum)
+      #   * :integration_params (Hash{String => Object})
+      #   * :linked_account_params (Hash{String => Object})
       # @param remote_user_id [String]
-      # @param request_options [RequestOptions]
-      # @return [Ats::AttachmentResponse]
+      # @param request_options [Merge::RequestOptions]
+      # @return [Merge::Ats::AttachmentResponse]
+      # @example
+      #  api = Merge::Client.new(
+      #    environment: Environment::PRODUCTION,
+      #    base_url: "https://api.example.com",
+      #    api_key: "YOUR_AUTH_TOKEN"
+      #  )
+      #  api.ats.create(model: {  }, remote_user_id: "remote_user_id")
       def create(model:, remote_user_id:, is_debug_mode: nil, run_async: nil, request_options: nil)
-        response = @request_client.conn.post("/api/ats/v1/attachments") 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?
@@ -95,22 +115,34 @@ module Merge
             model: model,
             remote_user_id: remote_user_id
           }.compact
+          req.url "#{@request_client.get_url(request_options: request_options)}/ats/v1/attachments"
         end
-        Ats::AttachmentResponse.from_json(json_object: response.body)
+        Merge::Ats::AttachmentResponse.from_json(json_object: response.body)
       end
 
       # Returns an `Attachment` object with the given `id`.
       #
       # @param id [String]
-      # @param expand [String] 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 expand [String] 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 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 [Ats::Attachment]
+      # @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::Ats::Attachment]
+      # @example
+      #  api = Merge::Client.new(
+      #    environment: Environment::PRODUCTION,
+      #    base_url: "https://api.example.com",
+      #    api_key: "YOUR_AUTH_TOKEN"
+      #  )
+      #  api.ats.retrieve(id: "id")
       def retrieve(id:, expand: nil, include_remote_data: nil, remote_fields: nil, show_enum_origins: nil,
                    request_options: nil)
-        response = @request_client.conn.get("/api/ats/v1/attachments/#{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?
@@ -122,32 +154,41 @@ module Merge
             "remote_fields": remote_fields,
             "show_enum_origins": show_enum_origins
           }.compact
+          req.url "#{@request_client.get_url(request_options: request_options)}/ats/v1/attachments/#{id}"
         end
-        Ats::Attachment.from_json(json_object: response.body)
+        Merge::Ats::Attachment.from_json(json_object: response.body)
       end
 
       # Returns metadata for `Attachment` POSTs.
       #
-      # @param request_options [RequestOptions]
-      # @return [Ats::MetaResponse]
+      # @param request_options [Merge::RequestOptions]
+      # @return [Merge::Ats::MetaResponse]
+      # @example
+      #  api = Merge::Client.new(
+      #    environment: Environment::PRODUCTION,
+      #    base_url: "https://api.example.com",
+      #    api_key: "YOUR_AUTH_TOKEN"
+      #  )
+      #  api.ats.meta_post_retrieve
       def meta_post_retrieve(request_options: nil)
-        response = @request_client.conn.get("/api/ats/v1/attachments/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)}/ats/v1/attachments/meta/post"
         end
-        Ats::MetaResponse.from_json(json_object: response.body)
+        Merge::Ats::MetaResponse.from_json(json_object: response.body)
       end
     end
 
     class AsyncAttachmentsClient
+      # @return [Merge::AsyncRequestClient]
       attr_reader :request_client
 
-      # @param request_client [AsyncRequestClient]
-      # @return [Ats::AsyncAttachmentsClient]
+      # @param request_client [Merge::AsyncRequestClient]
+      # @return [Merge::Ats::AsyncAttachmentsClient]
       def initialize(request_client:)
-        # @type [AsyncRequestClient]
         @request_client = request_client
       end
 
@@ -157,21 +198,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 [String] Which relations should be returned in expanded form. Multiple relation names should be comma separated without spaces.
+      # @param expand [String] 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_data [Boolean] Whether to include the original data Merge fetched from the third-party to
+      #  produce these models.
       # @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_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 request_options [RequestOptions]
-      # @return [Ats::PaginatedAttachmentList]
+      # @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::Ats::PaginatedAttachmentList]
+      # @example
+      #  api = Merge::Client.new(
+      #    environment: Environment::PRODUCTION,
+      #    base_url: "https://api.example.com",
+      #    api_key: "YOUR_AUTH_TOKEN"
+      #  )
+      #  api.ats.list
       def list(candidate_id: nil, created_after: nil, created_before: nil, cursor: nil, expand: nil,
                include_deleted_data: nil, include_remote_data: nil, modified_after: nil, modified_before: nil, page_size: nil, remote_fields: nil, remote_id: nil, show_enum_origins: nil, request_options: nil)
         Async do
-          response = @request_client.conn.get("/api/ats/v1/attachments") 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?
@@ -192,8 +245,9 @@ module Merge
               "remote_id": remote_id,
               "show_enum_origins": show_enum_origins
             }.compact
+            req.url "#{@request_client.get_url(request_options: request_options)}/ats/v1/attachments"
           end
-          Ats::PaginatedAttachmentList.from_json(json_object: response.body)
+          Merge::Ats::PaginatedAttachmentList.from_json(json_object: response.body)
         end
       end
 
@@ -201,19 +255,26 @@ 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 Ats::AttachmentRequest, as a Hash
+      # @param model [Hash] Request of type Merge::Ats::AttachmentRequest, as a Hash
       #   * :file_name (String)
       #   * :file_url (String)
       #   * :candidate (String)
-      #   * :attachment_type (ATTACHMENT_TYPE_ENUM)
-      #   * :integration_params (Hash{String => String})
-      #   * :linked_account_params (Hash{String => String})
+      #   * :attachment_type (Merge::Ats::AttachmentTypeEnum)
+      #   * :integration_params (Hash{String => Object})
+      #   * :linked_account_params (Hash{String => Object})
       # @param remote_user_id [String]
-      # @param request_options [RequestOptions]
-      # @return [Ats::AttachmentResponse]
+      # @param request_options [Merge::RequestOptions]
+      # @return [Merge::Ats::AttachmentResponse]
+      # @example
+      #  api = Merge::Client.new(
+      #    environment: Environment::PRODUCTION,
+      #    base_url: "https://api.example.com",
+      #    api_key: "YOUR_AUTH_TOKEN"
+      #  )
+      #  api.ats.create(model: {  }, remote_user_id: "remote_user_id")
       def create(model:, remote_user_id:, is_debug_mode: nil, run_async: nil, request_options: nil)
         Async do
-          response = @request_client.conn.post("/api/ats/v1/attachments") 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?
@@ -228,24 +289,36 @@ module Merge
               model: model,
               remote_user_id: remote_user_id
             }.compact
+            req.url "#{@request_client.get_url(request_options: request_options)}/ats/v1/attachments"
           end
-          Ats::AttachmentResponse.from_json(json_object: response.body)
+          Merge::Ats::AttachmentResponse.from_json(json_object: response.body)
         end
       end
 
       # Returns an `Attachment` object with the given `id`.
       #
       # @param id [String]
-      # @param expand [String] 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 expand [String] 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 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 [Ats::Attachment]
+      # @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::Ats::Attachment]
+      # @example
+      #  api = Merge::Client.new(
+      #    environment: Environment::PRODUCTION,
+      #    base_url: "https://api.example.com",
+      #    api_key: "YOUR_AUTH_TOKEN"
+      #  )
+      #  api.ats.retrieve(id: "id")
       def retrieve(id:, expand: nil, include_remote_data: nil, remote_fields: nil, show_enum_origins: nil,
                    request_options: nil)
         Async do
-          response = @request_client.conn.get("/api/ats/v1/attachments/#{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?
@@ -257,24 +330,33 @@ module Merge
               "remote_fields": remote_fields,
               "show_enum_origins": show_enum_origins
             }.compact
+            req.url "#{@request_client.get_url(request_options: request_options)}/ats/v1/attachments/#{id}"
           end
-          Ats::Attachment.from_json(json_object: response.body)
+          Merge::Ats::Attachment.from_json(json_object: response.body)
         end
       end
 
       # Returns metadata for `Attachment` POSTs.
       #
-      # @param request_options [RequestOptions]
-      # @return [Ats::MetaResponse]
+      # @param request_options [Merge::RequestOptions]
+      # @return [Merge::Ats::MetaResponse]
+      # @example
+      #  api = Merge::Client.new(
+      #    environment: Environment::PRODUCTION,
+      #    base_url: "https://api.example.com",
+      #    api_key: "YOUR_AUTH_TOKEN"
+      #  )
+      #  api.ats.meta_post_retrieve
       def meta_post_retrieve(request_options: nil)
         Async do
-          response = @request_client.conn.get("/api/ats/v1/attachments/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)}/ats/v1/attachments/meta/post"
           end
-          Ats::MetaResponse.from_json(json_object: response.body)
+          Merge::Ats::MetaResponse.from_json(json_object: response.body)
         end
       end
     end