Class: Convoy::Endpoint

Inherits:

ApiResource

• Object
• ApiResource
• Convoy::Endpoint

Extended by:

ApiOperations::Create

Includes:

ApiOperations::Delete, ApiOperations::Get, ApiOperations::List, ApiOperations::Save

Defined in:

lib/convoy/resources/endpoint.rb

Instance Attribute Summary

Attributes inherited from ApiResource

#response

Instance Method Summary

• #initialize(id = nil, config = Convoy.config, **kwargs) ⇒ Endpoint constructor

  A new instance of Endpoint.

• #pause ⇒ Object
• #resource_uri ⇒ Object

Methods included from ApiOperations::Create

create

Methods included from ApiOperations::List

included, #list

Methods included from ApiOperations::Delete

#delete, included

Methods included from ApiOperations::Save

included, #save, #update

Methods included from ApiOperations::Get

#get, included

Methods inherited from ApiResource

#project_base_uri

Methods included from ApiOperations::Request

#send_request

Constructor Details

#initialize(id = nil, config = Convoy.config, **kwargs) ⇒ Endpoint

Returns a new instance of Endpoint.

# File 'lib/convoy/resources/endpoint.rb', line 9

def initialize(id = nil, config = Convoy.config, **kwargs)
  @id = id
  @config = config 

  super(**kwargs)
end

Instance Method Details

#pause ⇒ Object

# File 'lib/convoy/resources/endpoint.rb', line 24

def pause
  pause_uri = "#{resource_uri}/pause"
  send_request(pause_uri, :post, data: @data, params: @params)
end

#resource_uri ⇒ Object

# File 'lib/convoy/resources/endpoint.rb', line 16

def resource_uri
  if @id.nil?
    return "#{project_base_uri}/endpoints"
  end

  "#{project_base_uri}/endpoints/#{@id}"
end