docusign_esign.models.workflow_step

  1# coding: utf-8
  2
  3"""
  4    DocuSign REST API
  5
  6    The DocuSign REST API provides you with a powerful, convenient, and simple Web services API for interacting with DocuSign.  # noqa: E501
  7
  8    OpenAPI spec version: v2.1
  9    Contact: devcenter@docusign.com
 10    Generated by: https://github.com/swagger-api/swagger-codegen.git
 11"""
 12
 13
 14import pprint
 15import re  # noqa: F401
 16
 17import six
 18
 19from docusign_esign.client.configuration import Configuration
 20
 21
 22class WorkflowStep(object):
 23    """NOTE: This class is auto generated by the swagger code generator program.
 24
 25    Do not edit the class manually.
 26    """
 27
 28    """
 29    Attributes:
 30      swagger_types (dict): The key is attribute name
 31                            and the value is attribute type.
 32      attribute_map (dict): The key is attribute name
 33                            and the value is json key in definition.
 34    """
 35    swagger_types = {
 36        'action': 'str',
 37        'completed_date': 'str',
 38        'delayed_routing': 'DelayedRouting',
 39        'item_id': 'str',
 40        'recipient_routing': 'RecipientRouting',
 41        'status': 'str',
 42        'triggered_date': 'str',
 43        'trigger_on_item': 'str',
 44        'workflow_step_id': 'str'
 45    }
 46
 47    attribute_map = {
 48        'action': 'action',
 49        'completed_date': 'completedDate',
 50        'delayed_routing': 'delayedRouting',
 51        'item_id': 'itemId',
 52        'recipient_routing': 'recipientRouting',
 53        'status': 'status',
 54        'triggered_date': 'triggeredDate',
 55        'trigger_on_item': 'triggerOnItem',
 56        'workflow_step_id': 'workflowStepId'
 57    }
 58
 59    def __init__(self, _configuration=None, **kwargs):  # noqa: E501
 60        """WorkflowStep - a model defined in Swagger"""  # noqa: E501
 61        if _configuration is None:
 62            _configuration = Configuration()
 63        self._configuration = _configuration
 64
 65        self._action = None
 66        self._completed_date = None
 67        self._delayed_routing = None
 68        self._item_id = None
 69        self._recipient_routing = None
 70        self._status = None
 71        self._triggered_date = None
 72        self._trigger_on_item = None
 73        self._workflow_step_id = None
 74        self.discriminator = None
 75
 76        setattr(self, "_{}".format('action'), kwargs.get('action', None))
 77        setattr(self, "_{}".format('completed_date'), kwargs.get('completed_date', None))
 78        setattr(self, "_{}".format('delayed_routing'), kwargs.get('delayed_routing', None))
 79        setattr(self, "_{}".format('item_id'), kwargs.get('item_id', None))
 80        setattr(self, "_{}".format('recipient_routing'), kwargs.get('recipient_routing', None))
 81        setattr(self, "_{}".format('status'), kwargs.get('status', None))
 82        setattr(self, "_{}".format('triggered_date'), kwargs.get('triggered_date', None))
 83        setattr(self, "_{}".format('trigger_on_item'), kwargs.get('trigger_on_item', None))
 84        setattr(self, "_{}".format('workflow_step_id'), kwargs.get('workflow_step_id', None))
 85
 86    @property
 87    def action(self):
 88        """Gets the action of this WorkflowStep.  # noqa: E501
 89
 90          # noqa: E501
 91
 92        :return: The action of this WorkflowStep.  # noqa: E501
 93        :rtype: str
 94        """
 95        return self._action
 96
 97    @action.setter
 98    def action(self, action):
 99        """Sets the action of this WorkflowStep.
100
101          # noqa: E501
102
103        :param action: The action of this WorkflowStep.  # noqa: E501
104        :type: str
105        """
106
107        self._action = action
108
109    @property
110    def completed_date(self):
111        """Gets the completed_date of this WorkflowStep.  # noqa: E501
112
113          # noqa: E501
114
115        :return: The completed_date of this WorkflowStep.  # noqa: E501
116        :rtype: str
117        """
118        return self._completed_date
119
120    @completed_date.setter
121    def completed_date(self, completed_date):
122        """Sets the completed_date of this WorkflowStep.
123
124          # noqa: E501
125
126        :param completed_date: The completed_date of this WorkflowStep.  # noqa: E501
127        :type: str
128        """
129
130        self._completed_date = completed_date
131
132    @property
133    def delayed_routing(self):
134        """Gets the delayed_routing of this WorkflowStep.  # noqa: E501
135
136        A complex element that specifies the delayed routing settings for the workflow step.  # noqa: E501
137
138        :return: The delayed_routing of this WorkflowStep.  # noqa: E501
139        :rtype: DelayedRouting
140        """
141        return self._delayed_routing
142
143    @delayed_routing.setter
144    def delayed_routing(self, delayed_routing):
145        """Sets the delayed_routing of this WorkflowStep.
146
147        A complex element that specifies the delayed routing settings for the workflow step.  # noqa: E501
148
149        :param delayed_routing: The delayed_routing of this WorkflowStep.  # noqa: E501
150        :type: DelayedRouting
151        """
152
153        self._delayed_routing = delayed_routing
154
155    @property
156    def item_id(self):
157        """Gets the item_id of this WorkflowStep.  # noqa: E501
158
159          # noqa: E501
160
161        :return: The item_id of this WorkflowStep.  # noqa: E501
162        :rtype: str
163        """
164        return self._item_id
165
166    @item_id.setter
167    def item_id(self, item_id):
168        """Sets the item_id of this WorkflowStep.
169
170          # noqa: E501
171
172        :param item_id: The item_id of this WorkflowStep.  # noqa: E501
173        :type: str
174        """
175
176        self._item_id = item_id
177
178    @property
179    def recipient_routing(self):
180        """Gets the recipient_routing of this WorkflowStep.  # noqa: E501
181
182        The rules for recipient routing.  # noqa: E501
183
184        :return: The recipient_routing of this WorkflowStep.  # noqa: E501
185        :rtype: RecipientRouting
186        """
187        return self._recipient_routing
188
189    @recipient_routing.setter
190    def recipient_routing(self, recipient_routing):
191        """Sets the recipient_routing of this WorkflowStep.
192
193        The rules for recipient routing.  # noqa: E501
194
195        :param recipient_routing: The recipient_routing of this WorkflowStep.  # noqa: E501
196        :type: RecipientRouting
197        """
198
199        self._recipient_routing = recipient_routing
200
201    @property
202    def status(self):
203        """Gets the status of this WorkflowStep.  # noqa: E501
204
205        Indicates the envelope status. Valid values are:  * sent - The envelope is sent to the recipients.  * created - The envelope is saved as a draft and can be modified and sent later.  # noqa: E501
206
207        :return: The status of this WorkflowStep.  # noqa: E501
208        :rtype: str
209        """
210        return self._status
211
212    @status.setter
213    def status(self, status):
214        """Sets the status of this WorkflowStep.
215
216        Indicates the envelope status. Valid values are:  * sent - The envelope is sent to the recipients.  * created - The envelope is saved as a draft and can be modified and sent later.  # noqa: E501
217
218        :param status: The status of this WorkflowStep.  # noqa: E501
219        :type: str
220        """
221
222        self._status = status
223
224    @property
225    def triggered_date(self):
226        """Gets the triggered_date of this WorkflowStep.  # noqa: E501
227
228          # noqa: E501
229
230        :return: The triggered_date of this WorkflowStep.  # noqa: E501
231        :rtype: str
232        """
233        return self._triggered_date
234
235    @triggered_date.setter
236    def triggered_date(self, triggered_date):
237        """Sets the triggered_date of this WorkflowStep.
238
239          # noqa: E501
240
241        :param triggered_date: The triggered_date of this WorkflowStep.  # noqa: E501
242        :type: str
243        """
244
245        self._triggered_date = triggered_date
246
247    @property
248    def trigger_on_item(self):
249        """Gets the trigger_on_item of this WorkflowStep.  # noqa: E501
250
251          # noqa: E501
252
253        :return: The trigger_on_item of this WorkflowStep.  # noqa: E501
254        :rtype: str
255        """
256        return self._trigger_on_item
257
258    @trigger_on_item.setter
259    def trigger_on_item(self, trigger_on_item):
260        """Sets the trigger_on_item of this WorkflowStep.
261
262          # noqa: E501
263
264        :param trigger_on_item: The trigger_on_item of this WorkflowStep.  # noqa: E501
265        :type: str
266        """
267
268        self._trigger_on_item = trigger_on_item
269
270    @property
271    def workflow_step_id(self):
272        """Gets the workflow_step_id of this WorkflowStep.  # noqa: E501
273
274          # noqa: E501
275
276        :return: The workflow_step_id of this WorkflowStep.  # noqa: E501
277        :rtype: str
278        """
279        return self._workflow_step_id
280
281    @workflow_step_id.setter
282    def workflow_step_id(self, workflow_step_id):
283        """Sets the workflow_step_id of this WorkflowStep.
284
285          # noqa: E501
286
287        :param workflow_step_id: The workflow_step_id of this WorkflowStep.  # noqa: E501
288        :type: str
289        """
290
291        self._workflow_step_id = workflow_step_id
292
293    def to_dict(self):
294        """Returns the model properties as a dict"""
295        result = {}
296
297        for attr, _ in six.iteritems(self.swagger_types):
298            value = getattr(self, attr)
299            if isinstance(value, list):
300                result[attr] = list(map(
301                    lambda x: x.to_dict() if hasattr(x, "to_dict") else x,
302                    value
303                ))
304            elif hasattr(value, "to_dict"):
305                result[attr] = value.to_dict()
306            elif isinstance(value, dict):
307                result[attr] = dict(map(
308                    lambda item: (item[0], item[1].to_dict())
309                    if hasattr(item[1], "to_dict") else item,
310                    value.items()
311                ))
312            else:
313                result[attr] = value
314        if issubclass(WorkflowStep, dict):
315            for key, value in self.items():
316                result[key] = value
317
318        return result
319
320    def to_str(self):
321        """Returns the string representation of the model"""
322        return pprint.pformat(self.to_dict())
323
324    def __repr__(self):
325        """For `print` and `pprint`"""
326        return self.to_str()
327
328    def __eq__(self, other):
329        """Returns true if both objects are equal"""
330        if not isinstance(other, WorkflowStep):
331            return False
332
333        return self.to_dict() == other.to_dict()
334
335    def __ne__(self, other):
336        """Returns true if both objects are not equal"""
337        if not isinstance(other, WorkflowStep):
338            return True
339
340        return self.to_dict() != other.to_dict()