Module saps4hana.itcm.promotion
ballerinax/saps4hana.itcm.promotion Ballerina library
1.5.2
Overview
The SAP S/4HANA Intelligent Trade Claims Management API v1.0.0 connector(https://help.sap.com/viewer/902b9d277dfe48fea582d28849d54935/CURRENT/en-US) OpenAPI specification. In SAP S/4HANA Intelligent Trade Claims Management, the promotion service allows you to create, add, and delete information about promotions. Execution of Promotions should be done in an particular order.
Key Features
- Programmatic access to create and manage resources via REST API
- Secure authentication with API key or OAuth support
- Seamless integration with REST API endpoints
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.promotion: Client
Isolated
This is a generated connector for SAPS4HANA Intelligent Trade Claims Management API v1.0.0 OpenAPI specification. In SAPS4HANA Intelligent Trade Claims Management, the promotion service allows you to create, add, and delete information about promotions. Execution of Promotions should be done in an particular order.
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
createPromotion
Isolated FunctionRemote Function
function createPromotion(ExternalPromotionDTO payload) returns ResponsePromotionCreationMessage|errorCreate a new Promotion
Parameters
- payload ExternalPromotionDTO - Request payload to create promotion
Return Type
- ResponsePromotionCreationMessage|error - Success Created.
getPromotionByExternalId
Isolated FunctionRemote Function
function getPromotionByExternalId(string externalId) returns ResponseExternalPromotionMessage|errorGet Promotion with externalId
Parameters
- externalId string - The external id of the promotion, for example
348328430
Return Type
deletePromotion
Isolated FunctionRemote Function
function deletePromotion(string externalId) returns ResponsePromotionDeletionMessage|errorDelete a Promotion with externalId
Parameters
- externalId string - The external id of the promotion, for example
348328430
Return Type
Records
saps4hana.itcm.promotion: ClientHttp1Settings
Closed record
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.promotion: ConnectionConfig
Closed record
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.promotion: ExternalCustomerHierarchyNodeKeyVDTO
Fields
- customerHierarchyNodeId string -
- customerHierarchyTypeCode string -
- hierarchyId string -
saps4hana.itcm.promotion: ExternalProductHierarchyNodeKeyVDTO
Fields
- hierarchyId string -
- productHierarchyNodeId string -
- productHierarchyTypeCode string -
saps4hana.itcm.promotion: ExternalPromotionCustomerVDTO
Fields
- customerExternalId? string -
- customerHierarchyNodeKey? ExternalCustomerHierarchyNodeKeyVDTO -
saps4hana.itcm.promotion: ExternalPromotionDTO
Fields
- businessSystem int -
- description? string -
- documentReferences? ExternalPromotionReferenceDTO[] -
- externalId string -
- externalSalesArea? ExternalSalesAreaVDTO -
- id? int -
- internalId? string -
- isMarkedForDeletion? boolean -
- promotionCustomer ExternalPromotionCustomerVDTO -
- promotionDates PromotionDateDTO[] -
- promotionProducts ExternalPromotionProductDTO[] -
- status? string -
- types? PromotionTypeCodeV[] -
saps4hana.itcm.promotion: ExternalPromotionProductDTO
Fields
- productExternalId string -
- productHierarchyNodeKey ExternalProductHierarchyNodeKeyVDTO -
saps4hana.itcm.promotion: ExternalPromotionReferenceDTO
Fields
- documentId? string -
- documentType? string -
saps4hana.itcm.promotion: ExternalSalesAreaVDTO
Fields
- distributionChannel? string -
- salesDivision? string -
- salesOrganization? string -
saps4hana.itcm.promotion: OAuth2ClientCredentialsGrantConfig
Closed record
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.promotion: PromotionDateDTO
Fields
- promotionDateTypeCode string -
- validFrom string -
- validTo string -
saps4hana.itcm.promotion: PromotionTypeCodeV
Fields
- promotionTypeCode? string -
saps4hana.itcm.promotion: ProxyConfig
Closed record
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.promotion: ResponseExternalPromotionListMessage
Fields
- message? string -
- promotions? ExternalPromotionDTO[] -
- timestamp? string -
saps4hana.itcm.promotion: ResponseExternalPromotionMessage
Fields
- externalId? string -
- message? string -
- count? int -
- promotion? ExternalPromotionDTO -
- timestamp? string -
saps4hana.itcm.promotion: ResponseForbiddenMessage
Fields
- message? string -
- timestamp? string -
- uri? string -
saps4hana.itcm.promotion: ResponseInvalidCustomer
Fields
- message? string -
- uri? string -
- timestamp? string -
saps4hana.itcm.promotion: ResponseInvalidDate
Fields
- externalId? int -
- message? string -
- timestamp? string -
saps4hana.itcm.promotion: ResponseInvalidProduct
Fields
- message? string -
- uri? string -
- timestamp? string -
saps4hana.itcm.promotion: ResponseMessage
Fields
- message? string -
- uri? string -
- timestamp? string -
saps4hana.itcm.promotion: ResponseNotFoundMessage
Fields
- message? string -
- 'error? string -
- timestamp? string -
saps4hana.itcm.promotion: ResponseNotFoundPromotionDeletionMessage
Fields
- externalId? string -
- message? string -
- promotion? ExternalPromotionDTO -
- timestamp? string -
saps4hana.itcm.promotion: ResponseNotFoundPromotionMessage
Fields
- externalId? string -
- message? string -
- promotion? ExternalPromotionDTO -
- timestamp? string -
saps4hana.itcm.promotion: ResponsePromotionCreationMessage
Fields
- externalId? int -
- message? string -
- timestamp? string -
saps4hana.itcm.promotion: ResponsePromotionDeleteAllMessage
Fields
- count? int -
- message? string -
- timestamp? string -
saps4hana.itcm.promotion: ResponsePromotionDeletionMessage
Fields
- externalId? string -
- message? string -
- timestamp? string -
saps4hana.itcm.promotion: ResponseUnauthorizedMessage
Fields
- message? string -
- timestamp? string -
- uri? string -
Union types
saps4hana.itcm.promotion: InlineResponse400
InlineResponse400