square

v36.0.0

Use Square APIs to manage and run business including payment, customer, product, inventory, and employee management. For more information about how to use this package see README

Latest version published 7 days ago

License: MIT

NPM

GitHub

Package Health Score

71 / 100

security
No known security issues
popularity
Recognized
maintenance
Sustainable
community
Limited

Explore Similar Packages

Security

No known security issues

All security vulnerabilities belong to production dependencies of direct and indirect packages.

Security and license risk for significant versions

All Versions

Version				Vulnerabilities	License Risk
36.0.0	\|	04/2024		0 C 0 H 0 M 0 L	0 H 0 M 0 L
35.1.0	\|	03/2024	Popular	0 C 0 H 0 M 0 L	0 H 0 M 0 L
34.0.1	\|	01/2024		0 C 0 H 0 M 0 L	0 H 0 M 0 L
33.1.0	\|	12/2023		0 C 0 H 0 M 0 L	0 H 0 M 0 L
33.0.0	\|	11/2023		0 C 0 H 0 M 0 L	0 H 0 M 0 L

License

MIT

Security Policy

Is your project affected by vulnerabilities?

Scan your projects for vulnerabilities. Fix quickly with automated fixes. Get started with Snyk for free.

Get started free

Popularity

Recognized

Weekly Downloads (17,186)

GitHub Stars: 67
Forks: 31
Contributors: 20

Direct Usage Popularity

The npm package square receives a total of 17,186 downloads a week. As such, we scored square popularity level to be Recognized.

Based on project statistics from the GitHub repository for the npm package square, we found that it has been starred 67 times.

Downloads are calculated as moving averages for a period of the last 12 months, excluding weekends and known missing data points.

Community

Limited

Readme.md: Yes
Contributing.md: No
Code of Conduct: No
Contributors: 20
Funding: No

With more than 10 contributors for the square repository, this is possibly a sign for a growing and inviting community.

We found a way for you to contribute to the project! Looks like square is missing a Code of Conduct.

Embed Package Health Score Badge

Maintenance

Sustainable

Commit Frequency

Open Issues: 19
Open PR: 14
Last Release: 7 days ago
Last Commit: 2 years ago

Further analysis of the maintenance status of square based on released npm versions cadence, the repository activity, and other data points determined that its maintenance is Sustainable.

We found that square demonstrates a positive version release cadence with at least one new version released in the past 3 months.

In the past month we didn't find any pull request activity or change in issues status has been detected for the GitHub repository.

Keep your project healthy

Check your package.json

Ensure all the packages you're using are healthy and well-maintained

Snyk Vulnerability Scanner

Get health score & security insights directly in your IDE

Package

Node.js Compatibility: >=14.17.0

Age: 12 years
Dependencies: 6 Direct
Versions: 67
Install Size: 7.1 MB
Dist-tags: 1
# of Files: 5.87K
Maintainers: 6
TS Typings: Yes

square has more than a single and default latest tag published for the npm package. This means, there may be other tags available for this package, such as next to indicate future releases, or stable to indicate stable releases.

Readme

Square Node.js SDK

Use this JavaScript library to manage Square resources (such as payments, orders, items, and inventory) for your own Square account or on behalf of Square sellers.

Requirements

Use of the Square Node.js SDK requires:

Node.js 14 or higher

This SDK supports Node.js versions that are either current, or that are in long-term support status (LTS). The SDK does not support Node.js versions that have reached their end-of-life (EOL). For more information on Node.js versioning, see .

This SDK is for use with Node.js only. It does not support other usages, such as for web browsers or frontend applications.

Installation

For more information, see Set Up Your Square SDK for a Node.js Project.

Quickstart

For more information, see Square Node.js SDK Quickstart.

Usage

For more information, see Using the Square Node.js SDK.

Tests

First, clone the repo locally and cd into the directory.

git clone https://github.com/square/square-nodejs-sdk.git
cd square-nodejs-sdk

Next, install dependencies and build.

npm install
npm run build

Before running the tests, get a sandbox access token from your Developer Dashboard and use it to set a SQUARE_SANDBOX_TOKEN environment variable.

export SQUARE_SANDBOX_TOKEN="YOUR SANDBOX ACCESS TOKEN HERE"

And run the tests.

npm test

SDK Reference

Payments

Terminal

Terminal

Orders

Subscriptions

Subscriptions

Invoices

Invoices

Items

Customers

Loyalty

Loyalty

Gift Cards

Bookings

Business

Team

Team
Labor

Financials

Bank Accounts

Online

Authorization

Webhook Subscriptions

Webhook Subscriptions

Deprecated APIs

The following Square APIs are deprecated:

Employees - replaced by the Team API. For more information, see Migrate from the Employees API.
Transactions - replaced by the Orders and Payments APIs. For more information, see Migrate from the Transactions API.

square dependencies

@apimatic/authentication-adapters @apimatic/axios-client-adapter @apimatic/core @apimatic/json-bigint @apimatic/schema @types/node

square development dependencies

@types/jest @types/uuid @typescript-eslint/eslint-plugin @typescript-eslint/parser eslint jest ts-jest tslib typescript uuid

FAQs

What is square?

Use Square APIs to manage and run business including payment, customer, product, inventory, and employee management. Visit Snyk Advisor to see a full health score report for square, including popularity, security, maintenance & community analysis.

Is square popular?

The npm package square receives a total of 17,186 weekly downloads. As such, square popularity was classified as a recognized. Visit the popularity section on Snyk Advisor to see the full health analysis.

Is square well maintained?

We found indications that square maintenance is sustainable demonstrating some project activity. We saw a total of 20 open source contributors collaborating on the project. See the full package health analysis to learn more about the package maintenance status.

Is square safe to use?

The npm package square was scanned for known vulnerabilities and missing license, and no issues were found. Thus the package was deemed as safe to use. See the full health analysis review.

Last updated on 23 April-2024, at 03:48 (UTC).

Build a secure application checklist

Select a recommended open source package

Minimize your risk by selecting secure & well maintained open source packages

DONE

Scan your app for vulnerabilities

Scan your application to find vulnerabilities in your: source code, open source dependencies, containers and configuration files

SCAN NOW

Fix identified vulnerabilities

Easily fix your code by leveraging automatically generated PRs

AUTO FIX

Monitor for new issues

New vulnerabilities are discovered every day. Get notified if your application is affected

MONITOR APP