com.mulesoft.connector.netsuite.internal.citizen.operation

Class CitizenOperations

java.lang.Object

com.mulesoft.connector.netsuite.internal.citizen.operation.CitizenOperations

public class CitizenOperations
extends Object

Field Summary

Fields

Modifier and Type	Field and Description
static String	INTERNAL_ID

Constructor Summary

Constructors

Constructor and Description
CitizenOperations()

Method Summary

Modifier and Type	Method and Description
org.mule.runtime.extension.api.runtime.operation.Result<InputStream,Void>	citizenAddRecord(NetSuiteSoapConfig config, NetSuiteSoapConnection connection, String recordType, org.mule.runtime.api.metadata.TypedValue<InputStream> record) Creates a new record.
org.mule.runtime.extension.api.runtime.operation.Result<Void,Void>	citizenDeleteRecord(NetSuiteSoapConfig config, NetSuiteSoapConnection connection, String recordType, String id, String idType) Deletes a record.
org.mule.runtime.extension.api.runtime.operation.Result<InputStream,Void>	citizenGetRecord(NetSuiteSoapConfig config, NetSuiteSoapConnection connection, String recordType, String id, String idType) Used to retrieve a record by providing the unique id that identifies that record.
org.mule.runtime.extension.api.runtime.streaming.PagingProvider<NetSuiteSoapConnection,org.mule.runtime.api.metadata.TypedValue<String>>	citizenGetRecords(NetSuiteSoapConfig config, String query) The citizenGetRecords operation calls search specialist operation.
InputStream	citizenGetRecordsConditionsEntityProvider(NetSuiteSoapConfig config, NetSuiteSoapConnection connection, String recordType)
InputStream	citizenGetRecordsFieldEntityProvider(NetSuiteSoapConfig config, NetSuiteSoapConnection connection, String recordType)
void	citizenGetRecordsInputType(String queryInput)
org.mule.runtime.extension.api.runtime.operation.Result<InputStream,Void>	citizenUpdateRecord(NetSuiteSoapConfig config, NetSuiteSoapConnection connection, InputRecordKey inputRecordKey, String id, Behavior behavior, org.mule.runtime.api.metadata.TypedValue<InputStream> record) Updates an existing record.
org.mule.runtime.extension.api.runtime.operation.Result<InputStream,Void>	citizenUpsertRecord(NetSuiteSoapConfig config, NetSuiteSoapConnection connection, String recordType, String externalID, Behavior behavior, org.mule.runtime.api.metadata.TypedValue<InputStream> record) Adds a new instance or updates instance of an existing record in the NetSuite.

Methods inherited from class java.lang.Object

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

Field Detail

INTERNAL_ID

public static final String INTERNAL_ID

See Also:

Constant Field Values

Constructor Detail

CitizenOperations

public CitizenOperations()

Method Detail

citizenAddRecord

@Throws(value=NetSuiteCitizenErrorTypeProvider.class)
 @MediaType(value="application/xml")
 @DisplayName(value="Citizen Add Record")
 @Summary(value="Creates a new record in the NetSuite.")
 @OutputResolver(output=CitizenActionOutputMetadataResolver.class)
 @SampleData(value=InternalIDSampleDataProvider.class)
 @Ignore
public org.mule.runtime.extension.api.runtime.operation.Result<InputStream,Void> citizenAddRecord(@Config
                                                                                                                                                                                                                                                                                                                                                                                                                                   NetSuiteSoapConfig config,
                                                                                                                                                                                                                                                                                                                                                                                                                                   @Connection
                                                                                                                                                                                                                                                                                                                                                                                                                                   NetSuiteSoapConnection connection,
                                                                                                                                                                                                                                                                                                                                                                                                                                   @DisplayName(value="Type of Record") @MetadataKeyId(value=CitizenInputRecordMetadataResolver.class)
                                                                                                                                                                                                                                                                                                                                                                                                                                   String recordType,
                                                                                                                                                                                                                                                                                                                                                                                                                                   @TypeResolver(value=CitizenInputExtIdRecordResolver.class) @DisplayName(value="Fields Associated to the Record") @Content
                                                                                                                                                                                                                                                                                                                                                                                                                                   org.mule.runtime.api.metadata.TypedValue<InputStream> record)

Creates a new record.

Parameters:

config - The NetSuite soap config.

connection - The NetSuite soap connection.

recordType - The record type for the operation.

record - The message to complete.

Returns:

The operation response.

citizenDeleteRecord

@Throws(value=NetSuiteErrorTypeProvider.class)
 @DisplayName(value="Citizen Delete Record")
 @Summary(value="Deletes a record from the NetSuite. Not all records can be deleted. Consult NetSuite documentation.")
 @Ignore
public org.mule.runtime.extension.api.runtime.operation.Result<Void,Void> citizenDeleteRecord(@Config
                                                                                                                                                                                                                                                                                                                          NetSuiteSoapConfig config,
                                                                                                                                                                                                                                                                                                                          @Connection
                                                                                                                                                                                                                                                                                                                          NetSuiteSoapConnection connection,
                                                                                                                                                                                                                                                                                                                          @DisplayName(value="Type of Record") @OfValues(value=CitizenInputRecordMetadataResolver.class)
                                                                                                                                                                                                                                                                                                                          String recordType,
                                                                                                                                                                                                                                                                                                                          @DisplayName(value="ID Value") @Example(value="101")
                                                                                                                                                                                                                                                                                                                          String id,
                                                                                                                                                                                                                                                                                                                          @DisplayName(value="ID Type") @OfValues(value=IdTypeValueProvider.class)
                                                                                                                                                                                                                                                                                                                          String idType)

Deletes a record. Not all records can be deleted. Consult NetSuite documentation.

Parameters:

config - The NetSuite soap config.

connection - The NetSuite soap connection.

recordType - The record type for the operation.

id - The ID Value to complete.

idType - The ID Type to complete.

Returns:

The delete response.

citizenGetRecord

@Throws(value=NetSuiteErrorTypeProvider.class)
 @MediaType(value="application/xml")
 @OutputResolver(output=CitizenGetOutputRecordMetadataResolver.class)
 @DisplayName(value="Citizen Get Record")
 @Summary(value="Used to retrieve a record by providing the unique id that identifies that record.")
 @SampleData(value=RecordSampleDataProvider.class)
 @Ignore
public org.mule.runtime.extension.api.runtime.operation.Result<InputStream,Void> citizenGetRecord(@Config
                                                                                                                                                                                                                                                                                                                                                                                                                                                                       NetSuiteSoapConfig config,
                                                                                                                                                                                                                                                                                                                                                                                                                                                                       @Connection
                                                                                                                                                                                                                                                                                                                                                                                                                                                                       NetSuiteSoapConnection connection,
                                                                                                                                                                                                                                                                                                                                                                                                                                                                       @DisplayName(value="Type of Record") @MetadataKeyId(value=CitizenInputRecordMetadataResolver.class)
                                                                                                                                                                                                                                                                                                                                                                                                                                                                       String recordType,
                                                                                                                                                                                                                                                                                                                                                                                                                                                                       @DisplayName(value="ID Value") @Example(value="101")
                                                                                                                                                                                                                                                                                                                                                                                                                                                                       String id,
                                                                                                                                                                                                                                                                                                                                                                                                                                                                       @DisplayName(value="ID Type") @OfValues(value=IdTypeValueProvider.class)
                                                                                                                                                                                                                                                                                                                                                                                                                                                                       String idType)

Used to retrieve a record by providing the unique id that identifies that record.

Parameters:

config - The NetSuite soap config.

connection - The NetSuite soap connection.

recordType - The record type for the operation.

id - The ID Value to complete.

idType - The ID Type to complete.

Returns:

The get response.

citizenUpdateRecord

@Throws(value=NetSuiteCitizenErrorTypeProvider.class)
 @MediaType(value="application/xml")
 @DisplayName(value="Citizen Update Record")
 @Summary(value="Updates an existing record in the NetSuite.")
 @OutputResolver(output=CitizenUpdateOutputMetadataResolver.class)
 @SampleData(value=InternalIDSampleDataProvider.class)
 @Ignore
public org.mule.runtime.extension.api.runtime.operation.Result<InputStream,Void> citizenUpdateRecord(@Config
                                                                                                                                                                                                                                                                                                                                                                                                                                               NetSuiteSoapConfig config,
                                                                                                                                                                                                                                                                                                                                                                                                                                               @Connection
                                                                                                                                                                                                                                                                                                                                                                                                                                               NetSuiteSoapConnection connection,
                                                                                                                                                                                                                                                                                                                                                                                                                                               @MetadataKeyId(value=CitizenInputKeysMetadataResolver.class) @ParameterGroup(name="Input Record Key")
                                                                                                                                                                                                                                                                                                                                                                                                                                               InputRecordKey inputRecordKey,
                                                                                                                                                                                                                                                                                                                                                                                                                                               @DisplayName(value="ID Value") @Example(value="101")
                                                                                                                                                                                                                                                                                                                                                                                                                                               String id,
                                                                                                                                                                                                                                                                                                                                                                                                                                               @ParameterGroup(name="Behavior modifiers")
                                                                                                                                                                                                                                                                                                                                                                                                                                               Behavior behavior,
                                                                                                                                                                                                                                                                                                                                                                                                                                               @TypeResolver(value=CitizenInputKeysMetadataResolver.class) @DisplayName(value="Fields to update") @Content
                                                                                                                                                                                                                                                                                                                                                                                                                                               org.mule.runtime.api.metadata.TypedValue<InputStream> record)

Updates an existing record.

Parameters:

config - The NetSuite soap config.

connection - The NetSuite soap connection.

inputRecordKey - The record type and ID Type to complete.

id - The ID Value to complete.

behavior - Object to change the default operation behaviour

record - The message to complete.

Returns:

The update response.

citizenUpsertRecord

@Throws(value=NetSuiteCitizenErrorTypeProvider.class)
 @MediaType(value="application/xml")
 @DisplayName(value="Citizen Upsert Record")
 @Summary(value="Adds a new instance or updates instance of an existing record in the NetSuite.")
 @OutputResolver(output=CitizenActionOutputMetadataResolver.class)
 @SampleData(value=InternalIDSampleDataProvider.class)
 @Ignore
public org.mule.runtime.extension.api.runtime.operation.Result<InputStream,Void> citizenUpsertRecord(@Config
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  NetSuiteSoapConfig config,
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  @Connection
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  NetSuiteSoapConnection connection,
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  @DisplayName(value="Type of Record") @MetadataKeyId(value=CitizenInputRecordMetadataResolver.class)
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  String recordType,
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  @DisplayName(value="Record External ID") @Example(value="101")
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  String externalID,
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  @ParameterGroup(name="Behavior modifiers")
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  Behavior behavior,
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  @DisplayName(value="Fields to update") @TypeResolver(value=CitizenInputRecordMetadataResolver.class) @Content
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  org.mule.runtime.api.metadata.TypedValue<InputStream> record)

Adds a new instance or updates instance of an existing record in the NetSuite. The upsert operation is similar to both the add and update operations, but upsert can be run without first determining whether a record exists in NetSuite. A record is identified by its external ID and its record type. If a record of the specified type with a matching external ID exists in the system, it is updated. If it does not exist, a new record is created. Because external ID is mandatory for this operation, upsert is supported only for records that support the external ID field. Also, this operation prohibits the passing of internal ID values.

Parameters:

config - The NetSuite soap config.

connection - The NetSuite soap connection.

recordType - The record type for the operation.

externalID - The External ID Value to complete.

behavior - Object to change the default operation behaviour

record - The message to complete.

Returns:

The get response.

citizenGetRecords

@Throws(value=NetSuiteCitizenErrorTypeProvider.class)
 @DisplayName(value="Citizen Get Records")
 @Summary(value="Gets records based on the type and filters.")
 @OutputResolver(output=CitizenGetRecordsOutputTypeMetadataResolver.class)
 @SampleData(value=GetRecordsSampleDataProvider.class)
 @Ignore
public org.mule.runtime.extension.api.runtime.streaming.PagingProvider<NetSuiteSoapConnection,org.mule.runtime.api.metadata.TypedValue<String>> citizenGetRecords(@Config
                                                                                                                                                                                                                                                                                                                                                                                                                                                                             NetSuiteSoapConfig config,
                                                                                                                                                                                                                                                                                                                                                                                                                                                                             @MetadataKeyId @Content
                                                                                                                                                                                                                                                                                                                                                                                                                                                                             String query)

The citizenGetRecords operation calls search specialist operation. Operation returns paginated records filtered by input query

Parameters:

config - The NetSuite soap config.

query - The search query contains objectType, fields, limit, conditions.

Returns:

The search response.

citizenGetRecordsInputType

@Ignore
public void citizenGetRecordsInputType(String queryInput)

citizenGetRecordsFieldEntityProvider

@Throws(value=NetSuiteCitizenErrorTypeProvider.class)
 @MediaType(value="application/xml")
 @OutputResolver(output=GetRecordsFieldListEntityProvider.class)
 @Ignore
public InputStream citizenGetRecordsFieldEntityProvider(@Config
                                                                                                                                                                                                                             NetSuiteSoapConfig config,
                                                                                                                                                                                                                             @Connection
                                                                                                                                                                                                                             NetSuiteSoapConnection connection,
                                                                                                                                                                                                                             @MetadataKeyId(value=GetRecordsFieldListEntityProvider.class)
                                                                                                                                                                                                                             String recordType)

citizenGetRecordsConditionsEntityProvider

@Throws(value=NetSuiteCitizenErrorTypeProvider.class)
 @MediaType(value="application/xml")
 @OutputResolver(output=GetRecordsConditionListEntityProvider.class)
 @Ignore
public InputStream citizenGetRecordsConditionsEntityProvider(@Config
                                                                                                                                                                                                                                      NetSuiteSoapConfig config,
                                                                                                                                                                                                                                      @Connection
                                                                                                                                                                                                                                      NetSuiteSoapConnection connection,
                                                                                                                                                                                                                                      @MetadataKeyId(value=GetRecordsConditionListEntityProvider.class)
                                                                                                                                                                                                                                      String recordType)