flexops 1.1.0 → 2.0.0

data/lib/flexops/resources/carbon_offsets.rb

@@ -0,0 +1,60 @@
+# ***********************************************************************
+# Package          : flexops
+# Author           : FlexOps, LLC
+# Created          : 2026-10-19
+#
+# Copyright (c) 2021-2026 by FlexOps, LLC. All rights reserved.
+# ***********************************************************************
+
+module FlexOps
+  module Resources
+    # Carbon offsets for shipments. Answers use the { success, data, message, errorCode } envelope.
+    class CarbonOffsets
+      def initialize(http, ws_id_proc)
+        @http = http
+        @ws_id = ws_id_proc
+      end
+
+      def quote(weight_lbs:, distance_miles:)
+        @http.post("#{ws_path}/quote", body: { weightLbs: weight_lbs, distanceMiles: distance_miles })
+      end
+
+      # Buys an offset for a shipment and debits the workspace wallet.
+      # Pass an idempotency_key you store with the purchase to make your own retry safe: after an
+      # error or a timeout, retry with the same key and the Gateway returns the first result instead
+      # of buying again. Without one, the SDK's own retries still share a key, but a new call gets a new key.
+      def purchase(tracking_number:, weight_lbs:, distance_miles:, idempotency_key: nil)
+        @http.post("#{ws_path}/purchase",
+                   body: { trackingNumber: tracking_number, weightLbs: weight_lbs, distanceMiles: distance_miles },
+                   headers: idempotency_key.nil? ? {} : { "Idempotency-Key" => idempotency_key })
+      end
+
+      def list(page: nil, page_size: nil)
+        query = { page: page, pageSize: page_size }.compact
+        @http.get(ws_path, query: query.empty? ? nil : query)
+      end
+
+      def get(offset_id)
+        @http.get("#{ws_path}/#{offset_id}")
+      end
+
+      def summary
+        @http.get("#{ws_path}/summary")
+      end
+
+      def get_settings
+        @http.get("#{ws_path}/settings")
+      end
+
+      def update_settings(auto_offset_enabled:)
+        @http.put("#{ws_path}/settings", body: { autoOffsetEnabled: auto_offset_enabled })
+      end
+
+      private
+
+      def ws_path
+        "/api/workspaces/#{@ws_id.call}/carbon-offsets"
+      end
+    end
+  end
+end

data/lib/flexops/resources/carriers.rb

@@ -8,6 +8,11 @@
 
 module FlexOps
   module Resources
+    # Carrier-specific calls through the legacy /api/ApiProxy passthrough (sunset 2027-06-30).
+    # Lookups (GET) work with an API key or a user token. The writes (POST/PUT/DELETE) are
+    # deprecated and need a user token (auth.login): the Gateway refuses API-key writes on the
+    # proxy with 403 API_KEY_SCOPE_REQUIRED. Label generation through the proxy is closed (410 Gone);
+    # buy, cancel and schedule through client.shipping, client.pickups and client.scan_forms.
     class Carriers
       attr_reader :usps, :ups, :fedex, :dhl
 
@@ -30,20 +35,37 @@ module FlexOps
       def validate_address(params) = @http.get("#{PROXY}/api/v3/AddressValidation/getUspsValidateAndCorrectAddress", query: params)
       def city_state_lookup(zip_code) = @http.get("#{PROXY}/api/v3/AddressValidation/getUspsCityStateLookupByZipCode", query: { zipCode: zip_code })
       def zip_code_lookup(params) = @http.get("#{PROXY}/api/v3/AddressValidation/getUspsZipCodeLookupByAddress", query: params)
+      # @deprecated Legacy carrier proxy (sunset 2027-06-30). Needs a user token: API keys get 403
+      #   API_KEY_SCOPE_REQUIRED. Use client.shipping / client.pickups / client.scan_forms where they cover this.
       def get_domestic_rates(body) = @http.post("#{PROXY}/api/v3/RateCalculator/postUspsSearchDomesticBaseRates", body: body)
+      # @deprecated Legacy carrier proxy (sunset 2027-06-30). Needs a user token: API keys get 403
+      #   API_KEY_SCOPE_REQUIRED. Use client.shipping / client.pickups / client.scan_forms where they cover this.
       def get_domestic_products(body) = @http.post("#{PROXY}/api/v3/RateCalculator/postUspsSearchEligibleDomesticProducts", body: body)
+      # @deprecated Legacy carrier proxy (sunset 2027-06-30). Needs a user token: API keys get 403
+      #   API_KEY_SCOPE_REQUIRED. Use client.shipping / client.pickups / client.scan_forms where they cover this.
       def get_domestic_prices(body) = @http.post("#{PROXY}/api/v3/RateCalculator/postUspsSearchEligibleDomesticPrices", body: body)
+      # @deprecated Legacy carrier proxy (sunset 2027-06-30). Needs a user token: API keys get 403
+      #   API_KEY_SCOPE_REQUIRED. Use client.shipping / client.pickups / client.scan_forms where they cover this.
       def get_international_rates(body) = @http.post("#{PROXY}/api/v3/RateCalculator/postUspsSearchInternationalBaseRates", body: body)
+      # @deprecated Legacy carrier proxy (sunset 2027-06-30). Needs a user token: API keys get 403
+      #   API_KEY_SCOPE_REQUIRED. Use client.shipping / client.pickups / client.scan_forms where they cover this.
       def get_international_prices(body) = @http.post("#{PROXY}/api/v3/RateCalculator/postUspsSearchEligibleInternationalPrices", body: body)
-      def create_domestic_label(body) = @http.post("#{PROXY}/api/v3/Shipping/postUspsGenerateDomesticShippingLabel", body: body)
-      def create_return_label(body) = @http.post("#{PROXY}/api/v3/Shipping/postUspsGenerateDomesticReturnsShippingLabel", body: body)
-      def create_international_label(body) = @http.post("#{PROXY}/api/v3/Shipping/postUspsGenerateInternationalShippingLabel", body: body)
+      # @deprecated Legacy carrier proxy (sunset 2027-06-30). Needs a user token: API keys get 403
+      #   API_KEY_SCOPE_REQUIRED. Use client.shipping / client.pickups / client.scan_forms where they cover this.
       def cancel_domestic_label = @http.delete("#{PROXY}/api/v3/Shipping/cancelUspsDomesticShipmentLabel")
+      # @deprecated Legacy carrier proxy (sunset 2027-06-30). Needs a user token: API keys get 403
+      #   API_KEY_SCOPE_REQUIRED. Use client.shipping / client.pickups / client.scan_forms where they cover this.
       def cancel_international_label = @http.delete("#{PROXY}/api/v3/Shipping/cancelUspsInternationalShipmentLabel")
       def track_summary(params) = @http.get("#{PROXY}/api/v3/Tracking/getUspsTrackingSummaryInformation", query: params)
       def track_detail(params) = @http.get("#{PROXY}/api/v3/Tracking/getUspsTrackingDetailInformation", query: params)
+      # @deprecated Legacy carrier proxy (sunset 2027-06-30). Needs a user token: API keys get 403
+      #   API_KEY_SCOPE_REQUIRED. Use client.shipping / client.pickups / client.scan_forms where they cover this.
       def create_pickup(body) = @http.post("#{PROXY}/api/v3/CarrierPickup/postUspsCreateCarrierPickupSchedule", body: body)
+      # @deprecated Legacy carrier proxy (sunset 2027-06-30). Needs a user token: API keys get 403
+      #   API_KEY_SCOPE_REQUIRED. Use client.shipping / client.pickups / client.scan_forms where they cover this.
       def cancel_pickup = @http.delete("#{PROXY}/api/v3/CarrierPickup/cancelUspsCarrierPickupSchedule")
+      # @deprecated Legacy carrier proxy (sunset 2027-06-30). Needs a user token: API keys get 403
+      #   API_KEY_SCOPE_REQUIRED. Use client.shipping / client.pickups / client.scan_forms where they cover this.
       def create_scan_form(body) = @http.post("#{PROXY}/api/v3/ScanForm/postUspsCreateScanFormLabelShipment", body: body)
       def delivery_standards(params) = @http.get("#{PROXY}/api/v3/ServiceStandards/getUspsGetDeliveryStandardsEstimates", query: params)
       def find_drop_off_locations(params) = @http.get("#{PROXY}/api/v3/LocationSearch/getUspsFindValidDropOffLocations", query: params)
@@ -57,17 +79,36 @@ module FlexOps
         @http = http
       end
 
+      # @deprecated Legacy carrier proxy (sunset 2027-06-30). Needs a user token: API keys get 403
+      #   API_KEY_SCOPE_REQUIRED. Use client.shipping / client.pickups / client.scan_forms where they cover this.
       def validate_address(body) = @http.post("#{PROXY}/api/v2/ShippingLabel/postUpsVerifyAddress", body: body)
+      # @deprecated Legacy carrier proxy (sunset 2027-06-30). Needs a user token: API keys get 403
+      #   API_KEY_SCOPE_REQUIRED. Use client.shipping / client.pickups / client.scan_forms where they cover this.
       def get_rates(body) = @http.post("#{PROXY}/api/v2/ShippingLabel/postUpsRateCheck", body: body)
-      def create_label(body) = @http.post("#{PROXY}/api/v2/ShippingLabel/generateNewUpsShipLabel", body: body)
       def track(params) = @http.get("#{PROXY}/api/v2/ShippingLabel/getSingleUpsTrackingDetail", query: params)
+      # @deprecated Legacy carrier proxy (sunset 2027-06-30). Needs a user token: API keys get 403
+      #   API_KEY_SCOPE_REQUIRED. Use client.shipping / client.pickups / client.scan_forms where they cover this.
       def create_pickup(body) = @http.post("#{PROXY}/api/v2/ShippingLabel/postUpsCreatePickup", body: body)
+      # @deprecated Legacy carrier proxy (sunset 2027-06-30). Needs a user token: API keys get 403
+      #   API_KEY_SCOPE_REQUIRED. Use client.shipping / client.pickups / client.scan_forms where they cover this.
       def cancel_pickup = @http.delete("#{PROXY}/api/v2/ShippingLabel/deleteUpsPickup")
+      # @deprecated Legacy carrier proxy (sunset 2027-06-30). Needs a user token: API keys get 403
+      #   API_KEY_SCOPE_REQUIRED. Use client.shipping / client.pickups / client.scan_forms where they cover this.
       def get_transit_times(body) = @http.post("#{PROXY}/api/v2/ShippingLabel/postUpsGetTransitTimes", body: body)
+      # @deprecated Legacy carrier proxy (sunset 2027-06-30). Needs a user token: API keys get 403
+      #   API_KEY_SCOPE_REQUIRED. Use client.shipping / client.pickups / client.scan_forms where they cover this.
       def get_landed_cost(body) = @http.post("#{PROXY}/api/v2/ShippingLabel/postUpsGetLandedCostQuote", body: body)
+      # @deprecated Legacy carrier proxy (sunset 2027-06-30). Needs a user token: API keys get 403
+      #   API_KEY_SCOPE_REQUIRED. Use client.shipping / client.pickups / client.scan_forms where they cover this.
       def search_locations(body) = @http.post("#{PROXY}/api/v2/ShippingLabel/postUpsSearchLocations", body: body)
+      # @deprecated Legacy carrier proxy (sunset 2027-06-30). Needs a user token: API keys get 403
+      #   API_KEY_SCOPE_REQUIRED. Use client.shipping / client.pickups / client.scan_forms where they cover this.
       def upload_document(body) = @http.post("#{PROXY}/api/v2/ShippingLabel/postUpsUploadPaperlessDocument", body: body)
+      # @deprecated Legacy carrier proxy (sunset 2027-06-30). Needs a user token: API keys get 403
+      #   API_KEY_SCOPE_REQUIRED. Use client.shipping / client.pickups / client.scan_forms where they cover this.
       def create_freight_shipment(body) = @http.post("#{PROXY}/api/v2/ShippingLabel/postUpsCreateFreightShipment", body: body)
+      # @deprecated Legacy carrier proxy (sunset 2027-06-30). Needs a user token: API keys get 403
+      #   API_KEY_SCOPE_REQUIRED. Use client.shipping / client.pickups / client.scan_forms where they cover this.
       def get_freight_rate(body) = @http.post("#{PROXY}/api/v2/ShippingLabel/postUpsGetFreightRate", body: body)
     end
 
@@ -78,26 +119,62 @@ module FlexOps
         @http = http
       end
 
+      # @deprecated Legacy carrier proxy (sunset 2027-06-30). Needs a user token: API keys get 403
+      #   API_KEY_SCOPE_REQUIRED. Use client.shipping / client.pickups / client.scan_forms where they cover this.
       def validate_address(body) = @http.post("#{PROXY}/api/v3/AddressValidation/postFedExValidateAndCorrectDomesticAddress", body: body)
+      # @deprecated Legacy carrier proxy (sunset 2027-06-30). Needs a user token: API keys get 403
+      #   API_KEY_SCOPE_REQUIRED. Use client.shipping / client.pickups / client.scan_forms where they cover this.
       def validate_postal_code(body) = @http.post("#{PROXY}/api/v3/AddressValidation/postFedExValidatePostalCode", body: body)
+      # @deprecated Legacy carrier proxy (sunset 2027-06-30). Needs a user token: API keys get 403
+      #   API_KEY_SCOPE_REQUIRED. Use client.shipping / client.pickups / client.scan_forms where they cover this.
       def get_rates(body) = @http.post("#{PROXY}/api/v3/RateCalculator/postRetrieveFedExRateAndTransitTimesAsync", body: body)
-      def create_shipment(body) = @http.post("#{PROXY}/api/v3/Shipping/postFedExCreateNewShipment", body: body)
+      # @deprecated Legacy carrier proxy (sunset 2027-06-30). Needs a user token: API keys get 403
+      #   API_KEY_SCOPE_REQUIRED. Use client.shipping / client.pickups / client.scan_forms where they cover this.
       def cancel_shipment(body) = @http.put("#{PROXY}/api/v3/Shipping/putFedExCancelShipment", body: body)
+      # @deprecated Legacy carrier proxy (sunset 2027-06-30). Needs a user token: API keys get 403
+      #   API_KEY_SCOPE_REQUIRED. Use client.shipping / client.pickups / client.scan_forms where they cover this.
       def validate_shipment(body) = @http.post("#{PROXY}/api/v3/Shipping/postFedExValidateShipment", body: body)
-      def create_return_shipment(body) = @http.post("#{PROXY}/api/v3/Shipping/postFedExCreateNewReturnShipment", body: body)
+      # @deprecated Legacy carrier proxy (sunset 2027-06-30). Needs a user token: API keys get 403
+      #   API_KEY_SCOPE_REQUIRED. Use client.shipping / client.pickups / client.scan_forms where they cover this.
       def track(body) = @http.post("#{PROXY}/api/v3/Tracking/postFedExRetrieveTrackingInfoByTrackingNumber", body: body)
+      # @deprecated Legacy carrier proxy (sunset 2027-06-30). Needs a user token: API keys get 403
+      #   API_KEY_SCOPE_REQUIRED. Use client.shipping / client.pickups / client.scan_forms where they cover this.
       def track_multi_piece(body) = @http.post("#{PROXY}/api/v3/Tracking/postFedExRetrieveTrackingInfoForMultiPieceShipment", body: body)
+      # @deprecated Legacy carrier proxy (sunset 2027-06-30). Needs a user token: API keys get 403
+      #   API_KEY_SCOPE_REQUIRED. Use client.shipping / client.pickups / client.scan_forms where they cover this.
       def register_tracking_notification(body) = @http.post("#{PROXY}/api/v3/Tracking/postFedExRegisterForTrackingNotification", body: body)
+      # @deprecated Legacy carrier proxy (sunset 2027-06-30). Needs a user token: API keys get 403
+      #   API_KEY_SCOPE_REQUIRED. Use client.shipping / client.pickups / client.scan_forms where they cover this.
       def create_pickup(body) = @http.post("#{PROXY}/api/v3/CarrierPickup/postFedExCreateCarrierPickupRequest", body: body)
+      # @deprecated Legacy carrier proxy (sunset 2027-06-30). Needs a user token: API keys get 403
+      #   API_KEY_SCOPE_REQUIRED. Use client.shipping / client.pickups / client.scan_forms where they cover this.
       def cancel_pickup(body) = @http.put("#{PROXY}/api/v3/CarrierPickup/putFedExCancelCarrierPickupRequest", body: body)
+      # @deprecated Legacy carrier proxy (sunset 2027-06-30). Needs a user token: API keys get 403
+      #   API_KEY_SCOPE_REQUIRED. Use client.shipping / client.pickups / client.scan_forms where they cover this.
       def search_locations(body) = @http.post("#{PROXY}/api/v3/LocationSearch/postFedExSearchValidLocations", body: body)
+      # @deprecated Legacy carrier proxy (sunset 2027-06-30). Needs a user token: API keys get 403
+      #   API_KEY_SCOPE_REQUIRED. Use client.shipping / client.pickups / client.scan_forms where they cover this.
       def get_service_standards(body) = @http.post("#{PROXY}/api/v3/ServiceStandards/postFedExRetrieveServicesAndTransitTimes", body: body)
+      # @deprecated Legacy carrier proxy (sunset 2027-06-30). Needs a user token: API keys get 403
+      #   API_KEY_SCOPE_REQUIRED. Use client.shipping / client.pickups / client.scan_forms where they cover this.
       def get_freight_rate(body) = @http.post("#{PROXY}/api/v3/Freight/postFedExGetFreightRateQuote", body: body)
+      # @deprecated Legacy carrier proxy (sunset 2027-06-30). Needs a user token: API keys get 403
+      #   API_KEY_SCOPE_REQUIRED. Use client.shipping / client.pickups / client.scan_forms where they cover this.
       def create_freight_shipment(body) = @http.post("#{PROXY}/api/v3/Freight/postFedExCreateFreightShipment", body: body)
+      # @deprecated Legacy carrier proxy (sunset 2027-06-30). Needs a user token: API keys get 403
+      #   API_KEY_SCOPE_REQUIRED. Use client.shipping / client.pickups / client.scan_forms where they cover this.
       def ground_close(body) = @http.post("#{PROXY}/api/v3/GroundClose/postFedExCloseWithDocuments", body: body)
+      # @deprecated Legacy carrier proxy (sunset 2027-06-30). Needs a user token: API keys get 403
+      #   API_KEY_SCOPE_REQUIRED. Use client.shipping / client.pickups / client.scan_forms where they cover this.
       def upload_trade_documents(body) = @http.post("#{PROXY}/api/v3/Trade/postFedExUploadTradeDocuments", body: body)
+      # @deprecated Legacy carrier proxy (sunset 2027-06-30). Needs a user token: API keys get 403
+      #   API_KEY_SCOPE_REQUIRED. Use client.shipping / client.pickups / client.scan_forms where they cover this.
       def create_open_shipment(body) = @http.post("#{PROXY}/api/v3/OpenShip/postFedExCreateOpenShipment", body: body)
+      # @deprecated Legacy carrier proxy (sunset 2027-06-30). Needs a user token: API keys get 403
+      #   API_KEY_SCOPE_REQUIRED. Use client.shipping / client.pickups / client.scan_forms where they cover this.
       def add_packages_to_open_shipment(body) = @http.post("#{PROXY}/api/v3/OpenShip/postFedExAddPackagesToOpenShipment", body: body)
+      # @deprecated Legacy carrier proxy (sunset 2027-06-30). Needs a user token: API keys get 403
+      #   API_KEY_SCOPE_REQUIRED. Use client.shipping / client.pickups / client.scan_forms where they cover this.
       def confirm_open_shipment(body) = @http.post("#{PROXY}/api/v3/OpenShip/postFedExConfirmOpenShipment", body: body)
     end
 
@@ -110,16 +187,26 @@ module FlexOps
 
       def validate_address(params) = @http.get("#{PROXY}/api/v2/ShippingLabel/getDhlValidateAddress", query: params)
       def get_rates(params) = @http.get("#{PROXY}/api/v2/ShippingLabel/getDhlRates", query: params)
+      # @deprecated Legacy carrier proxy (sunset 2027-06-30). Needs a user token: API keys get 403
+      #   API_KEY_SCOPE_REQUIRED. Use client.shipping / client.pickups / client.scan_forms where they cover this.
       def get_multi_piece_rates(body) = @http.post("#{PROXY}/api/v2/ShippingLabel/postDhlMultiPieceRates", body: body)
       def get_products(params) = @http.get("#{PROXY}/api/v2/ShippingLabel/getDhlProducts", query: params)
-      def create_shipment(body) = @http.post("#{PROXY}/api/v2/ShippingLabel/postDhlCreateShipment", body: body)
       def track(params) = @http.get("#{PROXY}/api/v2/ShippingLabel/getDhlTrackSingleShipment", query: params)
       def track_multiple(params) = @http.get("#{PROXY}/api/v2/ShippingLabel/getDhlTrackMultipleShipments", query: params)
+      # @deprecated Legacy carrier proxy (sunset 2027-06-30). Needs a user token: API keys get 403
+      #   API_KEY_SCOPE_REQUIRED. Use client.shipping / client.pickups / client.scan_forms where they cover this.
       def create_pickup(body) = @http.post("#{PROXY}/api/v2/ShippingLabel/postDhlCreatePickup", body: body)
-      def update_pickup(body) = @http.patch("#{PROXY}/api/v2/ShippingLabel/patchDhlUpdatePickup", body: body)
+      # @deprecated Legacy carrier proxy (sunset 2027-06-30). Needs a user token: API keys get 403
+      #   API_KEY_SCOPE_REQUIRED. Use client.shipping / client.pickups / client.scan_forms where they cover this.
       def cancel_pickup = @http.delete("#{PROXY}/api/v2/ShippingLabel/deleteDhlPickup")
+      # @deprecated Legacy carrier proxy (sunset 2027-06-30). Needs a user token: API keys get 403
+      #   API_KEY_SCOPE_REQUIRED. Use client.shipping / client.pickups / client.scan_forms where they cover this.
       def calculate_landed_cost(body) = @http.post("#{PROXY}/api/v2/ShippingLabel/postDhlCalculateLandedCost", body: body)
+      # @deprecated Legacy carrier proxy (sunset 2027-06-30). Needs a user token: API keys get 403
+      #   API_KEY_SCOPE_REQUIRED. Use client.shipping / client.pickups / client.scan_forms where they cover this.
       def screen_shipment(body) = @http.post("#{PROXY}/api/v2/ShippingLabel/postDhlScreenShipment", body: body)
+      # @deprecated Legacy carrier proxy (sunset 2027-06-30). Needs a user token: API keys get 403
+      #   API_KEY_SCOPE_REQUIRED. Use client.shipping / client.pickups / client.scan_forms where they cover this.
       def upload_invoice(body) = @http.post("#{PROXY}/api/v2/ShippingLabel/postDhlUploadInvoice", body: body)
       def get_proof_of_delivery(params) = @http.get("#{PROXY}/api/v2/ShippingLabel/getDhlElectronicProofOfDelivery", query: params)
       def get_reference_data(params) = @http.get("#{PROXY}/api/v2/ShippingLabel/getDhlReferenceData", query: params)

data/lib/flexops/resources/email_templates.rb

@@ -1,15 +1,22 @@
 # ***********************************************************************
 # Package          : flexops
 # Author           : FlexOps, LLC
-# Created          : 2026-03-31
+# Created          : 2026-10-19
 #
 # Copyright (c) 2021-2026 by FlexOps, LLC. All rights reserved.
 # ***********************************************************************
 
-# frozen_string_literal: true
-
 module FlexOps
   module Resources
+    # Branded tracking email templates, one per tracking event. Answers are bare JSON (no
+    # envelope); ids are GUID strings.
+    #
+    # Reads work with any API key or a user token. Writes (upsert, delete, preview) need a user
+    # token (auth.login) or an API key granted the opt-in "email-templates:write" scope; a key
+    # without it gets 403 API_KEY_SCOPE_REQUIRED.
+    #
+    # +eventType+ is the Gateway TrackingEmailEvent number: LabelCreated 0, InTransit 1,
+    # OutForDelivery 2, Delivered 3, Exception 4, ReturnToSender 5.
     class EmailTemplates
       def initialize(http, ws_id_proc)
         @http = http
@@ -17,33 +24,36 @@ module FlexOps
       end
 
       def list
-        @http.get("#{ws_path}/shipment-email-templates/")
-      end
-
-      def get(id)
-        @http.get("#{ws_path}/shipment-email-templates/#{id}")
+        @http.get(ws_path)
       end
 
-      def create(request)
-        @http.post("#{ws_path}/shipment-email-templates/", body: request)
+      def get(template_id)
+        @http.get("#{ws_path}/#{template_id}")
       end
 
-      def update(id, request)
-        @http.put("#{ws_path}/shipment-email-templates/#{id}", body: request)
+      # Creates or replaces the template for request's +eventType+.
+      #
+      # request:: { eventType: (0-5), subjectTemplate: (<= 500 chars), htmlBodyTemplate:,
+      #           isEnabled: (default true) }. Returns the template.
+      def upsert(request)
+        @http.put(ws_path, body: request)
       end
 
-      def delete(id)
-        @http.delete("#{ws_path}/shipment-email-templates/#{id}")
+      # Returns nil (204).
+      def delete(template_id)
+        @http.delete("#{ws_path}/#{template_id}")
       end
 
-      def preview(id, context = {})
-        @http.post("#{ws_path}/shipment-email-templates/#{id}/preview", body: context)
+      # Renders a draft with sample placeholder values. Returns { renderedSubject, renderedHtmlBody }.
+      def preview(subject_template:, html_body_template:)
+        @http.post("#{ws_path}/preview",
+                   body: { subjectTemplate: subject_template, htmlBodyTemplate: html_body_template })
       end
 
       private
 
       def ws_path
-        "/api/workspaces/#{@ws_id.call}"
+        "/api/workspaces/#{@ws_id.call}/email-templates"
       end
     end
   end

data/lib/flexops/resources/hs_codes.rb

@@ -8,31 +8,30 @@
 
 # frozen_string_literal: true
 
+require "erb"
+
 module FlexOps
   module Resources
+    # HS code lookup and landed cost. These routes are not workspace-scoped; each returns a bare
+    # (not enveloped) answer.
     class HsCodes
-      def initialize(http, ws_id_proc)
+      def initialize(http)
         @http = http
-        @ws_id = ws_id_proc
       end
 
       def search(query, destination_country: nil, max_results: 10)
         params = { query: query, destinationCountry: destination_country, maxResults: max_results }.compact
-        @http.get("#{ws_path}/shipping/hs-codes/search", query: params)
+        @http.get("/api/shipping/hs-codes/search", query: params)
       end
 
       def lookup(code)
-        @http.get("#{ws_path}/shipping/hs-codes/#{code}")
+        @http.get("/api/shipping/hs-codes/#{ERB::Util.url_encode(code.to_s)}")
       end
 
+      # request:: { destinationCountry:, items: [{ description:, quantity:, value:, weightOz:,
+      #           hsCode: (optional), originCountry:, skuOrProductId: (optional) }], shippingCost: }
       def estimate_landed_cost(request)
-        @http.post("#{ws_path}/shipping/landed-cost", body: request)
-      end
-
-      private
-
-      def ws_path
-        "/api/workspaces/#{@ws_id.call}"
+        @http.post("/api/shipping/landed-cost", body: request)
       end
     end
   end

data/lib/flexops/resources/insurance.rb

@@ -8,6 +8,7 @@
 
 module FlexOps
   module Resources
+    # Shipping insurance. Answers use the { success, data, message, errorCode } envelope.
     class Insurance
       def initialize(http, ws_id_proc)
         @http = http
@@ -18,24 +19,33 @@ module FlexOps
         @http.get("#{ws_path}/insurance/providers")
       end
 
-      def get_quote(carrier:, declared_value:, provider: nil)
-        body = { carrier: carrier, declaredValue: declared_value }
-        body[:provider] = provider if provider
+      def get_quote(declared_value:, carrier_code:, tracking_number: nil, provider: nil)
+        body = { declaredValue: declared_value, carrierCode: carrier_code,
+                 trackingNumber: tracking_number, provider: provider }.compact
         @http.post("#{ws_path}/insurance/quote", body: body)
       end
 
-      def purchase(tracking_number:, carrier:, declared_value:, provider: nil)
-        body = { trackingNumber: tracking_number, carrier: carrier, declaredValue: declared_value }
-        body[:provider] = provider if provider
-        @http.post("#{ws_path}/insurance/purchase", body: body)
+      # Buys a policy and charges the premium to the workspace wallet. A shipment that already has a
+      # policy in force is refused with 409 ALREADY_EXISTS.
+      # Pass an idempotency_key you store with the purchase to make your own retry safe: after an
+      # error or a timeout, retry with the same key and the Gateway returns the first result instead
+      # of buying again. Without one, the SDK's own retries still share a key, but a new call gets a new key.
+      def purchase(tracking_number:, carrier_code:, declared_value:, coverage_tier: nil, provider: nil,
+                   idempotency_key: nil)
+        body = { trackingNumber: tracking_number, carrierCode: carrier_code, declaredValue: declared_value,
+                 coverageTier: coverage_tier, provider: provider }.compact
+        @http.post("#{ws_path}/insurance/policies", body: body,
+                   headers: idempotency_key.nil? ? {} : { "Idempotency-Key" => idempotency_key })
       end
 
       def void(policy_id)
         @http.delete("#{ws_path}/insurance/policies/#{policy_id}")
       end
 
-      def file_claim(policy_id, description:, claim_amount:)
-        @http.post("#{ws_path}/insurance/policies/#{policy_id}/claims", body: { description: description, claimAmount: claim_amount })
+      def file_claim(policy_id:, claim_reason:, claim_amount:, evidence_json: nil)
+        body = { policyId: policy_id, claimReason: claim_reason, claimAmount: claim_amount,
+                 evidenceJson: evidence_json }.compact
+        @http.post("#{ws_path}/insurance/claims", body: body)
       end
 
       private

data/lib/flexops/resources/inventory.rb

@@ -15,10 +15,6 @@ module FlexOps
         @http = http
       end
 
-      def post_asn_receipt(receipt)
-        @http.post("#{PROXY}/api/v1/Inventory/postNewAsnReceipt", body: receipt)
-      end
-
       def get_warehouse_snapshot(params = nil)
         @http.get("#{PROXY}/api/v1/Inventory/getWarehouseInventorySnapshot", query: params)
       end
@@ -30,10 +26,6 @@ module FlexOps
       def get_part_numbers(params = nil)
         @http.get("#{PROXY}/api/v1/Inventory/getPartNumberList", query: params)
       end
-
-      def update_inventory(data)
-        @http.post("#{PROXY}/api/v2/Inventory/postCustomerInventoryUpdate", body: data)
-      end
     end
   end
 end

data/lib/flexops/resources/orders.rb

@@ -15,10 +15,6 @@ module FlexOps
         @http = http
       end
 
-      def create(order)
-        @http.post("#{BASE}/postNewOrder", body: order)
-      end
-
       def get_new_orders(params = nil)
         @http.get("#{BASE}/getNewOrderList", query: params)
       end
@@ -39,10 +35,6 @@ module FlexOps
         @http.get("#{BASE}/getIndividualOrderStatusByOrderNumber", query: { orderNumber: order_number })
       end
 
-      def cancel(order_number)
-        @http.post("#{BASE}/cancelOrderByOrderNumber", body: { orderNumber: order_number })
-      end
-
       def get_items(order_number)
         @http.get("#{BASE}/getAllOrderItemsByOrderNumber", query: { orderNumber: order_number })
       end

data/lib/flexops/resources/pickups.rb

@@ -6,6 +6,8 @@
 # Copyright (c) 2021-2026 by FlexOps, LLC. All rights reserved.
 # ***********************************************************************
 
+require "uri"
+
 module FlexOps
   module Resources
     class Pickups
@@ -14,20 +16,27 @@ module FlexOps
         @ws_id = ws_id_proc
       end
 
+      # request:: { carrierCode:, pickupDate:, street:, city:, state:, postalCode:,
+      #           country: (optional, "US"), packageCount:, totalWeightOz: (optional),
+      #           specialInstructions:, readyTime:, closeTime:, contactName:, contactPhone: (all optional) }
       def schedule(request)
         @http.post("#{ws_path}/pickups", body: request)
       end
 
+      # Lists the workspace's scheduled pickups.
       def list
-        @http.get("#{ws_path}/pickups")
+        @http.get("#{ws_path}/pickups/scheduled")
       end
 
-      def get(pickup_id)
-        @http.get("#{ws_path}/pickups/#{pickup_id}")
+      # The Gateway uses "usps" when carrier_code is left out.
+      def get(pickup_id, carrier_code: nil)
+        @http.get("#{ws_path}/pickups/#{pickup_id}", query: carrier_code.nil? ? nil : { carrierCode: carrier_code })
       end
 
-      def cancel(pickup_id)
-        @http.delete("#{ws_path}/pickups/#{pickup_id}")
+      # The Gateway uses "usps" when carrier_code is left out.
+      def cancel(pickup_id, carrier_code: nil)
+        query = carrier_code.nil? ? "" : "?#{URI.encode_www_form(carrierCode: carrier_code)}"
+        @http.delete("#{ws_path}/pickups/#{pickup_id}#{query}")
       end
 
       private

data/lib/flexops/resources/recurring_shipments.rb

@@ -1,58 +1,73 @@
 # ***********************************************************************
 # Package          : flexops
 # Author           : FlexOps, LLC
-# Created          : 2026-03-31
+# Created          : 2026-10-19
 #
 # Copyright (c) 2021-2026 by FlexOps, LLC. All rights reserved.
 # ***********************************************************************
 
-# frozen_string_literal: true
-
 module FlexOps
   module Resources
+    # Recurring shipment schedules. Answers are bare JSON (no envelope); ids are GUID strings.
+    #
+    # Reads work with any API key or a user token. Writes (create, update, delete, pause, resume,
+    # trigger) need a user token (auth.login) or an API key granted the opt-in
+    # "recurring-shipments:write" scope; a key without it gets 403 API_KEY_SCOPE_REQUIRED.
+    #
+    # +interval+ is the Gateway RecurrenceInterval number: Daily 0, Weekly 1, Biweekly 2,
+    # Monthly 3, Custom 4 (Custom runs on +cronExpression+).
     class RecurringShipments
       def initialize(http, ws_id_proc)
         @http = http
         @ws_id = ws_id_proc
       end
 
-      def list(page: nil, page_size: nil, is_active: nil)
-        query = { page: page, pageSize: page_size, isActive: is_active }.compact
-        @http.get("#{ws_path}/recurring-shipments/", query: query.empty? ? nil : query)
+      def list
+        @http.get(ws_path)
       end
 
       def get(id)
-        @http.get("#{ws_path}/recurring-shipments/#{id}")
+        @http.get("#{ws_path}/#{id}")
       end
 
+      # request:: { name:, firstRunUtc: (ISO 8601), interval: (0-4), presetId:, addressId:,
+      #           cronExpression:, maxFailures: (1-100, default 3) }. Each run needs a destination
+      #           +addressId+; a +presetId+ supplies the package and service. Returns the schedule.
       def create(request)
-        @http.post("#{ws_path}/recurring-shipments/", body: request)
+        @http.post(ws_path, body: request)
       end
 
+      # request:: any of name:, presetId:, addressId:, interval:, cronExpression:, maxFailures:.
       def update(id, request)
-        @http.put("#{ws_path}/recurring-shipments/#{id}", body: request)
+        @http.put("#{ws_path}/#{id}", body: request)
       end
 
+      # Returns nil (204).
       def delete(id)
-        @http.delete("#{ws_path}/recurring-shipments/#{id}")
+        @http.delete("#{ws_path}/#{id}")
       end
 
+      # Returns nil (204).
       def pause(id)
-        @http.post("#{ws_path}/recurring-shipments/#{id}/pause")
+        @http.post("#{ws_path}/#{id}/pause")
       end
 
+      # Returns nil (204).
       def resume(id)
-        @http.post("#{ws_path}/recurring-shipments/#{id}/resume")
+        @http.post("#{ws_path}/#{id}/resume")
       end
 
-      def trigger(id)
-        @http.post("#{ws_path}/recurring-shipments/#{id}/trigger")
+      # Runs the schedule now, which creates an order. Pass the same +idempotency_key+ when you
+      # retry a trigger yourself so the Gateway does not create a second order. Returns nil (204).
+      def trigger(id, idempotency_key: nil)
+        @http.post("#{ws_path}/#{id}/trigger",
+                   headers: idempotency_key.nil? ? {} : { "Idempotency-Key" => idempotency_key })
       end
 
       private
 
       def ws_path
-        "/api/workspaces/#{@ws_id.call}"
+        "/api/workspaces/#{@ws_id.call}/recurring-shipments"
       end
     end
   end