org.openapitools.client.api

Class ProfileMappingApi

java.lang.Object

org.openapitools.client.api.ProfileMappingApi

@Generated(value="org.openapitools.codegen.languages.JavaClientCodegen",
           date="2023-01-18T04:14:02.238-06:00[America/Chicago]")
 @Component(value="org.openapitools.client.api.ProfileMappingApi")
public class ProfileMappingApi
extends Object

Constructor Summary

Constructors

Constructor and Description
ProfileMappingApi()
ProfileMappingApi(ApiClient apiClient)

Method Summary

Modifier and Type	Method and Description
ApiClient	getApiClient()
ProfileMapping	getProfileMapping(String mappingId) Retrieve a Profile Mapping Retrieves a single Profile Mapping referenced by its ID
PagedList	getProfileMappingWithPaginationInfo(String mappingId) Retrieve a Profile Mapping Retrieves a single Profile Mapping referenced by its ID
List<ProfileMapping>	listProfileMappings(String after, Integer limit, String sourceId, String targetId) List all Profile Mappings Lists all profile mappings with pagination
PagedList	listProfileMappingsWithPaginationInfo(String after, Integer limit, String sourceId, String targetId) List all Profile Mappings Lists all profile mappings with pagination
void	setApiClient(ApiClient apiClient)
<T> T	updateProfileMapping(Class<?> T, String mappingId, ProfileMapping profileMapping) Update a Profile Mapping Updates an existing Profile Mapping by adding, updating, or removing one or many Property Mappings
ProfileMapping	updateProfileMapping(String mappingId, ProfileMapping profileMapping) Update a Profile Mapping Updates an existing Profile Mapping by adding, updating, or removing one or many Property Mappings
PagedList	updateProfileMappingWithPaginationInfo(String mappingId, ProfileMapping profileMapping) Update a Profile Mapping Updates an existing Profile Mapping by adding, updating, or removing one or many Property Mappings

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

ProfileMappingApi

public ProfileMappingApi()

ProfileMappingApi

@Autowired
public ProfileMappingApi(ApiClient apiClient)

Method Detail

getApiClient

public ApiClient getApiClient()

setApiClient

public void setApiClient(ApiClient apiClient)

getProfileMapping

public ProfileMapping getProfileMapping(String mappingId)
                                 throws org.springframework.web.client.RestClientException

Retrieve a Profile Mapping Retrieves a single Profile Mapping referenced by its ID

200 - Success

403 - Forbidden

404 - Not Found

429 - Too Many Requests

Parameters:

mappingId - (required)

Returns:

ProfileMapping

Throws:

org.springframework.web.client.RestClientException - if an error occurs while attempting to invoke the API

getProfileMappingWithPaginationInfo

public PagedList getProfileMappingWithPaginationInfo(String mappingId)
                                              throws org.springframework.web.client.RestClientException

Retrieve a Profile Mapping Retrieves a single Profile Mapping referenced by its ID

200 - Success

403 - Forbidden

404 - Not Found

429 - Too Many Requests

Parameters:

mappingId - (required)

Returns:

ResponseEntity<ProfileMapping>

Throws:

org.springframework.web.client.RestClientException - if an error occurs while attempting to invoke the API

listProfileMappings

public List<ProfileMapping> listProfileMappings(String after,
                                                Integer limit,
                                                String sourceId,
                                                String targetId)
                                         throws org.springframework.web.client.RestClientException

List all Profile Mappings Lists all profile mappings with pagination

200 - Success

403 - Forbidden

429 - Too Many Requests

Parameters:

after - (optional)

limit - (optional, default to -1)

sourceId - (optional)

targetId - (optional, default to )

Returns:

List<ProfileMapping>

Throws:

org.springframework.web.client.RestClientException - if an error occurs while attempting to invoke the API

listProfileMappingsWithPaginationInfo

public PagedList listProfileMappingsWithPaginationInfo(String after,
                                                       Integer limit,
                                                       String sourceId,
                                                       String targetId)
                                                throws org.springframework.web.client.RestClientException

List all Profile Mappings Lists all profile mappings with pagination

200 - Success

403 - Forbidden

429 - Too Many Requests

Parameters:

after - (optional)

limit - (optional, default to -1)

sourceId - (optional)

targetId - (optional, default to )

Returns:

ResponseEntity<List<ProfileMapping>>

Throws:

org.springframework.web.client.RestClientException - if an error occurs while attempting to invoke the API

updateProfileMapping

public ProfileMapping updateProfileMapping(String mappingId,
                                           ProfileMapping profileMapping)
                                    throws org.springframework.web.client.RestClientException

Update a Profile Mapping Updates an existing Profile Mapping by adding, updating, or removing one or many Property Mappings

200 - Success

400 - Bad Request

403 - Forbidden

404 - Not Found

429 - Too Many Requests

Parameters:

mappingId - (required)

profileMapping - (required)

Returns:

ProfileMapping

Throws:

org.springframework.web.client.RestClientException - if an error occurs while attempting to invoke the API

updateProfileMapping

public <T> T updateProfileMapping(Class<?> T,
                                  String mappingId,
                                  ProfileMapping profileMapping)
                           throws org.springframework.web.client.RestClientException

Update a Profile Mapping Updates an existing Profile Mapping by adding, updating, or removing one or many Property Mappings

200 - Success

400 - Bad Request

403 - Forbidden

404 - Not Found

429 - Too Many Requests

Parameters:

T - (required) - the assignable return type

mappingId - (required)

profileMapping - (required)

Returns:

T instance

Throws:

org.springframework.web.client.RestClientException - if an error occurs while attempting to invoke the API

updateProfileMappingWithPaginationInfo

public PagedList updateProfileMappingWithPaginationInfo(String mappingId,
                                                        ProfileMapping profileMapping)
                                                 throws org.springframework.web.client.RestClientException

Update a Profile Mapping Updates an existing Profile Mapping by adding, updating, or removing one or many Property Mappings

200 - Success

400 - Bad Request

403 - Forbidden

404 - Not Found

429 - Too Many Requests

Parameters:

mappingId - (required)

profileMapping - (required)

Returns:

ResponseEntity<ProfileMapping>

Throws:

org.springframework.web.client.RestClientException - if an error occurs while attempting to invoke the API