@@ -703,6 +697,19 @@
+
+
+ pooling_enabled
+
+
+ (boolean )
+
+
+ (defaults to: False )
+
+
+
+
Returns:
@@ -730,7 +737,6 @@
-37
38
39
40
@@ -743,12 +749,14 @@
47
48
49
-50
+50
+51
+52
- # File 'lib/ngrokapi/services/endpoints_client.rb', line 37
+ # File 'lib/ngrokapi/services/endpoints_client.rb', line 38
-def create ( url: " " , type: " " , traffic_policy: " " , description: nil , metadata: nil , bindings: nil )
+def create ( url: , type: , traffic_policy: , description: nil , metadata: nil , bindings: nil , pooling_enabled: False )
path = ' /endpoints ' replacements = {
}
@@ -759,6 +767,7 @@
data [ :description ] = description if description
data [ :metadata ] = metadata if metadata
data [ :bindings ] = bindings if bindings
+ data [ :pooling_enabled ] = pooling_enabled if pooling_enabled
result = @client . post ( path % replacements , data: data )
NgrokAPI :: Models :: Endpoint . new ( client: self , attrs: result )
end
- #create! (url: "", type: "", traffic_policy: "", description: nil, metadata: nil, bindings: nil) ⇒ NgrokAPI::Models::Endpoint create! (url:, type:, traffic_policy:, description: nil, metadata: nil, bindings: nil, pooling_enabled: False) ⇒ NgrokAPI::Models::Endpoint (string )
- (defaults to: "" )
-
—
@@ -816,12 +823,10 @@
(string )
-
(defaults to: "" )
-
—
-
whether the endpoint is ephemeral (served directly by an agent-initiated tunnel) or edge (served by an edge) or cloud (represents a cloud endpoint)
+
Type of endpoint. Only ‘cloud’ is currently supported (represents a cloud endpoint). Defaults to ‘cloud’ if not specified.
@@ -834,8 +839,6 @@
(string )
-
(defaults to: "" )
-
—
@@ -898,6 +901,19 @@
+
+
+ pooling_enabled
+
+
+ (boolean )
+
+
+ (defaults to: False )
+
+
+
+
Returns:
@@ -925,9 +941,6 @@
-65
-66
-67
68
69
70
@@ -938,12 +951,16 @@
75
76
77
-78
+78
+79
+80
+81
+82
- # File 'lib/ngrokapi/services/endpoints_client.rb', line 65
+ # File 'lib/ngrokapi/services/endpoints_client.rb', line 68
-def create! ( url: " " , type: " " , traffic_policy: " " , description: nil , metadata: nil , bindings: nil )
+def create! ( url: , type: , traffic_policy: , description: nil , metadata: nil , bindings: nil , pooling_enabled: False )
path = ' /endpoints ' replacements = {
}
@@ -954,6 +971,7 @@
data [ :description ] = description if description
data [ :metadata ] = metadata if metadata
data [ :bindings ] = bindings if bindings
+ data [ :pooling_enabled ] = pooling_enabled if pooling_enabled
result = @client . post ( path % replacements , data: data , danger: true )
NgrokAPI :: Models :: Endpoint . new ( client: self , attrs: result )
end
-230
-231
-232
-233
-234
-235
-236
+246
+247
+248
+249
+250
+251
+252
- # File 'lib/ngrokapi/services/endpoints_client.rb', line 230
+ # File 'lib/ngrokapi/services/endpoints_client.rb', line 246
def delete ( id: " " )
path = ' /endpoints/%{id} '
-246
-247
-248
-249
-250
-251
-252
+262
+263
+264
+265
+266
+267
+268
- # File 'lib/ngrokapi/services/endpoints_client.rb', line 246
+ # File 'lib/ngrokapi/services/endpoints_client.rb', line 262
def delete! ( id: " " )
path = ' /endpoints/%{id} '
-140
-141
-142
-143
-144
-145
-146
-147
-148
+152
+153
+154
+155
+156
+157
+158
+159
+160
- # File 'lib/ngrokapi/services/endpoints_client.rb', line 140
+ # File 'lib/ngrokapi/services/endpoints_client.rb', line 152
def get ( id: " " )
path = ' /endpoints/%{id} '
-158
-159
-160
-161
-162
-163
-164
-165
-166
+170
+171
+172
+173
+174
+175
+176
+177
+178
- # File 'lib/ngrokapi/services/endpoints_client.rb', line 158
+ # File 'lib/ngrokapi/services/endpoints_client.rb', line 170
def get! ( id: " " )
path = ' /endpoints/%{id} '
- #list (before_id: nil, limit: nil, url: nil) ⇒ NgrokAPI::Models::Listable list (before_id: nil, limit: nil, ids: [], urls: [], url: nil) ⇒ NgrokAPI::Models::Listable (defaults to: nil )
+
+
+
+
+ ids
+
+
+ (List<string> )
+
+
+ (defaults to: [] )
+
+
+
+
+
+
+ urls
+
+
+ (List<string> )
+
+
+ (defaults to: [] )
+
+
@@ -1428,12 +1472,6 @@
-89
-90
-91
-92
-93
-94
95
96
97
@@ -1442,15 +1480,25 @@
100
101
102
-103
+103
+104
+105
+106
+107
+108
+109
+110
+111
- # File 'lib/ngrokapi/services/endpoints_client.rb', line 89
+ # File 'lib/ngrokapi/services/endpoints_client.rb', line 95
-def list ( before_id: nil , limit: nil , url: nil )
+def list ( before_id: nil , limit: nil , ids: [ ] , urls: [ ] , url: nil )
result = @client . list (
before_id: before_id ,
limit: limit ,
+ ids: ids ,
+ urls: urls ,
url: url ,
path: PATH )
@@ -1470,7 +1518,7 @@
- #list! (before_id: nil, limit: nil, url: nil) ⇒ NgrokAPI::Models::Listable list! (before_id: nil, limit: nil, ids: [], urls: [], url: nil) ⇒ NgrokAPI::Models::Listable (defaults to: nil )
+
+
+
+
+ ids
+
+
+ (List<string> )
+
+
+ (defaults to: [] )
+
+
+
+
+
+
+ urls
+
+
+ (List<string> )
+
+
+ (defaults to: [] )
+
+
@@ -1561,31 +1635,35 @@
-115
-116
-117
-118
-119
-120
-121
-122
-123
-124
125
126
127
128
129
130
-131
+131
+132
+133
+134
+135
+136
+137
+138
+139
+140
+141
+142
+143
- # File 'lib/ngrokapi/services/endpoints_client.rb', line 115
+ # File 'lib/ngrokapi/services/endpoints_client.rb', line 125
-def list! ( before_id: nil , limit: nil , url: nil )
+def list! ( before_id: nil , limit: nil , ids: [ ] , urls: [ ] , url: nil )
result = @client . list (
before_id: before_id ,
limit: limit ,
+ ids: ids ,
+ urls: urls ,
danger: true ,
url: url ,
path: PATH
- #update (id: "", url: nil, traffic_policy: nil, description: nil, metadata: nil, bindings: nil) ⇒ NgrokAPI::Models::Endpoint update (id: "", url: nil, traffic_policy: nil, description: nil, metadata: nil, bindings: nil, pooling_enabled: False) ⇒ NgrokAPI::Models::Endpoint
+
+ pooling_enabled
+
+
+ (boolean )
+
+
+ (defaults to: False )
+
+
+
+
Returns:
@@ -1762,25 +1853,26 @@
-180
-181
-182
-183
-184
-185
-186
-187
-188
-189
-190
-191
-192
-193
+193
+194
+195
+196
+197
+198
+199
+200
+201
+202
+203
+204
+205
+206
+207
- # File 'lib/ngrokapi/services/endpoints_client.rb', line 180
+ # File 'lib/ngrokapi/services/endpoints_client.rb', line 193
-def update ( id: " " , url: nil , traffic_policy: nil , description: nil , metadata: nil , bindings: nil )
+def update ( id: " " , url: nil , traffic_policy: nil , description: nil , metadata: nil , bindings: nil , pooling_enabled: False )
path = ' /endpoints/%{id} ' replacements = {
id: id ,
@@ -1791,6 +1883,7 @@
data [ :description ] = description if description
data [ :metadata ] = metadata if metadata
data [ :bindings ] = bindings if bindings
+ data [ :pooling_enabled ] = pooling_enabled if pooling_enabled
result = @client . patch ( path % replacements , data: data )
NgrokAPI :: Models :: Endpoint . new ( client: self , attrs: result )
end
- #update! (id: "", url: nil, traffic_policy: nil, description: nil, metadata: nil, bindings: nil) ⇒ NgrokAPI::Models::Endpoint update! (id: "", url: nil, traffic_policy: nil, description: nil, metadata: nil, bindings: nil, pooling_enabled: False) ⇒ NgrokAPI::Models::Endpoint
+
+ pooling_enabled
+
+
+ (boolean )
+
+
+ (defaults to: False )
+
+
+
+
Returns:
@@ -1957,25 +2063,26 @@
-208
-209
-210
-211
-212
-213
-214
-215
-216
-217
-218
-219
-220
-221
+223
+224
+225
+226
+227
+228
+229
+230
+231
+232
+233
+234
+235
+236
+237
- # File 'lib/ngrokapi/services/endpoints_client.rb', line 208
+ # File 'lib/ngrokapi/services/endpoints_client.rb', line 223
-def update! ( id: " " , url: nil , traffic_policy: nil , description: nil , metadata: nil , bindings: nil )
+def update! ( id: " " , url: nil , traffic_policy: nil , description: nil , metadata: nil , bindings: nil , pooling_enabled: False )
path = ' /endpoints/%{id} ' replacements = {
id: id ,
@@ -1986,6 +2093,7 @@
data [ :description ] = description if description
data [ :metadata ] = metadata if metadata
data [ :bindings ] = bindings if bindings
+ data [ :pooling_enabled ] = pooling_enabled if pooling_enabled
result = @client . patch ( path % replacements , data: data , danger: true )
NgrokAPI :: Models :: Endpoint . new ( client: self , attrs: result )
end
+ Class: NgrokAPI::Services::SecretsClient
+
+ — Documentation by YARD 0.9.36
+
+
+
+
+
+
+
Class: NgrokAPI::Services::SecretsClient
+
+
+
+
+
+
+
+ Inherits:
+
+ Object
+
+
+ Object
+
+ NgrokAPI::Services::SecretsClient
+
+
+ show all
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ Defined in:
+ lib/ngrokapi/services/secrets_client.rb
+
+
+
+
+
Overview
+
+
+
Secrets is an api service for securely storing and managing sensitive data such as secrets, credentials, and tokens.
+
+
ngrok.com/docs/api#api-secrets
+
+
+
+
+
+
+
+
+
+
+ Constant Summary
+ collapse
+
+
+
+ PATH =
+
+
+
+
The API path for the requests
+
+
+
+
+
+
+
+
+ ' /vault_secrets ' LIST_PROPERTY =
+
+
+
+
The List Property from the resulting API for list calls
+
+
+
+
+
+
+
+
+ ' secrets '
+
+
+
+
+
+
Instance Attribute Summary collapse
+
+
+
+
+
+ #client ⇒ Object
+
+
+
+
+
+
+
+
+ readonly
+
+
+
+
+
+
+
+
+
+
+
Returns the value of attribute client.
+
+
+
+
+
+
+
+
+
+
+ Instance Method Summary
+ collapse
+
+
+
+
+
+
+ #create (name: "", value: "", metadata: "", description: "", vault_id:) ⇒ NgrokAPI::Models::Secret
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ #create! (name: "", value: "", metadata: "", description: "", vault_id:) ⇒ NgrokAPI::Models::Secret
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
Create a new Secret Throws an exception if API error.
+
+
+
+
+
+
+ #delete (id: "") ⇒ NgrokAPI::Models::Empty
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ #delete! (id: "") ⇒ NgrokAPI::Models::Empty
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
Delete a Secret Throws an exception if API error.
+
+
+
+
+
+
+ #get (id: "") ⇒ NgrokAPI::Models::Secret
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ #get! (id: "") ⇒ NgrokAPI::Models::Secret
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
Get a Secret by ID Throws an exception if API error.
+
+
+
+
+
+
+ #initialize (client:) ⇒ SecretsClient
+
+
+
+
+
+
+ constructor
+
+
+
+
+
+
+
+
+
+
A new instance of SecretsClient.
+
+
+
+
+
+
+ #list (before_id: nil, limit: nil, url: nil) ⇒ NgrokAPI::Models::Listable
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
List all Secrets owned by account.
+
+
+
+
+
+
+ #list! (before_id: nil, limit: nil, url: nil) ⇒ NgrokAPI::Models::Listable
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
List all Secrets owned by account Throws an exception if API error.
+
+
+
+
+
+
+ #update (id: "", name: nil, value: nil, metadata: nil, description: nil) ⇒ NgrokAPI::Models::Secret
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
Update an existing Secret by ID.
+
+
+
+
+
+
+ #update! (id: "", name: nil, value: nil, metadata: nil, description: nil) ⇒ NgrokAPI::Models::Secret
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
Update an existing Secret by ID Throws an exception if API error.
+
+
+
+
+
+
+
+
Constructor Details
+
+
+
+
+ #initialize (client:) ⇒ SecretsClient
+
+
+
Returns a new instance of SecretsClient.
+
+
+
+
+
+
+
+
+
+
+
+
+
+20
+21
+22
+
+
+ # File 'lib/ngrokapi/services/secrets_client.rb', line 20
+
+def initialize ( client: )
+ @client = client
+end
+
+
+
+
+
+
+
+
Instance Attribute Details
+
+
+
+
+
+
+ #client ⇒ Object
+
+
+
+
+
+
+
+
+
Returns the value of attribute client.
+
+
+
+
+
+
+
+
+
+
+
+
+
+18
+19
+20
+
+
+ # File 'lib/ngrokapi/services/secrets_client.rb', line 18
+
+def client
+ @client
+end
+
+
+
+
+
+
+
+
+
Instance Method Details
+
+
+
+
+
+ #create (name: "", value: "", metadata: "", description: "", vault_id:) ⇒ NgrokAPI::Models::Secret
+
+
+
+
+
+
+35
+36
+37
+38
+39
+40
+41
+42
+43
+44
+45
+46
+47
+
+
+ # File 'lib/ngrokapi/services/secrets_client.rb', line 35
+
+def create ( name: " " , value: " " , metadata: " " , description: " " , vault_id: )
+ path = ' /vault_secrets ' replacements = {
+ }
+ data = { }
+ data [ :name ] = name if name
+ data [ :value ] = value if value
+ data [ :metadata ] = metadata if metadata
+ data [ :description ] = description if description
+ data [ :vault_id ] = vault_id if vault_id
+ result = @client . post ( path % replacements , data: data )
+ NgrokAPI :: Models :: Secret . new ( client: self , attrs: result )
+end
+
+
+
+
+
+
+
+ #create! (name: "", value: "", metadata: "", description: "", vault_id:) ⇒ NgrokAPI::Models::Secret
+
+
+
+
+
+
+61
+62
+63
+64
+65
+66
+67
+68
+69
+70
+71
+72
+73
+
+
+ # File 'lib/ngrokapi/services/secrets_client.rb', line 61
+
+def create! ( name: " " , value: " " , metadata: " " , description: " " , vault_id: )
+ path = ' /vault_secrets ' replacements = {
+ }
+ data = { }
+ data [ :name ] = name if name
+ data [ :value ] = value if value
+ data [ :metadata ] = metadata if metadata
+ data [ :description ] = description if description
+ data [ :vault_id ] = vault_id if vault_id
+ result = @client . post ( path % replacements , data: data , danger: true )
+ NgrokAPI :: Models :: Secret . new ( client: self , attrs: result )
+end
+
+
+
+
+
+
+
+ #delete (id: "") ⇒ NgrokAPI::Models::Empty
+
+
+
+
+
+
+
+
+
+
+
+
+133
+134
+135
+136
+137
+138
+139
+
+
+ # File 'lib/ngrokapi/services/secrets_client.rb', line 133
+
+def delete ( id: " " )
+ path = ' /vault_secrets/%{id} ' replacements = {
+ id: id ,
+ }
+ @client . delete ( path % replacements )
+end
+
+
+
+
+
+
+
+ #delete! (id: "") ⇒ NgrokAPI::Models::Empty
+
+
+
+
+
+
+
+
+
+
+
+
+149
+150
+151
+152
+153
+154
+155
+
+
+ # File 'lib/ngrokapi/services/secrets_client.rb', line 149
+
+def delete! ( id: " " )
+ path = ' /vault_secrets/%{id} ' replacements = {
+ id: id ,
+ }
+ @client . delete ( path % replacements , danger: true )
+end
+
+
+
+
+
+
+
+
+
+
+
+
+164
+165
+166
+167
+168
+169
+170
+171
+172
+
+
+ # File 'lib/ngrokapi/services/secrets_client.rb', line 164
+
+def get ( id: " " )
+ path = ' /vault_secrets/%{id} ' replacements = {
+ id: id ,
+ }
+ data = { }
+ result = @client . get ( path % replacements , data: data )
+ NgrokAPI :: Models :: Secret . new ( client: self , attrs: result )
+end
+
+
+
+
+
+
+
+
+
+
+
+
+182
+183
+184
+185
+186
+187
+188
+189
+190
+
+
+ # File 'lib/ngrokapi/services/secrets_client.rb', line 182
+
+def get! ( id: " " )
+ path = ' /vault_secrets/%{id} ' replacements = {
+ id: id ,
+ }
+ data = { }
+ result = @client . get ( path % replacements , data: data , danger: true )
+ NgrokAPI :: Models :: Secret . new ( client: self , attrs: result )
+end
+
+
+
+
+
+
+
+ #list (before_id: nil, limit: nil, url: nil) ⇒ NgrokAPI::Models::Listable
+
+
+
+
+
+
+201
+202
+203
+204
+205
+206
+207
+208
+209
+210
+211
+212
+213
+214
+215
+
+
+ # File 'lib/ngrokapi/services/secrets_client.rb', line 201
+
+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 ,
+ attrs: result ,
+ list_property: LIST_PROPERTY ,
+ klass: NgrokAPI :: Models :: Secret )
+end
+
+
+
+
+
+
+
+ #list! (before_id: nil, limit: nil, url: nil) ⇒ NgrokAPI::Models::Listable
+
+
+
+
+
+
+227
+228
+229
+230
+231
+232
+233
+234
+235
+236
+237
+238
+239
+240
+241
+242
+243
+
+
+ # File 'lib/ngrokapi/services/secrets_client.rb', line 227
+
+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 ,
+ attrs: result ,
+ list_property: LIST_PROPERTY ,
+ klass: NgrokAPI :: Models :: Secret ,
+ danger: true
+ )
+end
+
+
+
+
+
+
+
+ #update (id: "", name: nil, value: nil, metadata: nil, description: nil) ⇒ NgrokAPI::Models::Secret
+
+
+
+
+
+
+86
+87
+88
+89
+90
+91
+92
+93
+94
+95
+96
+97
+98
+
+
+ # File 'lib/ngrokapi/services/secrets_client.rb', line 86
+
+def update ( id: " " , name: nil , value: nil , metadata: nil , description: nil )
+ path = ' /vault_secrets/%{id} ' replacements = {
+ id: id ,
+ }
+ data = { }
+ data [ :name ] = name if name
+ data [ :value ] = value if value
+ data [ :metadata ] = metadata if metadata
+ data [ :description ] = description if description
+ result = @client . patch ( path % replacements , data: data )
+ NgrokAPI :: Models :: Secret . new ( client: self , attrs: result )
+end
+
+
+
+
+
+
+
+ #update! (id: "", name: nil, value: nil, metadata: nil, description: nil) ⇒ NgrokAPI::Models::Secret
+
+
+
+
+
+
+112
+113
+114
+115
+116
+117
+118
+119
+120
+121
+122
+123
+124
+
+
+ # File 'lib/ngrokapi/services/secrets_client.rb', line 112
+
+def update! ( id: " " , name: nil , value: nil , metadata: nil , description: nil )
+ path = ' /vault_secrets/%{id} ' replacements = {
+ id: id ,
+ }
+ data = { }
+ data [ :name ] = name if name
+ data [ :value ] = value if value
+ data [ :metadata ] = metadata if metadata
+ data [ :description ] = description if description
+ result = @client . patch ( path % replacements , data: data , danger: true )
+ NgrokAPI :: Models :: Secret . new ( client: self , attrs: result )
+end
+
+
+
+
+
+
+
+
+
+
+
+ Class: NgrokAPI::Services::VaultsClient
+
+ — Documentation by YARD 0.9.36
+
+
+
+
+
+
+
Class: NgrokAPI::Services::VaultsClient
+
+
+
+
+
+
+
+ Inherits:
+
+ Object
+
+
+ Object
+
+ NgrokAPI::Services::VaultsClient
+
+
+ show all
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ Defined in:
+ lib/ngrokapi/services/vaults_client.rb
+
+
+
+
+
Overview
+
+
+
Vaults is an api service for securely storing and managing sensitive data such as secrets, credentials, and tokens.
+
+
ngrok.com/docs/api#api-vaults
+
+
+
+
+
+
+
+
+
+
+ Constant Summary
+ collapse
+
+
+
+ PATH =
+
+
+
+
The API path for the requests
+
+
+
+
+
+
+
+
+ ' /vaults ' LIST_PROPERTY =
+
+
+
+
The List Property from the resulting API for list calls
+
+
+
+
+
+
+
+
+ ' vaults '
+
+
+
+
+
+
Instance Attribute Summary collapse
+
+
+
+
+
+ #client ⇒ Object
+
+
+
+
+
+
+
+
+ readonly
+
+
+
+
+
+
+
+
+
+
+
Returns the value of attribute client.
+
+
+
+
+
+
+
+
+
+
+ Instance Method Summary
+ collapse
+
+
+
+
+
+
+ #create (name: "", metadata: "", description: "") ⇒ NgrokAPI::Models::Vault
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ #create! (name: "", metadata: "", description: "") ⇒ NgrokAPI::Models::Vault
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
Create a new Vault Throws an exception if API error.
+
+
+
+
+
+
+ #delete (id: "") ⇒ NgrokAPI::Models::Empty
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ #delete! (id: "") ⇒ NgrokAPI::Models::Empty
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
Delete a Vault Throws an exception if API error.
+
+
+
+
+
+
+ #get (id: "") ⇒ NgrokAPI::Models::Vault
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ #get! (id: "") ⇒ NgrokAPI::Models::Vault
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
Get a Vault by ID Throws an exception if API error.
+
+
+
+
+
+
+ #initialize (client:) ⇒ VaultsClient
+
+
+
+
+
+
+ constructor
+
+
+
+
+
+
+
+
+
+
A new instance of VaultsClient.
+
+
+
+
+
+
+ #list (before_id: nil, limit: nil, url: nil) ⇒ NgrokAPI::Models::Listable
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
List all Vaults owned by account.
+
+
+
+
+
+
+ #list! (before_id: nil, limit: nil, url: nil) ⇒ NgrokAPI::Models::Listable
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
List all Vaults owned by account Throws an exception if API error.
+
+
+
+
+
+
+ #update (id: "", name: nil, metadata: nil, description: nil) ⇒ NgrokAPI::Models::Vault
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
Update an existing Vault by ID.
+
+
+
+
+
+
+ #update! (id: "", name: nil, metadata: nil, description: nil) ⇒ NgrokAPI::Models::Vault
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
Update an existing Vault by ID Throws an exception if API error.
+
+
+
+
+
+
+
+
Constructor Details
+
+
+
+
+ #initialize (client:) ⇒ VaultsClient
+
+
+
Returns a new instance of VaultsClient.
+
+
+
+
+
+
+
+
+
+
+
+
+
+20
+21
+22
+
+
+ # File 'lib/ngrokapi/services/vaults_client.rb', line 20
+
+def initialize ( client: )
+ @client = client
+end
+
+
+
+
+
+
+
+
Instance Attribute Details
+
+
+
+
+
+
+ #client ⇒ Object
+
+
+
+
+
+
+
+
+
Returns the value of attribute client.
+
+
+
+
+
+
+
+
+
+
+
+
+
+18
+19
+20
+
+
+ # File 'lib/ngrokapi/services/vaults_client.rb', line 18
+
+def client
+ @client
+end
+
+
+
+
+
+
+
+
+
Instance Method Details
+
+
+
+
+
+ #create (name: "", metadata: "", description: "") ⇒ NgrokAPI::Models::Vault
+
+
+
+
+
+
+33
+34
+35
+36
+37
+38
+39
+40
+41
+42
+43
+
+
+ # File 'lib/ngrokapi/services/vaults_client.rb', line 33
+
+def create ( name: " " , metadata: " " , description: " " )
+ path = ' /vaults ' replacements = {
+ }
+ data = { }
+ data [ :name ] = name if name
+ data [ :metadata ] = metadata if metadata
+ data [ :description ] = description if description
+ result = @client . post ( path % replacements , data: data )
+ NgrokAPI :: Models :: Vault . new ( client: self , attrs: result )
+end
+
+
+
+
+
+
+
+ #create! (name: "", metadata: "", description: "") ⇒ NgrokAPI::Models::Vault
+
+
+
+
+
+
+55
+56
+57
+58
+59
+60
+61
+62
+63
+64
+65
+
+
+ # File 'lib/ngrokapi/services/vaults_client.rb', line 55
+
+def create! ( name: " " , metadata: " " , description: " " )
+ path = ' /vaults ' replacements = {
+ }
+ data = { }
+ data [ :name ] = name if name
+ data [ :metadata ] = metadata if metadata
+ data [ :description ] = description if description
+ result = @client . post ( path % replacements , data: data , danger: true )
+ NgrokAPI :: Models :: Vault . new ( client: self , attrs: result )
+end
+
+
+
+
+
+
+
+ #delete (id: "") ⇒ NgrokAPI::Models::Empty
+
+
+
+
+
+
+
+
+
+
+
+
+121
+122
+123
+124
+125
+126
+127
+
+
+ # File 'lib/ngrokapi/services/vaults_client.rb', line 121
+
+def delete ( id: " " )
+ path = ' /vaults/%{id} ' replacements = {
+ id: id ,
+ }
+ @client . delete ( path % replacements )
+end
+
+
+
+
+
+
+
+ #delete! (id: "") ⇒ NgrokAPI::Models::Empty
+
+
+
+
+
+
+
+
+
+
+
+
+137
+138
+139
+140
+141
+142
+143
+
+
+ # File 'lib/ngrokapi/services/vaults_client.rb', line 137
+
+def delete! ( id: " " )
+ path = ' /vaults/%{id} ' replacements = {
+ id: id ,
+ }
+ @client . delete ( path % replacements , danger: true )
+end
+
+
+
+
+
+
+
+
+
+
+
+
+152
+153
+154
+155
+156
+157
+158
+159
+160
+
+
+ # File 'lib/ngrokapi/services/vaults_client.rb', line 152
+
+def get ( id: " " )
+ path = ' /vaults/%{id} ' replacements = {
+ id: id ,
+ }
+ data = { }
+ result = @client . get ( path % replacements , data: data )
+ NgrokAPI :: Models :: Vault . new ( client: self , attrs: result )
+end
+
+
+
+
+
+
+
+
+
+
+
+
+170
+171
+172
+173
+174
+175
+176
+177
+178
+
+
+ # File 'lib/ngrokapi/services/vaults_client.rb', line 170
+
+def get! ( id: " " )
+ path = ' /vaults/%{id} ' replacements = {
+ id: id ,
+ }
+ data = { }
+ result = @client . get ( path % replacements , data: data , danger: true )
+ NgrokAPI :: Models :: Vault . new ( client: self , attrs: result )
+end
+
+
+
+
+
+
+
+ #list (before_id: nil, limit: nil, url: nil) ⇒ NgrokAPI::Models::Listable
+
+
+
+
+
+
+189
+190
+191
+192
+193
+194
+195
+196
+197
+198
+199
+200
+201
+202
+203
+
+
+ # File 'lib/ngrokapi/services/vaults_client.rb', line 189
+
+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 ,
+ attrs: result ,
+ list_property: LIST_PROPERTY ,
+ klass: NgrokAPI :: Models :: Vault )
+end
+
+
+
+
+
+
+
+ #list! (before_id: nil, limit: nil, url: nil) ⇒ NgrokAPI::Models::Listable
+
+
+
+
+
+
+215
+216
+217
+218
+219
+220
+221
+222
+223
+224
+225
+226
+227
+228
+229
+230
+231
+
+
+ # File 'lib/ngrokapi/services/vaults_client.rb', line 215
+
+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 ,
+ attrs: result ,
+ list_property: LIST_PROPERTY ,
+ klass: NgrokAPI :: Models :: Vault ,
+ danger: true
+ )
+end
+
+
+
+
+
+
+
+ #update (id: "", name: nil, metadata: nil, description: nil) ⇒ NgrokAPI::Models::Vault
+
+
+
+
+
+
+77
+78
+79
+80
+81
+82
+83
+84
+85
+86
+87
+88
+
+
+ # File 'lib/ngrokapi/services/vaults_client.rb', line 77
+
+def update ( id: " " , name: nil , metadata: nil , description: nil )
+ path = ' /vaults/%{id} ' replacements = {
+ id: id ,
+ }
+ data = { }
+ data [ :name ] = name if name
+ data [ :metadata ] = metadata if metadata
+ data [ :description ] = description if description
+ result = @client . patch ( path % replacements , data: data )
+ NgrokAPI :: Models :: Vault . new ( client: self , attrs: result )
+end
+
+
+
+
+
+
+
+ #update! (id: "", name: nil, metadata: nil, description: nil) ⇒ NgrokAPI::Models::Vault
+
+
+
+
+
+
+101
+102
+103
+104
+105
+106
+107
+108
+109
+110
+111
+112
+
+
+ # File 'lib/ngrokapi/services/vaults_client.rb', line 101
+
+def update! ( id: " " , name: nil , metadata: nil , description: nil )
+ path = ' /vaults/%{id} ' replacements = {
+ id: id ,
+ }
+ data = { }
+ data [ :name ] = name if name
+ data [ :metadata ] = metadata if metadata
+ data [ :description ] = description if description
+ result = @client . patch ( path % replacements , data: data , danger: true )
+ NgrokAPI :: Models :: Vault . new ( client: self , attrs: result )
+end
+
+
+
+
+
+
+
+
+
+
+
+ Secret (NgrokAPI::Models)
+
+
+
+
+ SecretsClient (NgrokAPI::Services)
+
+
+
Services
+
+ V
+
+
+
+ Vault (NgrokAPI::Models)
+
+
+
+
+ VaultsClient (NgrokAPI::Services)
+
+
+
+
+
+
+
W
@@ -1287,9 +1323,9 @@
diff --git a/doc/class_list.html b/doc/class_list.html
index 4b8aadf..1dd9c62 100644
--- a/doc/class_list.html
+++ b/doc/class_list.html
@@ -43,7 +43,7 @@
Error < StandardError
NgrokAPI APIKey < Object
NgrokAPI::Models Ref < Object
NgrokAPI::Models Tunnel < Object
NgrokAPI::Models Error < StandardError
NgrokAPI APIKey < Object
NgrokAPI::Models Ref < Object
NgrokAPI::Models Secret < Object
NgrokAPI::Models Tunnel < Object
NgrokAPI::Models Vault < Object
NgrokAPI::Models
diff --git a/doc/file.README.html b/doc/file.README.html
index 796d62b..54e6bb3 100644
--- a/doc/file.README.html
+++ b/doc/file.README.html
@@ -166,9 +166,9 @@
diff --git a/doc/index.html b/doc/index.html
index e12cc3e..acebabe 100644
--- a/doc/index.html
+++ b/doc/index.html
@@ -166,9 +166,9 @@
diff --git a/doc/method_list.html b/doc/method_list.html
index 6b54529..a513920 100644
--- a/doc/method_list.html
+++ b/doc/method_list.html
@@ -52,6 +52,22 @@
+
+
+
#==
+
NgrokAPI::Models::Vault
+
+
+
+
+
+
#==
+
NgrokAPI::Models::Secret
+
+
+
#==
@@ -940,6 +956,22 @@
+
+
+
#attrs
+
NgrokAPI::Models::Vault
+
+
+
+
+
+
#attrs
+
NgrokAPI::Models::Secret
+
+
+
#attrs
@@ -1972,6 +2004,22 @@
+
+
+
#client
+
NgrokAPI::Models::Vault
+
+
+
+
+
+
#client
+
NgrokAPI::Models::Secret
+
+
+
#client
@@ -2229,6 +2277,14 @@
+
+
#client
+
NgrokAPI::Services::VaultsClient
+
+
+
+
#client NgrokAPI::Models::ApplicationUser
@@ -2236,7 +2292,7 @@
-
+
#client NgrokAPI::Models::EndpointBackend
@@ -2244,7 +2300,7 @@
-
+
#client NgrokAPI::Models::FailoverBackend
@@ -2252,7 +2308,7 @@
-
+
#client NgrokAPI::Models::HTTPSEdgeRoute
@@ -2260,7 +2316,7 @@
-
+
#client NgrokAPI::Models::WeightedBackend
@@ -2268,6 +2324,14 @@
+
+
+
#client
+
NgrokAPI::Services::SecretsClient
+
+
+
#client
@@ -3348,6 +3412,22 @@
+
+
+
#create
+
NgrokAPI::Services::VaultsClient
+
+
+
+
+
+
#create
+
NgrokAPI::Services::SecretsClient
+
+
+
#create
@@ -3580,6 +3660,22 @@
+
+
+
#create!
+
NgrokAPI::Services::VaultsClient
+
+
+
+
+
+
#create!
+
NgrokAPI::Services::SecretsClient
+
+
+
#create!
@@ -3812,6 +3908,22 @@
+
+
+
+
+
+
+
+
+
+
#created_at
@@ -4052,6 +4164,22 @@
+
+
+
+
+
+
+
+
+
+
#credential
@@ -4132,6 +4260,22 @@
+
+
+
#delete
+
NgrokAPI::Models::Vault
+
+
+
+
+
+
#delete
+
NgrokAPI::Models::Secret
+
+
+
#delete
@@ -4261,6 +4405,14 @@
+
+
#delete
+
NgrokAPI::Services::VaultsClient
+
+
+
+
#delete NgrokAPI::Models::ApplicationUser
@@ -4268,7 +4420,7 @@
-
+
#delete NgrokAPI::Models::FailoverBackend
@@ -4276,7 +4428,7 @@
-
+
#delete NgrokAPI::Models::HTTPSEdgeRoute
@@ -4284,7 +4436,7 @@
-
+
#delete NgrokAPI::Models::WeightedBackend
@@ -4292,6 +4444,14 @@
+
+
+
#delete
+
NgrokAPI::Services::SecretsClient
+
+
+
#delete
@@ -4788,6 +4948,22 @@
+
+
+
#delete!
+
NgrokAPI::Services::VaultsClient
+
+
+
+
+
+
#delete!
+
NgrokAPI::Services::SecretsClient
+
+
+
#delete!
@@ -5260,6 +5436,22 @@
+
+
+
+
+
+
+
+
+
+
#description
@@ -6044,6 +6236,22 @@
+
+
+
#get
+
NgrokAPI::Services::VaultsClient
+
+
+
+
+
+
#get
+
NgrokAPI::Services::SecretsClient
+
+
+
#get
@@ -6492,6 +6700,22 @@
+
+
+
#get!
+
NgrokAPI::Services::VaultsClient
+
+
+
+
+
+
#get!
+
NgrokAPI::Services::SecretsClient
+
+
+
#get!
@@ -7044,6 +7268,22 @@
+
+
+
#id
+
NgrokAPI::Models::Vault
+
+
+
+
+
+
#id
+
NgrokAPI::Models::Secret
+
+
+
#id
@@ -7388,6 +7628,22 @@
+
+
+
+
+
+
+
+
+
+
#initialize
@@ -7653,6 +7909,14 @@
+
+
+
+
+
#initialize NgrokAPI::Models::ApplicationUser
@@ -7660,7 +7924,7 @@
-
+
#initialize NgrokAPI::Models::EndpointBackend
@@ -7668,7 +7932,7 @@
-
+
#initialize NgrokAPI::Models::FailoverBackend
@@ -7676,7 +7940,7 @@
-
+
#initialize NgrokAPI::Models::HTTPSEdgeRoute
@@ -7684,7 +7948,7 @@
-
+
#initialize NgrokAPI::Models::WeightedBackend
@@ -7692,6 +7956,14 @@
+
+
+
+
+
#initialize
@@ -8788,6 +9060,22 @@
+
+
+
+
+
+
+
+
+
+
#lat_long_radius_km
@@ -8820,6 +9108,22 @@
+
+
+
#list
+
NgrokAPI::Services::VaultsClient
+
+
+
+
+
+
#list
+
NgrokAPI::Services::SecretsClient
+
+
+
#list
@@ -9068,6 +9372,22 @@
+
+
+
#list!
+
NgrokAPI::Services::VaultsClient
+
+
+
+
+
+
#list!
+
NgrokAPI::Services::SecretsClient
+
+
+
#list!
@@ -9412,6 +9732,22 @@
+
+
+
+
+
+
+
+
+
+
#metadata
@@ -9716,6 +10052,22 @@
+
+
+
#name
+
NgrokAPI::Models::Vault
+
+
+
+
+
+
#name
+
NgrokAPI::Models::Secret
+
+
+
#name
@@ -9942,13 +10294,21 @@
+
+
#port
+
NgrokAPI::Models::Endpoint
+
+
+
+
#post NgrokAPI::HttpClient
@@ -9956,17 +10316,9 @@
-
-
-
-
-
@@ -10813,6 +11165,14 @@
+
+
+
+
+
#serial_number NgrokAPI::Models::TLSCertificate
@@ -10820,7 +11180,7 @@
-
+
#service NgrokAPI::Models::EventTargetDatadog
@@ -10828,7 +11188,7 @@
-
+
#single_logout_url NgrokAPI::Models::EndpointSAML
@@ -10836,7 +11196,7 @@
-
+
#sources NgrokAPI::Models::EventSourceList
@@ -10844,7 +11204,7 @@
-
+
#sources NgrokAPI::Models::EventSubscription
@@ -10852,7 +11212,7 @@
-
+
#ssh_certificate_authorities NgrokAPI::Client
@@ -10860,7 +11220,7 @@
-
+
#ssh_certificate_authority_id NgrokAPI::Models::SSHHostCertificate
@@ -10868,7 +11228,7 @@
-
+
#ssh_certificate_authority_id NgrokAPI::Models::SSHUserCertificate
@@ -10876,7 +11236,7 @@
-
+
#ssh_credentials NgrokAPI::Client
@@ -10884,7 +11244,7 @@
-
+
#ssh_host_certificates NgrokAPI::Client
@@ -10892,7 +11252,7 @@
-
+
#ssh_user_certificates NgrokAPI::Client
@@ -10900,7 +11260,7 @@
-
+
#started_at NgrokAPI::Models::Tunnel
@@ -10908,7 +11268,7 @@
-
+
#started_at NgrokAPI::Models::TunnelSession
@@ -10916,7 +11276,7 @@
-
+
#started_at NgrokAPI::Models::AgentIngressCertJob
@@ -10924,7 +11284,7 @@
-
+
#started_at NgrokAPI::Models::ReservedDomainCertJob
@@ -10932,7 +11292,7 @@
-
+
#status NgrokAPI::Models::AbuseReport
@@ -10940,7 +11300,7 @@
-
+
#status NgrokAPI::Models::AbuseReportHostname
@@ -10948,7 +11308,7 @@
-
+
#status_code NgrokAPI::Models::HTTPResponseBackend
@@ -10956,7 +11316,7 @@
-
+
#stop NgrokAPI::Services::TunnelSessionsClient
@@ -10964,7 +11324,7 @@
-
+
#stop! NgrokAPI::Services::TunnelSessionsClient
@@ -10972,7 +11332,7 @@
-
+
#stream_arn NgrokAPI::Models::EventTargetKinesis
@@ -10980,7 +11340,7 @@
-
+
#subject_alternative_names NgrokAPI::Models::TLSCertificate
@@ -10988,7 +11348,7 @@
-
+
#subject_common_name NgrokAPI::Models::TLSCertificate
@@ -10996,7 +11356,7 @@
-
+
#subject_common_name NgrokAPI::Models::CertificateAuthority
@@ -11004,7 +11364,7 @@
-
+
#subject_country NgrokAPI::Models::TLSCertificate
@@ -11012,7 +11372,7 @@
-
+
#subject_locality NgrokAPI::Models::TLSCertificate
@@ -11020,7 +11380,7 @@
-
+
#subject_organization NgrokAPI::Models::TLSCertificate
@@ -11028,7 +11388,7 @@
-
+
#subject_organizational_unit NgrokAPI::Models::TLSCertificate
@@ -11036,7 +11396,7 @@
-
+
#subject_province NgrokAPI::Models::TLSCertificate
@@ -11044,7 +11404,7 @@
-
+
#target NgrokAPI::Models::EventDestination
@@ -11052,7 +11412,7 @@
-
+
#tcp_addr NgrokAPI::Models::Endpoint
@@ -11060,7 +11420,7 @@
-
+
#teams NgrokAPI::Models::EndpointOAuthGitHub
@@ -11068,7 +11428,7 @@
-
+
#tenant_id NgrokAPI::Models::EventTargetAzureLogsIngestion
@@ -11076,7 +11436,7 @@
-
+
#terminate_at NgrokAPI::Models::EndpointTLSTermination
@@ -11084,7 +11444,7 @@
-
+
#tls NgrokAPI::Models::StaticBackend
@@ -11092,7 +11452,7 @@
-
+
#tls_certificates NgrokAPI::Client
@@ -11100,7 +11460,7 @@
-
+
#tls_termination NgrokAPI::Models::TLSEdge
@@ -11108,7 +11468,7 @@
-
+
#tls_termination NgrokAPI::Models::HTTPSEdge
@@ -11116,7 +11476,7 @@
-
+
#to_h NgrokAPI::Models::Ref
@@ -11124,7 +11484,23 @@
+
+
+
#to_h
+
NgrokAPI::Models::Vault
+
+
+
+
+
#to_h
+
NgrokAPI::Models::Secret
+
+
+
+
#to_h NgrokAPI::Models::Tunnel
@@ -11132,7 +11508,7 @@
-
+
#to_h NgrokAPI::Models::APIKey
@@ -11140,7 +11516,7 @@
-
+
#to_h NgrokAPI::Models::AWSAuth
@@ -11148,7 +11524,7 @@
-
+
#to_h NgrokAPI::Models::AWSRole
@@ -11156,7 +11532,7 @@
-
+
#to_h NgrokAPI::Models::BotUser
@@ -11164,7 +11540,7 @@
-
+
#to_h NgrokAPI::Models::Endpoint
@@ -11172,7 +11548,7 @@
-
+
#to_h NgrokAPI::Models::Location
@@ -11180,7 +11556,7 @@
-
+
#to_h NgrokAPI::Models::TCPEdge
@@ -11188,7 +11564,7 @@
-
+
#to_h NgrokAPI::Models::TLSEdge
@@ -11196,7 +11572,7 @@
-
+
#to_h NgrokAPI::Models::IPPolicy
@@ -11204,7 +11580,7 @@
-
+
#to_h NgrokAPI::Models::Credential
@@ -11212,7 +11588,7 @@
-
+
#to_h NgrokAPI::Models::HTTPSEdge
@@ -11220,7 +11596,7 @@
-
+
#to_h NgrokAPI::Models::UserAgent
@@ -11228,7 +11604,7 @@
-
+
#to_h NgrokAPI::Models::AbuseReport
@@ -11236,7 +11612,7 @@
-
+
#to_h NgrokAPI::Models::EventSource
@@ -11244,7 +11620,7 @@
-
+
#to_h NgrokAPI::Models::EventTarget
@@ -11252,7 +11628,7 @@
-
+
#to_h NgrokAPI::Models::AgentIngress
@@ -11260,7 +11636,7 @@
-
+
#to_h NgrokAPI::Models::EndpointOIDC
@@ -11268,7 +11644,7 @@
-
+
#to_h NgrokAPI::Models::EndpointSAML
@@ -11276,7 +11652,7 @@
-
+
#to_h NgrokAPI::Models::ReservedAddr
@@ -11284,7 +11660,7 @@
-
+
#to_h NgrokAPI::Models::IPPolicyRule
@@ -11292,7 +11668,7 @@
-
+
#to_h NgrokAPI::Models::IPRestriction
@@ -11300,7 +11676,7 @@
-
+
#to_h NgrokAPI::Models::SSHCredential
@@ -11308,7 +11684,7 @@
-
+
#to_h NgrokAPI::Models::StaticBackend
@@ -11316,7 +11692,7 @@
-
+
#to_h NgrokAPI::Models::TunnelSession
@@ -11324,7 +11700,7 @@
-
+
#to_h NgrokAPI::Models::AWSCredentials
@@ -11332,7 +11708,7 @@
-
+
#to_h NgrokAPI::Models::BrowserSession
@@ -11340,7 +11716,7 @@
-
+
#to_h NgrokAPI::Models::EndpointOAuth
@@ -11348,7 +11724,7 @@
-
+
#to_h NgrokAPI::Models::ReservedDomain
@@ -11356,7 +11732,7 @@
-
+
#to_h NgrokAPI::Models::TLSCertificate
@@ -11364,7 +11740,7 @@
-
+
#to_h NgrokAPI::Models::ApplicationUser
@@ -11372,7 +11748,7 @@
-
+
#to_h NgrokAPI::Models::EndpointBackend
@@ -11380,7 +11756,7 @@
-
+
#to_h NgrokAPI::Models::FailoverBackend
@@ -11388,7 +11764,7 @@
-
+
#to_h NgrokAPI::Models::HTTPSEdgeRoute
@@ -11396,7 +11772,7 @@
-
+
#to_h NgrokAPI::Models::WeightedBackend
@@ -11404,7 +11780,7 @@
-
+
#to_h NgrokAPI::Models::EventDestination
@@ -11412,7 +11788,7 @@
-
+
#to_h NgrokAPI::Models::EventSourceList
@@ -11420,7 +11796,7 @@
-
+
#to_h NgrokAPI::Models::IdentityProvider
@@ -11428,7 +11804,7 @@
-
+
#to_h NgrokAPI::Models::EndpointIPPolicy
@@ -11436,7 +11812,7 @@
-
+