ruby-brightpearl 0.8.0 → 0.10.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 499b1eb7f7e7ce054f49f19ba9dfd25602c3135b200c3d15c6934ec37379aca6
-  data.tar.gz: 62a70dfaff891786c97f0524825be9475fed68e2b6ca57a826349a4afea4fdd5
+  metadata.gz: b9e05da1a90bbe24c05beed8a083e43a77c4c22376af84e12f37d8ea3e6eeba8
+  data.tar.gz: 5f06f50c457a8be89f53181353c77c91dccbcf7d782de0096af6183eaae4358f
 SHA512:
-  metadata.gz: 98df0eadf345303d0163af51e20b55b401cfab34fe2585c016fada116c12fa4bad89ba0e2828498e5954ffce9427311855396ab2a7f738fa1b6a7aab962aaf86
-  data.tar.gz: 3c5c601b90a6b20d2827965f2879377195d994fc393ccb60fdc8e67caa6b555e7b00b67c70ea67a3c2725e84d9413641b44e07ae090973d666d14ea63e9ed0fb
+  metadata.gz: 5053255b92df81af25092d34b469b85bdf8a989c365f5654e018889b8de5e73aab963d5c7b6425849edcccab488ecab2d92f1bef2aa8c7a954d6bf96ab570e51
+  data.tar.gz: 9e377fe15a59fa1db5593521f5ac56f9d138c6e8cd823dca0b83d821f28fdfb6c81bfc8f7bd230f339dddc40a3b6918e968747416e683705c5d3d94e8d78b112

data/CHANGELOG.md

@@ -1,5 +1,20 @@
 ## [Unreleased]
 
+## [0.10.0] - 2026-04-17
+
+### Added
+
+- New resource `CustomerPayment`
+  - Available operations: `SEARCH`, `POST`, `DELETE`
+
+## [0.9.0] - 2025-12-10
+
+### Changed
+
+- **Renamed `Customer` resources to `Contact` to match Brightpearl API documentation**
+  - Renamed `Customer` to `Contact`
+  - Renamed `CustomerCustomField` to `ContactCustomField`
+
 ## [0.8.0] - 2025-11-05
 
 ### Added

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    ruby-brightpearl (0.8.0)
+    ruby-brightpearl (0.10.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.1)
     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.8.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/{customer.rb → contact.rb}

@@ -1,6 +1,6 @@
 module Brightpearl
   # https://api-docs.brightpearl.com/contact/contact/index.html
-  class Customer < Resource
+  class Contact < Resource
     extend Brightpearl::APIOperations::Get
     extend Brightpearl::APIOperations::Post
     extend Brightpearl::APIOperations::Patch
@@ -26,7 +26,7 @@ module Brightpearl
       def search(query_params = {})
         response = send_request(path: "contact-service/contact-search?#{to_query(query_params)}", method: :get)
         return response.merge({ # modify final payload to set search results as objects
-          records: response[:payload]["response"]["results"].map { |item| Customer.new(item) },
+          records: response[:payload]["response"]["results"].map { |item| Contact.new(item) },
          })
       end
     end
@@ -57,4 +57,5 @@ module Brightpearl
     end
 
   end
-end
+end
+

data/lib/brightpearl/resources/{customer_custom_field.rb → contact_custom_field.rb}

@@ -1,7 +1,7 @@
 module Brightpearl
   # Contact custom fields are the user-defined data held against Brightpearl contacts. Several data types are available. Custom fields are separated between Supplier contacts and Customer contacts, and may only be assigned to one of these groups.
   # https://api-docs.brightpearl.com/contact/custom-field/index.html
-  class CustomerCustomField < Resource
+  class ContactCustomField < Resource
     class << self 
       # https://api-docs.brightpearl.com/contact/custom-field/get.html
       def get(contact_id)
@@ -15,4 +15,5 @@ module Brightpearl
     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.rb

@@ -1,7 +1,7 @@
 require 'brightpearl/resource'
 
-require 'brightpearl/resources/customer'
-require 'brightpearl/resources/customer_custom_field'
+require 'brightpearl/resources/contact'
+require 'brightpearl/resources/contact_custom_field'
 
 require 'brightpearl/resources/order'
 require 'brightpearl/resources/order_row'
@@ -21,4 +21,5 @@ require 'brightpearl/resources/product_availability'
 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.8.0"
+  VERSION = "0.10.0"
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: ruby-brightpearl
 version: !ruby/object:Gem::Version
-  version: 0.8.0
+  version: 0.10.0
 platform: ruby
 authors:
 - vicvans20
@@ -152,8 +152,9 @@ files:
 - lib/brightpearl/errors.rb
 - lib/brightpearl/resource.rb
 - lib/brightpearl/resources.rb
-- lib/brightpearl/resources/customer.rb
-- lib/brightpearl/resources/customer_custom_field.rb
+- lib/brightpearl/resources/contact.rb
+- lib/brightpearl/resources/contact_custom_field.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