merge_ruby_client 0.1.4 → 1.1.0

data/lib/merge_ruby_client/accounting/types/employee.rb

@@ -0,0 +1,199 @@
+# frozen_string_literal: true
+
+require "date"
+require_relative "employee_company"
+require_relative "status_895_enum"
+require_relative "remote_data"
+require "ostruct"
+require "json"
+
+module Merge
+  module Accounting
+    # # The Employee Object
+    #  ### Description
+    #  An `Employee` is an individual who works for the company of the linked account.
+    #  The `Employee` model contains both contractors and full time employees.
+    #  * An `Employee` is a contractor if `is_contractor` property is `True`
+    #  * An `Employee` is a full time employee if `is_contractor` property is `False`
+    #  ### Usage Example
+    #  Fetch from the `LIST Employees` endpoint and view a company's employees.
+    class Employee
+      # @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 [String] The employee's first name.
+      attr_reader :first_name
+      # @return [String] The employee's last name.
+      attr_reader :last_name
+      # @return [Boolean] `True` if the employee is a contractor, `False` if not.
+      attr_reader :is_contractor
+      # @return [String] The employee's internal identification number.
+      attr_reader :employee_number
+      # @return [String] The employee's email address.
+      attr_reader :email_address
+      # @return [Merge::Accounting::EmployeeCompany] The subsidiary that the employee belongs to.
+      attr_reader :company
+      # @return [Merge::Accounting::Status895Enum] The employee's status in the accounting system.
+      #  * `ACTIVE` - ACTIVE
+      #  * `INACTIVE` - INACTIVE
+      attr_reader :status
+      # @return [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/).
+      attr_reader :remote_was_deleted
+      # @return [Hash{String => Object}]
+      attr_reader :field_mappings
+      # @return [Array<Merge::Accounting::RemoteData>]
+      attr_reader :remote_data
+      # @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 first_name [String] The employee's first name.
+      # @param last_name [String] The employee's last name.
+      # @param is_contractor [Boolean] `True` if the employee is a contractor, `False` if not.
+      # @param employee_number [String] The employee's internal identification number.
+      # @param email_address [String] The employee's email address.
+      # @param company [Merge::Accounting::EmployeeCompany] The subsidiary that the employee belongs to.
+      # @param status [Merge::Accounting::Status895Enum] The employee's status in the accounting system.
+      #  * `ACTIVE` - ACTIVE
+      #  * `INACTIVE` - INACTIVE
+      # @param remote_was_deleted [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 field_mappings [Hash{String => Object}]
+      # @param remote_data [Array<Merge::Accounting::RemoteData>]
+      # @param additional_properties [OpenStruct] Additional properties unmapped to the current class definition
+      # @return [Merge::Accounting::Employee]
+      def initialize(status:, id: OMIT, remote_id: OMIT, created_at: OMIT, modified_at: OMIT, first_name: OMIT, last_name: OMIT,
+                     is_contractor: OMIT, employee_number: OMIT, email_address: OMIT, company: OMIT, remote_was_deleted: OMIT, field_mappings: OMIT, remote_data: 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
+        @first_name = first_name if first_name != OMIT
+        @last_name = last_name if last_name != OMIT
+        @is_contractor = is_contractor if is_contractor != OMIT
+        @employee_number = employee_number if employee_number != OMIT
+        @email_address = email_address if email_address != OMIT
+        @company = company if company != OMIT
+        @status = status
+        @remote_was_deleted = remote_was_deleted if remote_was_deleted != OMIT
+        @field_mappings = field_mappings if field_mappings != OMIT
+        @remote_data = remote_data if remote_data != OMIT
+        @additional_properties = additional_properties
+        @_field_set = {
+          "id": id,
+          "remote_id": remote_id,
+          "created_at": created_at,
+          "modified_at": modified_at,
+          "first_name": first_name,
+          "last_name": last_name,
+          "is_contractor": is_contractor,
+          "employee_number": employee_number,
+          "email_address": email_address,
+          "company": company,
+          "status": status,
+          "remote_was_deleted": remote_was_deleted,
+          "field_mappings": field_mappings,
+          "remote_data": remote_data
+        }.reject do |_k, v|
+          v == OMIT
+        end
+      end
+
+      # Deserialize a JSON object to an instance of Employee
+      #
+      # @param json_object [String]
+      # @return [Merge::Accounting::Employee]
+      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?)
+        first_name = parsed_json["first_name"]
+        last_name = parsed_json["last_name"]
+        is_contractor = parsed_json["is_contractor"]
+        employee_number = parsed_json["employee_number"]
+        email_address = parsed_json["email_address"]
+        if parsed_json["company"].nil?
+          company = nil
+        else
+          company = parsed_json["company"].to_json
+          company = Merge::Accounting::EmployeeCompany.from_json(json_object: company)
+        end
+        status = parsed_json["status"]
+        remote_was_deleted = parsed_json["remote_was_deleted"]
+        field_mappings = parsed_json["field_mappings"]
+        remote_data = parsed_json["remote_data"]&.map do |item|
+          item = item.to_json
+          Merge::Accounting::RemoteData.from_json(json_object: item)
+        end
+        new(
+          id: id,
+          remote_id: remote_id,
+          created_at: created_at,
+          modified_at: modified_at,
+          first_name: first_name,
+          last_name: last_name,
+          is_contractor: is_contractor,
+          employee_number: employee_number,
+          email_address: email_address,
+          company: company,
+          status: status,
+          remote_was_deleted: remote_was_deleted,
+          field_mappings: field_mappings,
+          remote_data: remote_data,
+          additional_properties: struct
+        )
+      end
+
+      # Serialize an instance of Employee 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.first_name&.is_a?(String) != false || raise("Passed value for field obj.first_name is not the expected type, validation failed.")
+        obj.last_name&.is_a?(String) != false || raise("Passed value for field obj.last_name is not the expected type, validation failed.")
+        obj.is_contractor&.is_a?(Boolean) != false || raise("Passed value for field obj.is_contractor is not the expected type, validation failed.")
+        obj.employee_number&.is_a?(String) != false || raise("Passed value for field obj.employee_number is not the expected type, validation failed.")
+        obj.email_address&.is_a?(String) != false || raise("Passed value for field obj.email_address is not the expected type, validation failed.")
+        obj.company.nil? || Merge::Accounting::EmployeeCompany.validate_raw(obj: obj.company)
+        obj.status.is_a?(Merge::Accounting::Status895Enum) != false || raise("Passed value for field obj.status is not the expected type, validation failed.")
+        obj.remote_was_deleted&.is_a?(Boolean) != false || raise("Passed value for field obj.remote_was_deleted is not the expected type, validation failed.")
+        obj.field_mappings&.is_a?(Hash) != false || raise("Passed value for field obj.field_mappings is not the expected type, validation failed.")
+        obj.remote_data&.is_a?(Array) != false || raise("Passed value for field obj.remote_data is not the expected type, validation failed.")
+      end
+    end
+  end
+end

data/lib/merge_ruby_client/accounting/types/employee_company.rb

@@ -0,0 +1,56 @@
+# frozen_string_literal: true
+
+require "json"
+require_relative "company_info"
+
+module Merge
+  module Accounting
+    # The subsidiary that the employee belongs to.
+    class EmployeeCompany
+      # Deserialize a JSON object to an instance of EmployeeCompany
+      #
+      # @param json_object [String]
+      # @return [Merge::Accounting::EmployeeCompany]
+      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::Accounting::CompanyInfo.validate_raw(obj: struct)
+          return Merge::Accounting::CompanyInfo.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::Accounting::CompanyInfo.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/accounting/types/enabled_actions_enum.rb

@@ -2,8 +2,8 @@
 
 module Merge
   module Accounting
-    # - `READ` - READ
-    #  - `WRITE` - WRITE
+    # * `READ` - READ
+    #  * `WRITE` - WRITE
     class EnabledActionsEnum
       READ = "READ"
       WRITE = "WRITE"

data/lib/merge_ruby_client/accounting/types/encoding_enum.rb

@@ -2,9 +2,9 @@
 
 module Merge
   module Accounting
-    # - `RAW` - RAW
-    #  - `BASE64` - BASE64
-    #  - `GZIP_BASE64` - GZIP_BASE64
+    # * `RAW` - RAW
+    #  * `BASE64` - BASE64
+    #  * `GZIP_BASE64` - GZIP_BASE64
     class EncodingEnum
       RAW = "RAW"
       BASE_64 = "BASE64"

data/lib/merge_ruby_client/accounting/types/event_type_enum.rb

@@ -2,50 +2,59 @@
 
 module Merge
   module Accounting
-    # - `CREATED_REMOTE_PRODUCTION_API_KEY` - CREATED_REMOTE_PRODUCTION_API_KEY
-    #  - `DELETED_REMOTE_PRODUCTION_API_KEY` - DELETED_REMOTE_PRODUCTION_API_KEY
-    #  - `CREATED_TEST_API_KEY` - CREATED_TEST_API_KEY
-    #  - `DELETED_TEST_API_KEY` - DELETED_TEST_API_KEY
-    #  - `REGENERATED_PRODUCTION_API_KEY` - REGENERATED_PRODUCTION_API_KEY
-    #  - `INVITED_USER` - INVITED_USER
-    #  - `TWO_FACTOR_AUTH_ENABLED` - TWO_FACTOR_AUTH_ENABLED
-    #  - `TWO_FACTOR_AUTH_DISABLED` - TWO_FACTOR_AUTH_DISABLED
-    #  - `DELETED_LINKED_ACCOUNT` - DELETED_LINKED_ACCOUNT
-    #  - `CREATED_DESTINATION` - CREATED_DESTINATION
-    #  - `DELETED_DESTINATION` - DELETED_DESTINATION
-    #  - `CHANGED_DESTINATION` - CHANGED_DESTINATION
-    #  - `CHANGED_SCOPES` - CHANGED_SCOPES
-    #  - `CHANGED_PERSONAL_INFORMATION` - CHANGED_PERSONAL_INFORMATION
-    #  - `CHANGED_ORGANIZATION_SETTINGS` - CHANGED_ORGANIZATION_SETTINGS
-    #  - `ENABLED_INTEGRATION` - ENABLED_INTEGRATION
-    #  - `DISABLED_INTEGRATION` - DISABLED_INTEGRATION
-    #  - `ENABLED_CATEGORY` - ENABLED_CATEGORY
-    #  - `DISABLED_CATEGORY` - DISABLED_CATEGORY
-    #  - `CHANGED_PASSWORD` - CHANGED_PASSWORD
-    #  - `RESET_PASSWORD` - RESET_PASSWORD
-    #  - `ENABLED_REDACT_UNMAPPED_DATA_FOR_ORGANIZATION` -
+    # * `CREATED_REMOTE_PRODUCTION_API_KEY` - CREATED_REMOTE_PRODUCTION_API_KEY
+    #  * `DELETED_REMOTE_PRODUCTION_API_KEY` - DELETED_REMOTE_PRODUCTION_API_KEY
+    #  * `CREATED_TEST_API_KEY` - CREATED_TEST_API_KEY
+    #  * `DELETED_TEST_API_KEY` - DELETED_TEST_API_KEY
+    #  * `REGENERATED_PRODUCTION_API_KEY` - REGENERATED_PRODUCTION_API_KEY
+    #  * `INVITED_USER` - INVITED_USER
+    #  * `TWO_FACTOR_AUTH_ENABLED` - TWO_FACTOR_AUTH_ENABLED
+    #  * `TWO_FACTOR_AUTH_DISABLED` - TWO_FACTOR_AUTH_DISABLED
+    #  * `DELETED_LINKED_ACCOUNT` - DELETED_LINKED_ACCOUNT
+    #  * `DELETED_ALL_COMMON_MODELS_FOR_LINKED_ACCOUNT` -
+    #  DELETED_ALL_COMMON_MODELS_FOR_LINKED_ACCOUNT
+    #  * `CREATED_DESTINATION` - CREATED_DESTINATION
+    #  * `DELETED_DESTINATION` - DELETED_DESTINATION
+    #  * `CHANGED_DESTINATION` - CHANGED_DESTINATION
+    #  * `CHANGED_SCOPES` - CHANGED_SCOPES
+    #  * `CHANGED_PERSONAL_INFORMATION` - CHANGED_PERSONAL_INFORMATION
+    #  * `CHANGED_ORGANIZATION_SETTINGS` - CHANGED_ORGANIZATION_SETTINGS
+    #  * `ENABLED_INTEGRATION` - ENABLED_INTEGRATION
+    #  * `DISABLED_INTEGRATION` - DISABLED_INTEGRATION
+    #  * `ENABLED_CATEGORY` - ENABLED_CATEGORY
+    #  * `DISABLED_CATEGORY` - DISABLED_CATEGORY
+    #  * `CHANGED_PASSWORD` - CHANGED_PASSWORD
+    #  * `RESET_PASSWORD` - RESET_PASSWORD
+    #  * `ENABLED_REDACT_UNMAPPED_DATA_FOR_ORGANIZATION` -
     #  ENABLED_REDACT_UNMAPPED_DATA_FOR_ORGANIZATION
-    #  - `ENABLED_REDACT_UNMAPPED_DATA_FOR_LINKED_ACCOUNT` -
+    #  * `ENABLED_REDACT_UNMAPPED_DATA_FOR_LINKED_ACCOUNT` -
     #  ENABLED_REDACT_UNMAPPED_DATA_FOR_LINKED_ACCOUNT
-    #  - `DISABLED_REDACT_UNMAPPED_DATA_FOR_ORGANIZATION` -
+    #  * `DISABLED_REDACT_UNMAPPED_DATA_FOR_ORGANIZATION` -
     #  DISABLED_REDACT_UNMAPPED_DATA_FOR_ORGANIZATION
-    #  - `DISABLED_REDACT_UNMAPPED_DATA_FOR_LINKED_ACCOUNT` -
+    #  * `DISABLED_REDACT_UNMAPPED_DATA_FOR_LINKED_ACCOUNT` -
     #  DISABLED_REDACT_UNMAPPED_DATA_FOR_LINKED_ACCOUNT
-    #  - `CREATED_INTEGRATION_WIDE_FIELD_MAPPING` -
+    #  * `CREATED_INTEGRATION_WIDE_FIELD_MAPPING` -
     #  CREATED_INTEGRATION_WIDE_FIELD_MAPPING
-    #  - `CREATED_LINKED_ACCOUNT_FIELD_MAPPING` - CREATED_LINKED_ACCOUNT_FIELD_MAPPING
-    #  - `CHANGED_INTEGRATION_WIDE_FIELD_MAPPING` -
+    #  * `CREATED_LINKED_ACCOUNT_FIELD_MAPPING` - CREATED_LINKED_ACCOUNT_FIELD_MAPPING
+    #  * `CHANGED_INTEGRATION_WIDE_FIELD_MAPPING` -
     #  CHANGED_INTEGRATION_WIDE_FIELD_MAPPING
-    #  - `CHANGED_LINKED_ACCOUNT_FIELD_MAPPING` - CHANGED_LINKED_ACCOUNT_FIELD_MAPPING
-    #  - `DELETED_INTEGRATION_WIDE_FIELD_MAPPING` -
+    #  * `CHANGED_LINKED_ACCOUNT_FIELD_MAPPING` - CHANGED_LINKED_ACCOUNT_FIELD_MAPPING
+    #  * `DELETED_INTEGRATION_WIDE_FIELD_MAPPING` -
     #  DELETED_INTEGRATION_WIDE_FIELD_MAPPING
-    #  - `DELETED_LINKED_ACCOUNT_FIELD_MAPPING` - DELETED_LINKED_ACCOUNT_FIELD_MAPPING
-    #  - `FORCED_LINKED_ACCOUNT_RESYNC` - FORCED_LINKED_ACCOUNT_RESYNC
-    #  - `MUTED_ISSUE` - MUTED_ISSUE
-    #  - `GENERATED_MAGIC_LINK` - GENERATED_MAGIC_LINK
-    #  - `ENABLED_MERGE_WEBHOOK` - ENABLED_MERGE_WEBHOOK
-    #  - `DISABLED_MERGE_WEBHOOK` - DISABLED_MERGE_WEBHOOK
-    #  - `MERGE_WEBHOOK_TARGET_CHANGED` - MERGE_WEBHOOK_TARGET_CHANGED
+    #  * `DELETED_LINKED_ACCOUNT_FIELD_MAPPING` - DELETED_LINKED_ACCOUNT_FIELD_MAPPING
+    #  * `CREATED_LINKED_ACCOUNT_COMMON_MODEL_OVERRIDE` -
+    #  CREATED_LINKED_ACCOUNT_COMMON_MODEL_OVERRIDE
+    #  * `CHANGED_LINKED_ACCOUNT_COMMON_MODEL_OVERRIDE` -
+    #  CHANGED_LINKED_ACCOUNT_COMMON_MODEL_OVERRIDE
+    #  * `DELETED_LINKED_ACCOUNT_COMMON_MODEL_OVERRIDE` -
+    #  DELETED_LINKED_ACCOUNT_COMMON_MODEL_OVERRIDE
+    #  * `FORCED_LINKED_ACCOUNT_RESYNC` - FORCED_LINKED_ACCOUNT_RESYNC
+    #  * `MUTED_ISSUE` - MUTED_ISSUE
+    #  * `GENERATED_MAGIC_LINK` - GENERATED_MAGIC_LINK
+    #  * `ENABLED_MERGE_WEBHOOK` - ENABLED_MERGE_WEBHOOK
+    #  * `DISABLED_MERGE_WEBHOOK` - DISABLED_MERGE_WEBHOOK
+    #  * `MERGE_WEBHOOK_TARGET_CHANGED` - MERGE_WEBHOOK_TARGET_CHANGED
+    #  * `END_USER_CREDENTIALS_ACCESSED` - END_USER_CREDENTIALS_ACCESSED
     class EventTypeEnum
       CREATED_REMOTE_PRODUCTION_API_KEY = "CREATED_REMOTE_PRODUCTION_API_KEY"
       DELETED_REMOTE_PRODUCTION_API_KEY = "DELETED_REMOTE_PRODUCTION_API_KEY"
@@ -56,6 +65,7 @@ module Merge
       TWO_FACTOR_AUTH_ENABLED = "TWO_FACTOR_AUTH_ENABLED"
       TWO_FACTOR_AUTH_DISABLED = "TWO_FACTOR_AUTH_DISABLED"
       DELETED_LINKED_ACCOUNT = "DELETED_LINKED_ACCOUNT"
+      DELETED_ALL_COMMON_MODELS_FOR_LINKED_ACCOUNT = "DELETED_ALL_COMMON_MODELS_FOR_LINKED_ACCOUNT"
       CREATED_DESTINATION = "CREATED_DESTINATION"
       DELETED_DESTINATION = "DELETED_DESTINATION"
       CHANGED_DESTINATION = "CHANGED_DESTINATION"
@@ -78,12 +88,16 @@ module Merge
       CHANGED_LINKED_ACCOUNT_FIELD_MAPPING = "CHANGED_LINKED_ACCOUNT_FIELD_MAPPING"
       DELETED_INTEGRATION_WIDE_FIELD_MAPPING = "DELETED_INTEGRATION_WIDE_FIELD_MAPPING"
       DELETED_LINKED_ACCOUNT_FIELD_MAPPING = "DELETED_LINKED_ACCOUNT_FIELD_MAPPING"
+      CREATED_LINKED_ACCOUNT_COMMON_MODEL_OVERRIDE = "CREATED_LINKED_ACCOUNT_COMMON_MODEL_OVERRIDE"
+      CHANGED_LINKED_ACCOUNT_COMMON_MODEL_OVERRIDE = "CHANGED_LINKED_ACCOUNT_COMMON_MODEL_OVERRIDE"
+      DELETED_LINKED_ACCOUNT_COMMON_MODEL_OVERRIDE = "DELETED_LINKED_ACCOUNT_COMMON_MODEL_OVERRIDE"
       FORCED_LINKED_ACCOUNT_RESYNC = "FORCED_LINKED_ACCOUNT_RESYNC"
       MUTED_ISSUE = "MUTED_ISSUE"
       GENERATED_MAGIC_LINK = "GENERATED_MAGIC_LINK"
       ENABLED_MERGE_WEBHOOK = "ENABLED_MERGE_WEBHOOK"
       DISABLED_MERGE_WEBHOOK = "DISABLED_MERGE_WEBHOOK"
       MERGE_WEBHOOK_TARGET_CHANGED = "MERGE_WEBHOOK_TARGET_CHANGED"
+      END_USER_CREDENTIALS_ACCESSED = "END_USER_CREDENTIALS_ACCESSED"
     end
   end
 end