ruby-brightpearl 0.10.0 → 0.11.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: b9e05da1a90bbe24c05beed8a083e43a77c4c22376af84e12f37d8ea3e6eeba8
-  data.tar.gz: 5f06f50c457a8be89f53181353c77c91dccbcf7d782de0096af6183eaae4358f
+  metadata.gz: de2c63aae118383c79591261adf50e2c73511d3a3939591288937883892c3a76
+  data.tar.gz: f54a265866ae77e46343e6701801aa0c994431955850a31015bcea675b773d3a
 SHA512:
-  metadata.gz: 5053255b92df81af25092d34b469b85bdf8a989c365f5654e018889b8de5e73aab963d5c7b6425849edcccab488ecab2d92f1bef2aa8c7a954d6bf96ab570e51
-  data.tar.gz: 9e377fe15a59fa1db5593521f5ac56f9d138c6e8cd823dca0b83d821f28fdfb6c81bfc8f7bd230f339dddc40a3b6918e968747416e683705c5d3d94e8d78b112
+  metadata.gz: 0be98a97c29dbfe0239ee63fed3b270dcfd688d284e71178e192c5b3527c4d893e8bc9919a4b87de3d56bc086dd410ea50fba481f30d23bcbfc07b8aee9ca7ed
+  data.tar.gz: a721a3a87235c91a7520e0db43bbb00d91df3d4de7934bc5cf991e4a81644825cda5bbddca7fb9f24ed341a9ea61fcf82d455f3691b3c6952087ab8b1d4c8b32

data/CHANGELOG.md

@@ -1,5 +1,13 @@
 ## [Unreleased]
 
+## [0.11.0] - 2026-05-08
+
+### Added
+
+- New resources `ContactCustomFieldMetadata`, `OrderCustomFieldMetadata`, and `ProductCustomFieldMetadata`
+  - Available operations: `GET`
+  - Useful to get the available custom fields for a contact, order, or product and their metadata (name, type, list of values, etc.)
+
 ## [0.10.0] - 2026-04-17
 
 ### Added

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    ruby-brightpearl (0.10.0)
+    ruby-brightpearl (0.11.0)
       httparty (~> 0.20)
 
 GEM
@@ -10,7 +10,7 @@ GEM
     addressable (2.8.0)
       public_suffix (>= 2.0.2, < 5.0)
     base64 (0.3.0)
-    bigdecimal (4.1.1)
+    bigdecimal (4.1.2)
     byebug (11.1.3)
     coderay (1.1.3)
     crack (0.4.5)
@@ -25,7 +25,7 @@ GEM
       multi_xml (>= 0.5.2)
     method_source (1.1.0)
     mini_mime (1.1.5)
-    multi_xml (0.8.1)
+    multi_xml (0.9.1)
       bigdecimal (>= 3.1, < 5)
     pry (0.15.2)
       coderay (~> 1.1)

data/lib/brightpearl/resources/contact_custom_field_metadata.rb

@@ -0,0 +1,26 @@
+module Brightpearl
+  # https://api-docs.brightpearl.com/contact/custom-field-meta-data/get.html
+  class ContactCustomFieldMetadata < Resource
+    VALID_CONTACT_TYPES = ["customer", "supplier"].freeze
+
+    class << self
+      def get(contact_type, id_set = nil)
+        contact_type = contact_type.to_s
+        validate_contact_type!(contact_type)
+
+        path = "contact-service/#{contact_type}/custom-field-meta-data"
+        path = "#{path}/#{id_set}" if id_set
+
+        send_request(path: path, method: :get)
+      end
+
+      private
+
+      def validate_contact_type!(contact_type)
+        return if VALID_CONTACT_TYPES.include?(contact_type)
+
+        raise ArgumentError, "Invalid contact custom field metadata type: #{contact_type.inspect}. Valid types: #{VALID_CONTACT_TYPES.join(', ')}"
+      end
+    end
+  end
+end

data/lib/brightpearl/resources/order_custom_field_metadata.rb

@@ -0,0 +1,26 @@
+module Brightpearl
+  # https://api-docs.brightpearl.com/order/customfield-metadata/get.html
+  class OrderCustomFieldMetadata < Resource
+    VALID_ORDER_TYPES = ["sale", "purchase"].freeze
+
+    class << self
+      def get(order_type, id_set = nil)
+        order_type = order_type.to_s
+        validate_order_type!(order_type)
+
+        path = "order-service/#{order_type}/custom-field-meta-data"
+        path = "#{path}/#{id_set}" if id_set
+
+        send_request(path: path, method: :get)
+      end
+
+      private
+
+      def validate_order_type!(order_type)
+        return if VALID_ORDER_TYPES.include?(order_type)
+
+        raise ArgumentError, "Invalid order custom field metadata type: #{order_type.inspect}. Valid types: #{VALID_ORDER_TYPES.join(', ')}"
+      end
+    end
+  end
+end

data/lib/brightpearl/resources/product_custom_field_metadata.rb

@@ -0,0 +1,13 @@
+module Brightpearl
+  # https://api-docs.brightpearl.com/product/product-custom-field-metadata/get.html
+  class ProductCustomFieldMetadata < Resource
+    class << self
+      def get(id_set = nil)
+        path = "product-service/product/custom-field-meta-data"
+        path = "#{path}/#{id_set}" if id_set
+
+        send_request(path: path, method: :get)
+      end
+    end
+  end
+end

data/lib/brightpearl/resources.rb

@@ -2,6 +2,7 @@ require 'brightpearl/resource'
 
 require 'brightpearl/resources/contact'
 require 'brightpearl/resources/contact_custom_field'
+require 'brightpearl/resources/contact_custom_field_metadata'
 
 require 'brightpearl/resources/order'
 require 'brightpearl/resources/order_row'
@@ -9,6 +10,7 @@ require 'brightpearl/resources/order_shipping_status'
 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/goods_out_note'
 
@@ -16,6 +18,7 @@ require 'brightpearl/resources/product'
 require 'brightpearl/resources/product_price'
 require 'brightpearl/resources/price_list'
 require 'brightpearl/resources/product_availability'
+require 'brightpearl/resources/product_custom_field_metadata'
 
 # Integration
 require 'brightpearl/resources/webhook'

data/lib/brightpearl/version.rb

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

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: ruby-brightpearl
 version: !ruby/object:Gem::Version
-  version: 0.10.0
+  version: 0.11.0
 platform: ruby
 authors:
 - vicvans20
@@ -154,10 +154,12 @@ files:
 - lib/brightpearl/resources.rb
 - lib/brightpearl/resources/contact.rb
 - lib/brightpearl/resources/contact_custom_field.rb
+- lib/brightpearl/resources/contact_custom_field_metadata.rb
 - lib/brightpearl/resources/customer_payment.rb
 - lib/brightpearl/resources/goods_out_note.rb
 - lib/brightpearl/resources/order.rb
 - lib/brightpearl/resources/order_custom_field.rb
+- lib/brightpearl/resources/order_custom_field_metadata.rb
 - lib/brightpearl/resources/order_row.rb
 - lib/brightpearl/resources/order_shipping_status.rb
 - lib/brightpearl/resources/order_status.rb
@@ -165,6 +167,7 @@ files:
 - lib/brightpearl/resources/price_list.rb
 - lib/brightpearl/resources/product.rb
 - lib/brightpearl/resources/product_availability.rb
+- lib/brightpearl/resources/product_custom_field_metadata.rb
 - lib/brightpearl/resources/product_price.rb
 - lib/brightpearl/resources/tax_code.rb
 - lib/brightpearl/resources/webhook.rb