Class: Notifo::MobilePushApi

Inherits:
Object
  • Object
show all
Defined in:
lib/notifo/api/mobile_push_api.rb

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(api_client = ApiClient.default) ⇒ MobilePushApi

Returns a new instance of MobilePushApi.



16
17
18
 
# File 'lib/notifo/api/mobile_push_api.rb', line 16

def initialize(api_client = ApiClient.default)
  @api_client = api_client
end

Instance Attribute Details

#api_client ⇒ Object

Returns the value of attribute api_client.



14
15
16
 
# File 'lib/notifo/api/mobile_push_api.rb', line 14

def api_client
  @api_client
end

Instance Method Details

#mobile_push_delete_my_token(token, opts = {}) ⇒ nil

Deletes a mobile push token for the current user.

Parameters:

  • token —

    The token to remove.

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

    the optional parameters

Returns:

  • (nil) 


23
24
25
26
 
# File 'lib/notifo/api/mobile_push_api.rb', line 23

def mobile_push_delete_my_token(token, opts = {})
  mobile_push_delete_my_token_with_http_info(token, opts)
  nil
end

#mobile_push_delete_my_token_with_http_info(token, opts = {}) ⇒ Array<(nil, Integer, Hash)>

Deletes a mobile push token for the current user.

Parameters:

  • token —

    The token to remove.

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

    the optional parameters

Returns:

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

    nil, response status code and response headers



32
33
34
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
 
# File 'lib/notifo/api/mobile_push_api.rb', line 32

def mobile_push_delete_my_token_with_http_info(token, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: MobilePushApi.mobile_push_delete_my_token ...'
  end
  # verify the required parameter 'token' is set
  if @api_client.config.client_side_validation && token.nil?
    fail ArgumentError, "Missing the required parameter 'token' when calling MobilePushApi.mobile_push_delete_my_token"
  end
  # resource path
  local_var_path = '/api/me/mobilepush/{token}'.sub('{' + 'token' + '}', token.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[:body] 

  return_type = opts[:return_type] 

  auth_names = opts[:auth_names] || []
  data, status_code, headers = @api_client.call_api(:DELETE, local_var_path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type)

  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: MobilePushApi#mobile_push_delete_my_token\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#mobile_push_get_my_token(opts = {}) ⇒ ListResponseDtoOfMobilePushTokenDto

Returns the mobile push tokens.

Parameters:

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

    the optional parameters

Returns:



76
77
78
79
 
# File 'lib/notifo/api/mobile_push_api.rb', line 76

def mobile_push_get_my_token(opts = {})
  data, _status_code, _headers = mobile_push_get_my_token_with_http_info(opts)
  data
end

#mobile_push_get_my_token_with_http_info(opts = {}) ⇒ Array<(ListResponseDtoOfMobilePushTokenDto, Integer, Hash)>

Returns the mobile push tokens.

Parameters:

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

    the optional parameters

Returns:



84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
 
# File 'lib/notifo/api/mobile_push_api.rb', line 84

def mobile_push_get_my_token_with_http_info(opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: MobilePushApi.mobile_push_get_my_token ...'
  end
  # resource path
  local_var_path = '/api/me/mobilepush'

  # 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[:body] 

  return_type = opts[:return_type] || 'ListResponseDtoOfMobilePushTokenDto' 

  auth_names = opts[:auth_names] || []
  data, status_code, headers = @api_client.call_api(:GET, local_var_path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type)

  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: MobilePushApi#mobile_push_get_my_token\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#mobile_push_post_my_token(body, opts = {}) ⇒ nil

Register a mobile push token for the current user.

Parameters:

  • body —

    The request object.

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

    the optional parameters

Returns:

  • (nil) 


125
126
127
128
 
# File 'lib/notifo/api/mobile_push_api.rb', line 125

def mobile_push_post_my_token(body, opts = {})
  mobile_push_post_my_token_with_http_info(body, opts)
  nil
end

#mobile_push_post_my_token_with_http_info(body, opts = {}) ⇒ Array<(nil, Integer, Hash)>

Register a mobile push token for the current user.

Parameters:

  • body —

    The request object.

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

    the optional parameters

Returns:

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

    nil, response status code and response headers



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
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
 
# File 'lib/notifo/api/mobile_push_api.rb', line 134

def mobile_push_post_my_token_with_http_info(body, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: MobilePushApi.mobile_push_post_my_token ...'
  end
  # verify the required parameter 'body' is set
  if @api_client.config.client_side_validation && body.nil?
    fail ArgumentError, "Missing the required parameter 'body' when calling MobilePushApi.mobile_push_post_my_token"
  end
  # resource path
  local_var_path = '/api/me/mobilepush'

  # 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'])
  # HTTP header 'Content-Type'
  header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])

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

  # http body (model)
  post_body = opts[:body] || @api_client.object_to_http_body(body) 

  return_type = opts[:return_type] 

  auth_names = opts[:auth_names] || []
  data, status_code, headers = @api_client.call_api(:POST, local_var_path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type)

  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: MobilePushApi#mobile_push_post_my_token\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end