Class: NgrokAPI::Services::AgentIngressesClient

Inherits:
Object
  • Object
show all
Defined in:
lib/ngrokapi/services/agent_ingresses_client.rb

Overview

ngrok.com/docs/api#api-agent-ingresses

Constant Summary collapse

PATH =

The API path for the requests

'/agent_ingresses'
LIST_PROPERTY =

The List Property from the resulting API for list calls

'ingresses'

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(client:) ⇒ AgentIngressesClient

Returns a new instance of AgentIngressesClient.



15
16
17
 
# File 'lib/ngrokapi/services/agent_ingresses_client.rb', line 15

def initialize(client:)
  @client = client
end

Instance Attribute Details

#client ⇒ Object (readonly)

Returns the value of attribute client.



13
14
15
 
# File 'lib/ngrokapi/services/agent_ingresses_client.rb', line 13

def client
  @client
end

Instance Method Details

#create(description: "", metadata: "", domain:) ⇒ NgrokAPI::Models::AgentIngress

Create a new Agent Ingress. The ngrok agent can be configured to connect to ngrok via the new set of addresses on the returned Agent Ingress.

ngrok.com/docs/api#api-agent-ingresses-create

Parameters:

  • description (string) (defaults to: "") —

    human-readable description of the use of this Agent Ingress. optional, max 255 bytes.

  • metadata (string) (defaults to: "") —

    arbitrary user-defined machine-readable data of this Agent Ingress. optional, max 4096 bytes

  • domain (string) —

    the domain that you own to be used as the base domain name to generate regional agent ingress domains.

Returns:



29
30
31
32
33
34
35
36
37
38
39
 
# File 'lib/ngrokapi/services/agent_ingresses_client.rb', line 29

def create(description: "", metadata: "", domain:)
  path = '/agent_ingresses'
  replacements = {
  }
  data = {}
  data[:description] = description if description
  data[:metadata] = metadata if metadata
  data[:domain] = domain if domain
  result = @client.post(path % replacements, data: data)
  NgrokAPI::Models::AgentIngress.new(client: self, result: result)
end

#delete(id: "") ⇒ NgrokAPI::Models::Empty

Delete an Agent Ingress by ID

ngrok.com/docs/api#api-agent-ingresses-delete

Parameters:

  • id (string) (defaults to: "") —

    a resource identifier

Returns:

  • (NgrokAPI::Models::Empty) —

    result from the API request



48
49
50
51
52
53
54
 
# File 'lib/ngrokapi/services/agent_ingresses_client.rb', line 48

def delete(id: "")
  path = '/agent_ingresses/%{id}'
  replacements = {
    id: id,
  }
  @client.delete(path % replacements)
end

#delete!(id: "") ⇒ NgrokAPI::Models::Empty

Delete an Agent Ingress by ID Throws an exception if API error.

ngrok.com/docs/api#api-agent-ingresses-delete

Parameters:

  • id (string) (defaults to: "") —

    a resource identifier

Returns:

  • (NgrokAPI::Models::Empty) —

    result from the API request



64
65
66
67
68
69
70
 
# File 'lib/ngrokapi/services/agent_ingresses_client.rb', line 64

def delete!(id: "")
  path = '/agent_ingresses/%{id}'
  replacements = {
    id: id,
  }
  @client.delete(path % replacements, danger: true)
end

#get(id: "") ⇒ NgrokAPI::Models::AgentIngress

Get the details of an Agent Ingress by ID.

ngrok.com/docs/api#api-agent-ingresses-get

Parameters:

  • id (string) (defaults to: "") —

    a resource identifier

Returns:



79
80
81
82
83
84
85
86
87
 
# File 'lib/ngrokapi/services/agent_ingresses_client.rb', line 79

def get(id: "")
  path = '/agent_ingresses/%{id}'
  replacements = {
    id: id,
  }
  data = {}
  result = @client.get(path % replacements, data: data)
  NgrokAPI::Models::AgentIngress.new(client: self, result: result)
end

#get!(id: "") ⇒ NgrokAPI::Models::AgentIngress

Get the details of an Agent Ingress by ID. Throws an exception if API error.

ngrok.com/docs/api#api-agent-ingresses-get

Parameters:

  • id (string) (defaults to: "") —

    a resource identifier

Returns:



97
98
99
100
101
102
103
104
105
 
# File 'lib/ngrokapi/services/agent_ingresses_client.rb', line 97

def get!(id: "")
  path = '/agent_ingresses/%{id}'
  replacements = {
    id: id,
  }
  data = {}
  result = @client.get(path % replacements, data: data, danger: true)
  NgrokAPI::Models::AgentIngress.new(client: self, result: result)
end

#list(before_id: nil, limit: nil, url: nil) ⇒ NgrokAPI::Models::Listable

List all Agent Ingresses owned by this account

ngrok.com/docs/api#api-agent-ingresses-list

Parameters:

  • before_id (string) (defaults to: nil)
  • limit (string) (defaults to: nil)
  • url (string) (defaults to: nil) —

    optional and mutually exclusive from before_id and limit

Returns:



116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
 
# File 'lib/ngrokapi/services/agent_ingresses_client.rb', line 116

def list(before_id: nil, limit: nil,
         url: nil)
  result = @client.list(
    before_id: before_id,
    limit: limit,
    url: url,
    path: PATH
  )

  NgrokAPI::Models::Listable.new(
    client: self,
    result: result,
    list_property: LIST_PROPERTY,
    klass: NgrokAPI::Models::AgentIngress
  )
end

#list!(before_id: nil, limit: nil, url: nil) ⇒ NgrokAPI::Models::Listable

List all Agent Ingresses owned by this account Throws an exception if API error.

ngrok.com/docs/api#api-agent-ingresses-list

Parameters:

  • before_id (string) (defaults to: nil)
  • limit (string) (defaults to: nil)
  • url (string) (defaults to: nil) —

    optional and mutually exclusive from before_id and limit

Returns:



143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
 
# File 'lib/ngrokapi/services/agent_ingresses_client.rb', line 143

def list!(before_id: nil, limit: nil,
          url: nil)
  result = @client.list(
    before_id: before_id,
    limit: limit,
    danger: true,
    url: url,
    path: PATH
  )

  NgrokAPI::Models::Listable.new(
    client: self,
    result: result,
    list_property: LIST_PROPERTY,
    klass: NgrokAPI::Models::AgentIngress,
    danger: true
  )
end

#update(id: "", description: nil, metadata: nil) ⇒ NgrokAPI::Models::AgentIngress

Update attributes of an Agent Ingress by ID.

ngrok.com/docs/api#api-agent-ingresses-update

Parameters:

  • id (string) (defaults to: "")
  • description (string) (defaults to: nil) —

    human-readable description of the use of this Agent Ingress. optional, max 255 bytes.

  • metadata (string) (defaults to: nil) —

    arbitrary user-defined machine-readable data of this Agent Ingress. optional, max 4096 bytes

Returns:



171
172
173
174
175
176
177
178
179
180
181
 
# File 'lib/ngrokapi/services/agent_ingresses_client.rb', line 171

def update(id: "", description: nil, metadata: nil)
  path = '/agent_ingresses/%{id}'
  replacements = {
    id: id,
  }
  data = {}
  data[:description] = description if description
  data[:metadata] = metadata if metadata
  result = @client.patch(path % replacements, data: data)
  NgrokAPI::Models::AgentIngress.new(client: self, result: result)
end

#update!(id: "", description: nil, metadata: nil) ⇒ NgrokAPI::Models::AgentIngress

Update attributes of an Agent Ingress by ID. Throws an exception if API error.

ngrok.com/docs/api#api-agent-ingresses-update

Parameters:

  • id (string) (defaults to: "")
  • description (string) (defaults to: nil) —

    human-readable description of the use of this Agent Ingress. optional, max 255 bytes.

  • metadata (string) (defaults to: nil) —

    arbitrary user-defined machine-readable data of this Agent Ingress. optional, max 4096 bytes

Returns:



193
194
195
196
197
198
199
200
201
202
203
 
# File 'lib/ngrokapi/services/agent_ingresses_client.rb', line 193

def update!(id: "", description: nil, metadata: nil)
  path = '/agent_ingresses/%{id}'
  replacements = {
    id: id,
  }
  data = {}
  data[:description] = description if description
  data[:metadata] = metadata if metadata
  result = @client.patch(path % replacements, data: data, danger: true)
  NgrokAPI::Models::AgentIngress.new(client: self, result: result)
end