diff --git a/content/_components/git-protocol/index.md b/content/_components/git-protocol/index.md
index cd5a1c27..bfac43c8 100644
--- a/content/_components/git-protocol/index.md
+++ b/content/_components/git-protocol/index.md
@@ -10,27 +10,18 @@ ComponentVersion: 1.2.5
updatedDate: 2024-09-04
---
-## Table of Contents
-* [General information](#general-information)
- * [Description](#description)
-* [Credentials](#credentials)
-* [Actions](#actions)
- * [Create Commit](#create-commit)
- * [Config Fields](#config-fields)
- * [Input Metadata](#input-metadata)
- * [Output Metadata](#output-metadata)
- * [Read from Branch](#read-from-branch)
- * [Config Fields](#config-fields)
- * [Input Metadata](#input-metadata)
- * [Output Metadata](#output-metadata)
-
## General information
+
### Description
-Git protocol component for the [elastic.io platform](http://www.elastic.io "elastic.io platform")
+
+Git protocol component for the [{{site.data.tenant.name}} platform](http://www.{{site.data.tenant.name}})
## Credentials
-- Passphrase (string/text box, optional): Passphrase to use to authenticate.
-- Private SSH Key (string/text box, required): Private SSH key to use to authenticate. Example:
+
+- Passphrase (string/text box, optional): Passphrase to use to authenticate
+- Public SSH Key (string/text box, required): Public SSH key to use to authenticate
+
+Example:
```
-----BEGIN RSA PRIVATE KEY-----
@@ -40,44 +31,54 @@ jnJHBGH68t76ghvdsaHJVH66657VCHHcEZD+aVRKDQwjIosXR8r88b==
-----END RSA PRIVATE KEY-----
```
-
- Technical details
-The only field available on Elastic's UI to provide a secure input is a 'PasswordFieldView' view class. The problem is that it replaces new line characters with spaces.
-This method modifies the key in the following way. E.g. the key is:
+> **Please note** that you need to add your SSH key to the server (GiHub, GitLab, etc.) first!
+
+- Service URL (string, required): Url of the service to test the SSH key for validity
+
+Example:
```
- -----BEGIN RSA PRIVATE KEY-----
- BASE64_ENCODED_DATA_LINE_1
- BASE64_ENCODED_DATA_LINE_2
- BASE64_ENCODED_DATA_LINE_3
- -----END RSA PRIVATE KEY-----
+git@github.com
```
-The platform will then transform the key so:
-
------BEGIN RSA PRIVATE KEY----- BASE64_ENCODED_DATA_LINE_1 BASE64_ENCODED_DATA_LINE_2 BASE64_ENCODED_DATA_LINE_3 -----END RSA PRIVATE KEY-----
+- Git Project (string, required): Part of the git repo URL that is after the service URL. (e.g. If the Git Project is acme/git-protocol-component.git and the Service URL is git@github.com, then the full git URL should be git@github.com:acme/git-protocol-component.git
-The code in the component replaces all the space characters (except for in the header and footer lines) with new line characters
-
+- Private SSH Key (string/text box, required): Private SSH key to use to authenticate
-- Public SSH Key (string/text box, required): Public SSH key to use to authenticate. Example:
+Example:
```
ssh-rsa AAAAB3NzaC1yc2EAAAAD{.....}kf0vBMStV user@exampleHost
```
-Please note that you need to add your SSH key to the server (GiHub, GitLab, etc.) first!
-- Service URL (string, required): Url of the service to test the SSH key for validity. Example:
+### Technical details
+The only field available on Platform UI to provide a secure input is a 'PasswordFieldView' view class. The problem is that it replaces new line characters with spaces.
+This method modifies the key in the following way. E.g. the key is:
```
-git@github.com
+ -----BEGIN RSA PRIVATE KEY-----
+ BASE64_ENCODED_DATA_LINE_1
+ BASE64_ENCODED_DATA_LINE_2
+ BASE64_ENCODED_DATA_LINE_3
+ -----END RSA PRIVATE KEY-----
```
-- Git Project (string, required): Part of the git repo URL that is after the service URL. (e.g. If the Git Project is elasticio/git-protocol-component.git and the Service URL is git@github.com, then the full git URL should be git@github.com:elasticio/git-protocol-component.git
+The platform will then transform the key so:
+
+-----BEGIN RSA PRIVATE KEY----- BASE64_ENCODED_DATA_LINE_1 BASE64_ENCODED_DATA_LINE_2 BASE64_ENCODED_DATA_LINE_3 -----END RSA PRIVATE KEY-----
+
+The code in the component replaces all the space characters (except for in the header and footer lines) with new line character
+
+## Triggers
+
+This component has no trigger functions. This means it will not be accessible to
+select as a first component during the integration flow design.
## Actions
+
### Create Commit
+
This action does the equivalent to
- git clone
- git checkout
@@ -89,7 +90,7 @@ This action does the equivalent to
#### Config Fields
- File Source. One of the following:
- - Maester. Elastic's internal object storage
+ - Internal object storage
- URL. Internet (must be publicly available. Authentication mechanisms are not supported)
#### Input Metadata
@@ -106,8 +107,8 @@ This action does the equivalent to
- Date (string, optional: default to now). Time (in seconds from epoch) when the action happened
- Files to add to commit (array, required)
- File Source Meta (string, required): Dynamically generated. Will be one of the following depending on File Source chosen in the configuration:
- - Configuration `Maester Object ID or Maester URL`: - either ID of the object in Maester (e.g. `797bb70d-1590-4136-b9db-2abb01983d92`) or the full Maester object URL (e.g. `http://maester-service.platform.svc.cluster.local:3002/objects/dbceb3f1-6d18-4eb4-9f08-2437b6ef685f?storage_type=maester`))
- - Configuration `External URL`: External link to the file (e.g. `https://example.com/file.txt`). Must be publicly available. Authentication mechanisms are not supported
+ - Configuration 'Maester Object ID or Maester URL': - either ID of the object in Maester (e.g. `797bb70d-1590-4136-b9db-2abb01983d92`) or the full Maester object URL (e.g. `http://maester-service.platform.svc.cluster.local:3002/objects/dbceb3f1-6d18-4eb4-9f08-2437b6ef685f?storage_type=maester`))
+ - Configuration 'External URL': External link to the file (e.g. `https://example.com/file.txt`). Must be publicly available. Authentication mechanisms are not supported
- Filename + path (string, required): Location within the git repo to create the file
- Files to remove from the commit (array of strings, optional): List of files or file wildcards to remove as part of the commit. (equivalent to `git rm -r fileOne.txt fileTwo.txt someFolder`)
@@ -116,6 +117,7 @@ This action does the equivalent to
* commitId - ID of the commit in the repo
### Read from Branch
+
This action reads the files from a Git repository and saves them in Maester (Elastic's internal object storage)
#### Config Fields
@@ -132,14 +134,16 @@ This action reads the files from a Git repository and saves them in Maester (Ela
* commitId - ID of the commit in the repo
#### File patterns usage
-Internally this library is being used to find the wildcards/patterns match: [https://www.npmjs.com/package/fast-glob](https://www.npmjs.com/package/fast-glob)
+
+Internally this library is being used to find the wildcards/patterns match: https://www.npmjs.com/package/fast-glob
Examples:
+
1. Match all the files including all subdirectories (also note that 'Include hidden files' configuration field might affect the result): `'**'`
2. Match all the files of js type: `'**/*.js'`
3. Match a single file in the root folder: `'component.json'`
4. Match all the files in the given 'lib' folder: `'lib/**'`
## Known limitations
+
1. Maester object created by Sailor's Lightweight message feature can not be read (to be precise - they will be processed but not decrypted)
-2. The repository must be initialized before executing the `Create Commit` action. This means that the repository must contain at least one commit (initial commit).
diff --git a/content/_components/hubspot/index.md b/content/_components/hubspot/index.md
index b6a81acd..1f412259 100644
--- a/content/_components/hubspot/index.md
+++ b/content/_components/hubspot/index.md
@@ -14,280 +14,285 @@ redirect_from:
- /components/hubspot-component/triggers
---
-# HubSpot component
-
-## Table of Contents
-* [General information](#general-information)
- * [Description](#description)
- * [Completeness Matrix](#completeness-matrix)
- * [Environment variables](#environment-variables)
-* [Credentials](#credentials)
-* [Triggers](#triggers)
- * [Get New and Updated Objects](#get-new-and-updated-objects)
- * [Deprecated triggers](#deprecated-triggers)
-* [Actions](#actions)
- * [Raw Request](#raw-Request)
- * [Upsert](#upsert)
- * [Lookup Set Of Objects By Unique Criteria](#lookup-set-of-objects-by-unique-criteria)
- * [Lookup Object (at most one)](#lookup-object-at-most-one)
- * [Lookup Objects (Plural)](#lookup-objects-plural)
- * [Create Association](#create-association)
- * [Remove Association](#remove-association)
- * [Delete Object](#delete-object)
-* [Known Limitations](#known-limitations)
## General information
-### Description
-[elastic.io](http://www.elastic.io;) iPaaS component that connects to Hubspot API
-### Completeness Matrix
-
-[Completeness Matrix](https://docs.google.com/spreadsheets/d/1EBZNhv4VP9NUpsT1FNO89SKW2DHqe9DbrHRU8Kwjj8o/edit#gid=0)
+{{page.description}}
### Environment variables
| Name | Mandatory | Description | Values |
|----|---------|-----------|------|
-| `REQUEST_MAX_RETRY` | false | Set how many time system try to make request to API on errors (3 by default) | any `integer` above 0 |
-| `RENEW_LIMIT` | false | Set biggest number of records in `Get New and Updated Objects` trigger before set new start date, 9800 by default | any `integer` above 0 and less 10000 |
+| `REQUEST_MAX_RETRY` | false | The number of retries to HubSpot API the platform should do on errors (3 by default) | any `integer` above 0 |
+|`RENEW_LIMIT`| false | Set biggest number of records in `Get New and Updated Objects` trigger before set new start date, 9800 by default | any `integer` above 0 and less 10000|
## Credentials
-Authentication occurs via OAuth 2.0.
-In order to make OAuth work, you need a new App in your Hubspot.
-More information you can find [here](https://developers.hubspot.com/docs/api/working-with-oauth).
+Authentication occurs via OAuth 2.0. To make OAuth work, you need to
+[create a new OAuth2 App](creating-oauth-app-for-hubspot) in your HubSpot or use
+an existing OAuth2 Client during the credentials creation process.
-After granting access, you should be redirected back to our platform via a `redirect_url`. To do this, you will need to provide our [OAuth Callback Redirect URL](https://docs.elastic.io/guides/oauth-callback-redirect-url.html).
+{% include img.html max-width="100%" url="img/hubspot-credentials-screen.png" title="Oauth2" %}
-During credentials creation you would need to:
-- select existing Auth Client from drop-down list ``Choose Auth Client`` or create the new one.
-For creating Auth Client you should specify following fields:
+* Leave the **Additional parameters** input empty.
+* Provide the following value in the **Scopes** input. If you wish to grant certain permissions, you can do so by removing them from this list.
-Field name|Mandatory|Description|
-|----|---------|-----------|
-|Name| true | your Auth Client's name (any) |
-|Client ID| true | your OAuth client key (provide by Hubspot) |
-|Client Secret| true | your OAuth client secret (provide by Hubspot) |
-|Authorization Endpoint| true | your OAuth authorization endpoint. ex:
`https://app-eu1.hubspot.com/oauth/authorize`
-|Token Endpoint| true | your OAuth Token endpoint for refreshing access token:
`https://api.hubapi.com/oauth/v1/token`|
+```
+crm.objects.contacts.read, crm.objects.contacts.write, crm.schemas.contacts.read, crm.schemas.contacts.write, crm.objects.owners.read
+```
-
-- fill field ``Name Your Credential`` (any)
-- fill field ``Scopes`` - must be the same as provided during app creation in Hubspot, use space separated list (not comma), ``crm.objects.owners.read`` is required for verification
-
-
+To complete the process:
-- click on ``Authenticate`` button - if you have not logged in Hubspot before, then log in by entering data in the login window that appears
-- click on ``Verify`` button for verifying your credentials
-- click on ``Save`` button for saving your credentials
+* click on **Authenticate** button - if you have not logged into HubSpot before, then log in by entering data in the login window that appears
+* click on **Verify** button for verifying your credentials
+* click on **Save** button for saving your credentials.
## Triggers
+
### Get New and Updated Objects
-### Config Fields
- * **Object Type** Dropdown: Indicates Object Type to be fetched
- * **Emit behavior** Dropdown: Indicates emit objects individually or emit by page
- * **Field to poll** Dropdown: Indicates field to poll (new objects or modified objects)
- * **Start Time** - TextField (string, optional): Indicates the beginning time to start retrieving events from
- * **End Time** - TextField (string, optional, defaults to never): If provided, don’t fetch records modified after this time
- * **Size of Polling Page** - TextField (optional, positive integer, max 100, defaults to 100): Indicates the size of pages to be fetched
- * **Single Page per Interval** - Checkbox: Indicates that if the number of changed records exceeds the maximum number of results in a page, instead of fetching the next page immediately, wait until the next flow start to fetch the next page. This field will be ignored if `Max amount of Polling Pages` field is set.
- * **Max amount of Polling Pages** - TextField (optional, positive integer, max 1000, defaults to 1000): Indicates the maximum amount of pages to be fetched per execution
+
+{% include img.html max-width="100%" url="img/get-new-and-updated-objects.png" title="Get New and Updated Objects" %}
+
+### Configuration Fields
+
+* **Object Type** dropdown: Select an Object Type to fetch.
+* **Emit behavior** dropdown: Choose between **emit objects individually** or **emit by page** options.
+* **Field to poll** dropdown: Used to select the field to poll (new objects or modified objects).
+* **Start Time** - Text field (string, optional): Used to set the time from which to start retrieving events.
+* **End Time** - Text field (string, optional, defaults to never): When provided, don’t fetch records modified after this time.
+* **Size of Polling Page** - Text field (optional, positive integer, max 100, defaults to 100): Set the size of the fetched pages.
+* **Single Page per Interval** - Checkbox: Indicates that if the number of changed records exceeds the maximum number of results in a page, instead of fetching the next page at once, wait until the next flow start to fetch the next page.
+* **Max amount of Polling Pages** - TextField (optional, positive integer, max 1000, defaults to 1000): Indicates the maximum amount of pages to be fetched per execution.
#### Output Metadata
-- For `Fetch page`: An object with key ***results*** that has an array as its value
-- For `Emit Individually`: Each object fill the entire message
-### Limitations
-After reaching **9800** records flow will find largest `Field to poll` in last Polling Page and use it as `Start Time` for next iterations, results with this date will be excluded from that iteration and include in the next one
+- For `Fetch page`: An object with key ***results*** that has an array as its value.
+- For `Emit Individually`: Each object fill the entire message.
-### Deprecated triggers
+#### Limitations
-#### Webhook
+After reaching **9800** records flow will find largest `Field to poll` in last Polling Page and use it as `Start Time` for next iterations, results with this date will be excluded from that iteration and include in the next one.
-❗This trigger is deprecated, please use Hubspot webhook component instead.
+### Webhook
-Receive data from HubSpot based on configured [webhooks](https://developers.hubspot.com/docs/api/webhooks)
+> This trigger is deprecated. Please use [HubSpot Webhook component](/components/hubspot-webhook/) instead.
-##### Config Fields
+Receive data from HubSpot based on configured [webhooks](https://developers.hubspot.com/docs/api/webhooks).
- * **Client secret** - You need provide Client secret from HubSpot application here
+### Configuration Fields
- ❗You will get error during webhook requests if this field will be incorrect
+**Client secret** - Provide Client secret from HubSpot application here otherwise you will get an error during the webhook requests in case of incorrect or missing value.
-##### Output Metadata
+#### Output Metadata
-Triggered object from HubSpot
+Triggered object from HubSpot.
## Actions
+
### Raw Request
-Action to call any Hubspot API endpoint
-#### Config Fields
-* **Throw Error on 404 Response** - (optional) Treat 404 HTTP responses as errors, defaults to `false`.
+Action to call any Hubspot API endpoint.
+
+{% include img.html max-width="100%" url="img/raw-request.png" title="Raw Request" %}
+
+#### Configuration Fields
+
+**Throw Error on 404 Response** - (optional) Treat 404 HTTP responses as errors, defaults to `false`.
#### Input Metadata
-* **Url** - Path of the resource relative to the URL base (https://api.hubapi.com), required.
-* **Method** - Allowed values `GET`, `POST`, `PUT`, `PATCH`, `DELETE`, required. HTTP verb to use in the request.
-* **Request Body** - Body of the request to send
+
+* **URL** - Path of the resource relative to the URL base (`https://api.hubapi.com`), required.
+* **Method** - Allowed values `GET`, `POST`, `PUT`, `PATCH`, `DELETE`, required. HTTP verb to use in the request.
+* **Request Body** - Body of the request to send.
### Upsert
-Action to make upsert(update/create) object in Hubspot
-#### Config Fields
-* **Object type** - Object type for upsert ("Companies", "Contacts", "Deals", "Line Items", "Tickets")
-* **ID to Search On** - Identificator to search object ("Hubspot Id" or "Email". "Email" is only for "Contacts" `Object Type`)
+Action to make upsert (update/create) object in HubSpot.
+
+{% include img.html max-width="100%" url="img/upsert-object.png" title="Upsert" %}
+
+#### Configuration Fields
+
+* **Object type** - Object type for upsert like `Companies`, `Contacts`, `Deals`, `Line Items` or `Tickets`.
+* **ID to Search On** - Identifier to search objects like **HubSpot Id** or **Email**. Use **Email** for `Object Type` in the **Contacts**.
#### Input Metadata
-Dynamically generated
-For each custom file field, it is generated an object to upload the custom file to populate that field. That object includes the following:
+Dynamically generated.
+
+For each custom file field, an object is generated to upload the custom file to populate that field. That object includes the following:
+
+* Attachment URL (URL containing the file contents to upload)
+* Folder Path
+* File Name
+* Charset Hunch
+* Access
+* TTL
+* Overwrite
+* Duplicate Validation Strategy
+* Duplicate Validation Scope
- * Attachment URL (URL containing the file contents to upload)
- * Folder Path
- * File Name
- * Charset Hunch
- * Access
- * TTL
- * Overwrite
- * Duplicate Validation Strategy
- * Duplicate Validation Scope
+We use [Files API](https://developers.hubspot.com/docs/api/files/files) for file uploading.
-For uploading file [Files API](https://developers.hubspot.com/docs/api/files/files) is used.
+#### Known limitations
+
+Please, don't use platform attachments url (like `http://steward-service.platform.svc.cluster.local:8200/v2/objects/xxxxx`) for fields `Attachment URL`. The component will throw an exception `process.uncaughtException`.
### Lookup Set Of Objects By Unique Criteria
-Action to lookup object in Hubspot.
+
+Action to lookup object in HubSpot.
Lookup Set will make sure all the items in the set should be there, otherwise throw an error.
-#### Config Fields
+{% include img.html max-width="100%" url="img/lookup-set-of-objects.png" title="Lookup Set Of Objects By Unique Criteria" %}
-* **Object type** - Object type for lookup ("Companies", "Contacts", "Deals", "Line Items", "Tickets", "Quotes")
-* **ID to Search On** - Identification to search object ("Hubspot Id" or "Email". "Email" is only for "Contacts" `Object Type`)
-* **Enable download attachments** - Checkbox for enabling downloading attachments from fields with type `file`
+#### Configuration Fields
+
+* **Object type** - Object type for lookup like `Companies`, `Contacts`, `Deals`, `Line Items` or `Tickets`.
+* **ID to Search On** - Identifier to search objects like **HubSpot Id** or **Email**. Use **Email** for `Object Type` in the **Contacts**.
+* **Enable download attachments** - Checkbox for enabling attachment download for the `file` field type
#### Input Metadata
-An array where each item is an ID
+
+An array where each item is an ID.
### Lookup Object (at most one)
-Action designed to lookup one object by unique field
-#### Config Fields
-* **Object Type** Dropdown: Indicates Object Type to find
-* **ID to Search On** Dropdown: Indicates unique field to search on
-* **Allow ID to be omitted** Checkbox: When selected, the ID field becomes optional, otherwise it is a required field
-* **Allow zero results** Checkbox: When selected, if zero results are returned, the empty object {} is emitted, otherwise typically an error would be thrown.
-* **Enable download attachments** - Checkbox for enabling downloading attachments from fields with type `file`
+Action designed to lookup one object by unique field.
-#### Input Metadata
-* **ID value** Textfield: value for `ID to Search On` (unique field value by itself)
+{% include img.html max-width="100%" url="img/lookup-object-at-most-one.png" title="Lookup Object (at most one)" %}
+
+#### Configuration Fields
+* **Object Type** dropdown: Select an Object Type to lookup.
+* **ID to Search On** dropdown: Used to search a unique field.
+* **Allow ID to be omitted** Checkbox: Select to make the ID field optional (default: required).
+* **Allow zero results** Checkbox: Select to allow zero results. System will emit an empty object `{}`, otherwise system will through an error in case of zero results.
+* **Enable download attachments** - Checkbox for enabling attachment download for the `file` field type.
-
+#### Input Metadata
+
+**ID value** Text field: value for `ID to Search On` (unique field value by itself).
### Lookup Objects (Plural)
-Action to lookup objects in Hubspot
-#### Config Fields
+Action to lookup objects in HubSpot.
+
+{% include img.html max-width="100%" url="img/lookup-objects.png" title="Lookup Objects (Plural)" %}
-* **Object Type** Dropdown: Indicates Object Type to find
-* **Behaviour** Dropdown with options: `Fetch all`, `Fetch page`, `Emit individually`, required
-* **Enable download attachments** - Checkbox for enabling downloading attachments from fields with type `file`
+#### Configuration Fields
-
+* **Object Type** dropdown: Select an Object Type to find.
+* **Behaviour** dropdown with options: `Fetch all`, `Fetch page`, `Emit individually`, required.
+* **Enable download attachments** - Checkbox for enabling attachment download for the `file` field type.
#### Input Metadata
-* **Search Criteria** Array: Search terms are to be combined with the AND operator. For each search term.
+**Search Criteria** Array: Combine each search term with an `AND` operator.
-❗HubSpot support up to three criteria
+> **Please note:** HubSpot support up to three criteria
Example:
->
->
-> Records created after *'2021-10-01T03:30:17.883Z'* with property *'firstname'* contains *'Tony'*
-> ```
-> ["createdate GT 1633059017883", "firstname CONTAINS_TOKEN Tony"]
-> ```
+Records created after `2021-10-01T03:30:17.883Z` with property `firstname` containing `Tony`.
+
+```
+["createdate GT 1633059017883", "firstname CONTAINS_TOKEN Tony"]
+```
Supported operators:
-|OPERATOR|DESCRIPTION|
-|----|------|
-|EQ | equal to|
-|NEQ | not equal to|
-|LT | less than|
-|LTE | less than or equal to|
-|GT | greater than|
-|GTE | greater than or equal to|
-|HAS_PROPERTY | has property value|
-|NOT_HAS_PROPERTY | does not have property value|
-|CONTAINS_TOKEN | contains token|
-|NOT_CONTAINS_TOKEN | does not contain token|
+| OPERATOR | DESCRIPTION |
+| ---- | ------ |
+| `EQ` | equal to |
+| `NEQ` | not equal to |
+| `LT` | less than |
+| `LTE` | less than or equal to |
+| `GT` | greater than |
+| `GTE` | greater than or equal to |
+| `HAS_PROPERTY` | has property value |
+| `NOT_HAS_PROPERTY` | does not have property value |
+| `CONTAINS_TOKEN` | contains token |
+| `NOT_CONTAINS_TOKEN` | does not contain token |
If selected `Fetch page` additional metadata fields:
-* **Page Size** - Number of records to retrieve, limit - 100
-* **Page Number** - How many pages should be skipped
-* **Order** - Order direction, **ASCENDING** or **DESCENDING**
+* **Page Size** - Number of records to retrieve, limit - 100.
+* **Page Number** - Number of pages to skip.
+* **Order** - Order direction, **ASCENDING** or **DESCENDING**
Order example:
->
-> ```
-> 'createdate DESCENDING'
-> ```
-
+
+```
+'createdate DESCENDING'
+```
#### Output Metadata
-- For `Fetch page`: An object with:
- - key ***results*** that has an array as its value
- - key ***totalCountOfMatchingResults*** which contains the total number of results (not just on the page) which match the search criteria
-- For `Fetch All`: An object, with key ***results*** that has an array as its value
-- For `Emit Individually`: Each object fill the entire message
+* For `Fetch page`: An object with:
+ * key `results` that has an array as its value.
+ * key `*totalCountOfMatchingResults` containing the total number of results (not just on the page) matching the search criteria.
+* For `Fetch All`: An object, with key `*results` that has an array as its value.
+* For `Emit Individually`: Each object fill the entire message.
### Create Association
-#### Config Fields
+{% include img.html max-width="100%" url="img/create-associations.png" title="Create Association" %}
+
+#### Configuration Fields
+
+* **From Object Type** dropdown: Choose an object type to create association.
+* **To Object Type** dropdown: Choose an object type to associate to.
-* **From Object Type** Dropdown: Choose from which object needs to create association
-* **To Object Type** Dropdown: Choose to what object
+> **Please note**: We do not retrieve objects to associate dynamically. Check the
+> HubSpot documentation to verify that the association between selected objects is possible.
-❗*NOTE*: Objects to assosiate are not dinamically retrieved, so please make sure in Hubspot documentation that selected objects can be assosiated
#### Input Metadata
-* **From Object ID** - HubSpot id of object which needs to create association
-* **To Object ID** - id of associated object
+
+* **From Object ID** - HubSpot id of object which needs to create association.
+* **To Object ID** - id of associated object.
#### Output Metadata
-Object with key ***statusCode*** that represent result of request
+Object with `statusCode` key that represent result of request.
### Remove Association
-#### Config Fields
+{% include img.html max-width="100%" url="img/remove-associations.png" title="Remove Association" %}
+
+#### Configuration Fields
+
+* **From Object Type** dropdown: Choose from which object to remove association.
+* **To Object Type** dropdown: Choose to which object.
-* **From Object Type** Dropdown: Choose from which object needs to remove association
-* **To Object Type** Dropdown: Choose to what object
+> **Please note**: We do not retrieve objects to associate dynamically. Check the
+> HubSpot documentation to verify that the association between selected objects is possible.
-❗*NOTE*: Objects to assosiate are not dinamically retrieved, so please make sure in Hubspot documentation that selected objects can be assosiated
#### Input Metadata
-* **From Object ID** - HubSpot id of object which needs to remove association
-* **To Object ID** - id of associated object
+
+* **From Object ID** - HubSpot id of object which needs to remove association.
+* **To Object ID** - id of associated object.
#### Output Metadata
-Object with key ***statusCode*** that represent result of request
+Object with `statusCode` key that represent result of request.
### Delete Object
-Action designed to delete one object by unique field
-#### Config Fields
-* **Object Type** Dropdown: Indicates Object Type to find
-* **ID to Search On** Dropdown: Indicates unique field to search on
+Action designed to delete one object by unique field.
+
+{% include img.html max-width="100%" url="img/delete-object.png" title="Delete Object" %}
+
+#### Configuration Fields
+
+* **Object Type** dropdown: Indicates Object Type to find.
+* **ID to Search On** dropdown: Indicates unique field to search on.
#### Input Metadata
-* **ID value** Textfield: value for `ID to Search On` (unique field value by itself)
+
+**ID value** text field: value for `ID to Search On` (unique field value by itself).
#### Output Metadata
+
The expected output is an object with a `id` property. `id` value stands for id of delete object.
+## Known Limitations
-# Known Limitations
-1. [Rate Limits](https://developers.hubspot.com/docs/api/usage-details#rate-limits)
-2. Please, use some timer (around 5sec) if you are going to implement flow like `Upsert Object Action` -> any type of `Lookup Object(s) Action` with enabled feature `Enable download attachments`. Uploading the file to Hubspot on `Upsert Object Action` takes some time, so it is possible to receive `404` error on lookup.
+1. [Rate Limits](https://developers.hubspot.com/docs/api/usage-details#rate-limits).
+2. Please, use a timer (around 5 seconds) if you need to build a flow like `Upsert Object Action` -> any type of `Lookup Object(s) Action` with enabled feature `Enable download attachments`. Uploading the file to HubSpot on `Upsert Object Action` takes some time, your might get `404` error on lookup.
diff --git a/content/_components/netsuite/actions.md b/content/_components/netsuite/actions.md
new file mode 100644
index 00000000..53e1a4fd
--- /dev/null
+++ b/content/_components/netsuite/actions.md
@@ -0,0 +1,1178 @@
+---
+title: NetSuite actions
+layout: component
+description: NetSuite component actions.
+icon: netsuite.png
+icontext: NetSuite component
+category: netsuite
+updatedDate: 2023-05-26
+ComponentVersion: 3.1.0
+---
+
+## Add Object
+
+Add an object to NetSuite.
+
+### Configuration Fields
+
+* **Object Category** - a category of an object in NetSuite
+ * Standard
+ * Custom
+* **Object Type** - an object in NetSuite (Contact, Customer etc.). Fetches dynamically.
+
+### Input Metadata
+
+Is being fetched dynamically. Sample:
+
+Input metadata for invoice object
+
+```json
+{
+ "entity": {
+ "internalId": "5"
+ },
+ "currency": {
+ "internalId": "1"
+ },
+ "tranDate": "2023-05-23",
+ "itemList": {
+ "item": [
+ {
+ "description": "General Donation",
+ "amount": 1000,
+ "item": {
+ "internalId": "12"
+ },
+ "quantity": 1,
+ "rate": "100",
+ "taxCode": {
+ "internalId": "5"
+ },
+ "customFieldList": {
+ "customField": [
+ {
+ "type": "SelectCustomFieldRef",
+ "scriptId": "asd_d3",
+ "value": {
+ "name": "Charity type",
+ "internalId": "2"
+ }
+ }
+ ]
+ }
+ }
+ ]
+ },
+ "customFieldList": {
+ "customField": [
+ {
+ "type": "StringCustomFieldRef",
+ "scriptId": "custbody_sf_field-one",
+ "value": "Bank Transfer"
+ },
+ {
+ "type": "StringCustomFieldRef",
+ "scriptId": "custbody_sf_field-two",
+ "value": "Individual One-Off"
+ },
+ {
+ "type": "StringCustomFieldRef",
+ "scriptId": "custbody_sf_field-three",
+ "value": "John Doe"
+ },
+ {
+ "type": "StringCustomFieldRef",
+ "scriptId": "custbody_sf_field-four",
+ "value": "ABC-987"
+ }
+ ]
+ }
+}
+```
+Deletion Reason Usage Notes:
+
+> **Please Note:** the following about the deletionReason parameter:
+
+>The deletionReason complex type includes two fields: deletionReasonCode and deletionReasonMemo. The deletionReasonCode must identify a deletion reason that is listed at Setup > Accounting > Accounting Lists. If the Use Deletion Reasons feature is enabled and you use the deletionReasonCode to identify a code that does not exist, the request fails with an INVALID_REF_KEY error.
+
+> Deletion reasons can be saved only for transactions. However, in SOAP web services, you must use the deletionReason parameter even when referencing other record types, and even when the Use Deletion Reasons feature is not enabled. For situations where it is not appropriate to identify a deletion reason, pass in a value of null.
+
+> Even when a deletion reason is required, you can use a value of null. In these cases, the system automatically populates the deletion reason fields with default values. These defaults are: Other for deletionReasonCode and This transaction was deleted by script or web service for deletionReasonMemo.
+
+> The deletionReason complex type is defined in the core XSD.
+
+> For more details about the Use Deletion Reasons feature, see Recording a Reason for Deleting a Transaction.
+
+GetSelectValueFilterOperator:
+
+* contains
+* is
+* startsWith
+
+SearchDateFieldOperator:
+
+* after
+* before
+* empty
+* notAfter
+* notBefore
+* notEmpty
+* notOn
+* notOnOrAfter
+* notOnOrBefore
+* notWithin
+* on
+* onOrAfter
+* onOrBefore
+* within
+
+SearchDoubleFieldOperator:
+
+* between
+* empty
+* equalTo
+* greaterThan
+* greaterThanOrEqualTo
+* lessThan
+* lessThanOrEqualTo
+* notBetween
+* notEmpty
+* notEqualTo
+* notGreaterThan
+* notGreaterThanOrEqualTo
+* notLessThan
+* notLessThanOrEqualTo
+
+SearchEnumMultiSelectFieldOperator:
+
+* anyOf
+* noneOf
+
+SearchLongFieldOperator:
+
+* between
+* empty
+* equalTo
+* greaterThan
+* greaterThanOrEqualTo
+* lessThan
+* lessThanOrEqualTo
+* notBetween
+* notEmpty
+* notEqualTo
+* notGreaterThan
+* notGreaterThanOrEqualTo
+* notLessThan
+* notLessThanOrEqualTo
+
+SearchMultiSelectFieldOperator:
+
+* anyOf
+* noneOf
+
+SearchStringFieldOperator:
+
+* contains
+* doesNotContain
+* doesNotStartWith
+* empty
+* hasKeywords
+* is
+* isNot
+* notEmpty
+* startsWith
+
+SearchTextNumberFieldOperator:
+
+* between
+* empty
+* equalTo
+* greaterThan
+* greaterThanOrEqualTo
+* lessThan
+* lessThanOrEqualTo
+* notBetween
+* notEmpty
+* notEqualTo
+* notGreaterThan
+* notGreaterThanOrEqualTo
+* notLessThan
+* notLessThanOrEqualTo
+
+Click to expand for more details:
+
+```xml
+
+
+
+ YOURAPPLICATIONID
+
+
+ YOUREMAIL
+ YOURPASSWORD
+ YOURACCOUNT
+
+
+
+
+
+
+
+ tomsmith@tomsmith.com
+
+
+
+
+
+
+```
+
+Click to expand for more details:
+
+```json
+{
+ "results": [
+ {
+ "internalId": "4248",
+ "lastModifiedDate": "2018-08-17T08:51:19.000+0000",
+ "dateCreated": "2018-08-17T08:16:53.000+0000",
+ "globalSubscriptionStatus": {
+ "value": "_softOptIn"
+ },
+ "subsidiary": {
+ "internalId": "3",
+ "name": "Honeycomb Holdings Inc."
+ },
+ "isInactive": false,
+ "isPrivate": false,
+ "email": "tomsmith@tomsmith.com",
+ "lastName": "Smith",
+ "firstName": "Tom",
+ "salutation": "Smith",
+ "entityId": "Tom Smith"
+ }
+ ]
+}
+```
+
+Click to expand for more details:
+
+```xml
+
+
+
+ YOURAPPLICATIONID
+
+
+ YOUREMAIL
+ YOURPASSWORD
+ YOURACCOUNT
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+```
+
+Click to expand for more details:
+
+```json
+{
+ "results": [
+ {
+ "externalId": "Karen Austin / John Spear",
+ "internalId": "912",
+ "lastModifiedDate": "2019-07-24T09:54:53.000+0000",
+ "dateCreated": "2015-06-07T20:47:55.000+0000",
+ "globalSubscriptionStatus": {
+ "value": "_softOptIn"
+ },
+ "supervisor": {
+ "internalId": "27",
+ "name": "Brad M Sparling"
+ },
+ "mobilePhone": "(123) 545-6666",
+ "homePhone": "(222) 123-4321",
+ "officePhone": "(123) 456-7890",
+ "subsidiary": {
+ "internalId": "1",
+ "name": "Honeycomb Mfg."
+ },
+ "isInactive": false,
+ "isPrivate": false,
+ "defaultAddress": "Brandy Dough
7829 N. Commerce Avenue
San Francisco CA
United States",
+ "email": "bdickens@ramsey.com",
+ "phone": "(123) 456-7890",
+ "title": "Purchasing",
+ "lastName": "Dickens",
+ "firstName": "Brandy",
+ "entityId": "Brandy Dickens"
+ },
+ {
+ "internalId": "1545",
+ "lastModifiedDate": "2019-07-24T09:56:22.000+0000",
+ "dateCreated": "2015-03-18T14:35:42.000+0000",
+ "globalSubscriptionStatus": {
+ "value": "_softOptIn"
+ },
+ "supervisor": {
+ "internalId": "1516",
+ "name": "Brenda Jones"
+ },
+ "homePhone": "(713) 456-7878",
+ "subsidiary": {
+ "internalId": "1",
+ "name": "Honeycomb Mfg."
+ },
+ "isInactive": false,
+ "isPrivate": false,
+ "defaultAddress": "123
Ave B
Houston TX 78665
United States",
+ "email": "adminaccess2@ramsey.com",
+ "phone": "(713) 456-7878",
+ "lastName": "Samms",
+ "firstName": "Brandy",
+ "entityId": "Brandy Samms"
+ }
+ ]
+}
+```
+
+Click to expand for more details:
+
+```xml
+
+
+
+ YOURAPPLICATIONID
+
+
+ YOUREMAIL
+ YOURPASSWORD
+ YOURACCOUNT
+
+
+
+
+
+
+
+ _inventoryItem
+
+
+
+
+ 10
+
+
+
+
+
+
+```
+
+Click to expand for more details:
+
+```json
+{
+ "results": [
+ {
+ "externalId": "ITEM163",
+ "internalId": "163",
+ "customFieldList": {
+ "customField": [
+ {
+ "value": false,
+ "scriptId": "custitem16",
+ "internalId": "194"
+ }
+ ]
+ },
+ "supplyReplenishmentMethod": {
+ "internalId": "REORDER_POINT",
+ "name": "Reorder Point"
+ },
+ "currency": "USA",
+ "availableToPartners": false,
+ "isInactive": true,
+ "offerSupport": false,
+ "isOnline": true,
+ "displayName": "Reserve Pinot Noir 2000",
+ "itemId": "Reserve Pinot Noir 2000",
+ "outOfStockBehavior": {
+ "value": "_default"
+ },
+ "onSpecial": false,
+ "dontShowPrice": false,
+ "showDefaultDonationAmount": false,
+ "isDonationItem": false,
+ "sitemapPriority": {
+ "value": "_auto"
+ },
+ "excludeFromSitemap": false,
+ "autoReorderPoint": true,
+ "seasonalDemand": false,
+ "autoPreferredStockLevel": true,
+ "autoLeadTime": true,
+ "leadTime": 0,
+ "useBins": false,
+ "cost": 6,
+ "overallQuantityPricingType": {
+ "value": "_byLineQuantity"
+ },
+ "costEstimateType": {
+ "value": "_averageCost"
+ },
+ "useMarginalRates": false,
+ "costCategory": {
+ "internalId": "3",
+ "name": "Default"
+ },
+ "shipIndividually": false,
+ "enforceMinQtyInternally": true,
+ "roundUpAsComponent": false,
+ "isSpecialOrderItem": false,
+ "isDropShipItem": false,
+ "trackLandedCost": false,
+ "costingMethodDisplay": "Average",
+ "weightUnit": {
+ "value": "_lb"
+ },
+ "weight": 5,
+ "billExchRateVarianceAcct": {
+ "internalId": "152",
+ "name": "5097 Bill Exchange Rate Variance"
+ },
+ "billPriceVarianceAcct": {
+ "internalId": "151",
+ "name": "5096 Bill Price Variance"
+ },
+ "billQtyVarianceAcct": {
+ "internalId": "150",
+ "name": "5095 Bill Quantity Variance"
+ },
+ "matchBillToReceipt": false,
+ "assetAccount": {
+ "internalId": "120",
+ "name": "Inventory Asset"
+ },
+ "taxSchedule": {
+ "internalId": "1",
+ "name": "S1"
+ },
+ "incomeAccount": {
+ "internalId": "56",
+ "name": "4002 Sales : Sales - Merchandise"
+ },
+ "includeChildren": true,
+ "salesDescription": "Reserve Pinot Noir 2000",
+ "cogsAccount": {
+ "internalId": "121",
+ "name": "Cost of Goods Sold"
+ },
+ "copyDescription": false,
+ "purchaseDescription": "Reserve Pinot Noir 2000",
+ "lastModifiedDate": "2016-01-18T08:05:19.000+0000",
+ "createdDate": "2015-06-12T21:29:35.000+0000"
+ },
+ {
+ "externalId": "ITEM164",
+ "internalId": "164",
+ "customFieldList": {
+ "customField": [
+ {
+ "value": false,
+ "scriptId": "custitem16",
+ "internalId": "194"
+ }
+ ]
+ },
+ "supplyReplenishmentMethod": {
+ "internalId": "REORDER_POINT",
+ "name": "Reorder Point"
+ },
+ "currency": "USA",
+ "availableToPartners": false,
+ "isInactive": true,
+ "offerSupport": false,
+ "isOnline": true,
+ "displayName": "Crystallus 2002",
+ "itemId": "Crystallus 2002",
+ "outOfStockBehavior": {
+ "value": "_default"
+ },
+ "onSpecial": false,
+ "dontShowPrice": false,
+ "showDefaultDonationAmount": false,
+ "isDonationItem": false,
+ "sitemapPriority": {
+ "value": "_auto"
+ },
+ "excludeFromSitemap": false,
+ "autoReorderPoint": true,
+ "seasonalDemand": false,
+ "autoPreferredStockLevel": true,
+ "autoLeadTime": true,
+ "leadTime": 0,
+ "useBins": false,
+ "cost": 5,
+ "overallQuantityPricingType": {
+ "value": "_byLineQuantity"
+ },
+ "costEstimateType": {
+ "value": "_averageCost"
+ },
+ "useMarginalRates": false,
+ "costCategory": {
+ "internalId": "3",
+ "name": "Default"
+ },
+ "shipIndividually": false,
+ "enforceMinQtyInternally": true,
+ "roundUpAsComponent": false,
+ "isSpecialOrderItem": false,
+ "isDropShipItem": false,
+ "trackLandedCost": false,
+ "costingMethodDisplay": "Average",
+ "weightUnit": {
+ "value": "_lb"
+ },
+ "weight": 5,
+ "billExchRateVarianceAcct": {
+ "internalId": "152",
+ "name": "5097 Bill Exchange Rate Variance"
+ },
+ "billPriceVarianceAcct": {
+ "internalId": "151",
+ "name": "5096 Bill Price Variance"
+ },
+ "billQtyVarianceAcct": {
+ "internalId": "150",
+ "name": "5095 Bill Quantity Variance"
+ },
+ "matchBillToReceipt": false,
+ "assetAccount": {
+ "internalId": "120",
+ "name": "Inventory Asset"
+ },
+ "taxSchedule": {
+ "internalId": "1",
+ "name": "S1"
+ },
+ "incomeAccount": {
+ "internalId": "56",
+ "name": "4002 Sales : Sales - Merchandise"
+ },
+ "includeChildren": true,
+ "salesDescription": "Crystallus 2002",
+ "cogsAccount": {
+ "internalId": "121",
+ "name": "Cost of Goods Sold"
+ },
+ "copyDescription": false,
+ "purchaseDescription": "Crystallus 2002",
+ "lastModifiedDate": "2016-01-18T08:05:19.000+0000",
+ "createdDate": "2015-06-12T21:29:35.000+0000"
+ }
+ ]
+}
+```
+
+Click to expand for more details:
+
+ - Blanket Purchase Order
+ - CCard Refund
+ - Commission
+ - Credit Card
+ - Currency Revaluation
+ - Customer Payment Authorization
+ - Deprecated Custom Transaction
+ - Finance Charge
+ - Fulfillment Request
+ - GL Impact Adjustment
+ - Inventory Count
+ - Inventory Distribution
+ - Inventory Status Change
+ - Inventory Worksheet
+ - Liability Adjustment
+ - Ownership Transfer
+ - Payroll Adjustment
+ - Payroll Liability Check
+ - Period End Journal
+ - Purchase Contract
+ - Request For Quote
+ - Revenue Arrangement
+ - Revenue Commitment
+ - Revenue Commitment Reversal
+ - Revenue Contract
+ - Sales Tax Payment
+ - Statement Charge
+ - Store Pickup Fulfillment
+ - System Journal
+ - Tax Liability Cheque
+ - Tegata Payable
+ - Tegata Receivable
+ - Transfer
+ - Vendor Request For Quote
+
+ Click to expand for more details:
+
+```xml
+
+
+
+ YOURAPPLICATIONID
+
+
+ YOUREMAIL
+ YOURPASSWORD
+ YOURACCOUNT
+
+
+
+
+
+
+
+
+```
+
+Click to expand for more details:
+
+```json
+{
+ "results": [
+ {
+ "basic": {
+ "salesRep": [
+ {
+ "searchValue": {
+ "internalId": "1008"
+ }
+ }
+ ],
+ "phone": [
+ {
+ "searchValue": "937-287-2222"
+ }
+ ],
+ "internalId": [
+ {
+ "searchValue": {
+ "internalId": "980"
+ }
+ }
+ ],
+ "entityId": [
+ {
+ "searchValue": "D&H Manufacturing"
+ }
+ ],
+ "billState": [
+ {
+ "searchValue": "OH"
+ }
+ ],
+ "billCity": [
+ {
+ "searchValue": "Dayton"
+ }
+ ],
+ "billAddress1": [
+ {
+ "searchValue": "410 E. Fifth St."
+ }
+ ]
+ }
+ }
+ ]
+}
+```
+Input metadata for Invoice object:
+
+```json
+{
+ "internalId": "13817",
+ "entity": {
+ "internalId": "5"
+ },
+ "currency": {
+ "internalId": "1"
+ },
+ "tranDate": "2023-05-23",
+ "itemList": {
+ "item": [
+ {
+ "description": "General Donation",
+ "amount": 1000,
+ "item": {
+ "internalId": "12"
+ },
+ "quantity": 1,
+ "rate": "100",
+ "taxCode": {
+ "internalId": "5"
+ },
+ "customFieldList": {
+ "customField": [
+ {
+ "type": "SelectCustomFieldRef",
+ "scriptId": "asd_d3",
+ "value": {
+ "name": "Charity type",
+ "internalId": "2"
+ }
+ }
+ ]
+ }
+ }
+ ]
+ },
+ "customFieldList": {
+ "customField": [
+ {
+ "type": "StringCustomFieldRef",
+ "scriptId": "custbody_sf_field-one",
+ "value": "Bank Transfer"
+ },
+ {
+ "type": "StringCustomFieldRef",
+ "scriptId": "custbody_sf_field-two",
+ "value": "Individual One-Off"
+ },
+ {
+ "type": "StringCustomFieldRef",
+ "scriptId": "custbody_sf_field-three",
+ "value": "John Doe"
+ },
+ {
+ "type": "StringCustomFieldRef",
+ "scriptId": "custbody_sf_field-four",
+ "value": "ABC-987"
+ }
+ ]
+ }
+}
+```
+Input metadata for Invoice object:
-
-
-```json
-{
- "entity": {
- "internalId": "5"
- },
- "currency": {
- "internalId": "1"
- },
- "tranDate": "2023-05-23",
- "itemList": {
- "item": [
- {
- "description": "General Donation",
- "amount": 1000,
- "item": {
- "internalId": "12"
- },
- "quantity": 1,
- "rate": "100",
- "taxCode": {
- "internalId": "5"
- },
- "customFieldList": {
- "customField": [
- {
- "type": "SelectCustomFieldRef",
- "scriptId": "asd_d3",
- "value": {
- "name": "Charity type",
- "internalId": "2"
- }
- }
- ]
- }
- }
- ]
- },
- "customFieldList": {
- "customField": [
- {
- "type": "StringCustomFieldRef",
- "scriptId": "custbody_sf_field-one",
- "value": "Bank Transfer"
- },
- {
- "type": "StringCustomFieldRef",
- "scriptId": "custbody_sf_field-two",
- "value": "Individual One-Off"
- },
- {
- "type": "StringCustomFieldRef",
- "scriptId": "custbody_sf_field-three",
- "value": "John Doe"
- },
- {
- "type": "StringCustomFieldRef",
- "scriptId": "custbody_sf_field-four",
- "value": "ABC-987"
- }
- ]
- }
-}
-```
-Click to expand
-
-> Note the following about the deletionReason parameter:
-> The deletionReason complex type includes two fields: deletionReasonCode and deletionReasonMemo. The deletionReasonCode must identify a deletion reason that is listed at Setup > Accounting > Accounting Lists. If the Use Deletion Reasons feature is enabled and you use the deletionReasonCode to identify a code that does not exist, the request fails with an INVALID_REF_KEY error.
-> Deletion reasons can be saved only for transactions. However, in SOAP web services, you must use the deletionReason parameter even when referencing other record types, and even when the Use Deletion Reasons feature is not enabled. For situations where it is not appropriate to identify a deletion reason, pass in a value of null.
-> Even when when a deletion reason is required, you can use a value of null. In these cases, the system automatically populates the deletion reason fields with default values. These defaults are: Other for deletionReasonCode and This transaction was deleted by script or web service for deletionReasonMemo.
-> The deletionReason complex type is defined in the core XSD.
-> For more details about the Use Deletion Reasons feature, see Recording a Reason for Deleting a Transaction.
-Click to expand
-
-* contains
-* is
-* startsWith
-Click to expand
-
-* after
-* before
-* empty
-* notAfter
-* notBefore
-* notEmpty
-* notOn
-* notOnOrAfter
-* notOnOrBefore
-* notWithin
-* on
-* onOrAfter
-* onOrBefore
-* within
-Click to expand
-
-* between
-* empty
-* equalTo
-* greaterThan
-* greaterThanOrEqualTo
-* lessThan
-* lessThanOrEqualTo
-* notBetween
-* notEmpty
-* notEqualTo
-* notGreaterThan
-* notGreaterThanOrEqualTo
-* notLessThan
-* notLessThanOrEqualTo
-Click to expand
-
-* anyOf
-* noneOf
-Click to expand
-
-* between
-* empty
-* equalTo
-* greaterThan
-* greaterThanOrEqualTo
-* lessThan
-* lessThanOrEqualTo
-* notBetween
-* notEmpty
-* notEqualTo
-* notGreaterThan
-* notGreaterThanOrEqualTo
-* notLessThan
-* notLessThanOrEqualTo
-Click to expand
+NetSuite component includes the following actions:
-* anyOf
-* noneOf
-Click to expand
+ 2. [Delete Object By Id](/components/netsuite/actions#delete-object-by-id)
+ Deletes an object by the ID provided.
-* contains
-* doesNotContain
-* doesNotStartWith
-* empty
-* hasKeywords
-* is
-* isNot
-* notEmpty
-* startsWith
-Click to expand
+ 4. [Lookup Object By Id](/components/netsuite/actions#lookup-object-by-id)
+ Lookup an object by the ID provided.
-* between
-* empty
-* equalTo
-* greaterThan
-* greaterThanOrEqualTo
-* lessThan
-* lessThanOrEqualTo
-* notBetween
-* notEmpty
-* notEqualTo
-* notGreaterThan
-* notGreaterThanOrEqualTo
-* notLessThan
-* notLessThanOrEqualTo
-Click to expand
-
-```xml
-
-
-
- YOURAPPLICATIONID
-
-
- YOUREMAIL
- YOURPASSWORD
- YOURACCOUNT
-
-
-
-
-
-
-
- tomsmith@tomsmith.com
-
-
-
-
-
-
-```
-Click to see the response
-
-```json
-{
- "results": [
- {
- "internalId": "4248",
- "lastModifiedDate": "2018-08-17T08:51:19.000+0000",
- "dateCreated": "2018-08-17T08:16:53.000+0000",
- "globalSubscriptionStatus": {
- "value": "_softOptIn"
- },
- "subsidiary": {
- "internalId": "3",
- "name": "Honeycomb Holdings Inc."
- },
- "isInactive": false,
- "isPrivate": false,
- "email": "tomsmith@tomsmith.com",
- "lastName": "Smith",
- "firstName": "Tom",
- "salutation": "Smith",
- "entityId": "Tom Smith"
- }
- ]
-}
-```
-Click to expand
-
-```xml
-
-
-
- YOURAPPLICATIONID
-
-
- YOUREMAIL
- YOURPASSWORD
- YOURACCOUNT
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-```
-Click to see the response
-
-```json
-{
- "results": [
- {
- "externalId": "Karen Austin / John Spear",
- "internalId": "912",
- "lastModifiedDate": "2019-07-24T09:54:53.000+0000",
- "dateCreated": "2015-06-07T20:47:55.000+0000",
- "globalSubscriptionStatus": {
- "value": "_softOptIn"
- },
- "supervisor": {
- "internalId": "27",
- "name": "Brad M Sparling"
- },
- "mobilePhone": "(123) 545-6666",
- "homePhone": "(222) 123-4321",
- "officePhone": "(123) 456-7890",
- "subsidiary": {
- "internalId": "1",
- "name": "Honeycomb Mfg."
- },
- "isInactive": false,
- "isPrivate": false,
- "defaultAddress": "Brandy Dough
7829 N. Commerce Avenue
San Francisco CA
United States",
- "email": "bdickens@ramsey.com",
- "phone": "(123) 456-7890",
- "title": "Purchasing",
- "lastName": "Dickens",
- "firstName": "Brandy",
- "entityId": "Brandy Dickens"
- },
- {
- "internalId": "1545",
- "lastModifiedDate": "2019-07-24T09:56:22.000+0000",
- "dateCreated": "2015-03-18T14:35:42.000+0000",
- "globalSubscriptionStatus": {
- "value": "_softOptIn"
- },
- "supervisor": {
- "internalId": "1516",
- "name": "Brenda Jones"
- },
- "homePhone": "(713) 456-7878",
- "subsidiary": {
- "internalId": "1",
- "name": "Honeycomb Mfg."
- },
- "isInactive": false,
- "isPrivate": false,
- "defaultAddress": "123
Ave B
Houston TX 78665
United States",
- "email": "adminaccess2@ramsey.com",
- "phone": "(713) 456-7878",
- "lastName": "Samms",
- "firstName": "Brandy",
- "entityId": "Brandy Samms"
- }
- ]
-}
-```
-Click to expand
-
-```xml
-
-
-
- YOURAPPLICATIONID
-
-
- YOUREMAIL
- YOURPASSWORD
- YOURACCOUNT
-
-
-
-
-
-
-
- _inventoryItem
-
-
-
-
- 10
-
-
-
-
-
-
-```
-Click to see the response
-
-```json
-{
- "results": [
- {
- "externalId": "ITEM163",
- "internalId": "163",
- "customFieldList": {
- "customField": [
- {
- "value": false,
- "scriptId": "custitem16",
- "internalId": "194"
- }
- ]
- },
- "supplyReplenishmentMethod": {
- "internalId": "REORDER_POINT",
- "name": "Reorder Point"
- },
- "currency": "USA",
- "availableToPartners": false,
- "isInactive": true,
- "offerSupport": false,
- "isOnline": true,
- "displayName": "Reserve Pinot Noir 2000",
- "itemId": "Reserve Pinot Noir 2000",
- "outOfStockBehavior": {
- "value": "_default"
- },
- "onSpecial": false,
- "dontShowPrice": false,
- "showDefaultDonationAmount": false,
- "isDonationItem": false,
- "sitemapPriority": {
- "value": "_auto"
- },
- "excludeFromSitemap": false,
- "autoReorderPoint": true,
- "seasonalDemand": false,
- "autoPreferredStockLevel": true,
- "autoLeadTime": true,
- "leadTime": 0,
- "useBins": false,
- "cost": 6,
- "overallQuantityPricingType": {
- "value": "_byLineQuantity"
- },
- "costEstimateType": {
- "value": "_averageCost"
- },
- "useMarginalRates": false,
- "costCategory": {
- "internalId": "3",
- "name": "Default"
- },
- "shipIndividually": false,
- "enforceMinQtyInternally": true,
- "roundUpAsComponent": false,
- "isSpecialOrderItem": false,
- "isDropShipItem": false,
- "trackLandedCost": false,
- "costingMethodDisplay": "Average",
- "weightUnit": {
- "value": "_lb"
- },
- "weight": 5,
- "billExchRateVarianceAcct": {
- "internalId": "152",
- "name": "5097 Bill Exchange Rate Variance"
- },
- "billPriceVarianceAcct": {
- "internalId": "151",
- "name": "5096 Bill Price Variance"
- },
- "billQtyVarianceAcct": {
- "internalId": "150",
- "name": "5095 Bill Quantity Variance"
- },
- "matchBillToReceipt": false,
- "assetAccount": {
- "internalId": "120",
- "name": "Inventory Asset"
- },
- "taxSchedule": {
- "internalId": "1",
- "name": "S1"
- },
- "incomeAccount": {
- "internalId": "56",
- "name": "4002 Sales : Sales - Merchandise"
- },
- "includeChildren": true,
- "salesDescription": "Reserve Pinot Noir 2000",
- "cogsAccount": {
- "internalId": "121",
- "name": "Cost of Goods Sold"
- },
- "copyDescription": false,
- "purchaseDescription": "Reserve Pinot Noir 2000",
- "lastModifiedDate": "2016-01-18T08:05:19.000+0000",
- "createdDate": "2015-06-12T21:29:35.000+0000"
- },
- {
- "externalId": "ITEM164",
- "internalId": "164",
- "customFieldList": {
- "customField": [
- {
- "value": false,
- "scriptId": "custitem16",
- "internalId": "194"
- }
- ]
- },
- "supplyReplenishmentMethod": {
- "internalId": "REORDER_POINT",
- "name": "Reorder Point"
- },
- "currency": "USA",
- "availableToPartners": false,
- "isInactive": true,
- "offerSupport": false,
- "isOnline": true,
- "displayName": "Crystallus 2002",
- "itemId": "Crystallus 2002",
- "outOfStockBehavior": {
- "value": "_default"
- },
- "onSpecial": false,
- "dontShowPrice": false,
- "showDefaultDonationAmount": false,
- "isDonationItem": false,
- "sitemapPriority": {
- "value": "_auto"
- },
- "excludeFromSitemap": false,
- "autoReorderPoint": true,
- "seasonalDemand": false,
- "autoPreferredStockLevel": true,
- "autoLeadTime": true,
- "leadTime": 0,
- "useBins": false,
- "cost": 5,
- "overallQuantityPricingType": {
- "value": "_byLineQuantity"
- },
- "costEstimateType": {
- "value": "_averageCost"
- },
- "useMarginalRates": false,
- "costCategory": {
- "internalId": "3",
- "name": "Default"
- },
- "shipIndividually": false,
- "enforceMinQtyInternally": true,
- "roundUpAsComponent": false,
- "isSpecialOrderItem": false,
- "isDropShipItem": false,
- "trackLandedCost": false,
- "costingMethodDisplay": "Average",
- "weightUnit": {
- "value": "_lb"
- },
- "weight": 5,
- "billExchRateVarianceAcct": {
- "internalId": "152",
- "name": "5097 Bill Exchange Rate Variance"
- },
- "billPriceVarianceAcct": {
- "internalId": "151",
- "name": "5096 Bill Price Variance"
- },
- "billQtyVarianceAcct": {
- "internalId": "150",
- "name": "5095 Bill Quantity Variance"
- },
- "matchBillToReceipt": false,
- "assetAccount": {
- "internalId": "120",
- "name": "Inventory Asset"
- },
- "taxSchedule": {
- "internalId": "1",
- "name": "S1"
- },
- "incomeAccount": {
- "internalId": "56",
- "name": "4002 Sales : Sales - Merchandise"
- },
- "includeChildren": true,
- "salesDescription": "Crystallus 2002",
- "cogsAccount": {
- "internalId": "121",
- "name": "Cost of Goods Sold"
- },
- "copyDescription": false,
- "purchaseDescription": "Crystallus 2002",
- "lastModifiedDate": "2016-01-18T08:05:19.000+0000",
- "createdDate": "2015-06-12T21:29:35.000+0000"
- }
- ]
-}
-```
-Click to expand
+ 5. [Upsert Invoice(deprecated)](/components/netsuite/deprecated-functions#upsert-invoicedeprecated)
+ Deprecated. Use [Upsert Object By Id](/components/netsuite/actions#upsert-object-by-id) action instead. Create new or update existing invoice by provided external ID.
- - Blanket Purchase Order
- - CCard Refund
- - Commission
- - Credit Card
- - Currency Revaluation
- - Customer Payment Authorization
- - Deprecated Custom Transaction
- - Finance Charge
- - Fulfillment Request
- - GL Impact Adjustment
- - Inventory Count
- - Inventory Distribution
- - Inventory Status Change
- - Inventory Worksheet
- - Liability Adjustment
- - Ownership Transfer
- - Payroll Adjustment
- - Payroll Liability Check
- - Period End Journal
- - Purchase Contract
- - Request For Quote
- - Revenue Arrangement
- - Revenue Commitment
- - Revenue Commitment Reversal
- - Revenue Contract
- - Sales Tax Payment
- - Statement Charge
- - Store Pickup Fulfillment
- - System Journal
- - Tax Liability Cheque
- - Tegata Payable
- - Tegata Receivable
- - Transfer
- - Vendor Request For Quote
- Click to expand
-
-```xml
-
-
-
- YOURAPPLICATIONID
-
-
- YOUREMAIL
- YOURPASSWORD
- YOURACCOUNT
-
-
-
-
-
-
-
-
-```
-Click to see the response
-
-```json
-{
- "results": [
- {
- "basic": {
- "salesRep": [
- {
- "searchValue": {
- "internalId": "1008"
- }
- }
- ],
- "phone": [
- {
- "searchValue": "937-287-2222"
- }
- ],
- "internalId": [
- {
- "searchValue": {
- "internalId": "980"
- }
- }
- ],
- "entityId": [
- {
- "searchValue": "D&H Manufacturing"
- }
- ],
- "billState": [
- {
- "searchValue": "OH"
- }
- ],
- "billCity": [
- {
- "searchValue": "Dayton"
- }
- ],
- "billAddress1": [
- {
- "searchValue": "410 E. Fifth St."
- }
- ]
- }
- }
- ]
-}
-```
-Input metadata for Invoice object:
-
-```json
-{
- "internalId": "13817",
- "entity": {
- "internalId": "5"
- },
- "currency": {
- "internalId": "1"
- },
- "tranDate": "2023-05-23",
- "itemList": {
- "item": [
- {
- "description": "General Donation",
- "amount": 1000,
- "item": {
- "internalId": "12"
- },
- "quantity": 1,
- "rate": "100",
- "taxCode": {
- "internalId": "5"
- },
- "customFieldList": {
- "customField": [
- {
- "type": "SelectCustomFieldRef",
- "scriptId": "asd_d3",
- "value": {
- "name": "Charity type",
- "internalId": "2"
- }
- }
- ]
- }
- }
- ]
- },
- "customFieldList": {
- "customField": [
- {
- "type": "StringCustomFieldRef",
- "scriptId": "custbody_sf_field-one",
- "value": "Bank Transfer"
- },
- {
- "type": "StringCustomFieldRef",
- "scriptId": "custbody_sf_field-two",
- "value": "Individual One-Off"
- },
- {
- "type": "StringCustomFieldRef",
- "scriptId": "custbody_sf_field-three",
- "value": "John Doe"
- },
- {
- "type": "StringCustomFieldRef",
- "scriptId": "custbody_sf_field-four",
- "value": "ABC-987"
- }
- ]
- }
-}
-```
-Click to see the response
-
-Request sample:
-```json
-{
- "externalId": "23213000001",
- "customForm": {
- "name": "HM Product Invoice",
- "internalId": "102"
- },
- "entity": {
- "name": "Jennings Financial",
- "internalId": "81"
- },
- "terms": {
- "name": "Net 30",
- "internalId": "2"
- },
- "subsidiary": {
- "name": "Honeycomb Mfg.",
- "internalId": "1"
- },
- "currency": {
- "name": "USA",
- "internalId": "1"
- },
- "location": {
- "name": "02: Boston",
- "internalId": "1"
- },
- "isTaxable": true,
- "taxItem": {
- "name": "CA-SAN MATEO",
- "internalId": "-112"
- },
- "taxRate": 8.25,
- "fax": "916-555-0806",
- "message": "We appreciate your prompt payment",
- "shipMethod": {
- "name": "Truck",
- "internalId": "3"
- },
- "itemList": {
- "item": [
- {
- "job": null,
- "item": {
- "name": "CHA00002®",
- "internalId": "707",
- "externalId": null,
- "type": null
- },
- "line": 1,
- "description": "Assembly Item - Historical",
- "amount": 7020,
- "isTaxable": null,
- "quantity": 36,
- "price": {
- "name": "List Price",
- "internalId": "1"
- },
- "rate": "195.00",
- "taxCode": {
- "name": "-Not Taxable-",
- "internalId": "-7"
- }
- }
- ],
- "replaceAll": false
- },
- "shippingCost": 704.25,
- "customFieldList": {
- "customField": [
- {
- "type": "BooleanCustomFieldRef",
- "internalId": "167",
- "scriptId": "custbody_fmt_senior_exec_declined",
- "value": false
- }
- ]
- }
-}
-```
-Screenshot instructions
+
+
+
+
+
+
+
+
+
+
+Example for customer
+
+ ```graphql
+ metafields(first: 2) {
+ edges {
+ node {
+ namespace
+ key
+ value
+ }
+ }
+ }
+ addresses {
+ address1
+ country
+ }
+ ```
+
+ Response with enabled "Return Full Response" checkbox and "Emit Behavior" = "Emit page"
+
+```json
{
- "search": "query=name:\"#D12\""
+ "data": {
+ "customers": [
+ {
+ "id": "gid://shopify/Customer/2444144115794",
+ "firstName": "Willy"
+ },
+ {
+ "id": "gid://shopify/Customer/2444144148562",
+ "firstName": "Tobi"
+ },
+ {
+ "id": "gid://shopify/Customer/2444144181330",
+ "firstName": "Mathilde"
+ }
+ ]
+ },
+ "extensions": {
+ "cost": {
+ "requestedQueryCost": 5,
+ "actualQueryCost": 5,
+ "throttleStatus": {
+ "maximumAvailable": 1000,
+ "currentlyAvailable": 40,
+ "restoreRate": 50
+ }
+ }
+ }
}
- ```
+```
+Response with disabled "Return Full Response" checkbox and "Emit Behavior" = "Emit page"
-Objects in Shopify can be created with [Execute mutation action](#execute-mutation)
+```json
+{
+ "results": [
+ {
+ "id": "gid://shopify/Customer/2444144115794",
+ "firstName": "Willy"
+ },
+ {
+ "id": "gid://shopify/Customer/2444144148562",
+ "firstName": "Tobi"
+ },
+ {
+ "id": "gid://shopify/Customer/2444144181330",
+ "firstName": "Mathilde"
+ }
+ ]
+}
+```
+Example of input metadata to delete a customer
+
+``` json
+{
+ "input": {
+ "id": "gid://shopify/Customer/6657016299696"
}
- ```
+}
+```
+Example of input metadata to delete multiple companies
-### Update Object
+``` json
+{
+ "companyIds": ["gid://shopify/Company/68616368"]
+}
+```
+Example of input metadata to bulk delete draft orders using search
+
+```json
+{
+ "search": "query=name:\"#D12\""
+}
+```
+
+Example of input metadata to create a customer
+``` json
+{
+ "input": {
+ "firstName": "NewUser"
+ }
+}
+```
+
+Example of input metadata to update a customer
``` json
- {
- "input": {
- "firstName": "NewUser2",
- "id": "gid://shopify/Customer/6664472461488"
- }
+{
+ "input": {
+ "firstName": "NewUser2",
+ "id": "gid://shopify/Customer/6664472461488"
}
- ```
+}
+```
+Example for customer
+
+```graphql
customer {
metafields(first: 2) {
edges {
@@ -220,9 +341,11 @@ Execute any mutation available on selected API version. This action can be used
country
}
}
- ```
+```
-❗Note: You need to select basic fields or provide additional fields for resulting object to execute mutation
+Example for customer
+
+ ```graphql
+ addresses {
address1
country
- }
- ```
+ }
+ ```
-* **Emit Behavior** - (dropdown, required): Defines the way result objects will be emitted, one of `Emit page` or `Emit individually`.
-* **Return Full Response** - (checkbox): Defines the format of emitted result: with service information or without.
-Examples for Object type `customers` are given below:
- Response with enabled `Return Full Response` checkbox and `Emit Behavior` = `Emit page`
-
- ```json
- {
- "data": {
- "customers": [
- {
- "id": "gid://shopify/Customer/2444144115794",
- "firstName": "Willy"
- },
- {
- "id": "gid://shopify/Customer/2444144148562",
- "firstName": "Tobi"
- },
- {
- "id": "gid://shopify/Customer/2444144181330",
- "firstName": "Mathilde"
- }
- ]
- },
- "extensions": {
- "cost": {
- "requestedQueryCost": 5,
- "actualQueryCost": 5,
- "throttleStatus": {
- "maximumAvailable": 1000,
- "currentlyAvailable": 40,
- "restoreRate": 50
- }
+ Response with enabled `Return Full Response` checkbox and `Emit Behavior` = `Emit page`
+
+```json
+{
+ "data": {
+ "customers": [
+ {
+ "id": "gid://shopify/Customer/2444144115794",
+ "firstName": "Willy"
+ },
+ {
+ "id": "gid://shopify/Customer/2444144148562",
+ "firstName": "Tobi"
+ },
+ {
+ "id": "gid://shopify/Customer/2444144181330",
+ "firstName": "Mathilde"
+ }
+ ]
+ },
+ "extensions": {
+ "cost": {
+ "requestedQueryCost": 5,
+ "actualQueryCost": 5,
+ "throttleStatus": {
+ "maximumAvailable": 1000,
+ "currentlyAvailable": 40,
+ "restoreRate": 50
}
}
- }
- ```
+ }
+}
+```
+Response with disabled `Return Full Response` checkbox and `Emit Behavior` = `Emit page`
+
+```json
+{
+ "results": [
+ {
+ "id": "gid://shopify/Customer/2444144115794",
+ "firstName": "Willy"
+ },
+ {
+ "id": "gid://shopify/Customer/2444144148562",
+ "firstName": "Tobi"
+ },
+ {
+ "id": "gid://shopify/Customer/2444144181330",
+ "firstName": "Mathilde"
+ }
+ ]
+}
+```
+- **Number of search terms** - (number, optional): text field to specify the number of search terms (positive integer number [1-99] or 0).
+- **Emit empty object if no entities found** - (checkbox): If this checkbox is selected and objects are not found component will emit an empty object instead of skipping execution
-* **Number of search terms** - (number, optional): text field to specify the number of search terms (positive integer number [1-99] or 0).
-* **Emit empty object if no entities found** - (checkbox): If this checkbox is selected and objects are not found component will emit an empty object instead of skipping execution
+
-
-2. From dropdown `Select basic fields for resulting object` select basic fields: `id`, `state` and `firstName`.
- 
-
-**Note**: Basic fields are fields that can be requested without specifying arguments or adding additional levels: `id`, `email`, etc.
-3. Paste additional fields in field `You can provide additional fields here`:
- 
+**1.** Select in `Object type` option `Customers`.
+{% include img.html max-width="100%" url="img/example-1.png" title="Example 1" %}
-**Note**: Additional fields are fields that can't be selected in `Basic fields` section. As rule, they are fields with specifying arguments or adding additional levels such as: `addresses{country}`.
+**2.** From dropdown `Select basic fields for resulting object` select basic fields: `id`, `state` and `firstName`.
+{% include img.html max-width="100%" url="img/example-2.png" title="Example 2" %}
+>**Please Note**: Basic fields are fields that can be requested without specifying arguments or adding additional levels: `id`, `email`, etc.
-4. Select `Emit Behavior`. If it is needed to receive each object individually, use `Emit individually`, in other case, `Emit page` option - all objects will be returned in one array `result`. For example, lets use 'Emit individually'
- 
+**3.** Paste additional fields in field `You can provide additional fields here`:
+{% include img.html max-width="100%" url="img/example-3.png" title="Example 3" %}
+> **Please Note**: Additional fields are fields that can't be selected in `Basic fields` section. As rule, they are fields with specifying arguments or adding additional levels such as: `addresses{country}`.
-5. Specify `Number of search terms`: in example query we see 2 conditions, so set it to `2`
- 
+**4.** Select `Emit Behavior`. If it is needed to receive each object individually, use `Emit individually`, in other cases, `Emit page` option - all objects will be returned in one array `result`. For example, lets use `Emit individually`.
+{% include img.html max-width="100%" url="img/example-4.png" title="Example 4" %}
-6. Push the button `Continue` and move to fill metadata
+**5.** Specify `Number of search terms`: in example query we see 2 conditions, so set it to `2`.
+{% include img.html max-width="100%" url="img/example-5.png" title="Example 5" %}
-7. Set `10` to field `First`
- 
+**6.** Push the button `Continue` and move to fill metadata.
-8. To map condition `country:Canada`:
+**7.** Set `10` to field `First`.
+{% include img.html max-width="100%" url="img/example-6.png" title="Example 6" %}
-- select in `Field name` from Allowed Values dropdown option `country`:
- 
+**8.** To map condition `country:Canada`:
+- Select in `Field name` from Allowed Values dropdown option `country`:
+{% include img.html max-width="100%" url="img/example-7.png" title="Example 7" %}
+- Select in `Condition` from Allowed Values dropdown option `:`.
+- Set in `Field value` value `Canada`.
+{% include img.html max-width="100%" url="img/example-8.png" title="Example 8" %}
-- select in `Condition` from Allowed Values dropdown option `:`
-- set in `Field value` value `Canada`
+**9.** Select in `Logical operator` from Allowed Values dropdown option `AND`.
-
+**10.** To map condition `-state:DISABLED`: set `Field name` to `-state`, `Condition` to `:` and `Field value` to `DISABLED`.
+{% include img.html max-width="100%" url="img/example-9.png" title="Example 9" %}
-9. Select in `Logical operator` from Allowed Values dropdown option `AND`
-10. To map condition `-state:DISABLED`: set `Field name` to `-state`, `Condition` to `:` and `Field value` to `DISABLED`
+**11.** Push the button `Continue` and move to `Sample` section.
-
+**12.** Push the button `Retrieve new sample from Shopify admin component v2`.
-11. Push the button `Continue` and move to `Sample` section
-12. Push the button `Retrieve new sample from Shopify admin component v2`
-13. Step is configured.
+**13.** Step is configured.
### Lookup Object By ID
@@ -402,19 +531,21 @@ Lookup a single object by its ID - only query with one argument `id` can be used
#### Configuration Fields
* **Object Type** - (dropdown, required): Object-type to lookup on. E.g `Customer`.
-* **Select basic fields for resulting object** - (dropdown, optional): Here provided only basic fields that can be included in resulting object, it may affect on query cost
-* **You can provide additional fields here** - (string, optional): Resulting object can be expanded using GraphQL request, it may affect on query cost
- Example for customer
+* **Select basic fields for resulting object** - (dropdown, optional): Here only basic fields can be included in the resulting object, it may affect query cost.
+* **You can provide additional fields here** - (string, optional): The resulting object can be expanded using GraphQL request, it may affect query cost.
- ```
- addresses {
- address1
- country
- }
+Example for customer
+
+ ```graphql
+ addresses {
+ address1
+ country
+ }
```
+
+{% include img.html max-width="100%" url="img/lookup-by-id.png" title="Lookup Object By ID" %}
#### Input Metadata
@@ -430,11 +561,11 @@ Executes custom request.
#### Configuration Fields
-none
+There is no configuration fields in this action.
#### Input Metadata
-* **Url** - (string, required): Path of the resource relative to the base URL (`https://{store_name}.myshopify.com/admin/api/{api_version}/`) or full url
+* **URL** - (string, required): Path of the resource relative to the base URL (`https://{store_name}.myshopify.com/admin/api/{api_version}/`) or full URL
* **Method** - (string, required): HTTP verb to use in the request, one of `GET`, `POST`, `PUT`, `PATCH`, `DELETE`.
* **Request Body** - (object, optional): Body of the request to send.
@@ -444,154 +575,21 @@ none
* **HTTP headers** - (object, required): HTTP headers of the response.
* **Response Body** - (object, optional): HTTP response body.
-**Note**: GraphQL and REST API endpoints are supported. E.g.
-
-GraphQL
-
-* **Url** - `/graphql.json`
-* **Method** - `POST`
-* **Request Body** - `{"query": "query { products(first: 10) { edges { node { id title } } } }"}`
-
-Equivalent to this:
-
-REST
-
-* **Url** - `/products.json?fields=id,title`
-* **Method** - `POST`
-* **Request Body** - *empty
-
-## Triggers
-
-### Get New and Updated Objects Polling
-
-Retrieve all the updated or created objects within a given time range.
-
-#### Configuration Fields
-
-* **Object Type** - (dropdown, required): Object-type to lookup on. E.g `Customers`.
-
-* **Timestamp field to poll on** - (dropdown, required): Can be either Last Modified or Created dates (updated or new objects, respectively)
-
-* **Select basic fields for resulting object** - (dropdown, optional): Here provided only basic fields that can be included in resulting object, it may affect on query cost
-* **You can provide additional fields here** - (string, optional): Resulting object can be expanded using GraphQL request, this field represent content from each `edges.node`, it may affect on query cost
- Example for Customers
-
- ```
- metafields(first: 2) {
- edges {
- node {
- namespace
- key
- value
- }
- }
- }
- addresses {
- address1
- country
- }
- ```
-
-* **Size of Polling Page** - (optional, positive integer, defaults to 250, max 250): Indicates the size of pages to be fetched per request. If you query cost will be over shop limit, you can decrease page size.
-* **Emit behavior** - (dropdown, optional): Indicates emit objects behavior - `Emit individually` (by default) or `Emit page`
-* **Return Full Response** - (checkbox): Defines the format of emitted result: with service information or without.
- Examples for Object type `customers` are given below:
-Response with enabled `Return Full Response` checkbox and `Emit Behavior` = `Emit page`
-
-```json
-{
- "data": {
- "customers": [
- {
- "id": "gid://shopify/Customer/2444144115794",
- "firstName": "Willy"
- },
- {
- "id": "gid://shopify/Customer/2444144148562",
- "firstName": "Tobi"
- },
- {
- "id": "gid://shopify/Customer/2444144181330",
- "firstName": "Mathilde"
- }
- ]
- },
- "extensions": {
- "cost": {
- "requestedQueryCost": 5,
- "actualQueryCost": 5,
- "throttleStatus": {
- "maximumAvailable": 1000,
- "currentlyAvailable": 40,
- "restoreRate": 50
- }
- }
- }
-}
-```
-
-
-Response with disabled `Return Full Response` checkbox and `Emit Behavior` = `Emit page`
+> **Note:** GraphQL and REST endpoints are supported. You can find examples below.
-```json
-{
- "results": [
- {
- "id": "gid://shopify/Customer/2444144115794",
- "firstName": "Willy"
- },
- {
- "id": "gid://shopify/Customer/2444144148562",
- "firstName": "Tobi"
- },
- {
- "id": "gid://shopify/Customer/2444144181330",
- "firstName": "Mathilde"
- }
- ]
-}
-```
-
-
-* **Start Time** - (string, optional): The timestamp, in ISO8601 format, to start polling from (inclusive). Default value is the beginning of time (January 1, 1970 at 00:00.000).
-* **End Time** - (string, optional): The timestamp, in ISO8601 format, to end at (inclusive). Default value is never.
-
-
-#### Input Metadata
-
-None.
-
-#### Output Metadata
-Resulting object will represent content from path "data\\{Object Type}\\edges\node"
-
-Depends on selected `Object Type`, selected or provided fields and `Emit behavior`:
-For `Emit Page` mode: An object with key `results` that has an array as its value (if `Page Size` > 0)
-For `Emit Individually` mode: Each object which fill the entire message.
-
-
-### Webhook
-
-Creates [webhook subscription](https://shopify.dev/docs/api/admin-graphql/2024-01/mutations/webhookSubscriptionCreate) for selected topics on the Shopify side to receive events
+#### GraphQL
+* **URL** - `/graphql.json`.
+* **Method** - `POST`.
+* **Request Body** - `{"query": "query { products(first: 10) { edges { node { id title } } } }"}`.
-#### Configuration Fields
-
-* **Select topics** - (multi-select dropdown, required): Select available topics to create a subscription
-* **Skip validation** - (checkbox, optional): If checked - the component will not validate the incoming message to be sure that it comes from Shopify, use it for test purposes only!
-
-#### Input Metadata
-
-None.
-
-#### Output Metadata
-Event from the subscription on the selected topic
-
-#### Limitations
-* **Generate Stub Sample** works only for the most used objects
-* This trigger doesn't support `Retrieve sample` functionality
-* If you use ordinary flow (`real-time` not enabled) after flow starts you will need to run it once - just follow the webhook URL (to make the first execution) this action will create a subscription, error on this execution may be ignored
+#### REST
+- **URL** - `/products.json?fields=id,title`.
+- **Method** - `POST`.
+* **Request Body** - `{}`.
## Known limitations
+
* Look at [Shopify API rate limits](https://shopify.dev/api/usage/rate-limits), specially [GraphQL Admin API rate limits](https://shopify.dev/api/usage/rate-limits#graphql-admin-api-rate-limits)
-* If the component reaches API rate limit it will retry the request after waiting until the queue is restored up to 10 times: for example - a query costs `500` points, currently available only `100` points, the restore rate `50` points/second, the component will wait `8` seconds until available points will be restored and try again to get data
+* If the component reaches API rate limit it will retry the request after waiting until the queue is restored up to 10 times: for example - a query costs `500` points, currently available only `100` points, the restore rate `50` points/second, the component will wait `8` seconds until available points will be restored and try again to get data.
- Be careful with several flows running at the same time, each of them can affect on total available points, if the component won't be able to get data after 10 retries, then the error `"Throttled"` will be thrown
+ Be careful with several flows running at the same time, each of them can affect on total available points, if the component won't be able to get data after 10 retries, then the error `"Throttled"` will be thrown.
diff --git a/content/_components/whatsapp/index.md b/content/_components/whatsapp/index.md
index 0d1cc1dd..16a3430d 100644
--- a/content/_components/whatsapp/index.md
+++ b/content/_components/whatsapp/index.md
@@ -71,10 +71,265 @@ None
#### Input Metadata
-Please refer to the [Input Schema file](./src/schemas/actions/sendMessage.in.json) for the full list of metadata fields.
+
+Please refer to the Input Schema file below for the full list of metadata fields.
+Input Schema file
+```json
+{
+ "type": "object",
+ "properties": {
+ "to": {
+ "type": "string",
+ "title": "To",
+ "required": true,
+ "help": {
+ "description": "WhatsApp ID or phone number of the customer you want to send a message to. See Phone Number Formats link below",
+ "link": "https://developers.facebook.com/docs/whatsapp/cloud-api/reference/phone-numbers#phone-number-formats"
+ }
+ },
+ "type": {
+ "type": "string",
+ "title": "Type",
+ "help": {
+ "description": "The type of message you want to send. If omitted, defaults to text"
+ },
+ "required": false,
+ "enum": [
+ "contacts",
+ "location",
+ "text",
+ "template"
+ ]
+ },
+ "contacts": {
+ "type": "object",
+ "required": false,
+ "title": "Contacts",
+ "help": {
+ "description": "Required when type=contacts"
+ },
+ "properties": {
+ "addresses": {
+ "type": "object",
+ "title": "Addresses",
+ "help": {
+ "description": "Full contact address(es) formatted as an addresses object"
+ },
+ "required": false,
+ "properties": {
+ "street": {
+ "type": "string",
+ "title": "Street",
+ "help": {
+ "description": "Street number and name"
+ },
+ "required": false
+ },
+ "city": {
+ "type": "string",
+ "title": "City",
+ "help": {
+ "description": "City name"
+ },
+ "required": false
+ },
+ "state": {
+ "type": "string",
+ "title": "State",
+ "help": {
+ "description": "State abbreviation"
+ },
+ "required": false
+ },
+ "zip": {
+ "type": "string",
+ "title": "ZIP",
+ "help": {
+ "description": "ZIP code"
+ },
+ "required": false
+ },
+ "country": {
+ "type": "string",
+ "title": "Country",
+ "help": {
+ "description": "Full country name"
+ },
+ "required": false
+ },
+ "country_code": {
+ "type": "string",
+ "title": "Country code",
+ "help": {
+ "description": "Two-letter country abbreviation"
+ },
+ "required": false
+ },
+ "type": {
+ "type": "string",
+ "title": "Type",
+ "help": {
+ "description": "Standard values are HOME and WORK"
+ },
+ "required": false
+ }
+ }
+ }
+ }
+ },
+ "template": {
+ "type": "object",
+ "title": "Template",
+ "help": {
+ "description": "Required when type=template"
+ },
+ "required": false,
+ "properties": {
+ "name": {
+ "type": "string",
+ "title": "Name",
+ "help": {
+ "description": "Name of the template"
+ },
+ "required": false
+ },
+ "language": {
+ "type": "object",
+ "title": "Language",
+ "help": {
+ "description": "Contains a language object. Specifies the language the template may be rendered in"
+ },
+ "required": false,
+ "properties": {
+ "policy": {
+ "type": "string",
+ "title": "Policy",
+ "help": {
+ "description": "The language policy the message should follow. The only supported option is deterministic"
+ },
+ "required": false
+ },
+ "code": {
+ "type": "string",
+ "title": "Code",
+ "help": {
+ "description": "The code of the language or locale to use. Accepts both language and language_locale formats (e.g., en and en_US). For all codes, see https://developers.facebook.com/docs/whatsapp/api/messages/message-templates#supported-languages"
+ },
+ "required": false
+ }
+ }
+ }
+ }
+ },
+ "text": {
+ "type": "object",
+ "title": "Text",
+ "help": {
+ "description": "Required for text messages"
+ },
+ "required": false,
+ "properties": {
+ "body": {
+ "type": "string",
+ "title": "Body",
+ "help": {
+ "description": "The text of the text message which can contain URLs which begin with http:// or https:// and formatting"
+ },
+ "required": false
+ },
+ "preview_url": {
+ "type": "boolean",
+ "title": "Preview URL",
+ "help": {
+ "description": "Set to true to have the WhatsApp Messenger and WhatsApp Business apps attempt to render a link preview of any URL in the body text string. URLs must begin with http:// or https://. If multiple URLs are in the body text string, only the first URL will be rendered"
+ },
+ "required": false
+ }
+ }
+ },
+ "location": {
+ "type": "object",
+ "title": "Location",
+ "help": {
+ "description": "Required when type=location"
+ },
+ "required": false,
+ "properties": {
+ "longitude": {
+ "type": "string",
+ "title": "Longitude",
+ "help": {
+ "description": "Longitude of the location"
+ },
+ "required": false
+ },
+ "latitude": {
+ "type": "string",
+ "title": "Latitude",
+ "help": {
+ "description": "Latitude of the location"
+ },
+ "required": false
+ },
+ "name": {
+ "type": "string",
+ "title": "Name",
+ "help": {
+ "description": "Name of the location"
+ },
+ "required": false
+ },
+ "address": {
+ "type": "string",
+ "title": "Address",
+ "help": {
+ "description": "Address of the location"
+ },
+ "required": false
+ }
+ }
+ },
+ "preview_url": {
+ "type": "boolean",
+ "title": "Preview URL",
+ "help": {
+ "description": "Required if type=text"
+ },
+ "required": false
+ },
+ "status": {
+ "type": "string",
+ "title": "Status",
+ "help": {
+ "description": "A message's status. You can use this field to mark a message as read"
+ },
+ "required": false
+ },
+ "context": {
+ "type": "object",
+ "title": "Context",
+ "help": {
+ "description": "Required if replying to any message in the conversation"
+ },
+ "required": false,
+ "properties": {
+ "message_id": {
+ "type": "string",
+ "title": "Message ID",
+ "help": {
+ "description": "ID of a previous message you are replying to"
+ },
+ "required": false
+ }
+ }
+ }
+ }
+}
+```
+