Merge pull request #33 from merge-api/fern-bot/04-22-2025-0554PM

🌿 Fern Regeneration -- April 22, 2025

Author: rmkonnur

lib/merge_ruby_client.rb

@@ -3,23 +3,23 @@
 require_relative "environment"
 require_relative "types_export"
 require_relative "requests"
-require_relative "merge_ruby_client/ats/client"
 require_relative "merge_ruby_client/crm/client"
-require_relative "merge_ruby_client/filestorage/client"
+require_relative "merge_ruby_client/ats/client"
 require_relative "merge_ruby_client/hris/client"
+require_relative "merge_ruby_client/filestorage/client"
 require_relative "merge_ruby_client/ticketing/client"
 require_relative "merge_ruby_client/accounting/client"
 
 module Merge
   class Client
-    # @return [Merge::Ats::Client]
-    attr_reader :ats
     # @return [Merge::Crm::Client]
     attr_reader :crm
-    # @return [Merge::Filestorage::Client]
-    attr_reader :filestorage
+    # @return [Merge::Ats::Client]
+    attr_reader :ats
     # @return [Merge::Hris::Client]
     attr_reader :hris
+    # @return [Merge::Filestorage::Client]
+    attr_reader :filestorage
     # @return [Merge::Ticketing::Client]
     attr_reader :ticketing
     # @return [Merge::Accounting::Client]
@@ -42,24 +42,24 @@ def initialize(api_key:, base_url: nil, environment: Merge::Environment::PRODUCT
         api_key: api_key,
         account_token: account_token
       )
-      @ats = Merge::Ats::Client.new(request_client: @request_client)
       @crm = Merge::Crm::Client.new(request_client: @request_client)
-      @filestorage = Merge::Filestorage::Client.new(request_client: @request_client)
+      @ats = Merge::Ats::Client.new(request_client: @request_client)
       @hris = Merge::Hris::Client.new(request_client: @request_client)
+      @filestorage = Merge::Filestorage::Client.new(request_client: @request_client)
       @ticketing = Merge::Ticketing::Client.new(request_client: @request_client)
       @accounting = Merge::Accounting::Client.new(request_client: @request_client)
     end
   end
 
   class AsyncClient
-    # @return [Merge::Ats::AsyncClient]
-    attr_reader :ats
     # @return [Merge::Crm::AsyncClient]
     attr_reader :crm
-    # @return [Merge::Filestorage::AsyncClient]
-    attr_reader :filestorage
+    # @return [Merge::Ats::AsyncClient]
+    attr_reader :ats
     # @return [Merge::Hris::AsyncClient]
     attr_reader :hris
+    # @return [Merge::Filestorage::AsyncClient]
+    attr_reader :filestorage
     # @return [Merge::Ticketing::AsyncClient]
     attr_reader :ticketing
     # @return [Merge::Accounting::AsyncClient]
@@ -82,10 +82,10 @@ def initialize(api_key:, base_url: nil, environment: Merge::Environment::PRODUCT
         api_key: api_key,
         account_token: account_token
       )
-      @ats = Merge::Ats::AsyncClient.new(request_client: @async_request_client)
       @crm = Merge::Crm::AsyncClient.new(request_client: @async_request_client)
-      @filestorage = Merge::Filestorage::AsyncClient.new(request_client: @async_request_client)
+      @ats = Merge::Ats::AsyncClient.new(request_client: @async_request_client)
       @hris = Merge::Hris::AsyncClient.new(request_client: @async_request_client)
+      @filestorage = Merge::Filestorage::AsyncClient.new(request_client: @async_request_client)
       @ticketing = Merge::Ticketing::AsyncClient.new(request_client: @async_request_client)
       @accounting = Merge::Accounting::AsyncClient.new(request_client: @async_request_client)
     end

lib/merge_ruby_client/accounting/accounting_periods/client.rb

@@ -70,6 +70,8 @@ def list(cursor: nil, include_deleted_data: nil, include_remote_data: nil, inclu
       # @param id [String]
       # @param include_remote_data [Boolean] Whether to include the original data Merge fetched from the third-party to
       #  produce these models.
+      # @param include_shell_data [Boolean] Whether to include shell records. Shell records are empty records (they may
+      #  contain some metadata but all other fields are null).
       # @param request_options [Merge::RequestOptions]
       # @return [Merge::Accounting::AccountingPeriod]
       # @example
@@ -79,7 +81,7 @@ def list(cursor: nil, include_deleted_data: nil, include_remote_data: nil, inclu
       #    api_key: "YOUR_AUTH_TOKEN"
       #  )
       #  api.accounting.accounting_periods.retrieve(id: "id")
-      def retrieve(id:, include_remote_data: nil, request_options: nil)
+      def retrieve(id:, include_remote_data: nil, include_shell_data: nil, request_options: nil)
         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?
@@ -91,7 +93,8 @@ def retrieve(id:, include_remote_data: nil, request_options: nil)
           }.compact
           req.params = {
             **(request_options&.additional_query_parameters || {}),
-            "include_remote_data": include_remote_data
+            "include_remote_data": include_remote_data,
+            "include_shell_data": include_shell_data
           }.compact
           unless request_options.nil? || request_options&.additional_body_parameters.nil?
             req.body = { **(request_options&.additional_body_parameters || {}) }.compact
@@ -167,6 +170,8 @@ def list(cursor: nil, include_deleted_data: nil, include_remote_data: nil, inclu
       # @param id [String]
       # @param include_remote_data [Boolean] Whether to include the original data Merge fetched from the third-party to
       #  produce these models.
+      # @param include_shell_data [Boolean] Whether to include shell records. Shell records are empty records (they may
+      #  contain some metadata but all other fields are null).
       # @param request_options [Merge::RequestOptions]
       # @return [Merge::Accounting::AccountingPeriod]
       # @example
@@ -176,7 +181,7 @@ def list(cursor: nil, include_deleted_data: nil, include_remote_data: nil, inclu
       #    api_key: "YOUR_AUTH_TOKEN"
       #  )
       #  api.accounting.accounting_periods.retrieve(id: "id")
-      def retrieve(id:, include_remote_data: nil, request_options: nil)
+      def retrieve(id:, include_remote_data: nil, include_shell_data: nil, request_options: nil)
         Async do
           response = @request_client.conn.get do |req|
             req.options.timeout = request_options.timeout_in_seconds unless request_options&.timeout_in_seconds.nil?
@@ -189,7 +194,8 @@ def retrieve(id:, include_remote_data: nil, request_options: nil)
             }.compact
             req.params = {
               **(request_options&.additional_query_parameters || {}),
-              "include_remote_data": include_remote_data
+              "include_remote_data": include_remote_data,
+              "include_shell_data": include_shell_data
             }.compact
             unless request_options.nil? || request_options&.additional_body_parameters.nil?
               req.body = { **(request_options&.additional_body_parameters || {}) }.compact

lib/merge_ruby_client/accounting/accounts/client.rb

@@ -45,6 +45,7 @@ def initialize(request_client:)
       # @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 name [String] If provided, will only return Accounts with this name.
       # @param page_size [Integer] Number of results to return per page.
       # @param remote_fields [Merge::Accounting::Accounts::AccountsListRequestRemoteFields] Deprecated. Use show_enum_origins.
       # @param remote_id [String] The API provider's ID for the given object.
@@ -61,7 +62,7 @@ def initialize(request_client:)
       #  )
       #  api.accounting.accounts.list
       def list(account_type: nil, company_id: nil, created_after: nil, created_before: nil, cursor: nil, expand: nil,
-               include_deleted_data: nil, include_remote_data: nil, include_shell_data: nil, modified_after: nil, modified_before: nil, page_size: nil, remote_fields: nil, remote_id: nil, show_enum_origins: nil, request_options: nil)
+               include_deleted_data: nil, include_remote_data: nil, include_shell_data: nil, modified_after: nil, modified_before: nil, name: nil, page_size: nil, remote_fields: nil, remote_id: nil, show_enum_origins: nil, request_options: nil)
         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?
@@ -84,6 +85,7 @@ def list(account_type: nil, company_id: nil, created_after: nil, created_before:
             "include_shell_data": include_shell_data,
             "modified_after": modified_after,
             "modified_before": modified_before,
+            "name": name,
             "page_size": page_size,
             "remote_fields": remote_fields,
             "remote_id": remote_id,
@@ -152,6 +154,8 @@ def create(model:, is_debug_mode: nil, run_async: nil, request_options: nil)
       #  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_shell_data [Boolean] Whether to include shell records. Shell records are empty records (they may
+      #  contain some metadata but all other fields are null).
       # @param remote_fields [Merge::Accounting::Accounts::AccountsRetrieveRequestRemoteFields] Deprecated. Use show_enum_origins.
       # @param show_enum_origins [Merge::Accounting::Accounts::AccountsRetrieveRequestShowEnumOrigins] 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
@@ -165,8 +169,8 @@ def create(model:, is_debug_mode: nil, run_async: nil, request_options: nil)
       #    api_key: "YOUR_AUTH_TOKEN"
       #  )
       #  api.accounting.accounts.retrieve(id: "id")
-      def retrieve(id:, expand: nil, include_remote_data: nil, remote_fields: nil, show_enum_origins: nil,
-                   request_options: nil)
+      def retrieve(id:, expand: nil, include_remote_data: nil, include_shell_data: nil, remote_fields: nil,
+                   show_enum_origins: nil, request_options: nil)
         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?
@@ -180,6 +184,7 @@ def retrieve(id:, expand: nil, include_remote_data: nil, remote_fields: nil, sho
             **(request_options&.additional_query_parameters || {}),
             "expand": expand,
             "include_remote_data": include_remote_data,
+            "include_shell_data": include_shell_data,
             "remote_fields": remote_fields,
             "show_enum_origins": show_enum_origins
           }.compact
@@ -254,6 +259,7 @@ def initialize(request_client:)
       # @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 name [String] If provided, will only return Accounts with this name.
       # @param page_size [Integer] Number of results to return per page.
       # @param remote_fields [Merge::Accounting::Accounts::AccountsListRequestRemoteFields] Deprecated. Use show_enum_origins.
       # @param remote_id [String] The API provider's ID for the given object.
@@ -270,7 +276,7 @@ def initialize(request_client:)
       #  )
       #  api.accounting.accounts.list
       def list(account_type: nil, company_id: nil, created_after: nil, created_before: nil, cursor: nil, expand: nil,
-               include_deleted_data: nil, include_remote_data: nil, include_shell_data: nil, modified_after: nil, modified_before: nil, page_size: nil, remote_fields: nil, remote_id: nil, show_enum_origins: nil, request_options: nil)
+               include_deleted_data: nil, include_remote_data: nil, include_shell_data: nil, modified_after: nil, modified_before: nil, name: nil, page_size: nil, remote_fields: nil, remote_id: nil, show_enum_origins: nil, request_options: nil)
         Async do
           response = @request_client.conn.get do |req|
             req.options.timeout = request_options.timeout_in_seconds unless request_options&.timeout_in_seconds.nil?
@@ -294,6 +300,7 @@ def list(account_type: nil, company_id: nil, created_after: nil, created_before:
               "include_shell_data": include_shell_data,
               "modified_after": modified_after,
               "modified_before": modified_before,
+              "name": name,
               "page_size": page_size,
               "remote_fields": remote_fields,
               "remote_id": remote_id,
@@ -365,6 +372,8 @@ def create(model:, is_debug_mode: nil, run_async: nil, request_options: nil)
       #  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_shell_data [Boolean] Whether to include shell records. Shell records are empty records (they may
+      #  contain some metadata but all other fields are null).
       # @param remote_fields [Merge::Accounting::Accounts::AccountsRetrieveRequestRemoteFields] Deprecated. Use show_enum_origins.
       # @param show_enum_origins [Merge::Accounting::Accounts::AccountsRetrieveRequestShowEnumOrigins] 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
@@ -378,8 +387,8 @@ def create(model:, is_debug_mode: nil, run_async: nil, request_options: nil)
       #    api_key: "YOUR_AUTH_TOKEN"
       #  )
       #  api.accounting.accounts.retrieve(id: "id")
-      def retrieve(id:, expand: nil, include_remote_data: nil, remote_fields: nil, show_enum_origins: nil,
-                   request_options: nil)
+      def retrieve(id:, expand: nil, include_remote_data: nil, include_shell_data: nil, remote_fields: nil,
+                   show_enum_origins: nil, request_options: nil)
         Async do
           response = @request_client.conn.get do |req|
             req.options.timeout = request_options.timeout_in_seconds unless request_options&.timeout_in_seconds.nil?
@@ -394,6 +403,7 @@ def retrieve(id:, expand: nil, include_remote_data: nil, remote_fields: nil, sho
               **(request_options&.additional_query_parameters || {}),
               "expand": expand,
               "include_remote_data": include_remote_data,
+              "include_shell_data": include_shell_data,
               "remote_fields": remote_fields,
               "show_enum_origins": show_enum_origins
             }.compact

lib/merge_ruby_client/accounting/addresses/client.rb

@@ -21,6 +21,8 @@ def initialize(request_client:)
       # @param id [String]
       # @param include_remote_data [Boolean] Whether to include the original data Merge fetched from the third-party to
       #  produce these models.
+      # @param include_shell_data [Boolean] Whether to include shell records. Shell records are empty records (they may
+      #  contain some metadata but all other fields are null).
       # @param remote_fields [String] Deprecated. Use show_enum_origins.
       # @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
@@ -34,7 +36,8 @@ def initialize(request_client:)
       #    api_key: "YOUR_AUTH_TOKEN"
       #  )
       #  api.accounting.addresses.retrieve(id: "id")
-      def retrieve(id:, include_remote_data: nil, remote_fields: nil, show_enum_origins: nil, request_options: nil)
+      def retrieve(id:, include_remote_data: nil, include_shell_data: nil, remote_fields: nil, show_enum_origins: nil,
+                   request_options: nil)
         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?
@@ -47,6 +50,7 @@ def retrieve(id:, include_remote_data: nil, remote_fields: nil, show_enum_origin
           req.params = {
             **(request_options&.additional_query_parameters || {}),
             "include_remote_data": include_remote_data,
+            "include_shell_data": include_shell_data,
             "remote_fields": remote_fields,
             "show_enum_origins": show_enum_origins
           }.compact
@@ -74,6 +78,8 @@ def initialize(request_client:)
       # @param id [String]
       # @param include_remote_data [Boolean] Whether to include the original data Merge fetched from the third-party to
       #  produce these models.
+      # @param include_shell_data [Boolean] Whether to include shell records. Shell records are empty records (they may
+      #  contain some metadata but all other fields are null).
       # @param remote_fields [String] Deprecated. Use show_enum_origins.
       # @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
@@ -87,7 +93,8 @@ def initialize(request_client:)
       #    api_key: "YOUR_AUTH_TOKEN"
       #  )
       #  api.accounting.addresses.retrieve(id: "id")
-      def retrieve(id:, include_remote_data: nil, remote_fields: nil, show_enum_origins: nil, request_options: nil)
+      def retrieve(id:, include_remote_data: nil, include_shell_data: nil, remote_fields: nil, show_enum_origins: nil,
+                   request_options: nil)
         Async do
           response = @request_client.conn.get do |req|
             req.options.timeout = request_options.timeout_in_seconds unless request_options&.timeout_in_seconds.nil?
@@ -101,6 +108,7 @@ def retrieve(id:, include_remote_data: nil, remote_fields: nil, show_enum_origin
             req.params = {
               **(request_options&.additional_query_parameters || {}),
               "include_remote_data": include_remote_data,
+              "include_shell_data": include_shell_data,
               "remote_fields": remote_fields,
               "show_enum_origins": show_enum_origins
             }.compact