README.md

Marketing

Available Operations

• create_email_template - Create email template
• create_omni_channel_template - Create omni-channel template
• create_push_template - Create push template
• get_campaign - Get campaign
• get_email_template - Get email template
• get_omni_channel_template - Get omni-channel template
• get_push_template - Get push template
• list_campaigns - List campaigns
• list_email_templates - List email templates
• list_omni_channel_templates - List omni-channel templates
• list_push_templates - List push templates
• update_email_template - Update email template
• update_omni_channel_template - Update omni-channel template
• update_push_template - Update push template

create_email_template

Create email template

Example Usage

require 'stackone_client'


s = ::StackOne::StackOne.new
s.config_security(
  ::StackOne::Shared::Security.new(
    password: "<YOUR_PASSWORD_HERE>",
  )
)

    
res = s.marketing.create_email_template(marketing_create_email_template_request_dto=::StackOne::Shared::MarketingCreateEmailTemplateRequestDto.new(
    messages: [
      ::StackOne::Shared::EmailMessages.new(
        id: "8187e5da-dc77-475e-9949-af0f1fa4e4e3",
        message_type: ::StackOne::Shared::MessageType.new(
          source_value: "Email",
        ),
        remote_id: "8187e5da-dc77-475e-9949-af0f1fa4e4e3",
      ),
    ],
    passthrough: {
      "Non": "<value>",
    },
  ), x_account_id="<value>")

if ! res.create_result.nil?
  # handle response
end

Parameters

Parameter	Type	Required	Description
marketing_create_email_template_request_dto	::StackOne::Shared::MarketingCreateEmailTemplateRequestDto	✔️	N/A
x_account_id	::String	✔️	The account identifier

Response

T.nilable(::StackOne::Operations::MarketingCreateEmailTemplateResponse)

create_omni_channel_template

Create omni-channel template

Example Usage

require 'stackone_client'


s = ::StackOne::StackOne.new
s.config_security(
  ::StackOne::Shared::Security.new(
    password: "<YOUR_PASSWORD_HERE>",
  )
)

    
res = s.marketing.create_omni_channel_template(marketing_create_template_request_dto=::StackOne::Shared::MarketingCreateTemplateRequestDto.new(
    messages: [
      ::StackOne::Shared::Message.new(
        id: "8187e5da-dc77-475e-9949-af0f1fa4e4e3",
        message_type: ::StackOne::Shared::MessageMessageType.new(
          source_value: "Email",
        ),
        remote_id: "8187e5da-dc77-475e-9949-af0f1fa4e4e3",
      ),
    ],
    passthrough: {
      "Cargo": "<value>",
    },
  ), x_account_id="<value>")

if ! res.create_result.nil?
  # handle response
end

Parameters

Parameter	Type	Required	Description
marketing_create_template_request_dto	::StackOne::Shared::MarketingCreateTemplateRequestDto	✔️	N/A
x_account_id	::String	✔️	The account identifier

Response

T.nilable(::StackOne::Operations::MarketingCreateOmniChannelTemplateResponse)

create_push_template

Create push template

Example Usage

require 'stackone_client'


s = ::StackOne::StackOne.new
s.config_security(
  ::StackOne::Shared::Security.new(
    password: "<YOUR_PASSWORD_HERE>",
  )
)

    
res = s.marketing.create_push_template(marketing_create_push_template_request_dto=::StackOne::Shared::MarketingCreatePushTemplateRequestDto.new(
    messages: [
      ::StackOne::Shared::PushMessages.new(
        id: "8187e5da-dc77-475e-9949-af0f1fa4e4e3",
        message_type: ::StackOne::Shared::PushMessagesMessageType.new(
          source_value: "Email",
        ),
        remote_id: "8187e5da-dc77-475e-9949-af0f1fa4e4e3",
      ),
    ],
    passthrough: {
      "turban": "<value>",
    },
  ), x_account_id="<value>")

if ! res.create_result.nil?
  # handle response
end

Parameters

Parameter	Type	Required	Description
marketing_create_push_template_request_dto	::StackOne::Shared::MarketingCreatePushTemplateRequestDto	✔️	N/A
x_account_id	::String	✔️	The account identifier

Response

T.nilable(::StackOne::Operations::MarketingCreatePushTemplateResponse)

get_campaign

Get campaign

Example Usage

require 'stackone_client'


s = ::StackOne::StackOne.new
s.config_security(
  ::StackOne::Shared::Security.new(
    password: "<YOUR_PASSWORD_HERE>",
  )
)


req = ::StackOne::Operations::MarketingGetCampaignRequest.new(
  fields_: "id,name,created_at,updated_at,description,schedule_type,status,channels,first_sent_at,last_sent_at,tags,messages",
  id: "<id>",
  x_account_id: "<value>",
)
    
res = s.marketing.get_campaign(req)

if ! res.campaign_result.nil?
  # handle response
end

Parameters

Parameter	Type	Required	Description
request	::StackOne::Operations::MarketingGetCampaignRequest	✔️	The request object to use for the request.

Response

T.nilable(::StackOne::Operations::MarketingGetCampaignResponse)

get_email_template

Get email template

Example Usage

require 'stackone_client'


s = ::StackOne::StackOne.new
s.config_security(
  ::StackOne::Shared::Security.new(
    password: "<YOUR_PASSWORD_HERE>",
  )
)


req = ::StackOne::Operations::MarketingGetEmailTemplateRequest.new(
  fields_: "id,name,messages,created_at,updated_at,tags",
  id: "<id>",
  x_account_id: "<value>",
)
    
res = s.marketing.get_email_template(req)

if ! res.template_result.nil?
  # handle response
end

Parameters

Parameter	Type	Required	Description
request	::StackOne::Operations::MarketingGetEmailTemplateRequest	✔️	The request object to use for the request.

Response

T.nilable(::StackOne::Operations::MarketingGetEmailTemplateResponse)

get_omni_channel_template

Get omni-channel template

Example Usage

require 'stackone_client'


s = ::StackOne::StackOne.new
s.config_security(
  ::StackOne::Shared::Security.new(
    password: "<YOUR_PASSWORD_HERE>",
  )
)


req = ::StackOne::Operations::MarketingGetOmniChannelTemplateRequest.new(
  fields_: "id,name,messages,created_at,updated_at,tags",
  id: "<id>",
  x_account_id: "<value>",
)
    
res = s.marketing.get_omni_channel_template(req)

if ! res.template_result.nil?
  # handle response
end

Parameters

Parameter	Type	Required	Description
request	::StackOne::Operations::MarketingGetOmniChannelTemplateRequest	✔️	The request object to use for the request.

Response

T.nilable(::StackOne::Operations::MarketingGetOmniChannelTemplateResponse)

get_push_template

Get push template

Example Usage

require 'stackone_client'


s = ::StackOne::StackOne.new
s.config_security(
  ::StackOne::Shared::Security.new(
    password: "<YOUR_PASSWORD_HERE>",
  )
)


req = ::StackOne::Operations::MarketingGetPushTemplateRequest.new(
  fields_: "id,name,messages,created_at,updated_at,tags",
  id: "<id>",
  x_account_id: "<value>",
)
    
res = s.marketing.get_push_template(req)

if ! res.template_result.nil?
  # handle response
end

Parameters

Parameter	Type	Required	Description
request	::StackOne::Operations::MarketingGetPushTemplateRequest	✔️	The request object to use for the request.

Response

T.nilable(::StackOne::Operations::MarketingGetPushTemplateResponse)

list_campaigns

List campaigns

Example Usage

require 'stackone_client'


s = ::StackOne::StackOne.new
s.config_security(
  ::StackOne::Shared::Security.new(
    password: "<YOUR_PASSWORD_HERE>",
  )
)


req = ::StackOne::Operations::MarketingListCampaignsRequest.new(
  fields_: "id,name,created_at,updated_at,description,schedule_type,status,channels,first_sent_at,last_sent_at,tags,messages",
  filter: ::StackOne::Operations::MarketingListCampaignsQueryParamFilter.new(
    updated_after: "2020-01-01T00:00:00.000Z",
  ),
  x_account_id: "<value>",
)
    
res = s.marketing.list_campaigns(req)

if ! res.campaigns_paginated.nil?
  # handle response
end

Parameters

Parameter	Type	Required	Description
request	::StackOne::Operations::MarketingListCampaignsRequest	✔️	The request object to use for the request.

Response

T.nilable(::StackOne::Operations::MarketingListCampaignsResponse)

list_email_templates

List email templates

Example Usage

require 'stackone_client'


s = ::StackOne::StackOne.new
s.config_security(
  ::StackOne::Shared::Security.new(
    password: "<YOUR_PASSWORD_HERE>",
  )
)


req = ::StackOne::Operations::MarketingListEmailTemplatesRequest.new(
  fields_: "id,name,messages,created_at,updated_at,tags",
  filter: ::StackOne::Operations::MarketingListEmailTemplatesQueryParamFilter.new(
    updated_after: "2020-01-01T00:00:00.000Z",
  ),
  x_account_id: "<value>",
)
    
res = s.marketing.list_email_templates(req)

if ! res.templates_paginated.nil?
  # handle response
end

Parameters

Parameter	Type	Required	Description
request	::StackOne::Operations::MarketingListEmailTemplatesRequest	✔️	The request object to use for the request.

Response

T.nilable(::StackOne::Operations::MarketingListEmailTemplatesResponse)

list_omni_channel_templates

List omni-channel templates

Example Usage

require 'stackone_client'


s = ::StackOne::StackOne.new
s.config_security(
  ::StackOne::Shared::Security.new(
    password: "<YOUR_PASSWORD_HERE>",
  )
)


req = ::StackOne::Operations::MarketingListOmniChannelTemplatesRequest.new(
  fields_: "id,name,messages,created_at,updated_at,tags",
  filter: ::StackOne::Operations::MarketingListOmniChannelTemplatesQueryParamFilter.new(
    updated_after: "2020-01-01T00:00:00.000Z",
  ),
  x_account_id: "<value>",
)
    
res = s.marketing.list_omni_channel_templates(req)

if ! res.templates_paginated.nil?
  # handle response
end

Parameters

Parameter	Type	Required	Description
request	::StackOne::Operations::MarketingListOmniChannelTemplatesRequest	✔️	The request object to use for the request.

Response

T.nilable(::StackOne::Operations::MarketingListOmniChannelTemplatesResponse)

list_push_templates

List push templates

Example Usage

require 'stackone_client'


s = ::StackOne::StackOne.new
s.config_security(
  ::StackOne::Shared::Security.new(
    password: "<YOUR_PASSWORD_HERE>",
  )
)


req = ::StackOne::Operations::MarketingListPushTemplatesRequest.new(
  fields_: "id,name,messages,created_at,updated_at,tags",
  filter: ::StackOne::Operations::MarketingListPushTemplatesQueryParamFilter.new(
    updated_after: "2020-01-01T00:00:00.000Z",
  ),
  x_account_id: "<value>",
)
    
res = s.marketing.list_push_templates(req)

if ! res.templates_paginated.nil?
  # handle response
end

Parameters

Parameter	Type	Required	Description
request	::StackOne::Operations::MarketingListPushTemplatesRequest	✔️	The request object to use for the request.

Response

T.nilable(::StackOne::Operations::MarketingListPushTemplatesResponse)

update_email_template

Update email template

Example Usage

require 'stackone_client'


s = ::StackOne::StackOne.new
s.config_security(
  ::StackOne::Shared::Security.new(
    password: "<YOUR_PASSWORD_HERE>",
  )
)

    
res = s.marketing.update_email_template(marketing_create_email_template_request_dto=::StackOne::Shared::MarketingCreateEmailTemplateRequestDto.new(
    messages: [
      ::StackOne::Shared::EmailMessages.new(
        id: "8187e5da-dc77-475e-9949-af0f1fa4e4e3",
        message_type: ::StackOne::Shared::MessageType.new(
          source_value: "Email",
        ),
        remote_id: "8187e5da-dc77-475e-9949-af0f1fa4e4e3",
      ),
    ],
    passthrough: {
      "strategize": "<value>",
    },
  ), id="<value>", x_account_id="<value>")

if ! res.create_result.nil?
  # handle response
end

Parameters

Parameter	Type	Required	Description
marketing_create_email_template_request_dto	::StackOne::Shared::MarketingCreateEmailTemplateRequestDto	✔️	N/A
id	::String	✔️	N/A
x_account_id	::String	✔️	The account identifier

Response

T.nilable(::StackOne::Operations::MarketingUpdateEmailTemplateResponse)

update_omni_channel_template

Update omni-channel template

Example Usage

require 'stackone_client'


s = ::StackOne::StackOne.new
s.config_security(
  ::StackOne::Shared::Security.new(
    password: "<YOUR_PASSWORD_HERE>",
  )
)

    
res = s.marketing.update_omni_channel_template(marketing_create_template_request_dto=::StackOne::Shared::MarketingCreateTemplateRequestDto.new(
    messages: [
      ::StackOne::Shared::Message.new(
        id: "8187e5da-dc77-475e-9949-af0f1fa4e4e3",
        message_type: ::StackOne::Shared::MessageMessageType.new(
          source_value: "Email",
        ),
        remote_id: "8187e5da-dc77-475e-9949-af0f1fa4e4e3",
      ),
    ],
    passthrough: {
      "Edina": "<value>",
    },
  ), id="<value>", x_account_id="<value>")

if ! res.create_result.nil?
  # handle response
end

Parameters

Parameter	Type	Required	Description
marketing_create_template_request_dto	::StackOne::Shared::MarketingCreateTemplateRequestDto	✔️	N/A
id	::String	✔️	N/A
x_account_id	::String	✔️	The account identifier

Response

T.nilable(::StackOne::Operations::MarketingUpdateOmniChannelTemplateResponse)

update_push_template

Update push template

Example Usage

require 'stackone_client'


s = ::StackOne::StackOne.new
s.config_security(
  ::StackOne::Shared::Security.new(
    password: "<YOUR_PASSWORD_HERE>",
  )
)

    
res = s.marketing.update_push_template(marketing_create_push_template_request_dto=::StackOne::Shared::MarketingCreatePushTemplateRequestDto.new(
    messages: [
      ::StackOne::Shared::PushMessages.new(
        id: "8187e5da-dc77-475e-9949-af0f1fa4e4e3",
        message_type: ::StackOne::Shared::PushMessagesMessageType.new(
          source_value: "Email",
        ),
        remote_id: "8187e5da-dc77-475e-9949-af0f1fa4e4e3",
      ),
    ],
    passthrough: {
      "tightly": "<value>",
    },
  ), id="<value>", x_account_id="<value>")

if ! res.create_result.nil?
  # handle response
end

Parameters

Parameter	Type	Required	Description
marketing_create_push_template_request_dto	::StackOne::Shared::MarketingCreatePushTemplateRequestDto	✔️	N/A
id	::String	✔️	N/A
x_account_id	::String	✔️	The account identifier

Response

T.nilable(::StackOne::Operations::MarketingUpdatePushTemplateResponse)