dear_inventory 0.2.0

data/lib/dear_inventory/models/sales/manual_journal.rb

@@ -0,0 +1,24 @@
+# typed: strong
+# frozen_string_literal: true
+
+module DearInventory
+  module Models
+    module Sales
+      class ManualJournal < DearInventory::Model
+        extend T::Sig
+
+        fields({
+          Status: {
+            name: :status,
+            type: :String,
+          },
+          Lines: {
+            name: :lines,
+            type: :Array,
+            model: DearInventory::Models::Sales::ManualJournalLine,
+          },
+        })
+      end
+    end
+  end
+end

data/lib/dear_inventory/models/sales/manual_journal_line.rb

@@ -0,0 +1,35 @@
+# typed: strong
+# frozen_string_literal: true
+
+module DearInventory
+  module Models
+    module Sales
+      class ManualJournalLine < DearInventory::Model
+        extend T::Sig
+
+        fields({
+          Reference: {
+            name: :reference,
+            type: :String,
+          },
+          Amount: {
+            name: :amount,
+            type: :Numeric,
+          },
+          Date: {
+            name: :date,
+            type: :DateTime,
+          },
+          Debit: {
+            name: :debit,
+            type: :String,
+          },
+          Credit: {
+            name: :credit,
+            type: :String,
+          },
+        })
+      end
+    end
+  end
+end

data/lib/dear_inventory/models/sales/order.rb

@@ -0,0 +1,49 @@
+# typed: strong
+# frozen_string_literal: true
+
+module DearInventory
+  module Models
+    module Sales
+      class Order < DearInventory::Model
+        extend T::Sig
+
+        fields({
+          SaleOrderNumber: {
+            name: :sale_order_number,
+            type: :String,
+          },
+          Memo: {
+            name: :memo,
+            type: :String,
+          },
+          Status: {
+            name: :status,
+            type: :String,
+          },
+          Lines: {
+            name: :lines,
+            type: :Array,
+            model: DearInventory::Models::Sales::Line,
+          },
+          AdditionalCharges: {
+            name: :additional_charges,
+            type: :Array,
+            model: DearInventory::Models::AdditionalCharge,
+          },
+          TotalBeforeTax: {
+            name: :total_before_tax,
+            type: :Numeric,
+          },
+          Tax: {
+            name: :tax,
+            type: :Numeric,
+          },
+          Total: {
+            name: :total,
+            type: :Numeric,
+          },
+        })
+      end
+    end
+  end
+end

data/lib/dear_inventory/models/sales/payment_line.rb

@@ -0,0 +1,43 @@
+# typed: strong
+# frozen_string_literal: true
+
+module DearInventory
+  module Models
+    module Sales
+      class PaymentLine < DearInventory::Model
+        extend T::Sig
+
+        fields({
+          ID: {
+            name: :id,
+            type: :Guid,
+          },
+          Reference: {
+            name: :reference,
+            type: :String,
+          },
+          Amount: {
+            name: :amount,
+            type: :Numeric,
+          },
+          DatePaid: {
+            name: :date_paid,
+            type: :DateTime,
+          },
+          Account: {
+            name: :account,
+            type: :String,
+          },
+          CurrencyRate: {
+            name: :currency_rate,
+            type: :Numeric,
+          },
+          DateCreated: {
+            name: :date_created,
+            type: :DateTime,
+          },
+        })
+      end
+    end
+  end
+end

data/lib/dear_inventory/models/sales/quote.rb

@@ -0,0 +1,50 @@
+# typed: strong
+# frozen_string_literal: true
+
+module DearInventory
+  module Models
+    module Sales
+      class Quote < DearInventory::Model
+        extend T::Sig
+
+        fields({
+          Memo: {
+            name: :memo,
+            type: :String,
+          },
+          Status: {
+            name: :status,
+            type: :String,
+          },
+          Prepayments: {
+            name: :prepayments,
+            type: :Array,
+            model: DearInventory::Models::Sales::PaymentLine,
+          },
+          Lines: {
+            name: :lines,
+            type: :Array,
+            model: DearInventory::Models::Sales::Line,
+          },
+          AdditionalCharges: {
+            name: :additional_charges,
+            type: :Array,
+            model: DearInventory::Models::AdditionalCharge,
+          },
+          TotalBeforeTax: {
+            name: :total_before_tax,
+            type: :Numeric,
+          },
+          Tax: {
+            name: :tax,
+            type: :Numeric,
+          },
+          Total: {
+            name: :total,
+            type: :Numeric,
+          },
+        })
+      end
+    end
+  end
+end

data/lib/dear_inventory/models/shipping_address.rb

@@ -0,0 +1,25 @@
+# typed: strong
+# frozen_string_literal: true
+
+module DearInventory
+  module Models
+    class ShippingAddress < Address
+      extend T::Sig
+
+      fields({
+        Company: {
+          name: :company,
+          type: :String,
+        },
+        Contact: {
+          name: :contact,
+          type: :String,
+        },
+        ShipToOther: {
+          name: :ship_to_other,
+          type: :Boolean,
+        },
+      })
+    end
+  end
+end

data/lib/dear_inventory/models/transaction.rb

@@ -0,0 +1,41 @@
+# typed: strong
+# frozen_string_literal: true
+
+module DearInventory
+  module Models
+    class Transaction < DearInventory::Model
+      extend T::Sig
+
+      fields({
+        TaskID: {
+          name: :task_id,
+          type: :Guid,
+        },
+        TransactionID: {
+          name: :transaction_id,
+          type: :Guid,
+        },
+        Debit: {
+          name: :debit,
+          type: :String,
+        },
+        Credit: {
+          name: :credit,
+          type: :String,
+        },
+        Description: {
+          name: :description,
+          type: :String,
+        },
+        Amount: {
+          name: :credit,
+          type: :Numeric,
+        },
+        EffectiveDate: {
+          name: :description,
+          type: :DateTime,
+        },
+      })
+    end
+  end
+end

data/lib/dear_inventory/parameters.rb

@@ -0,0 +1,209 @@
+# typed: strict
+# frozen_string_literal: true
+
+module DearInventory
+  class Parameters
+    extend T::Sig
+    extend DearInventory::IsASubclass
+
+    sig { params(params: T::Hash[Symbol, T.untyped]).void }
+    def initialize(params)
+      @values = T.let({}, T::Hash[Symbol, T.untyped])
+      assign_params(params)
+    end
+
+    class << self
+      extend T::Sig
+
+      sig do
+        params(
+          fields: T::Hash[
+            Symbol, T::Hash[Symbol, T.any(Symbol, T::Array[String], T::Boolean)]
+          ]
+        ).void
+      end
+      def fields(fields)
+        const_set(:FIELDS, fields.freeze)
+
+        fields.each do |name, specifications|
+          define_method_for_validator(name, specifications)
+        end
+      end
+
+      sig do
+        params(
+          resource_class: T.untyped,
+          endpoint: T.nilable(String),
+          params: T::Hash[Symbol, T.untyped]
+        ).returns(T.untyped)
+      end
+      def convert(resource_class, endpoint, params)
+        resource = resource_class.name.split("::").last
+        params_class = DearInventory::EndpointClass.(
+          class_type: "Parameters",
+          resource_class: resource_class,
+          endpoint: endpoint
+        )
+        params_class = T.cast(
+          params_class,
+          T.class_of(DearInventory::Parameters)
+        )
+
+        convert_with_params_class(
+          endpoint: endpoint, params_class: params_class,
+          resource_class: resource_class, params: params
+        )
+      end
+
+      private
+
+      sig do
+        params(
+          name: Symbol,
+          specifications: T::Hash[
+            Symbol, T.any(Symbol, T::Array[String], T::Boolean)
+          ]
+        ).void
+      end
+      def define_method_for_validator(name, specifications)
+        case specifications[:type]
+        when :Enum
+          define_enum_method(name, specifications)
+        when :String
+          define_string_method(
+            name,
+            T.cast(specifications, T::Hash[Symbol, T.any(Symbol, T::Boolean)])
+          )
+        else
+          define_method_without_options(
+            name,
+            T.cast(specifications, T::Hash[Symbol, T.any(Symbol, T::Boolean)])
+          )
+        end
+      end
+
+      sig do
+        params(
+          name: Symbol,
+          specifications: T::Hash[
+            Symbol, T.any(Symbol, T::Array[String], T::Boolean)
+          ]
+        ).void
+      end
+      def define_enum_method(name, specifications)
+        validator = DearInventory::Validators::Enum
+        options = {
+          values: specifications[:values]
+        }
+        define_method_with_options(name, validator, options)
+      end
+
+      sig do
+        params(
+          name: Symbol,
+          specifications: T::Hash[Symbol, T.any(Symbol, T::Boolean)]
+        ).void
+      end
+      def define_string_method(name, specifications)
+        validator = DearInventory::Validators::String
+        options = {
+          max_length: specifications[:max_length]
+        }
+        define_method_with_options(name, validator, options)
+      end
+
+      sig do
+        params(
+          name: Symbol,
+          validator: T.class_of(DearInventory::Validator),
+          options: T::Hash[
+            Symbol, T.nilable(T.any(Symbol, T::Array[String], T::Boolean))
+          ],
+        ).void
+      end
+      def define_method_with_options(name, validator, options)
+        define_method("#{name}=") do |value|
+          validator.(
+            name,
+            value,
+            options: options
+          )
+
+          T.unsafe(self).instance_variable_get(:@values)[name] = value
+        end
+      end
+
+      sig do
+        params(
+          name: Symbol,
+          specifications: T::Hash[Symbol, T.any(Symbol, T::Boolean)]
+        ).void
+      end
+      def define_method_without_options(name, specifications)
+        validator = Object.const_get(
+          "DearInventory::Validators::#{specifications[:type]}"
+        )
+        define_method("#{name}=") do |value|
+          validator.(name, value)
+          T.unsafe(self).instance_variable_get(:@values)[name] = value
+        end
+      end
+
+      sig do
+        params(
+          params_class: T.nilable(T.class_of(DearInventory::Parameters)),
+          resource_class: DearInventory::Resource,
+          endpoint: T.nilable(String),
+          params: T::Hash[Symbol, T.untyped]
+        ).returns(T.nilable(DearInventory::Parameters))
+      end
+      def convert_with_params_class(
+        params_class:, resource_class:, endpoint:, params:
+      )
+        return params_class.new(params) unless params_class.nil?
+
+        message = "No parameters class can be found for resource, " \
+          "#{resource_class}, with endpoint #{endpoint}"
+        raise ArgumentError, message
+      end
+    end
+
+    sig { returns(T::Hash[Symbol, T.untyped]) }
+    def to_h
+      self.class.
+        const_get(:FIELDS).
+        each_with_object({}) do |(field_name, specifications), hash|
+          value = parameter_value(field_name, specifications)
+          next if value.nil?
+
+          hash[specifications[:property]] = value
+        end
+    end
+
+    private
+
+    sig do
+      params(
+        field_name: Symbol,
+        specifications: T::Hash[Symbol, T.untyped]
+      ).returns(T.nilable(T.any(String, Numeric, T::Boolean)))
+    end
+    def parameter_value(field_name, specifications)
+      value = @values[field_name]
+      Validators::Required.(field_name, value) if specifications[:required]
+
+      if value.respond_to?(:strftime)
+        ::DearInventory::DateTime.new(value).to_s
+      else
+        value
+      end
+    end
+
+    sig { params(params: T::Hash[Symbol, T.untyped]).void }
+    def assign_params(params)
+      params.each do |name, value|
+        __send__(:"#{name}=", value)
+      end
+    end
+  end
+end