ruby-brightpearl 0.12.0 → 0.14.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 4e872e28d8c8ed42ed2e30a141e6b37b709e857e11e506feefcd9ffba901398f
-  data.tar.gz: e73b1a317a93421b24fe84959d816edd0b5940243cd87a1f0e6fb56da9856c25
+  metadata.gz: 635fe340ac23fbdbe781fdbf36b08c2d9922aa87c4faca34877a451678d70aa4
+  data.tar.gz: 5c1979dbfc570f161fd993a021012db22d43690162403ffe3f61866e62c63674
 SHA512:
-  metadata.gz: b9e8a6fca6d64b1d641b24dbcdef1ef942ea4ddb6c8aae150800a2db1dd945712540d4159615ce4eb97a69d47d5b20f3062fe785369886dea0064d0fca27be9c
-  data.tar.gz: 2bee8f31a03585425df7c4527a78f8a7e29850534c6437ec1da87a95e72bcd78fa216052e6249be45d3c06b70e30ac308559090820f063d72c05a1c8a8d6217f
+  metadata.gz: 68575dc7b7c2099de4a8166b24ffa6276c3ccb1eb534d0e18f3d6b2c4aa6ea8839b9dfeb96c6be7d5d26969c37e217426e3afceb2bdcb81a97ed658b1c6a29eb
+  data.tar.gz: 0ec4fdc3afd8dd1f59849b3a0108b5692e4456f33535b21b3b712c4d987e0836975aa0fe2baec48c85ed821f869fe4203b0af5a5a3215828800c2c898141d045

data/CHANGELOG.md

@@ -1,5 +1,33 @@
 ## [Unreleased]
 
+## [0.14.0] - 2026-06-25
+
+### Added
+
+- New resource `ExchangeRate`
+  - Available operations: `GET`, `POST`, `PUT`
+
+- New resource `Currency`
+  - Available operations: `SEARCH`
+
+## [0.13.0] - 2026-06-03
+
+### Added
+
+- New contact reference resources `ContactTag`, `ContactGroup`, and `LeadSource`
+  - Available operations: `GET`
+  - Supports fetching the full list (no argument) or a specific record by id-set
+  - Note: `ContactTag` response is a Hash keyed by tag id, not an Array
+- New order reference resources `OrderType` and `OrderStockStatus`
+  - Available operations: `GET`
+  - Supports fetching the full list (no argument) or a specific record by id-set
+- New accounting reference resources `NominalCode` and `PaymentMethod`
+  - Available operations: `GET`
+  - Supports fetching the full list (no argument) or a specific record by id-set
+- New warehouse reference resource `ShippingMethod`
+  - Available operations: `GET`
+  - Supports fetching the full list (no argument) or a specific record by id-set
+
 ## [0.12.0] - 2026-06-02
 
 ### Added

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    ruby-brightpearl (0.12.0)
+    ruby-brightpearl (0.14.0)
       httparty (~> 0.20)
 
 GEM

data/lib/brightpearl/resources/contact_group.rb

@@ -0,0 +1,21 @@
+module Brightpearl
+  class ContactGroup < Resource
+    extend Brightpearl::APIOperations::Get
+    class << self
+      def resource_path
+        "contact-service/contact-group"
+      end
+
+      def get(id_set = nil)
+        if id_set
+          super
+        else
+          super(nil)
+        end
+      end
+
+      # https://api-docs.brightpearl.com/contact/contact-group/get.html
+
+    end
+  end
+end

data/lib/brightpearl/resources/contact_tag.rb

@@ -0,0 +1,21 @@
+module Brightpearl
+  class ContactTag < Resource
+    extend Brightpearl::APIOperations::Get
+    class << self
+      def resource_path
+        "contact-service/tag"
+      end
+
+      def get(id_set = nil)
+        if id_set
+          super
+        else
+          super(nil)
+        end
+      end
+
+      # https://api-docs.brightpearl.com/contact/tag/get.html
+
+    end
+  end
+end

data/lib/brightpearl/resources/currency.rb

@@ -0,0 +1,27 @@
+module Brightpearl
+  class Currency < Resource
+    attr_accessor :id, :title, :code, :symbol, :exchange_rate, :is_default,
+                  :exchange_rate_variance_nominal_code
+
+    class << self
+      # https://api-docs.brightpearl.com/accounting/currency/search.html
+      def search(query_params = {})
+        response = send_request(path: "accounting-service/currency-search?#{to_query(query_params)}", method: :get)
+        response.merge({
+          records: response[:payload]["response"]["results"].map { |item| Currency.new(item) }
+        })
+      end
+    end
+
+    # ARA => API Record Array
+    def initialize(ara)
+      @id                                    = ara[0]
+      @title                                 = ara[1]
+      @code                                  = ara[2]
+      @symbol                                = ara[3]
+      @exchange_rate                         = ara[4]
+      @is_default                            = ara[5]
+      @exchange_rate_variance_nominal_code   = ara[6]
+    end
+  end
+end

data/lib/brightpearl/resources/exchange_rate.rb

@@ -0,0 +1,20 @@
+module Brightpearl
+  class ExchangeRate < Resource
+    class << self
+      # https://api-docs.brightpearl.com/accounting/exchange-rate/get.html
+      def get
+        send_request(path: "accounting-service/exchange-rate/", method: :get)
+      end
+
+      # https://api-docs.brightpearl.com/accounting/exchange-rate/post.html
+      def post(currency_id:, **params)
+        send_request(path: "accounting-service/currency/#{currency_id}/exchange-rate", method: :post, body: params)
+      end
+
+      # https://api-docs.brightpearl.com/accounting/exchange-rate/put.html
+      def put(currency_id:, **params)
+        send_request(path: "accounting-service/currency/#{currency_id}/exchange-rate", method: :put, body: params)
+      end
+    end
+  end
+end

data/lib/brightpearl/resources/lead_source.rb

@@ -0,0 +1,21 @@
+module Brightpearl
+  class LeadSource < Resource
+    extend Brightpearl::APIOperations::Get
+    class << self
+      def resource_path
+        "contact-service/lead-source"
+      end
+
+      def get(id_set = nil)
+        if id_set
+          super
+        else
+          super(nil)
+        end
+      end
+
+      # https://api-docs.brightpearl.com/contact/lead-source/get.html
+
+    end
+  end
+end

data/lib/brightpearl/resources/nominal_code.rb

@@ -0,0 +1,21 @@
+module Brightpearl
+  class NominalCode < Resource
+    extend Brightpearl::APIOperations::Get
+    class << self
+      def resource_path
+        "accounting-service/nominal-code"
+      end
+
+      def get(id_set = nil)
+        if id_set
+          super
+        else
+          super(nil)
+        end
+      end
+
+      # https://api-docs.brightpearl.com/accounting/nominal-code/get.html
+
+    end
+  end
+end

data/lib/brightpearl/resources/order_stock_status.rb

@@ -0,0 +1,21 @@
+module Brightpearl
+  class OrderStockStatus < Resource
+    extend Brightpearl::APIOperations::Get
+    class << self
+      def resource_path
+        "order-service/order-stock-status"
+      end
+
+      def get(id_set = nil)
+        if id_set
+          super
+        else
+          super(nil)
+        end
+      end
+
+      # https://api-docs.brightpearl.com/order/order-stock-status/get.html
+
+    end
+  end
+end

data/lib/brightpearl/resources/order_type.rb

@@ -0,0 +1,21 @@
+module Brightpearl
+  class OrderType < Resource
+    extend Brightpearl::APIOperations::Get
+    class << self
+      def resource_path
+        "order-service/order-type"
+      end
+
+      def get(id_set = nil)
+        if id_set
+          super
+        else
+          super(nil)
+        end
+      end
+
+      # https://api-docs.brightpearl.com/order/order-type/get.html
+
+    end
+  end
+end

data/lib/brightpearl/resources/payment_method.rb

@@ -0,0 +1,21 @@
+module Brightpearl
+  class PaymentMethod < Resource
+    extend Brightpearl::APIOperations::Get
+    class << self
+      def resource_path
+        "accounting-service/payment-method"
+      end
+
+      def get(id_set = nil)
+        if id_set
+          super
+        else
+          super(nil)
+        end
+      end
+
+      # https://api-docs.brightpearl.com/accounting/payment-method/get.html
+
+    end
+  end
+end

data/lib/brightpearl/resources/shipping_method.rb

@@ -0,0 +1,21 @@
+module Brightpearl
+  class ShippingMethod < Resource
+    extend Brightpearl::APIOperations::Get
+    class << self
+      def resource_path
+        "warehouse-service/shipping-method"
+      end
+
+      def get(id_set = nil)
+        if id_set
+          super
+        else
+          super(nil)
+        end
+      end
+
+      # https://api-docs.brightpearl.com/warehouse/shipping-method/get.html
+
+    end
+  end
+end

data/lib/brightpearl/resources.rb

@@ -4,6 +4,9 @@ require 'brightpearl/resource'
 require 'brightpearl/resources/contact'
 require 'brightpearl/resources/contact_custom_field'
 require 'brightpearl/resources/contact_custom_field_metadata'
+require 'brightpearl/resources/contact_group'
+require 'brightpearl/resources/contact_tag'
+require 'brightpearl/resources/lead_source'
 
 # Orders
 require 'brightpearl/resources/order'
@@ -13,6 +16,8 @@ require 'brightpearl/resources/order_status'
 require 'brightpearl/resources/order_status_update'
 require 'brightpearl/resources/order_custom_field'
 require 'brightpearl/resources/order_custom_field_metadata'
+require 'brightpearl/resources/order_stock_status'
+require 'brightpearl/resources/order_type'
 
 require 'brightpearl/resources/goods_out_note'
 
@@ -29,6 +34,7 @@ require 'brightpearl/resources/channel'
 require 'brightpearl/resources/product_category'
 require 'brightpearl/resources/product_type'
 require 'brightpearl/resources/warehouse'
+require 'brightpearl/resources/shipping_method'
 
 # Integration
 require 'brightpearl/resources/webhook'
@@ -36,3 +42,7 @@ require 'brightpearl/resources/webhook'
 # Accounting
 require 'brightpearl/resources/tax_code'
 require 'brightpearl/resources/customer_payment'
+require 'brightpearl/resources/nominal_code'
+require 'brightpearl/resources/payment_method'
+require 'brightpearl/resources/exchange_rate'
+require 'brightpearl/resources/currency'

data/lib/brightpearl/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module Brightpearl
-  VERSION = "0.12.0"
+  VERSION = "0.14.0"
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: ruby-brightpearl
 version: !ruby/object:Gem::Version
-  version: 0.12.0
+  version: 0.14.0
 platform: ruby
 authors:
 - vicvans20
@@ -157,8 +157,14 @@ files:
 - lib/brightpearl/resources/contact.rb
 - lib/brightpearl/resources/contact_custom_field.rb
 - lib/brightpearl/resources/contact_custom_field_metadata.rb
+- lib/brightpearl/resources/contact_group.rb
+- lib/brightpearl/resources/contact_tag.rb
+- lib/brightpearl/resources/currency.rb
 - lib/brightpearl/resources/customer_payment.rb
+- lib/brightpearl/resources/exchange_rate.rb
 - lib/brightpearl/resources/goods_out_note.rb
+- lib/brightpearl/resources/lead_source.rb
+- lib/brightpearl/resources/nominal_code.rb
 - lib/brightpearl/resources/order.rb
 - lib/brightpearl/resources/order_custom_field.rb
 - lib/brightpearl/resources/order_custom_field_metadata.rb
@@ -166,6 +172,9 @@ files:
 - lib/brightpearl/resources/order_shipping_status.rb
 - lib/brightpearl/resources/order_status.rb
 - lib/brightpearl/resources/order_status_update.rb
+- lib/brightpearl/resources/order_stock_status.rb
+- lib/brightpearl/resources/order_type.rb
+- lib/brightpearl/resources/payment_method.rb
 - lib/brightpearl/resources/price_list.rb
 - lib/brightpearl/resources/product.rb
 - lib/brightpearl/resources/product_availability.rb
@@ -173,6 +182,7 @@ files:
 - lib/brightpearl/resources/product_custom_field_metadata.rb
 - lib/brightpearl/resources/product_price.rb
 - lib/brightpearl/resources/product_type.rb
+- lib/brightpearl/resources/shipping_method.rb
 - lib/brightpearl/resources/tax_code.rb
 - lib/brightpearl/resources/warehouse.rb
 - lib/brightpearl/resources/webhook.rb