ruby-brightpearl 0.7.0 → 0.8.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: d50d3172ec36f06ca6b5ac76a9fc5f69b578df384db02b467d4c57502ede7dae
-  data.tar.gz: 89d67376fd2e4a6c5e007c2c6300cd657e2115b202b4f67403c1364921cdf6f0
+  metadata.gz: 499b1eb7f7e7ce054f49f19ba9dfd25602c3135b200c3d15c6934ec37379aca6
+  data.tar.gz: 62a70dfaff891786c97f0524825be9475fed68e2b6ca57a826349a4afea4fdd5
 SHA512:
-  metadata.gz: 7789dbc2a64efb929655e07def14a753246baf3ade6b7b6d3ed750da89b77abe9568ba1974634f7f22f98db54de6f379787c14d5901eddca571c0ced4ce56eb0
-  data.tar.gz: d259a5ead61c86d653f866bc150d5a604db202bd907b71530965d3cc27030d50e33f2fb122c0f591a971c515f07bc10c00855b1824535f0b6e9c4e0b525394a0
+  metadata.gz: 98df0eadf345303d0163af51e20b55b401cfab34fe2585c016fada116c12fa4bad89ba0e2828498e5954ffce9427311855396ab2a7f738fa1b6a7aab962aaf86
+  data.tar.gz: 3c5c601b90a6b20d2827965f2879377195d994fc393ccb60fdc8e67caa6b555e7b00b67c70ea67a3c2725e84d9413641b44e07ae090973d666d14ea63e9ed0fb

data/CHANGELOG.md

@@ -1,5 +1,13 @@
 ## [Unreleased]
 
+## [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

data/Gemfile.lock

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

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

@@ -10,6 +10,8 @@ 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'

data/lib/brightpearl/version.rb

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

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: ruby-brightpearl
 version: !ruby/object:Gem::Version
-  version: 0.7.0
+  version: 0.8.0
 platform: ruby
 authors:
 - vicvans20
@@ -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