Class: DocuSign_eSign::BulkEnvelope

Inherits:
Object
  • Object
show all
Defined in:
lib/docusign_esign/models/bulk_envelope.rb

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ BulkEnvelope

Initializes the object

Parameters:

  • attributes (Hash) (defaults to: {})

    Model attributes in the form of hash


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
# File 'lib/docusign_esign/models/bulk_envelope.rb', line 75

def initialize(attributes = {})
  return unless attributes.is_a?(Hash)

  # convert string to symbol for hash key
  attributes = attributes.each_with_object({}) { |(k, v), h| h[k.to_sym] = v }

  if attributes.has_key?(:'bulkRecipientRow')
    self.bulk_recipient_row = attributes[:'bulkRecipientRow']
  end

  if attributes.has_key?(:'bulkStatus')
    self.bulk_status = attributes[:'bulkStatus']
  end

  if attributes.has_key?(:'email')
    self.email = attributes[:'email']
  end

  if attributes.has_key?(:'envelopeId')
    self.envelope_id = attributes[:'envelopeId']
  end

  if attributes.has_key?(:'envelopeUri')
    self.envelope_uri = attributes[:'envelopeUri']
  end

  if attributes.has_key?(:'errorDetails')
    self.error_details = attributes[:'errorDetails']
  end

  if attributes.has_key?(:'name')
    self.name = attributes[:'name']
  end

  if attributes.has_key?(:'submittedDateTime')
    self. = attributes[:'submittedDateTime']
  end

  if attributes.has_key?(:'transactionId')
    self.transaction_id = attributes[:'transactionId']
  end
end

Instance Attribute Details

#bulk_recipient_rowObject

Reserved: TBD


18
19
20
# File 'lib/docusign_esign/models/bulk_envelope.rb', line 18

def bulk_recipient_row
  @bulk_recipient_row
end

#bulk_statusObject

Indicates the status of the bulk send operation. Returned values can be: * queued * processing * sent * failed


21
22
23
# File 'lib/docusign_esign/models/bulk_envelope.rb', line 21

def bulk_status
  @bulk_status
end

#emailObject

Returns the value of attribute email


24
25
26
# File 'lib/docusign_esign/models/bulk_envelope.rb', line 24

def email
  @email
end

#envelope_idObject

The envelope ID of the envelope status that failed to post.


27
28
29
# File 'lib/docusign_esign/models/bulk_envelope.rb', line 27

def envelope_id
  @envelope_id
end

#envelope_uriObject

Contains a URI for an endpoint that you can use to retrieve the envelope or envelopes.


30
31
32
# File 'lib/docusign_esign/models/bulk_envelope.rb', line 30

def envelope_uri
  @envelope_uri
end

#error_detailsObject

Returns the value of attribute error_details


32
33
34
# File 'lib/docusign_esign/models/bulk_envelope.rb', line 32

def error_details
  @error_details
end

#nameObject

Returns the value of attribute name


35
36
37
# File 'lib/docusign_esign/models/bulk_envelope.rb', line 35

def name
  @name
end

#submitted_date_timeObject

Returns the value of attribute submitted_date_time


38
39
40
# File 'lib/docusign_esign/models/bulk_envelope.rb', line 38

def 
  @submitted_date_time
end

#transaction_idObject

Used to identify an envelope. The id is a sender-generated value and is valid in the DocuSign system for 7 days. It is recommended that a transaction ID is used for offline signing to ensure that an envelope is not sent multiple times. The `transactionId` property can be used determine an envelope's status (i.e. was it created or not) in cases where the internet connection was lost before the envelope status was returned.


41
42
43
# File 'lib/docusign_esign/models/bulk_envelope.rb', line 41

def transaction_id
  @transaction_id
end

Class Method Details

.attribute_mapObject

Attribute mapping from ruby-style variable name to JSON key.


44
45
46
47
48
49
50
51
52
53
54
55
56
# File 'lib/docusign_esign/models/bulk_envelope.rb', line 44

def self.attribute_map
  {
    :'bulk_recipient_row' => :'bulkRecipientRow',
    :'bulk_status' => :'bulkStatus',
    :'email' => :'email',
    :'envelope_id' => :'envelopeId',
    :'envelope_uri' => :'envelopeUri',
    :'error_details' => :'errorDetails',
    :'name' => :'name',
    :'submitted_date_time' => :'submittedDateTime',
    :'transaction_id' => :'transactionId'
  }
end

.swagger_typesObject

Attribute type mapping.


59
60
61
62
63
64
65
66
67
68
69
70
71
# File 'lib/docusign_esign/models/bulk_envelope.rb', line 59

def self.swagger_types
  {
    :'bulk_recipient_row' => :'String',
    :'bulk_status' => :'String',
    :'email' => :'String',
    :'envelope_id' => :'String',
    :'envelope_uri' => :'String',
    :'error_details' => :'ErrorDetails',
    :'name' => :'String',
    :'submitted_date_time' => :'String',
    :'transaction_id' => :'String'
  }
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object)

    to be compared


133
134
135
136
137
138
139
140
141
142
143
144
145
# File 'lib/docusign_esign/models/bulk_envelope.rb', line 133

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      bulk_recipient_row == o.bulk_recipient_row &&
      bulk_status == o.bulk_status &&
      email == o.email &&
      envelope_id == o.envelope_id &&
      envelope_uri == o.envelope_uri &&
      error_details == o.error_details &&
      name == o.name &&
       == o. &&
      transaction_id == o.transaction_id
end

#_deserialize(type, value) ⇒ Object

Deserializes the data based on type

Parameters:

  • string

    type Data type

  • string

    value Value to be deserialized

Returns:

  • (Object)

    Deserialized data


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
# File 'lib/docusign_esign/models/bulk_envelope.rb', line 183

def _deserialize(type, value)
  case type.to_sym
  when :DateTime
    DateTime.parse(value)
  when :Date
    Date.parse(value)
  when :String
    value.to_s
  when :Integer
    value.to_i
  when :Float
    value.to_f
  when :BOOLEAN
    if value.to_s =~ /\A(true|t|yes|y|1)\z/i
      true
    else
      false
    end
  when :Object
    # generic object (usually a Hash), return directly
    value
  when /\AArray<(?<inner_type>.+)>\z/
    inner_type = Regexp.last_match[:inner_type]
    value.map { |v| _deserialize(inner_type, v) }
  when /\AHash<(?<k_type>.+?), (?<v_type>.+)>\z/
    k_type = Regexp.last_match[:k_type]
    v_type = Regexp.last_match[:v_type]
    {}.tap do |hash|
      value.each do |k, v|
        hash[_deserialize(k_type, k)] = _deserialize(v_type, v)
      end
    end
  else # model
    temp_model = DocuSign_eSign.const_get(type).new
    temp_model.build_from_hash(value)
  end
end

#_to_hash(value) ⇒ Hash

Outputs non-array value in the form of hash For object, use to_hash. Otherwise, just return the value

Parameters:

  • value (Object)

    Any valid value

Returns:

  • (Hash)

    Returns the value in the form of hash


249
250
251
252
253
254
255
256
257
258
259
260
261
# File 'lib/docusign_esign/models/bulk_envelope.rb', line 249

def _to_hash(value)
  if value.is_a?(Array)
    value.compact.map { |v| _to_hash(v) }
  elsif value.is_a?(Hash)
    {}.tap do |hash|
      value.each { |k, v| hash[k] = _to_hash(v) }
    end
  elsif value.respond_to? :to_hash
    value.to_hash
  else
    value
  end
end

#build_from_hash(attributes) ⇒ Object

Builds the object from hash

Parameters:

  • attributes (Hash)

    Model attributes in the form of hash

Returns:

  • (Object)

    Returns the model itself


162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
# File 'lib/docusign_esign/models/bulk_envelope.rb', line 162

def build_from_hash(attributes)
  return nil unless attributes.is_a?(Hash)
  self.class.swagger_types.each_pair do |key, type|
    if type =~ /\AArray<(.*)>/i
      # check to ensure the input is an array given that the attribute
      # is documented as an array but the input is not
      if attributes[self.class.attribute_map[key]].is_a?(Array)
        self.send("#{key}=", attributes[self.class.attribute_map[key]].map { |v| _deserialize($1, v) })
      end
    elsif !attributes[self.class.attribute_map[key]].nil?
      self.send("#{key}=", _deserialize(type, attributes[self.class.attribute_map[key]]))
    end # or else data not found in attributes(hash), not an issue as the data can be optional
  end

  self
end

#eql?(o) ⇒ Boolean

Parameters:

  • Object (Object)

    to be compared

Returns:

  • (Boolean)

See Also:

  • `==` method

149
150
151
# File 'lib/docusign_esign/models/bulk_envelope.rb', line 149

def eql?(o)
  self == o
end

#hashFixnum

Calculates hash code according to all attributes.

Returns:

  • (Fixnum)

    Hash code


155
156
157
# File 'lib/docusign_esign/models/bulk_envelope.rb', line 155

def hash
  [bulk_recipient_row, bulk_status, email, envelope_id, envelope_uri, error_details, name, , transaction_id].hash
end

#list_invalid_propertiesObject

Show invalid properties with the reasons. Usually used together with valid?

Returns:

  • Array for valid properties with the reasons


120
121
122
123
# File 'lib/docusign_esign/models/bulk_envelope.rb', line 120

def list_invalid_properties
  invalid_properties = Array.new
  invalid_properties
end

#to_bodyHash

to_body is an alias to to_hash (backward compatibility)

Returns:

  • (Hash)

    Returns the object in the form of hash


229
230
231
# File 'lib/docusign_esign/models/bulk_envelope.rb', line 229

def to_body
  to_hash
end

#to_hashHash

Returns the object in the form of hash

Returns:

  • (Hash)

    Returns the object in the form of hash


235
236
237
238
239
240
241
242
243
# File 'lib/docusign_esign/models/bulk_envelope.rb', line 235

def to_hash
  hash = {}
  self.class.attribute_map.each_pair do |attr, param|
    value = self.send(attr)
    next if value.nil?
    hash[param] = _to_hash(value)
  end
  hash
end

#to_sString

Returns the string representation of the object

Returns:

  • (String)

    String presentation of the object


223
224
225
# File 'lib/docusign_esign/models/bulk_envelope.rb', line 223

def to_s
  to_hash.to_s
end

#valid?Boolean

Check to see if the all the properties in the model are valid

Returns:

  • (Boolean)

    true if the model is valid


127
128
129
# File 'lib/docusign_esign/models/bulk_envelope.rb', line 127

def valid?
  true
end