Module saps4hana.itcm.product
ballerinax/saps4hana.itcm.product Ballerina library
Overview
This is a generated connector for SAPS4HANA Intelligent Trade Claims Management API v1.0.0 OpenAPI specification. In SAPS4HANA Intelligent Trade Claims Management, the product service allows you to access their product retailer and distributor information.
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.product: Client
This is a generated connector for SAPS4HANA Intelligent Trade Claims Management API v1.0.0 OpenAPI specification. In SAPS4HANA Intelligent Trade Claims Management, the product service allows you to access their product retailer and distributor information.
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
createProduct
function createProduct(Product payload) returns ResponseProductMessage|errorCreate a new product
Parameters
- payload Product -
Return Type
- ResponseProductMessage|error - Success Created.
deleteProduct
function deleteProduct(string externalId) returns ResponseDeleteMessage|errorDelete a product
Parameters
- externalId string - ExternalId
Return Type
- ResponseDeleteMessage|error - OK.
Records
saps4hana.itcm.product: 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.product: 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.product: 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.product: Product
Fields
- baseUnitOfMeasure string -
- brand string? -
- businessSystem int? -
- isMarkedForDeletion boolean? -
- externalId string -
- description ProductDescription[] -
- groupCode string? -
- externalHierarchyId string? -
- unitOfMeasureConversions ProductUnitOfMeasureConversion[]? -
saps4hana.itcm.product: ProductCodes
Fields
- productCode string? -
- productCodeTypeCode string? -
saps4hana.itcm.product: ProductDescription
Fields
- description string? -
- languageKey string? -
saps4hana.itcm.product: ProductUnitOfMeasureConversion
Fields
- quantityDenominator int? -
- quantityNumerator int? -
- productCodes ProductCodes[] -
- measurementUnit string? -
saps4hana.itcm.product: 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.product: ResponseDeleteMessage
Fields
- message string? -
- timestamp string? -
saps4hana.itcm.product: ResponseForbiddenMessage
Fields
- message string? -
- timestamp string? -
- uri string? -
saps4hana.itcm.product: ResponseMessage
Fields
- 'error string? -
- message string? -
- timestamp string? -
- uri string? -
saps4hana.itcm.product: ResponseNotFoundMessage
Fields
- message string? -
- 'error string? -
- timestamp string? -
saps4hana.itcm.product: ResponseProductDeleteMessage
Fields
- externalid string? -
- message string? -
- timestamp string? -
saps4hana.itcm.product: ResponseProductMessage
Fields
- externalid string? -
- message string? -
- timestamp string? -
saps4hana.itcm.product: ResponseUnauthorizedMessage
Fields
- message string? -
- timestamp string? -
- uri string? -