zen_ex v0.4.2 ZenEx.Model.DynamicContent

Provides functions to operate Zendesk Dynamic content.

Link to this section Summary

Functions

Create dynamic_content.

Delete dynamic_content specified by id.

List dynamic_contents.

Show dynamic_content specified by id.

Update dynamic_content specified by id. This function won't change variants.

Link to this section Functions

Link to this function

create(dynamic_content)

Specs

create(%ZenEx.Entity.DynamicContent{
  created_at: term(),
  default_locale_id: term(),
  id: term(),
  name: term(),
  outdated: term(),
  placeholder: term(),
  updated_at: term(),
  url: term(),
  variants: term()
}) :: %ZenEx.Entity.DynamicContent{
  created_at: term(),
  default_locale_id: term(),
  id: term(),
  name: term(),
  outdated: term(),
  placeholder: term(),
  updated_at: term(),
  url: term(),
  variants: term()
}

Create dynamic_content.

Examples

iex> ZenEx.Model.DynamicContent.create(%ZenEx.Entity.DynamicContent{default_locale_id: xxx, variants: [%ZenEx.Entity.DynamicContent.Variant{...}, ...], ...})
%ZenEx.Entity.DynamicContent{id: xxx, default_locale_id: xxx, ...}

Specs

destroy(integer()) :: :ok | :error

Delete dynamic_content specified by id.

Examples

iex> ZenEx.Model.DynamicContent.destroy(1)
:ok
Link to this function

list(opts \\ [])

List dynamic_contents.

Examples

iex> ZenEx.Model.DynamicContent.list
%ZenEx.Collection{}

Specs

show(integer()) :: %ZenEx.Entity.DynamicContent{
  created_at: term(),
  default_locale_id: term(),
  id: term(),
  name: term(),
  outdated: term(),
  placeholder: term(),
  updated_at: term(),
  url: term(),
  variants: term()
}

Show dynamic_content specified by id.

Examples

iex> ZenEx.Model.DynamicContent.show(xxx)
%ZenEx.Entity.DynamicContent{id: xxx, default_locale_id: xxx, variants: [%ZenEx.Entity.DynamicContent.Variant{...}, ...], ...}
Link to this function

update(dynamic_content)

Specs

update(%ZenEx.Entity.DynamicContent{
  created_at: term(),
  default_locale_id: term(),
  id: term(),
  name: term(),
  outdated: term(),
  placeholder: term(),
  updated_at: term(),
  url: term(),
  variants: term()
}) :: %ZenEx.Entity.DynamicContent{
  created_at: term(),
  default_locale_id: term(),
  id: term(),
  name: term(),
  outdated: term(),
  placeholder: term(),
  updated_at: term(),
  url: term(),
  variants: term()
}

Update dynamic_content specified by id. This function won't change variants.

Examples

iex> ZenEx.Model.DynamicContent.update(%ZenEx.Entity.DynamicContent{id: xxx, default_locale_id: xxx, ...})
%ZenEx.Entity.DynamicContent{id: xxx, default_locale_id: xxx, ...}