class PluralKitAPI::ProxyingApi

Attributes

api_client[RW]

Public Class Methods

new(api_client = ApiClient.default) click to toggle source
# File lib/pluralkit-api/api/proxying_api.rb, line 19
def initialize(api_client = ApiClient.default)
  @api_client = api_client
end

Public Instance Methods

msg_id_get(id, opts = {}) click to toggle source

Gets information about a proxied message by its message ID. @param 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. @param [Hash] opts the optional parameters @return [Message]

# 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 = {}) click to toggle source

Gets information about a proxied message by its message ID. @param id [String] A Discord message ID. This may refer to either the original "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. @param [Hash] opts the optional parameters @return [Array<(Message, Integer, Hash)>] Message data, response status code and response headers

# 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