merge_ruby_client 0.1.3 → 1.0.0

data/lib/merge_ruby_client/ticketing/types/user.rb

@@ -11,7 +11,10 @@ module Merge
   module Ticketing
     # # The User Object
     #  ### Description
-    #  The `User` object is used to represent an employee within a company.
+    #  The `User` object is used to represent a user with a login to the ticketing
+    #  system.
+    #  Users are either assignees who are directly responsible or a viewer on a
+    #  `Ticket`/ `Collection`.
     #  ### Usage Example
     #  TODO
     class User
@@ -36,7 +39,9 @@ module Merge
       # @return [String] The user's avatar picture.
       attr_reader :avatar
       # @return [Boolean] Indicates whether or not this object has been deleted in the third party
-      #  platform.
+      #  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/).
       attr_reader :remote_was_deleted
       # @return [Hash{String => Object}]
       attr_reader :field_mappings
@@ -61,7 +66,9 @@ module Merge
       # @param roles [Array<Merge::Ticketing::UserRolesItem>]
       # @param avatar [String] The user's avatar picture.
       # @param remote_was_deleted [Boolean] Indicates whether or not this object has been deleted in the third party
-      #  platform.
+      #  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 field_mappings [Hash{String => Object}]
       # @param remote_data [Array<Merge::Ticketing::RemoteData>]
       # @param additional_properties [OpenStruct] Additional properties unmapped to the current class definition

data/lib/merge_ruby_client/ticketing/types/viewer.rb

@@ -0,0 +1,123 @@
+# frozen_string_literal: true
+
+require "date"
+require_relative "viewer_team"
+require_relative "viewer_user"
+require "ostruct"
+require "json"
+
+module Merge
+  module Ticketing
+    # # The Viewer Object
+    #  ### Description
+    #  The `Viewer` object is used to represent a User or Team within a company.
+    #  ### Usage Example
+    #  TODO
+    class Viewer
+      # @return [String]
+      attr_reader :id
+      # @return [String] The third-party API ID of the matching object.
+      attr_reader :remote_id
+      # @return [DateTime] The datetime that this object was created by Merge.
+      attr_reader :created_at
+      # @return [DateTime] The datetime that this object was modified by Merge.
+      attr_reader :modified_at
+      # @return [Merge::Ticketing::ViewerTeam] The Team this Viewer belongs to.
+      attr_reader :team
+      # @return [Merge::Ticketing::ViewerUser] The User this Viewer belongs to.
+      attr_reader :user
+      # @return [OpenStruct] Additional properties unmapped to the current class definition
+      attr_reader :additional_properties
+      # @return [Object]
+      attr_reader :_field_set
+      protected :_field_set
+
+      OMIT = Object.new
+
+      # @param id [String]
+      # @param remote_id [String] The third-party API ID of the matching object.
+      # @param created_at [DateTime] The datetime that this object was created by Merge.
+      # @param modified_at [DateTime] The datetime that this object was modified by Merge.
+      # @param team [Merge::Ticketing::ViewerTeam] The Team this Viewer belongs to.
+      # @param user [Merge::Ticketing::ViewerUser] The User this Viewer belongs to.
+      # @param additional_properties [OpenStruct] Additional properties unmapped to the current class definition
+      # @return [Merge::Ticketing::Viewer]
+      def initialize(id: OMIT, remote_id: OMIT, created_at: OMIT, modified_at: OMIT, team: OMIT, user: OMIT,
+                     additional_properties: nil)
+        @id = id if id != OMIT
+        @remote_id = remote_id if remote_id != OMIT
+        @created_at = created_at if created_at != OMIT
+        @modified_at = modified_at if modified_at != OMIT
+        @team = team if team != OMIT
+        @user = user if user != OMIT
+        @additional_properties = additional_properties
+        @_field_set = {
+          "id": id,
+          "remote_id": remote_id,
+          "created_at": created_at,
+          "modified_at": modified_at,
+          "team": team,
+          "user": user
+        }.reject do |_k, v|
+          v == OMIT
+        end
+      end
+
+      # Deserialize a JSON object to an instance of Viewer
+      #
+      # @param json_object [String]
+      # @return [Merge::Ticketing::Viewer]
+      def self.from_json(json_object:)
+        struct = JSON.parse(json_object, object_class: OpenStruct)
+        parsed_json = JSON.parse(json_object)
+        id = parsed_json["id"]
+        remote_id = parsed_json["remote_id"]
+        created_at = (DateTime.parse(parsed_json["created_at"]) unless parsed_json["created_at"].nil?)
+        modified_at = (DateTime.parse(parsed_json["modified_at"]) unless parsed_json["modified_at"].nil?)
+        if parsed_json["team"].nil?
+          team = nil
+        else
+          team = parsed_json["team"].to_json
+          team = Merge::Ticketing::ViewerTeam.from_json(json_object: team)
+        end
+        if parsed_json["user"].nil?
+          user = nil
+        else
+          user = parsed_json["user"].to_json
+          user = Merge::Ticketing::ViewerUser.from_json(json_object: user)
+        end
+        new(
+          id: id,
+          remote_id: remote_id,
+          created_at: created_at,
+          modified_at: modified_at,
+          team: team,
+          user: user,
+          additional_properties: struct
+        )
+      end
+
+      # Serialize an instance of Viewer to a JSON object
+      #
+      # @return [String]
+      def to_json(*_args)
+        @_field_set&.to_json
+      end
+
+      # Leveraged for Union-type generation, validate_raw attempts to parse the given
+      #  hash and check each fields type against the current object's property
+      #  definitions.
+      #
+      # @param obj [Object]
+      # @return [Void]
+      def self.validate_raw(obj:)
+        obj.id&.is_a?(String) != false || raise("Passed value for field obj.id is not the expected type, validation failed.")
+        obj.remote_id&.is_a?(String) != false || raise("Passed value for field obj.remote_id is not the expected type, validation failed.")
+        obj.created_at&.is_a?(DateTime) != false || raise("Passed value for field obj.created_at is not the expected type, validation failed.")
+        obj.modified_at&.is_a?(DateTime) != false || raise("Passed value for field obj.modified_at is not the expected type, validation failed.")
+        obj.team.nil? || Merge::Ticketing::ViewerTeam.validate_raw(obj: obj.team)
+        obj.user.nil? || Merge::Ticketing::ViewerUser.validate_raw(obj: obj.user)
+      end
+    end
+  end
+end

data/lib/merge_ruby_client/ticketing/types/viewer_team.rb

@@ -0,0 +1,56 @@
+# frozen_string_literal: true
+
+require "json"
+require_relative "team"
+
+module Merge
+  module Ticketing
+    # The Team this Viewer belongs to.
+    class ViewerTeam
+      # Deserialize a JSON object to an instance of ViewerTeam
+      #
+      # @param json_object [String]
+      # @return [Merge::Ticketing::ViewerTeam]
+      def self.from_json(json_object:)
+        struct = JSON.parse(json_object, object_class: OpenStruct)
+        begin
+          struct.is_a?(String) != false || raise("Passed value for field struct is not the expected type, validation failed.")
+          return struct unless struct.nil?
+
+          return nil
+        rescue StandardError
+          # noop
+        end
+        begin
+          Merge::Ticketing::Team.validate_raw(obj: struct)
+          return Merge::Ticketing::Team.from_json(json_object: struct) unless struct.nil?
+
+          return nil
+        rescue StandardError
+          # noop
+        end
+        struct
+      end
+
+      # Leveraged for Union-type generation, validate_raw attempts to parse the given
+      #  hash and check each fields type against the current object's property
+      #  definitions.
+      #
+      # @param obj [Object]
+      # @return [Void]
+      def self.validate_raw(obj:)
+        begin
+          return obj.is_a?(String) != false || raise("Passed value for field obj is not the expected type, validation failed.")
+        rescue StandardError
+          # noop
+        end
+        begin
+          return Merge::Ticketing::Team.validate_raw(obj: obj)
+        rescue StandardError
+          # noop
+        end
+        raise("Passed value matched no type within the union, validation failed.")
+      end
+    end
+  end
+end

data/lib/merge_ruby_client/ticketing/types/viewer_user.rb

@@ -0,0 +1,56 @@
+# frozen_string_literal: true
+
+require "json"
+require_relative "user"
+
+module Merge
+  module Ticketing
+    # The User this Viewer belongs to.
+    class ViewerUser
+      # Deserialize a JSON object to an instance of ViewerUser
+      #
+      # @param json_object [String]
+      # @return [Merge::Ticketing::ViewerUser]
+      def self.from_json(json_object:)
+        struct = JSON.parse(json_object, object_class: OpenStruct)
+        begin
+          struct.is_a?(String) != false || raise("Passed value for field struct is not the expected type, validation failed.")
+          return struct unless struct.nil?
+
+          return nil
+        rescue StandardError
+          # noop
+        end
+        begin
+          Merge::Ticketing::User.validate_raw(obj: struct)
+          return Merge::Ticketing::User.from_json(json_object: struct) unless struct.nil?
+
+          return nil
+        rescue StandardError
+          # noop
+        end
+        struct
+      end
+
+      # Leveraged for Union-type generation, validate_raw attempts to parse the given
+      #  hash and check each fields type against the current object's property
+      #  definitions.
+      #
+      # @param obj [Object]
+      # @return [Void]
+      def self.validate_raw(obj:)
+        begin
+          return obj.is_a?(String) != false || raise("Passed value for field obj is not the expected type, validation failed.")
+        rescue StandardError
+          # noop
+        end
+        begin
+          return Merge::Ticketing::User.validate_raw(obj: obj)
+        rescue StandardError
+          # noop
+        end
+        raise("Passed value matched no type within the union, validation failed.")
+      end
+    end
+  end
+end

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

@@ -29,9 +29,14 @@ module Merge
       #  insensitive).
       # @param expand [Merge::Ticketing::Users::UsersListRequestExpand] 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.
@@ -47,7 +52,7 @@ module Merge
       #  )
       #  api.ticketing.users.list
       def list(created_after: nil, created_before: nil, cursor: nil, email_address: 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_deleted_data: 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?
@@ -66,6 +71,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,
@@ -138,9 +144,14 @@ module Merge
       #  insensitive).
       # @param expand [Merge::Ticketing::Users::UsersListRequestExpand] 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.
@@ -156,7 +167,7 @@ module Merge
       #  )
       #  api.ticketing.users.list
       def list(created_after: nil, created_before: nil, cursor: nil, email_address: 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_deleted_data: 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?
@@ -176,6 +187,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.rb

@@ -3,21 +3,21 @@
 require_relative "environment"
 require_relative "types_export"
 require_relative "requests"
-require_relative "merge_ruby_client/filestorage/client"
 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/hris/client"
 require_relative "merge_ruby_client/ticketing/client"
 require_relative "merge_ruby_client/accounting/client"
 
 module Merge
   class Client
-    # @return [Merge::Filestorage::Client]
-    attr_reader :filestorage
     # @return [Merge::Ats::Client]
     attr_reader :ats
     # @return [Merge::Crm::Client]
     attr_reader :crm
+    # @return [Merge::Filestorage::Client]
+    attr_reader :filestorage
     # @return [Merge::Hris::Client]
     attr_reader :hris
     # @return [Merge::Ticketing::Client]
@@ -42,9 +42,9 @@ module Merge
         api_key: api_key,
         account_token: account_token
       )
-      @filestorage = Merge::Filestorage::Client.new(request_client: @request_client)
       @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)
       @hris = Merge::Hris::Client.new(request_client: @request_client)
       @ticketing = Merge::Ticketing::Client.new(request_client: @request_client)
       @accounting = Merge::Accounting::Client.new(request_client: @request_client)
@@ -52,12 +52,12 @@ module Merge
   end
 
   class AsyncClient
-    # @return [Merge::Filestorage::AsyncClient]
-    attr_reader :filestorage
     # @return [Merge::Ats::AsyncClient]
     attr_reader :ats
     # @return [Merge::Crm::AsyncClient]
     attr_reader :crm
+    # @return [Merge::Filestorage::AsyncClient]
+    attr_reader :filestorage
     # @return [Merge::Hris::AsyncClient]
     attr_reader :hris
     # @return [Merge::Ticketing::AsyncClient]
@@ -82,9 +82,9 @@ module Merge
         api_key: api_key,
         account_token: account_token
       )
-      @filestorage = Merge::Filestorage::AsyncClient.new(request_client: @async_request_client)
       @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)
       @hris = Merge::Hris::AsyncClient.new(request_client: @async_request_client)
       @ticketing = Merge::Ticketing::AsyncClient.new(request_client: @async_request_client)
       @accounting = Merge::Accounting::AsyncClient.new(request_client: @async_request_client)

data/lib/requests.rb

@@ -48,7 +48,7 @@ module Merge
 
     # @return [Hash{String => String}]
     def get_headers
-      headers = { "X-Fern-Language": "Ruby", "X-Fern-SDK-Name": "merge_ruby_client", "X-Fern-SDK-Version": "0.1.3" }
+      headers = { "X-Fern-Language": "Ruby", "X-Fern-SDK-Name": "merge_ruby_client", "X-Fern-SDK-Version": "1.0.0" }
       headers["Authorization"] = ((@api_key.is_a? Method) ? @api_key.call : @api_key) unless @api_key.nil?
       headers
     end
@@ -96,7 +96,7 @@ module Merge
 
     # @return [Hash{String => String}]
     def get_headers
-      headers = { "X-Fern-Language": "Ruby", "X-Fern-SDK-Name": "merge_ruby_client", "X-Fern-SDK-Version": "0.1.3" }
+      headers = { "X-Fern-Language": "Ruby", "X-Fern-SDK-Name": "merge_ruby_client", "X-Fern-SDK-Version": "1.0.0" }
       headers["Authorization"] = ((@api_key.is_a? Method) ? @api_key.call : @api_key) unless @api_key.nil?
       headers
     end