Class: Lithic::Resources::ResponderEndpoints

Inherits:

Object

• Object
• Lithic::Resources::ResponderEndpoints

Defined in:

lib/lithic/resources/responder_endpoints.rb

Instance Method Summary

• #check_status(type:, request_options: {}) ⇒ Lithic::Models::ResponderEndpointStatus

  Check the status of a responder endpoint.

• #create(type: nil, url: nil, request_options: {}) ⇒ Lithic::Models::ResponderEndpointCreateResponse

  Enroll a responder endpoint.

• #delete(type:, request_options: {}) ⇒ nil

  Disenroll a responder endpoint.

• #initialize(client:) ⇒ ResponderEndpoints constructor private

  A new instance of ResponderEndpoints.

Constructor Details

#initialize(client:) ⇒ ResponderEndpoints

This method is part of a private API. You should avoid using this method if possible, as it may be removed or be changed in the future.

Returns a new instance of ResponderEndpoints.

Parameters:

• client (Lithic::Client)

# File 'lib/lithic/resources/responder_endpoints.rb', line 77

def initialize(client:)
  @client = client
end

Instance Method Details

#check_status(type:, request_options: {}) ⇒ Lithic::Models::ResponderEndpointStatus

Check the status of a responder endpoint

Parameters:

• type (Symbol, Lithic::Models::ResponderEndpointCheckStatusParams::Type) —

  The type of the endpoint.

• request_options (Lithic::RequestOptions, Hash{Symbol=>Object}, nil)

Returns:

• (Lithic::Models::ResponderEndpointStatus)

See Also:

• Models::ResponderEndpointCheckStatusParams

# File 'lib/lithic/resources/responder_endpoints.rb', line 63

def check_status(params)
  parsed, options = Lithic::ResponderEndpointCheckStatusParams.dump_request(params)
  @client.request(
    method: :get,
    path: "v1/responder_endpoints",
    query: parsed,
    model: Lithic::ResponderEndpointStatus,
    options: options
  )
end

#create(type: nil, url: nil, request_options: {}) ⇒ Lithic::Models::ResponderEndpointCreateResponse

Enroll a responder endpoint

Parameters:

• type (Symbol, Lithic::Models::ResponderEndpointCreateParams::Type) —

  The type of the endpoint.

• url (String) —

  The URL for the responder endpoint (must be http(s)).

• request_options (Lithic::RequestOptions, Hash{Symbol=>Object}, nil)

Returns:

• (Lithic::Models::ResponderEndpointCreateResponse)

See Also:

• Models::ResponderEndpointCreateParams

# File 'lib/lithic/resources/responder_endpoints.rb', line 19

def create(params = {})
  parsed, options = Lithic::ResponderEndpointCreateParams.dump_request(params)
  @client.request(
    method: :post,
    path: "v1/responder_endpoints",
    body: parsed,
    model: Lithic::Models::ResponderEndpointCreateResponse,
    options: options
  )
end

#delete(type:, request_options: {}) ⇒ nil

Disenroll a responder endpoint

Parameters:

• type (Symbol, Lithic::Models::ResponderEndpointDeleteParams::Type) —

  The type of the endpoint.

• request_options (Lithic::RequestOptions, Hash{Symbol=>Object}, nil)

Returns:

• (nil)

See Also:

• Models::ResponderEndpointDeleteParams

# File 'lib/lithic/resources/responder_endpoints.rb', line 41

def delete(params)
  parsed, options = Lithic::ResponderEndpointDeleteParams.dump_request(params)
  @client.request(
    method: :delete,
    path: "v1/responder_endpoints",
    query: parsed,
    model: NilClass,
    options: options
  )
end