Class: NgrokAPI::Services::APIKeysClient

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

Overview

API Keys are used to authenticate to the ngrok API. You may use the API itself to provision and manage API Keys but you'll need to provision your first API key from the API Keys page on your ngrok.com dashboard.

https://ngrok.com/docs/api#api-api-keys

Constant Summary collapse

PATH =

The API path for the requests

'/api_keys'
LIST_PROPERTY =

The List Property from the resulting API for list calls

'keys'

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(client:) ⇒ APIKeysClient

Returns a new instance of APIKeysClient.



21
22
23
 
# File 'lib/ngrokapi/services/api_keys_client.rb', line 21

def initialize(client:)
  @client = client
end

Instance Attribute Details

#client ⇒ Object (readonly)

Returns the value of attribute client.



19
20
21
 
# File 'lib/ngrokapi/services/api_keys_client.rb', line 19

def client
  @client
end

Instance Method Details

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

Create a new API key. The generated API key can be used to authenticate to the ngrok API.

https://ngrok.com/docs/api#api-api-keys-create

Parameters:

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

    human-readable description of what uses the API key to authenticate. optional, max 255 bytes.

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

    arbitrary user-defined data of this API key. optional, max 4096 bytes

Returns:



34
35
36
37
38
39
40
41
42
43
 
# File 'lib/ngrokapi/services/api_keys_client.rb', line 34

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

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

Delete an API key by ID

https://ngrok.com/docs/api#api-api-keys-delete

Parameters:

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

    a resource identifier

Returns:

  • (NgrokAPI::Models::Empty) —

    result from the API request



52
53
54
55
56
57
58
 
# File 'lib/ngrokapi/services/api_keys_client.rb', line 52

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

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

Delete an API key by ID Throws an exception if API error.

https://ngrok.com/docs/api#api-api-keys-delete

Parameters:

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

    a resource identifier

Returns:

  • (NgrokAPI::Models::Empty) —

    result from the API request



68
69
70
71
72
73
74
 
# File 'lib/ngrokapi/services/api_keys_client.rb', line 68

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

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

Get the details of an API key by ID.

https://ngrok.com/docs/api#api-api-keys-get

Parameters:

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

    a resource identifier

Returns:



83
84
85
86
87
88
89
90
91
 
# File 'lib/ngrokapi/services/api_keys_client.rb', line 83

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

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

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

https://ngrok.com/docs/api#api-api-keys-get

Parameters:

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

    a resource identifier

Returns:



101
102
103
104
105
106
107
108
109
 
# File 'lib/ngrokapi/services/api_keys_client.rb', line 101

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

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

List all API keys owned by this account

https://ngrok.com/docs/api#api-api-keys-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:



120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
 
# File 'lib/ngrokapi/services/api_keys_client.rb', line 120

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::APIKey
  )
end

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

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

https://ngrok.com/docs/api#api-api-keys-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:



147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
 
# File 'lib/ngrokapi/services/api_keys_client.rb', line 147

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::APIKey,
    danger: true
  )
end

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

Update attributes of an API key by ID.

https://ngrok.com/docs/api#api-api-keys-update

Parameters:

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

    human-readable description of what uses the API key to authenticate. optional, max 255 bytes.

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

    arbitrary user-defined data of this API key. optional, max 4096 bytes

Returns:



175
176
177
178
179
180
181
182
183
184
185
 
# File 'lib/ngrokapi/services/api_keys_client.rb', line 175

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

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

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

https://ngrok.com/docs/api#api-api-keys-update

Parameters:

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

    human-readable description of what uses the API key to authenticate. optional, max 255 bytes.

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

    arbitrary user-defined data of this API key. optional, max 4096 bytes

Returns:



197
198
199
200
201
202
203
204
205
206
207
 
# File 'lib/ngrokapi/services/api_keys_client.rb', line 197

def update!(id: "", description: nil, metadata: nil)
  path = '/api_keys/%{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::APIKey.new(client: self, result: result)
end