forked from sendgrid/sendgrid-python
-
Notifications
You must be signed in to change notification settings - Fork 0
/
substitution.py
90 lines (73 loc) · 2.49 KB
/
substitution.py
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
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
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
class Substitution(object):
"""A string substitution to be applied to the text and HTML contents of
the body of your email, as well as in the Subject and Reply-To parameters.
"""
def __init__(self, key=None, value=None, p=None):
"""Create a Substitution with the given key and value.
:param key: Text to be replaced with "value" param
:type key: string, optional
:param value: Value to substitute into email
:type value: string, optional
:param name: p is the Personalization object or Personalization object
index
:type name: Personalization, integer, optional
"""
self._key = None
self._value = None
self._personalization = None
if key is not None:
self.key = key
if value is not None:
self.value = value
if p is not None:
self.personalization = p
@property
def key(self):
"""The substitution key.
:rtype key: string
"""
return self._key
@key.setter
def key(self, value):
"""The substitution key.
:param key: The substitution key.
:type key: string
"""
self._key = value
@property
def value(self):
"""The substitution value.
:rtype value: string
"""
return str(self._value) if isinstance(self._value, int) else self._value
@value.setter
def value(self, value):
"""The substitution value.
:param value: The substitution value.
:type value: string
"""
self._value = value
@property
def personalization(self):
"""The Personalization object or Personalization object index
:rtype: Personalization, integer
"""
return self._personalization
@personalization.setter
def personalization(self, value):
"""The Personalization object or Personalization object index
:param value: The Personalization object or Personalization object
index
:type value: Personalization, integer
"""
self._personalization = value
def get(self):
"""
Get a JSON-ready representation of this Substitution.
:returns: This Substitution, ready for use in a request body.
:rtype: dict
"""
substitution = {}
if self.key is not None and self.value is not None:
substitution[self.key] = self.value
return substitution