Class: Reach::REST::Api::Authentix::ConfigurationItemContext::AuthenticationControlItemInstance

Inherits:
InstanceResource
  • Object
show all
Defined in:
lib/reach-ruby/rest/api/authentix/configuration_item/authentication_control_item.rb

Instance Method Summary collapse

Constructor Details

#initialize(version, payload, configuration_id: nil) ⇒ AuthenticationControlItemInstance

Initialize the AuthenticationControlItemInstance

Parameters:

  • version (Version) —

    Version that contains the resource

  • payload (Hash) —

    payload that contains response from Reach(TalkyLabs)

  • account_sid (String) —

    The SID of the Account that created this AuthenticationControlItem resource.

  • sid (String) —

    The SID of the Call resource to fetch.



116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
 
# File 'lib/reach-ruby/rest/api/authentix/configuration_item/authentication_control_item.rb', line 116

def initialize(version, payload , configuration_id: nil)
    super(version)
    
    # Marshaled Properties
    @properties = { 
        'appletId' => payload['appletId'],
        'apiVersion' => payload['apiVersion'],
        'configurationId' => payload['configurationId'],
        'authenticationId' => payload['authenticationId'],
        'status' => payload['status'],
        'dest' => payload['dest'],
        'channel' => payload['channel'],
        'paymentInfo' => payload['paymentInfo'],
        'dateCreated' => Reach.deserialize_iso8601_datetime(payload['dateCreated']),
        'dateUpdated' => Reach.deserialize_iso8601_datetime(payload['dateUpdated']),
    }
end

Instance Method Details

#apiVersion ⇒ String

Returns The API version.

Returns:

  • (String) —

    The API version.



143
144
145
 
# File 'lib/reach-ruby/rest/api/authentix/configuration_item/authentication_control_item.rb', line 143

def apiVersion
    @properties['apiVersion']
end

#appletId ⇒ String

Returns The identifier of the applet.

Returns:

  • (String) —

    The identifier of the applet.



137
138
139
 
# File 'lib/reach-ruby/rest/api/authentix/configuration_item/authentication_control_item.rb', line 137

def appletId
    @properties['appletId']
end

#authenticationId ⇒ String

Returns The identifier of the authentication.

Returns:

  • (String) —

    The identifier of the authentication.



155
156
157
 
# File 'lib/reach-ruby/rest/api/authentix/configuration_item/authentication_control_item.rb', line 155

def authenticationId
    @properties['authenticationId']
end

#channel ⇒ String

Returns The channel used.

Returns:

  • (String) —

    The channel used.



173
174
175
 
# File 'lib/reach-ruby/rest/api/authentix/configuration_item/authentication_control_item.rb', line 173

def channel
    @properties['channel']
end

#configurationId ⇒ String

Returns The identifier of the configuration.

Returns:

  • (String) —

    The identifier of the configuration.



149
150
151
 
# File 'lib/reach-ruby/rest/api/authentix/configuration_item/authentication_control_item.rb', line 149

def configurationId
    @properties['configurationId']
end

#dateCreated ⇒ Time

Returns The date and time in GMT that the authentication was created.

Returns:

  • (Time) —

    The date and time in GMT that the authentication was created.



185
186
187
 
# File 'lib/reach-ruby/rest/api/authentix/configuration_item/authentication_control_item.rb', line 185

def dateCreated
    @properties['dateCreated']
end

#dateUpdated ⇒ Time

Returns The date and time in GMT that the authentication was last updated.

Returns:

  • (Time) —

    The date and time in GMT that the authentication was last updated.



191
192
193
 
# File 'lib/reach-ruby/rest/api/authentix/configuration_item/authentication_control_item.rb', line 191

def dateUpdated
    @properties['dateUpdated']
end

#dest ⇒ String

Returns The phone number or email being verified. Phone numbers must be in E.164 format.

Returns:

  • (String) —

    The phone number or email being verified. Phone numbers must be in E.164 format.



167
168
169
 
# File 'lib/reach-ruby/rest/api/authentix/configuration_item/authentication_control_item.rb', line 167

def dest
    @properties['dest']
end

#inspect ⇒ Object

Provide a detailed, user friendly representation



203
204
205
 
# File 'lib/reach-ruby/rest/api/authentix/configuration_item/authentication_control_item.rb', line 203

def inspect
    "<Reach.Api.Authentix.AuthenticationControlItemInstance>"
end

#paymentInfo ⇒ PaymentInfo

Returns:

  • (PaymentInfo) 


179
180
181
 
# File 'lib/reach-ruby/rest/api/authentix/configuration_item/authentication_control_item.rb', line 179

def paymentInfo
    @properties['paymentInfo']
end

#status ⇒ String

Returns The outcome of the authentication control.

Returns:

  • (String) —

    The outcome of the authentication control.



161
162
163
 
# File 'lib/reach-ruby/rest/api/authentix/configuration_item/authentication_control_item.rb', line 161

def status
    @properties['status']
end

#to_s ⇒ Object

Provide a user friendly representation



197
198
199
 
# File 'lib/reach-ruby/rest/api/authentix/configuration_item/authentication_control_item.rb', line 197

def to_s
    "<Reach.Api.Authentix.AuthenticationControlItemInstance>"
end