powertoolsdeveloper.collections
Module powertoolsdeveloper.collections
API
Definitions
![](https://bcentral-packageicons.azureedge.net/images/ballerinax_powertoolsdeveloper.collections_1.5.1.png)
ballerinax/powertoolsdeveloper.collections Ballerina library
Overview
This is a generated connector for Apptigent PowerTools Developer API v2021.1.01 OpenAPI specification. Apptigent PowerTools Developer Edition is a powerful suite of API endpoints for custom applications running on any stack. Manipulate text, modify collections, format dates and times, convert currency, perform advanced mathematical calculations, shorten URL's, encode strings, convert text to speech, translate content into multiple languages, process images, and more. PowerTools is the ultimate developer toolkit. This connector provides the capability to modify collections.
Prerequisites
Before using this connector in your Ballerina application, complete the following:
- Create Apptigent account
- Obtain tokens
- Log into Apptigent Developer Portal by visiting https://portal.apptigent.com
- Create an app and obtain the
Client ID
which will be used as theAPI Key
by following the guidelines described here.
Quickstart
To use the Apptigent PowerTools Developer connector in your Ballerina application, update the .bal file as follows:
Step 1: Import connector
Import the ballerinax/powertoolsdeveloper.collections
module into the Ballerina project.
import ballerinax/powertoolsdeveloper.collections as pc;
Step 2: Create a new connector instance
Create a collections:ApiKeysConfig
with the Client ID obtained, and initialize the connector with it.
pc:ApiKeysConfig config = { xIbmClientId: "<CLIENT_ID>" } pc:Client baseClient = check new Client(config);
Step 3: Invoke connector operation
-
Now you can use the operations available within the connector. Note that they are in the form of remote operations.
Following is an example on how to sort a collection of strings using the connector by providing the collection of strings to sort and the sort order.
Sort a collection of strings
public function main() { pc:InputCollectionSort inputCollectionSort = { input: ["a","d","c","b","e"], 'order: "Ascending" }; pc:OutputCollectionResult|error response = baseClient->sortCollection(inputCollectionSort); if (response is pc:OutputCollectionResult) { log:printInfo(response.toString()); } else { log:printError(response.message()); } }
-
Use
bal run
command to compile and run the Ballerina program.
Clients![](/images/permalink.svg)
powertoolsdeveloper.collections: Client![](/images/permalink.svg)
This is a generated connector for Apptigent PowerTools Developer API v2021.1.01 OpenAPI specification. 'Apptigent PowerTools Developer Edition is a powerful suite of API endpoints for custom applications running on any stack. Manipulate text, modify collections, format dates and times, convert currency, perform advanced mathematical calculations, shorten URL''s, encode strings, convert text to speech, translate content into multiple languages, process images, and more. PowerTools is the ultimate developer toolkit.' This connector provides the capability to modify collections.
Constructor![](/images/permalink.svg)
Gets invoked to initialize the connector
.
The connector initialization requires setting the API credentials.
Create an Apptigent account and obtain tokens following this guide.
init (ApiKeysConfig apiKeyConfig, ConnectionConfig config, string serviceUrl)
- apiKeyConfig ApiKeysConfig - API keys for authorization
- config ConnectionConfig {} - The configurations to be used when initializing the
connector
- serviceUrl string "https://connect.apptigent.com/api/utilities" - URL of the target service
addToCollection![](/images/permalink.svg)
function addToCollection(InputCollectionModify payload) returns OutputCollectionResult|error
Collections - Add to collection
Parameters
- payload InputCollectionModify - Collection modification parameters
Return Type
removeFromCollection![](/images/permalink.svg)
function removeFromCollection(InputCollectionModify payload) returns OutputCollectionResult|error
Collections - Remove from collection
Parameters
- payload InputCollectionModify - Collection modification parameters
Return Type
filterCollection![](/images/permalink.svg)
function filterCollection(InputCollectionFilter payload) returns OutputCollectionResult|error
Collections - Filter collection
Parameters
- payload InputCollectionFilter - Filter collection parameters
Return Type
sortCollection![](/images/permalink.svg)
function sortCollection(InputCollectionSort payload) returns OutputCollectionResult|error
Collections - Sort collection
Parameters
- payload InputCollectionSort - Sort collection parameters
Return Type
countCollection![](/images/permalink.svg)
function countCollection(InputCollectionCount payload) returns OutputNumber|error
Collections - Count collection
Parameters
- payload InputCollectionCount - Count collection parameters
Return Type
- OutputNumber|error - OK
splitCollection![](/images/permalink.svg)
function splitCollection(InputCollectionSplit payload) returns OutputMultiCollection|error
Collections - Split collection
Parameters
- payload InputCollectionSplit - Split collection parameters
Return Type
replaceValuesInCollection![](/images/permalink.svg)
function replaceValuesInCollection(InputCollectionReplace payload) returns OutputCollectionResult|error
Collections - Replace values in collection
Parameters
- payload InputCollectionReplace - Replace values in collection parameters
Return Type
collectionContainsString![](/images/permalink.svg)
function collectionContainsString(InputCollectionSearch payload) returns OutputCollectionString|error
Collections - Contains string
Parameters
- payload InputCollectionSearch - Collection search parameters
Return Type
collectionStartsWithString![](/images/permalink.svg)
function collectionStartsWithString(InputCollectionSearch payload) returns OutputCollectionString|error
Collections - Starts with string
Parameters
- payload InputCollectionSearch - Collection search parameters
Return Type
collectionEndsWithString![](/images/permalink.svg)
function collectionEndsWithString(InputCollectionSearch payload) returns OutputCollectionString|error
Collections - Ends with string
Parameters
- payload InputCollectionSearch - Collection search parameters
Return Type
collectionContainsNumber![](/images/permalink.svg)
function collectionContainsNumber(InputCollectionSearchNumeric payload) returns OutputCollectionNumber|error
Collections - Contains number
Parameters
- payload InputCollectionSearchNumeric - Collection search parameters
Return Type
collectionToJSON![](/images/permalink.svg)
function collectionToJSON(InputCollectionConversion payload) returns OutputString|error
Collections - Collection to JSON
Parameters
- payload InputCollectionConversion - Collection conversion parameters
Return Type
- OutputString|error - OK
collectionToXml![](/images/permalink.svg)
function collectionToXml(InputCollectionConversionXML payload) returns OutputString|error
Collections - Collection to XML
Parameters
- payload InputCollectionConversionXML - Collection conversion parameters
Return Type
- OutputString|error - OK
Records![](/images/permalink.svg)
powertoolsdeveloper.collections: ApiKeysConfig![](/images/permalink.svg)
Provides API key configurations needed when communicating with a remote HTTP endpoint.
Fields
- xIbmClientId string - Represents API Key
X-IBM-Client-Id
powertoolsdeveloper.collections: ClientHttp1Settings![](/images/permalink.svg)
Provides settings related to HTTP/1.x protocol.
Fields
- keepAlive KeepAlive(default http:KEEPALIVE_AUTO) - Specifies whether to reuse a connection for multiple requests
- chunking Chunking(default http:CHUNKING_AUTO) - The chunking behaviour of the request
- proxy ProxyConfig? - Proxy server related options
powertoolsdeveloper.collections: ConnectionConfig![](/images/permalink.svg)
Provides a set of configurations for controlling the behaviours when communicating with a remote HTTP endpoint.
Fields
- httpVersion HttpVersion(default http:HTTP_2_0) - The HTTP version understood by the client
- http1Settings ClientHttp1Settings? - Configurations related to HTTP/1.x protocol
- http2Settings ClientHttp2Settings? - Configurations related to HTTP/2 protocol
- timeout decimal(default 60) - The maximum time to wait (in seconds) for a response before closing the connection
- forwarded string(default "disable") - The choice of setting
forwarded
/x-forwarded
header
- poolConfig PoolConfiguration? - Configurations associated with request pooling
- cache CacheConfig? - HTTP caching related configurations
- compression Compression(default http:COMPRESSION_AUTO) - Specifies the way of handling compression (
accept-encoding
) header
- circuitBreaker CircuitBreakerConfig? - Configurations associated with the behaviour of the Circuit Breaker
- retryConfig RetryConfig? - Configurations associated with retrying
- responseLimits ResponseLimitConfigs? - Configurations associated with inbound response size limits
- secureSocket ClientSecureSocket? - SSL/TLS-related options
- proxy ProxyConfig? - Proxy server related options
- validation boolean(default true) - Enables the inbound payload validation functionality which provided by the constraint package. Enabled by default
powertoolsdeveloper.collections: InputCalculateMinMax![](/images/permalink.svg)
Fields
- input decimal[] - Colllection of values to calculate
- 'type string - Minimum or Maximum
powertoolsdeveloper.collections: InputCalculateNumber![](/images/permalink.svg)
Fields
- input decimal - Numeric value to calculate
- decimals decimal - Round to number of decimal places
powertoolsdeveloper.collections: InputCalculateNumbers![](/images/permalink.svg)
Fields
- input decimal - Numeric value
- value decimal - Addend, subtrahend, factor, divisor or radicand
- decimals decimal - Round to number of decimal places
powertoolsdeveloper.collections: InputCalculatePower![](/images/permalink.svg)
Fields
- input decimal - Number to raise
- power decimal - Power
- decimals decimal - Round to number of decimal places
powertoolsdeveloper.collections: InputCalculateSeries![](/images/permalink.svg)
Fields
- input decimal[] - Colllection of values to calculate
- decimals decimal - Round to number of decimal places
powertoolsdeveloper.collections: InputCaseConversion![](/images/permalink.svg)
Fields
- input string - String containing the text to convert
- alphacase string - Case of conversion result
powertoolsdeveloper.collections: InputCollectionConversion![](/images/permalink.svg)
Fields
- input string[] - Collection containing strings to convert
- name string - Collection name
powertoolsdeveloper.collections: InputCollectionConversionXML![](/images/permalink.svg)
Fields
- input string[] - Collection containing strings to convert
- root string - Name of root XML node
- child string - Name of child XML node(s)
powertoolsdeveloper.collections: InputCollectionCount![](/images/permalink.svg)
Fields
- input string[] - Collection of items to count
powertoolsdeveloper.collections: InputCollectionFilter![](/images/permalink.svg)
Fields
- input string[] - Collection of strings to filter
- 'match string - Match type
- keywords string - Keywords (separate multiple values with commas)
powertoolsdeveloper.collections: InputCollectionModify![](/images/permalink.svg)
Fields
- input string[] - Collection of values or objects to modify
- item string? - Item (for multiple items, leave blank and use Items)
- items string[]? - Items (Collection, for a single item leave blank and use Item)
- index string? - Index position for operation (leave blank to specify end of collection)
powertoolsdeveloper.collections: InputCollectionReplace![](/images/permalink.svg)
Fields
- input string[] - Collection of strings
- 'match string - Match value
- replacement string - Replacement value
- ignoreCase string - Ignore case
powertoolsdeveloper.collections: InputCollectionSearch![](/images/permalink.svg)
Fields
- input string[] - Collection of strings to search
- 'match string - Text to match
- trim string? - Trim white space from comparison string
- ignorecase string? - Ignore case when performing comparison
powertoolsdeveloper.collections: InputCollectionSearchNumeric![](/images/permalink.svg)
Fields
- input decimal[] - Collection of strings to search
- 'match decimal - Number to match
- 'type string(default "Integer") - Type of number - integer or decimal
powertoolsdeveloper.collections: InputCollectionSort![](/images/permalink.svg)
Fields
- input string[] - Collection of strings to sort
- 'order string - Sort order
powertoolsdeveloper.collections: InputCollectionSplit![](/images/permalink.svg)
Fields
- input string[] - Collection of items to split
- 'match string? - String to match (explicit, case-insensitive, leave empty to use Index)
- index string? - Index location to split (leave empty to use Match value)
powertoolsdeveloper.collections: InputConvertAngle![](/images/permalink.svg)
Fields
- input decimal -
- 'source string -
- target string -
powertoolsdeveloper.collections: InputConvertArea![](/images/permalink.svg)
Fields
- input decimal -
- 'source string -
- target string -
powertoolsdeveloper.collections: InputConvertDistance![](/images/permalink.svg)
Fields
- input decimal -
- 'source string -
- target string -
powertoolsdeveloper.collections: InputConvertDuration![](/images/permalink.svg)
Fields
- input decimal -
- 'source string -
- target string -
powertoolsdeveloper.collections: InputConvertEnergy![](/images/permalink.svg)
Fields
- input decimal -
- 'source string -
- target string -
powertoolsdeveloper.collections: InputConvertPower![](/images/permalink.svg)
Fields
- input decimal -
- 'source string -
- target string -
powertoolsdeveloper.collections: InputConvertSpeed![](/images/permalink.svg)
Fields
- input decimal -
- 'source string -
- target string -
powertoolsdeveloper.collections: InputConvertTemperature![](/images/permalink.svg)
Fields
- input decimal -
- 'source string -
- target string -
powertoolsdeveloper.collections: InputConvertVolume![](/images/permalink.svg)
Fields
- input decimal -
- 'source string -
- target string -
powertoolsdeveloper.collections: InputConvertWeight![](/images/permalink.svg)
Fields
- input decimal -
- 'source string -
- target string -
powertoolsdeveloper.collections: InputCsvConversionJSON![](/images/permalink.svg)
Fields
- input string - CSV string
- header boolean - Include header row
powertoolsdeveloper.collections: InputCurrencyConversion![](/images/permalink.svg)
Fields
- input decimal - Amount to convert
- 'source string -
- target string -
powertoolsdeveloper.collections: InputCurrencyFormat![](/images/permalink.svg)
Fields
- input decimal - Amount to format
- target string -
powertoolsdeveloper.collections: InputDataQuery![](/images/permalink.svg)
Fields
- input string - XML or JSON string
- query string - XPath or JSONPath query
powertoolsdeveloper.collections: InputDateTimeConversion![](/images/permalink.svg)
Fields
- input string - Source date and time
- 'source string -
- target string -
- format string? - Display format (defaults to 'yyyy-MM-dd HH:mm:ss')
powertoolsdeveloper.collections: InputDateTimeDifference![](/images/permalink.svg)
Fields
- dateTime1 string - First date/time value
- dateTime2 string - Second date/time value
powertoolsdeveloper.collections: InputDateTimeFormat![](/images/permalink.svg)
Fields
- input string - Source date and time
- culture string - Language culture
- format string - Output format
powertoolsdeveloper.collections: InputDateTimeInfo![](/images/permalink.svg)
Fields
- input string - Source date and time
- culture string - Language culture
powertoolsdeveloper.collections: InputGenerateHash![](/images/permalink.svg)
Fields
- input string - Hash source string
- algorithm string - Hash algorithm
powertoolsdeveloper.collections: InputGenerateUniqueID![](/images/permalink.svg)
Fields
- uppercase string - All uppercase alpha characters
powertoolsdeveloper.collections: InputJoinStrings![](/images/permalink.svg)
Fields
- input string[] - Collection of strings to be joined
- separator string - Separator character
- lower string - Convert strings in collection to lowercase
- trim string - Trim strings in collection
powertoolsdeveloper.collections: InputJsonConversionCSV![](/images/permalink.svg)
Fields
- input string - JSON array object
- header boolean - Include header row
- omit string? - Columns to omit (comma separated)
- 'order string? - Column order (comma separated)
powertoolsdeveloper.collections: InputJsonConversionHTML![](/images/permalink.svg)
Fields
- input string - JSON array object
- header boolean - Include header row
- alternate string? - Alternate header row markup
- attributes string? - Optional table attributes (single quoted values)
- omit string? - Columns to omit (comma separated)
- 'order string? - Column order (comma separated)
powertoolsdeveloper.collections: InputJsonConversionXML![](/images/permalink.svg)
Fields
- input string - JSON array object
- root string - Name of root node
powertoolsdeveloper.collections: InputMarketIndex![](/images/permalink.svg)
Fields
- symbol string - Market index
- date string? - Date (yyyy-MM-dd, leave empty for last trading day)
powertoolsdeveloper.collections: InputNumberRange![](/images/permalink.svg)
Fields
- 'start decimal - Start of range
- end decimal - End of range
powertoolsdeveloper.collections: InputQRCode![](/images/permalink.svg)
Fields
- input string - Text value(s) (vertical bar delimited by type)
- payload string - Payload type
powertoolsdeveloper.collections: InputRedactString![](/images/permalink.svg)
Fields
- 'source string - String containing the complete text
- value string? - Individual string to redact
- values string[]? - Collection of strings to redact
- regex string? - Regular expression pattern for matching strings
powertoolsdeveloper.collections: InputReplaceString![](/images/permalink.svg)
Fields
- 'source string - String containing the text to be replaced
- value string - Text to replace
- replacement string - Replacement text
powertoolsdeveloper.collections: InputSplitString![](/images/permalink.svg)
Fields
- input string - Text to split
- characters string - One or more characters that will be used to split the text
powertoolsdeveloper.collections: InputStockPrices![](/images/permalink.svg)
Fields
- symbols string - Stock ticker symbols (comma-separated, max 20)
- date string? - Date (yyyy-MM-dd, leave empty for latest)
- exchange string? - Stock exchange
powertoolsdeveloper.collections: InputString![](/images/permalink.svg)
Fields
- 'source string - String variable or text value
powertoolsdeveloper.collections: InputStringComparison![](/images/permalink.svg)
Fields
- input string - Original string
- compare string - Comparison string
- lower string - Convert strings to lowercase before comparison
- trim string - Trim strings before comparison
powertoolsdeveloper.collections: InputStringContains![](/images/permalink.svg)
Fields
- find string - Text to match
- input string - Text to search
- lower string - Convert strings to lowercase
powertoolsdeveloper.collections: InputStringToFile![](/images/permalink.svg)
Fields
- input string - Text string (body of file)
- extension string - File extension
- filename string - Name of file (without extension)
powertoolsdeveloper.collections: InputTextToSpeech![](/images/permalink.svg)
Fields
- text string - Text to convert (10,000 characters max)
- 'type string - Text or file type
- voice string - Voice locale (must match language of input text)
powertoolsdeveloper.collections: InputTranslateString![](/images/permalink.svg)
Fields
- input string - String containing the text to be translated
- language string - Translation language
powertoolsdeveloper.collections: InputTrimString![](/images/permalink.svg)
Fields
- 'source string - String containing the text to be trimmed
- 'type string - Type of white space to remove
powertoolsdeveloper.collections: InputVerifyHash![](/images/permalink.svg)
Fields
- input string - Original source string
- algorithm string - Hash algorithm
- hash string - Hashed result
powertoolsdeveloper.collections: InputXmlConversionJSON![](/images/permalink.svg)
Fields
- input string - XML string
powertoolsdeveloper.collections: OutputBoolean![](/images/permalink.svg)
Fields
- result boolean? - Result
powertoolsdeveloper.collections: OutputCollectionNumber![](/images/permalink.svg)
Fields
- status boolean? - Success
- item decimal? - First Value
- items decimal[]? - All Values
powertoolsdeveloper.collections: OutputCollectionResult![](/images/permalink.svg)
Fields
- result string[]? - Modified collection result
powertoolsdeveloper.collections: OutputCollectionString![](/images/permalink.svg)
Fields
- status boolean? - Success
- item string? - First Value
- items string[]? - All Values
powertoolsdeveloper.collections: OutputDateDifference![](/images/permalink.svg)
Fields
- years decimal? - Years
- months decimal? - Months
- days decimal? - Days
- hours decimal? - Hours
- minutes decimal? - Minutes
- milliseconds decimal? - Milliseconds
- totalYears decimal? - Total Years
- totalMonths decimal? - Total Months
- totalDays decimal? - Total Days
- totalHours decimal? - Total Hours
- totalMinutes decimal? - Total Minutes
- totalSeconds decimal? - Total Seconds
- totalMilliseconds decimal? - Total Milliseconds
- ticks decimal? - Ticks
powertoolsdeveloper.collections: OutputDateInfo![](/images/permalink.svg)
Fields
- DayOfYear decimal? - DayOfYear
- DayOfWeek decimal? - DayOfWeek
- WeekOfYear decimal? - WeekOfYear
- SecondsInDay decimal? - SecondsInDay
- MinutesInDay decimal? - MinutesInDay
- Ticks decimal? - Ticks
powertoolsdeveloper.collections: OutputFileByte![](/images/permalink.svg)
Fields
- result string? - Result
powertoolsdeveloper.collections: OutputMarketIndex![](/images/permalink.svg)
Fields
- date string? - Date
- symbol string? - Index symbol
- exchange string? - Market exchange
- open decimal? - Open value
- high decimal? - High value
- low decimal? - Low value
- close decimal? - Close value
- volume decimal? - Trading volume
- adj_open decimal? - Adjusted open value
- adj_high decimal? - Adjusted high value
- adj_low decimal? - Adjusted low value
- adj_close decimal? - Adjusted close value
- adj_volume decimal? - Adjusted trading volume
powertoolsdeveloper.collections: OutputMultiCollection![](/images/permalink.svg)
Fields
- result1 string[]? - First collection result
- result2 string[]? - Second collection result
powertoolsdeveloper.collections: OutputNumber![](/images/permalink.svg)
Fields
- result decimal? - Result
powertoolsdeveloper.collections: OutputStockPrice![](/images/permalink.svg)
Fields
- result OutputstockpriceResult[]? - Stock price information
powertoolsdeveloper.collections: OutputstockpriceResult![](/images/permalink.svg)
Fields
- date string? - Date
- symbol string? - Ticker symbol
- exchange string? - Stock exchange
- open decimal? - Open
- high decimal? - High
- low decimal? - Low
- close decimal? - Close
- volume decimal? - Volume
powertoolsdeveloper.collections: OutputString![](/images/permalink.svg)
Fields
- result string? - Result
powertoolsdeveloper.collections: OutputStringArray![](/images/permalink.svg)
Fields
- data string[]? - data
powertoolsdeveloper.collections: ProxyConfig![](/images/permalink.svg)
Proxy server configurations to be used with the HTTP client endpoint.
Fields
- host string(default "") - Host name of the proxy server
- port int(default 0) - Proxy server port
- userName string(default "") - Proxy server username
- password string(default "") - Proxy server password
Import
import ballerinax/powertoolsdeveloper.collections;
Metadata
Released date: over 1 year ago
Version: 1.5.1
License: Apache-2.0
Compatibility
Platform: any
Ballerina version: 2201.4.1
GraalVM compatible: Yes
Pull count
Total: 0
Current verison: 0
Weekly downloads
Keywords
Website & App Building/App Builders
Cost/Freemium
Contributors
Dependencies