Class: DocuSign_eSign::PermissionProfile

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

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ PermissionProfile

Initializes the object

Parameters:

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

    Model attributes in the form of hash


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
98
99
100
# File 'lib/docusign_esign/models/permission_profile.rb', line 65

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

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

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

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

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

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

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

Instance Attribute Details

#modified_by_usernameObject

Returns the value of attribute modified_by_username


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

def modified_by_username
  @modified_by_username
end

#modified_date_timeObject

Returns the value of attribute modified_date_time


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

def modified_date_time
  @modified_date_time
end

#permission_profile_idObject

Returns the value of attribute permission_profile_id


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

def permission_profile_id
  @permission_profile_id
end

#permission_profile_nameObject

Returns the value of attribute permission_profile_name


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

def permission_profile_name
  @permission_profile_name
end

#settingsObject

Returns the value of attribute settings


29
30
31
# File 'lib/docusign_esign/models/permission_profile.rb', line 29

def settings
  @settings
end

#user_countObject

Returns the value of attribute user_count


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

def user_count
  @user_count
end

#usersObject

Returns the value of attribute users


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

def users
  @users
end

Class Method Details

.attribute_mapObject

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


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

def self.attribute_map
  {
    :'modified_by_username' => :'modifiedByUsername',
    :'modified_date_time' => :'modifiedDateTime',
    :'permission_profile_id' => :'permissionProfileId',
    :'permission_profile_name' => :'permissionProfileName',
    :'settings' => :'settings',
    :'user_count' => :'userCount',
    :'users' => :'users'
  }
end

.swagger_typesObject

Attribute type mapping.


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

def self.swagger_types
  {
    :'modified_by_username' => :'String',
    :'modified_date_time' => :'String',
    :'permission_profile_id' => :'String',
    :'permission_profile_name' => :'String',
    :'settings' => :'AccountRoleSettings',
    :'user_count' => :'String',
    :'users' => :'Array<UserInformation>'
  }
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object)

    to be compared


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

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      modified_by_username == o.modified_by_username &&
      modified_date_time == o.modified_date_time &&
      permission_profile_id == o.permission_profile_id &&
      permission_profile_name == o.permission_profile_name &&
      settings == o.settings &&
      user_count == o.user_count &&
      users == o.users
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


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
201
# File 'lib/docusign_esign/models/permission_profile.rb', line 165

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


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

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


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

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

131
132
133
# File 'lib/docusign_esign/models/permission_profile.rb', line 131

def eql?(o)
  self == o
end

#hashFixnum

Calculates hash code according to all attributes.

Returns:

  • (Fixnum)

    Hash code


137
138
139
# File 'lib/docusign_esign/models/permission_profile.rb', line 137

def hash
  [modified_by_username, modified_date_time, permission_profile_id, permission_profile_name, settings, user_count, users].hash
end

#list_invalid_propertiesObject

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

Returns:

  • Array for valid properties with the reasons


104
105
106
107
# File 'lib/docusign_esign/models/permission_profile.rb', line 104

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


211
212
213
# File 'lib/docusign_esign/models/permission_profile.rb', line 211

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


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

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


205
206
207
# File 'lib/docusign_esign/models/permission_profile.rb', line 205

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


111
112
113
# File 'lib/docusign_esign/models/permission_profile.rb', line 111

def valid?
  true
end