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 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 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253
|
r"""
This code was generated by
___ _ _ _ _ _ _ ____ ____ ____ _ ____ ____ _ _ ____ ____ ____ ___ __ __
| | | | | | | | | __ | | |__| | __ | __ |___ |\ | |___ |__/ |__| | | | |__/
| |_|_| | |___ | |__| |__| | | | |__] |___ | \| |___ | \ | | | |__| | \
Twilio - Bulkexports
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 typing import Any, Dict, Optional
from twilio.base import values
from twilio.base.instance_context import InstanceContext
from twilio.base.instance_resource import InstanceResource
from twilio.base.list_resource import ListResource
from twilio.base.version import Version
class JobInstance(InstanceResource):
"""
:ivar resource_type: The type of communication – Messages, Calls, Conferences, and Participants
:ivar friendly_name: The friendly name specified when creating the job
:ivar details: The details of a job which is an object that contains an array of status grouped by `status` state. Each `status` object has a `status` string, a count which is the number of days in that `status`, and list of days in that `status`. The day strings are in the format yyyy-MM-dd. As an example, a currently running job may have a status object for COMPLETED and a `status` object for SUBMITTED each with its own count and list of days.
:ivar start_day: The start time for the export specified when creating the job
:ivar end_day: The end time for the export specified when creating the job
:ivar job_sid: The job_sid returned when the export was created
:ivar webhook_url: The optional webhook url called on completion
:ivar webhook_method: This is the method used to call the webhook
:ivar email: The optional email to send the completion notification to
:ivar url:
:ivar job_queue_position: This is the job position from the 1st in line. Your queue position will never increase. As jobs ahead of yours in the queue are processed, the queue position number will decrease
:ivar estimated_completion_time: this is the time estimated until your job is complete. This is calculated each time you request the job list. The time is calculated based on the current rate of job completion (which may vary) and your job queue position
"""
def __init__(
self, version: Version, payload: Dict[str, Any], job_sid: Optional[str] = None
):
super().__init__(version)
self.resource_type: Optional[str] = payload.get("resource_type")
self.friendly_name: Optional[str] = payload.get("friendly_name")
self.details: Optional[Dict[str, object]] = payload.get("details")
self.start_day: Optional[str] = payload.get("start_day")
self.end_day: Optional[str] = payload.get("end_day")
self.job_sid: Optional[str] = payload.get("job_sid")
self.webhook_url: Optional[str] = payload.get("webhook_url")
self.webhook_method: Optional[str] = payload.get("webhook_method")
self.email: Optional[str] = payload.get("email")
self.url: Optional[str] = payload.get("url")
self.job_queue_position: Optional[str] = payload.get("job_queue_position")
self.estimated_completion_time: Optional[str] = payload.get(
"estimated_completion_time"
)
self._solution = {
"job_sid": job_sid or self.job_sid,
}
self._context: Optional[JobContext] = None
@property
def _proxy(self) -> "JobContext":
"""
Generate an instance context for the instance, the context is capable of
performing various actions. All instance actions are proxied to the context
:returns: JobContext for this JobInstance
"""
if self._context is None:
self._context = JobContext(
self._version,
job_sid=self._solution["job_sid"],
)
return self._context
def delete(self) -> bool:
"""
Deletes the JobInstance
:returns: True if delete succeeds, False otherwise
"""
return self._proxy.delete()
async def delete_async(self) -> bool:
"""
Asynchronous coroutine that deletes the JobInstance
:returns: True if delete succeeds, False otherwise
"""
return await self._proxy.delete_async()
def fetch(self) -> "JobInstance":
"""
Fetch the JobInstance
:returns: The fetched JobInstance
"""
return self._proxy.fetch()
async def fetch_async(self) -> "JobInstance":
"""
Asynchronous coroutine to fetch the JobInstance
:returns: The fetched JobInstance
"""
return await self._proxy.fetch_async()
def __repr__(self) -> str:
"""
Provide a friendly representation
:returns: Machine friendly representation
"""
context = " ".join("{}={}".format(k, v) for k, v in self._solution.items())
return "<Twilio.Bulkexports.V1.JobInstance {}>".format(context)
class JobContext(InstanceContext):
def __init__(self, version: Version, job_sid: str):
"""
Initialize the JobContext
:param version: Version that contains the resource
:param job_sid: The unique string that that we created to identify the Bulk Export job
"""
super().__init__(version)
# Path Solution
self._solution = {
"job_sid": job_sid,
}
self._uri = "/Exports/Jobs/{job_sid}".format(**self._solution)
def delete(self) -> bool:
"""
Deletes the JobInstance
:returns: True if delete succeeds, False otherwise
"""
headers = values.of({})
return self._version.delete(method="DELETE", uri=self._uri, headers=headers)
async def delete_async(self) -> bool:
"""
Asynchronous coroutine that deletes the JobInstance
:returns: True if delete succeeds, False otherwise
"""
headers = values.of({})
return await self._version.delete_async(
method="DELETE", uri=self._uri, headers=headers
)
def fetch(self) -> JobInstance:
"""
Fetch the JobInstance
:returns: The fetched JobInstance
"""
headers = values.of({})
headers["Accept"] = "application/json"
payload = self._version.fetch(method="GET", uri=self._uri, headers=headers)
return JobInstance(
self._version,
payload,
job_sid=self._solution["job_sid"],
)
async def fetch_async(self) -> JobInstance:
"""
Asynchronous coroutine to fetch the JobInstance
:returns: The fetched JobInstance
"""
headers = values.of({})
headers["Accept"] = "application/json"
payload = await self._version.fetch_async(
method="GET", uri=self._uri, headers=headers
)
return JobInstance(
self._version,
payload,
job_sid=self._solution["job_sid"],
)
def __repr__(self) -> str:
"""
Provide a friendly representation
:returns: Machine friendly representation
"""
context = " ".join("{}={}".format(k, v) for k, v in self._solution.items())
return "<Twilio.Bulkexports.V1.JobContext {}>".format(context)
class JobList(ListResource):
def __init__(self, version: Version):
"""
Initialize the JobList
:param version: Version that contains the resource
"""
super().__init__(version)
def get(self, job_sid: str) -> JobContext:
"""
Constructs a JobContext
:param job_sid: The unique string that that we created to identify the Bulk Export job
"""
return JobContext(self._version, job_sid=job_sid)
def __call__(self, job_sid: str) -> JobContext:
"""
Constructs a JobContext
:param job_sid: The unique string that that we created to identify the Bulk Export job
"""
return JobContext(self._version, job_sid=job_sid)
def __repr__(self) -> str:
"""
Provide a friendly representation
:returns: Machine friendly representation
"""
return "<Twilio.Bulkexports.V1.JobList>"
|