Class: Twilio::REST::Numbers::V1::SigningRequestConfigurationInstance

Inherits:
InstanceResource
  • Object
show all
Defined in:
lib/twilio-ruby/rest/numbers/v1/signing_request_configuration.rb

Instance Method Summary collapse

Constructor Details

#initialize(version, payload) ⇒ SigningRequestConfigurationInstance

Initialize the SigningRequestConfigurationInstance

Parameters:

  • version (Version) —

    Version that contains the resource

  • payload (Hash) —

    payload that contains response from Twilio

  • account_sid (String) —

    The SID of the Account that created this SigningRequestConfiguration resource.

  • sid (String) —

    The SID of the Call resource to fetch.



199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
 
# File 'lib/twilio-ruby/rest/numbers/v1/signing_request_configuration.rb', line 199

def initialize(version, payload )
    super(version)
    
    # Marshaled Properties
    @properties = { 
        'logo_sid' => payload['logo_sid'],
        'friendly_name' => payload['friendly_name'],
        'product' => payload['product'],
        'country' => payload['country'],
        'email_subject' => payload['email_subject'],
        'email_message' => payload['email_message'],
        'url_redirection' => payload['url_redirection'],
        'url' => payload['url'],
    }
end

Instance Method Details

#country ⇒ String

Returns The country ISO code to apply the configuration.

Returns:

  • (String) —

    The country ISO code to apply the configuration.



236
237
238
 
# File 'lib/twilio-ruby/rest/numbers/v1/signing_request_configuration.rb', line 236

def country
    @properties['country']
end

#email_message ⇒ String

Returns Content of the email that the end client will receive ex: “This is a Hosting request from Twilio, please check the document and sign it”, maximum length of 5,000 characters.

Returns:

  • (String) —

    Content of the email that the end client will receive ex: “This is a Hosting request from Twilio, please check the document and sign it”, maximum length of 5,000 characters.



248
249
250
 
# File 'lib/twilio-ruby/rest/numbers/v1/signing_request_configuration.rb', line 248

def email_message
    @properties['email_message']
end

#email_subject ⇒ String

Returns Subject of the email that the end client will receive ex: “Twilio Hosting Request”, maximum length of 255 characters.

Returns:

  • (String) —

    Subject of the email that the end client will receive ex: “Twilio Hosting Request”, maximum length of 255 characters.



242
243
244
 
# File 'lib/twilio-ruby/rest/numbers/v1/signing_request_configuration.rb', line 242

def email_subject
    @properties['email_subject']
end

#friendly_name ⇒ String

Returns This is the string that you assigned as a friendly name for describing the creation of the configuration.

Returns:

  • (String) —

    This is the string that you assigned as a friendly name for describing the creation of the configuration.



224
225
226
 
# File 'lib/twilio-ruby/rest/numbers/v1/signing_request_configuration.rb', line 224

def friendly_name
    @properties['friendly_name']
end

#inspect ⇒ Object

Provide a detailed, user friendly representation



272
273
274
 
# File 'lib/twilio-ruby/rest/numbers/v1/signing_request_configuration.rb', line 272

def inspect
    "<Twilio.Numbers.V1.SigningRequestConfigurationInstance>"
end

#logo_sid ⇒ String

Returns The SID of the document that includes the logo that will appear in the LOA. To upload documents follow the following guide: www.twilio.com/docs/phone-numbers/regulatory/getting-started/create-new-bundle-public-rest-apis#supporting-document-create.

Returns:



218
219
220
 
# File 'lib/twilio-ruby/rest/numbers/v1/signing_request_configuration.rb', line 218

def logo_sid
    @properties['logo_sid']
end

#product ⇒ String

Returns The product or service for which is requesting the signature.

Returns:

  • (String) —

    The product or service for which is requesting the signature.



230
231
232
 
# File 'lib/twilio-ruby/rest/numbers/v1/signing_request_configuration.rb', line 230

def product
    @properties['product']
end

#to_s ⇒ Object

Provide a user friendly representation



266
267
268
 
# File 'lib/twilio-ruby/rest/numbers/v1/signing_request_configuration.rb', line 266

def to_s
    "<Twilio.Numbers.V1.SigningRequestConfigurationInstance>"
end

#url ⇒ String

Returns:

  • (String) 


260
261
262
 
# File 'lib/twilio-ruby/rest/numbers/v1/signing_request_configuration.rb', line 260

def url
    @properties['url']
end

#url_redirection ⇒ String

Returns Url the end client will be redirected after signing a document.

Returns:

  • (String) —

    Url the end client will be redirected after signing a document.



254
255
256
 
# File 'lib/twilio-ruby/rest/numbers/v1/signing_request_configuration.rb', line 254

def url_redirection
    @properties['url_redirection']
end