Class: Svix::EventsApi

Inherits:
Object
  • Object
show all
Defined in:
lib/svix/api/events_api.rb

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(api_client = ApiClient.default) ⇒ EventsApi

Returns a new instance of EventsApi.



19
20
21
 
# File 'lib/svix/api/events_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/svix/api/events_api.rb', line 17

def api_client
  @api_client
end

Instance Method Details

#v1_events(opts = {}) ⇒ MessageEventsOut

Events Reads the stream of operational webhook events for this environment

Parameters:

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

    the optional parameters

Options Hash (opts):

  • :limit (Integer) —

    Limit the number of returned items

  • :iterator (String) —

    The iterator returned from a prior invocation

  • :event_types (Array<String>) —

    Filter response based on the event type

  • :channels (Array<String>) —

    Filter response based on the event type

  • :after (Time)

Returns:



31
32
33
34
 
# File 'lib/svix/api/events_api.rb', line 31

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

#v1_events_with_http_info(opts = {}) ⇒ Array<(MessageEventsOut, Integer, Hash)>

Events Reads the stream of operational webhook events for this environment

Parameters:

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

    the optional parameters

Options Hash (opts):

  • :limit (Integer) —

    Limit the number of returned items

  • :iterator (String) —

    The iterator returned from a prior invocation

  • :event_types (Array<String>) —

    Filter response based on the event type

  • :channels (Array<String>) —

    Filter response based on the event type

  • :after (Time)

Returns:

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

    MessageEventsOut data, response status code and response headers



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
 
# File 'lib/svix/api/events_api.rb', line 45

def v1_events_with_http_info(opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: EventsApi.v1_events ...'
  end
  if @api_client.config.client_side_validation && !opts[:'limit'].nil? && opts[:'limit'] > 250
    fail ArgumentError, 'invalid value for "opts[:"limit"]" when calling EventsApi.v1_events, must be smaller than or equal to 250.'
  end

  if @api_client.config.client_side_validation && !opts[:'limit'].nil? && opts[:'limit'] < 1
    fail ArgumentError, 'invalid value for "opts[:"limit"]" when calling EventsApi.v1_events, must be greater than or equal to 1.'
  end

  # resource path
  local_var_path = '/api/v1/events'

  # query parameters
  query_params = opts[:query_params] || {}
  query_params[:'limit'] = opts[:'limit'] if !opts[:'limit'].nil?
  query_params[:'iterator'] = opts[:'iterator'] if !opts[:'iterator'].nil?
  query_params[:'event_types'] = @api_client.build_collection_param(opts[:'event_types'], :multi) if !opts[:'event_types'].nil?
  query_params[:'channels'] = @api_client.build_collection_param(opts[:'channels'], :multi) if !opts[:'channels'].nil?
  query_params[:'after'] = opts[:'after'] if !opts[:'after'].nil?

  # 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] || 'MessageEventsOut'

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

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