merge_ruby_client 0.1.3 → 1.0.0

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

@@ -0,0 +1,145 @@
+# frozen_string_literal: true
+
+require_relative "field_type_enum"
+require_relative "field_format_enum"
+require_relative "item_schema"
+require "ostruct"
+require "json"
+
+module Merge
+  module Accounting
+    class RemoteFieldClass
+      # @return [String]
+      attr_reader :id
+      # @return [String]
+      attr_reader :display_name
+      # @return [String]
+      attr_reader :remote_key_name
+      # @return [String]
+      attr_reader :description
+      # @return [Boolean]
+      attr_reader :is_custom
+      # @return [Boolean]
+      attr_reader :is_required
+      # @return [Merge::Accounting::FieldTypeEnum]
+      attr_reader :field_type
+      # @return [Merge::Accounting::FieldFormatEnum]
+      attr_reader :field_format
+      # @return [Array<String>]
+      attr_reader :field_choices
+      # @return [Merge::Accounting::ItemSchema]
+      attr_reader :item_schema
+      # @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 display_name [String]
+      # @param remote_key_name [String]
+      # @param description [String]
+      # @param is_custom [Boolean]
+      # @param is_required [Boolean]
+      # @param field_type [Merge::Accounting::FieldTypeEnum]
+      # @param field_format [Merge::Accounting::FieldFormatEnum]
+      # @param field_choices [Array<String>]
+      # @param item_schema [Merge::Accounting::ItemSchema]
+      # @param additional_properties [OpenStruct] Additional properties unmapped to the current class definition
+      # @return [Merge::Accounting::RemoteFieldClass]
+      def initialize(id: OMIT, display_name: OMIT, remote_key_name: OMIT, description: OMIT, is_custom: OMIT,
+                     is_required: OMIT, field_type: OMIT, field_format: OMIT, field_choices: OMIT, item_schema: OMIT, additional_properties: nil)
+        @id = id if id != OMIT
+        @display_name = display_name if display_name != OMIT
+        @remote_key_name = remote_key_name if remote_key_name != OMIT
+        @description = description if description != OMIT
+        @is_custom = is_custom if is_custom != OMIT
+        @is_required = is_required if is_required != OMIT
+        @field_type = field_type if field_type != OMIT
+        @field_format = field_format if field_format != OMIT
+        @field_choices = field_choices if field_choices != OMIT
+        @item_schema = item_schema if item_schema != OMIT
+        @additional_properties = additional_properties
+        @_field_set = {
+          "id": id,
+          "display_name": display_name,
+          "remote_key_name": remote_key_name,
+          "description": description,
+          "is_custom": is_custom,
+          "is_required": is_required,
+          "field_type": field_type,
+          "field_format": field_format,
+          "field_choices": field_choices,
+          "item_schema": item_schema
+        }.reject do |_k, v|
+          v == OMIT
+        end
+      end
+
+      # Deserialize a JSON object to an instance of RemoteFieldClass
+      #
+      # @param json_object [String]
+      # @return [Merge::Accounting::RemoteFieldClass]
+      def self.from_json(json_object:)
+        struct = JSON.parse(json_object, object_class: OpenStruct)
+        parsed_json = JSON.parse(json_object)
+        id = parsed_json["id"]
+        display_name = parsed_json["display_name"]
+        remote_key_name = parsed_json["remote_key_name"]
+        description = parsed_json["description"]
+        is_custom = parsed_json["is_custom"]
+        is_required = parsed_json["is_required"]
+        field_type = parsed_json["field_type"]
+        field_format = parsed_json["field_format"]
+        field_choices = parsed_json["field_choices"]
+        if parsed_json["item_schema"].nil?
+          item_schema = nil
+        else
+          item_schema = parsed_json["item_schema"].to_json
+          item_schema = Merge::Accounting::ItemSchema.from_json(json_object: item_schema)
+        end
+        new(
+          id: id,
+          display_name: display_name,
+          remote_key_name: remote_key_name,
+          description: description,
+          is_custom: is_custom,
+          is_required: is_required,
+          field_type: field_type,
+          field_format: field_format,
+          field_choices: field_choices,
+          item_schema: item_schema,
+          additional_properties: struct
+        )
+      end
+
+      # Serialize an instance of RemoteFieldClass 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.display_name&.is_a?(String) != false || raise("Passed value for field obj.display_name is not the expected type, validation failed.")
+        obj.remote_key_name&.is_a?(String) != false || raise("Passed value for field obj.remote_key_name is not the expected type, validation failed.")
+        obj.description&.is_a?(String) != false || raise("Passed value for field obj.description is not the expected type, validation failed.")
+        obj.is_custom&.is_a?(Boolean) != false || raise("Passed value for field obj.is_custom is not the expected type, validation failed.")
+        obj.is_required&.is_a?(Boolean) != false || raise("Passed value for field obj.is_required is not the expected type, validation failed.")
+        obj.field_type&.is_a?(Merge::Accounting::FieldTypeEnum) != false || raise("Passed value for field obj.field_type is not the expected type, validation failed.")
+        obj.field_format&.is_a?(Merge::Accounting::FieldFormatEnum) != false || raise("Passed value for field obj.field_format is not the expected type, validation failed.")
+        obj.field_choices&.is_a?(Array) != false || raise("Passed value for field obj.field_choices is not the expected type, validation failed.")
+        obj.item_schema.nil? || Merge::Accounting::ItemSchema.validate_raw(obj: obj.item_schema)
+      end
+    end
+  end
+end

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

@@ -0,0 +1,75 @@
+# frozen_string_literal: true
+
+require_relative "remote_field_request_remote_field_class"
+require "ostruct"
+require "json"
+
+module Merge
+  module Accounting
+    class RemoteFieldRequest
+      # @return [Merge::Accounting::RemoteFieldRequestRemoteFieldClass]
+      attr_reader :remote_field_class
+      # @return [Object]
+      attr_reader :value
+      # @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 remote_field_class [Merge::Accounting::RemoteFieldRequestRemoteFieldClass]
+      # @param value [Object]
+      # @param additional_properties [OpenStruct] Additional properties unmapped to the current class definition
+      # @return [Merge::Accounting::RemoteFieldRequest]
+      def initialize(remote_field_class:, value: OMIT, additional_properties: nil)
+        @remote_field_class = remote_field_class
+        @value = value if value != OMIT
+        @additional_properties = additional_properties
+        @_field_set = { "remote_field_class": remote_field_class, "value": value }.reject do |_k, v|
+          v == OMIT
+        end
+      end
+
+      # Deserialize a JSON object to an instance of RemoteFieldRequest
+      #
+      # @param json_object [String]
+      # @return [Merge::Accounting::RemoteFieldRequest]
+      def self.from_json(json_object:)
+        struct = JSON.parse(json_object, object_class: OpenStruct)
+        parsed_json = JSON.parse(json_object)
+        if parsed_json["remote_field_class"].nil?
+          remote_field_class = nil
+        else
+          remote_field_class = parsed_json["remote_field_class"].to_json
+          remote_field_class = Merge::Accounting::RemoteFieldRequestRemoteFieldClass.from_json(json_object: remote_field_class)
+        end
+        value = parsed_json["value"]
+        new(
+          remote_field_class: remote_field_class,
+          value: value,
+          additional_properties: struct
+        )
+      end
+
+      # Serialize an instance of RemoteFieldRequest 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:)
+        Merge::Accounting::RemoteFieldRequestRemoteFieldClass.validate_raw(obj: obj.remote_field_class)
+        obj.value&.is_a?(Object) != false || raise("Passed value for field obj.value is not the expected type, validation failed.")
+      end
+    end
+  end
+end

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

@@ -0,0 +1,55 @@
+# frozen_string_literal: true
+
+require "json"
+require_relative "remote_field_class"
+
+module Merge
+  module Accounting
+    class RemoteFieldRequestRemoteFieldClass
+      # Deserialize a JSON object to an instance of RemoteFieldRequestRemoteFieldClass
+      #
+      # @param json_object [String]
+      # @return [Merge::Accounting::RemoteFieldRequestRemoteFieldClass]
+      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::RemoteFieldClass.validate_raw(obj: struct)
+          return Merge::Accounting::RemoteFieldClass.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::RemoteFieldClass.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/report_item.rb

@@ -28,6 +28,11 @@ module Merge
       attr_reader :sub_items
       # @return [String] The company the report item belongs to.
       attr_reader :company
+      # @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 [OpenStruct] Additional properties unmapped to the current class definition
       attr_reader :additional_properties
       # @return [Object]
@@ -43,10 +48,14 @@ module Merge
       # @param value [Float] The report item's value.
       # @param sub_items [Array<Hash{String => Object}>]
       # @param company [String] The company the report item belongs to.
+      # @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 additional_properties [OpenStruct] Additional properties unmapped to the current class definition
       # @return [Merge::Accounting::ReportItem]
       def initialize(remote_id: OMIT, created_at: OMIT, modified_at: OMIT, name: OMIT, value: OMIT, sub_items: OMIT,
-                     company: OMIT, additional_properties: nil)
+                     company: OMIT, remote_was_deleted: OMIT, additional_properties: nil)
         @remote_id = remote_id if remote_id != OMIT
         @created_at = created_at if created_at != OMIT
         @modified_at = modified_at if modified_at != OMIT
@@ -54,6 +63,7 @@ module Merge
         @value = value if value != OMIT
         @sub_items = sub_items if sub_items != OMIT
         @company = company if company != OMIT
+        @remote_was_deleted = remote_was_deleted if remote_was_deleted != OMIT
         @additional_properties = additional_properties
         @_field_set = {
           "remote_id": remote_id,
@@ -62,7 +72,8 @@ module Merge
           "name": name,
           "value": value,
           "sub_items": sub_items,
-          "company": company
+          "company": company,
+          "remote_was_deleted": remote_was_deleted
         }.reject do |_k, v|
           v == OMIT
         end
@@ -82,6 +93,7 @@ module Merge
         value = parsed_json["value"]
         sub_items = parsed_json["sub_items"]
         company = parsed_json["company"]
+        remote_was_deleted = parsed_json["remote_was_deleted"]
         new(
           remote_id: remote_id,
           created_at: created_at,
@@ -90,6 +102,7 @@ module Merge
           value: value,
           sub_items: sub_items,
           company: company,
+          remote_was_deleted: remote_was_deleted,
           additional_properties: struct
         )
       end
@@ -115,6 +128,7 @@ module Merge
         obj.value&.is_a?(Float) != false || raise("Passed value for field obj.value is not the expected type, validation failed.")
         obj.sub_items&.is_a?(Array) != false || raise("Passed value for field obj.sub_items is not the expected type, validation failed.")
         obj.company&.is_a?(String) != false || raise("Passed value for field obj.company 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.")
       end
     end
   end

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

@@ -0,0 +1,12 @@
+# frozen_string_literal: true
+
+module Merge
+  module Accounting
+    # - `ACTIVE` - ACTIVE
+    #  - `INACTIVE` - INACTIVE
+    class Status895Enum
+      ACTIVE = "ACTIVE"
+      INACTIVE = "INACTIVE"
+    end
+  end
+end

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

@@ -0,0 +1,150 @@
+# frozen_string_literal: true
+
+require "date"
+require_relative "component_type_enum"
+require "ostruct"
+require "json"
+
+module Merge
+  module Accounting
+    # # The TaxRate Object
+    #  ### Description
+    #  The `TaxComponent` object is used to represent any sub-taxes that make up the
+    #  `TaxRate`.
+    #  ### Usage Example
+    #  Fetch from the `LIST TaxRates` endpoint and view tax components relevant to a
+    #  tax rate.
+    class TaxComponent
+      # @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 tax rate’s name.
+      attr_reader :name
+      # @return [String] The tax component’s rate.
+      attr_reader :rate
+      # @return [Boolean] Returns True if the tax component is compound, False if not.
+      attr_reader :is_compound
+      # @return [Merge::Accounting::ComponentTypeEnum] Returns PURCHASE if the tax component corresponds to a purchase tax or SALES if
+      #  the tax component corresponds to a sales tax.
+      #  - `SALES` - SALES
+      #  - `PURCHASE` - PURCHASE
+      attr_reader :component_type
+      # @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 [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 name [String] The tax rate’s name.
+      # @param rate [String] The tax component’s rate.
+      # @param is_compound [Boolean] Returns True if the tax component is compound, False if not.
+      # @param component_type [Merge::Accounting::ComponentTypeEnum] Returns PURCHASE if the tax component corresponds to a purchase tax or SALES if
+      #  the tax component corresponds to a sales tax.
+      #  - `SALES` - SALES
+      #  - `PURCHASE` - PURCHASE
+      # @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 additional_properties [OpenStruct] Additional properties unmapped to the current class definition
+      # @return [Merge::Accounting::TaxComponent]
+      def initialize(id: OMIT, remote_id: OMIT, created_at: OMIT, modified_at: OMIT, name: OMIT, rate: OMIT,
+                     is_compound: OMIT, component_type: OMIT, remote_was_deleted: 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
+        @name = name if name != OMIT
+        @rate = rate if rate != OMIT
+        @is_compound = is_compound if is_compound != OMIT
+        @component_type = component_type if component_type != OMIT
+        @remote_was_deleted = remote_was_deleted if remote_was_deleted != OMIT
+        @additional_properties = additional_properties
+        @_field_set = {
+          "id": id,
+          "remote_id": remote_id,
+          "created_at": created_at,
+          "modified_at": modified_at,
+          "name": name,
+          "rate": rate,
+          "is_compound": is_compound,
+          "component_type": component_type,
+          "remote_was_deleted": remote_was_deleted
+        }.reject do |_k, v|
+          v == OMIT
+        end
+      end
+
+      # Deserialize a JSON object to an instance of TaxComponent
+      #
+      # @param json_object [String]
+      # @return [Merge::Accounting::TaxComponent]
+      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?)
+        name = parsed_json["name"]
+        rate = parsed_json["rate"]
+        is_compound = parsed_json["is_compound"]
+        component_type = parsed_json["component_type"]
+        remote_was_deleted = parsed_json["remote_was_deleted"]
+        new(
+          id: id,
+          remote_id: remote_id,
+          created_at: created_at,
+          modified_at: modified_at,
+          name: name,
+          rate: rate,
+          is_compound: is_compound,
+          component_type: component_type,
+          remote_was_deleted: remote_was_deleted,
+          additional_properties: struct
+        )
+      end
+
+      # Serialize an instance of TaxComponent 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.name&.is_a?(String) != false || raise("Passed value for field obj.name is not the expected type, validation failed.")
+        obj.rate&.is_a?(String) != false || raise("Passed value for field obj.rate is not the expected type, validation failed.")
+        obj.is_compound&.is_a?(Boolean) != false || raise("Passed value for field obj.is_compound is not the expected type, validation failed.")
+        obj.component_type&.is_a?(Merge::Accounting::ComponentTypeEnum) != false || raise("Passed value for field obj.component_type 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.")
+      end
+    end
+  end
+end