ruby-brightpearl 0.9.0 → 0.11.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 7812b15f9e154a4f456e4f240064d16fa996f28dd4b7de7db71c0755251fb3ac
-  data.tar.gz: '0733425239130ce0c62fc11467a7b5b285f7bc0838421aa3acf680b2ed959c78'
+  metadata.gz: de2c63aae118383c79591261adf50e2c73511d3a3939591288937883892c3a76
+  data.tar.gz: f54a265866ae77e46343e6701801aa0c994431955850a31015bcea675b773d3a
 SHA512:
-  metadata.gz: 2d449c53b725ee84d975c72cce202952b729a8448ff2860863657a0bddf4b71a7895beeb7d0815404ba7413fe537173e24213cc525145f19b39450856b6aedc5
-  data.tar.gz: 8fd551ae744bfca7f9e2ca1f73087edda0ea7a32d89ccd6f0fa467672cc139e9c271757480dcca99f912e3fec63597e1c64177274b4fd71e8d36c7b6793df081
+  metadata.gz: 0be98a97c29dbfe0239ee63fed3b270dcfd688d284e71178e192c5b3527c4d893e8bc9919a4b87de3d56bc086dd410ea50fba481f30d23bcbfc07b8aee9ca7ed
+  data.tar.gz: a721a3a87235c91a7520e0db43bbb00d91df3d4de7934bc5cf991e4a81644825cda5bbddca7fb9f24ed341a9ea61fcf82d455f3691b3c6952087ab8b1d4c8b32

data/CHANGELOG.md

@@ -1,5 +1,20 @@
 ## [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
+
+- New resource `CustomerPayment`
+  - Available operations: `SEARCH`, `POST`, `DELETE`
+
 ## [0.9.0] - 2025-12-10
 
 ### Changed

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    ruby-brightpearl (0.9.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 (3.3.1)
+    bigdecimal (4.1.2)
     byebug (11.1.3)
     coderay (1.1.3)
     crack (0.4.5)
@@ -19,14 +19,14 @@ GEM
     diff-lcs (1.5.0)
     dotenv (3.1.8)
     hashdiff (1.0.1)
-    httparty (0.23.2)
+    httparty (0.24.2)
       csv
       mini_mime (>= 1.0.0)
       multi_xml (>= 0.5.2)
     method_source (1.1.0)
     mini_mime (1.1.5)
-    multi_xml (0.7.2)
-      bigdecimal (~> 3.1)
+    multi_xml (0.9.1)
+      bigdecimal (>= 3.1, < 5)
     pry (0.15.2)
       coderay (~> 1.1)
       method_source (~> 1.0)
@@ -54,6 +54,7 @@ GEM
       hashdiff (>= 0.4.0, < 2.0.0)
 
 PLATFORMS
+  arm64-darwin-25
   x86_64-linux
 
 DEPENDENCIES

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/customer_payment.rb

@@ -0,0 +1,47 @@
+module Brightpearl
+  # https://api-docs.brightpearl.com/accounting/customer-payment/index.html
+  class CustomerPayment < Resource
+    extend Brightpearl::APIOperations::Post
+    extend Brightpearl::APIOperations::Delete
+
+    attr_accessor :payment_id, :transaction_ref, :transaction_code, :payment_method_code,
+                  :payment_type, :order_id, :currency_id, :currency_code,
+                  :amount_authorized, :amount_paid, :expires, :payment_date,
+                  :created_on, :journal_id
+
+    class << self
+      def resource_path
+        "accounting-service/customer-payment"
+      end
+
+      # https://api-docs.brightpearl.com/accounting/customer-payment/post.html
+      # https://api-docs.brightpearl.com/accounting/customer-payment/delete.html
+
+      # https://api-docs.brightpearl.com/accounting/customer-payment/search.html
+      def search(query_params = {})
+        response = send_request(path: "accounting-service/customer-payment-search?#{to_query(query_params)}", method: :get)
+        return response.merge({
+          records: response[:payload]["response"]["results"].map { |item| CustomerPayment.new(item) },
+        })
+      end
+    end
+
+    # ARA => API Record Array
+    def initialize(ara)
+      @payment_id = ara[0]
+      @transaction_ref = ara[1]
+      @transaction_code = ara[2]
+      @payment_method_code = ara[3]
+      @payment_type = ara[4]
+      @order_id = ara[5]
+      @currency_id = ara[6]
+      @currency_code = ara[7]
+      @amount_authorized = ara[8]
+      @amount_paid = ara[9]
+      @expires = ara[10]
+      @payment_date = ara[11]
+      @created_on = ara[12]
+      @journal_id = ara[13]
+    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,9 +18,11 @@ 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'
 
 # Accounting
-require 'brightpearl/resources/tax_code'
+require 'brightpearl/resources/tax_code'
+require 'brightpearl/resources/customer_payment'

data/lib/brightpearl/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module Brightpearl
-  VERSION = "0.9.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.9.0
+  version: 0.11.0
 platform: ruby
 authors:
 - vicvans20
@@ -154,9 +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
@@ -164,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