Class: OneSignal::Player

Inherits:
OneSignal show all
Defined in:
lib/one_signal/player.rb

Constant Summary

Constants included from OneSignal

VERSION

Class Method Summary collapse

Class Method Details

.all(params: {}, opts: {}) ⇒ Object 



23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
 
# File 'lib/one_signal/player.rb', line 23

def self.all(params: {}, opts: {})
  opts[:auth_key] ||= @@api_key

  uri_string = @@base_uri
  uri_string += "/players"
  uri = URI.parse(uri_string)

  response = send_get_request(uri: uri, params: params, opts: opts)

  ensure_http_status(response: response,
                     status: '200',
                     method_name: 'All',
                     uri: uri,
                     params: params)

  return response
end

.create(params: {}, opts: {}) ⇒ Object 



60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
 
# File 'lib/one_signal/player.rb', line 60

def self.create(params: {}, opts: {})
  opts[:auth_key] ||= @@api_key

  uri_string = @@base_uri
  uri_string += "/players"
  uri = URI.parse(uri_string)

  response = send_post_request(uri: uri, body: params, opts: opts)

  ensure_http_status(response: response,
                     status: '200',
                     method_name: 'Create',
                     uri: uri,
                     params: params)

  return response
end

.create_focus(id: "", params: {}, opts: {}) ⇒ Object 



118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
 
# File 'lib/one_signal/player.rb', line 118

def self.create_focus(id: "", params: {}, opts: {})
  opts[:auth_key] ||= @@api_key

  uri_string = @@base_uri
  uri_string += "/players"
  uri_string += "/#{id}"
  uri_string += "/on_focus"
  uri = URI.parse(uri_string)

  response = send_post_request(uri: uri, body: params, opts: opts)

  ensure_http_status(response: response,
                     status: '200',
                     method_name: 'Create Focus',
                     uri: uri,
                     params: params)

  return response
end

.create_purchase(id: "", params: {}, opts: {}) ⇒ Object 



98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
 
# File 'lib/one_signal/player.rb', line 98

def self.create_purchase(id: "", params: {}, opts: {})
  opts[:auth_key] ||= @@api_key

  uri_string = @@base_uri
  uri_string += "/players"
  uri_string += "/#{id}"
  uri_string += "/on_purchase"
  uri = URI.parse(uri_string)

  response = send_post_request(uri: uri, body: params, opts: opts)

  ensure_http_status(response: response,
                     status: '200',
                     method_name: 'Create Purchase',
                     uri: uri,
                     params: params)

  return response
end

.create_session(id: "", params: {}, opts: {}) ⇒ Object 



78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
 
# File 'lib/one_signal/player.rb', line 78

def self.create_session(id: "", params: {}, opts: {})
  opts[:auth_key] ||= @@api_key

  uri_string = @@base_uri
  uri_string += "/players"
  uri_string += "/#{id}"
  uri_string += "/on_session"
  uri = URI.parse(uri_string)

  response = send_post_request(uri: uri, body: params, opts: opts)

  ensure_http_status(response: response,
                     status: '200',
                     method_name: 'Create Session',
                     uri: uri,
                     params: params)

  return response
end

.csv_export(params: {}, opts: {}) ⇒ Object 



5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
 
# File 'lib/one_signal/player.rb', line 5

def self.csv_export(params: {}, opts: {})
  opts[:auth_key] ||= @@api_key

  uri_string = @@base_uri
  uri_string += "/players/csv_export"
  uri = URI.parse(uri_string)

  response = send_post_request(uri: uri, body: params, opts: opts)

  ensure_http_status(response: response,
                     status: '200',
                     method_name: 'CSV Export',
                     uri: uri,
                     params: {})

  return response
end

.delete(id: "", params: {}, opts: {}) ⇒ Object 



157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
 
# File 'lib/one_signal/player.rb', line 157

def self.delete(id: "", params: {}, opts: {})
  opts[:auth_key] ||= @@api_key

  uri_string = @@base_uri
  uri_string += "/players"
  uri_string += "/#{id}"
  uri = URI.parse(uri_string)

  response = send_delete_request(uri: uri, params: params, opts: opts)

  ensure_http_status(response: response,
                     status: '200',
                     method_name: 'Delete',
                     uri: uri,
                     params: nil)

  return response
end

.get(id: "", opts: {}) ⇒ Object 



41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
 
# File 'lib/one_signal/player.rb', line 41

def self.get(id: "", opts: {})
  opts[:auth_key] ||= @@api_key

  uri_string = @@base_uri
  uri_string += "/players"
  uri_string += "/#{id}"
  uri = URI.parse(uri_string)

  response = send_get_request(uri: uri, params: nil, opts: opts)

  ensure_http_status(response: response,
                     status: '200',
                     method_name: 'Get',
                     uri: uri,
                     params: nil)

  return response
end

.update(id: "", params: {}, opts: {}) ⇒ Object 



138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
 
# File 'lib/one_signal/player.rb', line 138

def self.update(id: "", params: {}, opts: {})
  opts[:auth_key] ||= @@api_key

  uri_string = @@base_uri
  uri_string += "/players"
  uri_string += "/#{id}"
  uri = URI.parse(uri_string)

  response = send_put_request(uri: uri, body: params, opts: opts)

  ensure_http_status(response: response,
                     status: '200',
                     method_name: 'Update',
                     uri: uri,
                     params: params)

  return response
end