klaviyo 2.0.6 → 2.0.4
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- checksums.yaml +4 -4
- data/klaviyo.gemspec +2 -2
- data/lib/klaviyo/apis/metrics.rb +2 -0
- data/lib/klaviyo/apis/profiles.rb +2 -1
- data/lib/klaviyo/apis/public.rb +2 -2
- data/lib/klaviyo/client.rb +16 -35
- data/lib/klaviyo/klaviyo_module.rb +0 -1
- metadata +2 -3
- data/lib/klaviyo/apis/email_templates.rb +0 -97
checksums.yaml
CHANGED
@@ -1,7 +1,7 @@
|
|
1
1
|
---
|
2
2
|
SHA256:
|
3
|
-
metadata.gz:
|
4
|
-
data.tar.gz:
|
3
|
+
metadata.gz: 28360ee80e88095a3cab7c279740506e843483536659a59b2ac4473e2163e489
|
4
|
+
data.tar.gz: 68e8e4561cdb1790f786b195a83ae3ea557aaf69ff9c7c9356b09cee33f724d6
|
5
5
|
SHA512:
|
6
|
-
metadata.gz:
|
7
|
-
data.tar.gz:
|
6
|
+
metadata.gz: 46def1393ec8838ccfe6c966f0aa0e0651fa3354b6c580a42e764245636aab1e7cc7894d221c405fd23abed2c7bed2ea3a0cc3f1b04841f2ee061538bf5297b0
|
7
|
+
data.tar.gz: 4d5bd8ee0ae050dc333c0b2cf5b3c4be06875a08ea9b6bfa1c3479f755b0d44c255facc7c6cafec76d094714ed74e8bb94ac137fe302b22f29ac12e9477e5bb0
|
data/klaviyo.gemspec
CHANGED
@@ -2,8 +2,8 @@ files = ['klaviyo.gemspec', '{lib}/**/**/*'].map {|f| Dir[f]}.flatten
|
|
2
2
|
|
3
3
|
Gem::Specification.new do |s|
|
4
4
|
s.name = 'klaviyo'
|
5
|
-
s.version = '2.0.
|
6
|
-
s.date = '2021-04-
|
5
|
+
s.version = '2.0.4'
|
6
|
+
s.date = '2021-04-02'
|
7
7
|
s.summary = 'You heard us, a Ruby wrapper for the Klaviyo API'
|
8
8
|
s.description = 'Ruby wrapper for the Klaviyo API'
|
9
9
|
s.authors = ['Klaviyo Team']
|
data/lib/klaviyo/apis/metrics.rb
CHANGED
data/lib/klaviyo/apis/public.rb
CHANGED
@@ -66,9 +66,9 @@ module Klaviyo
|
|
66
66
|
:properties => kwargs[:properties],
|
67
67
|
:customer_properties => customer_properties
|
68
68
|
}
|
69
|
-
params[:time] = kwargs[:time] if kwargs[:time]
|
69
|
+
params[:time] = kwargs[:time].to_time.to_i if kwargs[:time]
|
70
70
|
|
71
|
-
public_request(HTTP_GET, 'track',
|
71
|
+
public_request(HTTP_GET, 'track', params)
|
72
72
|
end
|
73
73
|
|
74
74
|
def self.track_once(event, kwargs = {})
|
data/lib/klaviyo/client.rb
CHANGED
@@ -10,76 +10,57 @@ module Klaviyo
|
|
10
10
|
HTTP_PUT = 'put'
|
11
11
|
|
12
12
|
ALL = 'all'
|
13
|
-
METRIC = 'metric'
|
14
|
-
METRICS = 'metrics'
|
15
13
|
TIMELINE = 'timeline'
|
16
14
|
|
17
15
|
DEFAULT_COUNT = 100
|
18
16
|
DEFAULT_PAGE = 0
|
19
17
|
DEFAULT_SORT_DESC = 'desc'
|
20
18
|
|
21
|
-
CONTENT_JSON = 'application/json'
|
22
|
-
CONTENT_URL_FORM = 'application/x-www-form-urlencoded'
|
23
|
-
|
24
19
|
private
|
25
20
|
|
26
|
-
def self.request(method, path,
|
21
|
+
def self.request(method, path, kwargs = {})
|
27
22
|
check_private_api_key_exists()
|
28
23
|
url = "#{BASE_API_URL}/#{path}"
|
29
24
|
connection = Faraday.new(
|
30
25
|
url: url,
|
31
26
|
headers: {
|
32
|
-
'Content-Type' =>
|
27
|
+
'Content-Type' => 'application/json'
|
33
28
|
})
|
34
|
-
if content_type == CONTENT_JSON
|
35
|
-
kwargs[:body] = kwargs[:body].to_json
|
36
|
-
end
|
37
29
|
response = connection.send(method) do |req|
|
38
|
-
req.body = kwargs[:body] || nil
|
30
|
+
req.body = kwargs[:body].to_json || nil
|
39
31
|
end
|
40
32
|
end
|
41
33
|
|
42
|
-
def self.public_request(method, path,
|
34
|
+
def self.public_request(method, path, kwargs = {})
|
43
35
|
check_public_api_key_exists()
|
44
36
|
params = build_params(kwargs)
|
45
37
|
url = "#{BASE_API_URL}/#{path}?#{params}"
|
46
38
|
res = Faraday.get(url).body
|
47
39
|
end
|
48
40
|
|
49
|
-
def self.v1_request(method, path,
|
50
|
-
|
51
|
-
|
52
|
-
|
53
|
-
|
54
|
-
|
55
|
-
|
56
|
-
|
57
|
-
|
58
|
-
request(method, full_url, content_type, data)
|
59
|
-
else
|
60
|
-
defaults = {:page => nil,
|
61
|
-
:count => nil,
|
62
|
-
:since => nil,
|
63
|
-
:sort => nil}
|
64
|
-
params = defaults.merge(kwargs)
|
65
|
-
query_params = encode_params(params)
|
66
|
-
full_url = "#{V1_API}/#{path}?api_key=#{Klaviyo.private_api_key}#{query_params}"
|
67
|
-
request(method, full_url, content_type)
|
68
|
-
end
|
41
|
+
def self.v1_request(method, path, kwargs = {})
|
42
|
+
defaults = {:page => nil,
|
43
|
+
:count => nil,
|
44
|
+
:since => nil,
|
45
|
+
:sort => nil}
|
46
|
+
params = defaults.merge(kwargs)
|
47
|
+
query_params = encode_params(params)
|
48
|
+
full_url = "#{V1_API}/#{path}?api_key=#{Klaviyo.private_api_key}#{query_params}"
|
49
|
+
request(method, full_url)
|
69
50
|
end
|
70
51
|
|
71
|
-
def self.v2_request(method, path,
|
52
|
+
def self.v2_request(method, path, kwargs = {})
|
72
53
|
path = "#{V2_API}/#{path}"
|
73
54
|
key = {
|
74
55
|
"api_key": "#{Klaviyo.private_api_key}"
|
75
56
|
}
|
76
57
|
data = {}
|
77
58
|
data[:body] = key.merge(kwargs)
|
78
|
-
request(method, path,
|
59
|
+
request(method, path, data)
|
79
60
|
end
|
80
61
|
|
81
62
|
def self.build_params(params)
|
82
|
-
"data=#{
|
63
|
+
"data=#{Base64.encode64(JSON.generate(params)).gsub(/\n/,'')}"
|
83
64
|
end
|
84
65
|
|
85
66
|
def self.check_required_args(kwargs)
|
metadata
CHANGED
@@ -1,14 +1,14 @@
|
|
1
1
|
--- !ruby/object:Gem::Specification
|
2
2
|
name: klaviyo
|
3
3
|
version: !ruby/object:Gem::Version
|
4
|
-
version: 2.0.
|
4
|
+
version: 2.0.4
|
5
5
|
platform: ruby
|
6
6
|
authors:
|
7
7
|
- Klaviyo Team
|
8
8
|
autorequire:
|
9
9
|
bindir: bin
|
10
10
|
cert_chain: []
|
11
|
-
date: 2021-04-
|
11
|
+
date: 2021-04-02 00:00:00.000000000 Z
|
12
12
|
dependencies:
|
13
13
|
- !ruby/object:Gem::Dependency
|
14
14
|
name: json
|
@@ -76,7 +76,6 @@ files:
|
|
76
76
|
- lib/klaviyo.rb
|
77
77
|
- lib/klaviyo/apis/campaigns.rb
|
78
78
|
- lib/klaviyo/apis/data_privacy.rb
|
79
|
-
- lib/klaviyo/apis/email_templates.rb
|
80
79
|
- lib/klaviyo/apis/lists.rb
|
81
80
|
- lib/klaviyo/apis/metrics.rb
|
82
81
|
- lib/klaviyo/apis/profiles.rb
|
@@ -1,97 +0,0 @@
|
|
1
|
-
module Klaviyo
|
2
|
-
class EmailTemplates < Client
|
3
|
-
EMAIL_TEMPLATES = 'email-templates'
|
4
|
-
EMAIL_TEMPLATE = 'email-template'
|
5
|
-
CLONE = 'clone'
|
6
|
-
RENDER = 'render'
|
7
|
-
SEND = 'send'
|
8
|
-
|
9
|
-
# Returns a list of all the email templates you've created.
|
10
|
-
# The templates are returned in sorted order by name.
|
11
|
-
# @return [List] of JSON formatted email template objects
|
12
|
-
def self.get_templates()
|
13
|
-
v1_request(HTTP_GET, EMAIL_TEMPLATES)
|
14
|
-
end
|
15
|
-
|
16
|
-
# Creates a new email template
|
17
|
-
# @param :name [String] The name of the email template
|
18
|
-
# @param :html [String] The HTML content for this template
|
19
|
-
# @return [JSON] a JSON object containing information about the email template
|
20
|
-
def self.create_template(name: nil, html: nil)
|
21
|
-
params = {
|
22
|
-
name: name,
|
23
|
-
html: html
|
24
|
-
}
|
25
|
-
v1_request(HTTP_POST, EMAIL_TEMPLATES, content_type: CONTENT_URL_FORM, params: params)
|
26
|
-
end
|
27
|
-
|
28
|
-
# Updates the name and/or HTML content of a template. Only updates imported
|
29
|
-
# HTML templates; does not currently update drag & drop templates
|
30
|
-
# @param template_id [String] The id of the email template
|
31
|
-
# @param :name [String] The name of the email template
|
32
|
-
# @param :html [String] The HTML content for this template
|
33
|
-
# @return [JSON] a JSON object containing information about the email template
|
34
|
-
def self.update_template(template_id, name:, html:)
|
35
|
-
path = "#{EMAIL_TEMPLATE}/#{template_id}"
|
36
|
-
params = {
|
37
|
-
name: name,
|
38
|
-
html: html
|
39
|
-
}
|
40
|
-
v1_request(HTTP_PUT, path, params)
|
41
|
-
end
|
42
|
-
|
43
|
-
# Deletes a given template.
|
44
|
-
# @param template_id [String] The id of the email template
|
45
|
-
# @return [JSON] a JSON object containing information about the email template
|
46
|
-
def self.delete_template(template_id)
|
47
|
-
path = "#{EMAIL_TEMPLATE}/#{template_id}"
|
48
|
-
v1_request(HTTP_DELETE, path)
|
49
|
-
end
|
50
|
-
|
51
|
-
# Creates a copy of a given template with a new name
|
52
|
-
# @param template_id [String] The id of the email template to copy
|
53
|
-
# @param :name [String] The name of the newly cloned email template
|
54
|
-
# @return [JSON] a JSON object containing information about the email template
|
55
|
-
def self.clone_template(template_id, name:)
|
56
|
-
path = "#{EMAIL_TEMPLATE}/#{template_id}/#{CLONE}"
|
57
|
-
params = {
|
58
|
-
name: name
|
59
|
-
}
|
60
|
-
v1_request(HTTP_POST, path, content_type: CONTENT_URL_FORM, params: params)
|
61
|
-
end
|
62
|
-
|
63
|
-
# Renders the specified template with the provided data and return HTML
|
64
|
-
# and text versions of the email
|
65
|
-
# @param template_id [String] The id of the email template to copy
|
66
|
-
# @param :context [Hash] The context the email template will be rendered with
|
67
|
-
# @return [JSON] a JSON object containing information about the email template
|
68
|
-
def self.render_template(template_id, context: {})
|
69
|
-
path = "#{EMAIL_TEMPLATE}/#{template_id}/#{RENDER}"
|
70
|
-
params = {
|
71
|
-
context: context
|
72
|
-
}
|
73
|
-
v1_request(HTTP_POST, path, content_type: CONTENT_URL_FORM, params: params)
|
74
|
-
end
|
75
|
-
|
76
|
-
# Renders the specified template with the provided data and then send the
|
77
|
-
# contents in an email via the service specified
|
78
|
-
# @param template_id [String] The id of the email template to copy
|
79
|
-
# @param :from_email [String] The from email address; used in the reply-to header
|
80
|
-
# @param :from_name [String] The name the email is sent from
|
81
|
-
# @param :subject [String] The subject of the email template
|
82
|
-
# @param :to [Mixed] The email this template is being sent to
|
83
|
-
# @param :context [Hash] The context the email template will be rendered with
|
84
|
-
# @return [JSON] a JSON object containing information about the email template
|
85
|
-
def self.send_template(template_id, from_email:, from_name:, subject:, to:, context: {})
|
86
|
-
path = "#{EMAIL_TEMPLATE}/#{template_id}/#{SEND}"
|
87
|
-
params = {
|
88
|
-
from_email: from_email,
|
89
|
-
from_name: from_name,
|
90
|
-
subject: subject,
|
91
|
-
to: to,
|
92
|
-
context: context
|
93
|
-
}
|
94
|
-
v1_request(HTTP_POST, path, content_type: CONTENT_URL_FORM, params: params)
|
95
|
-
end
|
96
|
-
end
|
97
|
-
end
|