shedcloud-partner_api 0.2.0 → 0.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 734c3d0eea78c90ba7776d78e851458f70cdaea30bdfa5925825bdafe2297ad3
-  data.tar.gz: 48dae1fe95a8fbf76f9284fe4ef8f8079609ecb824358302f4dd78988a245805
+  metadata.gz: a78896e75288ba076d02b6c502db75bc6f645d70f01a84d71d56f2e49d4257c4
+  data.tar.gz: ec94a587917290bf4b50a21ed6cdac8494c4b8787bba196d19f69f289a321a5b
 SHA512:
-  metadata.gz: 7fe825bcd1852876eb1f6519ce6d3ce935dcdeece6af55c241a0ed4f57bd9f19c04783f9d45caa4ec3dd6ab8087dc0689a707592378f086e3e9c1df5cf3a4eb1
-  data.tar.gz: 6513611c7663bfaa6d252340b5a68b8a0f2b8dbbd7df94b90928e599ce6007d58a946e4bc6c9b0f0e0bb977014f50ff22f00c6efaeb52e06ed3dff68cac6d54c
+  metadata.gz: c751ed94096c4ee0e4b1d09da5343051e560c729dcba403cd13db15467baebe17a12a32ea24414264859613fc704434789827b3eeaf983503592c5765c636c71
+  data.tar.gz: 8e6ce0647d26ab9dcce2c49f9dc45dcdf2f0c549637dbaeb28fc2689842d9edaf2d6daf06b258944761fa61e35ca904637676ef60ca6cc62ccbf71cb49526a51

data/CHANGELOG.md

@@ -1,5 +1,29 @@
 # Changelog
 
+## 0.3.0 — 2026-07-26
+
+- **Location sales budgets** — `client.location_budgets.list/get/create/update`
+  for `GET/POST/PUT /partner/v1/location-budgets` (scopes
+  `partner-api.location-budgets.read` / `.write`).
+- Parity with `@shedcloud/partner-api` 0.7.0 and the `shedcloud-api-go` Partner
+  API changelog entry (2026-07-25).
+
+## Unreleased
+
+- **Parametric products** — `client.orders.create` accepts `dimensions` in place of
+  `sizeId`, and `client.work_orders.create` accepts `productId` + `dimensions`, for
+  products whose bill of materials is a set of rules rather than one bill per size.
+  The fields are mutually exclusive (`dimensions` also requires `productId` on work
+  orders); both rules are enforced server-side as a `400` and are not duplicated
+  client-side. Keys inside `dimensions` are sent verbatim — no key transform, since
+  an unrecognised key is a `400` rather than a dropped field.
+- **New `client.bom`** — `dimension_variables` for
+  `GET /partner/v1/bom/dimension-variables` (existing scope
+  `partner-api.products.read`), listing the accepted keys with their unit, category
+  and `isSystem` flag. Read-only: authoring variables is a portal modelling
+  decision. Resolve the list per company rather than hard-coding the ten built-ins.
+- Parity with the `shedcloud-api-go` Partner API changelog entry (2026-07-25).
+
 ## 0.2.0 — 2026-07-19
 
 - **Site events** — `client.site_events.track`, `list`, and `each` for

data/README.md

@@ -208,6 +208,6 @@ The Partner API is **additive-only within `/partner/v1`**. This gem is tagged wi
 - Partner API reference: https://go.shedcloud.com/partner/reference
 - Backend source of truth: `shedcloud-api-go/docs/PARTNER_API.md`
 - TypeScript/JavaScript: [`@shedcloud/partner-api`](https://github.com/Corland-Partners-LLC/shedcloud-npm)
-- Go: [`shedcloud-gomod/partnerapi`](https://github.com/Corland-Partners-LLC/shedcloud-gomod)
+- Go: [`shedcloud-gomod/partnerapi`](https://pkg.go.dev/github.com/Corland-Partners-LLC/shedcloud-gomod/partnerapi)
 - Python: [`shedcloud-partner-api`](https://github.com/Corland-Partners-LLC/shedcloud-pypi)
 - PHP: [`shedcloud/partner-api`](https://github.com/Corland-Partners-LLC/shedcloud-php)

data/lib/shedcloud/partner_api/client.rb

@@ -11,6 +11,7 @@ module ShedCloud
                   :orders,
                   :work_orders,
                   :locations,
+                  :location_budgets,
                   :customers,
                   :domains,
                   :agreements,
@@ -50,6 +51,7 @@ module ShedCloud
         @orders = Resources::Orders.new(@http)
         @work_orders = Resources::WorkOrders.new(@http)
         @locations = Resources::Locations.new(@http)
+        @location_budgets = Resources::LocationBudgets.new(@http)
         @customers = Resources::Customers.new(@http)
         @domains = Resources::Domains.new(@http)
         @agreements = Resources::Agreements.new(@http)

data/lib/shedcloud/partner_api/resources/location_budgets.rb

@@ -0,0 +1,30 @@
+# frozen_string_literal: true
+
+module ShedCloud
+  module PartnerApi
+    module Resources
+      class LocationBudgets < Base
+        def list(params = {})
+          @http.request('GET', '/partner/v1/location-budgets', query: params) || {}
+        end
+
+        def get(id)
+          @http.request('GET', "/partner/v1/location-budgets/#{path_segment(id)}") || {}
+        end
+
+        def create(body, options: nil)
+          @http.request(
+            'POST',
+            '/partner/v1/location-budgets',
+            body: body,
+            headers: option_headers(options),
+          ) || {}
+        end
+
+        def update(id, body)
+          @http.request('PUT', "/partner/v1/location-budgets/#{path_segment(id)}", body: body) || {}
+        end
+      end
+    end
+  end
+end

data/lib/shedcloud/partner_api/resources/site_events.rb

@@ -14,6 +14,13 @@ module ShedCloud
         # POST /partner/v1/site-events (scope partner-api.site-events.write).
         # Unlike most Partner API endpoints, the ingest body natively speaks
         # snake_case on the wire (session_id, visitor_id, events[].event_type, ...).
+        #
+        # Forward the end shopper's context via top-level client_ip and
+        # client_user_agent — without them every event is stamped with your
+        # server's IP/UA and visitor geo is meaningless. Identity events may
+        # carry events[].customer (first_name/last_name/email/phone/zip),
+        # events[].delivery (address), and events[].payment
+        # (payment_type "RENT_TO_OWN"|"CASH", monthly_term, ...) snapshots.
         def track(body, options: nil)
           @http.request('POST', '/partner/v1/site-events', body: body, headers: option_headers(options)) || {}
         end

data/lib/shedcloud/partner_api/scopes.rb

@@ -14,6 +14,8 @@ module ShedCloud
       WORK_ORDERS_WRITE = 'partner-api.work-orders.write'
       LOCATIONS_READ = 'partner-api.locations.read'
       LOCATIONS_WRITE = 'partner-api.locations.write'
+      LOCATION_BUDGETS_READ = 'partner-api.location-budgets.read'
+      LOCATION_BUDGETS_WRITE = 'partner-api.location-budgets.write'
       CUSTOMERS_READ = 'partner-api.customers.read'
       CUSTOMERS_WRITE = 'partner-api.customers.write'
       PRODUCTS_READ = 'partner-api.products.read'
@@ -43,6 +45,8 @@ module ShedCloud
         WORK_ORDERS_WRITE,
         LOCATIONS_READ,
         LOCATIONS_WRITE,
+        LOCATION_BUDGETS_READ,
+        LOCATION_BUDGETS_WRITE,
         CUSTOMERS_READ,
         CUSTOMERS_WRITE,
         PRODUCTS_READ,

data/lib/shedcloud/partner_api/version.rb

@@ -2,6 +2,6 @@
 
 module ShedCloud
   module PartnerApi
-    VERSION = '0.2.0'
+    VERSION = '0.3.0'
   end
 end

data/lib/shedcloud/partner_api.rb

@@ -18,6 +18,7 @@ require_relative 'partner_api/resources/quotes'
 require_relative 'partner_api/resources/orders'
 require_relative 'partner_api/resources/work_orders'
 require_relative 'partner_api/resources/locations'
+require_relative 'partner_api/resources/location_budgets'
 require_relative 'partner_api/resources/customers'
 require_relative 'partner_api/resources/domains'
 require_relative 'partner_api/resources/agreements'

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: shedcloud-partner_api
 version: !ruby/object:Gem::Version
-  version: 0.2.0
+  version: 0.3.0
 platform: ruby
 authors:
 - Corland Partners LLC
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2026-07-19 00:00:00.000000000 Z
+date: 2026-07-26 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rake
@@ -71,6 +71,7 @@ files:
 - lib/shedcloud/partner_api/resources/domains.rb
 - lib/shedcloud/partner_api/resources/events.rb
 - lib/shedcloud/partner_api/resources/leads.rb
+- lib/shedcloud/partner_api/resources/location_budgets.rb
 - lib/shedcloud/partner_api/resources/locations.rb
 - lib/shedcloud/partner_api/resources/lot_stock.rb
 - lib/shedcloud/partner_api/resources/orders.rb