SDK regeneration

Author: fern-api[bot]

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/ticketing/client"
+require_relative "merge_ruby_client/crm/client"
+require_relative "merge_ruby_client/ats/client"
 require_relative "merge_ruby_client/hris/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::Ticketing::Client]
     attr_reader :ticketing
+    # @return [Merge::Crm::Client]
+    attr_reader :crm
+    # @return [Merge::Ats::Client]
+    attr_reader :ats
     # @return [Merge::Hris::Client]
     attr_reader :hris
     # @return [Merge::Accounting::Client]
@@ -42,24 +42,24 @@ def initialize(api_key:, environment: Environment::PRODUCTION, base_url: nil, ma
         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)
       @ticketing = Merge::Ticketing::Client.new(request_client: @request_client)
+      @crm = Merge::Crm::Client.new(request_client: @request_client)
+      @ats = Merge::Ats::Client.new(request_client: @request_client)
       @hris = Merge::Hris::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::Ticketing::AsyncClient]
     attr_reader :ticketing
+    # @return [Merge::Crm::AsyncClient]
+    attr_reader :crm
+    # @return [Merge::Ats::AsyncClient]
+    attr_reader :ats
     # @return [Merge::Hris::AsyncClient]
     attr_reader :hris
     # @return [Merge::Accounting::AsyncClient]
@@ -82,10 +82,10 @@ def initialize(api_key:, environment: Environment::PRODUCTION, base_url: nil, ma
         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)
       @ticketing = Merge::Ticketing::AsyncClient.new(request_client: @async_request_client)
+      @crm = Merge::Crm::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)
       @accounting = Merge::Accounting::AsyncClient.new(request_client: @async_request_client)
     end

lib/merge_ruby_client/accounting/field_mapping/client.rb

@@ -66,7 +66,7 @@ def field_mappings_retrieve(request_options: nil)
       #  api.accounting.field_mappings_create(
       #    target_field_name: "example_target_field_name",
       #    target_field_description: "this is a example description of the target field",
-      #    remote_field_traversal_path: ,
+      #    remote_field_traversal_path: ["example_remote_field"],
       #    remote_method: "GET",
       #    remote_url_path: "/example-url-path",
       #    common_model_name: "ExampleCommonModel"
@@ -274,7 +274,7 @@ def field_mappings_retrieve(request_options: nil)
       #  api.accounting.field_mappings_create(
       #    target_field_name: "example_target_field_name",
       #    target_field_description: "this is a example description of the target field",
-      #    remote_field_traversal_path: ,
+      #    remote_field_traversal_path: ["example_remote_field"],
       #    remote_method: "GET",
       #    remote_url_path: "/example-url-path",
       #    common_model_name: "ExampleCommonModel"

lib/merge_ruby_client/accounting/link_token/client.rb

@@ -59,7 +59,7 @@ def initialize(request_client:)
       #    end_user_email_address: "[email protected]",
       #    end_user_organization_name: "Test Organization",
       #    end_user_origin_id: "12345",
-      #    categories: [HRIS]
+      #    categories: [HRIS, ATS]
       #  )
       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, category_common_model_scopes: nil, language: nil, integration_specific_config: nil, request_options: nil)
@@ -139,7 +139,7 @@ def initialize(request_client:)
       #    end_user_email_address: "[email protected]",
       #    end_user_organization_name: "Test Organization",
       #    end_user_origin_id: "12345",
-      #    categories: [HRIS]
+      #    categories: [HRIS, ATS]
       #  )
       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, category_common_model_scopes: nil, language: nil, integration_specific_config: nil, request_options: nil)

lib/merge_ruby_client/accounting/scopes/client.rb

@@ -83,7 +83,7 @@ def linked_account_scopes_retrieve(request_options: nil)
       #    base_url: "https://api.example.com",
       #    api_key: "YOUR_AUTH_TOKEN"
       #  )
-      #  api.accounting.linked_account_scopes_create(common_models: [{ model_name: "model_name" }])
+      #  api.accounting.linked_account_scopes_create(common_models: [{ model_name: "Employee", model_permissions: { "READ": { is_enabled: true }, "WRITE": { is_enabled: false } } }, { model_name: "Benefit", model_permissions: { "WRITE": { is_enabled: false } } }])
       def linked_account_scopes_create(common_models:, 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?
@@ -177,7 +177,7 @@ def linked_account_scopes_retrieve(request_options: nil)
       #    base_url: "https://api.example.com",
       #    api_key: "YOUR_AUTH_TOKEN"
       #  )
-      #  api.accounting.linked_account_scopes_create(common_models: [{ model_name: "model_name" }])
+      #  api.accounting.linked_account_scopes_create(common_models: [{ model_name: "Employee", model_permissions: { "READ": { is_enabled: true }, "WRITE": { is_enabled: false } } }, { model_name: "Benefit", model_permissions: { "WRITE": { is_enabled: false } } }])
       def linked_account_scopes_create(common_models:, request_options: nil)
         Async do
           response = @request_client.conn.post do |req|

lib/merge_ruby_client/ats/field_mapping/client.rb

@@ -66,7 +66,7 @@ def field_mappings_retrieve(request_options: nil)
       #  api.ats.field_mappings_create(
       #    target_field_name: "example_target_field_name",
       #    target_field_description: "this is a example description of the target field",
-      #    remote_field_traversal_path: ,
+      #    remote_field_traversal_path: ["example_remote_field"],
       #    remote_method: "GET",
       #    remote_url_path: "/example-url-path",
       #    common_model_name: "ExampleCommonModel"
@@ -274,7 +274,7 @@ def field_mappings_retrieve(request_options: nil)
       #  api.ats.field_mappings_create(
       #    target_field_name: "example_target_field_name",
       #    target_field_description: "this is a example description of the target field",
-      #    remote_field_traversal_path: ,
+      #    remote_field_traversal_path: ["example_remote_field"],
       #    remote_method: "GET",
       #    remote_url_path: "/example-url-path",
       #    common_model_name: "ExampleCommonModel"

lib/merge_ruby_client/ats/link_token/client.rb

@@ -59,7 +59,7 @@ def initialize(request_client:)
       #    end_user_email_address: "[email protected]",
       #    end_user_organization_name: "Test Organization",
       #    end_user_origin_id: "12345",
-      #    categories: [HRIS]
+      #    categories: [HRIS, ATS]
       #  )
       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, category_common_model_scopes: nil, language: nil, integration_specific_config: nil, request_options: nil)
@@ -139,7 +139,7 @@ def initialize(request_client:)
       #    end_user_email_address: "[email protected]",
       #    end_user_organization_name: "Test Organization",
       #    end_user_origin_id: "12345",
-      #    categories: [HRIS]
+      #    categories: [HRIS, ATS]
       #  )
       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, category_common_model_scopes: nil, language: nil, integration_specific_config: nil, request_options: nil)

lib/merge_ruby_client/ats/scopes/client.rb

@@ -83,7 +83,7 @@ def linked_account_scopes_retrieve(request_options: nil)
       #    base_url: "https://api.example.com",
       #    api_key: "YOUR_AUTH_TOKEN"
       #  )
-      #  api.ats.linked_account_scopes_create(common_models: [{ model_name: "model_name" }])
+      #  api.ats.linked_account_scopes_create(common_models: [{ model_name: "Employee", model_permissions: { "READ": { is_enabled: true }, "WRITE": { is_enabled: false } } }, { model_name: "Benefit", model_permissions: { "WRITE": { is_enabled: false } } }])
       def linked_account_scopes_create(common_models:, 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?
@@ -177,7 +177,7 @@ def linked_account_scopes_retrieve(request_options: nil)
       #    base_url: "https://api.example.com",
       #    api_key: "YOUR_AUTH_TOKEN"
       #  )
-      #  api.ats.linked_account_scopes_create(common_models: [{ model_name: "model_name" }])
+      #  api.ats.linked_account_scopes_create(common_models: [{ model_name: "Employee", model_permissions: { "READ": { is_enabled: true }, "WRITE": { is_enabled: false } } }, { model_name: "Benefit", model_permissions: { "WRITE": { is_enabled: false } } }])
       def linked_account_scopes_create(common_models:, request_options: nil)
         Async do
           response = @request_client.conn.post do |req|

lib/merge_ruby_client/crm/custom_objects/client.rb

@@ -86,7 +86,7 @@ def custom_object_classes_custom_objects_list(custom_object_class_id:, created_a
       #    base_url: "https://api.example.com",
       #    api_key: "YOUR_AUTH_TOKEN"
       #  )
-      #  api.crm.custom_object_classes_custom_objects_create(custom_object_class_id: "custom_object_class_id", model: { fields: {  } })
+      #  api.crm.custom_object_classes_custom_objects_create(custom_object_class_id: "custom_object_class_id", model: { fields: { "test_field": "hello" } })
       def custom_object_classes_custom_objects_create(custom_object_class_id:, model:, is_debug_mode: nil,
                                                       run_async: nil, request_options: nil)
         response = @request_client.conn.post do |req|
@@ -240,7 +240,7 @@ def custom_object_classes_custom_objects_list(custom_object_class_id:, created_a
       #    base_url: "https://api.example.com",
       #    api_key: "YOUR_AUTH_TOKEN"
       #  )
-      #  api.crm.custom_object_classes_custom_objects_create(custom_object_class_id: "custom_object_class_id", model: { fields: {  } })
+      #  api.crm.custom_object_classes_custom_objects_create(custom_object_class_id: "custom_object_class_id", model: { fields: { "test_field": "hello" } })
       def custom_object_classes_custom_objects_create(custom_object_class_id:, model:, is_debug_mode: nil,
                                                       run_async: nil, request_options: nil)
         Async do

lib/merge_ruby_client/crm/field_mapping/client.rb

@@ -66,7 +66,7 @@ def field_mappings_retrieve(request_options: nil)
       #  api.crm.field_mappings_create(
       #    target_field_name: "example_target_field_name",
       #    target_field_description: "this is a example description of the target field",
-      #    remote_field_traversal_path: ,
+      #    remote_field_traversal_path: ["example_remote_field"],
       #    remote_method: "GET",
       #    remote_url_path: "/example-url-path",
       #    common_model_name: "ExampleCommonModel"
@@ -274,7 +274,7 @@ def field_mappings_retrieve(request_options: nil)
       #  api.crm.field_mappings_create(
       #    target_field_name: "example_target_field_name",
       #    target_field_description: "this is a example description of the target field",
-      #    remote_field_traversal_path: ,
+      #    remote_field_traversal_path: ["example_remote_field"],
       #    remote_method: "GET",
       #    remote_url_path: "/example-url-path",
       #    common_model_name: "ExampleCommonModel"

lib/merge_ruby_client/crm/link_token/client.rb

@@ -59,7 +59,7 @@ def initialize(request_client:)
       #    end_user_email_address: "[email protected]",
       #    end_user_organization_name: "Test Organization",
       #    end_user_origin_id: "12345",
-      #    categories: [HRIS]
+      #    categories: [HRIS, ATS]
       #  )
       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, category_common_model_scopes: nil, language: nil, integration_specific_config: nil, request_options: nil)
@@ -139,7 +139,7 @@ def initialize(request_client:)
       #    end_user_email_address: "[email protected]",
       #    end_user_organization_name: "Test Organization",
       #    end_user_origin_id: "12345",
-      #    categories: [HRIS]
+      #    categories: [HRIS, ATS]
       #  )
       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, category_common_model_scopes: nil, language: nil, integration_specific_config: nil, request_options: nil)