File: room_recording_rule.py

package info (click to toggle)
python-twilio 6.51.0%2Bds-1
  • links: PTS, VCS
  • area: main
  • in suites: bullseye
  • size: 12,260 kB
  • sloc: python: 128,982; makefile: 51
file content (178 lines) | stat: -rw-r--r-- 5,850 bytes parent folder | download
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
# coding=utf-8
r"""
This code was generated by
\ / _    _  _|   _  _
 | (_)\/(_)(_|\/| |(/_  v1.0.0
      /       /
"""

from twilio.base import deserialize
from twilio.base import serialize
from twilio.base import values
from twilio.base.instance_resource import InstanceResource
from twilio.base.list_resource import ListResource
from twilio.base.page import Page


class RecordingRulesList(ListResource):
    """ PLEASE NOTE that this class contains beta products that are subject to
    change. Use them with caution. """

    def __init__(self, version, room_sid):
        """
        Initialize the RecordingRulesList

        :param Version version: Version that contains the resource
        :param room_sid: The SID of the Room resource for the Recording Rules

        :returns: twilio.rest.video.v1.room.room_recording_rule.RecordingRulesList
        :rtype: twilio.rest.video.v1.room.room_recording_rule.RecordingRulesList
        """
        super(RecordingRulesList, self).__init__(version)

        # Path Solution
        self._solution = {'room_sid': room_sid, }
        self._uri = '/Rooms/{room_sid}/RecordingRules'.format(**self._solution)

    def fetch(self):
        """
        Fetch the RecordingRulesInstance

        :returns: The fetched RecordingRulesInstance
        :rtype: twilio.rest.video.v1.room.room_recording_rule.RecordingRulesInstance
        """
        payload = self._version.fetch(method='GET', uri=self._uri, )

        return RecordingRulesInstance(self._version, payload, room_sid=self._solution['room_sid'], )

    def update(self, rules=values.unset):
        """
        Update the RecordingRulesInstance

        :param dict rules: A JSON-encoded array of recording rules

        :returns: The updated RecordingRulesInstance
        :rtype: twilio.rest.video.v1.room.room_recording_rule.RecordingRulesInstance
        """
        data = values.of({'Rules': serialize.object(rules), })

        payload = self._version.update(method='POST', uri=self._uri, data=data, )

        return RecordingRulesInstance(self._version, payload, room_sid=self._solution['room_sid'], )

    def __repr__(self):
        """
        Provide a friendly representation

        :returns: Machine friendly representation
        :rtype: str
        """
        return '<Twilio.Video.V1.RecordingRulesList>'


class RecordingRulesPage(Page):
    """ PLEASE NOTE that this class contains beta products that are subject to
    change. Use them with caution. """

    def __init__(self, version, response, solution):
        """
        Initialize the RecordingRulesPage

        :param Version version: Version that contains the resource
        :param Response response: Response from the API
        :param room_sid: The SID of the Room resource for the Recording Rules

        :returns: twilio.rest.video.v1.room.room_recording_rule.RecordingRulesPage
        :rtype: twilio.rest.video.v1.room.room_recording_rule.RecordingRulesPage
        """
        super(RecordingRulesPage, self).__init__(version, response)

        # Path Solution
        self._solution = solution

    def get_instance(self, payload):
        """
        Build an instance of RecordingRulesInstance

        :param dict payload: Payload response from the API

        :returns: twilio.rest.video.v1.room.room_recording_rule.RecordingRulesInstance
        :rtype: twilio.rest.video.v1.room.room_recording_rule.RecordingRulesInstance
        """
        return RecordingRulesInstance(self._version, payload, room_sid=self._solution['room_sid'], )

    def __repr__(self):
        """
        Provide a friendly representation

        :returns: Machine friendly representation
        :rtype: str
        """
        return '<Twilio.Video.V1.RecordingRulesPage>'


class RecordingRulesInstance(InstanceResource):
    """ PLEASE NOTE that this class contains beta products that are subject to
    change. Use them with caution. """

    def __init__(self, version, payload, room_sid):
        """
        Initialize the RecordingRulesInstance

        :returns: twilio.rest.video.v1.room.room_recording_rule.RecordingRulesInstance
        :rtype: twilio.rest.video.v1.room.room_recording_rule.RecordingRulesInstance
        """
        super(RecordingRulesInstance, self).__init__(version)

        # Marshaled Properties
        self._properties = {
            'room_sid': payload.get('room_sid'),
            'rules': payload.get('rules'),
            'date_created': deserialize.iso8601_datetime(payload.get('date_created')),
            'date_updated': deserialize.iso8601_datetime(payload.get('date_updated')),
        }

        # Context
        self._context = None
        self._solution = {'room_sid': room_sid, }

    @property
    def room_sid(self):
        """
        :returns: The SID of the Room resource for the Recording Rules
        :rtype: unicode
        """
        return self._properties['room_sid']

    @property
    def rules(self):
        """
        :returns: A collection of recording Rules that describe how to include or exclude matching tracks for recording
        :rtype: list[unicode]
        """
        return self._properties['rules']

    @property
    def date_created(self):
        """
        :returns: The ISO 8601 date and time in GMT when the resource was created
        :rtype: datetime
        """
        return self._properties['date_created']

    @property
    def date_updated(self):
        """
        :returns: The ISO 8601 date and time in GMT when the resource was last updated
        :rtype: datetime
        """
        return self._properties['date_updated']

    def __repr__(self):
        """
        Provide a friendly representation

        :returns: Machine friendly representation
        :rtype: str
        """
        return '<Twilio.Video.V1.RecordingRulesInstance>'