powertoolsdeveloper.datetime
Module powertoolsdeveloper.datetime
Definitions
ballerinax/powertoolsdeveloper.datetime Ballerina library
Overview
The Apptigent PowerTools Developer API v2021.1.01 connector(https://portal.apptigent.com/node/612) 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 for date and time operations.
Key Features
- Programmatic access to create and manage resources via REST API
- Manage user accounts and profiles
- Secure authentication with API key or OAuth support
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 IDwhich will be used as theAPI Keyby 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.datetime module into the Ballerina project.
import ballerinax/powertoolsdeveloper.datetime as pd;
Step 2: Create a new connector instance
Create a datetime:ApiKeysConfig with the Client ID obtained, and initialize the connector with it.
pd:ApiKeysConfig config = { xIbmClientId: "<CLIENT_ID>" } pd: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 calculate the difference between two dates using the connector by providing the
InputDateTimeDifferencerecord with date/time values to compare.Calculate the difference between two dates
public function main() { pd:InputDateTimeDifference inputDateTimeDifference = { dateTime1: "1/1/2010 12:37:19", dateTime2: "3/15/2011 14:27:49" }; pd:OutputDateDifference|error response = baseClient->dateTimeDifference(inputDateTimeDifference); if (response is pd:OutputDateDifference) { log:printInfo(response.toString()); } else { log:printError(response.message()); } } -
Use
bal runcommand to compile and run the Ballerina program.
Clients
powertoolsdeveloper.datetime: Client
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 for date and time operations.
Constructor
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
dateTimeInfo
function dateTimeInfo(InputDateTimeInfo payload) returns OutputDateInfo|errorDateTime - Get date and time information
Parameters
- payload InputDateTimeInfo - Input date time info parameters
Return Type
- OutputDateInfo|error - OK
dateTimeDifference
function dateTimeDifference(InputDateTimeDifference payload) returns OutputDateDifference|errorDateTime - DateTime difference
Parameters
- payload InputDateTimeDifference - Input date time difference parameters
Return Type
formatDateTime
function formatDateTime(InputDateTimeFormat payload) returns OutputString|errorDateTime - Format date and time
Parameters
- payload InputDateTimeFormat - Input date time format parameters
Return Type
- OutputString|error - OK
worldTime
function worldTime(InputDateTimeConversion payload) returns OutputString|errorDateTime - Get world time
Parameters
- payload InputDateTimeConversion - Input date time conversion parameters
Return Type
- OutputString|error - OK
Records
powertoolsdeveloper.datetime: ApiKeysConfig
Provides API key configurations needed when communicating with a remote HTTP endpoint.
Fields
- xIbmClientId string - Represents API Key
X-IBM-Client-Id
powertoolsdeveloper.datetime: ClientHttp1Settings
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.datetime: ConnectionConfig
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-forwardedheader
- 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.datetime: InputCalculateMinMax
Fields
- input decimal[] - Colllection of values to calculate
- 'type string - Minimum or Maximum
powertoolsdeveloper.datetime: InputCalculateNumber
Fields
- input decimal - Numeric value to calculate
- decimals decimal - Round to number of decimal places
powertoolsdeveloper.datetime: InputCalculateNumbers
Fields
- input decimal - Numeric value
- value decimal - Addend, subtrahend, factor, divisor or radicand
- decimals decimal - Round to number of decimal places
powertoolsdeveloper.datetime: InputCalculatePower
Fields
- input decimal - Number to raise
- power decimal - Power
- decimals decimal - Round to number of decimal places
powertoolsdeveloper.datetime: InputCalculateSeries
Fields
- input decimal[] - Colllection of values to calculate
- decimals decimal - Round to number of decimal places
powertoolsdeveloper.datetime: InputCaseConversion
Fields
- input string - String containing the text to convert
- alphacase string - Case of conversion result
powertoolsdeveloper.datetime: InputCollectionConversion
Fields
- input string[] - Collection containing strings to convert
- name string - Collection name
powertoolsdeveloper.datetime: InputCollectionConversionXML
Fields
- input string[] - Collection containing strings to convert
- root string - Name of root XML node
- child string - Name of child XML node(s)
powertoolsdeveloper.datetime: InputCollectionCount
Fields
- input string[] - Collection of items to count
powertoolsdeveloper.datetime: InputCollectionFilter
Fields
- input string[] - Collection of strings to filter
- 'match string - Match type
- keywords string - Keywords (separate multiple values with commas)
powertoolsdeveloper.datetime: InputCollectionModify
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.datetime: InputCollectionReplace
Fields
- input string[] - Collection of strings
- 'match string - Match value
- replacement string - Replacement value
- ignoreCase string - Ignore case
powertoolsdeveloper.datetime: InputCollectionSearch
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.datetime: InputCollectionSearchNumeric
Fields
- input decimal[] - Collection of strings to search
- 'match decimal - Number to match
- 'type string(default "Integer") - Type of number - integer or decimal
powertoolsdeveloper.datetime: InputCollectionSort
Fields
- input string[] - Collection of strings to sort
- 'order string - Sort order
powertoolsdeveloper.datetime: InputCollectionSplit
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.datetime: InputConvertAngle
Fields
- input decimal -
- 'source string -
- target string -
powertoolsdeveloper.datetime: InputConvertArea
Fields
- input decimal -
- 'source string -
- target string -
powertoolsdeveloper.datetime: InputConvertDistance
Fields
- input decimal -
- 'source string -
- target string -
powertoolsdeveloper.datetime: InputConvertDuration
Fields
- input decimal -
- 'source string -
- target string -
powertoolsdeveloper.datetime: InputConvertEnergy
Fields
- input decimal -
- 'source string -
- target string -
powertoolsdeveloper.datetime: InputConvertPower
Fields
- input decimal -
- 'source string -
- target string -
powertoolsdeveloper.datetime: InputConvertSpeed
Fields
- input decimal -
- 'source string -
- target string -
powertoolsdeveloper.datetime: InputConvertTemperature
Fields
- input decimal -
- 'source string -
- target string -
powertoolsdeveloper.datetime: InputConvertVolume
Fields
- input decimal -
- 'source string -
- target string -
powertoolsdeveloper.datetime: InputConvertWeight
Fields
- input decimal -
- 'source string -
- target string -
powertoolsdeveloper.datetime: InputCsvConversionJSON
Fields
- input string - CSV string
- header boolean - Include header row
powertoolsdeveloper.datetime: InputCurrencyConversion
Fields
- input decimal - Amount to convert
- 'source string -
- target string -
powertoolsdeveloper.datetime: InputCurrencyFormat
Fields
- input decimal - Amount to format
- target string -
powertoolsdeveloper.datetime: InputDataQuery
Fields
- input string - XML or JSON string
- query string - XPath or JSONPath query
powertoolsdeveloper.datetime: InputDateTimeConversion
Fields
- input string - Source date and time
- 'source string -
- target string -
- format? string - Display format (defaults to 'yyyy-MM-dd HH:mm:ss')
powertoolsdeveloper.datetime: InputDateTimeDifference
Fields
- dateTime1 string - First date/time value
- dateTime2 string - Second date/time value
powertoolsdeveloper.datetime: InputDateTimeFormat
Fields
- input string - Source date and time
- culture string - Language culture
- format string - Output format
powertoolsdeveloper.datetime: InputDateTimeInfo
Fields
- input string - Source date and time
- culture string - Language culture
powertoolsdeveloper.datetime: InputGenerateHash
Fields
- input string - Hash source string
- algorithm string - Hash algorithm
powertoolsdeveloper.datetime: InputGenerateUniqueID
Fields
- uppercase string - All uppercase alpha characters
powertoolsdeveloper.datetime: InputJoinStrings
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.datetime: InputJsonConversionCSV
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.datetime: InputJsonConversionHTML
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.datetime: InputJsonConversionXML
Fields
- input string - JSON array object
- root string - Name of root node
powertoolsdeveloper.datetime: InputMarketIndex
Fields
- symbol string - Market index
- date? string - Date (yyyy-MM-dd, leave empty for last trading day)
powertoolsdeveloper.datetime: InputNumberRange
Fields
- 'start decimal - Start of range
- end decimal - End of range
powertoolsdeveloper.datetime: InputQRCode
Fields
- input string - Text value(s) (vertical bar delimited by type)
- payload string - Payload type
powertoolsdeveloper.datetime: InputRedactString
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.datetime: InputReplaceString
Fields
- 'source string - String containing the text to be replaced
- value string - Text to replace
- replacement string - Replacement text
powertoolsdeveloper.datetime: InputSplitString
Fields
- input string - Text to split
- characters string - One or more characters that will be used to split the text
powertoolsdeveloper.datetime: InputStockPrices
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.datetime: InputString
Fields
- 'source string - String variable or text value
powertoolsdeveloper.datetime: InputStringComparison
Fields
- input string - Original string
- compare string - Comparison string
- lower string - Convert strings to lowercase before comparison
- trim string - Trim strings before comparison
powertoolsdeveloper.datetime: InputStringContains
Fields
- find string - Text to match
- input string - Text to search
- lower string - Convert strings to lowercase
powertoolsdeveloper.datetime: InputStringToFile
Fields
- input string - Text string (body of file)
- extension string - File extension
- filename string - Name of file (without extension)
powertoolsdeveloper.datetime: InputTextToSpeech
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.datetime: InputTranslateString
Fields
- input string - String containing the text to be translated
- language string - Translation language
powertoolsdeveloper.datetime: InputTrimString
Fields
- 'source string - String containing the text to be trimmed
- 'type string - Type of white space to remove
powertoolsdeveloper.datetime: InputVerifyHash
Fields
- input string - Original source string
- algorithm string - Hash algorithm
- hash string - Hashed result
powertoolsdeveloper.datetime: InputXmlConversionJSON
Fields
- input string - XML string
powertoolsdeveloper.datetime: OutputBoolean
Fields
- result? boolean - Result
powertoolsdeveloper.datetime: OutputCollectionNumber
Fields
- status? boolean - Success
- item? decimal - First Value
- items? decimal[] - All Values
powertoolsdeveloper.datetime: OutputCollectionResult
Fields
- result? string[] - Modified collection result
powertoolsdeveloper.datetime: OutputCollectionString
Fields
- status? boolean - Success
- item? string - First Value
- items? string[] - All Values
powertoolsdeveloper.datetime: OutputDateDifference
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.datetime: OutputDateInfo
Fields
- DayOfYear? decimal - DayOfYear
- DayOfWeek? decimal - DayOfWeek
- WeekOfYear? decimal - WeekOfYear
- SecondsInDay? decimal - SecondsInDay
- MinutesInDay? decimal - MinutesInDay
- Ticks? decimal - Ticks
powertoolsdeveloper.datetime: OutputFileByte
Fields
- result? string - Result
powertoolsdeveloper.datetime: OutputMarketIndex
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.datetime: OutputMultiCollection
Fields
- result1? string[] - First collection result
- result2? string[] - Second collection result
powertoolsdeveloper.datetime: OutputNumber
Fields
- result? decimal - Result
powertoolsdeveloper.datetime: OutputStockPrice
Fields
- result? OutputstockpriceResult[] - Stock price information
powertoolsdeveloper.datetime: OutputstockpriceResult
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.datetime: OutputString
Fields
- result? string - Result
powertoolsdeveloper.datetime: OutputStringArray
Fields
- data? string[] - data
powertoolsdeveloper.datetime: ProxyConfig
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.datetime;Metadata
Released date: about 24 hours ago
Version: 1.5.2
License: Apache-2.0
Compatibility
Platform: any
Ballerina version: 2201.8.0
GraalVM compatible: Yes
Pull count
Total: 24
Current verison: 0
Weekly downloads
Keywords
Type/Connector
Vendor/PowerTools
Area/Developer Tools
Website & App Building/App Builders
Cost/Freemium
Contributors
Dependencies