Product
Introducing License Enforcement in Socket
Ensure open-source compliance with Socket’s License Enforcement Beta. Set up your License Policy and secure your software!
mongodb-stitch-api-client
Advanced tools
A mongdb stitch api client for nodejs.
npm install mongodb-stitch-api-client
The basic syntax is:
const getClient = require("mongodb-stitch-api-client");
const {trigger, application} = getClient({
"publicKey": "some public key",
"privateKey": "some private key",
"baseUrl": "https://stitch.mongodb.com/api/admin/v3.0",
"projectId": "some project/group id",
"appId": "some stitch appId" // Optional when you are creating app using Application
});
await trigger.getAll();
const createApplication = await application.create({"name": "myFirstStitchApp", "deployment_model": "LOCAL", "location": "IE"});
npm test
Following entities are currently supported
Promise
Creates the stitch application
Kind: instance method of Application
Returns: Promise
- - promise which resolves on success and rejects on error
Param | Type | Default | Description |
---|---|---|---|
body | Object | Object that contains stitch application details. | |
[productType] | string | standard | Optional product type. standard or atlas |
Promise
Returns all applications
Kind: instance method of Application
Returns: Promise
- - promise which resolves on success and rejects on error
Param | Type | Default | Description |
---|---|---|---|
[productType] | string | standard | Optional product type. standard or atlas |
Promise
Returns a single application as per app Id
Kind: instance method of Application
Returns: Promise
- - promise which resolves on success and rejects on error
Param | Type | Description |
---|---|---|
appId | string | Application Id |
Promise
Deletes a single application as per app Id
Kind: instance method of Application
Returns: Promise
- - promise which resolves on success and rejects on error
Param | Type | Description |
---|---|---|
appId | string | Application Id |
Promise
Creates the service
Kind: instance method of Service
Returns: Promise
- - promise which resolves on success and rejects on error
Param | Type | Description |
---|---|---|
body | Object | Object that contains stitch service details. |
Promise
Updates the service
Kind: instance method of Service
Returns: Promise
- - promise which resolves on success and rejects on error
Param | Type | Description |
---|---|---|
serviceId | string | Service Id. |
body | Object | Object that contains stitch service details. |
Promise
Returns all services
Kind: instance method of Service
Returns: Promise
- - promise which resolves on success and rejects on error
Promise
Returns single service as per service Id
Kind: instance method of Service
Returns: Promise
- - promise which resolves on success and rejects on error
Param | Type | Description |
---|---|---|
serviceId | string | Service Id |
Promise
Deletes single service as per service Id
Kind: instance method of Service
Returns: Promise
- - promise which resolves on success and rejects on error
Param | Type | Description |
---|---|---|
serviceId | string | Service Id |
Promise
Creates the trigger
Kind: instance method of Trigger
Returns: Promise
- - promise which resolves on success and rejects on error
Param | Type | Description |
---|---|---|
body | Object | Object that contains stitch trigger details. |
Promise
Updates the trigger
Kind: instance method of Trigger
Returns: Promise
- - promise which resolves on success and rejects on error
Param | Type | Description |
---|---|---|
triggerId | string | Service Id. |
body | Object | Object that contains stitch trigger details. |
Promise
Resumes the trigger
Kind: instance method of Trigger
Returns: Promise
- - promise which resolves on success and rejects on error
Param | Type | Description |
---|---|---|
triggerId | string | Service Id. |
useResumeToken | bool | Whether to use resume token for restarting trigger. Default is true. |
Promise
Returns all triggers
Kind: instance method of Trigger
Returns: Promise
- - promise which resolves on success and rejects on error
Promise
Returns single trigger as per trigger Id
Kind: instance method of Trigger
Returns: Promise
- - promise which resolves on success and rejects on error
Param | Type | Description |
---|---|---|
triggerId | string | Trigger Id |
Promise
Deletes single trigger as per trigger Id
Kind: instance method of Trigger
Returns: Promise
- - promise which resolves on success and rejects on error
Param | Type | Description |
---|---|---|
triggerId | string | Trigger Id |
Promise
Returns the bearer token as per public key and private key
Kind: instance method of Token
Returns: Promise
- - promise which resolves on success and rejects on error
Promise
Creates the function
Kind: instance method of StitchFunction
Returns: Promise
- - promise which resolves on success and rejects on error
Param | Type | Description |
---|---|---|
body | Object | Object that contains stitch functions details. |
Promise
Updates the function
Kind: instance method of StitchFunction
Returns: Promise
- - promise which resolves on success and rejects on error
Param | Type | Description |
---|---|---|
functionId | string | Service Id. |
body | Object | Object that contains stitch function details. |
Promise
Returns all functions
Kind: instance method of StitchFunction
Returns: Promise
- - promise which resolves on success and rejects on error
Promise
Returns single function as per function Id
Kind: instance method of StitchFunction
Returns: Promise
- - promise which resolves on success and rejects on error
Param | Type | Description |
---|---|---|
functionId | string | function Id |
Promise
Deletes single function as per function Id
Kind: instance method of StitchFunction
Returns: Promise
- - promise which resolves on success and rejects on error
Param | Type | Description |
---|---|---|
functionId | string | function Id |
Promise
Creates the rule
Kind: instance method of Rule
Returns: Promise
- - promise which resolves on success and rejects on error
Param | Type | Description |
---|---|---|
serviceId | string | service id |
body | Object | Object that contains stitch rules details. |
Promise
Updates the rule
Kind: instance method of Rule
Returns: Promise
- - promise which resolves on success and rejects on error
Param | Type | Description |
---|---|---|
serviceId | string | service id |
ruleId | string | Service Id. |
body | Object | Object that contains stitch rule details. |
Promise
Returns all rules
Kind: instance method of Rule
Returns: Promise
- - promise which resolves on success and rejects on error
Param | Type | Description |
---|---|---|
serviceId | string | service id |
Promise
Returns single rule as per rule Id
Kind: instance method of Rule
Returns: Promise
- - promise which resolves on success and rejects on error
Param | Type | Description |
---|---|---|
serviceId | string | service id |
ruleId | string | rule Id |
Promise
Deletes single rule as per rule Id
Kind: instance method of Rule
Returns: Promise
- - promise which resolves on success and rejects on error
Param | Type | Description |
---|---|---|
serviceId | string | service id |
ruleId | string | rule Id |
Promise
Returns all the logs as per options passed
Kind: instance method of Log
Returns: Promise
- - promise which resolves on success and rejects on error
Param | Type | Default | Description |
---|---|---|---|
[options] | object | {} | Options having parameter which will be passed as query string |
Promise
Set the allowed HTTP origins from which Stitch should allow requests.
Kind: instance method of Security
Returns: Promise
- - promise which resolves on success and rejects on error
Param | Type | Description |
---|---|---|
body | Object | Object that contains allowed http origins |
Promise
List the allowed HTTP origins from which Stitch should allow requests.
Kind: instance method of Security
Returns: Promise
- - promise which resolves on success and rejects on error
Promise
Send a confirmation email.
Kind: instance method of Email
Returns: Promise
- - promise which resolves on success and rejects on error
Param | Type | Description |
---|---|---|
string | Email address. |
Promise
Confirm a pending user.
Kind: instance method of Email
Returns: Promise
- - promise which resolves on success and rejects on error
Param | Type | Description |
---|---|---|
string | Email address. |
Promise
Re-runs a pending user’s confirmation workflow.
Kind: instance method of Email
Returns: Promise
- - promise which resolves on success and rejects on error
Param | Type | Description |
---|---|---|
string | Email address. |
Promise
Creates the webhook
Kind: instance method of Webhook
Returns: Promise
- - promise which resolves on success and rejects on error
Param | Type | Description |
---|---|---|
serviceId | string | service id |
body | Object | Object that contains stitch webhooks details. |
Promise
Updates the webhook
Kind: instance method of Webhook
Returns: Promise
- - promise which resolves on success and rejects on error
Param | Type | Description |
---|---|---|
serviceId | string | service id |
webhookId | string | Service Id. |
body | Object | Object that contains stitch webhook details. |
Promise
Returns all webhooks
Kind: instance method of Webhook
Returns: Promise
- - promise which resolves on success and rejects on error
Param | Type | Description |
---|---|---|
serviceId | string | service id |
Promise
Returns single webhook as per webhook Id
Kind: instance method of Webhook
Returns: Promise
- - promise which resolves on success and rejects on error
Param | Type | Description |
---|---|---|
serviceId | string | service id |
webhookId | string | webhook Id |
Promise
Deletes single webhook as per webhook Id
Kind: instance method of Webhook
Returns: Promise
- - promise which resolves on success and rejects on error
Param | Type | Description |
---|---|---|
serviceId | string | service id |
webhookId | string | webhook Id |
FAQs
A mongodb stitch api client for nodejs.
The npm package mongodb-stitch-api-client receives a total of 15 weekly downloads. As such, mongodb-stitch-api-client popularity was classified as not popular.
We found that mongodb-stitch-api-client demonstrated a healthy version release cadence and project activity because the last version was released less than a year ago. It has 1 open source maintainer collaborating on the project.
Did you know?
Socket for GitHub automatically highlights issues in each pull request and monitors the health of all your open source dependencies. Discover the contents of your packages and block harmful activity before you install or update your dependencies.
Product
Ensure open-source compliance with Socket’s License Enforcement Beta. Set up your License Policy and secure your software!
Product
We're launching a new set of license analysis and compliance features for analyzing, managing, and complying with licenses across a range of supported languages and ecosystems.
Product
We're excited to introduce Socket Optimize, a powerful CLI command to secure open source dependencies with tested, optimized package overrides.