purecloudplatformclientv2 17.0.0 → 18.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/AnalyticsConversation.md +5 -5
- data/docs/AnalyticsConversationSegment.md +9 -9
- data/docs/AnalyticsEvaluation.md +10 -10
- data/docs/AnalyticsParticipant.md +7 -7
- data/docs/AnalyticsSession.md +27 -27
- data/docs/BillingApi.md +75 -0
- data/docs/BillingUsage.md +15 -0
- data/docs/BillingUsageReport.md +18 -0
- data/docs/BillingUsageResource.md +14 -0
- data/docs/CallCommand.md +1 -0
- data/docs/Conversation.md +1 -1
- data/docs/CreateQueueRequest.md +9 -9
- data/docs/DID.md +9 -9
- data/docs/DIDPool.md +9 -9
- data/docs/DirectoryUserDevicesListing.md +22 -0
- data/docs/DomainCertificateAuthority.md +9 -9
- data/docs/DomainLogicalInterface.md +9 -9
- data/docs/DomainOrganizationRole.md +1 -1
- data/docs/DomainOrganizationRoleCreate.md +1 -1
- data/docs/DomainOrganizationRoleUpdate.md +1 -1
- data/docs/DomainPhysicalInterface.md +9 -9
- data/docs/DomainSchemaReference.md +9 -9
- data/docs/Edge.md +10 -10
- data/docs/EdgeGroup.md +9 -9
- data/docs/EdgeLine.md +9 -9
- data/docs/EdgeLogsJob.md +9 -9
- data/docs/EdgeLogsJobFile.md +9 -9
- data/docs/EdgeLogsJobResponse.md +9 -9
- data/docs/EdgeTrunkBase.md +9 -9
- data/docs/Endpoint.md +9 -9
- data/docs/Extension.md +9 -9
- data/docs/ExtensionPool.md +9 -9
- data/docs/IVR.md +9 -9
- data/docs/JsonNode.md +4 -4
- data/docs/Line.md +9 -9
- data/docs/LineBase.md +9 -9
- data/docs/Metabase.md +8 -8
- data/docs/MobileDevicesApi.md +320 -0
- data/docs/NumberPlan.md +9 -9
- data/docs/OutboundApi.md +113 -0
- data/docs/OutboundRoute.md +9 -9
- data/docs/OutboundRouteBase.md +9 -9
- data/docs/OutboundSettings.md +20 -0
- data/docs/Phone.md +9 -9
- data/docs/PhoneBase.md +9 -9
- data/docs/Queue.md +9 -9
- data/docs/Schedule.md +10 -10
- data/docs/ScheduleGroup.md +10 -10
- data/docs/SchemaCategory.md +9 -9
- data/docs/Site.md +9 -9
- data/docs/Trunk.md +9 -9
- data/docs/TrunkBase.md +9 -9
- data/docs/UserDevice.md +22 -0
- data/docs/UserQueue.md +9 -9
- data/docs/UsersApi.md +1 -1
- data/lib/purecloudplatformclientv2.rb +8 -0
- data/lib/purecloudplatformclientv2/api/billing_api.rb +104 -0
- data/lib/purecloudplatformclientv2/api/mobile_devices_api.rb +380 -0
- data/lib/purecloudplatformclientv2/api/outbound_api.rb +119 -0
- data/lib/purecloudplatformclientv2/api/users_api.rb +2 -2
- data/lib/purecloudplatformclientv2/api_client.rb +1 -1
- data/lib/purecloudplatformclientv2/models/analytics_conversation.rb +5 -2
- data/lib/purecloudplatformclientv2/models/analytics_conversation_segment.rb +9 -2
- data/lib/purecloudplatformclientv2/models/analytics_evaluation.rb +10 -0
- data/lib/purecloudplatformclientv2/models/analytics_participant.rb +7 -0
- data/lib/purecloudplatformclientv2/models/analytics_session.rb +42 -2
- data/lib/purecloudplatformclientv2/models/billing_usage.rb +271 -0
- data/lib/purecloudplatformclientv2/models/billing_usage_report.rb +348 -0
- data/lib/purecloudplatformclientv2/models/billing_usage_resource.rb +238 -0
- data/lib/purecloudplatformclientv2/models/call_command.rb +30 -4
- data/lib/purecloudplatformclientv2/models/conversation.rb +1 -1
- data/lib/purecloudplatformclientv2/models/create_queue_request.rb +9 -2
- data/lib/purecloudplatformclientv2/models/did.rb +9 -2
- data/lib/purecloudplatformclientv2/models/did_pool.rb +9 -2
- data/lib/purecloudplatformclientv2/models/directory_user_devices_listing.rb +428 -0
- data/lib/purecloudplatformclientv2/models/domain_certificate_authority.rb +9 -2
- data/lib/purecloudplatformclientv2/models/domain_logical_interface.rb +9 -2
- data/lib/purecloudplatformclientv2/models/domain_organization_role.rb +12 -12
- data/lib/purecloudplatformclientv2/models/domain_organization_role_create.rb +12 -12
- data/lib/purecloudplatformclientv2/models/domain_organization_role_update.rb +12 -12
- data/lib/purecloudplatformclientv2/models/domain_physical_interface.rb +9 -2
- data/lib/purecloudplatformclientv2/models/domain_schema_reference.rb +9 -2
- data/lib/purecloudplatformclientv2/models/edge.rb +10 -2
- data/lib/purecloudplatformclientv2/models/edge_group.rb +9 -2
- data/lib/purecloudplatformclientv2/models/edge_line.rb +9 -2
- data/lib/purecloudplatformclientv2/models/edge_logs_job.rb +9 -2
- data/lib/purecloudplatformclientv2/models/edge_logs_job_file.rb +9 -2
- data/lib/purecloudplatformclientv2/models/edge_logs_job_response.rb +9 -2
- data/lib/purecloudplatformclientv2/models/edge_trunk_base.rb +9 -2
- data/lib/purecloudplatformclientv2/models/endpoint.rb +9 -2
- data/lib/purecloudplatformclientv2/models/extension.rb +9 -2
- data/lib/purecloudplatformclientv2/models/extension_pool.rb +9 -2
- data/lib/purecloudplatformclientv2/models/intraday_data_group.rb +2 -2
- data/lib/purecloudplatformclientv2/models/intraday_data_update_notification_intraday_data_group.rb +2 -2
- data/lib/purecloudplatformclientv2/models/intraday_data_update_notification_intraday_data_groupings.rb +2 -2
- data/lib/purecloudplatformclientv2/models/ivr.rb +9 -2
- data/lib/purecloudplatformclientv2/models/json_node.rb +72 -72
- data/lib/purecloudplatformclientv2/models/line.rb +9 -2
- data/lib/purecloudplatformclientv2/models/line_base.rb +9 -2
- data/lib/purecloudplatformclientv2/models/metabase.rb +8 -2
- data/lib/purecloudplatformclientv2/models/number_plan.rb +9 -2
- data/lib/purecloudplatformclientv2/models/outbound_route.rb +9 -2
- data/lib/purecloudplatformclientv2/models/outbound_route_base.rb +9 -2
- data/lib/purecloudplatformclientv2/models/outbound_settings.rb +383 -0
- data/lib/purecloudplatformclientv2/models/phone.rb +9 -2
- data/lib/purecloudplatformclientv2/models/phone_base.rb +9 -2
- data/lib/purecloudplatformclientv2/models/queue.rb +9 -2
- data/lib/purecloudplatformclientv2/models/recording.rb +2 -2
- data/lib/purecloudplatformclientv2/models/schedule.rb +15 -2
- data/lib/purecloudplatformclientv2/models/schedule_group.rb +15 -2
- data/lib/purecloudplatformclientv2/models/schema_category.rb +9 -2
- data/lib/purecloudplatformclientv2/models/site.rb +9 -2
- data/lib/purecloudplatformclientv2/models/trunk.rb +9 -2
- data/lib/purecloudplatformclientv2/models/trunk_base.rb +9 -2
- data/lib/purecloudplatformclientv2/models/user_device.rb +478 -0
- data/lib/purecloudplatformclientv2/models/user_queue.rb +9 -2
- data/lib/purecloudplatformclientv2/version.rb +1 -1
- metadata +19 -3
data/docs/OutboundRoute.md
CHANGED
|
@@ -9,15 +9,15 @@ title: OutboundRoute
|
|
|
9
9
|
|------------ | ------------- | ------------- | -------------|
|
|
10
10
|
| **id** | **String** | The globally unique identifier for the object. | [optional] |
|
|
11
11
|
| **name** | **String** | The name of the entity. | |
|
|
12
|
-
| **description** | **String** |
|
|
13
|
-
| **version** | **Integer** |
|
|
14
|
-
| **date_created** | **DateTime** | Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss.SSSZ | [optional] |
|
|
15
|
-
| **date_modified** | **DateTime** | Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss.SSSZ | [optional] |
|
|
16
|
-
| **modified_by** | **String** |
|
|
17
|
-
| **created_by** | **String** |
|
|
18
|
-
| **state** | **String** |
|
|
19
|
-
| **modified_by_app** | **String** |
|
|
20
|
-
| **created_by_app** | **String** |
|
|
12
|
+
| **description** | **String** | The resource's description. | [optional] |
|
|
13
|
+
| **version** | **Integer** | The current version of the resource. | [optional] |
|
|
14
|
+
| **date_created** | **DateTime** | The date the resource was created. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss.SSSZ | [optional] |
|
|
15
|
+
| **date_modified** | **DateTime** | The date of the last modification to the resource. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss.SSSZ | [optional] |
|
|
16
|
+
| **modified_by** | **String** | The ID of the user that last modified the resource. | [optional] |
|
|
17
|
+
| **created_by** | **String** | The ID of the user that created the resource. | [optional] |
|
|
18
|
+
| **state** | **String** | Indicates if the resource is active, inactive, or deleted. | [optional] |
|
|
19
|
+
| **modified_by_app** | **String** | The application that last modified the resource. | [optional] |
|
|
20
|
+
| **created_by_app** | **String** | The application that created the resource. | [optional] |
|
|
21
21
|
| **classification_types** | **Array<String>** | The site associated to the outbound route. | |
|
|
22
22
|
| **enabled** | **BOOLEAN** | | [optional] |
|
|
23
23
|
| **distribution** | **String** | | [optional] |
|
data/docs/OutboundRouteBase.md
CHANGED
|
@@ -9,15 +9,15 @@ title: OutboundRouteBase
|
|
|
9
9
|
|------------ | ------------- | ------------- | -------------|
|
|
10
10
|
| **id** | **String** | The globally unique identifier for the object. | [optional] |
|
|
11
11
|
| **name** | **String** | The name of the entity. | |
|
|
12
|
-
| **description** | **String** |
|
|
13
|
-
| **version** | **Integer** |
|
|
14
|
-
| **date_created** | **DateTime** | Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss.SSSZ | [optional] |
|
|
15
|
-
| **date_modified** | **DateTime** | Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss.SSSZ | [optional] |
|
|
16
|
-
| **modified_by** | **String** |
|
|
17
|
-
| **created_by** | **String** |
|
|
18
|
-
| **state** | **String** |
|
|
19
|
-
| **modified_by_app** | **String** |
|
|
20
|
-
| **created_by_app** | **String** |
|
|
12
|
+
| **description** | **String** | The resource's description. | [optional] |
|
|
13
|
+
| **version** | **Integer** | The current version of the resource. | [optional] |
|
|
14
|
+
| **date_created** | **DateTime** | The date the resource was created. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss.SSSZ | [optional] |
|
|
15
|
+
| **date_modified** | **DateTime** | The date of the last modification to the resource. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss.SSSZ | [optional] |
|
|
16
|
+
| **modified_by** | **String** | The ID of the user that last modified the resource. | [optional] |
|
|
17
|
+
| **created_by** | **String** | The ID of the user that created the resource. | [optional] |
|
|
18
|
+
| **state** | **String** | Indicates if the resource is active, inactive, or deleted. | [optional] |
|
|
19
|
+
| **modified_by_app** | **String** | The application that last modified the resource. | [optional] |
|
|
20
|
+
| **created_by_app** | **String** | The application that created the resource. | [optional] |
|
|
21
21
|
| **classification_types** | **Array<String>** | The site associated to the outbound route. | |
|
|
22
22
|
| **enabled** | **BOOLEAN** | | [optional] |
|
|
23
23
|
| **distribution** | **String** | | [optional] |
|
|
@@ -0,0 +1,20 @@
|
|
|
1
|
+
---
|
|
2
|
+
title: OutboundSettings
|
|
3
|
+
---
|
|
4
|
+
## PureCloud::OutboundSettings
|
|
5
|
+
|
|
6
|
+
## Properties
|
|
7
|
+
|
|
8
|
+
|Name | Type | Description | Notes|
|
|
9
|
+
|------------ | ------------- | ------------- | -------------|
|
|
10
|
+
| **id** | **String** | The globally unique identifier for the object. | [optional] |
|
|
11
|
+
| **name** | **String** | | [optional] |
|
|
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
|
+
| **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
|
+
| **version** | **Integer** | Required for updates, must match the version number of the most recent update | [optional] |
|
|
15
|
+
| **max_calls_per_agent** | **Integer** | The maximum number of calls that can be placed per agent on any campaign | [optional] |
|
|
16
|
+
| **max_line_utilization** | **Float** | The maximum percentage of lines that should be used for Outbound, expressed as a decimal in the range [0.0, 1.0] | [optional] |
|
|
17
|
+
| **self_uri** | **String** | The URI for this object | [optional] |
|
|
18
|
+
{: class="table table-striped"}
|
|
19
|
+
|
|
20
|
+
|
data/docs/Phone.md
CHANGED
|
@@ -9,15 +9,15 @@ title: Phone
|
|
|
9
9
|
|------------ | ------------- | ------------- | -------------|
|
|
10
10
|
| **id** | **String** | The globally unique identifier for the object. | [optional] |
|
|
11
11
|
| **name** | **String** | The name of the entity. | |
|
|
12
|
-
| **description** | **String** |
|
|
13
|
-
| **version** | **Integer** |
|
|
14
|
-
| **date_created** | **DateTime** | Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss.SSSZ | [optional] |
|
|
15
|
-
| **date_modified** | **DateTime** | Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss.SSSZ | [optional] |
|
|
16
|
-
| **modified_by** | **String** |
|
|
17
|
-
| **created_by** | **String** |
|
|
18
|
-
| **state** | **String** |
|
|
19
|
-
| **modified_by_app** | **String** |
|
|
20
|
-
| **created_by_app** | **String** |
|
|
12
|
+
| **description** | **String** | The resource's description. | [optional] |
|
|
13
|
+
| **version** | **Integer** | The current version of the resource. | [optional] |
|
|
14
|
+
| **date_created** | **DateTime** | The date the resource was created. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss.SSSZ | [optional] |
|
|
15
|
+
| **date_modified** | **DateTime** | The date of the last modification to the resource. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss.SSSZ | [optional] |
|
|
16
|
+
| **modified_by** | **String** | The ID of the user that last modified the resource. | [optional] |
|
|
17
|
+
| **created_by** | **String** | The ID of the user that created the resource. | [optional] |
|
|
18
|
+
| **state** | **String** | Indicates if the resource is active, inactive, or deleted. | [optional] |
|
|
19
|
+
| **modified_by_app** | **String** | The application that last modified the resource. | [optional] |
|
|
20
|
+
| **created_by_app** | **String** | The application that created the resource. | [optional] |
|
|
21
21
|
| **site** | [**UriReference**](UriReference.html) | The site associated to the phone. | |
|
|
22
22
|
| **phone_base_settings** | [**UriReference**](UriReference.html) | Phone Base Settings | |
|
|
23
23
|
| **line_base_settings** | [**UriReference**](UriReference.html) | | [optional] |
|
data/docs/PhoneBase.md
CHANGED
|
@@ -9,15 +9,15 @@ title: PhoneBase
|
|
|
9
9
|
|------------ | ------------- | ------------- | -------------|
|
|
10
10
|
| **id** | **String** | The globally unique identifier for the object. | [optional] |
|
|
11
11
|
| **name** | **String** | The name of the entity. | |
|
|
12
|
-
| **description** | **String** |
|
|
13
|
-
| **version** | **Integer** |
|
|
14
|
-
| **date_created** | **DateTime** | Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss.SSSZ | [optional] |
|
|
15
|
-
| **date_modified** | **DateTime** | Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss.SSSZ | [optional] |
|
|
16
|
-
| **modified_by** | **String** |
|
|
17
|
-
| **created_by** | **String** |
|
|
18
|
-
| **state** | **String** |
|
|
19
|
-
| **modified_by_app** | **String** |
|
|
20
|
-
| **created_by_app** | **String** |
|
|
12
|
+
| **description** | **String** | The resource's description. | [optional] |
|
|
13
|
+
| **version** | **Integer** | The current version of the resource. | [optional] |
|
|
14
|
+
| **date_created** | **DateTime** | The date the resource was created. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss.SSSZ | [optional] |
|
|
15
|
+
| **date_modified** | **DateTime** | The date of the last modification to the resource. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss.SSSZ | [optional] |
|
|
16
|
+
| **modified_by** | **String** | The ID of the user that last modified the resource. | [optional] |
|
|
17
|
+
| **created_by** | **String** | The ID of the user that created the resource. | [optional] |
|
|
18
|
+
| **state** | **String** | Indicates if the resource is active, inactive, or deleted. | [optional] |
|
|
19
|
+
| **modified_by_app** | **String** | The application that last modified the resource. | [optional] |
|
|
20
|
+
| **created_by_app** | **String** | The application that created the resource. | [optional] |
|
|
21
21
|
| **phone_meta_base** | [**UriReference**](UriReference.html) | A phone metabase is essentially a database for storing phone configuration settings, which simplifies the configuration process. | |
|
|
22
22
|
| **lines** | [**Array<LineBase>**](LineBase.html) | The list of linebases associated with the phone base. | |
|
|
23
23
|
| **properties** | **Hash<String, Object>** | | [optional] |
|
data/docs/Queue.md
CHANGED
|
@@ -9,15 +9,15 @@ title: Queue
|
|
|
9
9
|
|------------ | ------------- | ------------- | -------------|
|
|
10
10
|
| **id** | **String** | The globally unique identifier for the object. | [optional] |
|
|
11
11
|
| **name** | **String** | | [optional] |
|
|
12
|
-
| **description** | **String** |
|
|
13
|
-
| **version** | **Integer** |
|
|
14
|
-
| **date_created** | **DateTime** | Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss.SSSZ | [optional] |
|
|
15
|
-
| **date_modified** | **DateTime** | Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss.SSSZ | [optional] |
|
|
16
|
-
| **modified_by** | **String** |
|
|
17
|
-
| **created_by** | **String** |
|
|
18
|
-
| **state** | **String** |
|
|
19
|
-
| **modified_by_app** | **String** |
|
|
20
|
-
| **created_by_app** | **String** |
|
|
12
|
+
| **description** | **String** | The resource's description. | [optional] |
|
|
13
|
+
| **version** | **Integer** | The current version of the resource. | [optional] |
|
|
14
|
+
| **date_created** | **DateTime** | The date the resource was created. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss.SSSZ | [optional] |
|
|
15
|
+
| **date_modified** | **DateTime** | The date of the last modification to the resource. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss.SSSZ | [optional] |
|
|
16
|
+
| **modified_by** | **String** | The ID of the user that last modified the resource. | [optional] |
|
|
17
|
+
| **created_by** | **String** | The ID of the user that created the resource. | [optional] |
|
|
18
|
+
| **state** | **String** | Indicates if the resource is active, inactive, or deleted. | [optional] |
|
|
19
|
+
| **modified_by_app** | **String** | The application that last modified the resource. | [optional] |
|
|
20
|
+
| **created_by_app** | **String** | The application that created the resource. | [optional] |
|
|
21
21
|
| **media_settings** | [**Hash<String, MediaSetting>**](MediaSetting.html) | The media settings for the queue. Valid Key Values: CALL, CALLBACK, CHAT, EMAIL, SOCIAL_EXPRESSION | |
|
|
22
22
|
| **bullseye** | [**Bullseye**](Bullseye.html) | The bulls-eye settings for the queue. | [optional] |
|
|
23
23
|
| **acw_settings** | [**AcwSettings**](AcwSettings.html) | The ACW settings for the queue. | |
|
data/docs/Schedule.md
CHANGED
|
@@ -8,16 +8,16 @@ title: Schedule
|
|
|
8
8
|
|Name | Type | Description | Notes|
|
|
9
9
|
|------------ | ------------- | ------------- | -------------|
|
|
10
10
|
| **id** | **String** | The globally unique identifier for the object. | [optional] |
|
|
11
|
-
| **name** | **String** |
|
|
12
|
-
| **description** | **String** |
|
|
13
|
-
| **version** | **Integer** |
|
|
14
|
-
| **date_created** | **DateTime** | Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss.SSSZ | [optional] |
|
|
15
|
-
| **date_modified** | **DateTime** | Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss.SSSZ | [optional] |
|
|
16
|
-
| **modified_by** | **String** |
|
|
17
|
-
| **created_by** | **String** |
|
|
18
|
-
| **state** | **String** |
|
|
19
|
-
| **modified_by_app** | **String** |
|
|
20
|
-
| **created_by_app** | **String** |
|
|
11
|
+
| **name** | **String** | The name of the entity. | |
|
|
12
|
+
| **description** | **String** | The resource's description. | [optional] |
|
|
13
|
+
| **version** | **Integer** | The current version of the resource. | [optional] |
|
|
14
|
+
| **date_created** | **DateTime** | The date the resource was created. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss.SSSZ | [optional] |
|
|
15
|
+
| **date_modified** | **DateTime** | The date of the last modification to the resource. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss.SSSZ | [optional] |
|
|
16
|
+
| **modified_by** | **String** | The ID of the user that last modified the resource. | [optional] |
|
|
17
|
+
| **created_by** | **String** | The ID of the user that created the resource. | [optional] |
|
|
18
|
+
| **state** | **String** | Indicates if the resource is active, inactive, or deleted. | [optional] |
|
|
19
|
+
| **modified_by_app** | **String** | The application that last modified the resource. | [optional] |
|
|
20
|
+
| **created_by_app** | **String** | The application that created the resource. | [optional] |
|
|
21
21
|
| **start** | [**LocalDateTime**](LocalDateTime.html) | Date time is represented as an ISO-8601 string without a timezone. For example: yyyy-MM-ddTHH:mm:ss.SSS | [optional] |
|
|
22
22
|
| **_end** | [**LocalDateTime**](LocalDateTime.html) | Date time is represented as an ISO-8601 string without a timezone. For example: yyyy-MM-ddTHH:mm:ss.SSS | [optional] |
|
|
23
23
|
| **rrule** | **String** | An iCal Recurrence Rule (RRULE) string. | |
|
data/docs/ScheduleGroup.md
CHANGED
|
@@ -8,16 +8,16 @@ title: ScheduleGroup
|
|
|
8
8
|
|Name | Type | Description | Notes|
|
|
9
9
|
|------------ | ------------- | ------------- | -------------|
|
|
10
10
|
| **id** | **String** | The globally unique identifier for the object. | [optional] |
|
|
11
|
-
| **name** | **String** |
|
|
12
|
-
| **description** | **String** |
|
|
13
|
-
| **version** | **Integer** |
|
|
14
|
-
| **date_created** | **DateTime** | Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss.SSSZ | [optional] |
|
|
15
|
-
| **date_modified** | **DateTime** | Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss.SSSZ | [optional] |
|
|
16
|
-
| **modified_by** | **String** |
|
|
17
|
-
| **created_by** | **String** |
|
|
18
|
-
| **state** | **String** |
|
|
19
|
-
| **modified_by_app** | **String** |
|
|
20
|
-
| **created_by_app** | **String** |
|
|
11
|
+
| **name** | **String** | The name of the entity. | |
|
|
12
|
+
| **description** | **String** | The resource's description. | [optional] |
|
|
13
|
+
| **version** | **Integer** | The current version of the resource. | [optional] |
|
|
14
|
+
| **date_created** | **DateTime** | The date the resource was created. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss.SSSZ | [optional] |
|
|
15
|
+
| **date_modified** | **DateTime** | The date of the last modification to the resource. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss.SSSZ | [optional] |
|
|
16
|
+
| **modified_by** | **String** | The ID of the user that last modified the resource. | [optional] |
|
|
17
|
+
| **created_by** | **String** | The ID of the user that created the resource. | [optional] |
|
|
18
|
+
| **state** | **String** | Indicates if the resource is active, inactive, or deleted. | [optional] |
|
|
19
|
+
| **modified_by_app** | **String** | The application that last modified the resource. | [optional] |
|
|
20
|
+
| **created_by_app** | **String** | The application that created the resource. | [optional] |
|
|
21
21
|
| **time_zone** | **String** | The timezone the schedules are a part of. This is not a schedule property to allow a schedule to be used in multiple timezones. | [optional] |
|
|
22
22
|
| **open_schedules** | [**Array<UriReference>**](UriReference.html) | The schedules defining the hours an organization is open. | [optional] |
|
|
23
23
|
| **closed_schedules** | [**Array<UriReference>**](UriReference.html) | The schedules defining the hours an organization is closed. | [optional] |
|
data/docs/SchemaCategory.md
CHANGED
|
@@ -9,15 +9,15 @@ title: SchemaCategory
|
|
|
9
9
|
|------------ | ------------- | ------------- | -------------|
|
|
10
10
|
| **id** | **String** | The globally unique identifier for the object. | [optional] |
|
|
11
11
|
| **name** | **String** | The name of the entity. | |
|
|
12
|
-
| **description** | **String** |
|
|
13
|
-
| **version** | **Integer** |
|
|
14
|
-
| **date_created** | **DateTime** | Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss.SSSZ | [optional] |
|
|
15
|
-
| **date_modified** | **DateTime** | Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss.SSSZ | [optional] |
|
|
16
|
-
| **modified_by** | **String** |
|
|
17
|
-
| **created_by** | **String** |
|
|
18
|
-
| **state** | **String** |
|
|
19
|
-
| **modified_by_app** | **String** |
|
|
20
|
-
| **created_by_app** | **String** |
|
|
12
|
+
| **description** | **String** | The resource's description. | [optional] |
|
|
13
|
+
| **version** | **Integer** | The current version of the resource. | [optional] |
|
|
14
|
+
| **date_created** | **DateTime** | The date the resource was created. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss.SSSZ | [optional] |
|
|
15
|
+
| **date_modified** | **DateTime** | The date of the last modification to the resource. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss.SSSZ | [optional] |
|
|
16
|
+
| **modified_by** | **String** | The ID of the user that last modified the resource. | [optional] |
|
|
17
|
+
| **created_by** | **String** | The ID of the user that created the resource. | [optional] |
|
|
18
|
+
| **state** | **String** | Indicates if the resource is active, inactive, or deleted. | [optional] |
|
|
19
|
+
| **modified_by_app** | **String** | The application that last modified the resource. | [optional] |
|
|
20
|
+
| **created_by_app** | **String** | The application that created the resource. | [optional] |
|
|
21
21
|
| **self_uri** | **String** | The URI for this object | [optional] |
|
|
22
22
|
{: class="table table-striped"}
|
|
23
23
|
|
data/docs/Site.md
CHANGED
|
@@ -9,15 +9,15 @@ title: Site
|
|
|
9
9
|
|------------ | ------------- | ------------- | -------------|
|
|
10
10
|
| **id** | **String** | The globally unique identifier for the object. | [optional] |
|
|
11
11
|
| **name** | **String** | The name of the entity. | |
|
|
12
|
-
| **description** | **String** |
|
|
13
|
-
| **version** | **Integer** |
|
|
14
|
-
| **date_created** | **DateTime** | Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss.SSSZ | [optional] |
|
|
15
|
-
| **date_modified** | **DateTime** | Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss.SSSZ | [optional] |
|
|
16
|
-
| **modified_by** | **String** |
|
|
17
|
-
| **created_by** | **String** |
|
|
18
|
-
| **state** | **String** |
|
|
19
|
-
| **modified_by_app** | **String** |
|
|
20
|
-
| **created_by_app** | **String** |
|
|
12
|
+
| **description** | **String** | The resource's description. | [optional] |
|
|
13
|
+
| **version** | **Integer** | The current version of the resource. | [optional] |
|
|
14
|
+
| **date_created** | **DateTime** | The date the resource was created. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss.SSSZ | [optional] |
|
|
15
|
+
| **date_modified** | **DateTime** | The date of the last modification to the resource. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss.SSSZ | [optional] |
|
|
16
|
+
| **modified_by** | **String** | The ID of the user that last modified the resource. | [optional] |
|
|
17
|
+
| **created_by** | **String** | The ID of the user that created the resource. | [optional] |
|
|
18
|
+
| **state** | **String** | Indicates if the resource is active, inactive, or deleted. | [optional] |
|
|
19
|
+
| **modified_by_app** | **String** | The application that last modified the resource. | [optional] |
|
|
20
|
+
| **created_by_app** | **String** | The application that created the resource. | [optional] |
|
|
21
21
|
| **primary_sites** | [**Array<UriReference>**](UriReference.html) | | [optional] |
|
|
22
22
|
| **secondary_sites** | [**Array<UriReference>**](UriReference.html) | | [optional] |
|
|
23
23
|
| **primary_edges** | [**Array<Edge>**](Edge.html) | | [optional] |
|
data/docs/Trunk.md
CHANGED
|
@@ -9,15 +9,15 @@ title: Trunk
|
|
|
9
9
|
|------------ | ------------- | ------------- | -------------|
|
|
10
10
|
| **id** | **String** | The globally unique identifier for the object. | [optional] |
|
|
11
11
|
| **name** | **String** | The name of the entity. | |
|
|
12
|
-
| **description** | **String** |
|
|
13
|
-
| **version** | **Integer** |
|
|
14
|
-
| **date_created** | **DateTime** | Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss.SSSZ | [optional] |
|
|
15
|
-
| **date_modified** | **DateTime** | Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss.SSSZ | [optional] |
|
|
16
|
-
| **modified_by** | **String** |
|
|
17
|
-
| **created_by** | **String** |
|
|
18
|
-
| **state** | **String** |
|
|
19
|
-
| **modified_by_app** | **String** |
|
|
20
|
-
| **created_by_app** | **String** |
|
|
12
|
+
| **description** | **String** | The resource's description. | [optional] |
|
|
13
|
+
| **version** | **Integer** | The current version of the resource. | [optional] |
|
|
14
|
+
| **date_created** | **DateTime** | The date the resource was created. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss.SSSZ | [optional] |
|
|
15
|
+
| **date_modified** | **DateTime** | The date of the last modification to the resource. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss.SSSZ | [optional] |
|
|
16
|
+
| **modified_by** | **String** | The ID of the user that last modified the resource. | [optional] |
|
|
17
|
+
| **created_by** | **String** | The ID of the user that created the resource. | [optional] |
|
|
18
|
+
| **state** | **String** | Indicates if the resource is active, inactive, or deleted. | [optional] |
|
|
19
|
+
| **modified_by_app** | **String** | The application that last modified the resource. | [optional] |
|
|
20
|
+
| **created_by_app** | **String** | The application that created the resource. | [optional] |
|
|
21
21
|
| **trunk_type** | **String** | The type of this trunk. | [optional] |
|
|
22
22
|
| **edge** | [**UriReference**](UriReference.html) | The Edge using this trunk. | [optional] |
|
|
23
23
|
| **trunk_base** | [**UriReference**](UriReference.html) | The trunk base configuration used on this trunk. | [optional] |
|
data/docs/TrunkBase.md
CHANGED
|
@@ -9,15 +9,15 @@ title: TrunkBase
|
|
|
9
9
|
|------------ | ------------- | ------------- | -------------|
|
|
10
10
|
| **id** | **String** | The globally unique identifier for the object. | [optional] |
|
|
11
11
|
| **name** | **String** | The name of the entity. | |
|
|
12
|
-
| **description** | **String** |
|
|
13
|
-
| **version** | **Integer** |
|
|
14
|
-
| **date_created** | **DateTime** | Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss.SSSZ | [optional] |
|
|
15
|
-
| **date_modified** | **DateTime** | Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss.SSSZ | [optional] |
|
|
16
|
-
| **modified_by** | **String** |
|
|
17
|
-
| **created_by** | **String** |
|
|
18
|
-
| **state** | **String** |
|
|
19
|
-
| **modified_by_app** | **String** |
|
|
20
|
-
| **created_by_app** | **String** |
|
|
12
|
+
| **description** | **String** | The resource's description. | [optional] |
|
|
13
|
+
| **version** | **Integer** | The current version of the resource. | [optional] |
|
|
14
|
+
| **date_created** | **DateTime** | The date the resource was created. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss.SSSZ | [optional] |
|
|
15
|
+
| **date_modified** | **DateTime** | The date of the last modification to the resource. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss.SSSZ | [optional] |
|
|
16
|
+
| **modified_by** | **String** | The ID of the user that last modified the resource. | [optional] |
|
|
17
|
+
| **created_by** | **String** | The ID of the user that created the resource. | [optional] |
|
|
18
|
+
| **state** | **String** | Indicates if the resource is active, inactive, or deleted. | [optional] |
|
|
19
|
+
| **modified_by_app** | **String** | The application that last modified the resource. | [optional] |
|
|
20
|
+
| **created_by_app** | **String** | The application that created the resource. | [optional] |
|
|
21
21
|
| **trunk_metabase** | [**UriReference**](UriReference.html) | The meta-base this trunk is based on. | |
|
|
22
22
|
| **properties** | **Hash<String, Object>** | | [optional] |
|
|
23
23
|
| **trunk_type** | **String** | The type of this trunk base. | |
|
data/docs/UserDevice.md
ADDED
|
@@ -0,0 +1,22 @@
|
|
|
1
|
+
---
|
|
2
|
+
title: UserDevice
|
|
3
|
+
---
|
|
4
|
+
## PureCloud::UserDevice
|
|
5
|
+
|
|
6
|
+
## Properties
|
|
7
|
+
|
|
8
|
+
|Name | Type | Description | Notes|
|
|
9
|
+
|------------ | ------------- | ------------- | -------------|
|
|
10
|
+
| **id** | **String** | The globally unique identifier for the object. | [optional] |
|
|
11
|
+
| **name** | **String** | | [optional] |
|
|
12
|
+
| **device_token** | **String** | device token sent by mobile clients. | |
|
|
13
|
+
| **notification_id** | **String** | notification id of the device. | |
|
|
14
|
+
| **make** | **String** | make of the device. | |
|
|
15
|
+
| **model** | **String** | Device model | |
|
|
16
|
+
| **accept_notifications** | **BOOLEAN** | if the device accepts notifications | |
|
|
17
|
+
| **type** | **String** | type of the device; ios or android | |
|
|
18
|
+
| **session_hash** | **String** | | [optional] |
|
|
19
|
+
| **self_uri** | **String** | The URI for this object | [optional] |
|
|
20
|
+
{: class="table table-striped"}
|
|
21
|
+
|
|
22
|
+
|
data/docs/UserQueue.md
CHANGED
|
@@ -9,15 +9,15 @@ title: UserQueue
|
|
|
9
9
|
|------------ | ------------- | ------------- | -------------|
|
|
10
10
|
| **id** | **String** | The globally unique identifier for the object. | [optional] |
|
|
11
11
|
| **name** | **String** | | [optional] |
|
|
12
|
-
| **description** | **String** |
|
|
13
|
-
| **version** | **Integer** |
|
|
14
|
-
| **date_created** | **DateTime** | Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss.SSSZ | [optional] |
|
|
15
|
-
| **date_modified** | **DateTime** | Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss.SSSZ | [optional] |
|
|
16
|
-
| **modified_by** | **String** |
|
|
17
|
-
| **created_by** | **String** |
|
|
18
|
-
| **state** | **String** |
|
|
19
|
-
| **modified_by_app** | **String** |
|
|
20
|
-
| **created_by_app** | **String** |
|
|
12
|
+
| **description** | **String** | The resource's description. | [optional] |
|
|
13
|
+
| **version** | **Integer** | The current version of the resource. | [optional] |
|
|
14
|
+
| **date_created** | **DateTime** | The date the resource was created. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss.SSSZ | [optional] |
|
|
15
|
+
| **date_modified** | **DateTime** | The date of the last modification to the resource. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss.SSSZ | [optional] |
|
|
16
|
+
| **modified_by** | **String** | The ID of the user that last modified the resource. | [optional] |
|
|
17
|
+
| **created_by** | **String** | The ID of the user that created the resource. | [optional] |
|
|
18
|
+
| **state** | **String** | Indicates if the resource is active, inactive, or deleted. | [optional] |
|
|
19
|
+
| **modified_by_app** | **String** | The application that last modified the resource. | [optional] |
|
|
20
|
+
| **created_by_app** | **String** | The application that created the resource. | [optional] |
|
|
21
21
|
| **media_settings** | [**Hash<String, MediaSetting>**](MediaSetting.html) | The media settings for the queue. Valid Key Values: CALL, CALLBACK, CHAT, EMAIL, SOCIAL_EXPRESSION | |
|
|
22
22
|
| **bullseye** | [**Bullseye**](Bullseye.html) | The bulls-eye settings for the queue. | [optional] |
|
|
23
23
|
| **acw_settings** | [**AcwSettings**](AcwSettings.html) | The ACW settings for the queue. | |
|
data/docs/UsersApi.md
CHANGED
|
@@ -1334,7 +1334,7 @@ Name | Type | Description | Notes
|
|
|
1334
1334
|
**id** | [**Array<String>**](String.html)| id | [optional] |
|
|
1335
1335
|
**sort_order** | **String**| Ascending or descending sort order | [optional] [default to ASC]<br />**Values**: ascending, descending |
|
|
1336
1336
|
**expand** | [**Array<String>**](String.html)| Which fields, if any, to expand | [optional] <br />**Values**: routingStatus, presence, conversationSummary, outOfOffice, geolocation, station, authorization, profileSkills, locations, groups |
|
|
1337
|
-
**state** | **String**| Only list users of this state | [optional] [default to active]<br />**Values**: active, deleted |
|
|
1337
|
+
**state** | **String**| Only list users of this state | [optional] [default to active]<br />**Values**: active, inactive, deleted |
|
|
1338
1338
|
{: class="table table-striped"}
|
|
1339
1339
|
|
|
1340
1340
|
|
|
@@ -92,6 +92,9 @@ require 'purecloudplatformclientv2/models/available_language_list'
|
|
|
92
92
|
require 'purecloudplatformclientv2/models/available_topic'
|
|
93
93
|
require 'purecloudplatformclientv2/models/available_topic_entity_listing'
|
|
94
94
|
require 'purecloudplatformclientv2/models/available_translations'
|
|
95
|
+
require 'purecloudplatformclientv2/models/billing_usage'
|
|
96
|
+
require 'purecloudplatformclientv2/models/billing_usage_report'
|
|
97
|
+
require 'purecloudplatformclientv2/models/billing_usage_resource'
|
|
95
98
|
require 'purecloudplatformclientv2/models/bullseye'
|
|
96
99
|
require 'purecloudplatformclientv2/models/calibration'
|
|
97
100
|
require 'purecloudplatformclientv2/models/calibration_assignment'
|
|
@@ -341,6 +344,7 @@ require 'purecloudplatformclientv2/models/dialer_event_entity_listing'
|
|
|
341
344
|
require 'purecloudplatformclientv2/models/dialer_preview'
|
|
342
345
|
require 'purecloudplatformclientv2/models/dialer_rule'
|
|
343
346
|
require 'purecloudplatformclientv2/models/digit_length'
|
|
347
|
+
require 'purecloudplatformclientv2/models/directory_user_devices_listing'
|
|
344
348
|
require 'purecloudplatformclientv2/models/disconnect_reason'
|
|
345
349
|
require 'purecloudplatformclientv2/models/dnc_list'
|
|
346
350
|
require 'purecloudplatformclientv2/models/dnc_list_create'
|
|
@@ -658,6 +662,7 @@ require 'purecloudplatformclientv2/models/outbound_route'
|
|
|
658
662
|
require 'purecloudplatformclientv2/models/outbound_route_base'
|
|
659
663
|
require 'purecloudplatformclientv2/models/outbound_route_base_entity_listing'
|
|
660
664
|
require 'purecloudplatformclientv2/models/outbound_route_entity_listing'
|
|
665
|
+
require 'purecloudplatformclientv2/models/outbound_settings'
|
|
661
666
|
require 'purecloudplatformclientv2/models/pin_configuration'
|
|
662
667
|
require 'purecloudplatformclientv2/models/page'
|
|
663
668
|
require 'purecloudplatformclientv2/models/paging_spec'
|
|
@@ -930,6 +935,7 @@ require 'purecloudplatformclientv2/models/user_conversation_summary_notification
|
|
|
930
935
|
require 'purecloudplatformclientv2/models/user_conversation_summary_notification_media_summary'
|
|
931
936
|
require 'purecloudplatformclientv2/models/user_conversation_summary_notification_media_summary_detail'
|
|
932
937
|
require 'purecloudplatformclientv2/models/user_details_query'
|
|
938
|
+
require 'purecloudplatformclientv2/models/user_device'
|
|
933
939
|
require 'purecloudplatformclientv2/models/user_entity_listing'
|
|
934
940
|
require 'purecloudplatformclientv2/models/user_image'
|
|
935
941
|
require 'purecloudplatformclientv2/models/user_list_schedule_request_body'
|
|
@@ -1019,6 +1025,7 @@ require 'purecloudplatformclientv2/api/analytics_api'
|
|
|
1019
1025
|
require 'purecloudplatformclientv2/api/architect_api'
|
|
1020
1026
|
require 'purecloudplatformclientv2/api/attributes_api'
|
|
1021
1027
|
require 'purecloudplatformclientv2/api/authorization_api'
|
|
1028
|
+
require 'purecloudplatformclientv2/api/billing_api'
|
|
1022
1029
|
require 'purecloudplatformclientv2/api/content_management_api'
|
|
1023
1030
|
require 'purecloudplatformclientv2/api/conversations_api'
|
|
1024
1031
|
require 'purecloudplatformclientv2/api/external_contacts_api'
|
|
@@ -1031,6 +1038,7 @@ require 'purecloudplatformclientv2/api/integrations_api'
|
|
|
1031
1038
|
require 'purecloudplatformclientv2/api/languages_api'
|
|
1032
1039
|
require 'purecloudplatformclientv2/api/license_api'
|
|
1033
1040
|
require 'purecloudplatformclientv2/api/locations_api'
|
|
1041
|
+
require 'purecloudplatformclientv2/api/mobile_devices_api'
|
|
1034
1042
|
require 'purecloudplatformclientv2/api/notifications_api'
|
|
1035
1043
|
require 'purecloudplatformclientv2/api/o_auth_api'
|
|
1036
1044
|
require 'purecloudplatformclientv2/api/organization_api'
|
|
@@ -0,0 +1,104 @@
|
|
|
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: ININ
|
|
11
|
+
http://www.inin.com
|
|
12
|
+
|
|
13
|
+
Terms of Service: https://developer.mypurecloud.com/tos
|
|
14
|
+
|
|
15
|
+
=end
|
|
16
|
+
|
|
17
|
+
require "uri"
|
|
18
|
+
|
|
19
|
+
module PureCloud
|
|
20
|
+
class BillingApi
|
|
21
|
+
attr_accessor :api_client
|
|
22
|
+
|
|
23
|
+
def initialize(api_client = ApiClient.default)
|
|
24
|
+
@api_client = api_client
|
|
25
|
+
end
|
|
26
|
+
|
|
27
|
+
# Get a report of the billable usages (e.g. licenses and devices utilized) for a given period.
|
|
28
|
+
#
|
|
29
|
+
# @param start_date The period start date. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss.SSSZ
|
|
30
|
+
# @param end_date The period end date. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss.SSSZ
|
|
31
|
+
# @param [Hash] opts the optional parameters
|
|
32
|
+
# @return [BillingUsageReport]
|
|
33
|
+
def get_billing_reports_billableusage(start_date, end_date, opts = {})
|
|
34
|
+
data, _status_code, _headers = get_billing_reports_billableusage_with_http_info(start_date, end_date, opts)
|
|
35
|
+
return data
|
|
36
|
+
end
|
|
37
|
+
|
|
38
|
+
# Get a report of the billable usages (e.g. licenses and devices utilized) for a given period.
|
|
39
|
+
#
|
|
40
|
+
# @param start_date The period start date. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss.SSSZ
|
|
41
|
+
# @param end_date The period end date. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss.SSSZ
|
|
42
|
+
# @param [Hash] opts the optional parameters
|
|
43
|
+
# @return [Array<(BillingUsageReport, Fixnum, Hash)>] BillingUsageReport data, response status code and response headers
|
|
44
|
+
def get_billing_reports_billableusage_with_http_info(start_date, end_date, opts = {})
|
|
45
|
+
if @api_client.config.debugging
|
|
46
|
+
@api_client.config.logger.debug "Calling API: BillingApi.get_billing_reports_billableusage ..."
|
|
47
|
+
end
|
|
48
|
+
|
|
49
|
+
|
|
50
|
+
# verify the required parameter 'start_date' is set
|
|
51
|
+
fail ArgumentError, "Missing the required parameter 'start_date' when calling BillingApi.get_billing_reports_billableusage" if start_date.nil?
|
|
52
|
+
|
|
53
|
+
|
|
54
|
+
|
|
55
|
+
|
|
56
|
+
|
|
57
|
+
|
|
58
|
+
# verify the required parameter 'end_date' is set
|
|
59
|
+
fail ArgumentError, "Missing the required parameter 'end_date' when calling BillingApi.get_billing_reports_billableusage" if end_date.nil?
|
|
60
|
+
|
|
61
|
+
|
|
62
|
+
|
|
63
|
+
|
|
64
|
+
|
|
65
|
+
# resource path
|
|
66
|
+
local_var_path = "/api/v2/billing/reports/billableusage".sub('{format}','json')
|
|
67
|
+
|
|
68
|
+
# query parameters
|
|
69
|
+
query_params = {}
|
|
70
|
+
query_params[:'startDate'] = start_date
|
|
71
|
+
query_params[:'endDate'] = end_date
|
|
72
|
+
|
|
73
|
+
# header parameters
|
|
74
|
+
header_params = {}
|
|
75
|
+
|
|
76
|
+
# HTTP header 'Accept' (if needed)
|
|
77
|
+
local_header_accept = ['application/json']
|
|
78
|
+
local_header_accept_result = @api_client.select_header_accept(local_header_accept) and header_params['Accept'] = local_header_accept_result
|
|
79
|
+
|
|
80
|
+
# HTTP header 'Content-Type'
|
|
81
|
+
local_header_content_type = ['application/json']
|
|
82
|
+
header_params['Content-Type'] = @api_client.select_header_content_type(local_header_content_type)
|
|
83
|
+
|
|
84
|
+
# form parameters
|
|
85
|
+
form_params = {}
|
|
86
|
+
|
|
87
|
+
# http body (model)
|
|
88
|
+
post_body = nil
|
|
89
|
+
|
|
90
|
+
auth_names = ['PureCloud Auth']
|
|
91
|
+
data, status_code, headers = @api_client.call_api(:GET, local_var_path,
|
|
92
|
+
:header_params => header_params,
|
|
93
|
+
:query_params => query_params,
|
|
94
|
+
:form_params => form_params,
|
|
95
|
+
:body => post_body,
|
|
96
|
+
:auth_names => auth_names,
|
|
97
|
+
:return_type => 'BillingUsageReport')
|
|
98
|
+
if @api_client.config.debugging
|
|
99
|
+
@api_client.config.logger.debug "API called: BillingApi#get_billing_reports_billableusage\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
|
100
|
+
end
|
|
101
|
+
return data, status_code, headers
|
|
102
|
+
end
|
|
103
|
+
end
|
|
104
|
+
end
|