shopify-api-node
Advanced tools
Comparing version 2.1.0 to 2.2.0
{ | ||
"name": "shopify-api-node", | ||
"version": "2.1.0", | ||
"version": "2.2.0", | ||
"description": "Shopify API bindings for Node.js", | ||
@@ -5,0 +5,0 @@ "main": "index.js", |
@@ -22,11 +22,10 @@ # shopify-api-node | ||
Returns a new Shopify instance. Throws an error when required options are | ||
missing. | ||
Creates a new `Shopify` instance. | ||
**Arguments** | ||
#### Arguments | ||
`options` - Required - A plain JavaScript object that contains the | ||
- `options` - Required - A plain JavaScript object that contains the | ||
configuration options. | ||
**Options** | ||
#### Options | ||
@@ -44,3 +43,5 @@ - `shopName` - Required - A string that specifies the shop name. | ||
permanent [OAuth 2.0][oauth] access token. This option is mutually exclusive | ||
with the `apiKey` and `password` options. | ||
with the `apiKey` and `password` options. If you are looking for a premade | ||
solution to obtain an access token, take a look at the [shopify-token][] | ||
module. | ||
- `timeout` - Optional - A number that specifies the milliseconds to wait for | ||
@@ -50,4 +51,12 @@ the server to send response headers before aborting the request. Defaults to | ||
**Example** | ||
#### Return value | ||
A `Shopify` instance. | ||
#### Exceptions | ||
Throws an `Error` exception if the required options are missing. | ||
#### Example | ||
```js | ||
@@ -101,2 +110,4 @@ const Shopify = require('shopify-api-node'); | ||
- apiPermission | ||
- `delete()` | ||
- applicationCharge | ||
@@ -391,2 +402,3 @@ - `activate(id, params)` | ||
[oauth]: https://help.shopify.com/api/guides/authentication/oauth | ||
[shopify-token]: https://github.com/lpinca/shopify-token | ||
[becoming-a-shopify-app-developer]: https://app.shopify.com/services/partners/signup?ref=microapps | ||
@@ -393,0 +405,0 @@ [checking-out-the-roots]: https://help.shopify.com/api/guides?ref=microapps |
License Policy Violation
LicenseThis package is not allowed per your license policy. Review the package's license to ensure compliance.
Found 1 instance in 1 package
License Policy Violation
LicenseThis package is not allowed per your license policy. Review the package's license to ensure compliance.
Found 1 instance in 1 package
58622
48
1621
408