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
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
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
|
r"""
This code was generated by
___ _ _ _ _ _ _ ____ ____ ____ _ ____ ____ _ _ ____ ____ ____ ___ __ __
| | | | | | | | | __ | | |__| | __ | __ |___ |\ | |___ |__/ |__| | | | |__/
| |_|_| | |___ | |__| |__| | | | |__] |___ | \| |___ | \ | | | |__| | \
Twilio - Messaging
This is the public Twilio REST API.
NOTE: This class is auto generated by OpenAPI Generator.
https://openapi-generator.tech
Do not edit the class manually.
"""
from datetime import datetime
from typing import Any, Dict, Optional, Union
from twilio.base import deserialize, serialize, values
from twilio.base.instance_resource import InstanceResource
from twilio.base.list_resource import ListResource
from twilio.base.version import Version
class ExternalCampaignInstance(InstanceResource):
"""
:ivar sid: The unique string that identifies a US A2P Compliance resource `QE2c6890da8086d771620e9b13fadeba0b`.
:ivar account_sid: The SID of the [Account](https://www.twilio.com/docs/iam/api/account) that the Campaign belongs to.
:ivar campaign_id: ID of the preregistered campaign.
:ivar messaging_service_sid: The SID of the [Messaging Service](https://www.twilio.com/docs/messaging/api/service-resource) that the resource is associated with.
:ivar date_created: The date and time in GMT when the resource was created specified in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format.
"""
def __init__(self, version: Version, payload: Dict[str, Any]):
super().__init__(version)
self.sid: Optional[str] = payload.get("sid")
self.account_sid: Optional[str] = payload.get("account_sid")
self.campaign_id: Optional[str] = payload.get("campaign_id")
self.messaging_service_sid: Optional[str] = payload.get("messaging_service_sid")
self.date_created: Optional[datetime] = deserialize.iso8601_datetime(
payload.get("date_created")
)
def __repr__(self) -> str:
"""
Provide a friendly representation
:returns: Machine friendly representation
"""
return "<Twilio.Messaging.V1.ExternalCampaignInstance>"
class ExternalCampaignList(ListResource):
def __init__(self, version: Version):
"""
Initialize the ExternalCampaignList
:param version: Version that contains the resource
"""
super().__init__(version)
self._uri = "/Services/PreregisteredUsa2p"
def create(
self,
campaign_id: str,
messaging_service_sid: str,
cnp_migration: Union[bool, object] = values.unset,
) -> ExternalCampaignInstance:
"""
Create the ExternalCampaignInstance
:param campaign_id: ID of the preregistered campaign.
:param messaging_service_sid: The SID of the [Messaging Service](https://www.twilio.com/docs/messaging/api/service-resource) that the resource is associated with.
:param cnp_migration: Customers should use this flag during the ERC registration process to indicate to Twilio that the campaign being registered is undergoing CNP migration. It is important for the user to first trigger the CNP migration process for said campaign in their CSP portal and have Twilio accept the sharing request, before making this api call.
:returns: The created ExternalCampaignInstance
"""
data = values.of(
{
"CampaignId": campaign_id,
"MessagingServiceSid": messaging_service_sid,
"CnpMigration": serialize.boolean_to_string(cnp_migration),
}
)
headers = values.of({"Content-Type": "application/x-www-form-urlencoded"})
headers["Content-Type"] = "application/x-www-form-urlencoded"
headers["Accept"] = "application/json"
payload = self._version.create(
method="POST", uri=self._uri, data=data, headers=headers
)
return ExternalCampaignInstance(self._version, payload)
async def create_async(
self,
campaign_id: str,
messaging_service_sid: str,
cnp_migration: Union[bool, object] = values.unset,
) -> ExternalCampaignInstance:
"""
Asynchronously create the ExternalCampaignInstance
:param campaign_id: ID of the preregistered campaign.
:param messaging_service_sid: The SID of the [Messaging Service](https://www.twilio.com/docs/messaging/api/service-resource) that the resource is associated with.
:param cnp_migration: Customers should use this flag during the ERC registration process to indicate to Twilio that the campaign being registered is undergoing CNP migration. It is important for the user to first trigger the CNP migration process for said campaign in their CSP portal and have Twilio accept the sharing request, before making this api call.
:returns: The created ExternalCampaignInstance
"""
data = values.of(
{
"CampaignId": campaign_id,
"MessagingServiceSid": messaging_service_sid,
"CnpMigration": serialize.boolean_to_string(cnp_migration),
}
)
headers = values.of({"Content-Type": "application/x-www-form-urlencoded"})
headers["Content-Type"] = "application/x-www-form-urlencoded"
headers["Accept"] = "application/json"
payload = await self._version.create_async(
method="POST", uri=self._uri, data=data, headers=headers
)
return ExternalCampaignInstance(self._version, payload)
def __repr__(self) -> str:
"""
Provide a friendly representation
:returns: Machine friendly representation
"""
return "<Twilio.Messaging.V1.ExternalCampaignList>"
|
