merge_ruby_client 1.0.0 → 1.1.0

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

@@ -137,6 +137,8 @@ module Merge
       #  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 request_options [Merge::RequestOptions]
       # @return [Merge::Ticketing::Attachment]
       # @example
@@ -146,7 +148,7 @@ module Merge
       #    api_key: "YOUR_AUTH_TOKEN"
       #  )
       #  api.ticketing.attachments.retrieve(id: "id")
-      def retrieve(id:, expand: nil, include_remote_data: nil, request_options: nil)
+      def retrieve(id:, expand: nil, 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?
@@ -159,7 +161,8 @@ module Merge
           req.params = {
             **(request_options&.additional_query_parameters || {}),
             "expand": expand,
-            "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
@@ -172,6 +175,8 @@ module Merge
       # Returns the `File` content with the given `id` as a stream of bytes.
       #
       # @param id [String]
+      # @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 mime_type [String] If provided, specifies the export format of the file to be downloaded. For
       #  information on supported export formats, please refer to our <a
       #  tps://help.merge.dev/en/articles/8615316-file-export-and-download-specification'
@@ -182,14 +187,7 @@ module Merge
       #  response environment. The latter will allow access to the response status,
       #  headers and reason, as well as the request info.
       # @return [Void]
-      # @example
-      #  api = Merge::Client.new(
-      #    base_url: "https://api.example.com",
-      #    environment: Merge::Environment::PRODUCTION,
-      #    api_key: "YOUR_AUTH_TOKEN"
-      #  )
-      #  api.ticketing.attachments.download_retrieve(id: "string", mime_type: "string")
-      def download_retrieve(id:, mime_type: nil, request_options: nil, &on_data)
+      def download_retrieve(id:, include_shell_data: nil, mime_type: nil, request_options: nil, &on_data)
         @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?
@@ -200,7 +198,11 @@ module Merge
         **(request_options&.additional_headers || {})
           }.compact
           req.options.on_data = on_data
-          req.params = { **(request_options&.additional_query_parameters || {}), "mime_type": mime_type }.compact
+          req.params = {
+            **(request_options&.additional_query_parameters || {}),
+            "include_shell_data": include_shell_data,
+            "mime_type": mime_type
+          }.compact
           unless request_options.nil? || request_options&.additional_body_parameters.nil?
             req.body = { **(request_options&.additional_body_parameters || {}) }.compact
           end
@@ -371,6 +373,8 @@ module Merge
       #  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 request_options [Merge::RequestOptions]
       # @return [Merge::Ticketing::Attachment]
       # @example
@@ -380,7 +384,7 @@ module Merge
       #    api_key: "YOUR_AUTH_TOKEN"
       #  )
       #  api.ticketing.attachments.retrieve(id: "id")
-      def retrieve(id:, expand: nil, include_remote_data: nil, request_options: nil)
+      def retrieve(id:, expand: nil, 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?
@@ -394,7 +398,8 @@ module Merge
             req.params = {
               **(request_options&.additional_query_parameters || {}),
               "expand": expand,
-              "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
@@ -408,6 +413,8 @@ module Merge
       # Returns the `File` content with the given `id` as a stream of bytes.
       #
       # @param id [String]
+      # @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 mime_type [String] If provided, specifies the export format of the file to be downloaded. For
       #  information on supported export formats, please refer to our <a
       #  tps://help.merge.dev/en/articles/8615316-file-export-and-download-specification'
@@ -418,14 +425,7 @@ module Merge
       #  response environment. The latter will allow access to the response status,
       #  headers and reason, as well as the request info.
       # @return [Void]
-      # @example
-      #  api = Merge::Client.new(
-      #    base_url: "https://api.example.com",
-      #    environment: Merge::Environment::PRODUCTION,
-      #    api_key: "YOUR_AUTH_TOKEN"
-      #  )
-      #  api.ticketing.attachments.download_retrieve(id: "string", mime_type: "string")
-      def download_retrieve(id:, mime_type: nil, request_options: nil, &on_data)
+      def download_retrieve(id:, include_shell_data: nil, mime_type: nil, request_options: nil, &on_data)
         Async do
           @request_client.conn.get do |req|
             req.options.timeout = request_options.timeout_in_seconds unless request_options&.timeout_in_seconds.nil?
@@ -437,7 +437,11 @@ module Merge
           **(request_options&.additional_headers || {})
             }.compact
             req.options.on_data = on_data
-            req.params = { **(request_options&.additional_query_parameters || {}), "mime_type": mime_type }.compact
+            req.params = {
+              **(request_options&.additional_query_parameters || {}),
+              "include_shell_data": include_shell_data,
+              "mime_type": mime_type
+            }.compact
             unless request_options.nil? || request_options&.additional_body_parameters.nil?
               req.body = { **(request_options&.additional_body_parameters || {}) }.compact
             end

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

@@ -25,10 +25,11 @@ module Merge
       #  `DELETED_REMOTE_PRODUCTION_API_KEY`, `CREATED_TEST_API_KEY`,
       #  `DELETED_TEST_API_KEY`, `REGENERATED_PRODUCTION_API_KEY`, `INVITED_USER`,
       #  `TWO_FACTOR_AUTH_ENABLED`, `TWO_FACTOR_AUTH_DISABLED`, `DELETED_LINKED_ACCOUNT`,
-      #  `CREATED_DESTINATION`, `DELETED_DESTINATION`, `CHANGED_DESTINATION`,
-      #  `CHANGED_SCOPES`, `CHANGED_PERSONAL_INFORMATION`,
-      #  `CHANGED_ORGANIZATION_SETTINGS`, `ENABLED_INTEGRATION`, `DISABLED_INTEGRATION`,
-      #  `ENABLED_CATEGORY`, `DISABLED_CATEGORY`, `CHANGED_PASSWORD`, `RESET_PASSWORD`,
+      #  `DELETED_ALL_COMMON_MODELS_FOR_LINKED_ACCOUNT`, `CREATED_DESTINATION`,
+      #  `DELETED_DESTINATION`, `CHANGED_DESTINATION`, `CHANGED_SCOPES`,
+      #  `CHANGED_PERSONAL_INFORMATION`, `CHANGED_ORGANIZATION_SETTINGS`,
+      #  `ENABLED_INTEGRATION`, `DISABLED_INTEGRATION`, `ENABLED_CATEGORY`,
+      #  `DISABLED_CATEGORY`, `CHANGED_PASSWORD`, `RESET_PASSWORD`,
       #  `ENABLED_REDACT_UNMAPPED_DATA_FOR_ORGANIZATION`,
       #  `ENABLED_REDACT_UNMAPPED_DATA_FOR_LINKED_ACCOUNT`,
       #  `DISABLED_REDACT_UNMAPPED_DATA_FOR_ORGANIZATION`,
@@ -107,10 +108,11 @@ module Merge
       #  `DELETED_REMOTE_PRODUCTION_API_KEY`, `CREATED_TEST_API_KEY`,
       #  `DELETED_TEST_API_KEY`, `REGENERATED_PRODUCTION_API_KEY`, `INVITED_USER`,
       #  `TWO_FACTOR_AUTH_ENABLED`, `TWO_FACTOR_AUTH_DISABLED`, `DELETED_LINKED_ACCOUNT`,
-      #  `CREATED_DESTINATION`, `DELETED_DESTINATION`, `CHANGED_DESTINATION`,
-      #  `CHANGED_SCOPES`, `CHANGED_PERSONAL_INFORMATION`,
-      #  `CHANGED_ORGANIZATION_SETTINGS`, `ENABLED_INTEGRATION`, `DISABLED_INTEGRATION`,
-      #  `ENABLED_CATEGORY`, `DISABLED_CATEGORY`, `CHANGED_PASSWORD`, `RESET_PASSWORD`,
+      #  `DELETED_ALL_COMMON_MODELS_FOR_LINKED_ACCOUNT`, `CREATED_DESTINATION`,
+      #  `DELETED_DESTINATION`, `CHANGED_DESTINATION`, `CHANGED_SCOPES`,
+      #  `CHANGED_PERSONAL_INFORMATION`, `CHANGED_ORGANIZATION_SETTINGS`,
+      #  `ENABLED_INTEGRATION`, `DISABLED_INTEGRATION`, `ENABLED_CATEGORY`,
+      #  `DISABLED_CATEGORY`, `CHANGED_PASSWORD`, `RESET_PASSWORD`,
       #  `ENABLED_REDACT_UNMAPPED_DATA_FOR_ORGANIZATION`,
       #  `ENABLED_REDACT_UNMAPPED_DATA_FOR_LINKED_ACCOUNT`,
       #  `DISABLED_REDACT_UNMAPPED_DATA_FOR_ORGANIZATION`,

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

@@ -2,9 +2,9 @@
 
 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/collections_viewers_list_request_expand"
+require_relative "../types/paginated_viewer_list"
 require_relative "../types/collection"
 require "async"
 
@@ -26,7 +26,7 @@ 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 [Merge::Ticketing::Collections::CollectionsListRequestExpand] Which relations should be returned in expanded form. Multiple relation names
+      # @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] 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
@@ -93,13 +93,69 @@ module Merge
         Merge::Ticketing::PaginatedCollectionList.from_json(json_object: response.body)
       end
 
+      # Returns a list of `Viewer` objects that point to a User id or Team id that is
+      #  either an assignee or viewer on a `Collection` with the given id. [Learn
+      #  (https://help.merge.dev/en/articles/10333658-ticketing-access-control-list-acls)
+      #
+      # @param collection_id [String]
+      # @param cursor [String] The pagination cursor value.
+      # @param expand [Merge::Ticketing::Collections::CollectionsViewersListRequestExpand] Which relations should be returned in expanded form. Multiple relation names
+      #  should be comma separated without spaces.
+      # @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 page_size [Integer] Number of results to return per page.
+      # @param request_options [Merge::RequestOptions]
+      # @return [Merge::Ticketing::PaginatedViewerList]
+      # @example
+      #  api = Merge::Client.new(
+      #    base_url: "https://api.example.com",
+      #    environment: Merge::Environment::PRODUCTION,
+      #    api_key: "YOUR_AUTH_TOKEN"
+      #  )
+      #  api.ticketing.collections.viewers_list(collection_id: "collection_id")
+      def viewers_list(collection_id:, cursor: nil, expand: nil, include_deleted_data: nil, include_remote_data: nil,
+                       include_shell_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,
+            "include_shell_data": include_shell_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/#{collection_id}/viewers"
+        end
+        Merge::Ticketing::PaginatedViewerList.from_json(json_object: response.body)
+      end
+
       # Returns a `Collection` object with the given `id`.
       #
       # @param id [String]
-      # @param expand [Merge::Ticketing::Collections::CollectionsRetrieveRequestExpand] Which relations should be returned in expanded form. Multiple relation names
+      # @param expand [String] Which relations should be returned in expanded form. Multiple relation names
       #  should be comma separated without spaces.
       # @param include_remote_data [Boolean] Whether to include the original data Merge fetched from the third-party to
       #  produce these models.
+      # @param 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
@@ -113,8 +169,8 @@ module Merge
       #    api_key: "YOUR_AUTH_TOKEN"
       #  )
       #  api.ticketing.collections.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?
@@ -128,6 +184,7 @@ module Merge
             **(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
@@ -156,7 +213,7 @@ 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 [Merge::Ticketing::Collections::CollectionsListRequestExpand] Which relations should be returned in expanded form. Multiple relation names
+      # @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] 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
@@ -225,13 +282,71 @@ module Merge
         end
       end
 
+      # Returns a list of `Viewer` objects that point to a User id or Team id that is
+      #  either an assignee or viewer on a `Collection` with the given id. [Learn
+      #  (https://help.merge.dev/en/articles/10333658-ticketing-access-control-list-acls)
+      #
+      # @param collection_id [String]
+      # @param cursor [String] The pagination cursor value.
+      # @param expand [Merge::Ticketing::Collections::CollectionsViewersListRequestExpand] Which relations should be returned in expanded form. Multiple relation names
+      #  should be comma separated without spaces.
+      # @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 page_size [Integer] Number of results to return per page.
+      # @param request_options [Merge::RequestOptions]
+      # @return [Merge::Ticketing::PaginatedViewerList]
+      # @example
+      #  api = Merge::Client.new(
+      #    base_url: "https://api.example.com",
+      #    environment: Merge::Environment::PRODUCTION,
+      #    api_key: "YOUR_AUTH_TOKEN"
+      #  )
+      #  api.ticketing.collections.viewers_list(collection_id: "collection_id")
+      def viewers_list(collection_id:, cursor: nil, expand: nil, include_deleted_data: nil, include_remote_data: nil,
+                       include_shell_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,
+              "include_shell_data": include_shell_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/#{collection_id}/viewers"
+          end
+          Merge::Ticketing::PaginatedViewerList.from_json(json_object: response.body)
+        end
+      end
+
       # Returns a `Collection` object with the given `id`.
       #
       # @param id [String]
-      # @param expand [Merge::Ticketing::Collections::CollectionsRetrieveRequestExpand] Which relations should be returned in expanded form. Multiple relation names
+      # @param expand [String] Which relations should be returned in expanded form. Multiple relation names
       #  should be comma separated without spaces.
       # @param include_remote_data [Boolean] Whether to include the original data Merge fetched from the third-party to
       #  produce these models.
+      # @param 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
@@ -245,8 +360,8 @@ module Merge
       #    api_key: "YOUR_AUTH_TOKEN"
       #  )
       #  api.ticketing.collections.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?
@@ -261,6 +376,7 @@ module Merge
               **(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

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

@@ -0,0 +1,13 @@
+# frozen_string_literal: true
+
+module Merge
+  module Ticketing
+    class Collections
+      class CollectionsViewersListRequestExpand
+        TEAM = "team"
+        USER = "user"
+        USER_TEAM = "user,team"
+      end
+    end
+  end
+end

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

@@ -140,6 +140,8 @@ module Merge
       #  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 request_options [Merge::RequestOptions]
       # @return [Merge::Ticketing::Comment]
       # @example
@@ -149,7 +151,7 @@ module Merge
       #    api_key: "YOUR_AUTH_TOKEN"
       #  )
       #  api.ticketing.comments.retrieve(id: "id")
-      def retrieve(id:, expand: nil, include_remote_data: nil, request_options: nil)
+      def retrieve(id:, expand: nil, 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?
@@ -162,7 +164,8 @@ module Merge
           req.params = {
             **(request_options&.additional_query_parameters || {}),
             "expand": expand,
-            "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
@@ -336,6 +339,8 @@ module Merge
       #  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 request_options [Merge::RequestOptions]
       # @return [Merge::Ticketing::Comment]
       # @example
@@ -345,7 +350,7 @@ module Merge
       #    api_key: "YOUR_AUTH_TOKEN"
       #  )
       #  api.ticketing.comments.retrieve(id: "id")
-      def retrieve(id:, expand: nil, include_remote_data: nil, request_options: nil)
+      def retrieve(id:, expand: nil, 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?
@@ -359,7 +364,8 @@ module Merge
             req.params = {
               **(request_options&.additional_query_parameters || {}),
               "expand": expand,
-              "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

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

@@ -132,6 +132,8 @@ module Merge
       #  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 request_options [Merge::RequestOptions]
       # @return [Merge::Ticketing::Contact]
       # @example
@@ -141,7 +143,7 @@ module Merge
       #    api_key: "YOUR_AUTH_TOKEN"
       #  )
       #  api.ticketing.contacts.retrieve(id: "id")
-      def retrieve(id:, expand: nil, include_remote_data: nil, request_options: nil)
+      def retrieve(id:, expand: nil, 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?
@@ -154,7 +156,8 @@ module Merge
           req.params = {
             **(request_options&.additional_query_parameters || {}),
             "expand": expand,
-            "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
@@ -322,6 +325,8 @@ module Merge
       #  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 request_options [Merge::RequestOptions]
       # @return [Merge::Ticketing::Contact]
       # @example
@@ -331,7 +336,7 @@ module Merge
       #    api_key: "YOUR_AUTH_TOKEN"
       #  )
       #  api.ticketing.contacts.retrieve(id: "id")
-      def retrieve(id:, expand: nil, include_remote_data: nil, request_options: nil)
+      def retrieve(id:, expand: nil, 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?
@@ -345,7 +350,8 @@ module Merge
             req.params = {
               **(request_options&.additional_query_parameters || {}),
               "expand": expand,
-              "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

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

@@ -17,11 +17,11 @@ module Merge
         @request_client = request_client
       end
 
-      # 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 Professional or
-      #  Enterprise plans. Doing so will consume a sync credit for the relevant linked
-      #  account.
+      # Force re-sync of all models. This endpoint is available for monthly, quarterly,
+      #  and highest sync frequency customers on the Professional or Enterprise plans.
+      #  Doing so will consume a sync credit for the relevant linked account. Force
+      #  re-syncs can also be triggered manually in the Merge Dashboard and is available
+      #  for all customers.
       #
       # @param request_options [Merge::RequestOptions]
       # @return [Array<Merge::Ticketing::SyncStatus>]
@@ -68,11 +68,11 @@ module Merge
         @request_client = request_client
       end
 
-      # 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 Professional or
-      #  Enterprise plans. Doing so will consume a sync credit for the relevant linked
-      #  account.
+      # Force re-sync of all models. This endpoint is available for monthly, quarterly,
+      #  and highest sync frequency customers on the Professional or Enterprise plans.
+      #  Doing so will consume a sync credit for the relevant linked account. Force
+      #  re-syncs can also be triggered manually in the Merge Dashboard and is available
+      #  for all customers.
       #
       # @param request_options [Merge::RequestOptions]
       # @return [Array<Merge::Ticketing::SyncStatus>]

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

@@ -42,8 +42,8 @@ module Merge
       # @param start_date [String] If included, will only include issues whose most recent action occurred after
       #  this time
       # @param status [Merge::Ticketing::Issues::IssuesListRequestStatus] Status of the issue. Options: ('ONGOING', 'RESOLVED')
-      #  - `ONGOING` - ONGOING
-      #  - `RESOLVED` - RESOLVED
+      #  * `ONGOING` - ONGOING
+      #  * `RESOLVED` - RESOLVED
       # @param request_options [Merge::RequestOptions]
       # @return [Merge::Ticketing::PaginatedIssueList]
       # @example
@@ -156,8 +156,8 @@ module Merge
       # @param start_date [String] If included, will only include issues whose most recent action occurred after
       #  this time
       # @param status [Merge::Ticketing::Issues::IssuesListRequestStatus] Status of the issue. Options: ('ONGOING', 'RESOLVED')
-      #  - `ONGOING` - ONGOING
-      #  - `RESOLVED` - RESOLVED
+      #  * `ONGOING` - ONGOING
+      #  * `RESOLVED` - RESOLVED
       # @param request_options [Merge::RequestOptions]
       # @return [Merge::Ticketing::PaginatedIssueList]
       # @example

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

@@ -20,13 +20,13 @@ module Merge
       # List linked accounts for your organization.
       #
       # @param category [Merge::Ticketing::LinkedAccounts::LinkedAccountsListRequestCategory] Options: `accounting`, `ats`, `crm`, `filestorage`, `hris`, `mktg`, `ticketing`
-      #  - `hris` - hris
-      #  - `ats` - ats
-      #  - `accounting` - accounting
-      #  - `ticketing` - ticketing
-      #  - `crm` - crm
-      #  - `mktg` - mktg
-      #  - `filestorage` - filestorage
+      #  * `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.
@@ -106,13 +106,13 @@ module Merge
       # List linked accounts for your organization.
       #
       # @param category [Merge::Ticketing::LinkedAccounts::LinkedAccountsListRequestCategory] Options: `accounting`, `ats`, `crm`, `filestorage`, `hris`, `mktg`, `ticketing`
-      #  - `hris` - hris
-      #  - `ats` - ats
-      #  - `accounting` - accounting
-      #  - `ticketing` - ticketing
-      #  - `crm` - crm
-      #  - `mktg` - mktg
-      #  - `filestorage` - filestorage
+      #  * `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.