Package com.stackone.stackone_client_java

Class Marketing

  • public class Marketing
extends java.lang.Object

    • Method Detail

      • async

        public AsyncMarketing async()
        Switches to the async SDK.
        Returns:
        The async SDK

      • listEmailTemplates

        public MarketingListEmailTemplatesResponse listEmailTemplates​(MarketingListEmailTemplatesRequest request)
        List Email Templates
        Parameters:
        request - The request object containing all the parameters for the API call.
        Returns:
        The response from the API call
        Throws:
        java.lang.RuntimeException - subclass if the API call fails

      • listEmailTemplates

        public MarketingListEmailTemplatesResponse listEmailTemplates​(MarketingListEmailTemplatesRequest request,
                                                              java.util.Optional<Options> options)
        List Email Templates
        Parameters:
        request - The request object containing all the parameters for the API call.
        options - additional options
        Returns:
        The response from the API call
        Throws:
        java.lang.RuntimeException - subclass if the API call fails

      • createEmailTemplate

        public MarketingCreateEmailTemplateResponse createEmailTemplate​(java.lang.String xAccountId,
                                                                MarketingCreateEmailTemplateRequestDto marketingCreateEmailTemplateRequestDto)
        Create Email Templates
        Parameters:
        xAccountId - The account identifier
        marketingCreateEmailTemplateRequestDto -
        Returns:
        The response from the API call
        Throws:
        java.lang.RuntimeException - subclass if the API call fails

      • createEmailTemplate

        public MarketingCreateEmailTemplateResponse createEmailTemplate​(java.lang.String xAccountId,
                                                                MarketingCreateEmailTemplateRequestDto marketingCreateEmailTemplateRequestDto,
                                                                java.util.Optional<Options> options)
        Create Email Templates
        Parameters:
        xAccountId - The account identifier
        marketingCreateEmailTemplateRequestDto -
        options - additional options
        Returns:
        The response from the API call
        Throws:
        java.lang.RuntimeException - subclass if the API call fails

      • getEmailTemplate

        public MarketingGetEmailTemplateResponse getEmailTemplate​(MarketingGetEmailTemplateRequest request)
        Get Email Templates
        Parameters:
        request - The request object containing all the parameters for the API call.
        Returns:
        The response from the API call
        Throws:
        java.lang.RuntimeException - subclass if the API call fails

      • getEmailTemplate

        public MarketingGetEmailTemplateResponse getEmailTemplate​(MarketingGetEmailTemplateRequest request,
                                                          java.util.Optional<Options> options)
        Get Email Templates
        Parameters:
        request - The request object containing all the parameters for the API call.
        options - additional options
        Returns:
        The response from the API call
        Throws:
        java.lang.RuntimeException - subclass if the API call fails

      • updateEmailTemplate

        public MarketingUpdateEmailTemplateResponse updateEmailTemplate​(java.lang.String xAccountId,
                                                                java.lang.String id,
                                                                MarketingCreateEmailTemplateRequestDto marketingCreateEmailTemplateRequestDto)
        Update Email Templates
        Parameters:
        xAccountId - The account identifier
        id -
        marketingCreateEmailTemplateRequestDto -
        Returns:
        The response from the API call
        Throws:
        java.lang.RuntimeException - subclass if the API call fails

      • updateEmailTemplate

        public MarketingUpdateEmailTemplateResponse updateEmailTemplate​(java.lang.String xAccountId,
                                                                java.lang.String id,
                                                                MarketingCreateEmailTemplateRequestDto marketingCreateEmailTemplateRequestDto,
                                                                java.util.Optional<Options> options)
        Update Email Templates
        Parameters:
        xAccountId - The account identifier
        id -
        marketingCreateEmailTemplateRequestDto -
        options - additional options
        Returns:
        The response from the API call
        Throws:
        java.lang.RuntimeException - subclass if the API call fails

      • listInAppTemplates

        public MarketingListInAppTemplatesResponse listInAppTemplates​(MarketingListInAppTemplatesRequest request)
        List In-App Templates
        Parameters:
        request - The request object containing all the parameters for the API call.
        Returns:
        The response from the API call
        Throws:
        java.lang.RuntimeException - subclass if the API call fails

      • listInAppTemplates

        public MarketingListInAppTemplatesResponse listInAppTemplates​(MarketingListInAppTemplatesRequest request,
                                                              java.util.Optional<Options> options)
        List In-App Templates
        Parameters:
        request - The request object containing all the parameters for the API call.
        options - additional options
        Returns:
        The response from the API call
        Throws:
        java.lang.RuntimeException - subclass if the API call fails

      • createInAppTemplate

        public MarketingCreateInAppTemplateResponse createInAppTemplate​(java.lang.String xAccountId,
                                                                MarketingCreateInAppTemplateRequestDto marketingCreateInAppTemplateRequestDto)
        Create In-App Template
        Parameters:
        xAccountId - The account identifier
        marketingCreateInAppTemplateRequestDto -
        Returns:
        The response from the API call
        Throws:
        java.lang.RuntimeException - subclass if the API call fails

      • createInAppTemplate

        public MarketingCreateInAppTemplateResponse createInAppTemplate​(java.lang.String xAccountId,
                                                                MarketingCreateInAppTemplateRequestDto marketingCreateInAppTemplateRequestDto,
                                                                java.util.Optional<Options> options)
        Create In-App Template
        Parameters:
        xAccountId - The account identifier
        marketingCreateInAppTemplateRequestDto -
        options - additional options
        Returns:
        The response from the API call
        Throws:
        java.lang.RuntimeException - subclass if the API call fails

      • getInAppTemplate

        public MarketingGetInAppTemplateResponse getInAppTemplate​(MarketingGetInAppTemplateRequest request)
        Get In-App Template
        Parameters:
        request - The request object containing all the parameters for the API call.
        Returns:
        The response from the API call
        Throws:
        java.lang.RuntimeException - subclass if the API call fails

      • getInAppTemplate

        public MarketingGetInAppTemplateResponse getInAppTemplate​(MarketingGetInAppTemplateRequest request,
                                                          java.util.Optional<Options> options)
        Get In-App Template
        Parameters:
        request - The request object containing all the parameters for the API call.
        options - additional options
        Returns:
        The response from the API call
        Throws:
        java.lang.RuntimeException - subclass if the API call fails

      • updateInAppTemplate

        public MarketingUpdateInAppTemplateResponse updateInAppTemplate​(java.lang.String xAccountId,
                                                                java.lang.String id,
                                                                MarketingCreateInAppTemplateRequestDto marketingCreateInAppTemplateRequestDto)
        Update In-App Template
        Parameters:
        xAccountId - The account identifier
        id -
        marketingCreateInAppTemplateRequestDto -
        Returns:
        The response from the API call
        Throws:
        java.lang.RuntimeException - subclass if the API call fails

      • updateInAppTemplate

        public MarketingUpdateInAppTemplateResponse updateInAppTemplate​(java.lang.String xAccountId,
                                                                java.lang.String id,
                                                                MarketingCreateInAppTemplateRequestDto marketingCreateInAppTemplateRequestDto,
                                                                java.util.Optional<Options> options)
        Update In-App Template
        Parameters:
        xAccountId - The account identifier
        id -
        marketingCreateInAppTemplateRequestDto -
        options - additional options
        Returns:
        The response from the API call
        Throws:
        java.lang.RuntimeException - subclass if the API call fails

      • listSmsTemplates

        public MarketingListSmsTemplatesResponse listSmsTemplates​(MarketingListSmsTemplatesRequest request)
        List SMS Templates
        Parameters:
        request - The request object containing all the parameters for the API call.
        Returns:
        The response from the API call
        Throws:
        java.lang.RuntimeException - subclass if the API call fails

      • listSmsTemplates

        public MarketingListSmsTemplatesResponse listSmsTemplates​(MarketingListSmsTemplatesRequest request,
                                                          java.util.Optional<Options> options)
        List SMS Templates
        Parameters:
        request - The request object containing all the parameters for the API call.
        options - additional options
        Returns:
        The response from the API call
        Throws:
        java.lang.RuntimeException - subclass if the API call fails

      • createSmsTemplate

        public MarketingCreateSmsTemplateResponse createSmsTemplate​(java.lang.String xAccountId,
                                                            MarketingCreateSmsTemplateRequestDto marketingCreateSmsTemplateRequestDto)
        Create SMS Template
        Parameters:
        xAccountId - The account identifier
        marketingCreateSmsTemplateRequestDto -
        Returns:
        The response from the API call
        Throws:
        java.lang.RuntimeException - subclass if the API call fails

      • createSmsTemplate

        public MarketingCreateSmsTemplateResponse createSmsTemplate​(java.lang.String xAccountId,
                                                            MarketingCreateSmsTemplateRequestDto marketingCreateSmsTemplateRequestDto,
                                                            java.util.Optional<Options> options)
        Create SMS Template
        Parameters:
        xAccountId - The account identifier
        marketingCreateSmsTemplateRequestDto -
        options - additional options
        Returns:
        The response from the API call
        Throws:
        java.lang.RuntimeException - subclass if the API call fails

      • getSmsTemplate

        public MarketingGetSmsTemplateResponse getSmsTemplate​(MarketingGetSmsTemplateRequest request)
        Get SMS Template
        Parameters:
        request - The request object containing all the parameters for the API call.
        Returns:
        The response from the API call
        Throws:
        java.lang.RuntimeException - subclass if the API call fails

      • getSmsTemplate

        public MarketingGetSmsTemplateResponse getSmsTemplate​(MarketingGetSmsTemplateRequest request,
                                                      java.util.Optional<Options> options)
        Get SMS Template
        Parameters:
        request - The request object containing all the parameters for the API call.
        options - additional options
        Returns:
        The response from the API call
        Throws:
        java.lang.RuntimeException - subclass if the API call fails

      • updateSmsTemplate

        public MarketingUpdateSmsTemplateResponse updateSmsTemplate​(java.lang.String xAccountId,
                                                            java.lang.String id,
                                                            MarketingCreateSmsTemplateRequestDto marketingCreateSmsTemplateRequestDto)
        Update SMS Template
        Parameters:
        xAccountId - The account identifier
        id -
        marketingCreateSmsTemplateRequestDto -
        Returns:
        The response from the API call
        Throws:
        java.lang.RuntimeException - subclass if the API call fails

      • updateSmsTemplate

        public MarketingUpdateSmsTemplateResponse updateSmsTemplate​(java.lang.String xAccountId,
                                                            java.lang.String id,
                                                            MarketingCreateSmsTemplateRequestDto marketingCreateSmsTemplateRequestDto,
                                                            java.util.Optional<Options> options)
        Update SMS Template
        Parameters:
        xAccountId - The account identifier
        id -
        marketingCreateSmsTemplateRequestDto -
        options - additional options
        Returns:
        The response from the API call
        Throws:
        java.lang.RuntimeException - subclass if the API call fails

      • listOmniChannelTemplates

        @Deprecated
public MarketingListOmniChannelTemplatesRequestBuilder listOmniChannelTemplates()
        Deprecated.
        method: This will be removed in a future release, please migrate away from it as soon as possible.
        List Omni-Channel Templates
        Returns:
        The call builder

      • listOmniChannelTemplates

        @Deprecated
public MarketingListOmniChannelTemplatesResponse listOmniChannelTemplates​(MarketingListOmniChannelTemplatesRequest request)
        Deprecated.
        method: This will be removed in a future release, please migrate away from it as soon as possible.
        List Omni-Channel Templates
        Parameters:
        request - The request object containing all the parameters for the API call.
        Returns:
        The response from the API call
        Throws:
        java.lang.RuntimeException - subclass if the API call fails

      • listOmniChannelTemplates

        @Deprecated
public MarketingListOmniChannelTemplatesResponse listOmniChannelTemplates​(MarketingListOmniChannelTemplatesRequest request,
                                                                          java.util.Optional<Options> options)
        Deprecated.
        method: This will be removed in a future release, please migrate away from it as soon as possible.
        List Omni-Channel Templates
        Parameters:
        request - The request object containing all the parameters for the API call.
        options - additional options
        Returns:
        The response from the API call
        Throws:
        java.lang.RuntimeException - subclass if the API call fails

      • createOmniChannelTemplate

        @Deprecated
public MarketingCreateOmniChannelTemplateRequestBuilder createOmniChannelTemplate()
        Deprecated.
        method: This will be removed in a future release, please migrate away from it as soon as possible.
        Create Omni-Channel Template
        Returns:
        The call builder

      • createOmniChannelTemplate

        @Deprecated
public MarketingCreateOmniChannelTemplateResponse createOmniChannelTemplate​(java.lang.String xAccountId,
                                                                            MarketingCreateTemplateRequestDto marketingCreateTemplateRequestDto)
        Deprecated.
        method: This will be removed in a future release, please migrate away from it as soon as possible.
        Create Omni-Channel Template
        Parameters:
        xAccountId - The account identifier
        marketingCreateTemplateRequestDto -
        Returns:
        The response from the API call
        Throws:
        java.lang.RuntimeException - subclass if the API call fails

      • createOmniChannelTemplate

        @Deprecated
public MarketingCreateOmniChannelTemplateResponse createOmniChannelTemplate​(java.lang.String xAccountId,
                                                                            MarketingCreateTemplateRequestDto marketingCreateTemplateRequestDto,
                                                                            java.util.Optional<Options> options)
        Deprecated.
        method: This will be removed in a future release, please migrate away from it as soon as possible.
        Create Omni-Channel Template
        Parameters:
        xAccountId - The account identifier
        marketingCreateTemplateRequestDto -
        options - additional options
        Returns:
        The response from the API call
        Throws:
        java.lang.RuntimeException - subclass if the API call fails

      • getOmniChannelTemplate

        @Deprecated
public MarketingGetOmniChannelTemplateRequestBuilder getOmniChannelTemplate()
        Deprecated.
        method: This will be removed in a future release, please migrate away from it as soon as possible.
        Get Omni-Channel Template
        Returns:
        The call builder

      • getOmniChannelTemplate

        @Deprecated
public MarketingGetOmniChannelTemplateResponse getOmniChannelTemplate​(MarketingGetOmniChannelTemplateRequest request)
        Deprecated.
        method: This will be removed in a future release, please migrate away from it as soon as possible.
        Get Omni-Channel Template
        Parameters:
        request - The request object containing all the parameters for the API call.
        Returns:
        The response from the API call
        Throws:
        java.lang.RuntimeException - subclass if the API call fails

      • getOmniChannelTemplate

        @Deprecated
public MarketingGetOmniChannelTemplateResponse getOmniChannelTemplate​(MarketingGetOmniChannelTemplateRequest request,
                                                                      java.util.Optional<Options> options)
        Deprecated.
        method: This will be removed in a future release, please migrate away from it as soon as possible.
        Get Omni-Channel Template
        Parameters:
        request - The request object containing all the parameters for the API call.
        options - additional options
        Returns:
        The response from the API call
        Throws:
        java.lang.RuntimeException - subclass if the API call fails

      • updateOmniChannelTemplate

        @Deprecated
public MarketingUpdateOmniChannelTemplateRequestBuilder updateOmniChannelTemplate()
        Deprecated.
        method: This will be removed in a future release, please migrate away from it as soon as possible.
        Update Omni-Channel Template
        Returns:
        The call builder

      • updateOmniChannelTemplate

        @Deprecated
public MarketingUpdateOmniChannelTemplateResponse updateOmniChannelTemplate​(java.lang.String xAccountId,
                                                                            java.lang.String id,
                                                                            MarketingCreateTemplateRequestDto marketingCreateTemplateRequestDto)
        Deprecated.
        method: This will be removed in a future release, please migrate away from it as soon as possible.
        Update Omni-Channel Template
        Parameters:
        xAccountId - The account identifier
        id -
        marketingCreateTemplateRequestDto -
        Returns:
        The response from the API call
        Throws:
        java.lang.RuntimeException - subclass if the API call fails

      • updateOmniChannelTemplate

        @Deprecated
public MarketingUpdateOmniChannelTemplateResponse updateOmniChannelTemplate​(java.lang.String xAccountId,
                                                                            java.lang.String id,
                                                                            MarketingCreateTemplateRequestDto marketingCreateTemplateRequestDto,
                                                                            java.util.Optional<Options> options)
        Deprecated.
        method: This will be removed in a future release, please migrate away from it as soon as possible.
        Update Omni-Channel Template
        Parameters:
        xAccountId - The account identifier
        id -
        marketingCreateTemplateRequestDto -
        options - additional options
        Returns:
        The response from the API call
        Throws:
        java.lang.RuntimeException - subclass if the API call fails

      • listPushTemplates

        public MarketingListPushTemplatesResponse listPushTemplates​(MarketingListPushTemplatesRequest request)
        List Push Templates
        Parameters:
        request - The request object containing all the parameters for the API call.
        Returns:
        The response from the API call
        Throws:
        java.lang.RuntimeException - subclass if the API call fails

      • listPushTemplates

        public MarketingListPushTemplatesResponse listPushTemplates​(MarketingListPushTemplatesRequest request,
                                                            java.util.Optional<Options> options)
        List Push Templates
        Parameters:
        request - The request object containing all the parameters for the API call.
        options - additional options
        Returns:
        The response from the API call
        Throws:
        java.lang.RuntimeException - subclass if the API call fails

      • createPushTemplate

        public MarketingCreatePushTemplateResponse createPushTemplate​(java.lang.String xAccountId,
                                                              MarketingCreatePushTemplateRequestDto marketingCreatePushTemplateRequestDto)
        Create Push Template
        Parameters:
        xAccountId - The account identifier
        marketingCreatePushTemplateRequestDto -
        Returns:
        The response from the API call
        Throws:
        java.lang.RuntimeException - subclass if the API call fails

      • createPushTemplate

        public MarketingCreatePushTemplateResponse createPushTemplate​(java.lang.String xAccountId,
                                                              MarketingCreatePushTemplateRequestDto marketingCreatePushTemplateRequestDto,
                                                              java.util.Optional<Options> options)
        Create Push Template
        Parameters:
        xAccountId - The account identifier
        marketingCreatePushTemplateRequestDto -
        options - additional options
        Returns:
        The response from the API call
        Throws:
        java.lang.RuntimeException - subclass if the API call fails

      • getPushTemplate

        public MarketingGetPushTemplateResponse getPushTemplate​(MarketingGetPushTemplateRequest request)
        Get Push Template
        Parameters:
        request - The request object containing all the parameters for the API call.
        Returns:
        The response from the API call
        Throws:
        java.lang.RuntimeException - subclass if the API call fails

      • getPushTemplate

        public MarketingGetPushTemplateResponse getPushTemplate​(MarketingGetPushTemplateRequest request,
                                                        java.util.Optional<Options> options)
        Get Push Template
        Parameters:
        request - The request object containing all the parameters for the API call.
        options - additional options
        Returns:
        The response from the API call
        Throws:
        java.lang.RuntimeException - subclass if the API call fails

      • updatePushTemplate

        public MarketingUpdatePushTemplateResponse updatePushTemplate​(java.lang.String xAccountId,
                                                              java.lang.String id,
                                                              MarketingCreatePushTemplateRequestDto marketingCreatePushTemplateRequestDto)
        Update Push Template
        Parameters:
        xAccountId - The account identifier
        id -
        marketingCreatePushTemplateRequestDto -
        Returns:
        The response from the API call
        Throws:
        java.lang.RuntimeException - subclass if the API call fails

      • updatePushTemplate

        public MarketingUpdatePushTemplateResponse updatePushTemplate​(java.lang.String xAccountId,
                                                              java.lang.String id,
                                                              MarketingCreatePushTemplateRequestDto marketingCreatePushTemplateRequestDto,
                                                              java.util.Optional<Options> options)
        Update Push Template
        Parameters:
        xAccountId - The account identifier
        id -
        marketingCreatePushTemplateRequestDto -
        options - additional options
        Returns:
        The response from the API call
        Throws:
        java.lang.RuntimeException - subclass if the API call fails

      • listCampaigns

        public MarketingListCampaignsResponse listCampaigns​(MarketingListCampaignsRequest request)
        List campaigns
        Parameters:
        request - The request object containing all the parameters for the API call.
        Returns:
        The response from the API call
        Throws:
        java.lang.RuntimeException - subclass if the API call fails

      • listCampaigns

        public MarketingListCampaignsResponse listCampaigns​(MarketingListCampaignsRequest request,
                                                    java.util.Optional<Options> options)
        List campaigns
        Parameters:
        request - The request object containing all the parameters for the API call.
        options - additional options
        Returns:
        The response from the API call
        Throws:
        java.lang.RuntimeException - subclass if the API call fails

      • getCampaign

        public MarketingGetCampaignResponse getCampaign​(MarketingGetCampaignRequest request)
        Get campaign
        Parameters:
        request - The request object containing all the parameters for the API call.
        Returns:
        The response from the API call
        Throws:
        java.lang.RuntimeException - subclass if the API call fails

      • getCampaign

        public MarketingGetCampaignResponse getCampaign​(MarketingGetCampaignRequest request,
                                                java.util.Optional<Options> options)
        Get campaign
        Parameters:
        request - The request object containing all the parameters for the API call.
        options - additional options
        Returns:
        The response from the API call
        Throws:
        java.lang.RuntimeException - subclass if the API call fails

      • listContentBlocks

        public MarketingListContentBlocksResponse listContentBlocks​(MarketingListContentBlocksRequest request)
        List Content Blocks
        Parameters:
        request - The request object containing all the parameters for the API call.
        Returns:
        The response from the API call
        Throws:
        java.lang.RuntimeException - subclass if the API call fails

      • listContentBlocks

        public MarketingListContentBlocksResponse listContentBlocks​(MarketingListContentBlocksRequest request,
                                                            java.util.Optional<Options> options)
        List Content Blocks
        Parameters:
        request - The request object containing all the parameters for the API call.
        options - additional options
        Returns:
        The response from the API call
        Throws:
        java.lang.RuntimeException - subclass if the API call fails

      • createContentBlock

        public MarketingCreateContentBlockResponse createContentBlock​(java.lang.String xAccountId,
                                                              MarketingCreateContentBlocksRequestDto marketingCreateContentBlocksRequestDto)
        Create Content Block
        Parameters:
        xAccountId - The account identifier
        marketingCreateContentBlocksRequestDto -
        Returns:
        The response from the API call
        Throws:
        java.lang.RuntimeException - subclass if the API call fails

      • createContentBlock

        public MarketingCreateContentBlockResponse createContentBlock​(java.lang.String xAccountId,
                                                              MarketingCreateContentBlocksRequestDto marketingCreateContentBlocksRequestDto,
                                                              java.util.Optional<Options> options)
        Create Content Block
        Parameters:
        xAccountId - The account identifier
        marketingCreateContentBlocksRequestDto -
        options - additional options
        Returns:
        The response from the API call
        Throws:
        java.lang.RuntimeException - subclass if the API call fails

      • getContentBlock

        public MarketingGetContentBlockResponse getContentBlock​(MarketingGetContentBlockRequest request)
        Get Content Blocks
        Parameters:
        request - The request object containing all the parameters for the API call.
        Returns:
        The response from the API call
        Throws:
        java.lang.RuntimeException - subclass if the API call fails

      • getContentBlock

        public MarketingGetContentBlockResponse getContentBlock​(MarketingGetContentBlockRequest request,
                                                        java.util.Optional<Options> options)
        Get Content Blocks
        Parameters:
        request - The request object containing all the parameters for the API call.
        options - additional options
        Returns:
        The response from the API call
        Throws:
        java.lang.RuntimeException - subclass if the API call fails

      • updateContentBlock

        public MarketingUpdateContentBlockResponse updateContentBlock​(java.lang.String xAccountId,
                                                              java.lang.String id,
                                                              MarketingCreateContentBlocksRequestDto marketingCreateContentBlocksRequestDto)
        Update Content Block
        Parameters:
        xAccountId - The account identifier
        id -
        marketingCreateContentBlocksRequestDto -
        Returns:
        The response from the API call
        Throws:
        java.lang.RuntimeException - subclass if the API call fails

      • updateContentBlock

        public MarketingUpdateContentBlockResponse updateContentBlock​(java.lang.String xAccountId,
                                                              java.lang.String id,
                                                              MarketingCreateContentBlocksRequestDto marketingCreateContentBlocksRequestDto,
                                                              java.util.Optional<Options> options)
        Update Content Block
        Parameters:
        xAccountId - The account identifier
        id -
        marketingCreateContentBlocksRequestDto -
        options - additional options
        Returns:
        The response from the API call
        Throws:
        java.lang.RuntimeException - subclass if the API call fails