flexops 1.0.2 → 2.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 46267de883ed8970bdcfc87d77c86edcf9b33a5d1ffe0d312a10961ea43646fb
-  data.tar.gz: 9c828d5d8fbc74b2b3abee2640b1742de692a800e51fe60f3fd671b728564dc6
+  metadata.gz: 99bb604e4e35131d7525633fbfad7103b380170556b47250599192256636eec1
+  data.tar.gz: b9fb3ccd224541332bd03fd9e8510937fbed4d093c6ab3443dfd41fee0565229
 SHA512:
-  metadata.gz: 439f0b3d74903968585f2d980e80d00798f9784903100851804949a7602c3bc163f0ce3600e5602ebfe6fca0e85d93b64f2bc5b5269abfebd9eb573535db20b5
-  data.tar.gz: eff6ea869f9cfd93dca01e4bc9bfd794a64fb36f51825743ae7f0bef5783e8698b08324b976048b0a360622d6d49de9c355083fac6072007266080e5461aa874
+  metadata.gz: 12823e90e21cd1eeefcf883ab5c7ed9a4e9d008b2e26bd80ac6014a05e3b6e6b57e4054a3757574173886b2c8ed6a08e6c8d3a2863f6034eb592e6e8d03da5c1
+  data.tar.gz: fb7a48fb211dfb1af4ddd9a0be588eb58318b8ffd445578a09dcacdef625ff9dc8e3dbc593b59a21da18acf678d67d9ca0bd76aef55a22843be9748bfddcf5fa

data/README.md

@@ -40,23 +40,51 @@ rates = client.shipping.get_rates(
   package: {weight: 16, weightUnit: "oz"}
 )
 
-# Create a label with the cheapest rate
-cheapest = rates["rates"].min_by { |r| r["rate"].to_f }
-label = client.shipping.create_label(
-  carrier:      cheapest["carrier"],
-  service:      cheapest["service"],
-  from_address: {name: "Warehouse", street1: "123 Main St", city: "New York", state: "NY", zip: "10001", country: "US"},
-  to_address:   {name: "Customer",  street1: "456 Oak Ave", city: "Los Angeles", state: "CA", zip: "90210", country: "US"},
-  parcel:       {weight: 16, weight_unit: "oz"}
-)
-
-puts "Label URL: #{label["data"]["labelUrl"]}"
-puts "Tracking:  #{label["data"]["trackingNumber"]}"
+request = {
+  carrierCode: "USPS", serviceCode: "GROUND_ADVANTAGE",
+  origin: {name: "Warehouse", addressLine1: "123 Main St", city: "New York", stateProvince: "NY", postalCode: "10001", countryCode: "US"},
+  destination: {name: "Customer", addressLine1: "456 Oak Ave", city: "Los Angeles", stateProvince: "CA", postalCode: "90210", countryCode: "US"},
+  package: {weight: 16, weightUnit: "oz"},
+  maximumPostageAmount: 10.25, # Caller-approved ceiling in USD.
+  # Required without an orderId. The SDK never fills it in; NONE (0) = not hazardous.
+  hazmatClassification: FlexOps::HazmatClassification::NONE
+}
+preview = client.shipping.create_label(request)
+puts preview["quotedPostageAmount"]
+
+# Call only after explicit caller approval, within five minutes.
+purchase_approved_label = lambda do |purchase_key|
+  client.shipping.create_label(
+    request.merge(confirmationToken: preview["confirmationToken"]),
+    idempotency_key: purchase_key # Persist per purchase; reuse on retries.
+  )
+end
 
 # Track a shipment
 info = client.shipping.track("9400111899223456789012")
 ```
 
+### Live label approval (1.1.0+)
+
+The example below requires SDK 1.1.0 or later. Version 1.0.2 does not
+include the per-call idempotency argument.
+
+For live domestic single-label requests, `maximumPostageAmount` is required: positive
+USD, at most two decimal places, up to 1,000,000. Missing or invalid values return
+400 `ApprovalRequired`. Omitting `confirmationToken` returns a raw 200 preview
+(`status`, `quotedPostageAmount`, `maximumPostageAmount`, `currency`, `expiresAt`,
+`confirmationToken`). After explicit approval, resubmit the same shipment and ceiling
+with the token and a unique per-purchase `Idempotency-Key` header. The token expires
+after five minutes. A successful purchase returns the raw 201 label, including
+`labelId`, `trackingNumber`, `carrierCode`, and `labelData`, without a `data` wrapper.
+
+Keep the same key and request across retries. An uncertain outcome needs reconciliation;
+do not start another purchase with a new key. An expired approval returns 409
+`ApprovalExpired`; obtain and explicitly approve a fresh preview when no purchase is
+unresolved. The ceiling bounds postage authorization, not later adjustments or separate
+fees. Sandbox execution bypasses approval; batch, return, and raw carrier routes have
+separate contracts. The SDK never automatically confirms a preview.
+
 ## Authentication
 
 ### API key (recommended)
@@ -69,7 +97,8 @@ client = FlexOps::Client.new(api_key: "fxk_live_...", workspace_id: "ws_abc123")
 
 ```ruby
 client = FlexOps::Client.new(base_url: "https://gateway.flexops.io")
-client.auth.login(email: "user@example.com", password: "password")
+session = client.auth.login(email: "user@example.com", password: "password")
+client.set_access_token(session["data"]["token"])
 client.workspace_id = "ws_abc123"
 ```
 
@@ -81,38 +110,176 @@ Use `fxk_test_...` (instead of `fxk_live_...`) to route to the sandbox environme
 client = FlexOps::Client.new(api_key: "fxk_test_...", workspace_id: "ws_abc123")
 ```
 
-## Direct carrier operations
+## Carrier-specific calls
+
+`client.carriers.usps`, `.ups`, `.fedex` and `.dhl` call carrier routes through the legacy
+`/api/ApiProxy` passthrough, which the Gateway retires on 2027-06-30.
+
+- Lookups (GET), such as address checks, tracking and DHL rates, work with an API key or a user
+  token.
+- The writes (POST, PUT and DELETE, such as `usps.get_domestic_rates`, `fedex.cancel_shipment`
+  or `ups.create_pickup`) are deprecated. They need a user token from `auth.login`: API keys get
+  403 `API_KEY_SCOPE_REQUIRED`, and no API-key scope will be added for them. They stop working when
+  the proxy is retired.
+- Label generation through the proxy is closed (410 Gone), so the SDK has no carrier label
+  method.
+
+Use the native routes instead where they cover the call:
+
+| Instead of | Use |
+|---|---|
+| Carrier rate calls | `client.shipping.get_rates` |
+| Carrier labels | `client.shipping.create_label` (`client.returns.generate_label` for returns) |
+| Label cancels | `client.shipping.cancel_label` |
+| Carrier pickups | `client.pickups.schedule`, `list`, `get`, `cancel` |
+| USPS scan forms | `client.scan_forms.create` |
+| Address validation | `client.shipping.validate_address` |
+| Tracking | `client.shipping.track` |
+
+```ruby
+# USPS city and state for a ZIP code (works with an API key)
+place = client.carriers.usps.city_state_lookup("10001")
+```
+
+## Retries and idempotency
+
+The client retries a request up to three times with exponential backoff:
+
+- GET: after a dropped connection or timeout, and on 429, 500, 502, 503 and 504.
+- POST, PUT and PATCH: after a dropped connection or timeout, and on 429, 502, 503, 504 and
+  409 `IDEMPOTENCY_CONFLICT` (the first request with that key is still running). Never on 500:
+  the Gateway does not replay a 5xx, so a retry could run the write (and charge the wallet)
+  again.
+- DELETE: only on 429.
+
+A key reused with a different request body gets 422 `IDEMPOTENCY_KEY_REUSED`; it is not retried
+and raises `FlexOps::Error` with that `code`. Error codes are matched exactly, so a label
+purchase's own 409 `IdempotencyConflict` (altered inputs under a used key) is not retried either.
+
+Every POST, PUT and PATCH carries an `Idempotency-Key` header. Pass your own to
+`shipping.create_label(request, idempotency_key: ...)`, `insurance.purchase(..., idempotency_key: ...)`
+or `carbon_offsets.purchase(..., idempotency_key: ...)`, and store it so a retry your app makes after
+an error or a timeout reuses it; otherwise the client generates one UUID
+per call and sends it on every retry of that call, so the Gateway replays a write it already
+finished instead of running it twice. A 2xx response with no body returns `nil`.
+
+## Workspace members
+
+Roles are the Gateway `WorkspaceRole` numbers (Owner 0, Admin 1, Member 2, Merchant 3). Pass a
+`FlexOps::WorkspaceRole` constant or a name; the SDK sends the number.
+
+```ruby
+client.workspaces.invite_member(email: "ops@example.com", role: :member)
+client.workspaces.update_member_role(user_id, FlexOps::WorkspaceRole::ADMIN)
+
+result = client.workspaces.list_members
+members = result["data"]["members"] # also "pendingInvites", "userLimit", "canInviteMore"
+```
+
+## Recurring shipments, report schedules and email templates
 
-Access carrier-specific endpoints when you need full control:
+Reads work with any API key or a user token. Writes (every POST, PUT and DELETE, including the
+email template preview) need a user token from `auth.login` or an API key granted the
+resource's opt-in scope: `recurring-shipments:write`, `report-schedules:write` or
+`email-templates:write`. Older keys do not have these scopes; a key without one gets 403
+`API_KEY_SCOPE_REQUIRED` with `requiredScopes`. Enums are sent as numbers and ids are GUID
+strings.
 
 ```ruby
-# USPS domestic label
-label = client.carriers.usps.create_domestic_label(
-  image_type: "PDF",
-  mail_class: "PRIORITY_MAIL",
-  weight_in_ounces: 16
+# Recurring shipments (bare JSON). interval: Daily 0, Weekly 1, Biweekly 2, Monthly 3, Custom 4
+schedule = client.recurring_shipments.create(
+  name: "Weekly restock", addressId: address_id, presetId: preset_id,
+  interval: 1, firstRunUtc: "2026-11-02T14:00:00Z"
 )
+client.recurring_shipments.pause(schedule["id"])  # nil (204); also resume, delete
+client.recurring_shipments.trigger(schedule["id"], idempotency_key: run_key) # creates an order now
+
+# Report schedules ({ success, data, message } envelope).
+# format: Csv 0, Json 1; frequencyType: Daily 0, Weekly 1, Monthly 2
+report = client.report_schedules.create(
+  reportType: "shipments", format: 0, frequencyType: 1, dayOfWeek: 1,
+  timeOfDayUtc: "08:00:00", recipientEmails: "ops@example.com"
+)["data"]
+client.report_schedules.toggle(report["id"]) # flips isEnabled
+
+# Tracking email templates (bare JSON), one per event. eventType: LabelCreated 0, InTransit 1,
+# OutForDelivery 2, Delivered 3, Exception 4, ReturnToSender 5
+client.email_templates.upsert(eventType: 3, subjectTemplate: "Delivered: {{tracking_number}}",
+                              htmlBodyTemplate: "<p>Your package arrived.</p>")
+client.email_templates.preview(subject_template: "Hi {{recipient_name}}", html_body_template: "<p>{{status}}</p>")
+```
 
-# FedEx rate quote
-rates = client.carriers.fedex.get_rates(...)
+## Wallet balance
 
-# UPS tracking
-info = client.carriers.ups.track(tracking_number: "1Z999AA10123456784")
+```ruby
+balance = client.wallet.get_balance # {"hasWallet" => true, "balanceCents" => 1250, "balance" => 12.5}
+```
+
+The request carries `X-Workspace-Id` set to the client's `workspace_id`. Funding and
+transaction history are managed in the FlexOps portal.
+
+## Webhook subscriptions
 
-# DHL shipment
-shipment = client.carriers.dhl.create_shipment(...)
+```ruby
+# Leave events out to receive every event.
+webhook = client.webhooks.create(
+  url: "https://your-app.com/webhooks/flexops",
+  events: [FlexOps::WebhookEventType::LABEL_CREATED,
+           FlexOps::WebhookEventType::LABEL_CANCELED,
+           FlexOps::WebhookEventType::BATCH_COMPLETED]
+)
+signing_secret = webhook["secret"] # "whsec_...", returned only on create; store it
+
+# Change the events (or url, description, status: "Active", "Paused", "Disabled").
+client.webhooks.update(webhook["id"], events: [FlexOps::WebhookEventType::LABEL_CREATED])
 ```
 
+`create` returns the subscription itself (`"id"`, `"url"`, `"eventTypes"`, `"status"`, `"secret"`, ...), because the Gateway answers it with the bare subscription. The other webhook methods return the usual `{"success" => true, "data" => ...}` envelope.
+
+`events` is sent as the Gateway's comma-separated `eventTypes`. FlexOps sends these events, named exactly as below (`FlexOps::WebhookEventType::ALL` lists them). Names are PascalCase and matched exactly, so a name like `label.created` would never match; `create` and `update` raise `ArgumentError`, before any request, for an unknown name, an empty list or a non-array.
+
+| Event | Sent when |
+|---|---|
+| `LabelCreated` | A live label is purchased (sandbox labels send nothing) |
+| `LabelCanceled` | A live label is voided |
+| `BatchCompleted` | A batch label job finishes |
+| `TrackingUpdated` | A USPS tracking scan arrives (USPS push-tracking pilot workspaces only) |
+| `TrackingDelivered` | A USPS package is delivered (USPS push-tracking pilot workspaces only) |
+
+You can send a raw `eventTypes:` string (`"*"` or names joined by commas with no spaces) instead of `events:`; it is passed through unchecked, for example to subscribe to an event newer than your SDK version.
+
 ## Webhook verification
 
+FlexOps signs each delivery with HMAC-SHA256 over `{X-FlexOps-Timestamp}.{raw body}`, keyed with your subscription secret (`whsec_...`, used as-is), and sends it as `X-FlexOps-Signature: sha256=<hex>`. Verify the raw body before you parse it.
+
 ```ruby
-valid = FlexOps::Resources::Webhooks.verify_signature(
-  payload:   request.body.read,
-  signature: request.headers["X-FlexOps-Signature"],
-  secret:    "whsec_..."
-)
+# Rails controller action
+def flexops_webhook
+  payload = request.raw_post
+
+  valid = FlexOps::Resources::Webhooks.verify_signature(
+    payload:   payload,
+    signature: request.headers["X-FlexOps-Signature"], # "sha256=..."
+    timestamp: request.headers["X-FlexOps-Timestamp"], # Unix seconds
+    secret:    ENV.fetch("FLEXOPS_WEBHOOK_SECRET")      # "whsec_..."
+  )
+  return head :unauthorized unless valid
+
+  # The body is the event data itself (no type/data envelope).
+  # The event name is in a header; test events send "test".
+  data = JSON.parse(payload)
+  case request.headers["X-FlexOps-Event"]
+  when "test"
+    # data: {"type"=>"test", "message"=>"...", "timestamp"=>"...", "subscriptionId"=>"..."}
+  when "TrackingUpdated"
+    # data["trackingNumber"], data["status"], ...
+  end
+  head :ok
+end
 ```
 
+Deliveries whose timestamp is more than 300 seconds from your clock (either way) are rejected to limit replays; pass `tolerance:` (seconds) to change that. `verify_signature!` takes the same arguments and raises `FlexOps::WebhookSignatureError` instead of returning `false`; its `code` says why (`WEBHOOK_SIGNATURE_MISMATCH`, `WEBHOOK_TIMESTAMP_OUTSIDE_TOLERANCE`, `WEBHOOK_INVALID_TIMESTAMP`, `WEBHOOK_MISSING_SIGNATURE`, `WEBHOOK_MISSING_SECRET`).
+
 ## Curl quickstart
 
 Every SDK method is a thin wrapper around the FlexOps REST API. If you want to verify the API before committing to the SDK — or you're integrating from a language we don't ship a SDK for — these curl invocations hit the same endpoints:
@@ -128,24 +295,30 @@ curl -X POST https://gateway.flexops.io/api/shipping/rates \
     "package": {"weight": 16, "weightUnit": "oz"}
   }'
 
-# Create a label
-curl -X POST https://gateway.flexops.io/api/workspaces/ws_abc123/shipping/labels \
+# Preview a live label; this does not purchase it.
+# hazmatClassification 0 = not hazardous; required when there is no orderId.
+curl -X POST https://gateway.flexops.io/api/shipping/labels \
   -H "X-API-Key: fxk_live_..." \
   -H "Content-Type: application/json" \
   -d '{
-    "carrier":  "USPS",
-    "service":  "PRIORITY_MAIL",
-    "fromAddress": {"name": "Warehouse", "street1": "123 Main St", "city": "New York", "state": "NY", "zip": "10001", "country": "US"},
-    "toAddress":   {"name": "Customer",  "street1": "456 Oak Ave", "city": "Los Angeles", "state": "CA", "zip": "90210", "country": "US"},
-    "parcel":   {"weight": 16, "weightUnit": "oz"}
+    "carrierCode": "USPS", "serviceCode": "GROUND_ADVANTAGE",
+    "origin": {"name": "Warehouse", "addressLine1": "123 Main St", "city": "New York", "stateProvince": "NY", "postalCode": "10001", "countryCode": "US"},
+    "destination": {"name": "Customer", "addressLine1": "456 Oak Ave", "city": "Los Angeles", "stateProvince": "CA", "postalCode": "90210", "countryCode": "US"},
+    "package": {"weight": 16, "weightUnit": "oz"},
+    "maximumPostageAmount": 10.25,
+    "hazmatClassification": 0
   }'
 
+# After explicit approval, resend the same body with confirmationToken from
+# the preview and an Idempotency-Key header unique to this purchase.
+# See the SDK example above; retain that key for retries.
+
 # Track a shipment
-curl https://gateway.flexops.io/api/workspaces/ws_abc123/shipping/track/9400111899223456789012 \
+curl https://gateway.flexops.io/api/shipping/track/9400111899223456789012 \
   -H "X-API-Key: fxk_live_..."
 
-# Cancel a label (via the unified carrier-agnostic endpoint)
-curl -X DELETE https://gateway.flexops.io/api/v3.0/shipping/Usps/cancel/9400111899223456789012 \
+# Cancel a label
+curl -X DELETE "https://gateway.flexops.io/api/shipping/labels/lbl_123?carrierCode=USPS" \
   -H "X-API-Key: fxk_live_..."
 ```
 
@@ -155,26 +328,27 @@ Use an `fxk_test_...` key instead of `fxk_live_...` to hit the sandbox environme
 
 | Resource | Description |
 |----------|-------------|
-| `client.auth` | Login, register, password management |
-| `client.workspaces` | Workspace CRUD, membership, branding |
-| `client.shipping` | Rate shopping, labels, tracking, batch, cancel |
-| `client.carriers` | USPS, UPS, FedEx, DHL direct endpoints |
-| `client.webhooks` | Subscription CRUD, signature verification, delivery logs |
-| `client.wallet` | Balance, transactions, auto-reload |
-| `client.insurance` | Quotes, purchase, claims (first-party + U-PIC) |
-| `client.returns` | RMA lifecycle: create, batch, QR codes, photo upload, cost recovery |
-| `client.api_keys` | Key creation, rotation, revocation |
-| `client.analytics` | Shipments, orders, carrier performance |
-| `client.orders` | Order management |
-| `client.inventory` | Warehouse inventory |
-| `client.pickups` | Carrier pickup scheduling |
+| `client.auth` | Login, token refresh, logout |
+| `client.workspaces` | List and read workspaces; list, invite and remove members, change roles |
+| `client.shipping` | Rate shopping, labels, tracking, address validation, batch, cancel |
+| `client.carriers` | USPS, UPS, FedEx and DHL calls through the legacy proxy; writes are deprecated and need a user token |
+| `client.webhooks` | Subscription create/update/delete, secret rotation, test events, delivery logs, signature verification |
+| `client.wallet` | Workspace balance |
+| `client.insurance` | Providers, quotes, policies, void, claims |
+| `client.returns` | List and read returns; create RMAs, return labels, receive |
+| `client.analytics` | Shipments, orders, carrier performance (legacy proxy reads) |
+| `client.orders` | Order reads (legacy proxy) |
+| `client.inventory` | Inventory reads (legacy proxy) |
+| `client.pickups` | Schedule, list, read and cancel carrier pickups |
 | `client.scan_forms` | USPS scan forms |
-| `client.rules` | Shipping automation rules |
-| `client.offsets` | Carbon offset purchases |
-| `client.hs_codes` | HS code lookup for international customs |
-| `client.recurring_shipments` | Scheduled recurring shipments |
-| `client.email_templates` | Branded post-purchase email templates |
-| `client.reports` | Report generation and scheduled delivery |
+| `client.rules` | Shipping rules: create, read, update, delete, reorder, test |
+| `client.hs_codes` | HS code search and lookup, landed cost |
+| `client.carbon_offsets` | Carbon offset quotes, purchases, summary and settings |
+| `client.recurring_shipments` | Recurring shipment schedules: create, update, pause, resume, trigger, delete |
+| `client.report_schedules` | Scheduled report emails: create, update, toggle, delete |
+| `client.email_templates` | Tracking email templates: upsert, preview, delete |
+
+API keys, workspace settings and account management are managed in the FlexOps portals.
 
 ## Configuration
 
@@ -189,7 +363,7 @@ client = FlexOps::Client.new(
 
 ## Requirements
 
-- Ruby 3.0+
+- Ruby 3.1+
 
 ## License
 

data/lib/flexops/client.rb

@@ -10,9 +10,9 @@ module FlexOps
   class Client
     attr_accessor :workspace_id
     attr_reader :auth, :workspaces, :shipping, :carriers, :webhooks, :wallet,
-                :insurance, :returns, :api_keys, :analytics, :orders, :inventory,
-                :pickups, :scan_forms, :rules, :offsets, :hs_codes,
-                :recurring_shipments, :email_templates, :reports
+                :insurance, :returns, :analytics, :orders, :inventory,
+                :pickups, :scan_forms, :rules, :hs_codes, :carbon_offsets,
+                :recurring_shipments, :report_schedules, :email_templates
 
     def initialize(api_key: nil, access_token: nil, base_url: "https://gateway.flexops.io", workspace_id: nil, timeout: 30)
       @http = HttpClient.new(base_url: base_url, api_key: api_key, access_token: access_token, timeout: timeout)
@@ -28,18 +28,17 @@ module FlexOps
       @wallet = Resources::Wallet.new(@http, ws_id_proc)
       @insurance = Resources::Insurance.new(@http, ws_id_proc)
       @returns = Resources::Returns.new(@http, ws_id_proc)
-      @api_keys = Resources::ApiKeys.new(@http, ws_id_proc)
       @analytics = Resources::Analytics.new(@http)
       @orders = Resources::Orders.new(@http)
       @inventory = Resources::Inventory.new(@http)
       @pickups = Resources::Pickups.new(@http, ws_id_proc)
       @scan_forms = Resources::ScanForms.new(@http, ws_id_proc)
       @rules = Resources::Rules.new(@http, ws_id_proc)
-      @offsets = Resources::Offsets.new(@http, ws_id_proc)
-      @hs_codes = Resources::HsCodes.new(@http, ws_id_proc)
+      @hs_codes = Resources::HsCodes.new(@http)
+      @carbon_offsets = Resources::CarbonOffsets.new(@http, ws_id_proc)
       @recurring_shipments = Resources::RecurringShipments.new(@http, ws_id_proc)
+      @report_schedules = Resources::ReportSchedules.new(@http, ws_id_proc)
       @email_templates = Resources::EmailTemplates.new(@http, ws_id_proc)
-      @reports = Resources::Reports.new(@http, ws_id_proc)
     end
 
     def set_access_token(token)

data/lib/flexops/errors.rb

@@ -32,4 +32,13 @@ module FlexOps
       @retry_after = retry_after
     end
   end
+
+  # Raised by Resources::Webhooks.verify_signature! when a webhook delivery
+  # is not authentic or not fresh. +code+ says why, for example
+  # "WEBHOOK_SIGNATURE_MISMATCH" or "WEBHOOK_TIMESTAMP_OUTSIDE_TOLERANCE".
+  class WebhookSignatureError < Error
+    def initialize(message, code:)
+      super(message, code: code)
+    end
+  end
 end

data/lib/flexops/hazmat_classification.rb

@@ -0,0 +1,34 @@
+# ***********************************************************************
+# Package          : flexops
+# Author           : FlexOps, LLC
+# Created          : 2026-10-12
+#
+# Copyright (c) 2021-2026 by FlexOps, LLC. All rights reserved.
+# ***********************************************************************
+
+module FlexOps
+  # USPS HAZMAT classification, sent as the Gateway HazmatClassification number.
+  #
+  # There is no default: leave hazmatClassification out when you have no answer, or send
+  # HazmatClassification::NONE (0) to declare that the parcel holds no dangerous goods.
+  # A label without an orderId must declare one.
+  module HazmatClassification
+    NONE = 0
+    LIMITED_QUANTITY = 1
+    LITHIUM_BATTERY_CONTAINED_IN_EQUIPMENT = 2
+    LITHIUM_BATTERY_PACKED_WITH_EQUIPMENT = 3
+    LITHIUM_BATTERY_STANDALONE = 4
+    OTHER_RESTRICTED = 5
+    LITHIUM_BATTERY_USED_DEVICE = 6
+
+    ALL = {
+      NONE: NONE,
+      LIMITED_QUANTITY: LIMITED_QUANTITY,
+      LITHIUM_BATTERY_CONTAINED_IN_EQUIPMENT: LITHIUM_BATTERY_CONTAINED_IN_EQUIPMENT,
+      LITHIUM_BATTERY_PACKED_WITH_EQUIPMENT: LITHIUM_BATTERY_PACKED_WITH_EQUIPMENT,
+      LITHIUM_BATTERY_STANDALONE: LITHIUM_BATTERY_STANDALONE,
+      OTHER_RESTRICTED: OTHER_RESTRICTED,
+      LITHIUM_BATTERY_USED_DEVICE: LITHIUM_BATTERY_USED_DEVICE
+    }.freeze
+  end
+end