dear_inventory 0.6.3 → 0.7.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 05d549644157f0bd95430f8e30866a20f3c769e19d0d59a5481df5fa61a4d1d1
-  data.tar.gz: eb528d6d5dcc603a5aba7cc61459094f5fd7214486f9bc9b6afe9021c29a94b0
+  metadata.gz: 86c0378bf7a1cc54d02cd122095212afd620a16346df8e3be7c09802f4a854e3
+  data.tar.gz: d014ae24576d120bb54f67283c1d6f1348d388e0a686d989e60e345801f687df
 SHA512:
-  metadata.gz: 5148564599d630c5f71e64ea7b68d5daa4821df32127b831bab7e2a5a636284dda7e0643b08d7a0923d9587d125b97799f1b7712dc8823065c6017d69e8a69bc
-  data.tar.gz: dca2d9014270f6eed041525bcfb07630aa08a7923564bf90142b09cb2e476f2f3a7c6a5e9ccedee15cc682c55a74f0e171642effcb419cffc1d7365ae90fd5d4
+  metadata.gz: 473179f9c82e9575ab601576b6b79db220a3fb6c6b7718b9b5e39e4ef5f5cb3aac5fd68b6291a69144bbf7c4ce7982686764b8aba33c2f34fd74422d41fc26e1
+  data.tar.gz: 6fe8d252829187df5f95f21f2986e01f316e4f7890cb76bdbdf882cde7432d05d652b5bbaf3e127648f4a2977a9be87dd6de42acd0b516f232589a9dce8fde6f

data/.rubocop.yml

@@ -7,7 +7,7 @@ AllCops:
   Exclude:
     - bin/**/*
 
-Layout/AlignParameters:
+Layout/ParameterAlignment:
   EnforcedStyle: with_fixed_indentation
 
 Layout/DotPosition:
@@ -17,7 +17,7 @@ Layout/EndAlignment:
   AutoCorrect: true
   EnforcedStyleAlignWith: variable
 
-Layout/IndentFirstArrayElement:
+Layout/FirstArrayElementIndentation:
   EnforcedStyle: consistent
 
 Layout/MultilineMethodCallIndentation:
@@ -36,6 +36,7 @@ Metrics/BlockLength:
     - spec/**/*
 
 Metrics/ClassLength:
+  Max: 150
   Exclude:
     - lib/dear_inventory/models/**/*
 

data/lib/dear_inventory/model.rb

@@ -55,6 +55,8 @@ module DearInventory
 
     private
 
+    # rubocop:disable Metrics/AbcSize
+    # rubocop:disable Metrics/CyclomaticComplexity
     # rubocop:disable Metrics/MethodLength
     sig do
       params(
@@ -87,6 +89,8 @@ module DearInventory
         value
       end
     end
+    # rubocop:enable Metrics/AbcSize
+    # rubocop:enable Metrics/CyclomaticComplexity
     # rubocop:enable Metrics/MethodLength
 
     sig do

data/lib/dear_inventory/models/customer.rb

@@ -0,0 +1,135 @@
+# typed: strong
+# frozen_string_literal: true
+
+module DearInventory
+  module Models
+    class Customer < DearInventory::Model
+      extend T::Sig
+
+      fields(
+        ID: {
+          name: :id,
+          type: :Guid,
+        },
+        Name: {
+          name: :name,
+          type: :String,
+        },
+        Status: {
+          name: :status,
+          type: :String,
+        },
+        Currency: {
+          name: :currency,
+          type: :String,
+        },
+        PaymentTerm: {
+          name: :payment_term,
+          type: :String,
+        },
+        AccountReceivable: {
+          name: :account_receivable,
+          type: :String,
+        },
+        RevenueAccount: {
+          name: :revenue_account,
+          type: :String,
+        },
+        TaxRule: {
+          name: :tax_rule,
+          type: :String,
+        },
+        PriceTier: {
+          name: :price_tier,
+          type: :String,
+        },
+        Carrier: {
+          name: :carrier,
+          type: :String,
+        },
+        SalesRepresentative: {
+          name: :sales_representative,
+          type: :String,
+        },
+        Location: {
+          name: :location,
+          type: :String,
+        },
+        Discount: {
+          name: :discount,
+          type: :Integer,
+        },
+        Comments: {
+          name: :comments,
+          type: :String,
+        },
+        TaxNumber: {
+          name: :tax_number,
+          type: :Integer,
+        },
+        CreditLimit: {
+          name: :credit_limit,
+          type: :Integer,
+        },
+        Tag: {
+          name: :tag,
+          type: :String,
+        },
+        AttributeSet: {
+          name: :attribute_set,
+          type: :String,
+        },
+        AdditionalAttribute1: {
+          name: :additional_attribute_1,
+          type: :String,
+        },
+        AdditionalAttribute2: {
+          name: :additional_attribute_2,
+          type: :String,
+        },
+        AdditionalAttribute3: {
+          name: :additional_attribute_3,
+          type: :String,
+        },
+        AdditionalAttribute4: {
+          name: :additional_attribute_4,
+          type: :String,
+        },
+        AdditionalAttribute5: {
+          name: :additional_attribute_5,
+          type: :String,
+        },
+        AdditionalAttribute6: {
+          name: :additional_attribute_6,
+          type: :String,
+        },
+        AdditionalAttribute7: {
+          name: :additional_attribute_7,
+          type: :String,
+        },
+        AdditionalAttribute8: {
+          name: :additional_attribute_8,
+          type: :String,
+        },
+        AdditionalAttribute9: {
+          name: :additional_attribute_9,
+          type: :String,
+        },
+        LastModifiedOn: {
+          name: :last_modified_on,
+          type: :String,
+        },
+        Addresses: {
+          name: :addresses,
+          type: :Array,
+          model: DearInventory::Models::Customers::Address,
+        },
+        Contacts: {
+          name: :contacts,
+          type: :Array,
+          model: DearInventory::Models::Customers::Contact,
+        }
+      )
+    end
+  end
+end

data/lib/dear_inventory/models/customers/address.rb

@@ -0,0 +1,51 @@
+# typed: strong
+# frozen_string_literal: true
+
+module DearInventory
+  module Models
+    class Customers < DearInventory::Model
+      class Address < DearInventory::Model
+        extend T::Sig
+
+        fields(
+          TaskID: {
+            name: :task_id,
+            type: :Guid,
+          },
+          Line1: {
+            name: :line_1,
+            type: :String,
+          },
+          Line2: {
+            name: :line_2,
+            type: :String,
+          },
+          City: {
+            name: :city,
+            type: :String,
+          },
+          State: {
+            name: :state,
+            type: :String,
+          },
+          Postcode: {
+            name: :postcode,
+            type: :String,
+          },
+          Country: {
+            name: :country,
+            type: :String,
+          },
+          Type: {
+            name: :type,
+            type: :String,
+          },
+          DefaultForType: {
+            name: :default_for_type,
+            type: :Boolean,
+          }
+        )
+      end
+    end
+  end
+end

data/lib/dear_inventory/models/customers/contact.rb

@@ -0,0 +1,55 @@
+# typed: strong
+# frozen_string_literal: true
+
+module DearInventory
+  module Models
+    class Customers < DearInventory::Model
+      class Contact < DearInventory::Model
+        extend T::Sig
+
+        fields(
+          ID: {
+            name: :id,
+            type: :Guid,
+          },
+          Name: {
+            name: :name,
+            type: :Guid,
+          },
+          Phone: {
+            name: :phone,
+            type: :Guid,
+          },
+          MobilePhone: {
+            name: :mobile_phone,
+            type: :Guid,
+          },
+          Fax: {
+            name: :fax,
+            type: :Guid,
+          },
+          Email: {
+            name: :email,
+            type: :Guid,
+          },
+          Website: {
+            name: :website,
+            type: :Guid,
+          },
+          Comment: {
+            name: :comment,
+            type: :Guid,
+          },
+          Default: {
+            name: :default,
+            type: :Guid,
+          },
+          IncludeInEmail: {
+            name: :include_in_email,
+            type: :Guid,
+          }
+        )
+      end
+    end
+  end
+end

data/lib/dear_inventory/models/customers.rb

@@ -0,0 +1,26 @@
+# typed: strong
+# frozen_string_literal: true
+
+module DearInventory
+  module Models
+    class Customers < DearInventory::Model
+      extend T::Sig
+
+      fields(
+        Total: {
+          name: :total,
+          type: :Integer,
+        },
+        Page: {
+          name: :page,
+          type: :Integer,
+        },
+        CustomerList: {
+          name: :customer_list,
+          type: :Array,
+          model: DearInventory::Models::Customer,
+        }
+      )
+    end
+  end
+end

data/lib/dear_inventory/models/product.rb

@@ -125,7 +125,7 @@ module DearInventory
         },
         PriceTiers: {
           name: :price_tiers,
-          type: :Untyped
+          type: :Untyped,
         },
         AverageCost: {
           name: :average_cost,

data/lib/dear_inventory/parameters/customer/index.rb

@@ -0,0 +1,45 @@
+# typed: strict
+# frozen_string_literal: true
+
+module DearInventory
+  class Parameters
+    module Customer
+      class Index < DearInventory::Parameters
+        extend T::Sig
+
+        fields(
+          id: {
+            property: :ID,
+            type: :Guid,
+            required: false,
+          },
+          page: {
+            property: :Page,
+            type: :Integer,
+            required: false,
+          },
+          limit: {
+            property: :Limit,
+            type: :Integer,
+            required: false,
+          },
+          name: {
+            property: :Name,
+            type: :String,
+            required: false,
+          },
+          modified_since: {
+            property: :ModifiedSince,
+            type: :DateTime,
+            required: false,
+          },
+          include_deprecated: {
+            property: :IncludeDeprecated,
+            type: :Boolean,
+            required: false,
+          }
+        )
+      end
+    end
+  end
+end

data/lib/dear_inventory/resources/customer.rb

@@ -0,0 +1,24 @@
+# typed: strict
+# frozen_string_literal: true
+
+module DearInventory
+  class Customer < Resource
+    class << self
+      extend T::Sig
+
+      # Customer
+      #
+      # @param params [Hash] URL query string parameters that conform to
+      #   DearInventory::Parameters::Customer::Index
+      sig do
+        params(params: T::Hash[Symbol, T.untyped]).
+          returns(DearInventory::Response)
+      end
+      def index(params = {})
+        new.request(
+          :get, params: params, model: DearInventory::Models::Customers
+        )
+      end
+    end
+  end
+end

data/lib/dear_inventory/version.rb

@@ -2,5 +2,5 @@
 # frozen_string_literal: true
 
 module DearInventory
-  VERSION = "0.6.3"
+  VERSION = "0.7.0"
 end

data/lib/dear_inventory.rb

@@ -23,6 +23,8 @@ require "dear_inventory/models/address"
 require "dear_inventory/models/attachment"
 require "dear_inventory/models/bill_of_materials_product"
 require "dear_inventory/models/bill_of_materials_service"
+require "dear_inventory/models/customers/address"
+require "dear_inventory/models/customers/contact"
 require "dear_inventory/models/inventory_movement"
 require "dear_inventory/models/products/movement"
 require "dear_inventory/models/purchase_list"
@@ -58,6 +60,8 @@ require "dear_inventory/models/sales/fulfilments/ship"
 require "dear_inventory/models/sales/fulfilment"
 require "dear_inventory/models/sale_lists"
 
+require "dear_inventory/models/customer"
+require "dear_inventory/models/customers"
 require "dear_inventory/models/product"
 require "dear_inventory/models/products"
 require "dear_inventory/models/purchases/credit_note"
@@ -79,6 +83,7 @@ require "dear_inventory/validators/string"
 require "dear_inventory/validators/time"
 
 require "dear_inventory/parameters"
+require "dear_inventory/parameters/customer/index"
 require "dear_inventory/parameters/product/index"
 require "dear_inventory/parameters/purchase/index"
 require "dear_inventory/parameters/purchase_list/index"
@@ -86,6 +91,7 @@ require "dear_inventory/parameters/sale/index"
 require "dear_inventory/parameters/sale_list/index"
 
 require "dear_inventory/resource"
+require "dear_inventory/resources/customer"
 require "dear_inventory/resources/product"
 require "dear_inventory/resources/purchase"
 require "dear_inventory/resources/purchase_list"
@@ -107,9 +113,11 @@ module DearInventory
     sig { returns(Config) }
     attr_reader :config
 
+    # rubocop:disable Lint/UnusedMethodArgument
     sig { params(block: T.proc.params(config: Config).void).void }
     def configure(&block)
       yield config
     end
+    # rubocop:enable Lint/UnusedMethodArgument
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: dear_inventory
 version: !ruby/object:Gem::Version
-  version: 0.6.3
+  version: 0.7.0
 platform: ruby
 authors:
 - Adam Rice
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2020-03-18 00:00:00.000000000 Z
+date: 2020-03-26 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: http
@@ -235,6 +235,10 @@ files:
 - lib/dear_inventory/models/attachment.rb
 - lib/dear_inventory/models/bill_of_materials_product.rb
 - lib/dear_inventory/models/bill_of_materials_service.rb
+- lib/dear_inventory/models/customer.rb
+- lib/dear_inventory/models/customers.rb
+- lib/dear_inventory/models/customers/address.rb
+- lib/dear_inventory/models/customers/contact.rb
 - lib/dear_inventory/models/inventory_movement.rb
 - lib/dear_inventory/models/product.rb
 - lib/dear_inventory/models/products.rb
@@ -280,12 +284,14 @@ files:
 - lib/dear_inventory/models/supplier.rb
 - lib/dear_inventory/models/transaction.rb
 - lib/dear_inventory/parameters.rb
+- lib/dear_inventory/parameters/customer/index.rb
 - lib/dear_inventory/parameters/product/index.rb
 - lib/dear_inventory/parameters/purchase/index.rb
 - lib/dear_inventory/parameters/purchase_list/index.rb
 - lib/dear_inventory/parameters/sale/index.rb
 - lib/dear_inventory/parameters/sale_list/index.rb
 - lib/dear_inventory/resource.rb
+- lib/dear_inventory/resources/customer.rb
 - lib/dear_inventory/resources/product.rb
 - lib/dear_inventory/resources/purchase.rb
 - lib/dear_inventory/resources/purchase_list.rb