ruby-brightpearl 0.6.0 → 0.8.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: a80cab051224d81b25426eb10655cbc17a7671befe929070149f9f8f0e15d7a0
-  data.tar.gz: f3123fd3ed140e7609c4b8001e3550442432ec7758fe9d7f1509d5950d27389e
+  metadata.gz: 499b1eb7f7e7ce054f49f19ba9dfd25602c3135b200c3d15c6934ec37379aca6
+  data.tar.gz: 62a70dfaff891786c97f0524825be9475fed68e2b6ca57a826349a4afea4fdd5
 SHA512:
-  metadata.gz: 3a0a2a922874b73cf68f788338c7ebf9b3b5c925a8fa211c009dd09a2e37f891b4d3bb45d5d65043907b1b4302aba4506608549debe5feb2932b65cb0cddfc21
-  data.tar.gz: c5b1cecc26f306eddcd7be95374c809704d925fb8238afc9d2ff0c9e4058eeb45e9685aeb38c506262a80977432d274c5a886aa3c051cd085bfa8aa86d5647a1
+  metadata.gz: 98df0eadf345303d0163af51e20b55b401cfab34fe2585c016fada116c12fa4bad89ba0e2828498e5954ffce9427311855396ab2a7f738fa1b6a7aab962aaf86
+  data.tar.gz: 3c5c601b90a6b20d2827965f2879377195d994fc393ccb60fdc8e67caa6b555e7b00b67c70ea67a3c2725e84d9413641b44e07ae090973d666d14ea63e9ed0fb

data/CHANGELOG.md

@@ -1,12 +1,32 @@
 ## [Unreleased]
 
-## [0.6.0]
+## [0.8.0] - 2025-11-05
+
+### Added
+
+- **New resource `GoodsOutNote`**
+  - Available operations: `GET`, `POST`, `PUT`, `DELETE`
+  - Search is still pending to be implemented
+
+## [0.7.0] - 2025-11-03
+
+### Added
+
+- New API Operation `DELETE`
+- **New resource `Webhook`**
+  - Available operations: `GET`, `POST`, `DELETE`
+
+### Changed
+- Improved `Brightpearl::RequestError` message to include error code when available
+  - For example, `CMNC-404 - Resource not found` instead of just `Resource not found`
+
+## [0.6.0] - 2025-08-28
 
 - New resource `Customer`
 - New resource `CustomerCustomField`
 - Minor fixes on development libs
 
-## [0.5.0]
+## [0.5.0] - 2025-03-27
 
 - Add new resource OrderCustomField
 - Improve test environment to use different bp credentials without breaking the cassettes

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    ruby-brightpearl (0.6.0)
+    ruby-brightpearl (0.8.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.2.2)
+    bigdecimal (3.3.1)
     byebug (11.1.3)
     coderay (1.1.3)
     crack (0.4.5)
@@ -19,7 +19,7 @@ GEM
     diff-lcs (1.5.0)
     dotenv (3.1.8)
     hashdiff (1.0.1)
-    httparty (0.23.1)
+    httparty (0.23.2)
       csv
       mini_mime (>= 1.0.0)
       multi_xml (>= 0.5.2)

data/lib/brightpearl/api_operations/delete.rb

@@ -0,0 +1,9 @@
+module Brightpearl
+  module APIOperations
+    module Delete
+      def delete(id)
+        send_request(path: "#{resource_path}/#{id}", method: :delete)
+      end
+    end
+  end
+end

data/lib/brightpearl/api_operations.rb

@@ -2,4 +2,5 @@ require 'brightpearl/api_operations/get'
 require 'brightpearl/api_operations/post'
 require 'brightpearl/api_operations/patch'
 require 'brightpearl/api_operations/put'
-require 'brightpearl/api_operations/options'
+require 'brightpearl/api_operations/options'
+require 'brightpearl/api_operations/delete'

data/lib/brightpearl/client.rb

@@ -54,6 +54,7 @@ module Brightpearl
       elsif response.code == 401
         raise Brightpearl::InvalidToken.new(json["response"], response: json, status: 401)
       elsif !!json["errors"]
+        # Request Error is the fallback message. If response has a tangible error message, first one will be used from response json
         raise Brightpearl::RequestError.new("Request Error",  response: json, status: response.code)
       end
 

data/lib/brightpearl/errors.rb

@@ -3,9 +3,11 @@ module Brightpearl
     attr_reader :response, :code, :status
     def initialize(msg, response: nil, status: nil)
       if response["errors"] && response["errors"].size == 1 # If error is easily identifiable then set it as the Error message
-        error = response["errors"][0]["message"]
+        error_message = response["errors"][0]["message"]
         @code = response["errors"][0]["code"]
-        super(error)
+
+        error_message = "#{@code} - #{error_message}" if @code
+        super(error_message)
       else
         super(msg)
       end

data/lib/brightpearl/resources/goods_out_note.rb

@@ -0,0 +1,52 @@
+module Brightpearl
+  # Goods-Out Notes are used to represent stock permanently leaving your stock control system. The most common use of a Goods-Out Note is to facilitate the fulfilment of a Sales Order.
+  # 
+  # When a Goods-Out Note is successfully created, stock is allocated to the specified Sales Order and is not available for the purposes of sales, Internal Transfers, External Transfers, Reservations or Stock Corrections.
+  # 
+  # Unlike the majority of resources that can be manipulated via the warehouse service, Goods-Out Notes have a temporal component, represented by lifecycle events.
+  # 
+  # A Goods-Out Note POST creates a Goods-Out Note with a created event, but for accounting and reporting purposes, the stock is still considered present in its original Warehouse and Locations
+  # 
+  # You should issue one or more Goods-Out Note Event POSTs to add lifecycle events such as picked, packed and shipped to the Goods-Note Out. The stock is not considered to have left a Warehouse until the shipped event is added to the Goods-Note Out.
+  # 
+  # A separate mechanism for creating a Goods-Out Note is provided by the External Transfer resource, which allows the movement of stock between two Warehouses
+  # 
+  # https://api-docs.brightpearl.com/warehouse/goods-out-note/index.html
+  class GoodsOutNote < Resource
+    class << self 
+      # You may query for goods-out notes in several different ways:
+      # * By goods-out note ID: `/order/*/goods-note/goods-out/4`
+      # * By an ID set of goods-out note IDs: `/order/*/goods-note/goods-out/4-99,1,2`
+      # * By an order ID: `/order/55/goods-note/goods-out/`
+      # * By a set of order IDs: `/order/55-90,45/goods-note/goods-out/`
+      # * By a combination of order IDs and goods-out note IDs: `/order/100-500/goods-note/goods-out/40-45`
+      # https://api-docs.brightpearl.com/warehouse/goods-out-note/get.html
+      def get(order_id_set:, gon_id_set: "")
+        url = "warehouse-service/order/#{order_id_set}/goods-note/goods-out/#{gon_id_set}"
+        send_request(path: url, method: :get)
+      end
+  
+      # https://api-docs.brightpearl.com/warehouse/goods-out-note/post.html
+      def post(order_id:, **params)
+        url = "warehouse-service/order/#{order_id}/goods-note/goods-out"
+        send_request(path: url, method: :post, body: params)
+      end
+
+      # https://api-docs.brightpearl.com/warehouse/goods-out-note/put.html
+      def put(id:, **params)
+        url = "warehouse-service/goods-note/goods-out/#{id}"
+        send_request(path: url, method: :put, body: params)
+      end
+      
+      # https://api-docs.brightpearl.com/warehouse/goods-out-note/delete.html
+      def delete(order_id:, gon_id:)
+        url = "warehouse-service/order/#{order_id}/goods-note/goods-out/#{gon_id}"
+        send_request(path: url, method: :delete)
+      end
+
+      # search (TODO)
+      # https://api-docs.brightpearl.com/warehouse/goods-out-note/search.html
+    end
+
+  end
+end

data/lib/brightpearl/resources/webhook.rb

@@ -0,0 +1,19 @@
+module Brightpearl
+  # Webhooks are used to define a 'callback contract' between Brightpearl and some third-party system. They specify the circumstances under which Brightpearl should send an HTTP message to the third-party system and the format of that message.
+  # 
+  # They are typically used to notify a remote server supporting some integration of a change in the state of a resource in a customer's Brightpearl account. For example, a carrier integration will want to know when Goods-Out Notes are picked or packed.
+  # 
+  # Please read Brightpearl webhooks for more information on how and when to use webhooks.
+  # https://api-docs.brightpearl.com/integration/webhook/index.html
+  class Webhook < Resource
+    extend Brightpearl::APIOperations::Get # /integration-service/webhook/{ID-SET}
+    extend Brightpearl::APIOperations::Post # /integration-service/webhook
+    extend Brightpearl::APIOperations::Delete # /integration-service/webhook/{ID}
+
+    class << self
+      def resource_path
+        "integration-service/webhook"
+      end
+    end
+  end
+end

data/lib/brightpearl/resources.rb

@@ -10,9 +10,15 @@ require 'brightpearl/resources/order_status'
 require 'brightpearl/resources/order_status_update'
 require 'brightpearl/resources/order_custom_field'
 
+require 'brightpearl/resources/goods_out_note'
+
 require 'brightpearl/resources/product'
 require 'brightpearl/resources/product_price'
 require 'brightpearl/resources/price_list'
 require 'brightpearl/resources/product_availability'
+
+# Integration
+require 'brightpearl/resources/webhook'
+
 # Accounting
 require 'brightpearl/resources/tax_code'

data/lib/brightpearl/version.rb

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

metadata

@@ -1,14 +1,13 @@
 --- !ruby/object:Gem::Specification
 name: ruby-brightpearl
 version: !ruby/object:Gem::Version
-  version: 0.6.0
+  version: 0.8.0
 platform: ruby
 authors:
 - vicvans20
-autorequire:
 bindir: exe
 cert_chain: []
-date: 2025-08-28 00:00:00.000000000 Z
+date: 1980-01-02 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: httparty
@@ -141,6 +140,7 @@ files:
 - bin/setup
 - lib/brightpearl.rb
 - lib/brightpearl/api_operations.rb
+- lib/brightpearl/api_operations/delete.rb
 - lib/brightpearl/api_operations/get.rb
 - lib/brightpearl/api_operations/options.rb
 - lib/brightpearl/api_operations/patch.rb
@@ -154,6 +154,7 @@ files:
 - lib/brightpearl/resources.rb
 - lib/brightpearl/resources/customer.rb
 - lib/brightpearl/resources/customer_custom_field.rb
+- lib/brightpearl/resources/goods_out_note.rb
 - lib/brightpearl/resources/order.rb
 - lib/brightpearl/resources/order_custom_field.rb
 - lib/brightpearl/resources/order_row.rb
@@ -165,6 +166,7 @@ files:
 - lib/brightpearl/resources/product_availability.rb
 - lib/brightpearl/resources/product_price.rb
 - lib/brightpearl/resources/tax_code.rb
+- lib/brightpearl/resources/webhook.rb
 - lib/brightpearl/version.rb
 - playground.rb
 - ruby-brightpearl.gemspec
@@ -177,7 +179,6 @@ metadata:
   homepage_uri: https://github.com/vicvans20/ruby-brightpearl
   source_code_uri: https://github.com/vicvans20/ruby-brightpearl
   changelog_uri: https://github.com/vicvans20/ruby-brightpearl/blob/master/CHANGELOG.md
-post_install_message:
 rdoc_options: []
 require_paths:
 - lib
@@ -192,8 +193,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.5.3
-signing_key:
+rubygems_version: 3.6.9
 specification_version: 4
 summary: Brightpearl API ruby client.
 test_files: []