Class: GongAPI::PermissionProfileDTO

Inherits:
Object
  • Object
show all
Defined in:
lib/gong_api/models/permission_profile_dto.rb

Overview

Permission profile

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ PermissionProfileDTO

Initializes the object

Parameters:

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

    Model attributes in the form of hash



205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
# File 'lib/gong_api/models/permission_profile_dto.rb', line 205

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

Instance Attribute Details

#accountObject

User can view account pages.



18
19
20
# File 'lib/gong_api/models/permission_profile_dto.rb', line 18

def 
  @account
end

#activityObject

User can view activity pages.



21
22
23
# File 'lib/gong_api/models/permission_profile_dto.rb', line 21

def activity
  @activity
end

#calls_accessObject

Returns the value of attribute calls_access.



23
24
25
# File 'lib/gong_api/models/permission_profile_dto.rb', line 23

def calls_access
  @calls_access
end

#calls_and_searchObject

User can view and search calls.



26
27
28
# File 'lib/gong_api/models/permission_profile_dto.rb', line 26

def calls_and_search
  @calls_and_search
end

#coachingObject

User can view coaching pages.



29
30
31
# File 'lib/gong_api/models/permission_profile_dto.rb', line 29

def coaching
  @coaching
end

#coaching_accessObject

Returns the value of attribute coaching_access.



31
32
33
# File 'lib/gong_api/models/permission_profile_dto.rb', line 31

def coaching_access
  @coaching_access
end

#create_edit_and_delete_deals_boardsObject

User can create/edit/delete deals boards.



34
35
36
# File 'lib/gong_api/models/permission_profile_dto.rb', line 34

def create_edit_and_delete_deals_boards
  @create_edit_and_delete_deals_boards
end

#crm_data_importObject

User can perform import of crm data.



37
38
39
# File 'lib/gong_api/models/permission_profile_dto.rb', line 37

def crm_data_import
  @crm_data_import
end

#crm_data_inline_editingObject

User can perform inline editing of crm data.



40
41
42
# File 'lib/gong_api/models/permission_profile_dto.rb', line 40

def crm_data_inline_editing
  @crm_data_inline_editing
end

#dealsObject

User can view deals pages.



43
44
45
# File 'lib/gong_api/models/permission_profile_dto.rb', line 43

def deals
  @deals
end

#deals_accessObject

Returns the value of attribute deals_access.



45
46
47
# File 'lib/gong_api/models/permission_profile_dto.rb', line 45

def deals_access
  @deals_access
end

#deals_inline_editingObject

User can perform inline editing of deals.



48
49
50
# File 'lib/gong_api/models/permission_profile_dto.rb', line 48

def deals_inline_editing
  @deals_inline_editing
end

#delete_callsObject

User can delete calls.



51
52
53
# File 'lib/gong_api/models/permission_profile_dto.rb', line 51

def delete_calls
  @delete_calls
end

#delete_emailsObject

User can delete emails.



54
55
56
# File 'lib/gong_api/models/permission_profile_dto.rb', line 54

def delete_emails
  @delete_emails
end

#descriptionObject

Permission profile description.



57
58
59
# File 'lib/gong_api/models/permission_profile_dto.rb', line 57

def description
  @description
end

#download_call_mediaObject

User can download call media.



60
61
62
# File 'lib/gong_api/models/permission_profile_dto.rb', line 60

def download_call_media
  @download_call_media
end

#emails_accessObject

Returns the value of attribute emails_access.



62
63
64
# File 'lib/gong_api/models/permission_profile_dto.rb', line 62

def emails_access
  @emails_access
end

#export_calls_and_coaching_data_to_csvObject

User can export calls and coaching metrics data to CSV.



65
66
67
# File 'lib/gong_api/models/permission_profile_dto.rb', line 65

def export_calls_and_coaching_data_to_csv
  @export_calls_and_coaching_data_to_csv
end

#forecastObject

User can view forecast pages.



68
69
70
# File 'lib/gong_api/models/permission_profile_dto.rb', line 68

def forecast
  @forecast
end

#forecast_accessObject

Returns the value of attribute forecast_access.



70
71
72
# File 'lib/gong_api/models/permission_profile_dto.rb', line 70

def forecast_access
  @forecast_access
end

#idObject

Unique numeric identifier of the permission profile (up to 20 digits).



73
74
75
# File 'lib/gong_api/models/permission_profile_dto.rb', line 73

def id
  @id
end

#initiativesObject

User can view initiatives page.



76
77
78
# File 'lib/gong_api/models/permission_profile_dto.rb', line 76

def initiatives
  @initiatives
end

#insightsObject

User can view insights pages.



79
80
81
# File 'lib/gong_api/models/permission_profile_dto.rb', line 79

def insights
  @insights
end

#insights_accessObject

Returns the value of attribute insights_access.



81
82
83
# File 'lib/gong_api/models/permission_profile_dto.rb', line 81

def insights_access
  @insights_access
end

#libraryObject

User can view library pages.



84
85
86
# File 'lib/gong_api/models/permission_profile_dto.rb', line 84

def library
  @library
end

#library_folder_accessObject

Returns the value of attribute library_folder_access.



86
87
88
# File 'lib/gong_api/models/permission_profile_dto.rb', line 86

def library_folder_access
  @library_folder_access
end

#manage_general_business_settingsObject

User can manage general business settings.



89
90
91
# File 'lib/gong_api/models/permission_profile_dto.rb', line 89

def manage_general_business_settings
  @manage_general_business_settings
end

#manage_scorecardsObject

User can manage scorecards.



92
93
94
# File 'lib/gong_api/models/permission_profile_dto.rb', line 92

def manage_scorecards
  @manage_scorecards
end

#manually_schedule_and_upload_callsObject

User can manually schedule and upload calls.



95
96
97
# File 'lib/gong_api/models/permission_profile_dto.rb', line 95

def manually_schedule_and_upload_calls
  @manually_schedule_and_upload_calls
end

#marketObject

User can view market page.



98
99
100
# File 'lib/gong_api/models/permission_profile_dto.rb', line 98

def market
  @market
end

#nameObject

Permission profile name.



101
102
103
# File 'lib/gong_api/models/permission_profile_dto.rb', line 101

def name
  @name
end

#private_callsObject

User can set their own calls as private.



104
105
106
# File 'lib/gong_api/models/permission_profile_dto.rb', line 104

def private_calls
  @private_calls
end

#score_callsObject

User can score calls.



107
108
109
# File 'lib/gong_api/models/permission_profile_dto.rb', line 107

def score_calls
  @score_calls
end

#share_calls_with_customersObject

User can share calls with customers.



110
111
112
# File 'lib/gong_api/models/permission_profile_dto.rb', line 110

def share_calls_with_customers
  @share_calls_with_customers
end

#team_statsObject

User can view team stats page.



113
114
115
# File 'lib/gong_api/models/permission_profile_dto.rb', line 113

def team_stats
  @team_stats
end

Class Method Details

.attribute_mapObject

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



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
150
151
152
153
154
# File 'lib/gong_api/models/permission_profile_dto.rb', line 116

def self.attribute_map
  {
    :'account' => :'account',
    :'activity' => :'activity',
    :'calls_access' => :'callsAccess',
    :'calls_and_search' => :'callsAndSearch',
    :'coaching' => :'coaching',
    :'coaching_access' => :'coachingAccess',
    :'create_edit_and_delete_deals_boards' => :'createEditAndDeleteDealsBoards',
    :'crm_data_import' => :'crmDataImport',
    :'crm_data_inline_editing' => :'crmDataInlineEditing',
    :'deals' => :'deals',
    :'deals_access' => :'dealsAccess',
    :'deals_inline_editing' => :'dealsInlineEditing',
    :'delete_calls' => :'deleteCalls',
    :'delete_emails' => :'deleteEmails',
    :'description' => :'description',
    :'download_call_media' => :'downloadCallMedia',
    :'emails_access' => :'emailsAccess',
    :'export_calls_and_coaching_data_to_csv' => :'exportCallsAndCoachingDataToCSV',
    :'forecast' => :'forecast',
    :'forecast_access' => :'forecastAccess',
    :'id' => :'id',
    :'initiatives' => :'initiatives',
    :'insights' => :'insights',
    :'insights_access' => :'insightsAccess',
    :'library' => :'library',
    :'library_folder_access' => :'libraryFolderAccess',
    :'manage_general_business_settings' => :'manageGeneralBusinessSettings',
    :'manage_scorecards' => :'manageScorecards',
    :'manually_schedule_and_upload_calls' => :'manuallyScheduleAndUploadCalls',
    :'market' => :'market',
    :'name' => :'name',
    :'private_calls' => :'privateCalls',
    :'score_calls' => :'scoreCalls',
    :'share_calls_with_customers' => :'shareCallsWithCustomers',
    :'team_stats' => :'teamStats'
  }
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



429
430
431
# File 'lib/gong_api/models/permission_profile_dto.rb', line 429

def self.build_from_hash(attributes)
  new.build_from_hash(attributes)
end

.openapi_nullableObject

List of attributes with nullable: true



198
199
200
201
# File 'lib/gong_api/models/permission_profile_dto.rb', line 198

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

.openapi_typesObject

Attribute type mapping.



157
158
159
160
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
# File 'lib/gong_api/models/permission_profile_dto.rb', line 157

def self.openapi_types
  {
    :'account' => :'Object',
    :'activity' => :'Object',
    :'calls_access' => :'Object',
    :'calls_and_search' => :'Object',
    :'coaching' => :'Object',
    :'coaching_access' => :'Object',
    :'create_edit_and_delete_deals_boards' => :'Object',
    :'crm_data_import' => :'Object',
    :'crm_data_inline_editing' => :'Object',
    :'deals' => :'Object',
    :'deals_access' => :'Object',
    :'deals_inline_editing' => :'Object',
    :'delete_calls' => :'Object',
    :'delete_emails' => :'Object',
    :'description' => :'Object',
    :'download_call_media' => :'Object',
    :'emails_access' => :'Object',
    :'export_calls_and_coaching_data_to_csv' => :'Object',
    :'forecast' => :'Object',
    :'forecast_access' => :'Object',
    :'id' => :'Object',
    :'initiatives' => :'Object',
    :'insights' => :'Object',
    :'insights_access' => :'Object',
    :'library' => :'Object',
    :'library_folder_access' => :'Object',
    :'manage_general_business_settings' => :'Object',
    :'manage_scorecards' => :'Object',
    :'manually_schedule_and_upload_calls' => :'Object',
    :'market' => :'Object',
    :'name' => :'Object',
    :'private_calls' => :'Object',
    :'score_calls' => :'Object',
    :'share_calls_with_customers' => :'Object',
    :'team_stats' => :'Object'
  }
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object)

    to be compared



374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
# File 'lib/gong_api/models/permission_profile_dto.rb', line 374

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
       == o. &&
      activity == o.activity &&
      calls_access == o.calls_access &&
      calls_and_search == o.calls_and_search &&
      coaching == o.coaching &&
      coaching_access == o.coaching_access &&
      create_edit_and_delete_deals_boards == o.create_edit_and_delete_deals_boards &&
      crm_data_import == o.crm_data_import &&
      crm_data_inline_editing == o.crm_data_inline_editing &&
      deals == o.deals &&
      deals_access == o.deals_access &&
      deals_inline_editing == o.deals_inline_editing &&
      delete_calls == o.delete_calls &&
      delete_emails == o.delete_emails &&
      description == o.description &&
      download_call_media == o.download_call_media &&
      emails_access == o.emails_access &&
      export_calls_and_coaching_data_to_csv == o.export_calls_and_coaching_data_to_csv &&
      forecast == o.forecast &&
      forecast_access == o.forecast_access &&
      id == o.id &&
      initiatives == o.initiatives &&
      insights == o.insights &&
      insights_access == o.insights_access &&
      library == o.library &&
      library_folder_access == o.library_folder_access &&
      manage_general_business_settings == o.manage_general_business_settings &&
      manage_scorecards == o.manage_scorecards &&
      manually_schedule_and_upload_calls == o.manually_schedule_and_upload_calls &&
      market == o.market &&
      name == o.name &&
      private_calls == o.private_calls &&
      score_calls == o.score_calls &&
      share_calls_with_customers == o.share_calls_with_customers &&
      team_stats == o.team_stats
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



459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
# File 'lib/gong_api/models/permission_profile_dto.rb', line 459

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
    GongAPI.const_get(type).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



528
529
530
531
532
533
534
535
536
537
538
539
540
# File 'lib/gong_api/models/permission_profile_dto.rb', line 528

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



436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
# File 'lib/gong_api/models/permission_profile_dto.rb', line 436

def build_from_hash(attributes)
  return nil unless attributes.is_a?(Hash)
  self.class.openapi_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]]))
    elsif attributes[self.class.attribute_map[key]].nil? && self.class.openapi_nullable.include?(key)
      self.send("#{key}=", nil)
    end
  end

  self
end

#eql?(o) ⇒ Boolean

Parameters:

  • Object (Object)

    to be compared

Returns:

  • (Boolean)

See Also:

  • `==` method


416
417
418
# File 'lib/gong_api/models/permission_profile_dto.rb', line 416

def eql?(o)
  self == o
end

#hashInteger

Calculates hash code according to all attributes.

Returns:

  • (Integer)

    Hash code



422
423
424
# File 'lib/gong_api/models/permission_profile_dto.rb', line 422

def hash
  [, activity, calls_access, calls_and_search, coaching, coaching_access, create_edit_and_delete_deals_boards, crm_data_import, crm_data_inline_editing, deals, deals_access, deals_inline_editing, delete_calls, delete_emails, description, download_call_media, emails_access, export_calls_and_coaching_data_to_csv, forecast, forecast_access, id, initiatives, insights, insights_access, library, library_folder_access, manage_general_business_settings, manage_scorecards, manually_schedule_and_upload_calls, market, name, private_calls, score_calls, share_calls_with_customers, team_stats].hash
end

#list_invalid_propertiesObject

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

Returns:

  • Array for valid properties with the reasons



361
362
363
364
# File 'lib/gong_api/models/permission_profile_dto.rb', line 361

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



504
505
506
# File 'lib/gong_api/models/permission_profile_dto.rb', line 504

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



510
511
512
513
514
515
516
517
518
519
520
521
522
# File 'lib/gong_api/models/permission_profile_dto.rb', line 510

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

#to_sString

Returns the string representation of the object

Returns:

  • (String)

    String presentation of the object



498
499
500
# File 'lib/gong_api/models/permission_profile_dto.rb', line 498

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



368
369
370
# File 'lib/gong_api/models/permission_profile_dto.rb', line 368

def valid?
  true
end