Module saps4hana.itcm.currency
ballerinax/saps4hana.itcm.currency Ballerina library
Overview
This is a generated connector for SAPS4HANA Intelligent Trade Claims Management API v1.0.0 OpenAPI specification. SAPS4HANA Intelligent Trade Claims Management uses currency codes and their languages to properly display monetary value and decimal or comma placement.
Prerequisites
Before using this connector in your Ballerina application, complete the following:
- Create and configure an OAuth2 client credentials by following this guide.
Clients
saps4hana.itcm.currency: Client
This is a generated connector for SAPS4HANA Intelligent Trade Claims Management API v1.0.0 OpenAPI specification. SAPS4HANA Intelligent Trade Claims Management uses currency codes and their languages to properly display monetary value and decimal or comma placement.
Constructor
Gets invoked to initialize the connector.
The connector initialization requires setting the API credentials.
Create and configure an OAuth2 client credentials by following this guide.
init (ConnectionConfig config, string serviceUrl)- config ConnectionConfig - The configurations to be used when initializing the
connector
- serviceUrl string - URL of the target service
createCurrencyCode
function createCurrencyCode(CurrencyCodeDTO payload) returns ResponseCreatedCurrencyMessage|errorCreate a new Currency
Parameters
- payload CurrencyCodeDTO -
Return Type
- ResponseCreatedCurrencyMessage|error - Success Created.
getByISOLangKey
function getByISOLangKey(string currencyCode, string languageKey) returns ResponseCurrencyMessage|errorGet a Currency based on code and language
Return Type
- ResponseCurrencyMessage|error - OK.
deleteCurrency
function deleteCurrency(string currencyCode, string languageKey) returns ResponseDeleteCurrencyMessage|errorPermanently deletes a Currency
Return Type
Records
saps4hana.itcm.currency: 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
saps4hana.itcm.currency: ConnectionConfig
Provides a set of configurations for controlling the behaviours when communicating with a remote HTTP endpoint.
Fields
- auth OAuth2ClientCredentialsGrantConfig - Configurations related to client authentication
- 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
saps4hana.itcm.currency: CurrencyCodeDTO
Fields
- currencyCode string? -
- currencyText string? -
- languageKey string? -
- numberOfDecimals int? -
- unitOfMeasureISO string? -
saps4hana.itcm.currency: CurrencyCodeResponse
Fields
- currencyCodeData CurrencyCodeResponseDTO[]? -
- message string? -
- timestamp string? -
saps4hana.itcm.currency: CurrencyCodeResponseDTO
Fields
- currencyCode string? -
- currencyText string? -
- languageKey string? -
saps4hana.itcm.currency: OAuth2ClientCredentialsGrantConfig
OAuth2 Client Credentials Grant Configs
Fields
- Fields Included from *OAuth2ClientCredentialsGrantConfig
- tokenUrl string(default "https://colgate-dev1.authentication.us30.hana.ondemand.com/oauth/token") - Token URL
saps4hana.itcm.currency: 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
saps4hana.itcm.currency: ResponseCreatedCurrencyMessage
Fields
- currencyCode string? -
- langKey string? -
- message string? -
- timestamp string? -
saps4hana.itcm.currency: ResponseCurrencyMessage
Fields
- currencyCode string? -
- langKey string? -
- message string? -
- timestamp string? -
saps4hana.itcm.currency: ResponseDeleteCurrencyMessage
Fields
- message string? -
- timestamp string? -
saps4hana.itcm.currency: ResponseForbiddenMessage
Fields
- message string? -
- timestamp string? -
- uri string? -
saps4hana.itcm.currency: ResponseNotFoundMessage
Fields
- message string? -
- 'error string? -
- timestamp string? -
saps4hana.itcm.currency: ResponseUnauthorizedMessage
Fields
- message string? -
- timestamp string? -
- uri string? -