@robinpath/square
v0.1.1
Published
Square module for RobinPath.
Readme
@robinpath/square
Square module for RobinPath.
Why use this module?
The square module lets you:
- listCatalogItems
- getCatalogItem
- upsertCatalogObject
- deleteCatalogObject
- searchCatalog
All functions are callable directly from RobinPath scripts with a simple, consistent API.
Installation
npm install @robinpath/squareQuick Start
1. Set up credentials
square.setCredentials "your-credentials"2. listCatalogItems
square.listCatalogItemsAvailable Functions
| Function | Description |
|----------|-------------|
| square.setCredentials | Configure square credentials. |
| square.listCatalogItems | listCatalogItems |
| square.getCatalogItem | getCatalogItem |
| square.upsertCatalogObject | upsertCatalogObject |
| square.deleteCatalogObject | deleteCatalogObject |
| square.searchCatalog | searchCatalog |
| square.listCustomers | listCustomers |
| square.getCustomer | getCustomer |
| square.createCustomer | createCustomer |
| square.updateCustomer | updateCustomer |
| square.deleteCustomer | deleteCustomer |
| square.listOrders | listOrders |
| square.getOrder | getOrder |
| square.createOrder | createOrder |
| square.listLocations | listLocations |
| square.getLocation | getLocation |
| square.listInventory | listInventory |
| square.adjustInventory | adjustInventory |
| square.retrieveInventoryCount | retrieveInventoryCount |
| square.getMerchant | getMerchant |
| square.listPayments | listPayments |
Examples
listCatalogItems
square.listCatalogItemsgetCatalogItem
square.getCatalogItemupsertCatalogObject
square.upsertCatalogObjectIntegration with RobinPath
import { RobinPath } from "@wiredwp/robinpath";
import Module from "@robinpath/square";
const rp = new RobinPath();
rp.registerModule(Module.name, Module.functions);
rp.registerModuleMeta(Module.name, Module.functionMetadata);
const result = await rp.executeScript(`
square.setCredentials "your-credentials"
square.listCatalogItems
`);Full API Reference
See MODULE.md for complete documentation including all parameters, return types, error handling, and advanced examples.
Related Modules
@robinpath/shopify— Shopify module for complementary functionality@robinpath/woocommerce— WooCommerce module for complementary functionality@robinpath/bigcommerce— BigCommerce module for complementary functionality@robinpath/json— JSON module for complementary functionality
License
MIT
