Skip to content

docs: add customer groups and wholesale pricing guides#65

Merged
mbates merged 1 commit intomainfrom
docs/customer-groups-and-wholesale-pricing
Apr 15, 2026
Merged

docs: add customer groups and wholesale pricing guides#65
mbates merged 1 commit intomainfrom
docs/customer-groups-and-wholesale-pricing

Conversation

@mbates
Copy link
Copy Markdown
Owner

@mbates mbates commented Apr 15, 2026

Summary

Documentation follow-up for #64 (customer groups + pricing rules).

  • New guide: docs/guides/core/customer-groups.md — full coverage of square.customerGroups (CRUD, list pagination, membership) plus the wholesale workflow.
  • docs/guides/core/catalog.md — new Wholesale Pricing section covering:
    • The product set + discount + pricing rule trio
    • createWholesalePricing() (composite atomic helper)
    • Manual rule construction for advanced cases
    • Time-bounded rules with TIME_PERIOD (RFC 5545 RRULE) and date-bounded rules via validFromDate/validUntilDate
  • README.md — service table now includes customerGroups and checkout; pricing rules called out under catalog.
  • docs/README.md — linked the new guide.
  • CLAUDE.md — added a Documentation section establishing the rule that public API changes require docs in the same PR (or an immediate follow-up like this one).

Test plan

  • Markdown only — no code or tests touched
  • All internal links resolve to real files

- New guide: docs/guides/core/customer-groups.md
- Catalog guide: new "Wholesale Pricing" section covering createWholesalePricing,
  manual rule construction, and time-bounded rules with TIME_PERIOD
- README: add customerGroups/checkout to service table; mention pricing rules
- docs/README.md: link the new guides
- CLAUDE.md: add documentation rule — public API changes require docs in the
  same PR or an immediate follow-up
@codecov
Copy link
Copy Markdown

codecov bot commented Apr 15, 2026

Codecov Report

✅ All modified and coverable lines are covered by tests.
✅ Project coverage is 97.06%. Comparing base (756b613) to head (dd303cf).
⚠️ Report is 6 commits behind head on main.

Additional details and impacted files
@@           Coverage Diff           @@
##             main      #65   +/-   ##
=======================================
  Coverage   97.06%   97.06%           
=======================================
  Files          18       18           
  Lines         955      955           
  Branches      277      277           
=======================================
  Hits          927      927           
  Misses          1        1           
  Partials       27       27           

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

🚀 New features to boost your workflow:
  • ❄️ Test Analytics: Detect flaky tests, report on failures, and find test suite problems.
  • 📦 JS Bundle Analysis: Save yourself from yourself by tracking and limiting bundle sizes in JS merges.

@mbates mbates merged commit f921736 into main Apr 15, 2026
4 checks passed
@mbates mbates deleted the docs/customer-groups-and-wholesale-pricing branch April 15, 2026 01:01
@github-actions
Copy link
Copy Markdown

🎉 This PR is included in version 1.11.0 🎉

The release is available on:

Your semantic-release bot 📦🚀

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant