Class: PluralKitAPI::ProxyingApi

Inherits:
Object
  • Object
show all
Defined in:
lib/pluralkit-api/api/proxying_api.rb

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(api_client = ApiClient.default) ⇒ ProxyingApi

Returns a new instance of ProxyingApi.



19
20
21
 
# File 'lib/pluralkit-api/api/proxying_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/pluralkit-api/api/proxying_api.rb', line 17

def api_client
  @api_client
end

Instance Method Details

#msg_id_get(id, opts = {}) ⇒ Message

Gets information about a proxied message by its message ID.

Parameters:

  • id (String) —

    A Discord message ID. This may refer to either the original "trigger message" posted by the user, or to the resulting webhook message posted by PluralKit. The former may be useful for eg. logging bot integration.

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

    the optional parameters

Returns:



26
27
28
29
 
# File 'lib/pluralkit-api/api/proxying_api.rb', line 26

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

#msg_id_get_with_http_info(id, opts = {}) ⇒ Array<(Message, Integer, Hash)>

Gets information about a proxied message by its message ID.

Parameters:

  • id (String) —

    A Discord message ID. This may refer to either the original &quot;trigger message&quot; posted by the user, or to the resulting webhook message posted by PluralKit. The former may be useful for eg. logging bot integration.

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

    the optional parameters

Returns:

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

    Message data, response status code and response headers



35
36
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
89
90
91
92
93
94
 
# File 'lib/pluralkit-api/api/proxying_api.rb', line 35

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

  if @api_client.config.client_side_validation && id.to_s.length < 17
    fail ArgumentError, 'invalid value for "id" when calling ProxyingApi.msg_id_get, the character length must be great than or equal to 17.'
  end

  pattern = Regexp.new(/^[0-9]{17,19}/)
  if @api_client.config.client_side_validation && id !~ pattern
    fail ArgumentError, "invalid value for 'id' when calling ProxyingApi.msg_id_get, must conform to the pattern #{pattern}."
  end

  # resource path
  local_var_path = '/msg/{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'])

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

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

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

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

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