merge_ruby_client 0.1.4 → 1.0.0

data/lib/merge_ruby_client/ticketing/audit_trail/client.rb

@@ -38,7 +38,10 @@ module Merge
       #  `CHANGED_INTEGRATION_WIDE_FIELD_MAPPING`,
       #  `CHANGED_LINKED_ACCOUNT_FIELD_MAPPING`,
       #  `DELETED_INTEGRATION_WIDE_FIELD_MAPPING`,
-      #  `DELETED_LINKED_ACCOUNT_FIELD_MAPPING`, `FORCED_LINKED_ACCOUNT_RESYNC`,
+      #  `DELETED_LINKED_ACCOUNT_FIELD_MAPPING`,
+      #  `CREATED_LINKED_ACCOUNT_COMMON_MODEL_OVERRIDE`,
+      #  `CHANGED_LINKED_ACCOUNT_COMMON_MODEL_OVERRIDE`,
+      #  `DELETED_LINKED_ACCOUNT_COMMON_MODEL_OVERRIDE`, `FORCED_LINKED_ACCOUNT_RESYNC`,
       #  `MUTED_ISSUE`, `GENERATED_MAGIC_LINK`, `ENABLED_MERGE_WEBHOOK`,
       #  `DISABLED_MERGE_WEBHOOK`, `MERGE_WEBHOOK_TARGET_CHANGED`,
       #  `END_USER_CREDENTIALS_ACCESSED`
@@ -117,7 +120,10 @@ module Merge
       #  `CHANGED_INTEGRATION_WIDE_FIELD_MAPPING`,
       #  `CHANGED_LINKED_ACCOUNT_FIELD_MAPPING`,
       #  `DELETED_INTEGRATION_WIDE_FIELD_MAPPING`,
-      #  `DELETED_LINKED_ACCOUNT_FIELD_MAPPING`, `FORCED_LINKED_ACCOUNT_RESYNC`,
+      #  `DELETED_LINKED_ACCOUNT_FIELD_MAPPING`,
+      #  `CREATED_LINKED_ACCOUNT_COMMON_MODEL_OVERRIDE`,
+      #  `CHANGED_LINKED_ACCOUNT_COMMON_MODEL_OVERRIDE`,
+      #  `DELETED_LINKED_ACCOUNT_COMMON_MODEL_OVERRIDE`, `FORCED_LINKED_ACCOUNT_RESYNC`,
       #  `MUTED_ISSUE`, `GENERATED_MAGIC_LINK`, `ENABLED_MERGE_WEBHOOK`,
       #  `DISABLED_MERGE_WEBHOOK`, `MERGE_WEBHOOK_TARGET_CHANGED`,
       #  `END_USER_CREDENTIALS_ACCESSED`

data/lib/merge_ruby_client/ticketing/collections/client.rb

@@ -2,10 +2,10 @@
 
 require_relative "../../../requests"
 require "date"
+require_relative "types/collections_list_request_expand"
 require_relative "../types/paginated_collection_list"
+require_relative "types/collections_retrieve_request_expand"
 require_relative "../types/collection"
-require_relative "types/collections_users_list_request_expand"
-require_relative "../types/paginated_user_list"
 require "async"
 
 module Merge
@@ -26,11 +26,16 @@ 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
+      # @param expand [Merge::Ticketing::Collections::CollectionsListRequestExpand] 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_deleted_data [Boolean] Indicates whether or not this object has been deleted in the third party
+      #  platform. Full coverage deletion detection is a premium add-on. Native deletion
+      #  detection is offered for free with limited coverage. [Learn
+      #  more](https://docs.merge.dev/integrations/hris/supported-features/).
       # @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 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.
@@ -52,7 +57,7 @@ module Merge
       #  )
       #  api.ticketing.collections.list
       def list(collection_type: 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, parent_collection_id: 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, page_size: nil, parent_collection_id: 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?
@@ -71,6 +76,7 @@ module Merge
             "expand": expand,
             "include_deleted_data": include_deleted_data,
             "include_remote_data": include_remote_data,
+            "include_shell_data": include_shell_data,
             "modified_after": modified_after,
             "modified_before": modified_before,
             "page_size": page_size,
@@ -90,7 +96,7 @@ module Merge
       # Returns a `Collection` object with the given `id`.
       #
       # @param id [String]
-      # @param expand [String] Which relations should be returned in expanded form. Multiple relation names
+      # @param expand [Merge::Ticketing::Collections::CollectionsRetrieveRequestExpand] 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.
@@ -132,52 +138,6 @@ module Merge
         end
         Merge::Ticketing::Collection.from_json(json_object: response.body)
       end
-
-      # Returns a list of `User` objects.
-      #
-      # @param parent_id [String]
-      # @param cursor [String] The pagination cursor value.
-      # @param expand [Merge::Ticketing::Collections::CollectionsUsersListRequestExpand] 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 page_size [Integer] Number of results to return per page.
-      # @param request_options [Merge::RequestOptions]
-      # @return [Merge::Ticketing::PaginatedUserList]
-      # @example
-      #  api = Merge::Client.new(
-      #    base_url: "https://api.example.com",
-      #    environment: Merge::Environment::PRODUCTION,
-      #    api_key: "YOUR_AUTH_TOKEN"
-      #  )
-      #  api.ticketing.collections.users_list(parent_id: "parent_id")
-      def users_list(parent_id:, cursor: nil, expand: nil, include_deleted_data: nil, include_remote_data: nil,
-                     page_size: 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?
-          req.headers["X-Account-Token"] = request_options.account_token unless request_options&.account_token.nil?
-          req.headers = {
-        **(req.headers || {}),
-        **@request_client.get_headers,
-        **(request_options&.additional_headers || {})
-          }.compact
-          req.params = {
-            **(request_options&.additional_query_parameters || {}),
-            "cursor": cursor,
-            "expand": expand,
-            "include_deleted_data": include_deleted_data,
-            "include_remote_data": include_remote_data,
-            "page_size": page_size
-          }.compact
-          unless request_options.nil? || request_options&.additional_body_parameters.nil?
-            req.body = { **(request_options&.additional_body_parameters || {}) }.compact
-          end
-          req.url "#{@request_client.get_url(request_options: request_options)}/ticketing/v1/collections/#{parent_id}/users"
-        end
-        Merge::Ticketing::PaginatedUserList.from_json(json_object: response.body)
-      end
     end
 
     class AsyncCollectionsClient
@@ -196,11 +156,16 @@ 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
+      # @param expand [Merge::Ticketing::Collections::CollectionsListRequestExpand] 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_deleted_data [Boolean] Indicates whether or not this object has been deleted in the third party
+      #  platform. Full coverage deletion detection is a premium add-on. Native deletion
+      #  detection is offered for free with limited coverage. [Learn
+      #  more](https://docs.merge.dev/integrations/hris/supported-features/).
       # @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 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.
@@ -222,7 +187,7 @@ module Merge
       #  )
       #  api.ticketing.collections.list
       def list(collection_type: 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, parent_collection_id: 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, page_size: nil, parent_collection_id: 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?
@@ -242,6 +207,7 @@ module Merge
               "expand": expand,
               "include_deleted_data": include_deleted_data,
               "include_remote_data": include_remote_data,
+              "include_shell_data": include_shell_data,
               "modified_after": modified_after,
               "modified_before": modified_before,
               "page_size": page_size,
@@ -262,7 +228,7 @@ module Merge
       # Returns a `Collection` object with the given `id`.
       #
       # @param id [String]
-      # @param expand [String] Which relations should be returned in expanded form. Multiple relation names
+      # @param expand [Merge::Ticketing::Collections::CollectionsRetrieveRequestExpand] 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.
@@ -306,54 +272,6 @@ module Merge
           Merge::Ticketing::Collection.from_json(json_object: response.body)
         end
       end
-
-      # Returns a list of `User` objects.
-      #
-      # @param parent_id [String]
-      # @param cursor [String] The pagination cursor value.
-      # @param expand [Merge::Ticketing::Collections::CollectionsUsersListRequestExpand] 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 page_size [Integer] Number of results to return per page.
-      # @param request_options [Merge::RequestOptions]
-      # @return [Merge::Ticketing::PaginatedUserList]
-      # @example
-      #  api = Merge::Client.new(
-      #    base_url: "https://api.example.com",
-      #    environment: Merge::Environment::PRODUCTION,
-      #    api_key: "YOUR_AUTH_TOKEN"
-      #  )
-      #  api.ticketing.collections.users_list(parent_id: "parent_id")
-      def users_list(parent_id:, cursor: nil, expand: nil, include_deleted_data: nil, include_remote_data: nil,
-                     page_size: 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?
-            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_client.get_headers,
-          **(request_options&.additional_headers || {})
-            }.compact
-            req.params = {
-              **(request_options&.additional_query_parameters || {}),
-              "cursor": cursor,
-              "expand": expand,
-              "include_deleted_data": include_deleted_data,
-              "include_remote_data": include_remote_data,
-              "page_size": page_size
-            }.compact
-            unless request_options.nil? || request_options&.additional_body_parameters.nil?
-              req.body = { **(request_options&.additional_body_parameters || {}) }.compact
-            end
-            req.url "#{@request_client.get_url(request_options: request_options)}/ticketing/v1/collections/#{parent_id}/users"
-          end
-          Merge::Ticketing::PaginatedUserList.from_json(json_object: response.body)
-        end
-      end
     end
   end
 end

data/lib/merge_ruby_client/ticketing/collections/types/collections_list_request_expand.rb

@@ -0,0 +1,13 @@
+# frozen_string_literal: true
+
+module Merge
+  module Ticketing
+    class Collections
+      class CollectionsListRequestExpand
+        PARENT_COLLECTION = "parent_collection"
+        TEAMS = "teams"
+        TEAMS_PARENT_COLLECTION = "teams,parent_collection"
+      end
+    end
+  end
+end

data/lib/merge_ruby_client/ticketing/collections/types/collections_retrieve_request_expand.rb

@@ -0,0 +1,13 @@
+# frozen_string_literal: true
+
+module Merge
+  module Ticketing
+    class Collections
+      class CollectionsRetrieveRequestExpand
+        PARENT_COLLECTION = "parent_collection"
+        TEAMS = "teams"
+        TEAMS_PARENT_COLLECTION = "teams,parent_collection"
+      end
+    end
+  end
+end

data/lib/merge_ruby_client/ticketing/comments/client.rb

@@ -30,9 +30,14 @@ module Merge
       # @param cursor [String] The pagination cursor value.
       # @param expand [Merge::Ticketing::Comments::CommentsListRequestExpand] 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_deleted_data [Boolean] Indicates whether or not this object has been deleted in the third party
+      #  platform. Full coverage deletion detection is a premium add-on. Native deletion
+      #  detection is offered for free with limited coverage. [Learn
+      #  more](https://docs.merge.dev/integrations/hris/supported-features/).
       # @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 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.
@@ -51,7 +56,7 @@ module Merge
       #  )
       #  api.ticketing.comments.list
       def list(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_created_after: nil, remote_id: nil, ticket_id: nil, request_options: nil)
+               include_remote_data: nil, include_shell_data: nil, modified_after: nil, modified_before: nil, page_size: nil, remote_created_after: nil, remote_id: nil, ticket_id: 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?
@@ -69,6 +74,7 @@ module Merge
             "expand": expand,
             "include_deleted_data": include_deleted_data,
             "include_remote_data": include_remote_data,
+            "include_shell_data": include_shell_data,
             "modified_after": modified_after,
             "modified_before": modified_before,
             "page_size": page_size,
@@ -216,9 +222,14 @@ module Merge
       # @param cursor [String] The pagination cursor value.
       # @param expand [Merge::Ticketing::Comments::CommentsListRequestExpand] 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_deleted_data [Boolean] Indicates whether or not this object has been deleted in the third party
+      #  platform. Full coverage deletion detection is a premium add-on. Native deletion
+      #  detection is offered for free with limited coverage. [Learn
+      #  more](https://docs.merge.dev/integrations/hris/supported-features/).
       # @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 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.
@@ -237,7 +248,7 @@ module Merge
       #  )
       #  api.ticketing.comments.list
       def list(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_created_after: nil, remote_id: nil, ticket_id: nil, request_options: nil)
+               include_remote_data: nil, include_shell_data: nil, modified_after: nil, modified_before: nil, page_size: nil, remote_created_after: nil, remote_id: nil, ticket_id: 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?
@@ -256,6 +267,7 @@ module Merge
               "expand": expand,
               "include_deleted_data": include_deleted_data,
               "include_remote_data": include_remote_data,
+              "include_shell_data": include_shell_data,
               "modified_after": modified_after,
               "modified_before": modified_before,
               "page_size": page_size,

data/lib/merge_ruby_client/ticketing/contacts/client.rb

@@ -28,9 +28,14 @@ module Merge
       # @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 include_deleted_data [Boolean] Whether to include data that was marked as deleted by third party webhooks.
+      # @param include_deleted_data [Boolean] Indicates whether or not this object has been deleted in the third party
+      #  platform. Full coverage deletion detection is a premium add-on. Native deletion
+      #  detection is offered for free with limited coverage. [Learn
+      #  more](https://docs.merge.dev/integrations/hris/supported-features/).
       # @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 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.
@@ -46,7 +51,7 @@ module Merge
       #  )
       #  api.ticketing.contacts.list
       def list(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_id: nil, request_options: nil)
+               include_remote_data: nil, include_shell_data: nil, modified_after: nil, modified_before: nil, page_size: nil, remote_id: 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?
@@ -64,6 +69,7 @@ module Merge
             "expand": expand,
             "include_deleted_data": include_deleted_data,
             "include_remote_data": include_remote_data,
+            "include_shell_data": include_shell_data,
             "modified_after": modified_after,
             "modified_before": modified_before,
             "page_size": page_size,
@@ -208,9 +214,14 @@ module Merge
       # @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 include_deleted_data [Boolean] Whether to include data that was marked as deleted by third party webhooks.
+      # @param include_deleted_data [Boolean] Indicates whether or not this object has been deleted in the third party
+      #  platform. Full coverage deletion detection is a premium add-on. Native deletion
+      #  detection is offered for free with limited coverage. [Learn
+      #  more](https://docs.merge.dev/integrations/hris/supported-features/).
       # @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 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.
@@ -226,7 +237,7 @@ module Merge
       #  )
       #  api.ticketing.contacts.list
       def list(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_id: nil, request_options: nil)
+               include_remote_data: nil, include_shell_data: nil, modified_after: nil, modified_before: nil, page_size: nil, remote_id: 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?
@@ -245,6 +256,7 @@ module Merge
               "expand": expand,
               "include_deleted_data": include_deleted_data,
               "include_remote_data": include_remote_data,
+              "include_shell_data": include_shell_data,
               "modified_after": modified_after,
               "modified_before": modified_before,
               "page_size": page_size,

data/lib/merge_ruby_client/ticketing/field_mapping/client.rb

@@ -23,6 +23,10 @@ module Merge
       #  between third-party Remote Fields and user defined Merge fields. [Learn
       #  more](https://docs.merge.dev/supplemental-data/field-mappings/overview/).
       #
+      # @param exclude_remote_field_metadata [Boolean] If `true`, remote fields metadata is excluded from each field mapping instance
+      #  (i.e. `remote_fields.remote_key_name` and `remote_fields.schema` will be null).
+      #  This will increase the speed of the request since these fields require some
+      #  calculations.
       # @param request_options [Merge::RequestOptions]
       # @return [Merge::Ticketing::FieldMappingApiInstanceResponse]
       # @example
@@ -32,7 +36,7 @@ module Merge
       #    api_key: "YOUR_AUTH_TOKEN"
       #  )
       #  api.ticketing.field_mapping.field_mappings_retrieve
-      def field_mappings_retrieve(request_options: nil)
+      def field_mappings_retrieve(exclude_remote_field_metadata: 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?
@@ -42,9 +46,10 @@ module Merge
         **@request_client.get_headers,
         **(request_options&.additional_headers || {})
           }.compact
-          unless request_options.nil? || request_options&.additional_query_parameters.nil?
-            req.params = { **(request_options&.additional_query_parameters || {}) }.compact
-          end
+          req.params = {
+            **(request_options&.additional_query_parameters || {}),
+            "exclude_remote_field_metadata": exclude_remote_field_metadata
+          }.compact
           unless request_options.nil? || request_options&.additional_body_parameters.nil?
             req.body = { **(request_options&.additional_body_parameters || {}) }.compact
           end
@@ -57,6 +62,10 @@ module Merge
       #  This will cause the next sync for this Linked Account to sync **ALL** data from
       #  start.
       #
+      # @param exclude_remote_field_metadata [Boolean] If `true`, remote fields metadata is excluded from each field mapping instance
+      #  (i.e. `remote_fields.remote_key_name` and `remote_fields.schema` will be null).
+      #  This will increase the speed of the request since these fields require some
+      #  calculations.
       # @param target_field_name [String] The name of the target field you want this remote field to map to.
       # @param target_field_description [String] The description of the target field you want this remote field to map to.
       # @param remote_field_traversal_path [Array<Object>] The field traversal path of the remote field listed when you hit the GET
@@ -82,7 +91,7 @@ module Merge
       #    common_model_name: "ExampleCommonModel"
       #  )
       def field_mappings_create(target_field_name:, target_field_description:, remote_field_traversal_path:,
-                                remote_method:, remote_url_path:, common_model_name:, request_options: nil)
+                                remote_method:, remote_url_path:, common_model_name:, exclude_remote_field_metadata: 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?
@@ -92,9 +101,10 @@ module Merge
         **@request_client.get_headers,
         **(request_options&.additional_headers || {})
           }.compact
-          unless request_options.nil? || request_options&.additional_query_parameters.nil?
-            req.params = { **(request_options&.additional_query_parameters || {}) }.compact
-          end
+          req.params = {
+            **(request_options&.additional_query_parameters || {}),
+            "exclude_remote_field_metadata": exclude_remote_field_metadata
+          }.compact
           req.body = {
             **(request_options&.additional_body_parameters || {}),
             target_field_name: target_field_name,
@@ -280,6 +290,10 @@ module Merge
       #  between third-party Remote Fields and user defined Merge fields. [Learn
       #  more](https://docs.merge.dev/supplemental-data/field-mappings/overview/).
       #
+      # @param exclude_remote_field_metadata [Boolean] If `true`, remote fields metadata is excluded from each field mapping instance
+      #  (i.e. `remote_fields.remote_key_name` and `remote_fields.schema` will be null).
+      #  This will increase the speed of the request since these fields require some
+      #  calculations.
       # @param request_options [Merge::RequestOptions]
       # @return [Merge::Ticketing::FieldMappingApiInstanceResponse]
       # @example
@@ -289,7 +303,7 @@ module Merge
       #    api_key: "YOUR_AUTH_TOKEN"
       #  )
       #  api.ticketing.field_mapping.field_mappings_retrieve
-      def field_mappings_retrieve(request_options: nil)
+      def field_mappings_retrieve(exclude_remote_field_metadata: 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?
@@ -300,9 +314,10 @@ module Merge
           **@request_client.get_headers,
           **(request_options&.additional_headers || {})
             }.compact
-            unless request_options.nil? || request_options&.additional_query_parameters.nil?
-              req.params = { **(request_options&.additional_query_parameters || {}) }.compact
-            end
+            req.params = {
+              **(request_options&.additional_query_parameters || {}),
+              "exclude_remote_field_metadata": exclude_remote_field_metadata
+            }.compact
             unless request_options.nil? || request_options&.additional_body_parameters.nil?
               req.body = { **(request_options&.additional_body_parameters || {}) }.compact
             end
@@ -316,6 +331,10 @@ module Merge
       #  This will cause the next sync for this Linked Account to sync **ALL** data from
       #  start.
       #
+      # @param exclude_remote_field_metadata [Boolean] If `true`, remote fields metadata is excluded from each field mapping instance
+      #  (i.e. `remote_fields.remote_key_name` and `remote_fields.schema` will be null).
+      #  This will increase the speed of the request since these fields require some
+      #  calculations.
       # @param target_field_name [String] The name of the target field you want this remote field to map to.
       # @param target_field_description [String] The description of the target field you want this remote field to map to.
       # @param remote_field_traversal_path [Array<Object>] The field traversal path of the remote field listed when you hit the GET
@@ -341,7 +360,7 @@ module Merge
       #    common_model_name: "ExampleCommonModel"
       #  )
       def field_mappings_create(target_field_name:, target_field_description:, remote_field_traversal_path:,
-                                remote_method:, remote_url_path:, common_model_name:, request_options: nil)
+                                remote_method:, remote_url_path:, common_model_name:, exclude_remote_field_metadata: nil, request_options: nil)
         Async do
           response = @request_client.conn.post do |req|
             req.options.timeout = request_options.timeout_in_seconds unless request_options&.timeout_in_seconds.nil?
@@ -352,9 +371,10 @@ module Merge
           **@request_client.get_headers,
           **(request_options&.additional_headers || {})
             }.compact
-            unless request_options.nil? || request_options&.additional_query_parameters.nil?
-              req.params = { **(request_options&.additional_query_parameters || {}) }.compact
-            end
+            req.params = {
+              **(request_options&.additional_query_parameters || {}),
+              "exclude_remote_field_metadata": exclude_remote_field_metadata
+            }.compact
             req.body = {
               **(request_options&.additional_body_parameters || {}),
               target_field_name: target_field_name,

data/lib/merge_ruby_client/ticketing/force_resync/client.rb

@@ -19,7 +19,7 @@ module Merge
 
       # Force re-sync of all models. This is available for all organizations via the
       #  dashboard. Force re-sync is also available programmatically via API for monthly,
-      #  quarterly, and highest sync frequency customers on the Launch, Professional, or
+      #  quarterly, and highest sync frequency customers on the Professional or
       #  Enterprise plans. Doing so will consume a sync credit for the relevant linked
       #  account.
       #
@@ -70,7 +70,7 @@ module Merge
 
       # Force re-sync of all models. This is available for all organizations via the
       #  dashboard. Force re-sync is also available programmatically via API for monthly,
-      #  quarterly, and highest sync frequency customers on the Launch, Professional, or
+      #  quarterly, and highest sync frequency customers on the Professional or
       #  Enterprise plans. Doing so will consume a sync credit for the relevant linked
       #  account.
       #

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

@@ -3,6 +3,7 @@
 require_relative "../../../requests"
 require_relative "../types/categories_enum"
 require_relative "../types/common_model_scopes_body_request"
+require_relative "../types/language_enum"
 require_relative "../types/link_token"
 require "async"
 
@@ -48,7 +49,12 @@ module Merge
       # @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 language [Merge::Ticketing::LanguageEnum] The following subset of IETF language tags can be used to configure
+      #  localization.
+      #  * `en` - en
+      #  * `de` - de
+      # @param are_syncs_disabled [Boolean] The boolean that indicates whether initial, periodic, and force syncs will be
+      #  disabled.
       # @param integration_specific_config [Hash{String => Object}] A JSON object containing integration-specific configuration options.
       # @param request_options [Merge::RequestOptions]
       # @return [Merge::Ticketing::LinkToken]
@@ -65,7 +71,7 @@ module Merge
       #    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, hide_admin_magic_link: nil, common_models: nil, category_common_model_scopes: nil, language: nil, integration_specific_config: nil, request_options: nil)
+                 integration: nil, link_expiry_mins: nil, should_create_magic_link_url: nil, hide_admin_magic_link: nil, common_models: nil, category_common_model_scopes: nil, language: nil, are_syncs_disabled: 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?
@@ -91,6 +97,7 @@ module Merge
             common_models: common_models,
             category_common_model_scopes: category_common_model_scopes,
             language: language,
+            are_syncs_disabled: are_syncs_disabled,
             integration_specific_config: integration_specific_config
           }.compact
           req.url "#{@request_client.get_url(request_options: request_options)}/ticketing/v1/link-token"
@@ -139,7 +146,12 @@ module Merge
       # @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 language [Merge::Ticketing::LanguageEnum] The following subset of IETF language tags can be used to configure
+      #  localization.
+      #  * `en` - en
+      #  * `de` - de
+      # @param are_syncs_disabled [Boolean] The boolean that indicates whether initial, periodic, and force syncs will be
+      #  disabled.
       # @param integration_specific_config [Hash{String => Object}] A JSON object containing integration-specific configuration options.
       # @param request_options [Merge::RequestOptions]
       # @return [Merge::Ticketing::LinkToken]
@@ -156,7 +168,7 @@ module Merge
       #    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, hide_admin_magic_link: nil, common_models: nil, category_common_model_scopes: nil, language: nil, integration_specific_config: nil, request_options: nil)
+                 integration: nil, link_expiry_mins: nil, should_create_magic_link_url: nil, hide_admin_magic_link: nil, common_models: nil, category_common_model_scopes: nil, language: nil, are_syncs_disabled: nil, integration_specific_config: nil, request_options: nil)
         Async do
           response = @request_client.conn.post do |req|
             req.options.timeout = request_options.timeout_in_seconds unless request_options&.timeout_in_seconds.nil?
@@ -183,6 +195,7 @@ module Merge
               common_models: common_models,
               category_common_model_scopes: category_common_model_scopes,
               language: language,
+              are_syncs_disabled: are_syncs_disabled,
               integration_specific_config: integration_specific_config
             }.compact
             req.url "#{@request_client.get_url(request_options: request_options)}/ticketing/v1/link-token"

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

@@ -47,7 +47,7 @@ module Merge
       # @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 status [String] Filter by status. Options: `COMPLETE`, `IDLE`, `INCOMPLETE`, `RELINK_NEEDED`
       # @param request_options [Merge::RequestOptions]
       # @return [Merge::Ticketing::PaginatedAccountDetailsAndActionsList]
       # @example
@@ -133,7 +133,7 @@ module Merge
       # @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 status [String] Filter by status. Options: `COMPLETE`, `IDLE`, `INCOMPLETE`, `RELINK_NEEDED`
       # @param request_options [Merge::RequestOptions]
       # @return [Merge::Ticketing::PaginatedAccountDetailsAndActionsList]
       # @example