class ClickSign::Signer

Attributes

auths[R]
birthday[R]
created_at[R]
documentation[R]
email[R]
has_documentation[R]
key[R]
name[R]
phone_number[R]
raw_data[R]
updated_at[R]

Public Class Methods

build_payload(**args) click to toggle source

<CLASS METHODS>

# File lib/click_sign/signer.rb, line 21
    def self.build_payload(**args)
            payload = {}

            payload['email'] = parse_email(args['email']) if args['email'].present?
payload['phone_number'] = parse_phone_number(args['phone_number']) if args['phone_number'].present?
payload['name'] = parse_name(args['name']) if args['name'].present?
payload['documentation'] = parse_documentation(args['documentation']) if args['documentation'].present?
payload['birthday'] = parse_birthday(args['birthday']) if args['birthday'].present?
payload['has_documentation'] = args['has_documentation'].present? ? parse_has_documentation(args['has_documentation']) : default_has_documentation 
payload['auths'] = args['auths'].present? ? parse_auths(args['auths']) : default_auths
payload['delivery'] = args['delivery'].present? ? parse_delivery(args['delivery']) : default_delivery

{signer: payload}
    end
create(**args) click to toggle source
# File lib/click_sign/signer.rb, line 48
 def self.create(**args)
         payload = build_payload(args)
         response = ClickSign::Service.post(
                 url: 'signers',
                 payload: payload
)
if response.created?
        new_signer = ClickSign::Signer.new(response.body['signer'])
end
 end
default_auths() click to toggle source
# File lib/click_sign/signer.rb, line 44
def self.default_auths
        ['email']
end
default_delivery() click to toggle source
# File lib/click_sign/signer.rb, line 36
def self.default_delivery
        ClickSign::Constants::Delivery::EMAIL
end
default_has_documentation() click to toggle source
# File lib/click_sign/signer.rb, line 40
def self.default_has_documentation
        true
end
find(signer_key: nil) click to toggle source
# File lib/click_sign/signer.rb, line 59
            def self.find(signer_key: nil)
                    response = ClickSign::Service.get(
                            url: ['signers', signer_key]
  )
  if response.success?
    signer = ClickSign::Signer.new(response.body['signer'])
  end
end
new(args) click to toggle source
# File lib/click_sign/signer.rb, line 6
def initialize(args)
        @raw_data = args
        @key = clean_key(args['key']) if args['key'].present?
        @email = clean_email(args['email']) if args['email'].present?
        @auths = clean_auths(args['auths']) if args['auths'].present?
        @name = clean_name(args['name']) if args['name'].present?
        @documentation = clean_documentation(args['documentation']) if args['documentation'].present?
        @birthday = clean_birthday(args['birthday']) if args['birthday'].present?
        @phone_number = clean_phone_number(args['phone_number']) if args['phone_number'].present?
        @has_documentation = clean_has_documentation(args['has_documentation']) if args['has_documentation'].present?
        @created_at = clean_created_at(args['created_at']) if args['created_at'].present?
        @updated_at = clean_updated_at(args['updated_at']) if args['updated_at'].present?
end

Public Instance Methods

add_to_document(document_key: nil, sign_as: nil, group: nil) click to toggle source

<INSTANCE METHODS>

# File lib/click_sign/signer.rb, line 70
def add_to_document document_key: nil, sign_as: nil, group: nil
    ClickSign::List.create document_key: document_key, signer_key: self.key, sign_as: sign_as, group: group
end
remove_from_document(list_key: nil) click to toggle source
# File lib/click_sign/signer.rb, line 74
def remove_from_document list_key: nil
    ClickSign::List.delete list_key: list_key
end

Private Instance Methods

clean_auths(value) click to toggle source
# File lib/click_sign/signer.rb, line 87
def clean_auths value
        value
end
clean_birthday(value) click to toggle source
# File lib/click_sign/signer.rb, line 99
def clean_birthday value
        value
end
clean_created_at(value) click to toggle source
# File lib/click_sign/signer.rb, line 111
def clean_created_at value
        value
end
clean_documentation(value) click to toggle source
# File lib/click_sign/signer.rb, line 95
def clean_documentation value
        value
end
clean_email(value) click to toggle source
# File lib/click_sign/signer.rb, line 83
def clean_email value
        value
end
clean_has_documentation(value) click to toggle source
# File lib/click_sign/signer.rb, line 107
def clean_has_documentation value
        value
end
clean_key(value) click to toggle source
# File lib/click_sign/signer.rb, line 79
def clean_key value
        value
end
clean_name(value) click to toggle source
# File lib/click_sign/signer.rb, line 91
def clean_name value
        value
end
clean_phone_number(value) click to toggle source
# File lib/click_sign/signer.rb, line 103
def clean_phone_number value
        value
end
clean_updated_at(value) click to toggle source
# File lib/click_sign/signer.rb, line 115
def clean_updated_at value
        value
end
parse_auths(value) click to toggle source
# File lib/click_sign/signer.rb, line 127
def parse_auths value
        value
end
parse_birthday(value) click to toggle source
# File lib/click_sign/signer.rb, line 139
def parse_birthday value
        value
end
parse_created_at(value) click to toggle source
# File lib/click_sign/signer.rb, line 151
def parse_created_at value
        value
end
parse_documentation(value) click to toggle source
# File lib/click_sign/signer.rb, line 135
def parse_documentation value
        value
end
parse_email(value) click to toggle source
# File lib/click_sign/signer.rb, line 123
def parse_email value
        value
end
parse_has_documentation(value) click to toggle source
# File lib/click_sign/signer.rb, line 147
def parse_has_documentation value
        value
end
parse_key(value) click to toggle source
# File lib/click_sign/signer.rb, line 119
def parse_key value
        value
end
parse_name(value) click to toggle source
# File lib/click_sign/signer.rb, line 131
def parse_name value
        value
end
parse_phone_number(value) click to toggle source
# File lib/click_sign/signer.rb, line 143
def parse_phone_number value
        value
end
parse_updated_at(value) click to toggle source
# File lib/click_sign/signer.rb, line 155
def parse_updated_at value
        value
end