class RS4::ReusableTemplate

Attributes

created_at[RW]
creator[RW]
distribution_method[RW]
expires_in[RW]
filename[RW]
id[RW]
identity_method[RW]
kba[RW]
merge_field_components[RW]
name[RW]
page_image_urls[RW]
passcode[RW]
roles[RW]
shared_with[RW]
signer_sequencing[RW]
tags[RW]
thumbnail_url[RW]
updated_at[RW]
user_id[RW]

Public Class Methods

embed_document(template_guid, options = {}) click to toggle source
# File lib/rs4/reusable_template.rb, line 90
def embed_document(template_guid, options = {})
  path = "/public/v1/reusable_templates/#{template_guid}/embed_document"

  body = options

  response = RS4.configuration.request_handler.execute(path, :post, body)

  Rails.logger.info("RS4::ReusableTemplate::embed_document:: #{response.inspect}")

  unless response.is_a?(RS4::Error) || response.nil?
    # parsed_response = JSON.parse(response.read_body, symbolize_names: true)

    document_hash = response.dig(:document)

    return RS4::Document.new(document_hash)
  end
end
get_reusable_template(template_guid) click to toggle source
# File lib/rs4/reusable_template.rb, line 46
def get_reusable_template(template_guid)
  return unless template_guid

  path = "/public/v1/reusable_templates/#{template_guid}"

  response = RS4.configuration.request_handler.execute(path, :get)

  unless response.is_a?(RS4::Error) || response.nil?
    # parsed_response = JSON.parse(response.read_body, symbolize_names: true)

    template_hash = response.dig(:reusable_template)

    RS4::ReusableTemplate.new(template_hash)
  end
end
get_reusable_templates(options = {}) click to toggle source
# File lib/rs4/reusable_template.rb, line 62
def get_reusable_templates(options = {})
  base_path = '/public/v1/reusable_templates'

  query = CGI.unescape(options.to_query)

  path = query.empty? ? base_path : "#{base_path}?#{query}"

  RS4.configuration.request_handler.execute(path, :get)
end
new(options = {}) click to toggle source
# File lib/rs4/reusable_template.rb, line 23
def initialize(options = {})
  @id = options[:id]
  @name = name
  @creator = options[:creator]
  @expires_in = options[:expires_in]
  @signer_sequencing = options[:signer_sequencing]
  @shared_with = options[:shared_with]
  @distribution_method = options[:distribution_method]
  @identity_method = options[:identity_method]
  @kba = options[:kba]
  @passcode = options[:passcode]
  @filename = options[:filename]
  @tags = options[:tags]
  @user_id = options[:user_id]
  @roles = options[:roles]
  @merge_field_components = options[:merge_field_components]
  @created_at = options[:created_at]
  @updated_at = options[:updated_at]
  @thumbnail_url = options[:thumbnail_url]
  @page_image_urls = options[:page_image_urls]
end
prepare_document(template_guid, options = {}) click to toggle source
# File lib/rs4/reusable_template.rb, line 72
def prepare_document(template_guid, options = {})
  path = "/public/v1/reusable_templates/#{template_guid}/prepare_document"

  body = options

  response = RS4.configuration.request_handler.execute(path, :post, body)

  Rails.logger.info("RS4::ReusableTemplate::embed_document:: #{response.inspect}")

  unless response.is_a?(RS4::Error) || response.nil?
    # parsed_response = JSON.parse(response.read_body, symbolize_names: true)

    document_hash = response.dig(:document)

    return RS4::Document.new(document_hash)
  end
end
send_document(template_guid, options = {}) click to toggle source
# File lib/rs4/reusable_template.rb, line 108
def send_document(template_guid, options = {})
  path = "/public/v1/reusable_templates/#{template_guid}/send_document"

  body = options

  response = RS4.configuration.request_handler.execute(path, :post, body)

  Rails.logger.info("RS4::ReusableTemplate::send_document:: #{response.inspect}")

  unless response.is_a?(RS4::Error) || response.nil?
    # parsed_response = JSON.parse(response.read_body, symbolize_names: true)

    document_hash = response.dig(:document)

    return RS4::Document.new(document_hash)
  end
end