purecloudplatformclientv2 51.0.0 → 52.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.
- checksums.yaml +4 -4
- data/README.md +2 -2
- data/docs/AnalyticsEvaluation.md +1 -1
- data/docs/ArchitectApi.md +2 -2
- data/docs/ArrayNode.md +5 -5
- data/docs/Campaign.md +1 -0
- data/docs/CertificateDetails.md +1 -1
- data/docs/ContactList.md +1 -0
- data/docs/DncList.md +1 -0
- data/docs/DncListCreate.md +1 -0
- data/docs/Document.md +1 -1
- data/docs/FaxDocument.md +1 -1
- data/docs/GroupsApi.md +2 -0
- data/docs/JourneyCustomer.md +1 -1
- data/docs/JourneyCustomerSession.md +1 -1
- data/docs/OutboundApi.md +66 -0
- data/docs/TelephonyProvidersEdgeApi.md +0 -339
- data/docs/UsersApi.md +2 -1
- data/lib/purecloudplatformclientv2.rb +0 -1
- data/lib/purecloudplatformclientv2/api/architect_api.rb +4 -4
- data/lib/purecloudplatformclientv2/api/groups_api.rb +9 -0
- data/lib/purecloudplatformclientv2/api/outbound_api.rb +65 -0
- data/lib/purecloudplatformclientv2/api/telephony_providers_edge_api.rb +0 -360
- data/lib/purecloudplatformclientv2/api_client.rb +1 -1
- data/lib/purecloudplatformclientv2/models/aggregate_metric_data.rb +2 -2
- data/lib/purecloudplatformclientv2/models/analytics_evaluation.rb +13 -13
- data/lib/purecloudplatformclientv2/models/analytics_query_predicate.rb +2 -2
- data/lib/purecloudplatformclientv2/models/array_node.rb +65 -65
- data/lib/purecloudplatformclientv2/models/campaign.rb +27 -1
- data/lib/purecloudplatformclientv2/models/certificate_details.rb +13 -13
- data/lib/purecloudplatformclientv2/models/contact_list.rb +27 -1
- data/lib/purecloudplatformclientv2/models/dnc_list.rb +27 -1
- data/lib/purecloudplatformclientv2/models/dnc_list_create.rb +27 -1
- data/lib/purecloudplatformclientv2/models/document.rb +12 -12
- data/lib/purecloudplatformclientv2/models/fax_document.rb +12 -12
- data/lib/purecloudplatformclientv2/models/journey_customer.rb +8 -8
- data/lib/purecloudplatformclientv2/models/journey_customer_session.rb +1 -1
- data/lib/purecloudplatformclientv2/models/observation_metric_data.rb +2 -2
- data/lib/purecloudplatformclientv2/version.rb +1 -1
- metadata +2 -4
- data/docs/EndpointEntityListing.md +0 -22
- data/lib/purecloudplatformclientv2/models/endpoint_entity_listing.rb +0 -428
checksums.yaml
CHANGED
@@ -1,7 +1,7 @@
|
|
1
1
|
---
|
2
2
|
SHA1:
|
3
|
-
metadata.gz:
|
4
|
-
data.tar.gz:
|
3
|
+
metadata.gz: 52514f5c1b499a5f3857f8697fdd87fc2c44066a
|
4
|
+
data.tar.gz: f3c26d26d2edcf1fedf36789c99da62ee30f8269
|
5
5
|
SHA512:
|
6
|
-
metadata.gz:
|
7
|
-
data.tar.gz:
|
6
|
+
metadata.gz: 1566540eac5e7f52b496d52737b444cf1188d093170d8b447f3ffb50832b69a82a9dfa661177b92970e5d47093abd29c0e627017b552d90848a15cfc2e1a86c6
|
7
|
+
data.tar.gz: 65df12f9105471c730f071b08baa8cd750cc97599f77e743acf25e57992a39d42af6853003d219712881850da9cbb1fc81e6139d176ab6e791357ea28599de2c
|
data/README.md
CHANGED
@@ -1,7 +1,7 @@
|
|
1
1
|
---
|
2
2
|
title: PureCloud Ruby Gem
|
3
3
|
---
|
4
|
-

|
5
5
|
|
6
6
|
Documentation can be found at [https://developer.mypurecloud.com/api/rest/client-libraries/ruby/](https://developer.mypurecloud.com/api/rest/client-libraries/ruby/)
|
7
7
|
|
@@ -10,7 +10,7 @@ Documentation can be found at [https://developer.mypurecloud.com/api/rest/client
|
|
10
10
|
### from rubygems.org
|
11
11
|
|
12
12
|
```{"language":"ruby"}
|
13
|
-
gem install 'purecloudplatformclientv2', '~>
|
13
|
+
gem install 'purecloudplatformclientv2', '~> 52.0.0'
|
14
14
|
```
|
15
15
|
|
16
16
|
### Install from Git
|
data/docs/AnalyticsEvaluation.md
CHANGED
@@ -16,8 +16,8 @@ title: AnalyticsEvaluation
|
|
16
16
|
| **context_id** | **String** | A unique identifier for an evaluation form, regardless of version | [optional] |
|
17
17
|
| **form_name** | **String** | Name of the evaluation form | [optional] |
|
18
18
|
| **calibration_id** | **String** | The calibration id used for the purpose of training evaluators | [optional] |
|
19
|
-
| **o_total_score** | **Integer** | | [optional] |
|
20
19
|
| **o_total_critical_score** | **Integer** | | [optional] |
|
20
|
+
| **o_total_score** | **Integer** | | [optional] |
|
21
21
|
{: class="table table-striped"}
|
22
22
|
|
23
23
|
|
data/docs/ArchitectApi.md
CHANGED
@@ -3258,7 +3258,7 @@ Name | Type | Description | Notes
|
|
3258
3258
|
|
3259
3259
|
Get a pageable list of flows, filtered by query parameters
|
3260
3260
|
|
3261
|
-
|
3261
|
+
If one or more IDs are specified, the search will fetch flows that match the given ID(s) and not use any additional supplied query parameters in the search.
|
3262
3262
|
|
3263
3263
|
Wraps GET /api/v2/flows
|
3264
3264
|
|
@@ -3646,7 +3646,7 @@ Name | Type | Description | Notes
|
|
3646
3646
|
|
3647
3647
|
Get a pageable list of basic flow information objects filterable by query parameters.
|
3648
3648
|
|
3649
|
-
This returns a simplified version of /flow consisting of name and type.
|
3649
|
+
This returns a simplified version of /flow consisting of name and type. If one or more IDs are specified, the search will fetch flows that match the given ID(s) and not use any additional supplied query parameters in the search.
|
3650
3650
|
|
3651
3651
|
Wraps GET /api/v2/flows/divisionviews
|
3652
3652
|
|
data/docs/ArrayNode.md
CHANGED
@@ -10,13 +10,9 @@ title: ArrayNode
|
|
10
10
|
| **node_type** | **String** | | [optional] |
|
11
11
|
| **boolean** | **BOOLEAN** | | [optional] |
|
12
12
|
| **number** | **BOOLEAN** | | [optional] |
|
13
|
-
| **float** | **BOOLEAN** | | [optional] |
|
14
13
|
| **object** | **BOOLEAN** | | [optional] |
|
15
|
-
| **
|
16
|
-
| **container_node** | **BOOLEAN** | | [optional] |
|
17
|
-
| **missing_node** | **BOOLEAN** | | [optional] |
|
14
|
+
| **float** | **BOOLEAN** | | [optional] |
|
18
15
|
| **floating_point_number** | **BOOLEAN** | | [optional] |
|
19
|
-
| **pojo** | **BOOLEAN** | | [optional] |
|
20
16
|
| **integral_number** | **BOOLEAN** | | [optional] |
|
21
17
|
| **short** | **BOOLEAN** | | [optional] |
|
22
18
|
| **int** | **BOOLEAN** | | [optional] |
|
@@ -26,6 +22,10 @@ title: ArrayNode
|
|
26
22
|
| **big_integer** | **BOOLEAN** | | [optional] |
|
27
23
|
| **textual** | **BOOLEAN** | | [optional] |
|
28
24
|
| **binary** | **BOOLEAN** | | [optional] |
|
25
|
+
| **value_node** | **BOOLEAN** | | [optional] |
|
26
|
+
| **container_node** | **BOOLEAN** | | [optional] |
|
27
|
+
| **missing_node** | **BOOLEAN** | | [optional] |
|
28
|
+
| **pojo** | **BOOLEAN** | | [optional] |
|
29
29
|
| **array** | **BOOLEAN** | | [optional] |
|
30
30
|
| **null** | **BOOLEAN** | | [optional] |
|
31
31
|
{: class="table table-striped"}
|
data/docs/Campaign.md
CHANGED
@@ -38,6 +38,7 @@ title: Campaign
|
|
38
38
|
| **call_analysis_language** | **String** | The language the edge will use to analyze the call. | [optional] |
|
39
39
|
| **priority** | **Integer** | The priority of this campaign relative to other campaigns that are running on the same queue. 5 is the highest priority, 1 the lowest. | [optional] |
|
40
40
|
| **contact_list_filters** | [**Array<UriReference>**](UriReference.html) | Filter to apply to the contact list before dialing. Currently a campaign can only have one filter applied. | [optional] |
|
41
|
+
| **division** | [**UriReference**](UriReference.html) | The division this campaign belongs to. | [optional] |
|
41
42
|
| **self_uri** | **String** | The URI for this object | [optional] |
|
42
43
|
{: class="table table-striped"}
|
43
44
|
|
data/docs/CertificateDetails.md
CHANGED
@@ -12,8 +12,8 @@ title: CertificateDetails
|
|
12
12
|
| **expiration_date** | **DateTime** | The expiration date of the certificate. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss.SSSZ | [optional] |
|
13
13
|
| **issue_date** | **DateTime** | The issue date of the certificate. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss.SSSZ | [optional] |
|
14
14
|
| **expired** | **BOOLEAN** | True if the certificate is expired, false otherwise. | [optional] |
|
15
|
-
| **valid** | **BOOLEAN** | | [optional] |
|
16
15
|
| **signature_valid** | **BOOLEAN** | | [optional] |
|
16
|
+
| **valid** | **BOOLEAN** | | [optional] |
|
17
17
|
{: class="table table-striped"}
|
18
18
|
|
19
19
|
|
data/docs/ContactList.md
CHANGED
@@ -12,6 +12,7 @@ title: ContactList
|
|
12
12
|
| **date_created** | **DateTime** | Creation time of the entity. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss.SSSZ | [optional] |
|
13
13
|
| **date_modified** | **DateTime** | Last modified time of the entity. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss.SSSZ | [optional] |
|
14
14
|
| **version** | **Integer** | Required for updates, must match the version number of the most recent update | [optional] |
|
15
|
+
| **division** | [**UriReference**](UriReference.html) | The division this entity belongs to. | [optional] |
|
15
16
|
| **column_names** | **Array<String>** | The names of the contact data columns. | |
|
16
17
|
| **phone_columns** | [**Array<ContactPhoneNumberColumn>**](ContactPhoneNumberColumn.html) | Indicates which columns are phone numbers. | |
|
17
18
|
| **import_status** | [**ImportStatus**](ImportStatus.html) | The status of the import process. | [optional] |
|
data/docs/DncList.md
CHANGED
@@ -18,6 +18,7 @@ title: DncList
|
|
18
18
|
| **login_id** | **String** | A dnc.com loginId. Required if the dncSourceType is dnc.com. | [optional] |
|
19
19
|
| **dnc_codes** | **Array<String>** | The list of dnc.com codes to be treated as DNC. Required if the dncSourceType is dnc.com. | [optional] |
|
20
20
|
| **license_id** | **String** | A gryphon license number. Required if the dncSourceType is gryphon. | [optional] |
|
21
|
+
| **division** | [**UriReference**](UriReference.html) | The division this DncList belongs to. | [optional] |
|
21
22
|
| **self_uri** | **String** | The URI for this object | [optional] |
|
22
23
|
{: class="table table-striped"}
|
23
24
|
|
data/docs/DncListCreate.md
CHANGED
@@ -18,6 +18,7 @@ title: DncListCreate
|
|
18
18
|
| **login_id** | **String** | A dnc.com loginId. Required if the dncSourceType is dnc.com. | [optional] |
|
19
19
|
| **dnc_codes** | **Array<String>** | The list of dnc.com codes to be treated as DNC. Required if the dncSourceType is dnc.com. | [optional] |
|
20
20
|
| **license_id** | **String** | A gryphon license number. Required if the dncSourceType is gryphon. | [optional] |
|
21
|
+
| **division** | [**UriReference**](UriReference.html) | The division this DncList belongs to. | [optional] |
|
21
22
|
| **self_uri** | **String** | The URI for this object | [optional] |
|
22
23
|
{: class="table table-striped"}
|
23
24
|
|
data/docs/Document.md
CHANGED
@@ -35,8 +35,8 @@ title: Document
|
|
35
35
|
| **lock_info** | [**LockInfo**](LockInfo.html) | | [optional] |
|
36
36
|
| **acl** | **Array<String>** | A list of permitted action rights for the user making the request | [optional] |
|
37
37
|
| **sharing_status** | **String** | | [optional] |
|
38
|
-
| **sharing_uri** | **String** | | [optional] |
|
39
38
|
| **download_sharing_uri** | **String** | | [optional] |
|
39
|
+
| **sharing_uri** | **String** | | [optional] |
|
40
40
|
| **self_uri** | **String** | The URI for this object | [optional] |
|
41
41
|
{: class="table table-striped"}
|
42
42
|
|
data/docs/FaxDocument.md
CHANGED
@@ -22,8 +22,8 @@ title: FaxDocument
|
|
22
22
|
| **caller_address** | **String** | | [optional] |
|
23
23
|
| **receiver_address** | **String** | | [optional] |
|
24
24
|
| **thumbnails** | [**Array<DocumentThumbnail>**](DocumentThumbnail.html) | | [optional] |
|
25
|
-
| **sharing_uri** | **String** | | [optional] |
|
26
25
|
| **download_sharing_uri** | **String** | | [optional] |
|
26
|
+
| **sharing_uri** | **String** | | [optional] |
|
27
27
|
| **self_uri** | **String** | The URI for this object | [optional] |
|
28
28
|
{: class="table table-striped"}
|
29
29
|
|
data/docs/GroupsApi.md
CHANGED
@@ -528,6 +528,7 @@ opts = {
|
|
528
528
|
page_size: 25, # Integer | Page size
|
529
529
|
page_number: 1, # Integer | Page number
|
530
530
|
id: ["id_example"], # Array<String> | id
|
531
|
+
jabber_id: ["jabber_id_example"], # Array<String> | A list of jabberIds to fetch by bulk (cannot be used with the \"id\" parameter)
|
531
532
|
sort_order: "ASC" # String | Ascending or descending sort order
|
532
533
|
}
|
533
534
|
|
@@ -547,6 +548,7 @@ Name | Type | Description | Notes
|
|
547
548
|
**page_size** | **Integer**| Page size | [optional] [default to 25] |
|
548
549
|
**page_number** | **Integer**| Page number | [optional] [default to 1] |
|
549
550
|
**id** | [**Array<String>**](String.html)| id | [optional] |
|
551
|
+
**jabber_id** | [**Array<String>**](String.html)| A list of jabberIds to fetch by bulk (cannot be used with the \"id\" parameter) | [optional] |
|
550
552
|
**sort_order** | **String**| Ascending or descending sort order | [optional] [default to ASC]<br />**Values**: ascending, descending |
|
551
553
|
{: class="table table-striped"}
|
552
554
|
|
data/docs/JourneyCustomer.md
CHANGED
@@ -8,7 +8,7 @@ title: JourneyCustomer
|
|
8
8
|
|Name | Type | Description | Notes|
|
9
9
|
|------------ | ------------- | ------------- | -------------|
|
10
10
|
| **id** | **String** | An ID of a customer within the Journey System at a point-in-time. Note that a customer entity can have multiple customerIds based on the stitching process. Depending on the context within the PureCloud conversation, this may or may not be mutable. | |
|
11
|
-
| **
|
11
|
+
| **id_type** | **String** | The type of the customerId within the Journey System (e.g. cookie). | |
|
12
12
|
{: class="table table-striped"}
|
13
13
|
|
14
14
|
|
@@ -8,7 +8,7 @@ title: JourneyCustomerSession
|
|
8
8
|
|Name | Type | Description | Notes|
|
9
9
|
|------------ | ------------- | ------------- | -------------|
|
10
10
|
| **id** | **String** | An ID of a Customer/User's session within the Journey System at a point-in-time | |
|
11
|
-
| **type** | **String** | The type of the Customer/User's session
|
11
|
+
| **type** | **String** | The type of the Customer/User's session within the Journey System (e.g. web, app) | |
|
12
12
|
{: class="table table-striped"}
|
13
13
|
|
14
14
|
|
data/docs/OutboundApi.md
CHANGED
@@ -38,6 +38,7 @@ Method | Description
|
|
38
38
|
[**get_outbound_campaignrule**](OutboundApi.html#get_outbound_campaignrule) | Get Campaign Rule
|
39
39
|
[**get_outbound_campaignrules**](OutboundApi.html#get_outbound_campaignrules) | Query Campaign Rule list
|
40
40
|
[**get_outbound_campaigns**](OutboundApi.html#get_outbound_campaigns) | Query a list of dialer campaigns.
|
41
|
+
[**get_outbound_campaigns_divisionview**](OutboundApi.html#get_outbound_campaigns_divisionview) | Get a basic Campaign information object
|
41
42
|
[**get_outbound_campaigns_divisionviews**](OutboundApi.html#get_outbound_campaigns_divisionviews) | Query a list of basic Campaign information objects
|
42
43
|
[**get_outbound_contactlist**](OutboundApi.html#get_outbound_contactlist) | Get a dialer contact list.
|
43
44
|
[**get_outbound_contactlist_contact**](OutboundApi.html#get_outbound_contactlist_contact) | Get a contact.
|
@@ -2116,6 +2117,71 @@ Name | Type | Description | Notes
|
|
2116
2117
|
|
2117
2118
|
|
2118
2119
|
|
2120
|
+
<a name="get_outbound_campaigns_divisionview"></a>
|
2121
|
+
|
2122
|
+
## [**CampaignDivisionView**](CampaignDivisionView.html) get_outbound_campaigns_divisionview(campaign_id)
|
2123
|
+
|
2124
|
+
|
2125
|
+
|
2126
|
+
Get a basic Campaign information object
|
2127
|
+
|
2128
|
+
This returns a simplified version of a Campaign, consisting of name and division.
|
2129
|
+
|
2130
|
+
Wraps GET /api/v2/outbound/campaigns/divisionviews/{campaignId}
|
2131
|
+
|
2132
|
+
Requires ANY permissions:
|
2133
|
+
|
2134
|
+
* outbound:campaign:search
|
2135
|
+
|
2136
|
+
|
2137
|
+
### Example
|
2138
|
+
```{"language":"ruby"}
|
2139
|
+
# load the gem
|
2140
|
+
require 'purecloudplatformclientv2'
|
2141
|
+
# setup authorization
|
2142
|
+
@secret = ENV['PURECLOUD_SECRET']
|
2143
|
+
@id = ENV['PURECLOUD_CLIENT_ID']
|
2144
|
+
environment = "mypurecloud.com"
|
2145
|
+
|
2146
|
+
@authToken = PureCloud.authenticate_with_client_credentials @id, @secret, environment
|
2147
|
+
|
2148
|
+
PureCloud.configure do |config|
|
2149
|
+
config.access_token = @authToken
|
2150
|
+
end
|
2151
|
+
|
2152
|
+
api_instance = PureCloud::OutboundApi.new
|
2153
|
+
|
2154
|
+
campaign_id = "campaign_id_example" # String | Campaign ID
|
2155
|
+
|
2156
|
+
|
2157
|
+
begin
|
2158
|
+
#Get a basic Campaign information object
|
2159
|
+
result = api_instance.get_outbound_campaigns_divisionview(campaign_id)
|
2160
|
+
p result
|
2161
|
+
rescue PureCloud::ApiError => e
|
2162
|
+
puts "Exception when calling OutboundApi->get_outbound_campaigns_divisionview: #{e}"
|
2163
|
+
end
|
2164
|
+
```
|
2165
|
+
|
2166
|
+
### Parameters
|
2167
|
+
|
2168
|
+
Name | Type | Description | Notes
|
2169
|
+
------------- | ------------- | ------------- | -------------
|
2170
|
+
**campaign_id** | **String**| Campaign ID | |
|
2171
|
+
{: class="table table-striped"}
|
2172
|
+
|
2173
|
+
|
2174
|
+
### Return type
|
2175
|
+
|
2176
|
+
[**CampaignDivisionView**](CampaignDivisionView.html)
|
2177
|
+
|
2178
|
+
### HTTP request headers
|
2179
|
+
|
2180
|
+
- **Content-Type**: application/json
|
2181
|
+
- **Accept**: application/json
|
2182
|
+
|
2183
|
+
|
2184
|
+
|
2119
2185
|
<a name="get_outbound_campaigns_divisionviews"></a>
|
2120
2186
|
|
2121
2187
|
## [**CampaignDivisionViewListing**](CampaignDivisionViewListing.html) get_outbound_campaigns_divisionviews(opts)
|
@@ -14,7 +14,6 @@ Method | Description
|
|
14
14
|
[**delete_telephony_providers_edges_certificateauthority**](TelephonyProvidersEdgeApi.html#delete_telephony_providers_edges_certificateauthority) | Delete a certificate authority.
|
15
15
|
[**delete_telephony_providers_edges_didpool**](TelephonyProvidersEdgeApi.html#delete_telephony_providers_edges_didpool) | Delete a DID Pool by ID.
|
16
16
|
[**delete_telephony_providers_edges_edgegroup**](TelephonyProvidersEdgeApi.html#delete_telephony_providers_edges_edgegroup) | Delete an edge group.
|
17
|
-
[**delete_telephony_providers_edges_endpoint**](TelephonyProvidersEdgeApi.html#delete_telephony_providers_edges_endpoint) | Delete endpoint
|
18
17
|
[**delete_telephony_providers_edges_extensionpool**](TelephonyProvidersEdgeApi.html#delete_telephony_providers_edges_extensionpool) | Delete an extension pool by ID
|
19
18
|
[**delete_telephony_providers_edges_outboundroute**](TelephonyProvidersEdgeApi.html#delete_telephony_providers_edges_outboundroute) | Delete Outbound Route
|
20
19
|
[**delete_telephony_providers_edges_phone**](TelephonyProvidersEdgeApi.html#delete_telephony_providers_edges_phone) | Delete a Phone by ID
|
@@ -52,8 +51,6 @@ Method | Description
|
|
52
51
|
[**get_telephony_providers_edges_edgegroup_edgetrunkbase**](TelephonyProvidersEdgeApi.html#get_telephony_providers_edges_edgegroup_edgetrunkbase) | Gets the edge trunk base associated with the edge group
|
53
52
|
[**get_telephony_providers_edges_edgegroups**](TelephonyProvidersEdgeApi.html#get_telephony_providers_edges_edgegroups) | Get the list of edge groups.
|
54
53
|
[**get_telephony_providers_edges_edgeversionreport**](TelephonyProvidersEdgeApi.html#get_telephony_providers_edges_edgeversionreport) | Get the edge version report.
|
55
|
-
[**get_telephony_providers_edges_endpoint**](TelephonyProvidersEdgeApi.html#get_telephony_providers_edges_endpoint) | Get endpoint
|
56
|
-
[**get_telephony_providers_edges_endpoints**](TelephonyProvidersEdgeApi.html#get_telephony_providers_edges_endpoints) | Get endpoints
|
57
54
|
[**get_telephony_providers_edges_extension**](TelephonyProvidersEdgeApi.html#get_telephony_providers_edges_extension) | Get an extension by ID.
|
58
55
|
[**get_telephony_providers_edges_extensionpool**](TelephonyProvidersEdgeApi.html#get_telephony_providers_edges_extensionpool) | Get an extension pool by ID
|
59
56
|
[**get_telephony_providers_edges_extensionpools**](TelephonyProvidersEdgeApi.html#get_telephony_providers_edges_extensionpools) | Get a listing of extension pools
|
@@ -104,7 +101,6 @@ Method | Description
|
|
104
101
|
[**post_telephony_providers_edges_certificateauthorities**](TelephonyProvidersEdgeApi.html#post_telephony_providers_edges_certificateauthorities) | Create a certificate authority.
|
105
102
|
[**post_telephony_providers_edges_didpools**](TelephonyProvidersEdgeApi.html#post_telephony_providers_edges_didpools) | Create a new DID pool
|
106
103
|
[**post_telephony_providers_edges_edgegroups**](TelephonyProvidersEdgeApi.html#post_telephony_providers_edges_edgegroups) | Create an edge group.
|
107
|
-
[**post_telephony_providers_edges_endpoints**](TelephonyProvidersEdgeApi.html#post_telephony_providers_edges_endpoints) | Create endpoint
|
108
104
|
[**post_telephony_providers_edges_extensionpools**](TelephonyProvidersEdgeApi.html#post_telephony_providers_edges_extensionpools) | Create a new extension pool
|
109
105
|
[**post_telephony_providers_edges_outboundroutes**](TelephonyProvidersEdgeApi.html#post_telephony_providers_edges_outboundroutes) | Create outbound rule
|
110
106
|
[**post_telephony_providers_edges_phone_reboot**](TelephonyProvidersEdgeApi.html#post_telephony_providers_edges_phone_reboot) | Reboot a Phone
|
@@ -123,7 +119,6 @@ Method | Description
|
|
123
119
|
[**put_telephony_providers_edges_didpool**](TelephonyProvidersEdgeApi.html#put_telephony_providers_edges_didpool) | Update a DID Pool by ID.
|
124
120
|
[**put_telephony_providers_edges_edgegroup**](TelephonyProvidersEdgeApi.html#put_telephony_providers_edges_edgegroup) | Update an edge group.
|
125
121
|
[**put_telephony_providers_edges_edgegroup_edgetrunkbase**](TelephonyProvidersEdgeApi.html#put_telephony_providers_edges_edgegroup_edgetrunkbase) | Update the edge trunk base associated with the edge group
|
126
|
-
[**put_telephony_providers_edges_endpoint**](TelephonyProvidersEdgeApi.html#put_telephony_providers_edges_endpoint) | Update endpoint
|
127
122
|
[**put_telephony_providers_edges_extension**](TelephonyProvidersEdgeApi.html#put_telephony_providers_edges_extension) | Update an extension by ID.
|
128
123
|
[**put_telephony_providers_edges_extensionpool**](TelephonyProvidersEdgeApi.html#put_telephony_providers_edges_extensionpool) | Update an extension pool by ID
|
129
124
|
[**put_telephony_providers_edges_outboundroute**](TelephonyProvidersEdgeApi.html#put_telephony_providers_edges_outboundroute) | Update outbound route
|
@@ -521,70 +516,6 @@ nil (empty response body)
|
|
521
516
|
|
522
517
|
|
523
518
|
|
524
|
-
<a name="delete_telephony_providers_edges_endpoint"></a>
|
525
|
-
|
526
|
-
## delete_telephony_providers_edges_endpoint(endpoint_id)
|
527
|
-
|
528
|
-
|
529
|
-
|
530
|
-
Delete endpoint
|
531
|
-
|
532
|
-
|
533
|
-
|
534
|
-
Wraps DELETE /api/v2/telephony/providers/edges/endpoints/{endpointId}
|
535
|
-
|
536
|
-
Requires ANY permissions:
|
537
|
-
|
538
|
-
* telephony:plugin:all
|
539
|
-
|
540
|
-
|
541
|
-
### Example
|
542
|
-
```{"language":"ruby"}
|
543
|
-
# load the gem
|
544
|
-
require 'purecloudplatformclientv2'
|
545
|
-
# setup authorization
|
546
|
-
@secret = ENV['PURECLOUD_SECRET']
|
547
|
-
@id = ENV['PURECLOUD_CLIENT_ID']
|
548
|
-
environment = "mypurecloud.com"
|
549
|
-
|
550
|
-
@authToken = PureCloud.authenticate_with_client_credentials @id, @secret, environment
|
551
|
-
|
552
|
-
PureCloud.configure do |config|
|
553
|
-
config.access_token = @authToken
|
554
|
-
end
|
555
|
-
|
556
|
-
api_instance = PureCloud::TelephonyProvidersEdgeApi.new
|
557
|
-
|
558
|
-
endpoint_id = "endpoint_id_example" # String | Endpoint ID
|
559
|
-
|
560
|
-
|
561
|
-
begin
|
562
|
-
#Delete endpoint
|
563
|
-
api_instance.delete_telephony_providers_edges_endpoint(endpoint_id)
|
564
|
-
rescue PureCloud::ApiError => e
|
565
|
-
puts "Exception when calling TelephonyProvidersEdgeApi->delete_telephony_providers_edges_endpoint: #{e}"
|
566
|
-
end
|
567
|
-
```
|
568
|
-
|
569
|
-
### Parameters
|
570
|
-
|
571
|
-
Name | Type | Description | Notes
|
572
|
-
------------- | ------------- | ------------- | -------------
|
573
|
-
**endpoint_id** | **String**| Endpoint ID | |
|
574
|
-
{: class="table table-striped"}
|
575
|
-
|
576
|
-
|
577
|
-
### Return type
|
578
|
-
|
579
|
-
nil (empty response body)
|
580
|
-
|
581
|
-
### HTTP request headers
|
582
|
-
|
583
|
-
- **Content-Type**: application/json
|
584
|
-
- **Accept**: application/json
|
585
|
-
|
586
|
-
|
587
|
-
|
588
519
|
<a name="delete_telephony_providers_edges_extensionpool"></a>
|
589
520
|
|
590
521
|
## delete_telephony_providers_edges_extensionpool(extension_pool_id)
|
@@ -3086,143 +3017,6 @@ This endpoint does not need any parameter.
|
|
3086
3017
|
|
3087
3018
|
|
3088
3019
|
|
3089
|
-
<a name="get_telephony_providers_edges_endpoint"></a>
|
3090
|
-
|
3091
|
-
## [**Endpoint**](Endpoint.html) get_telephony_providers_edges_endpoint(endpoint_id)
|
3092
|
-
|
3093
|
-
|
3094
|
-
|
3095
|
-
Get endpoint
|
3096
|
-
|
3097
|
-
|
3098
|
-
|
3099
|
-
Wraps GET /api/v2/telephony/providers/edges/endpoints/{endpointId}
|
3100
|
-
|
3101
|
-
Requires ANY permissions:
|
3102
|
-
|
3103
|
-
* telephony:plugin:all
|
3104
|
-
|
3105
|
-
|
3106
|
-
### Example
|
3107
|
-
```{"language":"ruby"}
|
3108
|
-
# load the gem
|
3109
|
-
require 'purecloudplatformclientv2'
|
3110
|
-
# setup authorization
|
3111
|
-
@secret = ENV['PURECLOUD_SECRET']
|
3112
|
-
@id = ENV['PURECLOUD_CLIENT_ID']
|
3113
|
-
environment = "mypurecloud.com"
|
3114
|
-
|
3115
|
-
@authToken = PureCloud.authenticate_with_client_credentials @id, @secret, environment
|
3116
|
-
|
3117
|
-
PureCloud.configure do |config|
|
3118
|
-
config.access_token = @authToken
|
3119
|
-
end
|
3120
|
-
|
3121
|
-
api_instance = PureCloud::TelephonyProvidersEdgeApi.new
|
3122
|
-
|
3123
|
-
endpoint_id = "endpoint_id_example" # String | Endpoint ID
|
3124
|
-
|
3125
|
-
|
3126
|
-
begin
|
3127
|
-
#Get endpoint
|
3128
|
-
result = api_instance.get_telephony_providers_edges_endpoint(endpoint_id)
|
3129
|
-
p result
|
3130
|
-
rescue PureCloud::ApiError => e
|
3131
|
-
puts "Exception when calling TelephonyProvidersEdgeApi->get_telephony_providers_edges_endpoint: #{e}"
|
3132
|
-
end
|
3133
|
-
```
|
3134
|
-
|
3135
|
-
### Parameters
|
3136
|
-
|
3137
|
-
Name | Type | Description | Notes
|
3138
|
-
------------- | ------------- | ------------- | -------------
|
3139
|
-
**endpoint_id** | **String**| Endpoint ID | |
|
3140
|
-
{: class="table table-striped"}
|
3141
|
-
|
3142
|
-
|
3143
|
-
### Return type
|
3144
|
-
|
3145
|
-
[**Endpoint**](Endpoint.html)
|
3146
|
-
|
3147
|
-
### HTTP request headers
|
3148
|
-
|
3149
|
-
- **Content-Type**: application/json
|
3150
|
-
- **Accept**: application/json
|
3151
|
-
|
3152
|
-
|
3153
|
-
|
3154
|
-
<a name="get_telephony_providers_edges_endpoints"></a>
|
3155
|
-
|
3156
|
-
## [**EndpointEntityListing**](EndpointEntityListing.html) get_telephony_providers_edges_endpoints(opts)
|
3157
|
-
|
3158
|
-
|
3159
|
-
|
3160
|
-
Get endpoints
|
3161
|
-
|
3162
|
-
|
3163
|
-
|
3164
|
-
Wraps GET /api/v2/telephony/providers/edges/endpoints
|
3165
|
-
|
3166
|
-
Requires ANY permissions:
|
3167
|
-
|
3168
|
-
* telephony:plugin:all
|
3169
|
-
|
3170
|
-
|
3171
|
-
### Example
|
3172
|
-
```{"language":"ruby"}
|
3173
|
-
# load the gem
|
3174
|
-
require 'purecloudplatformclientv2'
|
3175
|
-
# setup authorization
|
3176
|
-
@secret = ENV['PURECLOUD_SECRET']
|
3177
|
-
@id = ENV['PURECLOUD_CLIENT_ID']
|
3178
|
-
environment = "mypurecloud.com"
|
3179
|
-
|
3180
|
-
@authToken = PureCloud.authenticate_with_client_credentials @id, @secret, environment
|
3181
|
-
|
3182
|
-
PureCloud.configure do |config|
|
3183
|
-
config.access_token = @authToken
|
3184
|
-
end
|
3185
|
-
|
3186
|
-
api_instance = PureCloud::TelephonyProvidersEdgeApi.new
|
3187
|
-
|
3188
|
-
opts = {
|
3189
|
-
page_size: 25, # Integer | Page size
|
3190
|
-
page_number: 1, # Integer | Page number
|
3191
|
-
name: "name_example", # String | Name
|
3192
|
-
sort_by: "name" # String | Sort by
|
3193
|
-
}
|
3194
|
-
|
3195
|
-
begin
|
3196
|
-
#Get endpoints
|
3197
|
-
result = api_instance.get_telephony_providers_edges_endpoints(opts)
|
3198
|
-
p result
|
3199
|
-
rescue PureCloud::ApiError => e
|
3200
|
-
puts "Exception when calling TelephonyProvidersEdgeApi->get_telephony_providers_edges_endpoints: #{e}"
|
3201
|
-
end
|
3202
|
-
```
|
3203
|
-
|
3204
|
-
### Parameters
|
3205
|
-
|
3206
|
-
Name | Type | Description | Notes
|
3207
|
-
------------- | ------------- | ------------- | -------------
|
3208
|
-
**page_size** | **Integer**| Page size | [optional] [default to 25] |
|
3209
|
-
**page_number** | **Integer**| Page number | [optional] [default to 1] |
|
3210
|
-
**name** | **String**| Name | [optional] |
|
3211
|
-
**sort_by** | **String**| Sort by | [optional] [default to name] |
|
3212
|
-
{: class="table table-striped"}
|
3213
|
-
|
3214
|
-
|
3215
|
-
### Return type
|
3216
|
-
|
3217
|
-
[**EndpointEntityListing**](EndpointEntityListing.html)
|
3218
|
-
|
3219
|
-
### HTTP request headers
|
3220
|
-
|
3221
|
-
- **Content-Type**: application/json
|
3222
|
-
- **Accept**: application/json
|
3223
|
-
|
3224
|
-
|
3225
|
-
|
3226
3020
|
<a name="get_telephony_providers_edges_extension"></a>
|
3227
3021
|
|
3228
3022
|
## [**Extension**](Extension.html) get_telephony_providers_edges_extension(extension_id)
|
@@ -6655,71 +6449,6 @@ Name | Type | Description | Notes
|
|
6655
6449
|
|
6656
6450
|
|
6657
6451
|
|
6658
|
-
<a name="post_telephony_providers_edges_endpoints"></a>
|
6659
|
-
|
6660
|
-
## [**Endpoint**](Endpoint.html) post_telephony_providers_edges_endpoints(body)
|
6661
|
-
|
6662
|
-
|
6663
|
-
|
6664
|
-
Create endpoint
|
6665
|
-
|
6666
|
-
|
6667
|
-
|
6668
|
-
Wraps POST /api/v2/telephony/providers/edges/endpoints
|
6669
|
-
|
6670
|
-
Requires ANY permissions:
|
6671
|
-
|
6672
|
-
* telephony:plugin:all
|
6673
|
-
|
6674
|
-
|
6675
|
-
### Example
|
6676
|
-
```{"language":"ruby"}
|
6677
|
-
# load the gem
|
6678
|
-
require 'purecloudplatformclientv2'
|
6679
|
-
# setup authorization
|
6680
|
-
@secret = ENV['PURECLOUD_SECRET']
|
6681
|
-
@id = ENV['PURECLOUD_CLIENT_ID']
|
6682
|
-
environment = "mypurecloud.com"
|
6683
|
-
|
6684
|
-
@authToken = PureCloud.authenticate_with_client_credentials @id, @secret, environment
|
6685
|
-
|
6686
|
-
PureCloud.configure do |config|
|
6687
|
-
config.access_token = @authToken
|
6688
|
-
end
|
6689
|
-
|
6690
|
-
api_instance = PureCloud::TelephonyProvidersEdgeApi.new
|
6691
|
-
|
6692
|
-
body = PureCloud::Endpoint.new # Endpoint | EndpointTemplate
|
6693
|
-
|
6694
|
-
|
6695
|
-
begin
|
6696
|
-
#Create endpoint
|
6697
|
-
result = api_instance.post_telephony_providers_edges_endpoints(body)
|
6698
|
-
p result
|
6699
|
-
rescue PureCloud::ApiError => e
|
6700
|
-
puts "Exception when calling TelephonyProvidersEdgeApi->post_telephony_providers_edges_endpoints: #{e}"
|
6701
|
-
end
|
6702
|
-
```
|
6703
|
-
|
6704
|
-
### Parameters
|
6705
|
-
|
6706
|
-
Name | Type | Description | Notes
|
6707
|
-
------------- | ------------- | ------------- | -------------
|
6708
|
-
**body** | [**Endpoint**](Endpoint.html)| EndpointTemplate | |
|
6709
|
-
{: class="table table-striped"}
|
6710
|
-
|
6711
|
-
|
6712
|
-
### Return type
|
6713
|
-
|
6714
|
-
[**Endpoint**](Endpoint.html)
|
6715
|
-
|
6716
|
-
### HTTP request headers
|
6717
|
-
|
6718
|
-
- **Content-Type**: application/json
|
6719
|
-
- **Accept**: application/json
|
6720
|
-
|
6721
|
-
|
6722
|
-
|
6723
6452
|
<a name="post_telephony_providers_edges_extensionpools"></a>
|
6724
6453
|
|
6725
6454
|
## [**ExtensionPool**](ExtensionPool.html) post_telephony_providers_edges_extensionpools(body)
|
@@ -7923,74 +7652,6 @@ Name | Type | Description | Notes
|
|
7923
7652
|
|
7924
7653
|
|
7925
7654
|
|
7926
|
-
<a name="put_telephony_providers_edges_endpoint"></a>
|
7927
|
-
|
7928
|
-
## [**Endpoint**](Endpoint.html) put_telephony_providers_edges_endpoint(endpoint_id, body)
|
7929
|
-
|
7930
|
-
|
7931
|
-
|
7932
|
-
Update endpoint
|
7933
|
-
|
7934
|
-
|
7935
|
-
|
7936
|
-
Wraps PUT /api/v2/telephony/providers/edges/endpoints/{endpointId}
|
7937
|
-
|
7938
|
-
Requires ANY permissions:
|
7939
|
-
|
7940
|
-
* telephony:plugin:all
|
7941
|
-
|
7942
|
-
|
7943
|
-
### Example
|
7944
|
-
```{"language":"ruby"}
|
7945
|
-
# load the gem
|
7946
|
-
require 'purecloudplatformclientv2'
|
7947
|
-
# setup authorization
|
7948
|
-
@secret = ENV['PURECLOUD_SECRET']
|
7949
|
-
@id = ENV['PURECLOUD_CLIENT_ID']
|
7950
|
-
environment = "mypurecloud.com"
|
7951
|
-
|
7952
|
-
@authToken = PureCloud.authenticate_with_client_credentials @id, @secret, environment
|
7953
|
-
|
7954
|
-
PureCloud.configure do |config|
|
7955
|
-
config.access_token = @authToken
|
7956
|
-
end
|
7957
|
-
|
7958
|
-
api_instance = PureCloud::TelephonyProvidersEdgeApi.new
|
7959
|
-
|
7960
|
-
endpoint_id = "endpoint_id_example" # String | Endpoint ID
|
7961
|
-
|
7962
|
-
body = PureCloud::Endpoint.new # Endpoint | EndpointTemplate
|
7963
|
-
|
7964
|
-
|
7965
|
-
begin
|
7966
|
-
#Update endpoint
|
7967
|
-
result = api_instance.put_telephony_providers_edges_endpoint(endpoint_id, body)
|
7968
|
-
p result
|
7969
|
-
rescue PureCloud::ApiError => e
|
7970
|
-
puts "Exception when calling TelephonyProvidersEdgeApi->put_telephony_providers_edges_endpoint: #{e}"
|
7971
|
-
end
|
7972
|
-
```
|
7973
|
-
|
7974
|
-
### Parameters
|
7975
|
-
|
7976
|
-
Name | Type | Description | Notes
|
7977
|
-
------------- | ------------- | ------------- | -------------
|
7978
|
-
**endpoint_id** | **String**| Endpoint ID | |
|
7979
|
-
**body** | [**Endpoint**](Endpoint.html)| EndpointTemplate | |
|
7980
|
-
{: class="table table-striped"}
|
7981
|
-
|
7982
|
-
|
7983
|
-
### Return type
|
7984
|
-
|
7985
|
-
[**Endpoint**](Endpoint.html)
|
7986
|
-
|
7987
|
-
### HTTP request headers
|
7988
|
-
|
7989
|
-
- **Content-Type**: application/json
|
7990
|
-
- **Accept**: application/json
|
7991
|
-
|
7992
|
-
|
7993
|
-
|
7994
7655
|
<a name="put_telephony_providers_edges_extension"></a>
|
7995
7656
|
|
7996
7657
|
## [**Extension**](Extension.html) put_telephony_providers_edges_extension(extension_id, body)
|