Class: Shipeasy::Admin::Generated::KillswitchApi

Inherits:
Object
  • Object
show all
Defined in:
lib/shipeasy_admin/api/killswitch_api.rb

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(api_client = ApiClient.default) ⇒ KillswitchApi

Returns a new instance of KillswitchApi.



19
20
21
 
# File 'lib/shipeasy_admin/api/killswitch_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/shipeasy_admin/api/killswitch_api.rb', line 17

def api_client
  @api_client
end

Instance Method Details

#toggle_killswitch(id, opts = {}) ⇒ ToggleKillswitchResponse

Toggle a killswitch or one of its switches Flips a killswitch on one environment and publishes a new version there. This is the one-call incident verb: it reads the current value, flips it, and publishes, so you don't have to fetch the killswitch first. Every body field is optional, which is what makes the call widen cleanly: - Flip the killswitch — {}. Flips the flat value on prod. - Flip one sub-switch — { \"switchKey\": \"eu_region\" }. Flips that entry on prod, creating it (from false) if it isn't in the map yet. - Set it idempotently — { \"switchKey\": \"eu_region\", \"value\": true }. Publishes exactly that value, so a retried call can't undo the first one. A null value means "flip", not "set to null". - Choose the environment — add \"env\": \"staging\". Omitted, env is prod. The response reports both previous and value, so a caller that asked for a flip can see what it actually changed. Prefer this over PUT /{id}/value and PUT /{id}/switch unless you specifically need those endpoints' unconditional set semantics.

Parameters:

  • id (String) —

    Stable opaque killswitch id (`ksw_…`) or the killswitch's `name`.

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

    the optional parameters

Options Hash (opts):

  • :x_project_id (String) —

    Project the request operates on. Optional — defaults to the project the SDK key belongs to; pass it only to scope a multi-project key (the generated client sets it once from its configuration, so per-call callers never thread it).

  • :toggle_killswitch_request (ToggleKillswitchRequest)

Returns:



29
30
31
32
 
# File 'lib/shipeasy_admin/api/killswitch_api.rb', line 29

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

#toggle_killswitch_with_http_info(id, opts = {}) ⇒ Array<(ToggleKillswitchResponse, Integer, Hash)>

Toggle a killswitch or one of its switches Flips a killswitch on one environment and publishes a new version there. This is the one-call incident verb: it reads the current value, flips it, and publishes, so you don't have to fetch the killswitch first. Every body field is optional, which is what makes the call widen cleanly: - Flip the killswitch — `{}`. Flips the flat `value` on `prod`. - Flip one sub-switch — `{ &quot;switchKey&quot;: &quot;eu_region&quot; }`. Flips that entry on `prod`, creating it (from `false`) if it isn't in the map yet. - Set it idempotently — `{ &quot;switchKey&quot;: &quot;eu_region&quot;, &quot;value&quot;: true }`. Publishes exactly that value, so a retried call can't undo the first one. A `null` `value` means &quot;flip&quot;, not &quot;set to null&quot;. - Choose the environment — add `&quot;env&quot;: &quot;staging&quot;`. Omitted, `env` is `prod`. The response reports both `previous` and `value`, so a caller that asked for a flip can see what it actually changed. Prefer this over `PUT /id/value` and `PUT /id/switch` unless you specifically need those endpoints' unconditional set semantics.

Parameters:

  • id (String) —

    Stable opaque killswitch id (`ksw_…`) or the killswitch's `name`.

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

    the optional parameters

Options Hash (opts):

  • :x_project_id (String) —

    Project the request operates on. Optional — defaults to the project the SDK key belongs to; pass it only to scope a multi-project key (the generated client sets it once from its configuration, so per-call callers never thread it).

  • :toggle_killswitch_request (ToggleKillswitchRequest)

Returns:

  • (Array<(ToggleKillswitchResponse, Integer, Hash)>) —

    ToggleKillswitchResponse data, response status code and response headers



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
89
90
91
92
93
94
95
96
97
98
99
100
101
 
# File 'lib/shipeasy_admin/api/killswitch_api.rb', line 41

def toggle_killswitch_with_http_info(id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: KillswitchApi.toggle_killswitch ...'
  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 KillswitchApi.toggle_killswitch"
  end
  if @api_client.config.client_side_validation && id.to_s.length > 128
    fail ArgumentError, 'invalid value for "id" when calling KillswitchApi.toggle_killswitch, the character length must be smaller than or equal to 128.'
  end

  if @api_client.config.client_side_validation && id.to_s.length < 1
    fail ArgumentError, 'invalid value for "id" when calling KillswitchApi.toggle_killswitch, the character length must be greater than or equal to 1.'
  end

  # resource path
  local_var_path = '/api/admin/killswitches/{id}/toggle'.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']
  # 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
  header_params[:'X-Project-Id'] = opts[:'x_project_id'] if !opts[:'x_project_id'].nil?

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

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

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

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

  new_options = opts.merge(
    :operation => :"KillswitchApi.toggle_killswitch",
    :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: KillswitchApi#toggle_killswitch\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end