Class: DocuSign_eSign::ConnectSalesforceObject

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

Overview

A ‘connectSalesforceObject` is an object that updates envelope and document status or recipient status in your Salesforce account. When you install DocuSign Connect for Salesforce, the service automatically sets up two Connect objects: one that updates envelope status and documents and one that updates recipient status. You can also customize DocuSign Connect for Salesforce by associating DocuSign objects with Salesforce objects so that DocuSign Connect for Salesforce updates or inserts the information into the Salesforce object. For more information, see [DocuSign for Salesforce - Adding Completed Documents to the Notes and Attachments](support.docusign.com/articles/DocuSign-for-Salesforce-Adding-Completed-Documents-to-the-Notes-and-Attachments-New).

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ ConnectSalesforceObject

Initializes the object

Parameters:

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

    Model attributes in the form of hash



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

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?(:'active')
    self.active = attributes[:'active']
  end

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

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

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

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

  if attributes.has_key?(:'selectFields')
    if (value = attributes[:'selectFields']).is_a?(Array)
      self.select_fields = value
    end
  end

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

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

  if attributes.has_key?(:'updateFields')
    if (value = attributes[:'updateFields']).is_a?(Array)
      self.update_fields = value
    end
  end
end

Instance Attribute Details

#active ⇒ Object

Returns the value of attribute active.



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

def active
  @active
end

#description ⇒ Object

Returns the value of attribute description.



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

def description
  @description
end

#id ⇒ Object

Returns the value of attribute id.



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

def id
  @id
end

#insert ⇒ Object

Returns the value of attribute insert.



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

def insert
  @insert
end

#on_complete_only ⇒ Object

Returns the value of attribute on_complete_only.



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

def on_complete_only
  @on_complete_only
end

#select_fields ⇒ Object

Returns the value of attribute select_fields.



33
34
35
 
# File 'lib/docusign_esign/models/connect_salesforce_object.rb', line 33

def select_fields
  @select_fields
end

#sf_object ⇒ Object

Returns the value of attribute sf_object.



36
37
38
 
# File 'lib/docusign_esign/models/connect_salesforce_object.rb', line 36

def sf_object
  @sf_object
end

#sf_object_name ⇒ Object

Returns the value of attribute sf_object_name.



39
40
41
 
# File 'lib/docusign_esign/models/connect_salesforce_object.rb', line 39

def sf_object_name
  @sf_object_name
end

#update_fields ⇒ Object

Returns the value of attribute update_fields.



42
43
44
 
# File 'lib/docusign_esign/models/connect_salesforce_object.rb', line 42

def update_fields
  @update_fields
end

Class Method Details

.attribute_map ⇒ Object

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



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

def self.attribute_map
  {
    :'active' => :'active',
    :'description' => :'description',
    :'id' => :'id',
    :'insert' => :'insert',
    :'on_complete_only' => :'onCompleteOnly',
    :'select_fields' => :'selectFields',
    :'sf_object' => :'sfObject',
    :'sf_object_name' => :'sfObjectName',
    :'update_fields' => :'updateFields'
  }
end

.swagger_types ⇒ Object

Attribute type mapping.



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

def self.swagger_types
  {
    :'active' => :'String',
    :'description' => :'String',
    :'id' => :'String',
    :'insert' => :'String',
    :'on_complete_only' => :'String',
    :'select_fields' => :'Array<ConnectSalesforceField>',
    :'sf_object' => :'String',
    :'sf_object_name' => :'String',
    :'update_fields' => :'Array<ConnectSalesforceField>'
  }
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object) —

    to be compared



138
139
140
141
142
143
144
145
146
147
148
149
150
 
# File 'lib/docusign_esign/models/connect_salesforce_object.rb', line 138

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      active == o.active &&
      description == o.description &&
      id == o.id &&
      insert == o.insert &&
      on_complete_only == o.on_complete_only &&
      select_fields == o.select_fields &&
      sf_object == o.sf_object &&
      sf_object_name == o.sf_object_name &&
      update_fields == o.update_fields
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



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

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



254
255
256
257
258
259
260
261
262
263
264
265
266
 
# File 'lib/docusign_esign/models/connect_salesforce_object.rb', line 254

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



167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
 
# File 'lib/docusign_esign/models/connect_salesforce_object.rb', line 167

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


154
155
156
 
# File 'lib/docusign_esign/models/connect_salesforce_object.rb', line 154

def eql?(o)
  self == o
end

#hash ⇒ Fixnum

Calculates hash code according to all attributes.

Returns:

  • (Fixnum) —

    Hash code



160
161
162
 
# File 'lib/docusign_esign/models/connect_salesforce_object.rb', line 160

def hash
  [active, description, id, insert, on_complete_only, select_fields, sf_object, sf_object_name, update_fields].hash
end

#list_invalid_properties ⇒ Object

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

Returns:

  • Array for valid properties with the reasons



125
126
127
128
 
# File 'lib/docusign_esign/models/connect_salesforce_object.rb', line 125

def list_invalid_properties
  invalid_properties = Array.new
  invalid_properties
end

#to_body ⇒ Hash

to_body is an alias to to_hash (backward compatibility)

Returns:

  • (Hash) —

    Returns the object in the form of hash



234
235
236
 
# File 'lib/docusign_esign/models/connect_salesforce_object.rb', line 234

def to_body
  to_hash
end

#to_hash ⇒ Hash

Returns the object in the form of hash

Returns:

  • (Hash) —

    Returns the object in the form of hash



240
241
242
243
244
245
246
247
248
 
# File 'lib/docusign_esign/models/connect_salesforce_object.rb', line 240

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_s ⇒ String

Returns the string representation of the object

Returns:

  • (String) —

    String presentation of the object



228
229
230
 
# File 'lib/docusign_esign/models/connect_salesforce_object.rb', line 228

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



132
133
134
 
# File 'lib/docusign_esign/models/connect_salesforce_object.rb', line 132

def valid?
  true
end