purecloudplatformclientv2 92.0.0 → 93.0.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (118) hide show
  1. checksums.yaml +4 -4
  2. data/README.md +2 -2
  3. data/docs/AnalyticsEvaluation.md +1 -1
  4. data/docs/AnalyticsSession.md +4 -0
  5. data/docs/ArchitectApi.md +51 -49
  6. data/docs/CoachingApi.md +8 -7
  7. data/docs/CommonCampaign.md +17 -0
  8. data/docs/CommonCampaignDivisionView.md +17 -0
  9. data/docs/CommonCampaignDivisionViewEntityListing.md +22 -0
  10. data/docs/CommonCampaignEntityListing.md +22 -0
  11. data/docs/ConversationAssociation.md +1 -1
  12. data/docs/ConversationEventTopicMessage.md +1 -0
  13. data/docs/ConversationsApi.md +4 -4
  14. data/docs/ExternalContactsApi.md +4 -4
  15. data/docs/HistoricalAdherenceActuals.md +15 -0
  16. data/docs/HistoricalAdherenceDayMetrics.md +23 -0
  17. data/docs/HistoricalAdherenceExceptionInfo.md +21 -0
  18. data/docs/HistoricalAdherenceQueryResult.md +21 -0
  19. data/docs/KnowledgeSearchRequest.md +3 -3
  20. data/docs/MessagingCampaign.md +28 -0
  21. data/docs/MessagingCampaignDivisionView.md +16 -0
  22. data/docs/MessagingCampaignDivisionViewEntityListing.md +22 -0
  23. data/docs/MessagingCampaignEntityListing.md +22 -0
  24. data/docs/ObservationValue.md +3 -1
  25. data/docs/OutboundApi.md +881 -76
  26. data/docs/QueueConversationEventTopicMessage.md +1 -0
  27. data/docs/QueueConversationSocialExpressionEventTopicMessage.md +1 -0
  28. data/docs/QueueConversationVideoEventTopicMessage.md +1 -0
  29. data/docs/ReportingExportJobRequest.md +2 -0
  30. data/docs/ReportingExportJobResponse.md +3 -0
  31. data/docs/SCIMApi.md +96 -108
  32. data/docs/ScimConfigResourceType.md +1 -1
  33. data/docs/ScimUserExtensions.md +2 -2
  34. data/docs/ScimUserRole.md +1 -1
  35. data/docs/ScimUserRoutingLanguage.md +2 -2
  36. data/docs/ScimUserRoutingSkill.md +2 -2
  37. data/docs/ScimV2CreateUser.md +3 -3
  38. data/docs/ScimV2Group.md +1 -1
  39. data/docs/ScimV2SchemaAttribute.md +11 -11
  40. data/docs/ScimV2SchemaDefinition.md +4 -4
  41. data/docs/ScimV2SchemaListResponse.md +1 -1
  42. data/docs/ScimV2User.md +4 -4
  43. data/docs/SmsConfig.md +15 -0
  44. data/docs/SmsPhoneNumberRef.md +14 -0
  45. data/docs/UserRoutingLanguage.md +3 -3
  46. data/docs/UserRoutingLanguagePost.md +1 -1
  47. data/docs/UserRoutingSkill.md +1 -1
  48. data/docs/VoicemailUserPolicy.md +1 -0
  49. data/docs/WfmBusinessUnitReference.md +14 -0
  50. data/docs/WfmHistoricalAdherenceResponse.md +1 -0
  51. data/docs/WfmHistoricalAdherenceResultWrapper.md +15 -0
  52. data/docs/WfmHistoricalDataUploadRequestStatusTopicDateTime.md +16 -0
  53. data/docs/WfmHistoricalDataUploadRequestStatusTopicHistoricalDataUploadRequestUpdate.md +20 -0
  54. data/docs/WfmScheduleReference.md +16 -0
  55. data/lib/purecloudplatformclientv2.rb +19 -0
  56. data/lib/purecloudplatformclientv2/api/architect_api.rb +15 -6
  57. data/lib/purecloudplatformclientv2/api/coaching_api.rb +10 -9
  58. data/lib/purecloudplatformclientv2/api/conversations_api.rb +4 -4
  59. data/lib/purecloudplatformclientv2/api/external_contacts_api.rb +4 -4
  60. data/lib/purecloudplatformclientv2/api/outbound_api.rb +1215 -155
  61. data/lib/purecloudplatformclientv2/api/scim_api.rb +88 -88
  62. data/lib/purecloudplatformclientv2/api_client.rb +1 -1
  63. data/lib/purecloudplatformclientv2/models/analytics_evaluation.rb +13 -13
  64. data/lib/purecloudplatformclientv2/models/analytics_session.rb +124 -4
  65. data/lib/purecloudplatformclientv2/models/common_campaign.rb +320 -0
  66. data/lib/purecloudplatformclientv2/models/common_campaign_division_view.rb +320 -0
  67. data/lib/purecloudplatformclientv2/models/common_campaign_division_view_entity_listing.rb +428 -0
  68. data/lib/purecloudplatformclientv2/models/common_campaign_entity_listing.rb +428 -0
  69. data/lib/purecloudplatformclientv2/models/conversation_aggregate_query_predicate.rb +2 -2
  70. data/lib/purecloudplatformclientv2/models/conversation_association.rb +1 -1
  71. data/lib/purecloudplatformclientv2/models/conversation_event_topic_message.rb +26 -1
  72. data/lib/purecloudplatformclientv2/models/dependency.rb +2 -2
  73. data/lib/purecloudplatformclientv2/models/dependency_object.rb +2 -2
  74. data/lib/purecloudplatformclientv2/models/event_message.rb +2 -2
  75. data/lib/purecloudplatformclientv2/models/flow_aggregate_query_predicate.rb +2 -2
  76. data/lib/purecloudplatformclientv2/models/historical_adherence_actuals.rb +268 -0
  77. data/lib/purecloudplatformclientv2/models/historical_adherence_day_metrics.rb +462 -0
  78. data/lib/purecloudplatformclientv2/models/historical_adherence_exception_info.rb +466 -0
  79. data/lib/purecloudplatformclientv2/models/historical_adherence_query_result.rb +430 -0
  80. data/lib/purecloudplatformclientv2/models/knowledge_search_request.rb +0 -15
  81. data/lib/purecloudplatformclientv2/models/messaging_campaign.rb +621 -0
  82. data/lib/purecloudplatformclientv2/models/messaging_campaign_division_view.rb +279 -0
  83. data/lib/purecloudplatformclientv2/models/messaging_campaign_division_view_entity_listing.rb +428 -0
  84. data/lib/purecloudplatformclientv2/models/messaging_campaign_entity_listing.rb +428 -0
  85. data/lib/purecloudplatformclientv2/models/observation_value.rb +70 -2
  86. data/lib/purecloudplatformclientv2/models/queue_conversation_event_topic_message.rb +26 -1
  87. data/lib/purecloudplatformclientv2/models/queue_conversation_social_expression_event_topic_message.rb +26 -1
  88. data/lib/purecloudplatformclientv2/models/queue_conversation_video_event_topic_message.rb +26 -1
  89. data/lib/purecloudplatformclientv2/models/reporting_export_job_request.rb +53 -1
  90. data/lib/purecloudplatformclientv2/models/reporting_export_job_response.rb +78 -1
  91. data/lib/purecloudplatformclientv2/models/scim_config_resource_type.rb +1 -1
  92. data/lib/purecloudplatformclientv2/models/scim_user_extensions.rb +3 -3
  93. data/lib/purecloudplatformclientv2/models/scim_user_role.rb +1 -1
  94. data/lib/purecloudplatformclientv2/models/scim_user_routing_language.rb +3 -3
  95. data/lib/purecloudplatformclientv2/models/scim_user_routing_skill.rb +3 -3
  96. data/lib/purecloudplatformclientv2/models/scim_v2_create_user.rb +3 -2
  97. data/lib/purecloudplatformclientv2/models/scim_v2_enterprise_user.rb +1 -1
  98. data/lib/purecloudplatformclientv2/models/scim_v2_group.rb +1 -1
  99. data/lib/purecloudplatformclientv2/models/scim_v2_schema_attribute.rb +12 -12
  100. data/lib/purecloudplatformclientv2/models/scim_v2_schema_definition.rb +5 -5
  101. data/lib/purecloudplatformclientv2/models/scim_v2_schema_list_response.rb +2 -2
  102. data/lib/purecloudplatformclientv2/models/scim_v2_user.rb +4 -3
  103. data/lib/purecloudplatformclientv2/models/segment_detail_query_predicate.rb +2 -2
  104. data/lib/purecloudplatformclientv2/models/sms_config.rb +269 -0
  105. data/lib/purecloudplatformclientv2/models/sms_phone_number_ref.rb +232 -0
  106. data/lib/purecloudplatformclientv2/models/user_routing_language.rb +4 -4
  107. data/lib/purecloudplatformclientv2/models/user_routing_language_post.rb +1 -1
  108. data/lib/purecloudplatformclientv2/models/user_routing_skill.rb +1 -1
  109. data/lib/purecloudplatformclientv2/models/voicemail_user_policy.rb +30 -4
  110. data/lib/purecloudplatformclientv2/models/wem_coaching_appointment_topic_coaching_appointment_notification.rb +4 -4
  111. data/lib/purecloudplatformclientv2/models/wfm_business_unit_reference.rb +228 -0
  112. data/lib/purecloudplatformclientv2/models/wfm_historical_adherence_response.rb +27 -1
  113. data/lib/purecloudplatformclientv2/models/wfm_historical_adherence_result_wrapper.rb +258 -0
  114. data/lib/purecloudplatformclientv2/models/wfm_historical_data_upload_request_status_topic_date_time.rb +276 -0
  115. data/lib/purecloudplatformclientv2/models/wfm_historical_data_upload_request_status_topic_historical_data_upload_request_update.rb +390 -0
  116. data/lib/purecloudplatformclientv2/models/wfm_schedule_reference.rb +280 -0
  117. data/lib/purecloudplatformclientv2/version.rb +1 -1
  118. metadata +41 -3
@@ -19,7 +19,7 @@ require 'date'
19
19
  module PureCloud
20
20
  # Defines a SCIM resource.
21
21
  class ScimConfigResourceType
22
- # The ID of the SCIM resource. Set by the service provider. \"caseExact\" is set to \"true\". \"Mutability\" is set to \"readOnly\". \"Returned\" is set to \"always\".
22
+ # The ID of the SCIM resource. Set by the service provider. \"caseExact\" is set to \"true\". \"mutability\" is set to \"readOnly\". \"returned\" is set to \"always\".
23
23
  attr_accessor :id
24
24
 
25
25
  # The list of supported schemas.
@@ -17,12 +17,12 @@ Terms of Service: https://help.mypurecloud.com/articles/terms-and-conditions/
17
17
  require 'date'
18
18
 
19
19
  module PureCloud
20
- # SCIM PureCloud extensions of user.
20
+ # Defines a SCIM Genesys Cloud user.
21
21
  class ScimUserExtensions
22
- # Routing Skills assigned to user. No more than 50 skills may be assigned to a user.
22
+ # The list of routing skills assigned to a user. Maximum 50 skills.
23
23
  attr_accessor :routing_skills
24
24
 
25
- # Routing Languages assigned to user. No more than 50 languages may be assigned to a user.
25
+ # The list of routing languages assigned to a user. Maximum 50 languages.
26
26
  attr_accessor :routing_languages
27
27
 
28
28
  # Attribute mapping from ruby-style variable name to JSON key.
@@ -19,7 +19,7 @@ require 'date'
19
19
  module PureCloud
20
20
  # Defines a user role.
21
21
  class ScimUserRole
22
- # Purecloud user role name
22
+ # The role of the Genesys Cloud user.
23
23
  attr_accessor :value
24
24
 
25
25
  # Attribute mapping from ruby-style variable name to JSON key.
@@ -17,12 +17,12 @@ Terms of Service: https://help.mypurecloud.com/articles/terms-and-conditions/
17
17
  require 'date'
18
18
 
19
19
  module PureCloud
20
- # Routing language assigned to user.
20
+ # The routing language assigned to a user.
21
21
  class ScimUserRoutingLanguage
22
- # Case-sensitive name identifying a language configured in routing languages.
22
+ # The case-sensitive name of a routing language configured in Genesys Cloud.
23
23
  attr_accessor :name
24
24
 
25
- # Proficiency is a rating from 0.0 to 5.0 on how competent an agent is for a particular language. It is used when a queue is set to \"Best available language\" mode to allow acd interactions to target agents with higher proficiency ratings.
25
+ # A rating from 0.0 to 5.0 that indicates how fluent an agent is in a particular language. ACD interactions are routed to agents with higher proficiency ratings.
26
26
  attr_accessor :proficiency
27
27
 
28
28
  # Attribute mapping from ruby-style variable name to JSON key.
@@ -17,12 +17,12 @@ Terms of Service: https://help.mypurecloud.com/articles/terms-and-conditions/
17
17
  require 'date'
18
18
 
19
19
  module PureCloud
20
- # Routing skill assigned to user.
20
+ # The routing skill assigned to a user.
21
21
  class ScimUserRoutingSkill
22
- # Case-sensitive name identifying a skill configured in routing skills.
22
+ # The case-sensitive name of a routing skill configured in Genesys Cloud.
23
23
  attr_accessor :name
24
24
 
25
- # Proficiency is a rating from 0.0 to 5.0 on how competent an agent is for a particular skill. It is used when a queue is set to \"Best available skills\" mode to allow acd interactions to target agents with higher proficiency ratings.
25
+ # A rating from 0.0 to 5.0 that indicates how adept an agent is at a particular skill. When \"Best available skills\" is enabled for a queue in Genesys Cloud, ACD interactions in that queue are routed to agents with higher proficiency ratings.
26
26
  attr_accessor :proficiency
27
27
 
28
28
  # Attribute mapping from ruby-style variable name to JSON key.
@@ -25,13 +25,13 @@ module PureCloud
25
25
  # Indicates whether the user's administrative status is active.
26
26
  attr_accessor :active
27
27
 
28
- # The user's PureCloud email address. Must be unique.
28
+ # The user's Genesys Cloud email address. Must be unique.
29
29
  attr_accessor :user_name
30
30
 
31
31
  # The display name of the user.
32
32
  attr_accessor :display_name
33
33
 
34
- # The new password for the PureCloud user. Does not return an existing password.
34
+ # The new password for the Genesys Cloud user. Does not return an existing password.
35
35
  attr_accessor :password
36
36
 
37
37
  # The user's title.
@@ -55,6 +55,7 @@ module PureCloud
55
55
  # The URI of the schema for the enterprise user.
56
56
  attr_accessor :urnietfparamsscimschemasextensionenterprise2_0_user
57
57
 
58
+ # The URI of the schema for the Genesys Cloud user.
58
59
  attr_accessor :urnietfparamsscimschemasextensiongenesyspurecloud2_0_user
59
60
 
60
61
  # Attribute mapping from ruby-style variable name to JSON key.
@@ -17,7 +17,7 @@ Terms of Service: https://help.mypurecloud.com/articles/terms-and-conditions/
17
17
  require 'date'
18
18
 
19
19
  module PureCloud
20
- # Defines an SCIM enterprise user.
20
+ # Defines a SCIM enterprise user.
21
21
  class ScimV2EnterpriseUser
22
22
  # The division that the user belongs to.
23
23
  attr_accessor :division
@@ -19,7 +19,7 @@ require 'date'
19
19
  module PureCloud
20
20
  # Defines a SCIM group.
21
21
  class ScimV2Group
22
- # The ID of the SCIM resource. Set by the service provider. \"caseExact\" is set to \"true\". \"Mutability\" is set to \"readOnly\". \"Returned\" is set to \"always\".
22
+ # The ID of the SCIM resource. Set by the service provider. \"caseExact\" is set to \"true\". \"mutability\" is set to \"readOnly\". \"returned\" is set to \"always\".
23
23
  attr_accessor :id
24
24
 
25
25
  # The list of supported schemas.
@@ -17,42 +17,42 @@ Terms of Service: https://help.mypurecloud.com/articles/terms-and-conditions/
17
17
  require 'date'
18
18
 
19
19
  module PureCloud
20
- # A complex type that defines service provider attributes, or sub-attributes and their qualities.
20
+ # A complex type that defines service provider attributes or subattributes and their qualities.
21
21
  class ScimV2SchemaAttribute
22
22
  # The attribute's name
23
23
  attr_accessor :name
24
24
 
25
- # The attribute's data type. Valid values are \"string\", \"boolean\", \"decimal\", \"integer\", \"dateTime\", \"reference\", and \"complex\".
25
+ # The data type of the attribute.
26
26
  attr_accessor :type
27
27
 
28
- # When an attribute is of type \"complex\", \"subAttributes\" defines a set of sub-attributes. \"subAttributes\" has the same schema sub-attributes as \"attributes\"
28
+ # The list of subattributes for an attribute of the type \"complex\". Uses the same schema as \"attributes\".
29
29
  attr_accessor :sub_attributes
30
30
 
31
- # A Boolean value indicating the attribute's plurality.
31
+ # Indicates whether an attribute contains multiple values.
32
32
  attr_accessor :multi_valued
33
33
 
34
- # The attribute's human-readable description.
34
+ # The description of the attribute.
35
35
  attr_accessor :description
36
36
 
37
- # A Boolean value that specifies whether or not the attribute is required.
37
+ # Indicates whether an attribute is required.
38
38
  attr_accessor :required
39
39
 
40
- # A collection of suggested canonical values that MAY be used (e.g., \"work\" and \"home\"). In some cases, service providers MAY choose to ignore unsupported values. OPTIONAL.
40
+ # The list of standard values that service providers may use. Service providers may ignore unsupported values.
41
41
  attr_accessor :canonical_values
42
42
 
43
- # A Boolean value that specifies whether or not a string attribute is case sensitive. The server SHALL use case sensitivity when evaluating filters. For attributes that are case exact, the server SHALL preserve case for any value submitted. If the attribute is case insensitive, the server MAY alter case for a submitted value. Case sensitivity also impacts how attribute values MAY be compared against filter values (see Section 3.4.2.2 of [RFC7644])
43
+ # Indicates whether a string attribute is case-sensitive. If set to \"true\", the server preserves case sensitivity. If set to \"false\", the server may change the case. The server also uses case sensitivity when evaluating filters. See section 3.4.2.2 \"Filtering\" in RFC 7644 for details.
44
44
  attr_accessor :case_exact
45
45
 
46
- # A single keyword indicating the circumstances under which the value of the attribute can be (re)defined. Value are readOnly, readWrite, immutable, writeOnly
46
+ # The circumstances under which an attribute can be defined or redefined. The default is \"readWrite\".
47
47
  attr_accessor :mutability
48
48
 
49
- # A single keyword that indicates when an attribute and associated values are returned in response to a GET request, or in response to a PUT, POST, or PATCH request. Valid keywords are as follows: always, never, default, request
49
+ # The circumstances under which an attribute and its values are returned in response to a GET, PUT, POST, or PATCH request.
50
50
  attr_accessor :returned
51
51
 
52
- # A single keyword value that specifies how the service provider enforces uniqueness of attribute values. A server MAY reject an invalid value based on uniqueness by returning HTTP response code 400 (Bad Request). A client MAY enforce uniqueness on the client side to a greater degree than the service provider enforces. For example, a client could make a value unique while the server has uniqueness of \"none\". Valid keywords are as follows: none, server, global
52
+ # The method by which the service provider enforces the uniqueness of an attribute value. A server can reject a value by returning the HTTP response code 400 (Bad Request). A client can enforce uniqueness to a greater degree than the server provider enforces. For example, a client could make a value unique even though the server has \"uniqueness\" set to \"none\".
53
53
  attr_accessor :uniqueness
54
54
 
55
- # A multi-valued array of JSON strings that indicate the SCIM resource types that may be referenced. Values include User, Group, external and uri.
55
+ # The list of SCIM resource types that may be referenced. Only applies when \"type\" is set to \"reference\".
56
56
  attr_accessor :reference_types
57
57
 
58
58
  # Attribute mapping from ruby-style variable name to JSON key.
@@ -17,18 +17,18 @@ Terms of Service: https://help.mypurecloud.com/articles/terms-and-conditions/
17
17
  require 'date'
18
18
 
19
19
  module PureCloud
20
- # A SCIM schema definition.
20
+ # Defines a SCIM schema.
21
21
  class ScimV2SchemaDefinition
22
- # The ID of the SCIM resource. Set by the service provider. \"caseExact\" is set to \"true\". \"Mutability\" is set to \"readOnly\". \"Returned\" is set to \"always\".
22
+ # The ID of the SCIM resource. Set by the service provider. \"caseExact\" is set to \"true\". \"mutability\" is set to \"readOnly\". \"returned\" is set to \"always\".
23
23
  attr_accessor :id
24
24
 
25
- # Schema name.
25
+ # The name of the schema.
26
26
  attr_accessor :name
27
27
 
28
- # Schema description.
28
+ # The description of the schema.
29
29
  attr_accessor :description
30
30
 
31
- # A complex type that defines service provider attributes and their qualities.
31
+ # The list of service provider attributes.
32
32
  attr_accessor :attributes
33
33
 
34
34
  # The metadata of the SCIM resource.
@@ -17,7 +17,7 @@ Terms of Service: https://help.mypurecloud.com/articles/terms-and-conditions/
17
17
  require 'date'
18
18
 
19
19
  module PureCloud
20
- # SCIM Resource Types list response
20
+ # Defines the list response for SCIM resource types.
21
21
  class ScimV2SchemaListResponse
22
22
  # The total number of results.
23
23
  attr_accessor :total_results
@@ -28,7 +28,7 @@ module PureCloud
28
28
  # The number of resources returned per page.
29
29
  attr_accessor :items_per_page
30
30
 
31
- # Resources
31
+ # The list of requested resources.
32
32
  attr_accessor :resources
33
33
 
34
34
  # The list of supported schemas.
@@ -19,7 +19,7 @@ require 'date'
19
19
  module PureCloud
20
20
  # Defines a SCIM user.
21
21
  class ScimV2User
22
- # The ID of the SCIM resource. Set by the service provider. \"caseExact\" is set to \"true\". \"Mutability\" is set to \"readOnly\". \"Returned\" is set to \"always\".
22
+ # The ID of the SCIM resource. Set by the service provider. \"caseExact\" is set to \"true\". \"mutability\" is set to \"readOnly\". \"returned\" is set to \"always\".
23
23
  attr_accessor :id
24
24
 
25
25
  # The list of supported schemas.
@@ -28,13 +28,13 @@ module PureCloud
28
28
  # Indicates whether the user's administrative status is active.
29
29
  attr_accessor :active
30
30
 
31
- # The user's PureCloud email address. Must be unique.
31
+ # The user's Genesys Cloud email address. Must be unique.
32
32
  attr_accessor :user_name
33
33
 
34
34
  # The display name of the user.
35
35
  attr_accessor :display_name
36
36
 
37
- # The new password for the PureCloud user. Does not return an existing password.
37
+ # The new password for the Genesys Cloud user. Does not return an existing password.
38
38
  attr_accessor :password
39
39
 
40
40
  # The user's title.
@@ -58,6 +58,7 @@ module PureCloud
58
58
  # The URI of the schema for the enterprise user.
59
59
  attr_accessor :urnietfparamsscimschemasextensionenterprise2_0_user
60
60
 
61
+ # The URI of the schema for the Genesys Cloud user.
61
62
  attr_accessor :urnietfparamsscimschemasextensiongenesyspurecloud2_0_user
62
63
 
63
64
  # The metadata of the SCIM resource.
@@ -195,7 +195,7 @@ module PureCloud
195
195
 
196
196
 
197
197
 
198
- allowed_values = ["addressFrom", "addressOther", "addressSelf", "addressTo", "agentScore", "ani", "audioMuted", "callbackNumber", "callbackScheduledTime", "callbackUserName", "cobrowseRole", "cobrowseRoomId", "conference", "destinationConversationId", "destinationSessionId", "direction", "disconnectType", "dispositionAnalyzer", "dispositionName", "dnis", "edgeId", "endingLanguage", "entryReason", "entryType", "errorCode", "exitReason", "externalContactId", "externalOrganizationId", "flaggedReason", "flowId", "flowName", "flowOutType", "flowOutcome", "flowOutcomeEndTimestamp", "flowOutcomeId", "flowOutcomeStartTimestamp", "flowOutcomeValue", "flowType", "flowVersion", "groupId", "issuedCallback", "journeyActionId", "journeyActionMapId", "journeyActionMapVersion", "journeyCustomerId", "journeyCustomerIdType", "journeyCustomerSessionId", "journeyCustomerSessionIdType", "mediaBridgeId", "mediaCount", "mediaType", "messageType", "monitoredParticipantId", "outboundCampaignId", "outboundContactId", "outboundContactListId", "participantId", "participantName", "peerId", "protocolCallId", "provider", "purpose", "q850ResponseCode", "queueId", "recording", "remote", "remoteNameDisplayable", "requestedLanguageId", "requestedRoutingSkillId", "requestedRoutingUserId", "roomId", "scoredAgentId", "screenShareAddressSelf", "screenShareRoomId", "scriptId", "segmentEnd", "segmentType", "sessionDnis", "sessionId", "sharingScreen", "sipResponseCode", "skipEnabled", "sourceConversationId", "sourceSessionId", "startingLanguage", "subject", "teamId", "timeoutSeconds", "transferTargetAddress", "transferTargetName", "transferType", "userId", "videoAddressSelf", "videoMuted", "videoRoomId", "wrapUpCode", "wrapUpNote", "wrapUpTag"]
198
+ allowed_values = ["addressFrom", "addressOther", "addressSelf", "addressTo", "agentScore", "ani", "audioMuted", "callbackNumber", "callbackScheduledTime", "callbackUserName", "cobrowseRole", "cobrowseRoomId", "conference", "destinationConversationId", "destinationSessionId", "direction", "disconnectType", "dispositionAnalyzer", "dispositionName", "dnis", "edgeId", "endingLanguage", "entryReason", "entryType", "errorCode", "exitReason", "externalContactId", "externalOrganizationId", "flaggedReason", "flowId", "flowName", "flowOutType", "flowOutcome", "flowOutcomeEndTimestamp", "flowOutcomeId", "flowOutcomeStartTimestamp", "flowOutcomeValue", "flowType", "flowVersion", "groupId", "issuedCallback", "journeyActionId", "journeyActionMapId", "journeyActionMapVersion", "journeyCustomerId", "journeyCustomerIdType", "journeyCustomerSessionId", "journeyCustomerSessionIdType", "mediaBridgeId", "mediaCount", "mediaType", "messageType", "monitoredParticipantId", "outboundCampaignId", "outboundContactId", "outboundContactListId", "participantId", "participantName", "peerId", "protocolCallId", "provider", "purpose", "q850ResponseCode", "queueId", "recording", "remote", "remoteNameDisplayable", "requestedLanguageId", "requestedRouting", "requestedRoutingSkillId", "requestedRoutingUserId", "roomId", "scoredAgentId", "screenShareAddressSelf", "screenShareRoomId", "scriptId", "segmentEnd", "segmentType", "selectedAgentId", "selectedAgentRank", "sessionDnis", "sessionId", "sharingScreen", "sipResponseCode", "skipEnabled", "sourceConversationId", "sourceSessionId", "startingLanguage", "subject", "teamId", "timeoutSeconds", "transferTargetAddress", "transferTargetName", "transferType", "usedRouting", "userId", "videoAddressSelf", "videoMuted", "videoRoomId", "wrapUpCode", "wrapUpNote", "wrapUpTag"]
199
199
  if @dimension && !allowed_values.include?(@dimension)
200
200
  return false
201
201
  end
@@ -262,7 +262,7 @@ module PureCloud
262
262
  # Custom attribute writer method checking allowed values (enum).
263
263
  # @param [Object] dimension Object to be assigned
264
264
  def dimension=(dimension)
265
- allowed_values = ["addressFrom", "addressOther", "addressSelf", "addressTo", "agentScore", "ani", "audioMuted", "callbackNumber", "callbackScheduledTime", "callbackUserName", "cobrowseRole", "cobrowseRoomId", "conference", "destinationConversationId", "destinationSessionId", "direction", "disconnectType", "dispositionAnalyzer", "dispositionName", "dnis", "edgeId", "endingLanguage", "entryReason", "entryType", "errorCode", "exitReason", "externalContactId", "externalOrganizationId", "flaggedReason", "flowId", "flowName", "flowOutType", "flowOutcome", "flowOutcomeEndTimestamp", "flowOutcomeId", "flowOutcomeStartTimestamp", "flowOutcomeValue", "flowType", "flowVersion", "groupId", "issuedCallback", "journeyActionId", "journeyActionMapId", "journeyActionMapVersion", "journeyCustomerId", "journeyCustomerIdType", "journeyCustomerSessionId", "journeyCustomerSessionIdType", "mediaBridgeId", "mediaCount", "mediaType", "messageType", "monitoredParticipantId", "outboundCampaignId", "outboundContactId", "outboundContactListId", "participantId", "participantName", "peerId", "protocolCallId", "provider", "purpose", "q850ResponseCode", "queueId", "recording", "remote", "remoteNameDisplayable", "requestedLanguageId", "requestedRoutingSkillId", "requestedRoutingUserId", "roomId", "scoredAgentId", "screenShareAddressSelf", "screenShareRoomId", "scriptId", "segmentEnd", "segmentType", "sessionDnis", "sessionId", "sharingScreen", "sipResponseCode", "skipEnabled", "sourceConversationId", "sourceSessionId", "startingLanguage", "subject", "teamId", "timeoutSeconds", "transferTargetAddress", "transferTargetName", "transferType", "userId", "videoAddressSelf", "videoMuted", "videoRoomId", "wrapUpCode", "wrapUpNote", "wrapUpTag"]
265
+ allowed_values = ["addressFrom", "addressOther", "addressSelf", "addressTo", "agentScore", "ani", "audioMuted", "callbackNumber", "callbackScheduledTime", "callbackUserName", "cobrowseRole", "cobrowseRoomId", "conference", "destinationConversationId", "destinationSessionId", "direction", "disconnectType", "dispositionAnalyzer", "dispositionName", "dnis", "edgeId", "endingLanguage", "entryReason", "entryType", "errorCode", "exitReason", "externalContactId", "externalOrganizationId", "flaggedReason", "flowId", "flowName", "flowOutType", "flowOutcome", "flowOutcomeEndTimestamp", "flowOutcomeId", "flowOutcomeStartTimestamp", "flowOutcomeValue", "flowType", "flowVersion", "groupId", "issuedCallback", "journeyActionId", "journeyActionMapId", "journeyActionMapVersion", "journeyCustomerId", "journeyCustomerIdType", "journeyCustomerSessionId", "journeyCustomerSessionIdType", "mediaBridgeId", "mediaCount", "mediaType", "messageType", "monitoredParticipantId", "outboundCampaignId", "outboundContactId", "outboundContactListId", "participantId", "participantName", "peerId", "protocolCallId", "provider", "purpose", "q850ResponseCode", "queueId", "recording", "remote", "remoteNameDisplayable", "requestedLanguageId", "requestedRouting", "requestedRoutingSkillId", "requestedRoutingUserId", "roomId", "scoredAgentId", "screenShareAddressSelf", "screenShareRoomId", "scriptId", "segmentEnd", "segmentType", "selectedAgentId", "selectedAgentRank", "sessionDnis", "sessionId", "sharingScreen", "sipResponseCode", "skipEnabled", "sourceConversationId", "sourceSessionId", "startingLanguage", "subject", "teamId", "timeoutSeconds", "transferTargetAddress", "transferTargetName", "transferType", "usedRouting", "userId", "videoAddressSelf", "videoMuted", "videoRoomId", "wrapUpCode", "wrapUpNote", "wrapUpTag"]
266
266
  if dimension && !allowed_values.include?(dimension)
267
267
  fail ArgumentError, "invalid value for 'dimension', must be one of #{allowed_values}."
268
268
  end
@@ -0,0 +1,269 @@
1
+ =begin
2
+ PureCloud Platform API
3
+
4
+ With the PureCloud Platform API, you can control all aspects of your PureCloud environment. With the APIs you can access the system configuration, manage conversations and more.
5
+
6
+ OpenAPI spec version: v2
7
+ Contact: DeveloperEvangelists@genesys.com
8
+ Generated by: https://github.com/swagger-api/swagger-codegen.git
9
+
10
+ License: UNLICENSED
11
+ https://help.mypurecloud.com/articles/terms-and-conditions/
12
+
13
+ Terms of Service: https://help.mypurecloud.com/articles/terms-and-conditions/
14
+
15
+ =end
16
+
17
+ require 'date'
18
+
19
+ module PureCloud
20
+ class SmsConfig
21
+ # The Contact List column specifying the message to send to the contact.
22
+ attr_accessor :message_column
23
+
24
+ # The Contact List column specifying the phone number to send a message to.
25
+ attr_accessor :phone_column
26
+
27
+ # A reference to the SMS Phone Number that will be used as the sender of a message.
28
+ attr_accessor :sender_sms_phone_number
29
+
30
+ # Attribute mapping from ruby-style variable name to JSON key.
31
+ def self.attribute_map
32
+ {
33
+
34
+ :'message_column' => :'messageColumn',
35
+
36
+ :'phone_column' => :'phoneColumn',
37
+
38
+ :'sender_sms_phone_number' => :'senderSmsPhoneNumber'
39
+
40
+ }
41
+ end
42
+
43
+ # Attribute type mapping.
44
+ def self.swagger_types
45
+ {
46
+
47
+ :'message_column' => :'String',
48
+
49
+ :'phone_column' => :'String',
50
+
51
+ :'sender_sms_phone_number' => :'SmsPhoneNumberRef'
52
+
53
+ }
54
+ end
55
+
56
+ # Initializes the object
57
+ # @param [Hash] attributes Model attributes in the form of hash
58
+ def initialize(attributes = {})
59
+ return unless attributes.is_a?(Hash)
60
+
61
+ # convert string to symbol for hash key
62
+ attributes = attributes.each_with_object({}){|(k,v), h| h[k.to_sym] = v}
63
+
64
+
65
+ if attributes.has_key?(:'messageColumn')
66
+
67
+
68
+ self.message_column = attributes[:'messageColumn']
69
+
70
+
71
+ end
72
+
73
+
74
+ if attributes.has_key?(:'phoneColumn')
75
+
76
+
77
+ self.phone_column = attributes[:'phoneColumn']
78
+
79
+
80
+ end
81
+
82
+
83
+ if attributes.has_key?(:'senderSmsPhoneNumber')
84
+
85
+
86
+ self.sender_sms_phone_number = attributes[:'senderSmsPhoneNumber']
87
+
88
+
89
+ end
90
+
91
+
92
+ end
93
+
94
+ # Show invalid properties with the reasons. Usually used together with valid?
95
+ # @return Array for valid properies with the reasons
96
+ def list_invalid_properties
97
+ invalid_properties = Array.new
98
+
99
+
100
+ return invalid_properties
101
+ end
102
+
103
+ # Check to see if the all the properties in the model are valid
104
+ # @return true if the model is valid
105
+ def valid?
106
+
107
+
108
+ if @message_column.nil?
109
+ return false
110
+ end
111
+
112
+
113
+
114
+
115
+
116
+
117
+ if @phone_column.nil?
118
+ return false
119
+ end
120
+
121
+
122
+
123
+
124
+
125
+
126
+ if @sender_sms_phone_number.nil?
127
+ return false
128
+ end
129
+
130
+
131
+
132
+
133
+
134
+ end
135
+
136
+
137
+
138
+
139
+
140
+
141
+
142
+
143
+
144
+
145
+
146
+
147
+
148
+
149
+
150
+
151
+
152
+ # Checks equality by comparing each attribute.
153
+ # @param [Object] Object to be compared
154
+ def ==(o)
155
+ return true if self.equal?(o)
156
+ self.class == o.class &&
157
+ message_column == o.message_column &&
158
+ phone_column == o.phone_column &&
159
+ sender_sms_phone_number == o.sender_sms_phone_number
160
+ end
161
+
162
+ # @see the `==` method
163
+ # @param [Object] Object to be compared
164
+ def eql?(o)
165
+ self == o
166
+ end
167
+
168
+ # Calculates hash code according to all attributes.
169
+ # @return [Fixnum] Hash code
170
+ def hash
171
+ [message_column, phone_column, sender_sms_phone_number].hash
172
+ end
173
+
174
+ # build the object from hash
175
+ def build_from_hash(attributes)
176
+ return nil unless attributes.is_a?(Hash)
177
+ self.class.swagger_types.each_pair do |key, type|
178
+ if type =~ /^Array<(.*)>/i
179
+ if attributes[self.class.attribute_map[key]].is_a?(Array)
180
+ self.send("#{key}=", attributes[self.class.attribute_map[key]].map{ |v| _deserialize($1, v) } )
181
+ else
182
+ #TODO show warning in debug mode
183
+ end
184
+ elsif !attributes[self.class.attribute_map[key]].nil?
185
+ self.send("#{key}=", _deserialize(type, attributes[self.class.attribute_map[key]]))
186
+ else
187
+ # data not found in attributes(hash), not an issue as the data can be optional
188
+ end
189
+ end
190
+
191
+ self
192
+ end
193
+
194
+ def _deserialize(type, value)
195
+ case type.to_sym
196
+ when :DateTime
197
+ DateTime.parse(value)
198
+ when :Date
199
+ Date.parse(value)
200
+ when :String
201
+ value.to_s
202
+ when :Integer
203
+ value.to_i
204
+ when :Float
205
+ value.to_f
206
+ when :BOOLEAN
207
+ if value.to_s =~ /^(true|t|yes|y|1)$/i
208
+ true
209
+ else
210
+ false
211
+ end
212
+ when :Object
213
+ # generic object (usually a Hash), return directly
214
+ value
215
+ when /\AArray<(?<inner_type>.+)>\z/
216
+ inner_type = Regexp.last_match[:inner_type]
217
+ value.map { |v| _deserialize(inner_type, v) }
218
+ when /\AHash<(?<k_type>.+), (?<v_type>.+)>\z/
219
+ k_type = Regexp.last_match[:k_type]
220
+ v_type = Regexp.last_match[:v_type]
221
+ {}.tap do |hash|
222
+ value.each do |k, v|
223
+ hash[_deserialize(k_type, k)] = _deserialize(v_type, v)
224
+ end
225
+ end
226
+ else # model
227
+ _model = Object.const_get("PureCloud").const_get(type).new
228
+ _model.build_from_hash(value)
229
+ end
230
+ end
231
+
232
+ def to_s
233
+ to_hash.to_s
234
+ end
235
+
236
+ # to_body is an alias to to_body (backward compatibility))
237
+ def to_body
238
+ to_hash
239
+ end
240
+
241
+ # return the object in the form of hash
242
+ def to_hash
243
+ hash = {}
244
+ self.class.attribute_map.each_pair do |attr, param|
245
+ value = self.send(attr)
246
+ next if value.nil?
247
+ hash[param] = _to_hash(value)
248
+ end
249
+ hash
250
+ end
251
+
252
+ # Method to output non-array value in the form of hash
253
+ # For object, use to_hash. Otherwise, just return the value
254
+ def _to_hash(value)
255
+ if value.is_a?(Array)
256
+ value.compact.map{ |v| _to_hash(v) }
257
+ elsif value.is_a?(Hash)
258
+ {}.tap do |hash|
259
+ value.each { |k, v| hash[k] = _to_hash(v) }
260
+ end
261
+ elsif value.respond_to? :to_hash
262
+ value.to_hash
263
+ else
264
+ value
265
+ end
266
+ end
267
+
268
+ end
269
+ end