Class: Mudbase::UpdateProjectRoleRequest

Inherits:
ApiModelBase show all
Defined in:
lib/mudbase/models/update_project_role_request.rb

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Methods inherited from ApiModelBase

_deserialize, #_to_hash, #to_body, #to_s

Constructor Details

#initialize(attributes = {}) ⇒ UpdateProjectRoleRequest

Initializes the object

Parameters:

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

    Model attributes in the form of hash



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
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
 
# File 'lib/mudbase/models/update_project_role_request.rb', line 90

def initialize(attributes = {})
  if (!attributes.is_a?(Hash))
    fail ArgumentError, "The input argument (attributes) must be a hash in `Mudbase::UpdateProjectRoleRequest` initialize method"
  end

  # check to see if the attribute exists and convert string to symbol for hash key
  acceptable_attribute_map = self.class.acceptable_attribute_map
  attributes = attributes.each_with_object({}) { |(k, v), h|
    if (!acceptable_attribute_map.key?(k.to_sym))
      fail ArgumentError, "`#{k}` is not a valid attribute in `Mudbase::UpdateProjectRoleRequest`. Please check the name to make sure it's valid. List of attributes: " + acceptable_attribute_map.keys.inspect
    end
    h[k.to_sym] = v
  }

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

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

  if attributes.key?(:'signup_endpoint')
    self. = attributes[:'signup_endpoint']
  end

  if attributes.key?(:'requires_approval')
    self.requires_approval = attributes[:'requires_approval']
  end

  if attributes.key?(:'requires_payment')
    self.requires_payment = attributes[:'requires_payment']
  end

  if attributes.key?(:'requires_kyc')
    self.requires_kyc = attributes[:'requires_kyc']
  end

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

  if attributes.key?(:'collection_permissions')
    if (value = attributes[:'collection_permissions']).is_a?(Hash)
      self.collection_permissions = value
    end
  end

  if attributes.key?(:'metadata')
    self.metadata = attributes[:'metadata']
  end

  if attributes.key?(:'feature_permissions')
    if (value = attributes[:'feature_permissions']).is_a?(Hash)
      self.feature_permissions = value
    end
  end
end

Instance Attribute Details

#collection_permissions ⇒ Object

Per-collection CRUD map (same as POST add role).



33
34
35
 
# File 'lib/mudbase/models/update_project_role_request.rb', line 33

def collection_permissions
  @collection_permissions
end

#default_permissions ⇒ Object

Returns the value of attribute default_permissions.



30
31
32
 
# File 'lib/mudbase/models/update_project_role_request.rb', line 30

def default_permissions
  @default_permissions
end

#description ⇒ Object

Returns the value of attribute description.



20
21
22
 
# File 'lib/mudbase/models/update_project_role_request.rb', line 20

def description
  @description
end

#feature_permissions ⇒ Object

App JWT feature toggles stored on MultiRoleFeature.roles[].featurePermissions. Structure: { [resource: string]: { [action: string]: boolean } }. Only explicit false on a key that matches the resolved gate denies; missing resources/actions imply no extra denial. Canonical map of (resource, action) pairs enforced at runtime: services/appRoleFeatureMap.js (RULES). Regenerate inventory: node scripts/verify-app-role-feature-map.js. Messaging also accepts legacy keys (email, sms, push, history, stats) alongside send_email, send_sms, send_push, read_history, read_stats — see services/appRoleFeatureService.js (MESSAGING_SYNONYMS). | Resource | Actions (boolean keys under the resource object) | |----------|--------------------------------------------------| | messaging | send_email, send_sms, send_push, read_history, read_stats (legacy: email, sms, push, history, stats) | | integration | read, create, update, delete, execute, test, export, read_usage | | functions | create, read, update, delete, execute, simulate | | data | create, read, update, delete | | search | query, suggestions, read_analytics | | usage | read | | storage | read, create, update, delete, upload | | chat | read, create, update, delete | | realtime | read_analytics, read_active_users, presence, read_throughput, read_history | | roleElevation | request, status, documents | | webhooks | config_read, config_update, test_transformation |



38
39
40
 
# File 'lib/mudbase/models/update_project_role_request.rb', line 38

def feature_permissions
  @feature_permissions
end

#metadata ⇒ Object

Returns the value of attribute metadata.



35
36
37
 
# File 'lib/mudbase/models/update_project_role_request.rb', line 35

def metadata
  @metadata
end

#name ⇒ Object

Returns the value of attribute name.



18
19
20
 
# File 'lib/mudbase/models/update_project_role_request.rb', line 18

def name
  @name
end

#requires_approval ⇒ Object

Returns the value of attribute requires_approval.



24
25
26
 
# File 'lib/mudbase/models/update_project_role_request.rb', line 24

def requires_approval
  @requires_approval
end

#requires_kyc ⇒ Object

Returns the value of attribute requires_kyc.



28
29
30
 
# File 'lib/mudbase/models/update_project_role_request.rb', line 28

def requires_kyc
  @requires_kyc
end

#requires_payment ⇒ Object

Returns the value of attribute requires_payment.



26
27
28
 
# File 'lib/mudbase/models/update_project_role_request.rb', line 26

def requires_payment
  @requires_payment
end

#signup_endpoint ⇒ Object

Returns the value of attribute signup_endpoint.



22
23
24
 
# File 'lib/mudbase/models/update_project_role_request.rb', line 22

def 
  @signup_endpoint
end

Class Method Details

.acceptable_attribute_map ⇒ Object

Returns attribute mapping this model knows about



57
58
59
 
# File 'lib/mudbase/models/update_project_role_request.rb', line 57

def self.acceptable_attribute_map
  attribute_map
end

.acceptable_attributes ⇒ Object

Returns all the JSON keys this model knows about



62
63
64
 
# File 'lib/mudbase/models/update_project_role_request.rb', line 62

def self.acceptable_attributes
  acceptable_attribute_map.values
end

.attribute_map ⇒ Object

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



41
42
43
44
45
46
47
48
49
50
51
52
53
54
 
# File 'lib/mudbase/models/update_project_role_request.rb', line 41

def self.attribute_map
  {
    :'name' => :'name',
    :'description' => :'description',
    :'signup_endpoint' => :'signupEndpoint',
    :'requires_approval' => :'requiresApproval',
    :'requires_payment' => :'requiresPayment',
    :'requires_kyc' => :'requiresKYC',
    :'default_permissions' => :'defaultPermissions',
    :'collection_permissions' => :'collectionPermissions',
    :'metadata' => :'metadata',
    :'feature_permissions' => :'featurePermissions'
  }
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



198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
 
# File 'lib/mudbase/models/update_project_role_request.rb', line 198

def self.build_from_hash(attributes)
  return nil unless attributes.is_a?(Hash)
  attributes = attributes.transform_keys(&:to_sym)
  transformed_hash = {}
  openapi_types.each_pair do |key, type|
    if attributes.key?(attribute_map[key]) && attributes[attribute_map[key]].nil?
      transformed_hash["#{key}"] = nil
    elsif 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[attribute_map[key]].is_a?(Array)
        transformed_hash["#{key}"] = attributes[attribute_map[key]].map { |v| _deserialize($1, v) }
      end
    elsif !attributes[attribute_map[key]].nil?
      transformed_hash["#{key}"] = _deserialize(type, attributes[attribute_map[key]])
    end
  end
  new(transformed_hash)
end

.openapi_nullable ⇒ Object

List of attributes with nullable: true



83
84
85
86
 
# File 'lib/mudbase/models/update_project_role_request.rb', line 83

def self.openapi_nullable
  Set.new([
  ])
end

.openapi_types ⇒ Object

Attribute type mapping.



67
68
69
70
71
72
73
74
75
76
77
78
79
80
 
# File 'lib/mudbase/models/update_project_role_request.rb', line 67

def self.openapi_types
  {
    :'name' => :'String',
    :'description' => :'String',
    :'signup_endpoint' => :'String',
    :'requires_approval' => :'Boolean',
    :'requires_payment' => :'Boolean',
    :'requires_kyc' => :'Boolean',
    :'default_permissions' => :'Array<Object>',
    :'collection_permissions' => :'Hash<String, CreateRoleRequestCollectionPermissionsValue>',
    :'metadata' => :'Object',
    :'feature_permissions' => :'Hash<String, Hash<String, Boolean>>'
  }
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object) —

    to be compared



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

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      name == o.name &&
      description == o.description &&
       == o. &&
      requires_approval == o.requires_approval &&
      requires_payment == o.requires_payment &&
      requires_kyc == o.requires_kyc &&
      default_permissions == o.default_permissions &&
      collection_permissions == o.collection_permissions &&
      metadata == o.metadata &&
      feature_permissions == o.feature_permissions
end

#eql?(o) ⇒ Boolean

Parameters:

  • Object (Object) —

    to be compared

Returns:

  • (Boolean)

See Also:

  • `==` method


185
186
187
 
# File 'lib/mudbase/models/update_project_role_request.rb', line 185

def eql?(o)
  self == o
end

#hash ⇒ Integer

Calculates hash code according to all attributes.

Returns:

  • (Integer) —

    Hash code



191
192
193
 
# File 'lib/mudbase/models/update_project_role_request.rb', line 191

def hash
  [name, description, , requires_approval, requires_payment, requires_kyc, default_permissions, collection_permissions, metadata, feature_permissions].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



153
154
155
156
157
 
# File 'lib/mudbase/models/update_project_role_request.rb', line 153

def list_invalid_properties
  warn '[DEPRECATED] the `list_invalid_properties` method is obsolete'
  invalid_properties = Array.new
  invalid_properties
end

#to_hash ⇒ Hash

Returns the object in the form of hash

Returns:

  • (Hash) —

    Returns the object in the form of hash



220
221
222
223
224
225
226
227
228
229
230
231
232
 
# File 'lib/mudbase/models/update_project_role_request.rb', line 220

def to_hash
  hash = {}
  self.class.attribute_map.each_pair do |attr, param|
    value = self.send(attr)
    if value.nil?
      is_nullable = self.class.openapi_nullable.include?(attr)
      next if !is_nullable || (is_nullable && !instance_variable_defined?(:"@#{attr}"))
    end

    hash[param] = _to_hash(value)
  end
  hash
end

#valid? ⇒ Boolean

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

Returns:

  • (Boolean) —

    true if the model is valid



161
162
163
164
 
# File 'lib/mudbase/models/update_project_role_request.rb', line 161

def valid?
  warn '[DEPRECATED] the `valid?` method is obsolete'
  true
end