Class: DocuSign_eSign::PlanInformation

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

Overview

An object used to identify the features and attributes of the account being created.

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ PlanInformation

Initializes the object

Parameters:

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

    Model attributes in the form of hash


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

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?(:'addOns')
    if (value = attributes[:'addOns']).is_a?(Array)
      self.add_ons = value
    end
  end

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

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

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

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

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

Instance Attribute Details

#add_onsObject

Reserved:


19
20
21
# File 'lib/docusign_esign/models/plan_information.rb', line 19

def add_ons
  @add_ons
end

#currency_codeObject

Specifies the ISO currency code for the account.


22
23
24
# File 'lib/docusign_esign/models/plan_information.rb', line 22

def currency_code
  @currency_code
end

#free_trial_days_overrideObject

Reserved for DocuSign use only.


25
26
27
# File 'lib/docusign_esign/models/plan_information.rb', line 25

def free_trial_days_override
  @free_trial_days_override
end

#plan_feature_setsObject

A complex type that sets the feature sets for the account.


28
29
30
# File 'lib/docusign_esign/models/plan_information.rb', line 28

def plan_feature_sets
  @plan_feature_sets
end

#plan_idObject

The DocuSign Plan ID for the account.


31
32
33
# File 'lib/docusign_esign/models/plan_information.rb', line 31

def plan_id
  @plan_id
end

#recipient_domainsObject

Returns the value of attribute recipient_domains


34
35
36
# File 'lib/docusign_esign/models/plan_information.rb', line 34

def recipient_domains
  @recipient_domains
end

Class Method Details

.attribute_mapObject

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


37
38
39
40
41
42
43
44
45
46
# File 'lib/docusign_esign/models/plan_information.rb', line 37

def self.attribute_map
  {
    :'add_ons' => :'addOns',
    :'currency_code' => :'currencyCode',
    :'free_trial_days_override' => :'freeTrialDaysOverride',
    :'plan_feature_sets' => :'planFeatureSets',
    :'plan_id' => :'planId',
    :'recipient_domains' => :'recipientDomains'
  }
end

.swagger_typesObject

Attribute type mapping.


49
50
51
52
53
54
55
56
57
58
# File 'lib/docusign_esign/models/plan_information.rb', line 49

def self.swagger_types
  {
    :'add_ons' => :'Array<AddOn>',
    :'currency_code' => :'String',
    :'free_trial_days_override' => :'String',
    :'plan_feature_sets' => :'Array<FeatureSet>',
    :'plan_id' => :'String',
    :'recipient_domains' => :'Array<RecipientDomain>'
  }
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object)

    to be compared


114
115
116
117
118
119
120
121
122
123
# File 'lib/docusign_esign/models/plan_information.rb', line 114

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      add_ons == o.add_ons &&
      currency_code == o.currency_code &&
      free_trial_days_override == o.free_trial_days_override &&
      plan_feature_sets == o.plan_feature_sets &&
      plan_id == o.plan_id &&
      recipient_domains == o.recipient_domains
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


161
162
163
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
# File 'lib/docusign_esign/models/plan_information.rb', line 161

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


227
228
229
230
231
232
233
234
235
236
237
238
239
# File 'lib/docusign_esign/models/plan_information.rb', line 227

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


140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
# File 'lib/docusign_esign/models/plan_information.rb', line 140

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

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

def eql?(o)
  self == o
end

#hashFixnum

Calculates hash code according to all attributes.

Returns:

  • (Fixnum)

    Hash code


133
134
135
# File 'lib/docusign_esign/models/plan_information.rb', line 133

def hash
  [add_ons, currency_code, free_trial_days_override, plan_feature_sets, plan_id, recipient_domains].hash
end

#list_invalid_propertiesObject

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

Returns:

  • Array for valid properties with the reasons


101
102
103
104
# File 'lib/docusign_esign/models/plan_information.rb', line 101

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


207
208
209
# File 'lib/docusign_esign/models/plan_information.rb', line 207

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


213
214
215
216
217
218
219
220
221
# File 'lib/docusign_esign/models/plan_information.rb', line 213

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


201
202
203
# File 'lib/docusign_esign/models/plan_information.rb', line 201

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


108
109
110
# File 'lib/docusign_esign/models/plan_information.rb', line 108

def valid?
  true
end