Class: ClerkHttpClient::EmailSMSTemplatesApi

Inherits:

Object

• Object
• ClerkHttpClient::EmailSMSTemplatesApi

Defined in:

lib/clerk-http-client/api/email_sms_templates_api.rb

Instance Attribute Summary

• #api_client ⇒ Object

  Returns the value of attribute api_client.

Instance Method Summary

• #get_template(template_type, slug, opts = {}) ⇒ Template

  Retrieve a template Returns the details of a template.

• #get_template_list(template_type, opts = {}) ⇒ Array<Template>

  List all templates Returns a list of all templates.

• #get_template_list_with_http_info(template_type, opts = {}) ⇒ Array<(Array<Template>, Integer, Hash)>

  List all templates Returns a list of all templates.

• #get_template_with_http_info(template_type, slug, opts = {}) ⇒ Array<(Template, Integer, Hash)>

  Retrieve a template Returns the details of a template GET.

• #initialize(api_client = ApiClient.default) ⇒ EmailSMSTemplatesApi constructor

  A new instance of EmailSMSTemplatesApi.

• #preview_template(template_type, slug, opts = {}) ⇒ Object

  Preview changes to a template Returns a preview of a template for a given template_type, slug and body.

• #preview_template_with_http_info(template_type, slug, opts = {}) ⇒ Array<(Object, Integer, Hash)>

  Preview changes to a template Returns a preview of a template for a given template_type, slug and body POST.

• #revert_template(template_type, slug, opts = {}) ⇒ Template

  Revert a template Reverts an updated template to its default state.

• #revert_template_with_http_info(template_type, slug, opts = {}) ⇒ Array<(Template, Integer, Hash)>

  Revert a template Reverts an updated template to its default state POST.

• #toggle_template_delivery(template_type, slug, opts = {}) ⇒ Template

  Toggle the delivery by Clerk for a template of a given type and slug Toggles the delivery by Clerk for a template of a given type and slug.

• #toggle_template_delivery_with_http_info(template_type, slug, opts = {}) ⇒ Array<(Template, Integer, Hash)>

  Toggle the delivery by Clerk for a template of a given type and slug Toggles the delivery by Clerk for a template of a given type and slug.

• #upsert_template(template_type, slug, opts = {}) ⇒ Template

  Update a template for a given type and slug Updates the existing template of the given type and slug.

• #upsert_template_with_http_info(template_type, slug, opts = {}) ⇒ Array<(Template, Integer, Hash)>

  Update a template for a given type and slug Updates the existing template of the given type and slug PUT.

Constructor Details

#initialize(api_client = ApiClient.default) ⇒ EmailSMSTemplatesApi

Returns a new instance of EmailSMSTemplatesApi.

# File 'lib/clerk-http-client/api/email_sms_templates_api.rb', line 19

def initialize(api_client = ApiClient.default)
  @api_client = api_client
end

Instance Attribute Details

#api_client ⇒ Object

Returns the value of attribute api_client.

# File 'lib/clerk-http-client/api/email_sms_templates_api.rb', line 17

def api_client
  @api_client
end

Instance Method Details

#get_template(template_type, slug, opts = {}) ⇒ Template

Retrieve a template Returns the details of a template

Parameters:

• template_type (String) —

  The type of templates to retrieve (email or SMS)

• slug (String) —

  The slug (i.e. machine-friendly name) of the template to retrieve

• opts (Hash) (defaults to: {}) —

  the optional parameters

Returns:

• (Template)

# File 'lib/clerk-http-client/api/email_sms_templates_api.rb', line 29

def get_template(template_type, slug, opts = {})
  data, _status_code, _headers = get_template_with_http_info(template_type, slug, opts)
  data
end

#get_template_list(template_type, opts = {}) ⇒ Array<Template>

List all templates Returns a list of all templates. The templates are returned sorted by position.

Parameters:

• template_type (String) —

  The type of templates to list (email or SMS)

• opts (Hash) (defaults to: {}) —

  the optional parameters

Returns:

• (Array<Template>)

# File 'lib/clerk-http-client/api/email_sms_templates_api.rb', line 104

def get_template_list(template_type, opts = {})
  data, _status_code, _headers = get_template_list_with_http_info(template_type, opts)
  data
end

#get_template_list_with_http_info(template_type, opts = {}) ⇒ Array<(Array<Template>, Integer, Hash)>

List all templates Returns a list of all templates. The templates are returned sorted by position. GET array

Parameters:

• template_type (String) —

  The type of templates to list (email or SMS)

• opts (Hash) (defaults to: {}) —

  the optional parameters

Returns:

• (Array<(Array<Template>, Integer, Hash)>) —

  Array