Marketing

Overview

Available Operations

listEmailTemplates - List Email Templates
createEmailTemplate - Create Email Templates
getEmailTemplate - Get Email Templates
updateEmailTemplate - Update Email Templates
listInAppTemplates - List In-App Templates
createInAppTemplate - Create In-App Template
getInAppTemplate - Get In-App Template
updateInAppTemplate - Update In-App Template
listSmsTemplates - List SMS Templates
createSmsTemplate - Create SMS Template
getSmsTemplate - Get SMS Template
updateSmsTemplate - Update SMS Template
~~listOmniChannelTemplates~~ - List Omni-Channel Templates ⚠️ Deprecated
~~createOmniChannelTemplate~~ - Create Omni-Channel Template ⚠️ Deprecated
~~getOmniChannelTemplate~~ - Get Omni-Channel Template ⚠️ Deprecated
~~updateOmniChannelTemplate~~ - Update Omni-Channel Template ⚠️ Deprecated
listPushTemplates - List Push Templates
createPushTemplate - Create Push Template
getPushTemplate - Get Push Template
updatePushTemplate - Update Push Template
listCampaigns - List campaigns
getCampaign - Get campaign
listContentBlocks - List Content Blocks
createContentBlock - Create Content Block
getContentBlock - Get Content Blocks
updateContentBlock - Update Content Block

listEmailTemplates

List Email Templates

Example Usage

package hello.world;

import com.stackone.stackone_client_java.StackOne;
import com.stackone.stackone_client_java.models.components.Security;
import com.stackone.stackone_client_java.models.errors.*;
import com.stackone.stackone_client_java.models.operations.*;
import java.lang.Exception;
import java.time.OffsetDateTime;

public class Application {

    public static void main(String[] args) throws Exception {

        StackOne sdk = StackOne.builder()
                .security(Security.builder()
                    .username("")
                    .password("")
                    .build())
            .build();

        MarketingListEmailTemplatesRequest req = MarketingListEmailTemplatesRequest.builder()
                .xAccountId("<id>")
                .fields("id,remote_id,name,messages,created_at,updated_at,tags,unified_custom_fields")
                .filter(MarketingListEmailTemplatesQueryParamFilter.builder()
                    .updatedAfter(OffsetDateTime.parse("2020-01-01T00:00:00.000Z"))
                    .build())
                .prefer("heartbeat")
                .build();


        sdk.marketing().listEmailTemplates()
                .callAsStream()
                .forEach((MarketingListEmailTemplatesResponse item) -> {
                   // handle page
                });

    }
}

Parameters

Parameter	Type	Required	Description
`request`	MarketingListEmailTemplatesRequest	✔️	The request object to use for the request.

Response

MarketingListEmailTemplatesResponse

Errors

Error Type	Status Code	Content Type
models/errors/BadRequestResponse	400	application/json
models/errors/UnauthorizedResponse	401	application/json
models/errors/ForbiddenResponse	403	application/json
models/errors/NotFoundResponse	404	application/json
models/errors/RequestTimedOutResponse	408	application/json
models/errors/ConflictResponse	409	application/json
models/errors/PreconditionFailedResponse	412	application/json
models/errors/UnprocessableEntityResponse	422	application/json
models/errors/TooManyRequestsResponse	429	application/json
models/errors/InternalServerErrorResponse	500	application/json
models/errors/NotImplementedResponse	501	application/json
models/errors/BadGatewayResponse	502	application/json
models/errors/SDKError	4XX, 5XX	/

createEmailTemplate

Create Email Templates

Example Usage

package hello.world;

import com.stackone.stackone_client_java.StackOne;
import com.stackone.stackone_client_java.models.components.*;
import com.stackone.stackone_client_java.models.errors.*;
import com.stackone.stackone_client_java.models.operations.MarketingCreateEmailTemplateResponse;
import java.lang.Exception;
import java.util.List;
import java.util.Map;
import org.openapitools.jackson.nullable.JsonNullable;

public class Application {

    public static void main(String[] args) throws Exception {

        StackOne sdk = StackOne.builder()
                .security(Security.builder()
                    .username("")
                    .password("")
                    .build())
            .build();

        MarketingCreateEmailTemplateResponse res = sdk.marketing().createEmailTemplate()
                .xAccountId("<id>")
                .prefer("heartbeat")
                .marketingCreateEmailTemplateRequestDto(MarketingCreateEmailTemplateRequestDto.builder()
                    .messages(List.of(
                        EmailMessages.builder()
                            .id("8187e5da-dc77-475e-9949-af0f1fa4e4e3")
                            .remoteId("8187e5da-dc77-475e-9949-af0f1fa4e4e3")
                            .messageType(JsonNullable.of(null))
                            .build()))
                    .passthrough(Map.ofEntries(
                        Map.entry("other_known_names", "John Doe")))
                    .build())
                .call();

        if (res.createResult().isPresent()) {
            // handle response
        }
    }
}

Parameters

Parameter	Type	Required	Description	Example
`xAccountId`	String	✔️	The account identifier
`prefer`	Optional<String>	➖	Set to "heartbeat" to enable keep-alive newline heartbeats during long-running requests. Response includes Preference-Applied: heartbeat header when honored. (RFC 7240)	heartbeat
`marketingCreateEmailTemplateRequestDto`	MarketingCreateEmailTemplateRequestDto	✔️	N/A

Response

MarketingCreateEmailTemplateResponse

Errors

Error Type	Status Code	Content Type
models/errors/BadRequestResponse	400	application/json
models/errors/UnauthorizedResponse	401	application/json
models/errors/ForbiddenResponse	403	application/json
models/errors/NotFoundResponse	404	application/json
models/errors/RequestTimedOutResponse	408	application/json
models/errors/ConflictResponse	409	application/json
models/errors/PreconditionFailedResponse	412	application/json
models/errors/UnprocessableEntityResponse	422	application/json
models/errors/TooManyRequestsResponse	429	application/json
models/errors/InternalServerErrorResponse	500	application/json
models/errors/NotImplementedResponse	501	application/json
models/errors/BadGatewayResponse	502	application/json
models/errors/SDKError	4XX, 5XX	/

getEmailTemplate

Get Email Templates

Example Usage

package hello.world;

import com.stackone.stackone_client_java.StackOne;
import com.stackone.stackone_client_java.models.components.Security;
import com.stackone.stackone_client_java.models.errors.*;
import com.stackone.stackone_client_java.models.operations.MarketingGetEmailTemplateRequest;
import com.stackone.stackone_client_java.models.operations.MarketingGetEmailTemplateResponse;
import java.lang.Exception;

public class Application {

    public static void main(String[] args) throws Exception {

        StackOne sdk = StackOne.builder()
                .security(Security.builder()
                    .username("")
                    .password("")
                    .build())
            .build();

        MarketingGetEmailTemplateRequest req = MarketingGetEmailTemplateRequest.builder()
                .xAccountId("<id>")
                .id("<id>")
                .fields("id,remote_id,name,messages,created_at,updated_at,tags,unified_custom_fields")
                .prefer("heartbeat")
                .build();

        MarketingGetEmailTemplateResponse res = sdk.marketing().getEmailTemplate()
                .request(req)
                .call();

        if (res.emailTemplateResult().isPresent()) {
            // handle response
        }
    }
}

Parameters

Parameter	Type	Required	Description
`request`	MarketingGetEmailTemplateRequest	✔️	The request object to use for the request.

Response

MarketingGetEmailTemplateResponse

Errors

Error Type	Status Code	Content Type
models/errors/BadRequestResponse	400	application/json
models/errors/UnauthorizedResponse	401	application/json
models/errors/ForbiddenResponse	403	application/json
models/errors/NotFoundResponse	404	application/json
models/errors/RequestTimedOutResponse	408	application/json
models/errors/ConflictResponse	409	application/json
models/errors/PreconditionFailedResponse	412	application/json
models/errors/UnprocessableEntityResponse	422	application/json
models/errors/TooManyRequestsResponse	429	application/json
models/errors/InternalServerErrorResponse	500	application/json
models/errors/NotImplementedResponse	501	application/json
models/errors/BadGatewayResponse	502	application/json
models/errors/SDKError	4XX, 5XX	/

updateEmailTemplate

Update Email Templates

Example Usage

package hello.world;

import com.stackone.stackone_client_java.StackOne;
import com.stackone.stackone_client_java.models.components.*;
import com.stackone.stackone_client_java.models.errors.*;
import com.stackone.stackone_client_java.models.operations.MarketingUpdateEmailTemplateResponse;
import java.lang.Exception;
import java.util.List;
import java.util.Map;

public class Application {

    public static void main(String[] args) throws Exception {

        StackOne sdk = StackOne.builder()
                .security(Security.builder()
                    .username("")
                    .password("")
                    .build())
            .build();

        MarketingUpdateEmailTemplateResponse res = sdk.marketing().updateEmailTemplate()
                .xAccountId("<id>")
                .id("<id>")
                .prefer("heartbeat")
                .marketingCreateEmailTemplateRequestDto(MarketingCreateEmailTemplateRequestDto.builder()
                    .messages(List.of(
                        EmailMessages.builder()
                            .id("8187e5da-dc77-475e-9949-af0f1fa4e4e3")
                            .remoteId("8187e5da-dc77-475e-9949-af0f1fa4e4e3")
                            .messageType(MessageType.builder()
                                .value(EmailMessagesValue.EMAIL)
                                .sourceValue(EmailMessagesSourceValue.of("Email"))
                                .build())
                            .build()))
                    .passthrough(Map.ofEntries(
                        Map.entry("other_known_names", "John Doe")))
                    .build())
                .call();

        if (res.createResult().isPresent()) {
            // handle response
        }
    }
}

Parameters

Parameter	Type	Required	Description	Example
`xAccountId`	String	✔️	The account identifier
`id`	String	✔️	N/A
`prefer`	Optional<String>	➖	Set to "heartbeat" to enable keep-alive newline heartbeats during long-running requests. Response includes Preference-Applied: heartbeat header when honored. (RFC 7240)	heartbeat
`marketingCreateEmailTemplateRequestDto`	MarketingCreateEmailTemplateRequestDto	✔️	N/A

Response

MarketingUpdateEmailTemplateResponse

Errors

Error Type	Status Code	Content Type
models/errors/BadRequestResponse	400	application/json
models/errors/UnauthorizedResponse	401	application/json
models/errors/ForbiddenResponse	403	application/json
models/errors/NotFoundResponse	404	application/json
models/errors/RequestTimedOutResponse	408	application/json
models/errors/ConflictResponse	409	application/json
models/errors/PreconditionFailedResponse	412	application/json
models/errors/UnprocessableEntityResponse	422	application/json
models/errors/TooManyRequestsResponse	429	application/json
models/errors/InternalServerErrorResponse	500	application/json
models/errors/NotImplementedResponse	501	application/json
models/errors/BadGatewayResponse	502	application/json
models/errors/SDKError	4XX, 5XX	/

listInAppTemplates

List In-App Templates

Example Usage

package hello.world;

import com.stackone.stackone_client_java.StackOne;
import com.stackone.stackone_client_java.models.components.Security;
import com.stackone.stackone_client_java.models.errors.*;
import com.stackone.stackone_client_java.models.operations.MarketingListInAppTemplatesRequest;
import com.stackone.stackone_client_java.models.operations.MarketingListInAppTemplatesResponse;
import java.lang.Exception;
import org.openapitools.jackson.nullable.JsonNullable;

public class Application {

    public static void main(String[] args) throws Exception {

        StackOne sdk = StackOne.builder()
                .security(Security.builder()
                    .username("")
                    .password("")
                    .build())
            .build();

        MarketingListInAppTemplatesRequest req = MarketingListInAppTemplatesRequest.builder()
                .xAccountId("<id>")
                .fields("id,remote_id,name,messages,created_at,updated_at,tags,unified_custom_fields")
                .filter(JsonNullable.of(null))
                .prefer("heartbeat")
                .build();


        sdk.marketing().listInAppTemplates()
                .callAsStream()
                .forEach((MarketingListInAppTemplatesResponse item) -> {
                   // handle page
                });

    }
}

Parameters

Parameter	Type	Required	Description
`request`	MarketingListInAppTemplatesRequest	✔️	The request object to use for the request.

Response

MarketingListInAppTemplatesResponse

Errors

Error Type	Status Code	Content Type
models/errors/BadRequestResponse	400	application/json
models/errors/UnauthorizedResponse	401	application/json
models/errors/ForbiddenResponse	403	application/json
models/errors/NotFoundResponse	404	application/json
models/errors/RequestTimedOutResponse	408	application/json
models/errors/ConflictResponse	409	application/json
models/errors/PreconditionFailedResponse	412	application/json
models/errors/UnprocessableEntityResponse	422	application/json
models/errors/TooManyRequestsResponse	429	application/json
models/errors/InternalServerErrorResponse	500	application/json
models/errors/NotImplementedResponse	501	application/json
models/errors/BadGatewayResponse	502	application/json
models/errors/SDKError	4XX, 5XX	/

createInAppTemplate

Create In-App Template

Example Usage

package hello.world;

import com.stackone.stackone_client_java.StackOne;
import com.stackone.stackone_client_java.models.components.*;
import com.stackone.stackone_client_java.models.errors.*;
import com.stackone.stackone_client_java.models.operations.MarketingCreateInAppTemplateResponse;
import java.lang.Exception;
import java.util.List;
import java.util.Map;

public class Application {

    public static void main(String[] args) throws Exception {

        StackOne sdk = StackOne.builder()
                .security(Security.builder()
                    .username("")
                    .password("")
                    .build())
            .build();

        MarketingCreateInAppTemplateResponse res = sdk.marketing().createInAppTemplate()
                .xAccountId("<id>")
                .prefer("heartbeat")
                .marketingCreateInAppTemplateRequestDto(MarketingCreateInAppTemplateRequestDto.builder()
                    .messages(List.of(
                        InAppMessages.builder()
                            .id("8187e5da-dc77-475e-9949-af0f1fa4e4e3")
                            .remoteId("8187e5da-dc77-475e-9949-af0f1fa4e4e3")
                            .messageType(InAppMessagesMessageType.builder()
                                .value(InAppMessagesValue.EMAIL)
                                .sourceValue(InAppMessagesSourceValue.of("Email"))
                                .build())
                            .build()))
                    .passthrough(Map.ofEntries(
                        Map.entry("other_known_names", "John Doe")))
                    .build())
                .call();

        if (res.createResult().isPresent()) {
            // handle response
        }
    }
}

Parameters

Parameter	Type	Required	Description	Example
`xAccountId`	String	✔️	The account identifier
`prefer`	Optional<String>	➖	Set to "heartbeat" to enable keep-alive newline heartbeats during long-running requests. Response includes Preference-Applied: heartbeat header when honored. (RFC 7240)	heartbeat
`marketingCreateInAppTemplateRequestDto`	MarketingCreateInAppTemplateRequestDto	✔️	N/A

Response

MarketingCreateInAppTemplateResponse

Errors

Error Type	Status Code	Content Type
models/errors/BadRequestResponse	400	application/json
models/errors/UnauthorizedResponse	401	application/json
models/errors/ForbiddenResponse	403	application/json
models/errors/NotFoundResponse	404	application/json
models/errors/RequestTimedOutResponse	408	application/json
models/errors/ConflictResponse	409	application/json
models/errors/PreconditionFailedResponse	412	application/json
models/errors/UnprocessableEntityResponse	422	application/json
models/errors/TooManyRequestsResponse	429	application/json
models/errors/InternalServerErrorResponse	500	application/json
models/errors/NotImplementedResponse	501	application/json
models/errors/BadGatewayResponse	502	application/json
models/errors/SDKError	4XX, 5XX	/

getInAppTemplate

Get In-App Template

Example Usage

package hello.world;

import com.stackone.stackone_client_java.StackOne;
import com.stackone.stackone_client_java.models.components.Security;
import com.stackone.stackone_client_java.models.errors.*;
import com.stackone.stackone_client_java.models.operations.MarketingGetInAppTemplateRequest;
import com.stackone.stackone_client_java.models.operations.MarketingGetInAppTemplateResponse;
import java.lang.Exception;

public class Application {

    public static void main(String[] args) throws Exception {

        StackOne sdk = StackOne.builder()
                .security(Security.builder()
                    .username("")
                    .password("")
                    .build())
            .build();

        MarketingGetInAppTemplateRequest req = MarketingGetInAppTemplateRequest.builder()
                .xAccountId("<id>")
                .id("<id>")
                .fields("id,remote_id,name,messages,created_at,updated_at,tags,unified_custom_fields")
                .prefer("heartbeat")
                .build();

        MarketingGetInAppTemplateResponse res = sdk.marketing().getInAppTemplate()
                .request(req)
                .call();

        if (res.inAppTemplateResult().isPresent()) {
            // handle response
        }
    }
}

Parameters

Parameter	Type	Required	Description
`request`	MarketingGetInAppTemplateRequest	✔️	The request object to use for the request.

Response

MarketingGetInAppTemplateResponse

Errors

Error Type	Status Code	Content Type
models/errors/BadRequestResponse	400	application/json
models/errors/UnauthorizedResponse	401	application/json
models/errors/ForbiddenResponse	403	application/json
models/errors/NotFoundResponse	404	application/json
models/errors/RequestTimedOutResponse	408	application/json
models/errors/ConflictResponse	409	application/json
models/errors/PreconditionFailedResponse	412	application/json
models/errors/UnprocessableEntityResponse	422	application/json
models/errors/TooManyRequestsResponse	429	application/json
models/errors/InternalServerErrorResponse	500	application/json
models/errors/NotImplementedResponse	501	application/json
models/errors/BadGatewayResponse	502	application/json
models/errors/SDKError	4XX, 5XX	/

updateInAppTemplate

Update In-App Template

Example Usage

package hello.world;

import com.stackone.stackone_client_java.StackOne;
import com.stackone.stackone_client_java.models.components.*;
import com.stackone.stackone_client_java.models.errors.*;
import com.stackone.stackone_client_java.models.operations.MarketingUpdateInAppTemplateResponse;
import java.lang.Exception;
import java.util.List;
import java.util.Map;

public class Application {

    public static void main(String[] args) throws Exception {

        StackOne sdk = StackOne.builder()
                .security(Security.builder()
                    .username("")
                    .password("")
                    .build())
            .build();

        MarketingUpdateInAppTemplateResponse res = sdk.marketing().updateInAppTemplate()
                .xAccountId("<id>")
                .id("<id>")
                .prefer("heartbeat")
                .marketingCreateInAppTemplateRequestDto(MarketingCreateInAppTemplateRequestDto.builder()
                    .messages(List.of(
                        InAppMessages.builder()
                            .id("8187e5da-dc77-475e-9949-af0f1fa4e4e3")
                            .remoteId("8187e5da-dc77-475e-9949-af0f1fa4e4e3")
                            .messageType(InAppMessagesMessageType.builder()
                                .value(InAppMessagesValue.EMAIL)
                                .sourceValue(InAppMessagesSourceValue.of("Email"))
                                .build())
                            .build()))
                    .passthrough(Map.ofEntries(
                        Map.entry("other_known_names", "John Doe")))
                    .build())
                .call();

        if (res.createResult().isPresent()) {
            // handle response
        }
    }
}

Parameters

Parameter	Type	Required	Description	Example
`xAccountId`	String	✔️	The account identifier
`id`	String	✔️	N/A
`prefer`	Optional<String>	➖	Set to "heartbeat" to enable keep-alive newline heartbeats during long-running requests. Response includes Preference-Applied: heartbeat header when honored. (RFC 7240)	heartbeat
`marketingCreateInAppTemplateRequestDto`	MarketingCreateInAppTemplateRequestDto	✔️	N/A

Response

MarketingUpdateInAppTemplateResponse

Errors

Error Type	Status Code	Content Type
models/errors/BadRequestResponse	400	application/json
models/errors/UnauthorizedResponse	401	application/json
models/errors/ForbiddenResponse	403	application/json
models/errors/NotFoundResponse	404	application/json
models/errors/RequestTimedOutResponse	408	application/json
models/errors/ConflictResponse	409	application/json
models/errors/PreconditionFailedResponse	412	application/json
models/errors/UnprocessableEntityResponse	422	application/json
models/errors/TooManyRequestsResponse	429	application/json
models/errors/InternalServerErrorResponse	500	application/json
models/errors/NotImplementedResponse	501	application/json
models/errors/BadGatewayResponse	502	application/json
models/errors/SDKError	4XX, 5XX	/

listSmsTemplates

List SMS Templates

Example Usage

package hello.world;

import com.stackone.stackone_client_java.StackOne;
import com.stackone.stackone_client_java.models.components.Security;
import com.stackone.stackone_client_java.models.errors.*;
import com.stackone.stackone_client_java.models.operations.*;
import java.lang.Exception;
import java.time.OffsetDateTime;

public class Application {

    public static void main(String[] args) throws Exception {

        StackOne sdk = StackOne.builder()
                .security(Security.builder()
                    .username("")
                    .password("")
                    .build())
            .build();

        MarketingListSmsTemplatesRequest req = MarketingListSmsTemplatesRequest.builder()
                .xAccountId("<id>")
                .fields("id,remote_id,name,messages,created_at,updated_at,tags,unified_custom_fields")
                .filter(MarketingListSmsTemplatesQueryParamFilter.builder()
                    .updatedAfter(OffsetDateTime.parse("2020-01-01T00:00:00.000Z"))
                    .build())
                .prefer("heartbeat")
                .build();


        sdk.marketing().listSmsTemplates()
                .callAsStream()
                .forEach((MarketingListSmsTemplatesResponse item) -> {
                   // handle page
                });

    }
}

Parameters

Parameter	Type	Required	Description
`request`	MarketingListSmsTemplatesRequest	✔️	The request object to use for the request.

Response

MarketingListSmsTemplatesResponse

Errors

Error Type	Status Code	Content Type
models/errors/BadRequestResponse	400	application/json
models/errors/UnauthorizedResponse	401	application/json
models/errors/ForbiddenResponse	403	application/json
models/errors/NotFoundResponse	404	application/json
models/errors/RequestTimedOutResponse	408	application/json
models/errors/ConflictResponse	409	application/json
models/errors/PreconditionFailedResponse	412	application/json
models/errors/UnprocessableEntityResponse	422	application/json
models/errors/TooManyRequestsResponse	429	application/json
models/errors/InternalServerErrorResponse	500	application/json
models/errors/NotImplementedResponse	501	application/json
models/errors/BadGatewayResponse	502	application/json
models/errors/SDKError	4XX, 5XX	/

createSmsTemplate

Create SMS Template

Example Usage

package hello.world;

import com.stackone.stackone_client_java.StackOne;
import com.stackone.stackone_client_java.models.components.*;
import com.stackone.stackone_client_java.models.errors.*;
import com.stackone.stackone_client_java.models.operations.MarketingCreateSmsTemplateResponse;
import java.lang.Exception;
import java.util.List;
import java.util.Map;

public class Application {

    public static void main(String[] args) throws Exception {

        StackOne sdk = StackOne.builder()
                .security(Security.builder()
                    .username("")
                    .password("")
                    .build())
            .build();

        MarketingCreateSmsTemplateResponse res = sdk.marketing().createSmsTemplate()
                .xAccountId("<id>")
                .prefer("heartbeat")
                .marketingCreateSmsTemplateRequestDto(MarketingCreateSmsTemplateRequestDto.builder()
                    .messages(List.of(
                        SmsMessages.builder()
                            .id("8187e5da-dc77-475e-9949-af0f1fa4e4e3")
                            .remoteId("8187e5da-dc77-475e-9949-af0f1fa4e4e3")
                            .messageType(SmsMessagesMessageType.builder()
                                .value(SmsMessagesValue.EMAIL)
                                .sourceValue(SmsMessagesSourceValue.of("Email"))
                                .build())
                            .build()))
                    .passthrough(Map.ofEntries(
                        Map.entry("other_known_names", "John Doe")))
                    .build())
                .call();

        if (res.createResult().isPresent()) {
            // handle response
        }
    }
}

Parameters

Parameter	Type	Required	Description	Example
`xAccountId`	String	✔️	The account identifier
`prefer`	Optional<String>	➖	Set to "heartbeat" to enable keep-alive newline heartbeats during long-running requests. Response includes Preference-Applied: heartbeat header when honored. (RFC 7240)	heartbeat
`marketingCreateSmsTemplateRequestDto`	MarketingCreateSmsTemplateRequestDto	✔️	N/A

Response

MarketingCreateSmsTemplateResponse

Errors

Error Type	Status Code	Content Type
models/errors/BadRequestResponse	400	application/json
models/errors/UnauthorizedResponse	401	application/json
models/errors/ForbiddenResponse	403	application/json
models/errors/NotFoundResponse	404	application/json
models/errors/RequestTimedOutResponse	408	application/json
models/errors/ConflictResponse	409	application/json
models/errors/PreconditionFailedResponse	412	application/json
models/errors/UnprocessableEntityResponse	422	application/json
models/errors/TooManyRequestsResponse	429	application/json
models/errors/InternalServerErrorResponse	500	application/json
models/errors/NotImplementedResponse	501	application/json
models/errors/BadGatewayResponse	502	application/json
models/errors/SDKError	4XX, 5XX	/

getSmsTemplate

Get SMS Template

Example Usage

package hello.world;

import com.stackone.stackone_client_java.StackOne;
import com.stackone.stackone_client_java.models.components.Security;
import com.stackone.stackone_client_java.models.errors.*;
import com.stackone.stackone_client_java.models.operations.MarketingGetSmsTemplateRequest;
import com.stackone.stackone_client_java.models.operations.MarketingGetSmsTemplateResponse;
import java.lang.Exception;

public class Application {

    public static void main(String[] args) throws Exception {

        StackOne sdk = StackOne.builder()
                .security(Security.builder()
                    .username("")
                    .password("")
                    .build())
            .build();

        MarketingGetSmsTemplateRequest req = MarketingGetSmsTemplateRequest.builder()
                .xAccountId("<id>")
                .id("<id>")
                .fields("id,remote_id,name,messages,created_at,updated_at,tags,unified_custom_fields")
                .prefer("heartbeat")
                .build();

        MarketingGetSmsTemplateResponse res = sdk.marketing().getSmsTemplate()
                .request(req)
                .call();

        if (res.smsTemplateResult().isPresent()) {
            // handle response
        }
    }
}

Parameters

Parameter	Type	Required	Description
`request`	MarketingGetSmsTemplateRequest	✔️	The request object to use for the request.

Response

MarketingGetSmsTemplateResponse

Errors

Error Type	Status Code	Content Type
models/errors/BadRequestResponse	400	application/json
models/errors/UnauthorizedResponse	401	application/json
models/errors/ForbiddenResponse	403	application/json
models/errors/NotFoundResponse	404	application/json
models/errors/RequestTimedOutResponse	408	application/json
models/errors/ConflictResponse	409	application/json
models/errors/PreconditionFailedResponse	412	application/json
models/errors/UnprocessableEntityResponse	422	application/json
models/errors/TooManyRequestsResponse	429	application/json
models/errors/InternalServerErrorResponse	500	application/json
models/errors/NotImplementedResponse	501	application/json
models/errors/BadGatewayResponse	502	application/json
models/errors/SDKError	4XX, 5XX	/

updateSmsTemplate

Update SMS Template

Example Usage

package hello.world;

import com.stackone.stackone_client_java.StackOne;
import com.stackone.stackone_client_java.models.components.*;
import com.stackone.stackone_client_java.models.errors.*;
import com.stackone.stackone_client_java.models.operations.MarketingUpdateSmsTemplateResponse;
import java.lang.Exception;
import java.util.List;
import java.util.Map;

public class Application {

    public static void main(String[] args) throws Exception {

        StackOne sdk = StackOne.builder()
                .security(Security.builder()
                    .username("")
                    .password("")
                    .build())
            .build();

        MarketingUpdateSmsTemplateResponse res = sdk.marketing().updateSmsTemplate()
                .xAccountId("<id>")
                .id("<id>")
                .prefer("heartbeat")
                .marketingCreateSmsTemplateRequestDto(MarketingCreateSmsTemplateRequestDto.builder()
                    .messages(List.of(
                        SmsMessages.builder()
                            .id("8187e5da-dc77-475e-9949-af0f1fa4e4e3")
                            .remoteId("8187e5da-dc77-475e-9949-af0f1fa4e4e3")
                            .messageType(SmsMessagesMessageType.builder()
                                .value(SmsMessagesValue.EMAIL)
                                .sourceValue(SmsMessagesSourceValue.of("Email"))
                                .build())
                            .build()))
                    .passthrough(Map.ofEntries(
                        Map.entry("other_known_names", "John Doe")))
                    .build())
                .call();

        if (res.createResult().isPresent()) {
            // handle response
        }
    }
}

Parameters

Parameter	Type	Required	Description	Example
`xAccountId`	String	✔️	The account identifier
`id`	String	✔️	N/A
`prefer`	Optional<String>	➖	Set to "heartbeat" to enable keep-alive newline heartbeats during long-running requests. Response includes Preference-Applied: heartbeat header when honored. (RFC 7240)	heartbeat
`marketingCreateSmsTemplateRequestDto`	MarketingCreateSmsTemplateRequestDto	✔️	N/A

Response

MarketingUpdateSmsTemplateResponse

Errors

Error Type	Status Code	Content Type
models/errors/BadRequestResponse	400	application/json
models/errors/UnauthorizedResponse	401	application/json
models/errors/ForbiddenResponse	403	application/json
models/errors/NotFoundResponse	404	application/json
models/errors/RequestTimedOutResponse	408	application/json
models/errors/ConflictResponse	409	application/json
models/errors/PreconditionFailedResponse	412	application/json
models/errors/UnprocessableEntityResponse	422	application/json
models/errors/TooManyRequestsResponse	429	application/json
models/errors/InternalServerErrorResponse	500	application/json
models/errors/NotImplementedResponse	501	application/json
models/errors/BadGatewayResponse	502	application/json
models/errors/SDKError	4XX, 5XX	/

listOmniChannelTemplates

List Omni-Channel Templates

⚠️ DEPRECATED: This will be removed in a future release, please migrate away from it as soon as possible.

Example Usage

package hello.world;

import com.stackone.stackone_client_java.StackOne;
import com.stackone.stackone_client_java.models.components.Security;
import com.stackone.stackone_client_java.models.errors.*;
import com.stackone.stackone_client_java.models.operations.*;
import java.lang.Exception;
import java.time.OffsetDateTime;

public class Application {

    public static void main(String[] args) throws Exception {

        StackOne sdk = StackOne.builder()
                .security(Security.builder()
                    .username("")
                    .password("")
                    .build())
            .build();

        MarketingListOmniChannelTemplatesRequest req = MarketingListOmniChannelTemplatesRequest.builder()
                .xAccountId("<id>")
                .fields("id,remote_id,name,messages,created_at,updated_at,tags,unified_custom_fields")
                .filter(MarketingListOmniChannelTemplatesQueryParamFilter.builder()
                    .updatedAfter(OffsetDateTime.parse("2020-01-01T00:00:00.000Z"))
                    .build())
                .prefer("heartbeat")
                .build();


        sdk.marketing().listOmniChannelTemplates()
                .callAsStream()
                .forEach((MarketingListOmniChannelTemplatesResponse item) -> {
                   // handle page
                });

    }
}

Parameters

Parameter	Type	Required	Description
`request`	MarketingListOmniChannelTemplatesRequest	✔️	The request object to use for the request.

Response

MarketingListOmniChannelTemplatesResponse

Errors

Error Type	Status Code	Content Type
models/errors/BadRequestResponse	400	application/json
models/errors/UnauthorizedResponse	401	application/json
models/errors/ForbiddenResponse	403	application/json
models/errors/NotFoundResponse	404	application/json
models/errors/RequestTimedOutResponse	408	application/json
models/errors/ConflictResponse	409	application/json
models/errors/PreconditionFailedResponse	412	application/json
models/errors/UnprocessableEntityResponse	422	application/json
models/errors/TooManyRequestsResponse	429	application/json
models/errors/InternalServerErrorResponse	500	application/json
models/errors/NotImplementedResponse	501	application/json
models/errors/BadGatewayResponse	502	application/json
models/errors/SDKError	4XX, 5XX	/

createOmniChannelTemplate

Create Omni-Channel Template

⚠️ DEPRECATED: This will be removed in a future release, please migrate away from it as soon as possible.

Example Usage

package hello.world;

import com.stackone.stackone_client_java.StackOne;
import com.stackone.stackone_client_java.models.components.*;
import com.stackone.stackone_client_java.models.errors.*;
import com.stackone.stackone_client_java.models.operations.MarketingCreateOmniChannelTemplateResponse;
import java.lang.Exception;
import java.util.List;
import java.util.Map;

public class Application {

    public static void main(String[] args) throws Exception {

        StackOne sdk = StackOne.builder()
                .security(Security.builder()
                    .username("")
                    .password("")
                    .build())
            .build();

        MarketingCreateOmniChannelTemplateResponse res = sdk.marketing().createOmniChannelTemplate()
                .xAccountId("<id>")
                .prefer("heartbeat")
                .marketingCreateTemplateRequestDto(MarketingCreateTemplateRequestDto.builder()
                    .messages(List.of(
                        CreateMessage.builder()
                            .id("8187e5da-dc77-475e-9949-af0f1fa4e4e3")
                            .messageType(CreateMessageMessageType.builder()
                                .value(CreateMessageValue.EMAIL)
                                .sourceValue(CreateMessageSourceValue.of("Email"))
                                .build())
                            .build()))
                    .passthrough(Map.ofEntries(
                        Map.entry("other_known_names", "John Doe")))
                    .build())
                .call();

        if (res.createResult().isPresent()) {
            // handle response
        }
    }
}

Parameters

Parameter	Type	Required	Description	Example
`xAccountId`	String	✔️	The account identifier
`prefer`	Optional<String>	➖	Set to "heartbeat" to enable keep-alive newline heartbeats during long-running requests. Response includes Preference-Applied: heartbeat header when honored. (RFC 7240)	heartbeat
`marketingCreateTemplateRequestDto`	MarketingCreateTemplateRequestDto	✔️	N/A

Response

MarketingCreateOmniChannelTemplateResponse

Errors

Error Type	Status Code	Content Type
models/errors/BadRequestResponse	400	application/json
models/errors/UnauthorizedResponse	401	application/json
models/errors/ForbiddenResponse	403	application/json
models/errors/NotFoundResponse	404	application/json
models/errors/RequestTimedOutResponse	408	application/json
models/errors/ConflictResponse	409	application/json
models/errors/PreconditionFailedResponse	412	application/json
models/errors/UnprocessableEntityResponse	422	application/json
models/errors/TooManyRequestsResponse	429	application/json
models/errors/InternalServerErrorResponse	500	application/json
models/errors/NotImplementedResponse	501	application/json
models/errors/BadGatewayResponse	502	application/json
models/errors/SDKError	4XX, 5XX	/

getOmniChannelTemplate

Get Omni-Channel Template

⚠️ DEPRECATED: This will be removed in a future release, please migrate away from it as soon as possible.

Example Usage

package hello.world;

import com.stackone.stackone_client_java.StackOne;
import com.stackone.stackone_client_java.models.components.Security;
import com.stackone.stackone_client_java.models.errors.*;
import com.stackone.stackone_client_java.models.operations.MarketingGetOmniChannelTemplateRequest;
import com.stackone.stackone_client_java.models.operations.MarketingGetOmniChannelTemplateResponse;
import java.lang.Exception;

public class Application {

    public static void main(String[] args) throws Exception {

        StackOne sdk = StackOne.builder()
                .security(Security.builder()
                    .username("")
                    .password("")
                    .build())
            .build();

        MarketingGetOmniChannelTemplateRequest req = MarketingGetOmniChannelTemplateRequest.builder()
                .xAccountId("<id>")
                .id("<id>")
                .fields("id,remote_id,name,messages,created_at,updated_at,tags,unified_custom_fields")
                .prefer("heartbeat")
                .build();

        MarketingGetOmniChannelTemplateResponse res = sdk.marketing().getOmniChannelTemplate()
                .request(req)
                .call();

        if (res.templateResult().isPresent()) {
            // handle response
        }
    }
}

Parameters

Parameter	Type	Required	Description
`request`	MarketingGetOmniChannelTemplateRequest	✔️	The request object to use for the request.

Response

MarketingGetOmniChannelTemplateResponse

Errors

Error Type	Status Code	Content Type
models/errors/BadRequestResponse	400	application/json
models/errors/UnauthorizedResponse	401	application/json
models/errors/ForbiddenResponse	403	application/json
models/errors/NotFoundResponse	404	application/json
models/errors/RequestTimedOutResponse	408	application/json
models/errors/ConflictResponse	409	application/json
models/errors/PreconditionFailedResponse	412	application/json
models/errors/UnprocessableEntityResponse	422	application/json
models/errors/TooManyRequestsResponse	429	application/json
models/errors/InternalServerErrorResponse	500	application/json
models/errors/NotImplementedResponse	501	application/json
models/errors/BadGatewayResponse	502	application/json
models/errors/SDKError	4XX, 5XX	/

updateOmniChannelTemplate

Update Omni-Channel Template

⚠️ DEPRECATED: This will be removed in a future release, please migrate away from it as soon as possible.

Example Usage

package hello.world;

import com.stackone.stackone_client_java.StackOne;
import com.stackone.stackone_client_java.models.components.*;
import com.stackone.stackone_client_java.models.errors.*;
import com.stackone.stackone_client_java.models.operations.MarketingUpdateOmniChannelTemplateResponse;
import java.lang.Exception;
import java.util.List;
import java.util.Map;

public class Application {

    public static void main(String[] args) throws Exception {

        StackOne sdk = StackOne.builder()
                .security(Security.builder()
                    .username("")
                    .password("")
                    .build())
            .build();

        MarketingUpdateOmniChannelTemplateResponse res = sdk.marketing().updateOmniChannelTemplate()
                .xAccountId("<id>")
                .id("<id>")
                .prefer("heartbeat")
                .marketingCreateTemplateRequestDto(MarketingCreateTemplateRequestDto.builder()
                    .messages(List.of(
                        CreateMessage.builder()
                            .id("8187e5da-dc77-475e-9949-af0f1fa4e4e3")
                            .messageType(CreateMessageMessageType.builder()
                                .value(CreateMessageValue.EMAIL)
                                .sourceValue(CreateMessageSourceValue.of("Email"))
                                .build())
                            .build()))
                    .passthrough(Map.ofEntries(
                        Map.entry("other_known_names", "John Doe")))
                    .build())
                .call();

        if (res.createResult().isPresent()) {
            // handle response
        }
    }
}

Parameters

Parameter	Type	Required	Description	Example
`xAccountId`	String	✔️	The account identifier
`id`	String	✔️	N/A
`prefer`	Optional<String>	➖	Set to "heartbeat" to enable keep-alive newline heartbeats during long-running requests. Response includes Preference-Applied: heartbeat header when honored. (RFC 7240)	heartbeat
`marketingCreateTemplateRequestDto`	MarketingCreateTemplateRequestDto	✔️	N/A

Response

MarketingUpdateOmniChannelTemplateResponse

Errors

Error Type	Status Code	Content Type
models/errors/BadRequestResponse	400	application/json
models/errors/UnauthorizedResponse	401	application/json
models/errors/ForbiddenResponse	403	application/json
models/errors/NotFoundResponse	404	application/json
models/errors/RequestTimedOutResponse	408	application/json
models/errors/ConflictResponse	409	application/json
models/errors/PreconditionFailedResponse	412	application/json
models/errors/UnprocessableEntityResponse	422	application/json
models/errors/TooManyRequestsResponse	429	application/json
models/errors/InternalServerErrorResponse	500	application/json
models/errors/NotImplementedResponse	501	application/json
models/errors/BadGatewayResponse	502	application/json
models/errors/SDKError	4XX, 5XX	/

listPushTemplates

List Push Templates

Example Usage

package hello.world;

import com.stackone.stackone_client_java.StackOne;
import com.stackone.stackone_client_java.models.components.Security;
import com.stackone.stackone_client_java.models.errors.*;
import com.stackone.stackone_client_java.models.operations.*;
import java.lang.Exception;
import java.time.OffsetDateTime;

public class Application {

    public static void main(String[] args) throws Exception {

        StackOne sdk = StackOne.builder()
                .security(Security.builder()
                    .username("")
                    .password("")
                    .build())
            .build();

        MarketingListPushTemplatesRequest req = MarketingListPushTemplatesRequest.builder()
                .xAccountId("<id>")
                .fields("id,remote_id,name,messages,created_at,updated_at,tags,unified_custom_fields")
                .filter(MarketingListPushTemplatesQueryParamFilter.builder()
                    .updatedAfter(OffsetDateTime.parse("2020-01-01T00:00:00.000Z"))
                    .build())
                .prefer("heartbeat")
                .build();


        sdk.marketing().listPushTemplates()
                .callAsStream()
                .forEach((MarketingListPushTemplatesResponse item) -> {
                   // handle page
                });

    }
}

Parameters

Parameter	Type	Required	Description
`request`	MarketingListPushTemplatesRequest	✔️	The request object to use for the request.

Response

MarketingListPushTemplatesResponse

Errors

Error Type	Status Code	Content Type
models/errors/BadRequestResponse	400	application/json
models/errors/UnauthorizedResponse	401	application/json
models/errors/ForbiddenResponse	403	application/json
models/errors/NotFoundResponse	404	application/json
models/errors/RequestTimedOutResponse	408	application/json
models/errors/ConflictResponse	409	application/json
models/errors/PreconditionFailedResponse	412	application/json
models/errors/UnprocessableEntityResponse	422	application/json
models/errors/TooManyRequestsResponse	429	application/json
models/errors/InternalServerErrorResponse	500	application/json
models/errors/NotImplementedResponse	501	application/json
models/errors/BadGatewayResponse	502	application/json
models/errors/SDKError	4XX, 5XX	/

createPushTemplate

Create Push Template

Example Usage

package hello.world;

import com.stackone.stackone_client_java.StackOne;
import com.stackone.stackone_client_java.models.components.*;
import com.stackone.stackone_client_java.models.errors.*;
import com.stackone.stackone_client_java.models.operations.MarketingCreatePushTemplateResponse;
import java.lang.Exception;
import java.util.List;
import java.util.Map;

public class Application {

    public static void main(String[] args) throws Exception {

        StackOne sdk = StackOne.builder()
                .security(Security.builder()
                    .username("")
                    .password("")
                    .build())
            .build();

        MarketingCreatePushTemplateResponse res = sdk.marketing().createPushTemplate()
                .xAccountId("<id>")
                .prefer("heartbeat")
                .marketingCreatePushTemplateRequestDto(MarketingCreatePushTemplateRequestDto.builder()
                    .messages(List.of(
                        PushMessages.builder()
                            .id("8187e5da-dc77-475e-9949-af0f1fa4e4e3")
                            .remoteId("8187e5da-dc77-475e-9949-af0f1fa4e4e3")
                            .messageType(PushMessagesMessageType.builder()
                                .value(PushMessagesValue.EMAIL)
                                .sourceValue(PushMessagesSourceValue.of("Email"))
                                .build())
                            .build()))
                    .passthrough(Map.ofEntries(
                        Map.entry("other_known_names", "John Doe")))
                    .build())
                .call();

        if (res.createResult().isPresent()) {
            // handle response
        }
    }
}

Parameters

Parameter	Type	Required	Description	Example
`xAccountId`	String	✔️	The account identifier
`prefer`	Optional<String>	➖	Set to "heartbeat" to enable keep-alive newline heartbeats during long-running requests. Response includes Preference-Applied: heartbeat header when honored. (RFC 7240)	heartbeat
`marketingCreatePushTemplateRequestDto`	MarketingCreatePushTemplateRequestDto	✔️	N/A

Response

MarketingCreatePushTemplateResponse

Errors

Error Type	Status Code	Content Type
models/errors/BadRequestResponse	400	application/json
models/errors/UnauthorizedResponse	401	application/json
models/errors/ForbiddenResponse	403	application/json
models/errors/NotFoundResponse	404	application/json
models/errors/RequestTimedOutResponse	408	application/json
models/errors/ConflictResponse	409	application/json
models/errors/PreconditionFailedResponse	412	application/json
models/errors/UnprocessableEntityResponse	422	application/json
models/errors/TooManyRequestsResponse	429	application/json
models/errors/InternalServerErrorResponse	500	application/json
models/errors/NotImplementedResponse	501	application/json
models/errors/BadGatewayResponse	502	application/json
models/errors/SDKError	4XX, 5XX	/

getPushTemplate

Get Push Template

Example Usage

package hello.world;

import com.stackone.stackone_client_java.StackOne;
import com.stackone.stackone_client_java.models.components.Security;
import com.stackone.stackone_client_java.models.errors.*;
import com.stackone.stackone_client_java.models.operations.MarketingGetPushTemplateRequest;
import com.stackone.stackone_client_java.models.operations.MarketingGetPushTemplateResponse;
import java.lang.Exception;

public class Application {

    public static void main(String[] args) throws Exception {

        StackOne sdk = StackOne.builder()
                .security(Security.builder()
                    .username("")
                    .password("")
                    .build())
            .build();

        MarketingGetPushTemplateRequest req = MarketingGetPushTemplateRequest.builder()
                .xAccountId("<id>")
                .id("<id>")
                .fields("id,remote_id,name,messages,created_at,updated_at,tags,unified_custom_fields")
                .prefer("heartbeat")
                .build();

        MarketingGetPushTemplateResponse res = sdk.marketing().getPushTemplate()
                .request(req)
                .call();

        if (res.pushTemplateResult().isPresent()) {
            // handle response
        }
    }
}

Parameters

Parameter	Type	Required	Description
`request`	MarketingGetPushTemplateRequest	✔️	The request object to use for the request.

Response

MarketingGetPushTemplateResponse

Errors

Error Type	Status Code	Content Type
models/errors/BadRequestResponse	400	application/json
models/errors/UnauthorizedResponse	401	application/json
models/errors/ForbiddenResponse	403	application/json
models/errors/NotFoundResponse	404	application/json
models/errors/RequestTimedOutResponse	408	application/json
models/errors/ConflictResponse	409	application/json
models/errors/PreconditionFailedResponse	412	application/json
models/errors/UnprocessableEntityResponse	422	application/json
models/errors/TooManyRequestsResponse	429	application/json
models/errors/InternalServerErrorResponse	500	application/json
models/errors/NotImplementedResponse	501	application/json
models/errors/BadGatewayResponse	502	application/json
models/errors/SDKError	4XX, 5XX	/

updatePushTemplate

Update Push Template

Example Usage

package hello.world;

import com.stackone.stackone_client_java.StackOne;
import com.stackone.stackone_client_java.models.components.*;
import com.stackone.stackone_client_java.models.errors.*;
import com.stackone.stackone_client_java.models.operations.MarketingUpdatePushTemplateResponse;
import java.lang.Exception;
import java.util.List;
import java.util.Map;

public class Application {

    public static void main(String[] args) throws Exception {

        StackOne sdk = StackOne.builder()
                .security(Security.builder()
                    .username("")
                    .password("")
                    .build())
            .build();

        MarketingUpdatePushTemplateResponse res = sdk.marketing().updatePushTemplate()
                .xAccountId("<id>")
                .id("<id>")
                .prefer("heartbeat")
                .marketingCreatePushTemplateRequestDto(MarketingCreatePushTemplateRequestDto.builder()
                    .messages(List.of(
                        PushMessages.builder()
                            .id("8187e5da-dc77-475e-9949-af0f1fa4e4e3")
                            .remoteId("8187e5da-dc77-475e-9949-af0f1fa4e4e3")
                            .messageType(PushMessagesMessageType.builder()
                                .value(PushMessagesValue.EMAIL)
                                .sourceValue(PushMessagesSourceValue.of("Email"))
                                .build())
                            .build()))
                    .passthrough(Map.ofEntries(
                        Map.entry("other_known_names", "John Doe")))
                    .build())
                .call();

        if (res.createResult().isPresent()) {
            // handle response
        }
    }
}

Parameters

Parameter	Type	Required	Description	Example
`xAccountId`	String	✔️	The account identifier
`id`	String	✔️	N/A
`prefer`	Optional<String>	➖	Set to "heartbeat" to enable keep-alive newline heartbeats during long-running requests. Response includes Preference-Applied: heartbeat header when honored. (RFC 7240)	heartbeat
`marketingCreatePushTemplateRequestDto`	MarketingCreatePushTemplateRequestDto	✔️	N/A

Response

MarketingUpdatePushTemplateResponse

Errors

Error Type	Status Code	Content Type
models/errors/BadRequestResponse	400	application/json
models/errors/UnauthorizedResponse	401	application/json
models/errors/ForbiddenResponse	403	application/json
models/errors/NotFoundResponse	404	application/json
models/errors/RequestTimedOutResponse	408	application/json
models/errors/ConflictResponse	409	application/json
models/errors/PreconditionFailedResponse	412	application/json
models/errors/UnprocessableEntityResponse	422	application/json
models/errors/TooManyRequestsResponse	429	application/json
models/errors/InternalServerErrorResponse	500	application/json
models/errors/NotImplementedResponse	501	application/json
models/errors/BadGatewayResponse	502	application/json
models/errors/SDKError	4XX, 5XX	/

listCampaigns

List campaigns

Example Usage

package hello.world;

import com.stackone.stackone_client_java.StackOne;
import com.stackone.stackone_client_java.models.components.Security;
import com.stackone.stackone_client_java.models.errors.*;
import com.stackone.stackone_client_java.models.operations.*;
import java.lang.Exception;
import java.time.OffsetDateTime;

public class Application {

    public static void main(String[] args) throws Exception {

        StackOne sdk = StackOne.builder()
                .security(Security.builder()
                    .username("")
                    .password("")
                    .build())
            .build();

        MarketingListCampaignsRequest req = MarketingListCampaignsRequest.builder()
                .xAccountId("<id>")
                .fields("id,remote_id,name,created_at,updated_at,description,schedule_type,status,channels,first_sent_at,last_sent_at,tags,messages,unified_custom_fields")
                .filter(MarketingListCampaignsQueryParamFilter.builder()
                    .updatedAfter(OffsetDateTime.parse("2020-01-01T00:00:00.000Z"))
                    .build())
                .prefer("heartbeat")
                .build();


        sdk.marketing().listCampaigns()
                .callAsStream()
                .forEach((MarketingListCampaignsResponse item) -> {
                   // handle page
                });

    }
}

Parameters

Parameter	Type	Required	Description
`request`	MarketingListCampaignsRequest	✔️	The request object to use for the request.

Response

MarketingListCampaignsResponse

Errors

Error Type	Status Code	Content Type
models/errors/BadRequestResponse	400	application/json
models/errors/UnauthorizedResponse	401	application/json
models/errors/ForbiddenResponse	403	application/json
models/errors/NotFoundResponse	404	application/json
models/errors/RequestTimedOutResponse	408	application/json
models/errors/ConflictResponse	409	application/json
models/errors/PreconditionFailedResponse	412	application/json
models/errors/UnprocessableEntityResponse	422	application/json
models/errors/TooManyRequestsResponse	429	application/json
models/errors/InternalServerErrorResponse	500	application/json
models/errors/NotImplementedResponse	501	application/json
models/errors/BadGatewayResponse	502	application/json
models/errors/SDKError	4XX, 5XX	/

getCampaign

Get campaign

Example Usage

package hello.world;

import com.stackone.stackone_client_java.StackOne;
import com.stackone.stackone_client_java.models.components.Security;
import com.stackone.stackone_client_java.models.errors.*;
import com.stackone.stackone_client_java.models.operations.MarketingGetCampaignRequest;
import com.stackone.stackone_client_java.models.operations.MarketingGetCampaignResponse;
import java.lang.Exception;

public class Application {

    public static void main(String[] args) throws Exception {

        StackOne sdk = StackOne.builder()
                .security(Security.builder()
                    .username("")
                    .password("")
                    .build())
            .build();

        MarketingGetCampaignRequest req = MarketingGetCampaignRequest.builder()
                .xAccountId("<id>")
                .id("<id>")
                .fields("id,remote_id,name,created_at,updated_at,description,schedule_type,status,channels,first_sent_at,last_sent_at,tags,messages,unified_custom_fields")
                .prefer("heartbeat")
                .build();

        MarketingGetCampaignResponse res = sdk.marketing().getCampaign()
                .request(req)
                .call();

        if (res.campaignResult().isPresent()) {
            // handle response
        }
    }
}

Parameters

Parameter	Type	Required	Description
`request`	MarketingGetCampaignRequest	✔️	The request object to use for the request.

Response

MarketingGetCampaignResponse

Errors

Error Type	Status Code	Content Type
models/errors/BadRequestResponse	400	application/json
models/errors/UnauthorizedResponse	401	application/json
models/errors/ForbiddenResponse	403	application/json
models/errors/NotFoundResponse	404	application/json
models/errors/RequestTimedOutResponse	408	application/json
models/errors/ConflictResponse	409	application/json
models/errors/PreconditionFailedResponse	412	application/json
models/errors/UnprocessableEntityResponse	422	application/json
models/errors/TooManyRequestsResponse	429	application/json
models/errors/InternalServerErrorResponse	500	application/json
models/errors/NotImplementedResponse	501	application/json
models/errors/BadGatewayResponse	502	application/json
models/errors/SDKError	4XX, 5XX	/

listContentBlocks

List Content Blocks

Example Usage

package hello.world;

import com.stackone.stackone_client_java.StackOne;
import com.stackone.stackone_client_java.models.components.Security;
import com.stackone.stackone_client_java.models.errors.*;
import com.stackone.stackone_client_java.models.operations.*;
import java.lang.Exception;
import java.time.OffsetDateTime;

public class Application {

    public static void main(String[] args) throws Exception {

        StackOne sdk = StackOne.builder()
                .security(Security.builder()
                    .username("")
                    .password("")
                    .build())
            .build();

        MarketingListContentBlocksRequest req = MarketingListContentBlocksRequest.builder()
                .xAccountId("<id>")
                .fields("id,remote_id,name,type,content,status,tags,created_at,updated_at,unified_custom_fields")
                .filter(MarketingListContentBlocksQueryParamFilter.builder()
                    .updatedAfter(OffsetDateTime.parse("2020-01-01T00:00:00.000Z"))
                    .build())
                .prefer("heartbeat")
                .build();


        sdk.marketing().listContentBlocks()
                .callAsStream()
                .forEach((MarketingListContentBlocksResponse item) -> {
                   // handle page
                });

    }
}

Parameters

Parameter	Type	Required	Description
`request`	MarketingListContentBlocksRequest	✔️	The request object to use for the request.

Response

MarketingListContentBlocksResponse

Errors

Error Type	Status Code	Content Type
models/errors/BadRequestResponse	400	application/json
models/errors/UnauthorizedResponse	401	application/json
models/errors/ForbiddenResponse	403	application/json
models/errors/NotFoundResponse	404	application/json
models/errors/RequestTimedOutResponse	408	application/json
models/errors/ConflictResponse	409	application/json
models/errors/PreconditionFailedResponse	412	application/json
models/errors/UnprocessableEntityResponse	422	application/json
models/errors/TooManyRequestsResponse	429	application/json
models/errors/InternalServerErrorResponse	500	application/json
models/errors/NotImplementedResponse	501	application/json
models/errors/BadGatewayResponse	502	application/json
models/errors/SDKError	4XX, 5XX	/

createContentBlock

Create Content Block

Example Usage

package hello.world;

import com.stackone.stackone_client_java.StackOne;
import com.stackone.stackone_client_java.models.components.*;
import com.stackone.stackone_client_java.models.errors.*;
import com.stackone.stackone_client_java.models.operations.MarketingCreateContentBlockResponse;
import java.lang.Exception;
import java.util.Map;

public class Application {

    public static void main(String[] args) throws Exception {

        StackOne sdk = StackOne.builder()
                .security(Security.builder()
                    .username("")
                    .password("")
                    .build())
            .build();

        MarketingCreateContentBlockResponse res = sdk.marketing().createContentBlock()
                .xAccountId("<id>")
                .prefer("heartbeat")
                .marketingCreateContentBlocksRequestDto(MarketingCreateContentBlocksRequestDto.builder()
                    .type(MarketingCreateContentBlocksRequestDtoType.builder()
                        .value(MarketingCreateContentBlocksRequestDtoValue.HTML)
                        .sourceValue(MarketingCreateContentBlocksRequestDtoSourceValue.of("text"))
                        .build())
                    .passthrough(Map.ofEntries(
                        Map.entry("other_known_names", "John Doe")))
                    .build())
                .call();

        if (res.createResult().isPresent()) {
            // handle response
        }
    }
}

Parameters

Parameter	Type	Required	Description	Example
`xAccountId`	String	✔️	The account identifier
`prefer`	Optional<String>	➖	Set to "heartbeat" to enable keep-alive newline heartbeats during long-running requests. Response includes Preference-Applied: heartbeat header when honored. (RFC 7240)	heartbeat
`marketingCreateContentBlocksRequestDto`	MarketingCreateContentBlocksRequestDto	✔️	N/A

Response

MarketingCreateContentBlockResponse

Errors

Error Type	Status Code	Content Type
models/errors/BadRequestResponse	400	application/json
models/errors/UnauthorizedResponse	401	application/json
models/errors/ForbiddenResponse	403	application/json
models/errors/NotFoundResponse	404	application/json
models/errors/RequestTimedOutResponse	408	application/json
models/errors/ConflictResponse	409	application/json
models/errors/PreconditionFailedResponse	412	application/json
models/errors/UnprocessableEntityResponse	422	application/json
models/errors/TooManyRequestsResponse	429	application/json
models/errors/InternalServerErrorResponse	500	application/json
models/errors/NotImplementedResponse	501	application/json
models/errors/BadGatewayResponse	502	application/json
models/errors/SDKError	4XX, 5XX	/

getContentBlock

Get Content Blocks

Example Usage

package hello.world;

import com.stackone.stackone_client_java.StackOne;
import com.stackone.stackone_client_java.models.components.Security;
import com.stackone.stackone_client_java.models.errors.*;
import com.stackone.stackone_client_java.models.operations.MarketingGetContentBlockRequest;
import com.stackone.stackone_client_java.models.operations.MarketingGetContentBlockResponse;
import java.lang.Exception;

public class Application {

    public static void main(String[] args) throws Exception {

        StackOne sdk = StackOne.builder()
                .security(Security.builder()
                    .username("")
                    .password("")
                    .build())
            .build();

        MarketingGetContentBlockRequest req = MarketingGetContentBlockRequest.builder()
                .xAccountId("<id>")
                .id("<id>")
                .fields("id,remote_id,name,type,content,status,tags,created_at,updated_at,unified_custom_fields")
                .prefer("heartbeat")
                .build();

        MarketingGetContentBlockResponse res = sdk.marketing().getContentBlock()
                .request(req)
                .call();

        if (res.contentBlockResult().isPresent()) {
            // handle response
        }
    }
}

Parameters

Parameter	Type	Required	Description
`request`	MarketingGetContentBlockRequest	✔️	The request object to use for the request.

Response

MarketingGetContentBlockResponse

Errors

Error Type	Status Code	Content Type
models/errors/BadRequestResponse	400	application/json
models/errors/UnauthorizedResponse	401	application/json
models/errors/ForbiddenResponse	403	application/json
models/errors/NotFoundResponse	404	application/json
models/errors/RequestTimedOutResponse	408	application/json
models/errors/ConflictResponse	409	application/json
models/errors/PreconditionFailedResponse	412	application/json
models/errors/UnprocessableEntityResponse	422	application/json
models/errors/TooManyRequestsResponse	429	application/json
models/errors/InternalServerErrorResponse	500	application/json
models/errors/NotImplementedResponse	501	application/json
models/errors/BadGatewayResponse	502	application/json
models/errors/SDKError	4XX, 5XX	/

updateContentBlock

Update Content Block

Example Usage

package hello.world;

import com.stackone.stackone_client_java.StackOne;
import com.stackone.stackone_client_java.models.components.*;
import com.stackone.stackone_client_java.models.errors.*;
import com.stackone.stackone_client_java.models.operations.MarketingUpdateContentBlockResponse;
import java.lang.Exception;
import java.util.Map;

public class Application {

    public static void main(String[] args) throws Exception {

        StackOne sdk = StackOne.builder()
                .security(Security.builder()
                    .username("")
                    .password("")
                    .build())
            .build();

        MarketingUpdateContentBlockResponse res = sdk.marketing().updateContentBlock()
                .xAccountId("<id>")
                .id("<id>")
                .prefer("heartbeat")
                .marketingCreateContentBlocksRequestDto(MarketingCreateContentBlocksRequestDto.builder()
                    .type(MarketingCreateContentBlocksRequestDtoType.builder()
                        .value(MarketingCreateContentBlocksRequestDtoValue.HTML)
                        .sourceValue(MarketingCreateContentBlocksRequestDtoSourceValue.of("text"))
                        .build())
                    .passthrough(Map.ofEntries(
                        Map.entry("other_known_names", "John Doe")))
                    .build())
                .call();

        if (res.createResult().isPresent()) {
            // handle response
        }
    }
}

Parameters

Parameter	Type	Required	Description	Example
`xAccountId`	String	✔️	The account identifier
`id`	String	✔️	N/A
`prefer`	Optional<String>	➖	Set to "heartbeat" to enable keep-alive newline heartbeats during long-running requests. Response includes Preference-Applied: heartbeat header when honored. (RFC 7240)	heartbeat
`marketingCreateContentBlocksRequestDto`	MarketingCreateContentBlocksRequestDto	✔️	N/A

Response

MarketingUpdateContentBlockResponse

Errors

Error Type	Status Code	Content Type
models/errors/BadRequestResponse	400	application/json
models/errors/UnauthorizedResponse	401	application/json
models/errors/ForbiddenResponse	403	application/json
models/errors/NotFoundResponse	404	application/json
models/errors/RequestTimedOutResponse	408	application/json
models/errors/ConflictResponse	409	application/json
models/errors/PreconditionFailedResponse	412	application/json
models/errors/UnprocessableEntityResponse	422	application/json
models/errors/TooManyRequestsResponse	429	application/json
models/errors/InternalServerErrorResponse	500	application/json
models/errors/NotImplementedResponse	501	application/json
models/errors/BadGatewayResponse	502	application/json
models/errors/SDKError	4XX, 5XX	/

FilesExpand file tree

README.md

Latest commit

History

README.md

File metadata and controls

Marketing

Overview

Available Operations

listEmailTemplates

Example Usage

Parameters

Response

Errors

createEmailTemplate

Example Usage

Parameters

Response

Errors

getEmailTemplate

Example Usage

Parameters

Response

Errors

updateEmailTemplate

Example Usage

Parameters

Response

Errors

listInAppTemplates

Example Usage

Parameters

Response

Errors

createInAppTemplate

Example Usage

Parameters

Response

Errors

getInAppTemplate

Example Usage

Parameters

Response

Errors

updateInAppTemplate

Example Usage

Parameters

Response

Errors

listSmsTemplates

Example Usage

Parameters

Response

Errors

createSmsTemplate

Example Usage

Parameters

Response

Errors

getSmsTemplate

Example Usage

Parameters

Response

Errors

updateSmsTemplate

Example Usage

Parameters

Response

Errors

listOmniChannelTemplates

Example Usage

Parameters

Response

Errors

createOmniChannelTemplate

Example Usage

Parameters

Response

Errors

getOmniChannelTemplate