Class: Reach::REST::Api::Authentix::ConfigurationItemContext::AuthenticationItemContext

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

Instance Method Summary collapse

Constructor Details

#initialize(version, configuration_id, authentication_id) ⇒ AuthenticationItemContext

Initialize the AuthenticationItemContext

Parameters:

  • version (Version)

    Version that contains the resource

  • configuration_id (String)

    The identifier of the configuration being used.

  • authentication_id (String)

    The identifier of the authentication to be updated.



179
180
181
182
183
184
185
186
187
# File 'lib/reach-ruby/rest/api/authentix/configuration_item/authentication_item.rb', line 179

def initialize(version, configuration_id, authentication_id)
    super(version)

    # Path Solution
    @solution = { configuration_id: configuration_id, authentication_id: authentication_id,  }
    @uri = "/authentix/v1/configurations/#{@solution[:configuration_id]}/authentications/#{@solution[:authentication_id]}"

    
end

Instance Method Details

#fetchAuthenticationItemInstance

Fetch the AuthenticationItemInstance

Returns:



191
192
193
194
195
196
197
198
199
200
201
202
203
204
# File 'lib/reach-ruby/rest/api/authentix/configuration_item/authentication_item.rb', line 191

def fetch

    baseParams = {
    }
    
    
    payload = @version.fetch('GET', @uri)
    AuthenticationItemInstance.new(
        @version,
        payload,
        configuration_id: @solution[:configuration_id],
        authentication_id: @solution[:authentication_id],
    )
end

#inspectObject

Provide a detailed, user friendly representation



241
242
243
244
# File 'lib/reach-ruby/rest/api/authentix/configuration_item/authentication_item.rb', line 241

def inspect
    context = @solution.map{|k, v| "#{k}: #{v}"}.join(',')
    "#<Reach.Api.Authentix.AuthenticationItemContext #{context}>"
end

#to_sObject

Provide a user friendly representation



234
235
236
237
# File 'lib/reach-ruby/rest/api/authentix/configuration_item/authentication_item.rb', line 234

def to_s
    context = @solution.map{|k, v| "#{k}: #{v}"}.join(',')
    "#<Reach.Api.Authentix.AuthenticationItemContext #{context}>"
end

#update(status: nil) ⇒ AuthenticationItemInstance

Update the AuthenticationItemInstance

Parameters:

  • status (String) (defaults to: nil)

    The new status of the authentication.

Returns:



210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
# File 'lib/reach-ruby/rest/api/authentix/configuration_item/authentication_item.rb', line 210

def update(
    status: nil
)

    baseParams = {
    }
    data = Reach::Values.of(baseParams.merge({                        
        'status' => status,
    }))

    
    
    payload = @version.update('POST', @uri, data: data)
    AuthenticationItemInstance.new(
        @version,
        payload,
        configuration_id: @solution[:configuration_id],
        authentication_id: @solution[:authentication_id],
    )
end