Class: DocuSign_eSign::ProvisioningInformation

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

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ ProvisioningInformation

Initializes the object

Parameters:

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

    Model attributes in the form of hash


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

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

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

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

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

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

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

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

Instance Attribute Details

#default_connection_idObject

Returns the value of attribute default_connection_id


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

def default_connection_id
  @default_connection_id
end

#default_plan_idObject

Returns the value of attribute default_plan_id


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

def default_plan_id
  @default_plan_id
end

#distributor_codeObject

The code that identifies the billing plan groups and plans for the new account.


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

def distributor_code
  @distributor_code
end

#distributor_passwordObject

The password for the distributorCode.


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

def distributor_password
  @distributor_password
end

#password_rule_textObject

Returns the value of attribute password_rule_text


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

def password_rule_text
  @password_rule_text
end

#plan_promotion_textObject

Returns the value of attribute plan_promotion_text


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

def plan_promotion_text
  @plan_promotion_text
end

#purchase_order_or_prom_allowedObject

Returns the value of attribute purchase_order_or_prom_allowed


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

def purchase_order_or_prom_allowed
  @purchase_order_or_prom_allowed
end

Class Method Details

.attribute_mapObject

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


39
40
41
42
43
44
45
46
47
48
49
# File 'lib/docusign_esign/models/provisioning_information.rb', line 39

def self.attribute_map
  {
    :'default_connection_id' => :'defaultConnectionId',
    :'default_plan_id' => :'defaultPlanId',
    :'distributor_code' => :'distributorCode',
    :'distributor_password' => :'distributorPassword',
    :'password_rule_text' => :'passwordRuleText',
    :'plan_promotion_text' => :'planPromotionText',
    :'purchase_order_or_prom_allowed' => :'purchaseOrderOrPromAllowed'
  }
end

.swagger_typesObject

Attribute type mapping.


52
53
54
55
56
57
58
59
60
61
62
# File 'lib/docusign_esign/models/provisioning_information.rb', line 52

def self.swagger_types
  {
    :'default_connection_id' => :'String',
    :'default_plan_id' => :'String',
    :'distributor_code' => :'String',
    :'distributor_password' => :'String',
    :'password_rule_text' => :'String',
    :'plan_promotion_text' => :'String',
    :'purchase_order_or_prom_allowed' => :'String'
  }
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object)

    to be compared


116
117
118
119
120
121
122
123
124
125
126
# File 'lib/docusign_esign/models/provisioning_information.rb', line 116

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      default_connection_id == o.default_connection_id &&
      default_plan_id == o.default_plan_id &&
      distributor_code == o.distributor_code &&
      distributor_password == o.distributor_password &&
      password_rule_text == o.password_rule_text &&
      plan_promotion_text == o.plan_promotion_text &&
      purchase_order_or_prom_allowed == o.purchase_order_or_prom_allowed
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


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

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


230
231
232
233
234
235
236
237
238
239
240
241
242
# File 'lib/docusign_esign/models/provisioning_information.rb', line 230

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


143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
# File 'lib/docusign_esign/models/provisioning_information.rb', line 143

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

130
131
132
# File 'lib/docusign_esign/models/provisioning_information.rb', line 130

def eql?(o)
  self == o
end

#hashFixnum

Calculates hash code according to all attributes.

Returns:

  • (Fixnum)

    Hash code


136
137
138
# File 'lib/docusign_esign/models/provisioning_information.rb', line 136

def hash
  [default_connection_id, default_plan_id, distributor_code, distributor_password, password_rule_text, plan_promotion_text, purchase_order_or_prom_allowed].hash
end

#list_invalid_propertiesObject

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

Returns:

  • Array for valid properties with the reasons


103
104
105
106
# File 'lib/docusign_esign/models/provisioning_information.rb', line 103

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


210
211
212
# File 'lib/docusign_esign/models/provisioning_information.rb', line 210

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


216
217
218
219
220
221
222
223
224
# File 'lib/docusign_esign/models/provisioning_information.rb', line 216

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


204
205
206
# File 'lib/docusign_esign/models/provisioning_information.rb', line 204

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


110
111
112
# File 'lib/docusign_esign/models/provisioning_information.rb', line 110

def valid?
  true
end