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

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

Get a Message Gets a specific messages by the given ID.

Parameters:

  • id (String) —

    MessageID is the ID of the message.

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

    the optional parameters

Returns:



27
28
29
30
 
# File 'lib/ory-client/api/courier_api.rb', line 27

def get_courier_message(id, opts = {})
  data, _status_code, _headers = get_courier_message_with_http_info(id, opts)
  data
end

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

Get a Message Gets a specific messages by the given ID.

Parameters:

  • id (String) —

    MessageID is the ID of the message.

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

    the optional parameters

Returns:

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

    Message data, response status code and response headers



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
 
# File 'lib/ory-client/api/courier_api.rb', line 37

def get_courier_message_with_http_info(id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: CourierApi.get_courier_message ...'
  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 CourierApi.get_courier_message"
  end
  # resource path
  local_var_path = '/admin/courier/messages/{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] || ['oryAccessToken']

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

#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):

  • :page_size (Integer) —

    Items per Page This is the number of items per page to return. For details on pagination please head over to the [pagination documentation](www.ory.sh/docs/ecosystem/api-design#pagination). (default to 250)

  • :page_token (String) —

    Next Page Token The next page token. For details on pagination please head over to the [pagination documentation](www.ory.sh/docs/ecosystem/api-design#pagination).

  • :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:



93
94
95
96
 
# File 'lib/ory-client/api/courier_api.rb', line 93

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):

  • :page_size (Integer) —

    Items per Page This is the number of items per page to return. For details on pagination please head over to the [pagination documentation](www.ory.sh/docs/ecosystem/api-design#pagination). (default to 250)

  • :page_token (String) —

    Next Page Token The next page token. For details on pagination please head over to the [pagination documentation](www.ory.sh/docs/ecosystem/api-design#pagination).

  • :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



106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
 
# File 'lib/ory-client/api/courier_api.rb', line 106

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[:'page_size'].nil? && opts[:'page_size'] > 1000
    fail ArgumentError, 'invalid value for "opts[:"page_size"]" when calling CourierApi.list_courier_messages, must be smaller than or equal to 1000.'
  end

  if @api_client.config.client_side_validation && !opts[:'page_size'].nil? && opts[:'page_size'] < 1
    fail ArgumentError, 'invalid value for "opts[:"page_size"]" 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[:'page_size'] = opts[:'page_size'] if !opts[:'page_size'].nil?
  query_params[:'page_token'] = opts[:'page_token'] if !opts[:'page_token'].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