merge_ruby_client 0.0.3 → 0.0.5

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

@@ -9,33 +9,61 @@ require "async"
 module Merge
   module Ats
     class LinkTokenClient
+      # @return [Merge::RequestClient]
       attr_reader :request_client
 
-      # @param request_client [RequestClient]
-      # @return [Ats::LinkTokenClient]
+      # @param request_client [Merge::RequestClient]
+      # @return [Merge::Ats::LinkTokenClient]
       def initialize(request_client:)
-        # @type [RequestClient]
         @request_client = request_client
       end
 
       # Creates a link token to be used when linking a new end user.
       #
-      # @param end_user_email_address [String] Your end user's email address. This is purely for identification purposes - setting this value will not cause any emails to be sent.
+      # @param end_user_email_address [String] Your end user's email address. This is purely for identification purposes -
+      #  setting this value will not cause any emails to be sent.
       # @param end_user_organization_name [String] Your end user's organization.
-      # @param end_user_origin_id [String] This unique identifier typically represents the ID for your end user in your product's database. This value must be distinct from other Linked Accounts' unique identifiers.
-      # @param categories [Array<Ats::CATEGORIES_ENUM>] The integration categories to show in Merge Link.
-      # @param integration [String] The slug of a specific pre-selected integration for this linking flow token. For examples of slugs, see https://docs.merge.dev/guides/merge-link/single-integration/.
-      # @param link_expiry_mins [Integer] An integer number of minutes between [30, 720 or 10080 if for a Magic Link URL] for how long this token is valid. Defaults to 30.
-      # @param should_create_magic_link_url [Boolean] Whether to generate a Magic Link URL. Defaults to false. For more information on Magic Link, see https://merge.dev/blog/integrations-fast-say-hello-to-magic-link.
-      # @param common_models [Array<Hash>] An array of objects to specify the models and fields that will be disabled for a given Linked Account. Each object uses model_id, enabled_actions, and disabled_fields to specify the model, method, and fields that are scoped for a given Linked Account.Request of type Array<Ats::CommonModelScopesBodyRequest>, as a Hash
+      # @param end_user_origin_id [String] This unique identifier typically represents the ID for your end user in your
+      #  product's database. This value must be distinct from other Linked Accounts'
+      #  unique identifiers.
+      # @param categories [Array<Merge::Ats::CategoriesEnum>] The integration categories to show in Merge Link.
+      # @param integration [String] The slug of a specific pre-selected integration for this linking flow token. For
+      #  examples of slugs, see
+      #  https://docs.merge.dev/guides/merge-link/single-integration/.
+      # @param link_expiry_mins [Integer] An integer number of minutes between [30, 720 or 10080 if for a Magic Link URL]
+      #  for how long this token is valid. Defaults to 30.
+      # @param should_create_magic_link_url [Boolean] Whether to generate a Magic Link URL. Defaults to false. For more information on
+      #  Magic Link, see
+      #  https://merge.dev/blog/integrations-fast-say-hello-to-magic-link.
+      # @param common_models [Array<Hash>] An array of objects to specify the models and fields that will be disabled for a
+      #  given Linked Account. Each object uses model_id, enabled_actions, and
+      #  disabled_fields to specify the model, method, and fields that are scoped for a
+      #  given Linked Account.Request of type Array<Merge::Ats::CommonModelScopesBodyRequest>, as a Hash
       #   * :model_id (String)
-      #   * :enabled_actions (Array<Ats::ENABLED_ACTIONS_ENUM>)
+      #   * :enabled_actions (Array<Merge::Ats::EnabledActionsEnum>)
       #   * :disabled_fields (Array<String>)
-      # @param request_options [RequestOptions]
-      # @return [Ats::LinkToken]
+      # @param category_common_model_scopes [Hash{String => Array}] When creating a Link Token, you can set permissions for Common Models that will
+      #  apply to the account that is going to be linked. Any model or field not
+      #  specified in link token payload will default to existing settings.
+      # @param language [String] The language code for the language to localize Merge Link to.
+      # @param integration_specific_config [Hash{String => Object}] A JSON object containing integration-specific configuration options.
+      # @param request_options [Merge::RequestOptions]
+      # @return [Merge::Ats::LinkToken]
+      # @example
+      #  api = Merge::Client.new(
+      #    environment: Environment::PRODUCTION,
+      #    base_url: "https://api.example.com",
+      #    api_key: "YOUR_AUTH_TOKEN"
+      #  )
+      #  api.ats.create(
+      #    end_user_email_address: "example@gmail.com",
+      #    end_user_organization_name: "Test Organization",
+      #    end_user_origin_id: "12345",
+      #    categories: [HRIS]
+      #  )
       def create(end_user_email_address:, end_user_organization_name:, end_user_origin_id:, categories:,
-                 integration: nil, link_expiry_mins: nil, should_create_magic_link_url: nil, common_models: nil, request_options: nil)
-        response = @request_client.conn.post("/api/ats/v1/link-token") do |req|
+                 integration: nil, link_expiry_mins: nil, should_create_magic_link_url: nil, common_models: nil, category_common_model_scopes: nil, language: nil, integration_specific_config: nil, request_options: nil)
+        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?
@@ -49,42 +77,74 @@ module Merge
             integration: integration,
             link_expiry_mins: link_expiry_mins,
             should_create_magic_link_url: should_create_magic_link_url,
-            common_models: common_models
+            common_models: common_models,
+            category_common_model_scopes: category_common_model_scopes,
+            language: language,
+            integration_specific_config: integration_specific_config
           }.compact
+          req.url "#{@request_client.get_url(request_options: request_options)}/ats/v1/link-token"
         end
-        Ats::LinkToken.from_json(json_object: response.body)
+        Merge::Ats::LinkToken.from_json(json_object: response.body)
       end
     end
 
     class AsyncLinkTokenClient
+      # @return [Merge::AsyncRequestClient]
       attr_reader :request_client
 
-      # @param request_client [AsyncRequestClient]
-      # @return [Ats::AsyncLinkTokenClient]
+      # @param request_client [Merge::AsyncRequestClient]
+      # @return [Merge::Ats::AsyncLinkTokenClient]
       def initialize(request_client:)
-        # @type [AsyncRequestClient]
         @request_client = request_client
       end
 
       # Creates a link token to be used when linking a new end user.
       #
-      # @param end_user_email_address [String] Your end user's email address. This is purely for identification purposes - setting this value will not cause any emails to be sent.
+      # @param end_user_email_address [String] Your end user's email address. This is purely for identification purposes -
+      #  setting this value will not cause any emails to be sent.
       # @param end_user_organization_name [String] Your end user's organization.
-      # @param end_user_origin_id [String] This unique identifier typically represents the ID for your end user in your product's database. This value must be distinct from other Linked Accounts' unique identifiers.
-      # @param categories [Array<Ats::CATEGORIES_ENUM>] The integration categories to show in Merge Link.
-      # @param integration [String] The slug of a specific pre-selected integration for this linking flow token. For examples of slugs, see https://docs.merge.dev/guides/merge-link/single-integration/.
-      # @param link_expiry_mins [Integer] An integer number of minutes between [30, 720 or 10080 if for a Magic Link URL] for how long this token is valid. Defaults to 30.
-      # @param should_create_magic_link_url [Boolean] Whether to generate a Magic Link URL. Defaults to false. For more information on Magic Link, see https://merge.dev/blog/integrations-fast-say-hello-to-magic-link.
-      # @param common_models [Array<Hash>] An array of objects to specify the models and fields that will be disabled for a given Linked Account. Each object uses model_id, enabled_actions, and disabled_fields to specify the model, method, and fields that are scoped for a given Linked Account.Request of type Array<Ats::CommonModelScopesBodyRequest>, as a Hash
+      # @param end_user_origin_id [String] This unique identifier typically represents the ID for your end user in your
+      #  product's database. This value must be distinct from other Linked Accounts'
+      #  unique identifiers.
+      # @param categories [Array<Merge::Ats::CategoriesEnum>] The integration categories to show in Merge Link.
+      # @param integration [String] The slug of a specific pre-selected integration for this linking flow token. For
+      #  examples of slugs, see
+      #  https://docs.merge.dev/guides/merge-link/single-integration/.
+      # @param link_expiry_mins [Integer] An integer number of minutes between [30, 720 or 10080 if for a Magic Link URL]
+      #  for how long this token is valid. Defaults to 30.
+      # @param should_create_magic_link_url [Boolean] Whether to generate a Magic Link URL. Defaults to false. For more information on
+      #  Magic Link, see
+      #  https://merge.dev/blog/integrations-fast-say-hello-to-magic-link.
+      # @param common_models [Array<Hash>] An array of objects to specify the models and fields that will be disabled for a
+      #  given Linked Account. Each object uses model_id, enabled_actions, and
+      #  disabled_fields to specify the model, method, and fields that are scoped for a
+      #  given Linked Account.Request of type Array<Merge::Ats::CommonModelScopesBodyRequest>, as a Hash
       #   * :model_id (String)
-      #   * :enabled_actions (Array<Ats::ENABLED_ACTIONS_ENUM>)
+      #   * :enabled_actions (Array<Merge::Ats::EnabledActionsEnum>)
       #   * :disabled_fields (Array<String>)
-      # @param request_options [RequestOptions]
-      # @return [Ats::LinkToken]
+      # @param category_common_model_scopes [Hash{String => Array}] When creating a Link Token, you can set permissions for Common Models that will
+      #  apply to the account that is going to be linked. Any model or field not
+      #  specified in link token payload will default to existing settings.
+      # @param language [String] The language code for the language to localize Merge Link to.
+      # @param integration_specific_config [Hash{String => Object}] A JSON object containing integration-specific configuration options.
+      # @param request_options [Merge::RequestOptions]
+      # @return [Merge::Ats::LinkToken]
+      # @example
+      #  api = Merge::Client.new(
+      #    environment: Environment::PRODUCTION,
+      #    base_url: "https://api.example.com",
+      #    api_key: "YOUR_AUTH_TOKEN"
+      #  )
+      #  api.ats.create(
+      #    end_user_email_address: "example@gmail.com",
+      #    end_user_organization_name: "Test Organization",
+      #    end_user_origin_id: "12345",
+      #    categories: [HRIS]
+      #  )
       def create(end_user_email_address:, end_user_organization_name:, end_user_origin_id:, categories:,
-                 integration: nil, link_expiry_mins: nil, should_create_magic_link_url: nil, common_models: nil, request_options: nil)
+                 integration: nil, link_expiry_mins: nil, should_create_magic_link_url: nil, common_models: nil, category_common_model_scopes: nil, language: nil, integration_specific_config: nil, request_options: nil)
         Async do
-          response = @request_client.conn.post("/api/ats/v1/link-token") 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?
@@ -98,10 +158,14 @@ module Merge
               integration: integration,
               link_expiry_mins: link_expiry_mins,
               should_create_magic_link_url: should_create_magic_link_url,
-              common_models: common_models
+              common_models: common_models,
+              category_common_model_scopes: category_common_model_scopes,
+              language: language,
+              integration_specific_config: integration_specific_config
             }.compact
+            req.url "#{@request_client.get_url(request_options: request_options)}/ats/v1/link-token"
           end
-          Ats::LinkToken.from_json(json_object: response.body)
+          Merge::Ats::LinkToken.from_json(json_object: response.body)
         end
       end
     end

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

@@ -8,42 +8,58 @@ require "async"
 module Merge
   module Ats
     class LinkedAccountsClient
+      # @return [Merge::RequestClient]
       attr_reader :request_client
 
-      # @param request_client [RequestClient]
-      # @return [Ats::LinkedAccountsClient]
+      # @param request_client [Merge::RequestClient]
+      # @return [Merge::Ats::LinkedAccountsClient]
       def initialize(request_client:)
-        # @type [RequestClient]
         @request_client = request_client
       end
 
       # List linked accounts for your organization.
       #
-      # @param category [LINKED_ACCOUNTS_LIST_REQUEST_CATEGORY] Options: ('hris', 'ats', 'accounting', 'ticketing', 'crm', 'mktg', 'filestorage')
-      #   - `hris` - hris
-      #   - `ats` - ats
-      #   - `accounting` - accounting
-      #   - `ticketing` - ticketing
-      #   - `crm` - crm
-      #   - `mktg` - mktg
-      #   - `filestorage` - filestorage
+      # @param category [Merge::Ats::LinkedAccounts::LinkedAccountsListRequestCategory] Options: `accounting`, `ats`, `crm`, `filestorage`, `hris`, `mktg`, `ticketing`
+      #  - `hris` - hris
+      #  - `ats` - ats
+      #  - `accounting` - accounting
+      #  - `ticketing` - ticketing
+      #  - `crm` - crm
+      #  - `mktg` - mktg
+      #  - `filestorage` - filestorage
       # @param cursor [String] The pagination cursor value.
-      # @param end_user_email_address [String] If provided, will only return linked accounts associated with the given email address.
-      # @param end_user_organization_name [String] If provided, will only return linked accounts associated with the given organization name.
-      # @param end_user_origin_id [String] If provided, will only return linked accounts associated with the given origin ID.
-      # @param end_user_origin_ids [String] Comma-separated list of EndUser origin IDs, making it possible to specify multiple EndUsers at once.
+      # @param end_user_email_address [String] If provided, will only return linked accounts associated with the given email
+      #  address.
+      # @param end_user_organization_name [String] If provided, will only return linked accounts associated with the given
+      #  organization name.
+      # @param end_user_origin_id [String] If provided, will only return linked accounts associated with the given origin
+      #  ID.
+      # @param end_user_origin_ids [String] Comma-separated list of EndUser origin IDs, making it possible to specify
+      #  multiple EndUsers at once.
       # @param id [String]
-      # @param ids [String] Comma-separated list of LinkedAccount IDs, making it possible to specify multiple LinkedAccounts at once.
-      # @param include_duplicates [Boolean] If `true`, will include complete production duplicates of the account specified by the `id` query parameter in the response. `id` must be for a complete production linked account.
-      # @param integration_name [String] If provided, will only return linked accounts associated with the given integration name.
-      # @param is_test_account [String] If included, will only include test linked accounts. If not included, will only include non-test linked accounts.
+      # @param ids [String] Comma-separated list of LinkedAccount IDs, making it possible to specify
+      #  multiple LinkedAccounts at once.
+      # @param include_duplicates [Boolean] If `true`, will include complete production duplicates of the account specified
+      #  by the `id` query parameter in the response. `id` must be for a complete
+      #  production linked account.
+      # @param integration_name [String] If provided, will only return linked accounts associated with the given
+      #  integration name.
+      # @param is_test_account [String] If included, will only include test linked accounts. If not included, will only
+      #  include non-test linked accounts.
       # @param page_size [Integer] Number of results to return per page.
       # @param status [String] Filter by status. Options: `COMPLETE`, `INCOMPLETE`, `RELINK_NEEDED`
-      # @param request_options [RequestOptions]
-      # @return [Ats::PaginatedAccountDetailsAndActionsList]
+      # @param request_options [Merge::RequestOptions]
+      # @return [Merge::Ats::PaginatedAccountDetailsAndActionsList]
+      # @example
+      #  api = Merge::Client.new(
+      #    environment: Environment::PRODUCTION,
+      #    base_url: "https://api.example.com",
+      #    api_key: "YOUR_AUTH_TOKEN"
+      #  )
+      #  api.ats.list
       def list(category: nil, cursor: nil, end_user_email_address: nil, end_user_organization_name: nil,
                end_user_origin_id: nil, end_user_origin_ids: nil, id: nil, ids: nil, include_duplicates: nil, integration_name: nil, is_test_account: nil, page_size: nil, status: nil, request_options: nil)
-        response = @request_client.conn.get("/api/ats/v1/linked-accounts") 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?
@@ -64,49 +80,66 @@ module Merge
             "page_size": page_size,
             "status": status
           }.compact
+          req.url "#{@request_client.get_url(request_options: request_options)}/ats/v1/linked-accounts"
         end
-        Ats::PaginatedAccountDetailsAndActionsList.from_json(json_object: response.body)
+        Merge::Ats::PaginatedAccountDetailsAndActionsList.from_json(json_object: response.body)
       end
     end
 
     class AsyncLinkedAccountsClient
+      # @return [Merge::AsyncRequestClient]
       attr_reader :request_client
 
-      # @param request_client [AsyncRequestClient]
-      # @return [Ats::AsyncLinkedAccountsClient]
+      # @param request_client [Merge::AsyncRequestClient]
+      # @return [Merge::Ats::AsyncLinkedAccountsClient]
       def initialize(request_client:)
-        # @type [AsyncRequestClient]
         @request_client = request_client
       end
 
       # List linked accounts for your organization.
       #
-      # @param category [LINKED_ACCOUNTS_LIST_REQUEST_CATEGORY] Options: ('hris', 'ats', 'accounting', 'ticketing', 'crm', 'mktg', 'filestorage')
-      #   - `hris` - hris
-      #   - `ats` - ats
-      #   - `accounting` - accounting
-      #   - `ticketing` - ticketing
-      #   - `crm` - crm
-      #   - `mktg` - mktg
-      #   - `filestorage` - filestorage
+      # @param category [Merge::Ats::LinkedAccounts::LinkedAccountsListRequestCategory] Options: `accounting`, `ats`, `crm`, `filestorage`, `hris`, `mktg`, `ticketing`
+      #  - `hris` - hris
+      #  - `ats` - ats
+      #  - `accounting` - accounting
+      #  - `ticketing` - ticketing
+      #  - `crm` - crm
+      #  - `mktg` - mktg
+      #  - `filestorage` - filestorage
       # @param cursor [String] The pagination cursor value.
-      # @param end_user_email_address [String] If provided, will only return linked accounts associated with the given email address.
-      # @param end_user_organization_name [String] If provided, will only return linked accounts associated with the given organization name.
-      # @param end_user_origin_id [String] If provided, will only return linked accounts associated with the given origin ID.
-      # @param end_user_origin_ids [String] Comma-separated list of EndUser origin IDs, making it possible to specify multiple EndUsers at once.
+      # @param end_user_email_address [String] If provided, will only return linked accounts associated with the given email
+      #  address.
+      # @param end_user_organization_name [String] If provided, will only return linked accounts associated with the given
+      #  organization name.
+      # @param end_user_origin_id [String] If provided, will only return linked accounts associated with the given origin
+      #  ID.
+      # @param end_user_origin_ids [String] Comma-separated list of EndUser origin IDs, making it possible to specify
+      #  multiple EndUsers at once.
       # @param id [String]
-      # @param ids [String] Comma-separated list of LinkedAccount IDs, making it possible to specify multiple LinkedAccounts at once.
-      # @param include_duplicates [Boolean] If `true`, will include complete production duplicates of the account specified by the `id` query parameter in the response. `id` must be for a complete production linked account.
-      # @param integration_name [String] If provided, will only return linked accounts associated with the given integration name.
-      # @param is_test_account [String] If included, will only include test linked accounts. If not included, will only include non-test linked accounts.
+      # @param ids [String] Comma-separated list of LinkedAccount IDs, making it possible to specify
+      #  multiple LinkedAccounts at once.
+      # @param include_duplicates [Boolean] If `true`, will include complete production duplicates of the account specified
+      #  by the `id` query parameter in the response. `id` must be for a complete
+      #  production linked account.
+      # @param integration_name [String] If provided, will only return linked accounts associated with the given
+      #  integration name.
+      # @param is_test_account [String] If included, will only include test linked accounts. If not included, will only
+      #  include non-test linked accounts.
       # @param page_size [Integer] Number of results to return per page.
       # @param status [String] Filter by status. Options: `COMPLETE`, `INCOMPLETE`, `RELINK_NEEDED`
-      # @param request_options [RequestOptions]
-      # @return [Ats::PaginatedAccountDetailsAndActionsList]
+      # @param request_options [Merge::RequestOptions]
+      # @return [Merge::Ats::PaginatedAccountDetailsAndActionsList]
+      # @example
+      #  api = Merge::Client.new(
+      #    environment: Environment::PRODUCTION,
+      #    base_url: "https://api.example.com",
+      #    api_key: "YOUR_AUTH_TOKEN"
+      #  )
+      #  api.ats.list
       def list(category: nil, cursor: nil, end_user_email_address: nil, end_user_organization_name: nil,
                end_user_origin_id: nil, end_user_origin_ids: nil, id: nil, ids: nil, include_duplicates: nil, integration_name: nil, is_test_account: nil, page_size: nil, status: nil, request_options: nil)
         Async do
-          response = @request_client.conn.get("/api/ats/v1/linked-accounts") 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?
@@ -127,8 +160,9 @@ module Merge
               "page_size": page_size,
               "status": status
             }.compact
+            req.url "#{@request_client.get_url(request_options: request_options)}/ats/v1/linked-accounts"
           end
-          Ats::PaginatedAccountDetailsAndActionsList.from_json(json_object: response.body)
+          Merge::Ats::PaginatedAccountDetailsAndActionsList.from_json(json_object: response.body)
         end
       end
     end

data/lib/merge_ruby_client/ats/linked_accounts/types/linked_accounts_list_request_category.rb

@@ -3,16 +3,15 @@
 module Merge
   module Ats
     class LinkedAccounts
-      # @type [LINKED_ACCOUNTS_LIST_REQUEST_CATEGORY]
-      LINKED_ACCOUNTS_LIST_REQUEST_CATEGORY = {
-        accounting: "accounting",
-        ats: "ats",
-        crm: "crm",
-        filestorage: "filestorage",
-        hris: "hris",
-        mktg: "mktg",
-        ticketing: "ticketing"
-      }.freeze
+      class LinkedAccountsListRequestCategory
+        ACCOUNTING = "accounting"
+        ATS = "ats"
+        CRM = "crm"
+        FILESTORAGE = "filestorage"
+        HRIS = "hris"
+        MKTG = "mktg"
+        TICKETING = "ticketing"
+      end
     end
   end
 end

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

@@ -11,12 +11,12 @@ require "async"
 module Merge
   module Ats
     class OffersClient
+      # @return [Merge::RequestClient]
       attr_reader :request_client
 
-      # @param request_client [RequestClient]
-      # @return [Ats::OffersClient]
+      # @param request_client [Merge::RequestClient]
+      # @return [Merge::Ats::OffersClient]
       def initialize(request_client:)
-        # @type [RequestClient]
         @request_client = request_client
       end
 
@@ -27,20 +27,32 @@ module Merge
       # @param created_before [DateTime] If provided, will only return objects created before this datetime.
       # @param creator_id [String] If provided, will only return offers created by this user.
       # @param cursor [String] The pagination cursor value.
-      # @param expand [OFFERS_LIST_REQUEST_EXPAND] Which relations should be returned in expanded form. Multiple relation names should be comma separated without spaces.
+      # @param expand [Merge::Ats::Offers::OffersListRequestExpand] 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::PaginatedOfferList]
+      # @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::PaginatedOfferList]
+      # @example
+      #  api = Merge::Client.new(
+      #    environment: Environment::PRODUCTION,
+      #    base_url: "https://api.example.com",
+      #    api_key: "YOUR_AUTH_TOKEN"
+      #  )
+      #  api.ats.list
       def list(application_id: nil, created_after: nil, created_before: nil, creator_id: 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/offers") 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?
@@ -62,22 +74,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/offers"
         end
-        Ats::PaginatedOfferList.from_json(json_object: response.body)
+        Merge::Ats::PaginatedOfferList.from_json(json_object: response.body)
       end
 
       # Returns an `Offer` object with the given `id`.
       #
       # @param id [String]
-      # @param expand [OFFERS_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 expand [Merge::Ats::Offers::OffersRetrieveRequestExpand] 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::Offer]
+      # @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::Offer]
+      # @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/offers/#{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?
@@ -89,18 +113,19 @@ 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/offers/#{id}"
         end
-        Ats::Offer.from_json(json_object: response.body)
+        Merge::Ats::Offer.from_json(json_object: response.body)
       end
     end
 
     class AsyncOffersClient
+      # @return [Merge::AsyncRequestClient]
       attr_reader :request_client
 
-      # @param request_client [AsyncRequestClient]
-      # @return [Ats::AsyncOffersClient]
+      # @param request_client [Merge::AsyncRequestClient]
+      # @return [Merge::Ats::AsyncOffersClient]
       def initialize(request_client:)
-        # @type [AsyncRequestClient]
         @request_client = request_client
       end
 
@@ -111,21 +136,33 @@ module Merge
       # @param created_before [DateTime] If provided, will only return objects created before this datetime.
       # @param creator_id [String] If provided, will only return offers created by this user.
       # @param cursor [String] The pagination cursor value.
-      # @param expand [OFFERS_LIST_REQUEST_EXPAND] Which relations should be returned in expanded form. Multiple relation names should be comma separated without spaces.
+      # @param expand [Merge::Ats::Offers::OffersListRequestExpand] 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::PaginatedOfferList]
+      # @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::PaginatedOfferList]
+      # @example
+      #  api = Merge::Client.new(
+      #    environment: Environment::PRODUCTION,
+      #    base_url: "https://api.example.com",
+      #    api_key: "YOUR_AUTH_TOKEN"
+      #  )
+      #  api.ats.list
       def list(application_id: nil, created_after: nil, created_before: nil, creator_id: 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/offers") 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?
@@ -147,24 +184,36 @@ 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/offers"
           end
-          Ats::PaginatedOfferList.from_json(json_object: response.body)
+          Merge::Ats::PaginatedOfferList.from_json(json_object: response.body)
         end
       end
 
       # Returns an `Offer` object with the given `id`.
       #
       # @param id [String]
-      # @param expand [OFFERS_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 expand [Merge::Ats::Offers::OffersRetrieveRequestExpand] 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::Offer]
+      # @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::Offer]
+      # @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/offers/#{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?
@@ -176,8 +225,9 @@ 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/offers/#{id}"
           end
-          Ats::Offer.from_json(json_object: response.body)
+          Merge::Ats::Offer.from_json(json_object: response.body)
         end
       end
     end