saps4hana.itcm.customer
Module saps4hana.itcm.customer
ballerinax/saps4hana.itcm.customer 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 customer service allows you to access their customers 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.customer: 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 customer service allows you to access their customers 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 (ClientConfig clientConfig, string serviceUrl)
- clientConfig ClientConfig - The configurations to be used when initializing the
connector
- serviceUrl string - URL of the target service
createCustomer
function createCustomer(CustomerDTO payload) returns ResponseCreatedMessage|error
Create a new Customer
Parameters
- payload CustomerDTO - Request payload to create customer
Return Type
- ResponseCreatedMessage|error - Success Created.
getCustomerByExternalId
function getCustomerByExternalId(string externalid) returns CustomerDTO|error
Get the details of a Customer with externalId
Parameters
- externalid string - customer's external id
Return Type
- CustomerDTO|error - OK.
deleteCustomer
function deleteCustomer(string externalid) returns ResponseDeleteCurrencyMessage|error
Delete a Customer with externalId
Parameters
- externalid string - customer's external id
Return Type
Records
saps4hana.itcm.customer: ClientConfig
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 string(default "1.1") - The HTTP version understood by the client
- http1Settings ClientHttp1Settings(default {}) - Configurations related to HTTP/1.x protocol
- http2Settings ClientHttp2Settings(default {}) - 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
- followRedirects FollowRedirects?(default ()) - Configurations associated with Redirection
- poolConfig PoolConfiguration?(default ()) - Configurations associated with request pooling
- cache CacheConfig(default {}) - HTTP caching related configurations
- compression Compression(default http:COMPRESSION_AUTO) - Specifies the way of handling compression (
accept-encoding
) header
- circuitBreaker CircuitBreakerConfig?(default ()) - Configurations associated with the behaviour of the Circuit Breaker
- retryConfig RetryConfig?(default ()) - Configurations associated with retrying
- cookieConfig CookieConfig?(default ()) - Configurations associated with cookies
- responseLimits ResponseLimitConfigs(default {}) - Configurations associated with inbound response size limits
- secureSocket ClientSecureSocket?(default ()) - SSL/TLS-related options
saps4hana.itcm.customer: CustomerDTO
Fields
- businessSystem int? -
- customerAddress ScriptedOrganizationAddressDTO? -
- customerSalesData CustomerSalesAspectDTO[]? -
- deletionIndicator boolean? -
- externalID string? -
- externalId string? -
- fullName string? -
- name string? -
- supplierID string? -
saps4hana.itcm.customer: CustomerPartnerRoleDTO
Fields
- customerID string? -
- name string? -
- partnerCode string? -
- partnerDescription string? -
saps4hana.itcm.customer: CustomerSalesAspectDTO
Fields
- customerPartnerRole CustomerPartnerRoleDTO[]? -
- salesArea SalesAreaDTO? -
saps4hana.itcm.customer: OAuth2ClientCredentialsGrantConfig
OAuth2 Client Credintials Grant Configs
Fields
- Fields Included from *OAuth2ClientCredentialsGrantConfig
- tokenUrl string
- clientId string
- clientSecret string
- scopes string[]
- defaultTokenExpTime decimal
- clockSkew decimal
- optionalParams map<string>
- credentialBearer CredentialBearer
- clientConfig ClientConfiguration
- tokenUrl string(default "https://colgate-dev1.authentication.us30.hana.ondemand.com/oauth/token") - Token URL
saps4hana.itcm.customer: PageDTO
Fields
- content CustomerDTO[]? -
- first boolean? -
- last boolean? -
- pageNumber int? -
- pageSize int? -
- totalElements int? -
- totalPages int? -
saps4hana.itcm.customer: ResponseCreatedMessage
Fields
- id string? -
- message string? -
- timestamp string? -
saps4hana.itcm.customer: ResponseDeleteCurrencyMessage
Fields
- message string? -
- timestamp string? -
saps4hana.itcm.customer: ResponseForbiddenMessage
Fields
- message string? -
- timestamp string? -
- uri string? -
saps4hana.itcm.customer: ResponseNotFoundMessage
Fields
- message string? -
- _error string? -
- timestamp string? -
saps4hana.itcm.customer: ResponseUnauthorizedMessage
Fields
- message string? -
- timestamp string? -
- uri string? -
saps4hana.itcm.customer: SalesAreaDTO
Fields
- distributionChannelCode string? -
- salesDivision string? -
- salesOrganizationID string? -
saps4hana.itcm.customer: ScriptedOrganizationAddressDTO
Fields
- formattedOrgNameLine1 string? -
- formattedOrgNameLine2 string? -
- formattedOrgNameLine3 string? -
- formattedOrgNameLine4 string? -
Import
import ballerinax/saps4hana.itcm.customer;
Metadata
Released date: over 2 years ago
Version: 1.2.0
License: Apache-2.0
Compatibility
Platform: any
Ballerina version: 2201.0.0
GraalVM compatible: Yes
Pull count
Total: 1
Current verison: 0
Weekly downloads
Keywords
Business Management/ERP
Cost/Paid
Contributors
Dependencies