Class: Weft::AgentBootstrapApi

Inherits:
Object
  • Object
show all
Defined in:
lib/weft/generated/api/agent_bootstrap_api.rb

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(api_client = ApiClient.default) ⇒ AgentBootstrapApi

Returns a new instance of AgentBootstrapApi.



19
20
21
 
# File 'lib/weft/generated/api/agent_bootstrap_api.rb', line 19

def initialize(api_client = ApiClient.default)
  @api_client = api_client
end

Instance Attribute Details

#api_client ⇒ Object

Returns the value of attribute api_client.



17
18
19
 
# File 'lib/weft/generated/api/agent_bootstrap_api.rb', line 17

def api_client
  @api_client
end

Instance Method Details

#cancel_account_bootstrap(id, opts = {}) ⇒ AccountBootstrapStatusResponse

Cancel or revoke a bootstrap credential A pending bootstrap becomes rejected. A claimed promoted credential becomes revoked and fails every subsequent request immediately.

Parameters:

  • id (String)
  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:



27
28
29
30
 
# File 'lib/weft/generated/api/agent_bootstrap_api.rb', line 27

def (id, opts = {})
  data, _status_code, _headers = (id, opts)
  data
end

#cancel_account_bootstrap_with_http_info(id, opts = {}) ⇒ Array<(AccountBootstrapStatusResponse, Integer, Hash)>

Cancel or revoke a bootstrap credential A pending bootstrap becomes rejected. A claimed promoted credential becomes revoked and fails every subsequent request immediately.

Parameters:

  • id (String)
  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:



37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
 
# File 'lib/weft/generated/api/agent_bootstrap_api.rb', line 37

def (id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: AgentBootstrapApi.cancel_account_bootstrap ...'
  end
  # verify the required parameter 'id' is set
  if @api_client.config.client_side_validation && id.nil?
    fail ArgumentError, "Missing the required parameter 'id' when calling AgentBootstrapApi.cancel_account_bootstrap"
  end
  pattern = Regexp.new(/^boot_[A-Za-z0-9_-]+$/)
  if @api_client.config.client_side_validation && id !~ pattern
    fail ArgumentError, "invalid value for 'id' when calling AgentBootstrapApi.cancel_account_bootstrap, must conform to the pattern #{pattern}."
  end

  # resource path
  local_var_path = '/api/v1/account_bootstraps/{id}'.sub('{' + 'id' + '}', CGI.escape(id.to_s))

  # query parameters
  query_params = opts[:query_params] || {}

  # header parameters
  header_params = opts[:header_params] || {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json']) unless header_params['Accept']

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:debug_body]

  # return_type
  return_type = opts[:debug_return_type] || 'AccountBootstrapStatusResponse'

  # auth_names
  auth_names = opts[:debug_auth_names] || ['bootstrapAuth']

  new_options = opts.merge(
    :operation => :"AgentBootstrapApi.cancel_account_bootstrap",
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type
  )

  data, status_code, headers = @api_client.call_api(:DELETE, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: AgentBootstrapApi#cancel_account_bootstrap\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#create_account_bootstrap(account_bootstrap_request, opts = {}) ⇒ AccountBootstrapCreatedResponse

Create a temporary agent bootstrap Creates a 30-minute, search-only bootstrap and emails a separate claim link to the supplied address. Human approval binds the same wbt_* bearer to the account and promotes it to the fixed durable capability set. The response is deliberately identical for new and existing account emails and never contains the claim token. Rate limits apply per IP and normalized email; request bodies over 4 KiB are rejected before parsing. The bootstrap row and one-time credentials are committed only after the mail relay accepts the claim email. A retryable 503 leaves no bootstrap row behind.

Parameters:

Returns:



95
96
97
98
 
# File 'lib/weft/generated/api/agent_bootstrap_api.rb', line 95

def (, opts = {})
  data, _status_code, _headers = (, opts)
  data
end

#create_account_bootstrap_with_http_info(account_bootstrap_request, opts = {}) ⇒ Array<(AccountBootstrapCreatedResponse, Integer, Hash)>

Create a temporary agent bootstrap Creates a 30-minute, search-only bootstrap and emails a separate claim link to the supplied address. Human approval binds the same `wbt_*` bearer to the account and promotes it to the fixed durable capability set. The response is deliberately identical for new and existing account emails and never contains the claim token. Rate limits apply per IP and normalized email; request bodies over 4 KiB are rejected before parsing. The bootstrap row and one-time credentials are committed only after the mail relay accepts the claim email. A retryable 503 leaves no bootstrap row behind.

Parameters:

Returns:



105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
 
# File 'lib/weft/generated/api/agent_bootstrap_api.rb', line 105

def (, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: AgentBootstrapApi.create_account_bootstrap ...'
  end
  # verify the required parameter 'account_bootstrap_request' is set
  if @api_client.config.client_side_validation && .nil?
    fail ArgumentError, "Missing the required parameter 'account_bootstrap_request' when calling AgentBootstrapApi.create_account_bootstrap"
  end
  # resource path
  local_var_path = '/api/v1/account_bootstraps'

  # query parameters
  query_params = opts[:query_params] || {}

  # header parameters
  header_params = opts[:header_params] || {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json']) unless header_params['Accept']
  # HTTP header 'Content-Type'
  content_type = @api_client.select_header_content_type(['application/json'])
  if !content_type.nil?
      header_params['Content-Type'] = content_type
  end

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:debug_body] || @api_client.object_to_http_body()

  # return_type
  return_type = opts[:debug_return_type] || 'AccountBootstrapCreatedResponse'

  # auth_names
  auth_names = opts[:debug_auth_names] || []

  new_options = opts.merge(
    :operation => :"AgentBootstrapApi.create_account_bootstrap",
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type
  )

  data, status_code, headers = @api_client.call_api(:POST, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: AgentBootstrapApi#create_account_bootstrap\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#get_account_bootstrap(id, opts = {}) ⇒ AccountBootstrapStatusResponse

Read bootstrap lifecycle status

Parameters:

  • id (String)
  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:



162
163
164
165
 
# File 'lib/weft/generated/api/agent_bootstrap_api.rb', line 162

def (id, opts = {})
  data, _status_code, _headers = (id, opts)
  data
end

#get_account_bootstrap_with_http_info(id, opts = {}) ⇒ Array<(AccountBootstrapStatusResponse, Integer, Hash)>

Read bootstrap lifecycle status

Parameters:

  • id (String)
  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:



171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
 
# File 'lib/weft/generated/api/agent_bootstrap_api.rb', line 171

def (id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: AgentBootstrapApi.get_account_bootstrap ...'
  end
  # verify the required parameter 'id' is set
  if @api_client.config.client_side_validation && id.nil?
    fail ArgumentError, "Missing the required parameter 'id' when calling AgentBootstrapApi.get_account_bootstrap"
  end
  pattern = Regexp.new(/^boot_[A-Za-z0-9_-]+$/)
  if @api_client.config.client_side_validation && id !~ pattern
    fail ArgumentError, "invalid value for 'id' when calling AgentBootstrapApi.get_account_bootstrap, must conform to the pattern #{pattern}."
  end

  # resource path
  local_var_path = '/api/v1/account_bootstraps/{id}'.sub('{' + 'id' + '}', CGI.escape(id.to_s))

  # query parameters
  query_params = opts[:query_params] || {}

  # header parameters
  header_params = opts[:header_params] || {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json']) unless header_params['Accept']

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:debug_body]

  # return_type
  return_type = opts[:debug_return_type] || 'AccountBootstrapStatusResponse'

  # auth_names
  auth_names = opts[:debug_auth_names] || ['bootstrapAuth']

  new_options = opts.merge(
    :operation => :"AgentBootstrapApi.get_account_bootstrap",
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type
  )

  data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: AgentBootstrapApi#get_account_bootstrap\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end