Class: OryClient::CourierApi

Inherits:
Object
  • Object
show all
Defined in:
lib/ory-client/api/courier_api.rb

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(api_client = ApiClient.default) ⇒ CourierApi

Returns a new instance of CourierApi.



19
20
21
 
# File 'lib/ory-client/api/courier_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/ory-client/api/courier_api.rb', line 17

def api_client
  @api_client
end

Instance Method Details

#list_courier_messages(opts = {}) ⇒ Array<Message>

List Messages Lists all messages by given status and recipient.

Parameters:

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

    the optional parameters

Options Hash (opts):

  • :per_page (Integer) —

    Items per Page This is the number of items per page. (default to 250)

  • :page (Integer) —

    Pagination Page This value is currently an integer, but it is not sequential. The value is not the page number, but a reference. The next page can be any number and some numbers might return an empty list. For example, page 2 might not follow after page 1. And even if page 3 and 5 exist, but page 4 might not exist. (default to 1)

  • :status (CourierMessageStatus) —

    Status filters out messages based on status. If no value is provided, it doesn&#39;t take effect on filter.

  • :recipient (String) —

    Recipient filters out messages based on recipient. If no value is provided, it doesn&#39;t take effect on filter.

Returns:



30
31
32
33
 
# File 'lib/ory-client/api/courier_api.rb', line 30

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

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

List Messages Lists all messages by given status and recipient.

Parameters:

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

    the optional parameters

Options Hash (opts):

  • :per_page (Integer) —

    Items per Page This is the number of items per page. (default to 250)

  • :page (Integer) —

    Pagination Page This value is currently an integer, but it is not sequential. The value is not the page number, but a reference. The next page can be any number and some numbers might return an empty list. For example, page 2 might not follow after page 1. And even if page 3 and 5 exist, but page 4 might not exist. (default to 1)

  • :status (CourierMessageStatus) —

    Status filters out messages based on status. If no value is provided, it doesn&#39;t take effect on filter.

  • :recipient (String) —

    Recipient filters out messages based on recipient. If no value is provided, it doesn&#39;t take effect on filter.

Returns:

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

    Array<Message> data, response status code and response headers



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/ory-client/api/courier_api.rb', line 43

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

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

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

  # resource path
  local_var_path = '/admin/courier/messages'

  # query parameters
  query_params = opts[:query_params] || {}
  query_params[:'per_page'] = opts[:'per_page'] if !opts[:'per_page'].nil?
  query_params[:'page'] = opts[:'page'] if !opts[:'page'].nil?
  query_params[:'status'] = opts[:'status'] if !opts[:'status'].nil?
  query_params[:'recipient'] = opts[:'recipient'] if !opts[:'recipient'].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] || 'Array<Message>'

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

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