purecloud 0.41.1 → 0.42.1
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.
- checksums.yaml +4 -4
- data/README.md +3 -3
- data/config-ruby.json +1 -1
- data/doc_out/ADFS.html.md +20 -0
- data/doc_out/CodesRequest.html.md +14 -0
- data/doc_out/ContactSort.html.md +1 -0
- data/doc_out/ContentQueryRequest.html.md +1 -0
- data/doc_out/ConversationAssociation.html.md +15 -0
- data/doc_out/CreateCallbackCommand.html.md +9 -9
- data/doc_out/CreateIntegrationRequest.html.md +16 -0
- data/doc_out/CustomerInteractionCenter.html.md +1 -0
- data/doc_out/DocusignTemplateMapping.html.md +16 -0
- data/doc_out/DomainEdgeSoftwareVersionDto.html.md +1 -1
- data/doc_out/EmbeddedSignatureView.html.md +1 -0
- data/doc_out/IdentityProviderApi.html.md +158 -0
- data/doc_out/Integration.html.md +4 -4
- data/doc_out/IntegrationConfiguration.html.md +3 -3
- data/doc_out/IntegrationStatusInfo.html.md +3 -3
- data/doc_out/IntegrationType.html.md +4 -4
- data/doc_out/JsonNode.html.md +4 -4
- data/doc_out/NumberOrder.html.md +2 -0
- data/doc_out/OAuthProvider.html.md +1 -0
- data/doc_out/Okta.html.md +1 -0
- data/doc_out/OneLogin.html.md +1 -0
- data/doc_out/PolicyActions.html.md +3 -2
- data/doc_out/PureCloud.html.md +1 -0
- data/doc_out/QueryRequest.html.md +1 -0
- data/doc_out/Response.html.md +1 -0
- data/doc_out/RoutingData.html.md +5 -5
- data/doc_out/Salesforce.html.md +1 -0
- data/doc_out/Script.html.md +1 -0
- data/doc_out/SignatureDocumentInfo.html.md +1 -0
- data/doc_out/TelephonyProvidersEdgeApi.html.md +15 -15
- data/doc_out/index.html.md +3 -3
- data/lib/purecloud.rb +5 -0
- data/lib/purecloud/api/identity_provider_api.rb +165 -0
- data/lib/purecloud/api/telephony_providers_edge_api.rb +10 -10
- data/lib/purecloud/api_client.rb +1 -1
- data/lib/purecloud/models/adfs.rb +239 -0
- data/lib/purecloud/models/codes_request.rb +175 -0
- data/lib/purecloud/models/contact_sort.rb +16 -4
- data/lib/purecloud/models/content_query_request.rb +16 -4
- data/lib/purecloud/models/conversation_association.rb +197 -0
- data/lib/purecloud/models/create_callback_command.rb +18 -8
- data/lib/purecloud/models/create_integration_request.rb +200 -0
- data/lib/purecloud/models/customer_interaction_center.rb +13 -1
- data/lib/purecloud/models/dependency.rb +1 -1
- data/lib/purecloud/models/dependency_object.rb +1 -1
- data/lib/purecloud/models/docusign_template_mapping.rb +197 -0
- data/lib/purecloud/models/domain_edge_software_version_dto.rb +13 -13
- data/lib/purecloud/models/embedded_signature_view.rb +15 -4
- data/lib/purecloud/models/flow.rb +1 -1
- data/lib/purecloud/models/integration.rb +2 -1
- data/lib/purecloud/models/integration_type.rb +1 -10
- data/lib/purecloud/models/json_node.rb +49 -49
- data/lib/purecloud/models/number_order.rb +23 -1
- data/lib/purecloud/models/o_auth_provider.rb +13 -1
- data/lib/purecloud/models/okta.rb +13 -1
- data/lib/purecloud/models/one_login.rb +13 -1
- data/lib/purecloud/models/policy_actions.rb +16 -1
- data/lib/purecloud/models/pure_cloud.rb +13 -1
- data/lib/purecloud/models/query_request.rb +16 -4
- data/lib/purecloud/models/response.rb +21 -1
- data/lib/purecloud/models/response_text.rb +9 -0
- data/lib/purecloud/models/routing_data.rb +5 -0
- data/lib/purecloud/models/salesforce.rb +13 -1
- data/lib/purecloud/models/script.rb +13 -1
- data/lib/purecloud/models/signature_document_info.rb +15 -4
- data/lib/purecloud/version.rb +1 -1
- data/newVersion.md +1 -1
- data/swagger.json +1 -1
- data/version.json +1 -1
- metadata +12 -2
data/doc_out/JsonNode.html.md
CHANGED
@@ -7,16 +7,17 @@ title: JsonNode
|
|
7
7
|
|
8
8
|
|Name | Type | Description | Notes|
|
9
9
|
|------------ | ------------- | ------------- | -------------|
|
10
|
+
| **floating_point_number** | **BOOLEAN** | | [optional] [default to false]|
|
11
|
+
| **missing_node** | **BOOLEAN** | | [optional] [default to false]|
|
10
12
|
| **node_type** | **String** | | [optional] |
|
11
13
|
| **float** | **BOOLEAN** | | [optional] [default to false]|
|
14
|
+
| **value_node** | **BOOLEAN** | | [optional] [default to false]|
|
15
|
+
| **container_node** | **BOOLEAN** | | [optional] [default to false]|
|
12
16
|
| **object** | **BOOLEAN** | | [optional] [default to false]|
|
13
17
|
| **boolean** | **BOOLEAN** | | [optional] [default to false]|
|
14
18
|
| **number** | **BOOLEAN** | | [optional] [default to false]|
|
15
|
-
| **container_node** | **BOOLEAN** | | [optional] [default to false]|
|
16
|
-
| **missing_node** | **BOOLEAN** | | [optional] [default to false]|
|
17
19
|
| **pojo** | **BOOLEAN** | | [optional] [default to false]|
|
18
20
|
| **integral_number** | **BOOLEAN** | | [optional] [default to false]|
|
19
|
-
| **floating_point_number** | **BOOLEAN** | | [optional] [default to false]|
|
20
21
|
| **short** | **BOOLEAN** | | [optional] [default to false]|
|
21
22
|
| **int** | **BOOLEAN** | | [optional] [default to false]|
|
22
23
|
| **long** | **BOOLEAN** | | [optional] [default to false]|
|
@@ -25,7 +26,6 @@ title: JsonNode
|
|
25
26
|
| **big_integer** | **BOOLEAN** | | [optional] [default to false]|
|
26
27
|
| **textual** | **BOOLEAN** | | [optional] [default to false]|
|
27
28
|
| **binary** | **BOOLEAN** | | [optional] [default to false]|
|
28
|
-
| **value_node** | **BOOLEAN** | | [optional] [default to false]|
|
29
29
|
| **array** | **BOOLEAN** | | [optional] [default to false]|
|
30
30
|
| **null** | **BOOLEAN** | | [optional] [default to false]|
|
31
31
|
{: class="table table-striped"}
|
data/doc_out/NumberOrder.html.md
CHANGED
@@ -21,6 +21,8 @@ title: NumberOrder
|
|
21
21
|
| **billing_address** | [**PortBillingAddress**](PortBillingAddress.html) | Billing address used for a number port | [optional] |
|
22
22
|
| **responsible_contact** | [**PortContact**](PortContact.html) | Company contact for a number port | [optional] |
|
23
23
|
| **company_name** | **String** | Company name for a number port | [optional] |
|
24
|
+
| **country_code** | **String** | Country dial in codes (telephone dialing prefixes) | [optional] |
|
25
|
+
| **envelope_id** | **String** | Id of the terms and conditions envelope for the order. | [optional] |
|
24
26
|
| **self_uri** | **String** | The URI for this object | [optional] |
|
25
27
|
{: class="table table-striped"}
|
26
28
|
|
@@ -9,6 +9,7 @@ title: OAuthProvider
|
|
9
9
|
|------------ | ------------- | ------------- | -------------|
|
10
10
|
| **id** | **String** | The globally unique identifier for the object. | [optional] |
|
11
11
|
| **name** | **String** | | [optional] |
|
12
|
+
| **disabled** | **BOOLEAN** | | [optional] [default to false]|
|
12
13
|
| **self_uri** | **String** | The URI for this object | [optional] |
|
13
14
|
{: class="table table-striped"}
|
14
15
|
|
data/doc_out/Okta.html.md
CHANGED
@@ -12,6 +12,7 @@ title: Okta
|
|
12
12
|
| **certificate** | **String** | | [optional] |
|
13
13
|
| **issuer_uri** | **String** | | [optional] |
|
14
14
|
| **sso_target_uri** | **String** | | [optional] |
|
15
|
+
| **disabled** | **BOOLEAN** | | [optional] [default to false]|
|
15
16
|
| **self_uri** | **String** | The URI for this object | [optional] |
|
16
17
|
{: class="table table-striped"}
|
17
18
|
|
data/doc_out/OneLogin.html.md
CHANGED
@@ -12,6 +12,7 @@ title: OneLogin
|
|
12
12
|
| **certificate** | **String** | | [optional] |
|
13
13
|
| **issuer_uri** | **String** | | [optional] |
|
14
14
|
| **sso_target_uri** | **String** | | [optional] |
|
15
|
+
| **disabled** | **BOOLEAN** | | [optional] [default to false]|
|
15
16
|
| **self_uri** | **String** | The URI for this object | [optional] |
|
16
17
|
{: class="table table-striped"}
|
17
18
|
|
@@ -7,8 +7,9 @@ title: PolicyActions
|
|
7
7
|
|
8
8
|
|Name | Type | Description | Notes|
|
9
9
|
|------------ | ------------- | ------------- | -------------|
|
10
|
-
| **retain_recording** | **BOOLEAN** |
|
11
|
-
| **delete_recording** | **BOOLEAN** |
|
10
|
+
| **retain_recording** | **BOOLEAN** | true to retain the recording associated with the conversation. Default = true | [optional] [default to false]|
|
11
|
+
| **delete_recording** | **BOOLEAN** | true to delete the recording associated with the conversation. If retainRecording = true, this will be ignored. Default = false | [optional] [default to false]|
|
12
|
+
| **always_delete** | **BOOLEAN** | true to delete the recording associated with the conversation regardless of the values of retainRecording or deleteRecording. Default = false | [optional] [default to false]|
|
12
13
|
| **assign_evaluations** | [**Array<EvaluationAssignment>**](EvaluationAssignment.html) | | [optional] |
|
13
14
|
| **assign_metered_evaluations** | [**Array<MeteredEvaluationAssignment>**](MeteredEvaluationAssignment.html) | | [optional] |
|
14
15
|
| **assign_calibrations** | [**Array<CalibrationAssignment>**](CalibrationAssignment.html) | | [optional] |
|
data/doc_out/PureCloud.html.md
CHANGED
@@ -9,6 +9,7 @@ title: PureCloud
|
|
9
9
|
|------------ | ------------- | ------------- | -------------|
|
10
10
|
| **id** | **String** | The globally unique identifier for the object. | [optional] |
|
11
11
|
| **name** | **String** | | [optional] |
|
12
|
+
| **disabled** | **BOOLEAN** | | [optional] [default to false]|
|
12
13
|
| **self_uri** | **String** | The URI for this object | [optional] |
|
13
14
|
{: class="table table-striped"}
|
14
15
|
|
@@ -14,6 +14,7 @@ title: QueryRequest
|
|
14
14
|
| **sort** | [**Array<SortItem>**](SortItem.html) | | [optional] |
|
15
15
|
| **filters** | [**Array<ContentFilterItem>**](ContentFilterItem.html) | | [optional] |
|
16
16
|
| **attribute_filters** | [**Array<AttributeFilterItem>**](AttributeFilterItem.html) | | [optional] |
|
17
|
+
| **include_shares** | **BOOLEAN** | | [optional] [default to false]|
|
17
18
|
{: class="table table-striped"}
|
18
19
|
|
19
20
|
|
data/doc_out/Response.html.md
CHANGED
@@ -14,6 +14,7 @@ title: Response
|
|
14
14
|
| **texts** | [**Array<ResponseText>**](ResponseText.html) | One or more texts associated with the response. | |
|
15
15
|
| **created_by** | [**User**](User.html) | User that created the response | [optional] |
|
16
16
|
| **date_created** | **DateTime** | The date and time the response was created. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss.SSSZ | [optional] |
|
17
|
+
| **interaction_type** | **String** | The interaction type for this response. | [optional] |
|
17
18
|
| **self_uri** | **String** | The URI for this object | [optional] |
|
18
19
|
{: class="table table-striped"}
|
19
20
|
|
data/doc_out/RoutingData.html.md
CHANGED
@@ -7,11 +7,11 @@ title: RoutingData
|
|
7
7
|
|
8
8
|
|Name | Type | Description | Notes|
|
9
9
|
|------------ | ------------- | ------------- | -------------|
|
10
|
-
| **queue_id** | **String** |
|
11
|
-
| **language_id** | **String** |
|
12
|
-
| **priority** | **Integer** |
|
13
|
-
| **skill_ids** | **Array<String>** |
|
14
|
-
| **preferred_agent_ids** | **Array<String>** |
|
10
|
+
| **queue_id** | **String** | The identifier of the routing queue | |
|
11
|
+
| **language_id** | **String** | The identifier of a language to be considered in routing | [optional] |
|
12
|
+
| **priority** | **Integer** | The priority for routing | [optional] |
|
13
|
+
| **skill_ids** | **Array<String>** | A list of skill identifiers to be considered in routing | [optional] |
|
14
|
+
| **preferred_agent_ids** | **Array<String>** | A list of agents to be preferred in routing | [optional] |
|
15
15
|
{: class="table table-striped"}
|
16
16
|
|
17
17
|
|
data/doc_out/Salesforce.html.md
CHANGED
@@ -12,6 +12,7 @@ title: Salesforce
|
|
12
12
|
| **certificate** | **String** | | [optional] |
|
13
13
|
| **issuer_uri** | **String** | | [optional] |
|
14
14
|
| **sso_target_uri** | **String** | | [optional] |
|
15
|
+
| **disabled** | **BOOLEAN** | | [optional] [default to false]|
|
15
16
|
| **self_uri** | **String** | The URI for this object | [optional] |
|
16
17
|
{: class="table table-striped"}
|
17
18
|
|
data/doc_out/Script.html.md
CHANGED
@@ -19,6 +19,7 @@ title: Script
|
|
19
19
|
| **features** | **Object** | | [optional] |
|
20
20
|
| **variables** | **Object** | | [optional] |
|
21
21
|
| **custom_actions** | **Object** | | [optional] |
|
22
|
+
| **pages** | [**Array<Page>**](Page.html) | | [optional] |
|
22
23
|
| **self_uri** | **String** | The URI for this object | [optional] |
|
23
24
|
{: class="table table-striped"}
|
24
25
|
|
@@ -10,6 +10,7 @@ title: SignatureDocumentInfo
|
|
10
10
|
| **org** | [**Organization**](Organization.html) | | [optional] |
|
11
11
|
| **user** | [**User**](User.html) | | [optional] |
|
12
12
|
| **return_url** | **String** | | [optional] |
|
13
|
+
| **template** | [**DocusignTemplateMapping**](DocusignTemplateMapping.html) | Template ID alias for the ESignature template you would like to retrieve. | [optional] |
|
13
14
|
{: class="table table-striped"}
|
14
15
|
|
15
16
|
|
@@ -19,7 +19,7 @@ Method | HTTP request | Description
|
|
19
19
|
|[**delete_providers_edges_outboundroutes_outboundroute_id**](TelephonyProvidersEdgeApi.html#delete_providers_edges_outboundroutes_outboundroute_id) | **DELETE** /api/v2/telephony/providers/edges/outboundroutes/{outboundRouteId} | Delete Outbound Route|
|
20
20
|
|[**delete_providers_edges_phonebasesettings_phonebase_id**](TelephonyProvidersEdgeApi.html#delete_providers_edges_phonebasesettings_phonebase_id) | **DELETE** /api/v2/telephony/providers/edges/phonebasesettings/{phoneBaseId} | Delete a Phone Base Settings by ID|
|
21
21
|
|[**delete_providers_edges_phones_phone_id**](TelephonyProvidersEdgeApi.html#delete_providers_edges_phones_phone_id) | **DELETE** /api/v2/telephony/providers/edges/phones/{phoneId} | Delete a Phone by ID|
|
22
|
-
|[**delete_providers_edges_sites_site_id**](TelephonyProvidersEdgeApi.html#delete_providers_edges_sites_site_id) | **DELETE** /api/v2/telephony/providers/edges/sites/{siteId} | Delete
|
22
|
+
|[**delete_providers_edges_sites_site_id**](TelephonyProvidersEdgeApi.html#delete_providers_edges_sites_site_id) | **DELETE** /api/v2/telephony/providers/edges/sites/{siteId} | Delete a Site by ID|
|
23
23
|
|[**delete_providers_edges_trunkbasesettings_trunkbasesettings_id**](TelephonyProvidersEdgeApi.html#delete_providers_edges_trunkbasesettings_trunkbasesettings_id) | **DELETE** /api/v2/telephony/providers/edges/trunkbasesettings/{trunkBaseSettingsId} | Delete a Trunk Base Settings object by ID|
|
24
24
|
|[**get_providers_edges**](TelephonyProvidersEdgeApi.html#get_providers_edges) | **GET** /api/v2/telephony/providers/edges | Get the list of edges.|
|
25
25
|
|[**get_providers_edges_availablelanguages**](TelephonyProvidersEdgeApi.html#get_providers_edges_availablelanguages) | **GET** /api/v2/telephony/providers/edges/availablelanguages | Get the list of available languages.|
|
@@ -62,8 +62,8 @@ Method | HTTP request | Description
|
|
62
62
|
|[**get_providers_edges_phones**](TelephonyProvidersEdgeApi.html#get_providers_edges_phones) | **GET** /api/v2/telephony/providers/edges/phones | Get a list of Phone Instances|
|
63
63
|
|[**get_providers_edges_phones_phone_id**](TelephonyProvidersEdgeApi.html#get_providers_edges_phones_phone_id) | **GET** /api/v2/telephony/providers/edges/phones/{phoneId} | Get a Phone by ID|
|
64
64
|
|[**get_providers_edges_phones_template**](TelephonyProvidersEdgeApi.html#get_providers_edges_phones_template) | **GET** /api/v2/telephony/providers/edges/phones/template | Get a Phone instance template based on a Phone Base Settings object. This object can then be modified and saved as a new Phone instance|
|
65
|
-
|[**get_providers_edges_sites**](TelephonyProvidersEdgeApi.html#get_providers_edges_sites) | **GET** /api/v2/telephony/providers/edges/sites | Get the list of
|
66
|
-
|[**get_providers_edges_sites_site_id**](TelephonyProvidersEdgeApi.html#get_providers_edges_sites_site_id) | **GET** /api/v2/telephony/providers/edges/sites/{siteId} | Get
|
65
|
+
|[**get_providers_edges_sites**](TelephonyProvidersEdgeApi.html#get_providers_edges_sites) | **GET** /api/v2/telephony/providers/edges/sites | Get the list of Sites.|
|
66
|
+
|[**get_providers_edges_sites_site_id**](TelephonyProvidersEdgeApi.html#get_providers_edges_sites_site_id) | **GET** /api/v2/telephony/providers/edges/sites/{siteId} | Get a Site by ID.|
|
67
67
|
|[**get_providers_edges_sites_site_id_numberplans**](TelephonyProvidersEdgeApi.html#get_providers_edges_sites_site_id_numberplans) | **GET** /api/v2/telephony/providers/edges/sites/{siteId}/numberplans | Get the list of Number Plans for this Site.|
|
68
68
|
|[**get_providers_edges_sites_site_id_numberplans_classifications**](TelephonyProvidersEdgeApi.html#get_providers_edges_sites_site_id_numberplans_classifications) | **GET** /api/v2/telephony/providers/edges/sites/{siteId}/numberplans/classifications | Get a list of Classifications for this Site|
|
69
69
|
|[**get_providers_edges_sites_site_id_numberplans_numberplan_id**](TelephonyProvidersEdgeApi.html#get_providers_edges_sites_site_id_numberplans_numberplan_id) | **GET** /api/v2/telephony/providers/edges/sites/{siteId}/numberplans/{numberPlanId} | Get a Number Plan by ID.|
|
@@ -98,7 +98,7 @@ Method | HTTP request | Description
|
|
98
98
|
|[**post_providers_edges_phones**](TelephonyProvidersEdgeApi.html#post_providers_edges_phones) | **POST** /api/v2/telephony/providers/edges/phones | Create a new Phone|
|
99
99
|
|[**post_providers_edges_phones_phone_id_reboot**](TelephonyProvidersEdgeApi.html#post_providers_edges_phones_phone_id_reboot) | **POST** /api/v2/telephony/providers/edges/phones/{phoneId}/reboot | Reboot a Phone|
|
100
100
|
|[**post_providers_edges_phones_reboot**](TelephonyProvidersEdgeApi.html#post_providers_edges_phones_reboot) | **POST** /api/v2/telephony/providers/edges/phones/reboot | Reboot Multiple Phones|
|
101
|
-
|[**post_providers_edges_sites**](TelephonyProvidersEdgeApi.html#post_providers_edges_sites) | **POST** /api/v2/telephony/providers/edges/sites | Create a
|
101
|
+
|[**post_providers_edges_sites**](TelephonyProvidersEdgeApi.html#post_providers_edges_sites) | **POST** /api/v2/telephony/providers/edges/sites | Create a Site.|
|
102
102
|
|[**post_providers_edges_sites_site_id_rebalance**](TelephonyProvidersEdgeApi.html#post_providers_edges_sites_site_id_rebalance) | **POST** /api/v2/telephony/providers/edges/sites/{siteId}/rebalance | Triggers the rebalance operation.|
|
103
103
|
|[**post_providers_edges_trunkbasesettings**](TelephonyProvidersEdgeApi.html#post_providers_edges_trunkbasesettings) | **POST** /api/v2/telephony/providers/edges/trunkbasesettings | Create a Trunk Base Settings object|
|
104
104
|
|[**put_providers_edges_certificateauthorities_certificate_id**](TelephonyProvidersEdgeApi.html#put_providers_edges_certificateauthorities_certificate_id) | **PUT** /api/v2/telephony/providers/edges/certificateauthorities/{certificateId} | Update a certificate authority.|
|
@@ -114,7 +114,7 @@ Method | HTTP request | Description
|
|
114
114
|
|[**put_providers_edges_outboundroutes_outboundroute_id**](TelephonyProvidersEdgeApi.html#put_providers_edges_outboundroutes_outboundroute_id) | **PUT** /api/v2/telephony/providers/edges/outboundroutes/{outboundRouteId} | Update outbound route|
|
115
115
|
|[**put_providers_edges_phonebasesettings_phonebase_id**](TelephonyProvidersEdgeApi.html#put_providers_edges_phonebasesettings_phonebase_id) | **PUT** /api/v2/telephony/providers/edges/phonebasesettings/{phoneBaseId} | Update a Phone Base Settings by ID|
|
116
116
|
|[**put_providers_edges_phones_phone_id**](TelephonyProvidersEdgeApi.html#put_providers_edges_phones_phone_id) | **PUT** /api/v2/telephony/providers/edges/phones/{phoneId} | Update a Phone by ID|
|
117
|
-
|[**put_providers_edges_sites_site_id**](TelephonyProvidersEdgeApi.html#put_providers_edges_sites_site_id) | **PUT** /api/v2/telephony/providers/edges/sites/{siteId} | Update a
|
117
|
+
|[**put_providers_edges_sites_site_id**](TelephonyProvidersEdgeApi.html#put_providers_edges_sites_site_id) | **PUT** /api/v2/telephony/providers/edges/sites/{siteId} | Update a Site by ID.|
|
118
118
|
|[**put_providers_edges_sites_site_id_numberplans**](TelephonyProvidersEdgeApi.html#put_providers_edges_sites_site_id_numberplans) | **PUT** /api/v2/telephony/providers/edges/sites/{siteId}/numberplans | Update the list of Number Plans.|
|
119
119
|
|[**put_providers_edges_trunkbasesettings_trunkbasesettings_id**](TelephonyProvidersEdgeApi.html#put_providers_edges_trunkbasesettings_trunkbasesettings_id) | **PUT** /api/v2/telephony/providers/edges/trunkbasesettings/{trunkBaseSettingsId} | Update a Trunk Base Settings object by ID|
|
120
120
|
{: class="table table-striped"}
|
@@ -741,7 +741,7 @@ Name | Type | Description | Notes
|
|
741
741
|
|
742
742
|
## -String** delete_providers_edges_sites_site_id(site_id)
|
743
743
|
|
744
|
-
Delete
|
744
|
+
Delete a Site by ID
|
745
745
|
|
746
746
|
|
747
747
|
|
@@ -766,7 +766,7 @@ site_id = "site_id_example" # String | Site ID
|
|
766
766
|
|
767
767
|
|
768
768
|
begin
|
769
|
-
#Delete
|
769
|
+
#Delete a Site by ID
|
770
770
|
result = api_instance.delete_providers_edges_sites_site_id(site_id)
|
771
771
|
p result
|
772
772
|
rescue PureCloud::ApiError => e
|
@@ -3256,7 +3256,7 @@ Name | Type | Description | Notes
|
|
3256
3256
|
|
3257
3257
|
## -[**SiteEntityListing**](SiteEntityListing.html) get_providers_edges_sites(opts)
|
3258
3258
|
|
3259
|
-
Get the list of
|
3259
|
+
Get the list of Sites.
|
3260
3260
|
|
3261
3261
|
|
3262
3262
|
|
@@ -3287,7 +3287,7 @@ opts = {
|
|
3287
3287
|
}
|
3288
3288
|
|
3289
3289
|
begin
|
3290
|
-
#Get the list of
|
3290
|
+
#Get the list of Sites.
|
3291
3291
|
result = api_instance.get_providers_edges_sites(opts)
|
3292
3292
|
p result
|
3293
3293
|
rescue PureCloud::ApiError => e
|
@@ -3323,7 +3323,7 @@ Name | Type | Description | Notes
|
|
3323
3323
|
|
3324
3324
|
## -[**Site**](Site.html) get_providers_edges_sites_site_id(site_id)
|
3325
3325
|
|
3326
|
-
Get
|
3326
|
+
Get a Site by ID.
|
3327
3327
|
|
3328
3328
|
|
3329
3329
|
|
@@ -3348,7 +3348,7 @@ site_id = "site_id_example" # String | Site ID
|
|
3348
3348
|
|
3349
3349
|
|
3350
3350
|
begin
|
3351
|
-
#Get
|
3351
|
+
#Get a Site by ID.
|
3352
3352
|
result = api_instance.get_providers_edges_sites_site_id(site_id)
|
3353
3353
|
p result
|
3354
3354
|
rescue PureCloud::ApiError => e
|
@@ -5388,7 +5388,7 @@ nil (empty response body)
|
|
5388
5388
|
|
5389
5389
|
## -[**Site**](Site.html) post_providers_edges_sites(opts)
|
5390
5390
|
|
5391
|
-
Create a
|
5391
|
+
Create a Site.
|
5392
5392
|
|
5393
5393
|
|
5394
5394
|
|
@@ -5414,7 +5414,7 @@ opts = {
|
|
5414
5414
|
}
|
5415
5415
|
|
5416
5416
|
begin
|
5417
|
-
#Create a
|
5417
|
+
#Create a Site.
|
5418
5418
|
result = api_instance.post_providers_edges_sites(opts)
|
5419
5419
|
p result
|
5420
5420
|
rescue PureCloud::ApiError => e
|
@@ -6343,7 +6343,7 @@ Name | Type | Description | Notes
|
|
6343
6343
|
|
6344
6344
|
## -[**Site**](Site.html) put_providers_edges_sites_site_id(site_id, opts)
|
6345
6345
|
|
6346
|
-
Update a
|
6346
|
+
Update a Site by ID.
|
6347
6347
|
|
6348
6348
|
|
6349
6349
|
|
@@ -6371,7 +6371,7 @@ opts = {
|
|
6371
6371
|
}
|
6372
6372
|
|
6373
6373
|
begin
|
6374
|
-
#Update a
|
6374
|
+
#Update a Site by ID.
|
6375
6375
|
result = api_instance.put_providers_edges_sites_site_id(site_id, opts)
|
6376
6376
|
p result
|
6377
6377
|
rescue PureCloud::ApiError => e
|
data/doc_out/index.html.md
CHANGED
@@ -9,8 +9,8 @@ With the PureCloud Platform API, you can control all aspects of your PureCloud e
|
|
9
9
|
This SDK is automatically generated by the [Swagger Codegen](https://github.com/swagger-api/swagger-codegen) project:
|
10
10
|
|
11
11
|
- API version: v2
|
12
|
-
- Package version: 0.
|
13
|
-
- Build date: 2016-
|
12
|
+
- Package version: 0.42.1
|
13
|
+
- Build date: 2016-06-05T03:13:29.878Z
|
14
14
|
|
15
15
|
For more information, please visit [https://developer.mypurecloud.com](https://developer.mypurecloud.com)
|
16
16
|
|
@@ -18,7 +18,7 @@ For more information, please visit [https://developer.mypurecloud.com](https://d
|
|
18
18
|
|
19
19
|
### from rubygems.org
|
20
20
|
|
21
|
-
gem 'purecloud', '~> 0.
|
21
|
+
gem 'purecloud', '~> 0.42.1'
|
22
22
|
|
23
23
|
### Install from Git
|
24
24
|
|
data/lib/purecloud.rb
CHANGED
@@ -21,6 +21,7 @@ require 'purecloud/version'
|
|
21
21
|
require 'purecloud/configuration'
|
22
22
|
|
23
23
|
# Models
|
24
|
+
require 'purecloud/models/adfs'
|
24
25
|
require 'purecloud/models/account'
|
25
26
|
require 'purecloud/models/account_manager'
|
26
27
|
require 'purecloud/models/account_overview'
|
@@ -149,6 +150,7 @@ require 'purecloud/models/chat_message'
|
|
149
150
|
require 'purecloud/models/chat_message_user'
|
150
151
|
require 'purecloud/models/client_spreadsheet_transform'
|
151
152
|
require 'purecloud/models/client_text_table_transform'
|
153
|
+
require 'purecloud/models/codes_request'
|
152
154
|
require 'purecloud/models/column_collapse'
|
153
155
|
require 'purecloud/models/command_status'
|
154
156
|
require 'purecloud/models/command_status_entity_listing'
|
@@ -180,6 +182,7 @@ require 'purecloud/models/contract_job'
|
|
180
182
|
require 'purecloud/models/control'
|
181
183
|
require 'purecloud/models/control_options'
|
182
184
|
require 'purecloud/models/conversation'
|
185
|
+
require 'purecloud/models/conversation_association'
|
183
186
|
require 'purecloud/models/conversation_chat'
|
184
187
|
require 'purecloud/models/conversation_entity_listing'
|
185
188
|
require 'purecloud/models/conversation_query'
|
@@ -188,6 +191,7 @@ require 'purecloud/models/create_call_request'
|
|
188
191
|
require 'purecloud/models/create_call_response'
|
189
192
|
require 'purecloud/models/create_callback_command'
|
190
193
|
require 'purecloud/models/create_callback_response'
|
194
|
+
require 'purecloud/models/create_integration_request'
|
191
195
|
require 'purecloud/models/create_share_request'
|
192
196
|
require 'purecloud/models/create_share_request_member'
|
193
197
|
require 'purecloud/models/create_share_response'
|
@@ -236,6 +240,7 @@ require 'purecloud/models/document_entity_listing'
|
|
236
240
|
require 'purecloud/models/document_thumbnail'
|
237
241
|
require 'purecloud/models/document_update'
|
238
242
|
require 'purecloud/models/document_upload'
|
243
|
+
require 'purecloud/models/docusign_template_mapping'
|
239
244
|
require 'purecloud/models/domain_billing_period_entity_listing'
|
240
245
|
require 'purecloud/models/domain_capabilities'
|
241
246
|
require 'purecloud/models/domain_certificate_authority'
|
@@ -24,6 +24,60 @@ module PureCloud
|
|
24
24
|
@api_client = api_client
|
25
25
|
end
|
26
26
|
|
27
|
+
# Delete ADFS Identity Provider
|
28
|
+
#
|
29
|
+
# @param [Hash] opts the optional parameters
|
30
|
+
# @return [nil]
|
31
|
+
def delete_adfs(opts = {})
|
32
|
+
delete_adfs_with_http_info(opts)
|
33
|
+
return nil
|
34
|
+
end
|
35
|
+
|
36
|
+
# Delete ADFS Identity Provider
|
37
|
+
#
|
38
|
+
# @param [Hash] opts the optional parameters
|
39
|
+
# @return [Array<(nil, Fixnum, Hash)>] nil, response status code and response headers
|
40
|
+
def delete_adfs_with_http_info(opts = {})
|
41
|
+
if @api_client.config.debugging
|
42
|
+
@api_client.config.logger.debug "Calling API: IdentityProviderApi#delete_adfs ..."
|
43
|
+
end
|
44
|
+
|
45
|
+
# resource path
|
46
|
+
local_var_path = "/api/v2/identityproviders/adfs".sub('{format}','json')
|
47
|
+
|
48
|
+
# query parameters
|
49
|
+
query_params = {}
|
50
|
+
|
51
|
+
# header parameters
|
52
|
+
header_params = {}
|
53
|
+
|
54
|
+
# HTTP header 'Accept' (if needed)
|
55
|
+
_header_accept = ['application/json']
|
56
|
+
_header_accept_result = @api_client.select_header_accept(_header_accept) and header_params['Accept'] = _header_accept_result
|
57
|
+
|
58
|
+
# HTTP header 'Content-Type'
|
59
|
+
_header_content_type = ['application/json']
|
60
|
+
header_params['Content-Type'] = @api_client.select_header_content_type(_header_content_type)
|
61
|
+
|
62
|
+
# form parameters
|
63
|
+
form_params = {}
|
64
|
+
|
65
|
+
# http body (model)
|
66
|
+
post_body = nil
|
67
|
+
|
68
|
+
auth_names = ['PureCloud Auth']
|
69
|
+
data, status_code, headers = @api_client.call_api(:DELETE, local_var_path,
|
70
|
+
:header_params => header_params,
|
71
|
+
:query_params => query_params,
|
72
|
+
:form_params => form_params,
|
73
|
+
:body => post_body,
|
74
|
+
:auth_names => auth_names)
|
75
|
+
if @api_client.config.debugging
|
76
|
+
@api_client.config.logger.debug "API called: IdentityProviderApi#delete_adfs\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
77
|
+
end
|
78
|
+
return data, status_code, headers
|
79
|
+
end
|
80
|
+
|
27
81
|
# Delete Customer Interaction Center (CIC) Identity Provider
|
28
82
|
#
|
29
83
|
# @param [Hash] opts the optional parameters
|
@@ -348,6 +402,61 @@ module PureCloud
|
|
348
402
|
return data, status_code, headers
|
349
403
|
end
|
350
404
|
|
405
|
+
# Get ADFS Identity Provider
|
406
|
+
#
|
407
|
+
# @param [Hash] opts the optional parameters
|
408
|
+
# @return [ADFS]
|
409
|
+
def get_adfs(opts = {})
|
410
|
+
data, status_code, headers = get_adfs_with_http_info(opts)
|
411
|
+
return data
|
412
|
+
end
|
413
|
+
|
414
|
+
# Get ADFS Identity Provider
|
415
|
+
#
|
416
|
+
# @param [Hash] opts the optional parameters
|
417
|
+
# @return [Array<(ADFS, Fixnum, Hash)>] ADFS data, response status code and response headers
|
418
|
+
def get_adfs_with_http_info(opts = {})
|
419
|
+
if @api_client.config.debugging
|
420
|
+
@api_client.config.logger.debug "Calling API: IdentityProviderApi#get_adfs ..."
|
421
|
+
end
|
422
|
+
|
423
|
+
# resource path
|
424
|
+
local_var_path = "/api/v2/identityproviders/adfs".sub('{format}','json')
|
425
|
+
|
426
|
+
# query parameters
|
427
|
+
query_params = {}
|
428
|
+
|
429
|
+
# header parameters
|
430
|
+
header_params = {}
|
431
|
+
|
432
|
+
# HTTP header 'Accept' (if needed)
|
433
|
+
_header_accept = ['application/json']
|
434
|
+
_header_accept_result = @api_client.select_header_accept(_header_accept) and header_params['Accept'] = _header_accept_result
|
435
|
+
|
436
|
+
# HTTP header 'Content-Type'
|
437
|
+
_header_content_type = ['application/json']
|
438
|
+
header_params['Content-Type'] = @api_client.select_header_content_type(_header_content_type)
|
439
|
+
|
440
|
+
# form parameters
|
441
|
+
form_params = {}
|
442
|
+
|
443
|
+
# http body (model)
|
444
|
+
post_body = nil
|
445
|
+
|
446
|
+
auth_names = ['PureCloud Auth']
|
447
|
+
data, status_code, headers = @api_client.call_api(:GET, local_var_path,
|
448
|
+
:header_params => header_params,
|
449
|
+
:query_params => query_params,
|
450
|
+
:form_params => form_params,
|
451
|
+
:body => post_body,
|
452
|
+
:auth_names => auth_names,
|
453
|
+
:return_type => 'ADFS')
|
454
|
+
if @api_client.config.debugging
|
455
|
+
@api_client.config.logger.debug "API called: IdentityProviderApi#get_adfs\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
456
|
+
end
|
457
|
+
return data, status_code, headers
|
458
|
+
end
|
459
|
+
|
351
460
|
# Get Customer Interaction Center (CIC) Identity Provider
|
352
461
|
#
|
353
462
|
# @param [Hash] opts the optional parameters
|
@@ -733,6 +842,62 @@ module PureCloud
|
|
733
842
|
return data, status_code, headers
|
734
843
|
end
|
735
844
|
|
845
|
+
# Update/Create ADFS Identity Provider
|
846
|
+
#
|
847
|
+
# @param [Hash] opts the optional parameters
|
848
|
+
# @option opts [ADFS] :body Provider
|
849
|
+
# @return [nil]
|
850
|
+
def put_adfs(opts = {})
|
851
|
+
put_adfs_with_http_info(opts)
|
852
|
+
return nil
|
853
|
+
end
|
854
|
+
|
855
|
+
# Update/Create ADFS Identity Provider
|
856
|
+
#
|
857
|
+
# @param [Hash] opts the optional parameters
|
858
|
+
# @option opts [ADFS] :body Provider
|
859
|
+
# @return [Array<(nil, Fixnum, Hash)>] nil, response status code and response headers
|
860
|
+
def put_adfs_with_http_info(opts = {})
|
861
|
+
if @api_client.config.debugging
|
862
|
+
@api_client.config.logger.debug "Calling API: IdentityProviderApi#put_adfs ..."
|
863
|
+
end
|
864
|
+
|
865
|
+
# resource path
|
866
|
+
local_var_path = "/api/v2/identityproviders/adfs".sub('{format}','json')
|
867
|
+
|
868
|
+
# query parameters
|
869
|
+
query_params = {}
|
870
|
+
|
871
|
+
# header parameters
|
872
|
+
header_params = {}
|
873
|
+
|
874
|
+
# HTTP header 'Accept' (if needed)
|
875
|
+
_header_accept = ['application/json']
|
876
|
+
_header_accept_result = @api_client.select_header_accept(_header_accept) and header_params['Accept'] = _header_accept_result
|
877
|
+
|
878
|
+
# HTTP header 'Content-Type'
|
879
|
+
_header_content_type = ['application/json']
|
880
|
+
header_params['Content-Type'] = @api_client.select_header_content_type(_header_content_type)
|
881
|
+
|
882
|
+
# form parameters
|
883
|
+
form_params = {}
|
884
|
+
|
885
|
+
# http body (model)
|
886
|
+
post_body = @api_client.object_to_http_body(opts[:'body'])
|
887
|
+
|
888
|
+
auth_names = ['PureCloud Auth']
|
889
|
+
data, status_code, headers = @api_client.call_api(:PUT, local_var_path,
|
890
|
+
:header_params => header_params,
|
891
|
+
:query_params => query_params,
|
892
|
+
:form_params => form_params,
|
893
|
+
:body => post_body,
|
894
|
+
:auth_names => auth_names)
|
895
|
+
if @api_client.config.debugging
|
896
|
+
@api_client.config.logger.debug "API called: IdentityProviderApi#put_adfs\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
897
|
+
end
|
898
|
+
return data, status_code, headers
|
899
|
+
end
|
900
|
+
|
736
901
|
# Update/Create Customer Interaction Center (CIC) Identity Provider
|
737
902
|
#
|
738
903
|
# @param [Hash] opts the optional parameters
|