Sha256: 62d6f051d4917d2735729539be9cad758d3b687ce2b3890fefc9f1e94f710e4d

Contents?: true

Size: 1.42 KB

Versions: 2

Compression:

Stored size: 1.42 KB

Contents

module HelloSign
  module Api

    #
    # HelloSign allows you to embed the signing page on your site in an iFrame
    # without the need for the end-user to create a HelloSign account.
    # Take a look at our {https://www.hellosign.com/api/embeddedSigningWalkthrough embedded signing walkthrough}
    # for more information about this.
    #
    # @author [hellosign]
    #
    module Embedded

      #
      # Retrieves the embedded signature request url.
      # @option opts [String] signature_id The id of the signature to get a signature url for
      #
      # @return [HelloSign::Resource::Embedded] Returns an Embedded object
      # @example
      #   embedded = @client.get_embedded_sign_url :signature_id => '50e3542f738adfa7ddd4cbd4c00d2a8ab6e4194b'
      #
      def get_embedded_sign_url(opts)
        HelloSign::Resource::Embedded.new get("/embedded/sign_url/#{opts[:signature_id]}")
      end
      #
      # Retrieves the edit url for an embedded template.
      # @option opts [String] template_id The id of the template to get a edit url for
      #
      # @return [HelloSign::Resource::Embedded] Returns an Embedded object
      # @example
      #   edit_url = @client.get_embedded_template_edit_url :template_id => '39e3387f738adfa7ddd4cbd4c00d2a8ab6e4194b'
      #
      def get_embedded_template_edit_url(opts)
        HelloSign::Resource::Embedded.new get("/embedded/edit_url/#{opts[:template_id]}")
      end
    end
  end
end

Version data entries

2 entries across 2 versions & 1 rubygems

Version Path
hellosign-ruby-sdk-3.0.11 lib/hello_sign/api/embedded.rb
hellosign-ruby-sdk-3.0.10 lib/hello_sign/api/embedded.rb