Skip to content

Commit

Permalink
doc publish
Browse files Browse the repository at this point in the history
  • Loading branch information
PureCloud Jenkins committed Jan 11, 2025
1 parent e53327b commit 31e984d
Show file tree
Hide file tree
Showing 48 changed files with 1,464 additions and 114 deletions.
2 changes: 1 addition & 1 deletion .lastupdated
Original file line number Diff line number Diff line change
@@ -1 +1 @@
2024-12-21T09:34:22
2025-01-11T08:28:51
2 changes: 1 addition & 1 deletion docs/gc_analytics_conversations.md
Original file line number Diff line number Diff line change
Expand Up @@ -32,7 +32,7 @@
* [gc analytics](gc_analytics.html) - /api/v2/analytics
* [gc analytics conversations activity](gc_analytics_conversations_activity.html) - /api/v2/analytics/conversations/activity
* [gc analytics conversations aggregates](gc_analytics_conversations_aggregates.html) - /api/v2/analytics/conversations/aggregates
* [gc analytics conversations details](gc_analytics_conversations_details.html) - /api/v2/analytics/conversations/details /api/v2/analytics/conversations/{conversationId}/details
* [gc analytics conversations details](gc_analytics_conversations_details.html) - /api/v2/analytics/conversations/{conversationId}/details /api/v2/analytics/conversations/details
* [gc analytics conversations transcripts](gc_analytics_conversations_transcripts.html) - /api/v2/analytics/conversations/transcripts


4 changes: 2 additions & 2 deletions docs/gc_analytics_conversations_details.md
Original file line number Diff line number Diff line change
@@ -1,10 +1,10 @@
## gc analytics conversations details

/api/v2/analytics/conversations/details /api/v2/analytics/conversations/{conversationId}/details
/api/v2/analytics/conversations/{conversationId}/details /api/v2/analytics/conversations/details

### Synopsis

/api/v2/analytics/conversations/details /api/v2/analytics/conversations/{conversationId}/details
/api/v2/analytics/conversations/{conversationId}/details /api/v2/analytics/conversations/details

### Options

Expand Down
2 changes: 1 addition & 1 deletion docs/gc_analytics_conversations_details_get.md
Original file line number Diff line number Diff line change
Expand Up @@ -33,6 +33,6 @@ gc analytics conversations details get [conversationId] [flags]

### SEE ALSO

* [gc analytics conversations details](gc_analytics_conversations_details.html) - /api/v2/analytics/conversations/details /api/v2/analytics/conversations/{conversationId}/details
* [gc analytics conversations details](gc_analytics_conversations_details.html) - /api/v2/analytics/conversations/{conversationId}/details /api/v2/analytics/conversations/details


2 changes: 1 addition & 1 deletion docs/gc_analytics_conversations_details_jobs.md
Original file line number Diff line number Diff line change
Expand Up @@ -29,7 +29,7 @@

### SEE ALSO

* [gc analytics conversations details](gc_analytics_conversations_details.html) - /api/v2/analytics/conversations/details /api/v2/analytics/conversations/{conversationId}/details
* [gc analytics conversations details](gc_analytics_conversations_details.html) - /api/v2/analytics/conversations/{conversationId}/details /api/v2/analytics/conversations/details
* [gc analytics conversations details jobs availability](gc_analytics_conversations_details_jobs_availability.html) - /api/v2/analytics/conversations/details/jobs/availability
* [gc analytics conversations details jobs create](gc_analytics_conversations_details_jobs_create.html) - Query for conversation details asynchronously
* [gc analytics conversations details jobs delete](gc_analytics_conversations_details_jobs_delete.html) - Delete/cancel an async details job
Expand Down
2 changes: 1 addition & 1 deletion docs/gc_analytics_conversations_details_list.md
Original file line number Diff line number Diff line change
Expand Up @@ -34,6 +34,6 @@ gc analytics conversations details list [flags]

### SEE ALSO

* [gc analytics conversations details](gc_analytics_conversations_details.html) - /api/v2/analytics/conversations/details /api/v2/analytics/conversations/{conversationId}/details
* [gc analytics conversations details](gc_analytics_conversations_details.html) - /api/v2/analytics/conversations/{conversationId}/details /api/v2/analytics/conversations/details


2 changes: 1 addition & 1 deletion docs/gc_analytics_conversations_details_properties.md
Original file line number Diff line number Diff line change
Expand Up @@ -29,7 +29,7 @@

### SEE ALSO

* [gc analytics conversations details](gc_analytics_conversations_details.html) - /api/v2/analytics/conversations/details /api/v2/analytics/conversations/{conversationId}/details
* [gc analytics conversations details](gc_analytics_conversations_details.html) - /api/v2/analytics/conversations/{conversationId}/details /api/v2/analytics/conversations/details
* [gc analytics conversations details properties create](gc_analytics_conversations_details_properties_create.html) - Index conversation properties


2 changes: 1 addition & 1 deletion docs/gc_analytics_conversations_details_query.md
Original file line number Diff line number Diff line change
Expand Up @@ -29,7 +29,7 @@

### SEE ALSO

* [gc analytics conversations details](gc_analytics_conversations_details.html) - /api/v2/analytics/conversations/details /api/v2/analytics/conversations/{conversationId}/details
* [gc analytics conversations details](gc_analytics_conversations_details.html) - /api/v2/analytics/conversations/{conversationId}/details /api/v2/analytics/conversations/details
* [gc analytics conversations details query create](gc_analytics_conversations_details_query_create.html) - Query for conversation details


1 change: 1 addition & 0 deletions docs/gc_analytics_resolutions_aggregates.md
Original file line number Diff line number Diff line change
Expand Up @@ -31,5 +31,6 @@

* [gc analytics resolutions](gc_analytics_resolutions.html) - /api/v2/analytics/resolutions
* [gc analytics resolutions aggregates jobs](gc_analytics_resolutions_aggregates_jobs.html) - /api/v2/analytics/resolutions/aggregates/jobs
* [gc analytics resolutions aggregates query](gc_analytics_resolutions_aggregates_query.html) - /api/v2/analytics/resolutions/aggregates/query


35 changes: 35 additions & 0 deletions docs/gc_analytics_resolutions_aggregates_query.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,35 @@
## gc analytics resolutions aggregates query

/api/v2/analytics/resolutions/aggregates/query

### Synopsis

/api/v2/analytics/resolutions/aggregates/query

### Options

```
-h, --help help for query
```

### Options inherited from parent commands

```
--accesstoken string accessToken override
--clientid string clientId override
--clientsecret string clientSecret override
--environment string environment override. E.g. mypurecloud.com.au or ap-southeast-2
-i, --indicateprogress Trace progress indicators to stderr
--inputformat string Data input format. Supported formats: YAML, JSON
--outputformat string Data output format. Supported formats: YAML, JSON
-p, --profile string Name of the profile to use for configuring the cli (default "DEFAULT")
--transform string Provide a Go template file for transforming output data
--transformstr string Provide a Go template string for transforming output data
```

### SEE ALSO

* [gc analytics resolutions aggregates](gc_analytics_resolutions_aggregates.html) - /api/v2/analytics/resolutions/aggregates
* [gc analytics resolutions aggregates query create](gc_analytics_resolutions_aggregates_query_create.html) - Query for resolution aggregates


41 changes: 41 additions & 0 deletions docs/gc_analytics_resolutions_aggregates_query_create.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,41 @@
## gc analytics resolutions aggregates query create

Query for resolution aggregates

### Synopsis

Query for resolution aggregates

```
gc analytics resolutions aggregates query create [flags]
```

### Options

```
-d, --directory string Directory path with files containing request bodies
-f, --file string File name containing the JSON body
-h, --help help for create
-b, --printrequestbody Print the request body format of the API.
```

### Options inherited from parent commands

```
--accesstoken string accessToken override
--clientid string clientId override
--clientsecret string clientSecret override
--environment string environment override. E.g. mypurecloud.com.au or ap-southeast-2
-i, --indicateprogress Trace progress indicators to stderr
--inputformat string Data input format. Supported formats: YAML, JSON
--outputformat string Data output format. Supported formats: YAML, JSON
-p, --profile string Name of the profile to use for configuring the cli (default "DEFAULT")
--transform string Provide a Go template file for transforming output data
--transformstr string Provide a Go template string for transforming output data
```

### SEE ALSO

* [gc analytics resolutions aggregates query](gc_analytics_resolutions_aggregates_query.html) - /api/v2/analytics/resolutions/aggregates/query


1 change: 1 addition & 0 deletions docs/gc_gamification_insights.md
Original file line number Diff line number Diff line change
Expand Up @@ -34,6 +34,7 @@
* [gc gamification insights groups](gc_gamification_insights_groups.html) - /api/v2/gamification/insights/groups
* [gc gamification insights list](gc_gamification_insights_list.html) - Get insights summary
* [gc gamification insights members](gc_gamification_insights_members.html) - /api/v2/gamification/insights/members
* [gc gamification insights rankings](gc_gamification_insights_rankings.html) - /api/v2/gamification/insights/rankings
* [gc gamification insights trends](gc_gamification_insights_trends.html) - /api/v2/gamification/insights/trends
* [gc gamification insights users](gc_gamification_insights_users.html) - /api/v2/gamification/insights/users

Expand Down
35 changes: 35 additions & 0 deletions docs/gc_gamification_insights_rankings.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,35 @@
## gc gamification insights rankings

/api/v2/gamification/insights/rankings

### Synopsis

/api/v2/gamification/insights/rankings

### Options

```
-h, --help help for rankings
```

### Options inherited from parent commands

```
--accesstoken string accessToken override
--clientid string clientId override
--clientsecret string clientSecret override
--environment string environment override. E.g. mypurecloud.com.au or ap-southeast-2
-i, --indicateprogress Trace progress indicators to stderr
--inputformat string Data input format. Supported formats: YAML, JSON
--outputformat string Data output format. Supported formats: YAML, JSON
-p, --profile string Name of the profile to use for configuring the cli (default "DEFAULT")
--transform string Provide a Go template file for transforming output data
--transformstr string Provide a Go template string for transforming output data
```

### SEE ALSO

* [gc gamification insights](gc_gamification_insights.html) - /api/v2/gamification/insights
* [gc gamification insights rankings get](gc_gamification_insights_rankings_get.html) - Get insights rankings


47 changes: 47 additions & 0 deletions docs/gc_gamification_insights_rankings_get.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,47 @@
## gc gamification insights rankings get

Get insights rankings

### Synopsis

Get insights rankings

```
gc gamification insights rankings get [flags]
```

### Options

```
--comparativePeriodStartWorkday string The start work day of comparative period. Dates are represented as an ISO-8601 string. For example: yyyy-MM-dd - REQUIRED
--filterId string ID for the filter type. - REQUIRED
--filterType string Filter type for the query request. - REQUIRED Valid values: PerformanceProfile, Division
--granularity string Granularity - REQUIRED Valid values: Weekly, Monthly
-h, --help help for get
--primaryPeriodStartWorkday string The start work day of primary period. Dates are represented as an ISO-8601 string. For example: yyyy-MM-dd - REQUIRED
--sectionSize string The number of top and bottom users to return before ties
--sortKey string Sort key - REQUIRED Valid values: percentOfGoal, percentOfGoalChange, overallPercentOfGoal, overallPercentOfGoalChange, value, valueChange
--sortMetricId string Sort Metric Id
--userIds string A list of up to 100 comma-separated user Ids
```

### Options inherited from parent commands

```
--accesstoken string accessToken override
--clientid string clientId override
--clientsecret string clientSecret override
--environment string environment override. E.g. mypurecloud.com.au or ap-southeast-2
-i, --indicateprogress Trace progress indicators to stderr
--inputformat string Data input format. Supported formats: YAML, JSON
--outputformat string Data output format. Supported formats: YAML, JSON
-p, --profile string Name of the profile to use for configuring the cli (default "DEFAULT")
--transform string Provide a Go template file for transforming output data
--transformstr string Provide a Go template string for transforming output data
```

### SEE ALSO

* [gc gamification insights rankings](gc_gamification_insights_rankings.html) - /api/v2/gamification/insights/rankings


2 changes: 1 addition & 1 deletion docs/gc_outbound_campaigns_all_divisionviews_list.md
Original file line number Diff line number Diff line change
Expand Up @@ -18,7 +18,7 @@ gc outbound campaigns all divisionviews list [flags]
--filtercondition string Filter list command output based on a given condition or regular expression
-h, --help help for list
--id strings Campaign ID(s)
--mediaType strings Media type(s) Valid values: email, sms, voice
--mediaType strings Media type(s) Valid values: email, sms, voice, whatsapp
--name string Campaign name(s)
--pageNumber string Page number (default "1")
--pageSize string Page size (default "25")
Expand Down
2 changes: 1 addition & 1 deletion docs/gc_outbound_campaigns_all_list.md
Original file line number Diff line number Diff line change
Expand Up @@ -18,7 +18,7 @@ gc outbound campaigns all list [flags]
--filtercondition string Filter list command output based on a given condition or regular expression
-h, --help help for list
--id strings Campaign ID(s)
--mediaType strings Media type(s) Valid values: email, sms, voice
--mediaType strings Media type(s) Valid values: email, sms, voice, whatsapp
--name string Campaign name(s)
--pageNumber string Page number (default "1")
--pageSize string Page size (default "25")
Expand Down
1 change: 1 addition & 0 deletions docs/gc_taskmanagement_workitems.md
Original file line number Diff line number Diff line change
Expand Up @@ -32,6 +32,7 @@
* [gc taskmanagement](gc_taskmanagement.html) - /api/v2/taskmanagement
* [gc taskmanagement workitems acd](gc_taskmanagement_workitems_acd.html) - /api/v2/taskmanagement/workitems/{workitemId}/acd
* [gc taskmanagement workitems assignment](gc_taskmanagement_workitems_assignment.html) - /api/v2/taskmanagement/workitems/{workitemId}/assignment
* [gc taskmanagement workitems bulk](gc_taskmanagement_workitems_bulk.html) - /api/v2/taskmanagement/workitems/bulk
* [gc taskmanagement workitems create](gc_taskmanagement_workitems_create.html) - Create a workitem
* [gc taskmanagement workitems delete](gc_taskmanagement_workitems_delete.html) - Delete a workitem
* [gc taskmanagement workitems disconnect](gc_taskmanagement_workitems_disconnect.html) - /api/v2/taskmanagement/workitems/{workitemId}/disconnect
Expand Down
37 changes: 37 additions & 0 deletions docs/gc_taskmanagement_workitems_bulk.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,37 @@
## gc taskmanagement workitems bulk

/api/v2/taskmanagement/workitems/bulk

### Synopsis

/api/v2/taskmanagement/workitems/bulk

### Options

```
-h, --help help for bulk
```

### Options inherited from parent commands

```
--accesstoken string accessToken override
--clientid string clientId override
--clientsecret string clientSecret override
--environment string environment override. E.g. mypurecloud.com.au or ap-southeast-2
-i, --indicateprogress Trace progress indicators to stderr
--inputformat string Data input format. Supported formats: YAML, JSON
--outputformat string Data output format. Supported formats: YAML, JSON
-p, --profile string Name of the profile to use for configuring the cli (default "DEFAULT")
--transform string Provide a Go template file for transforming output data
--transformstr string Provide a Go template string for transforming output data
```

### SEE ALSO

* [gc taskmanagement workitems](gc_taskmanagement_workitems.html) - /api/v2/taskmanagement/workitems
* [gc taskmanagement workitems bulk add](gc_taskmanagement_workitems_bulk_add.html) - /api/v2/taskmanagement/workitems/bulk/add
* [gc taskmanagement workitems bulk jobs](gc_taskmanagement_workitems_bulk_jobs.html) - /api/v2/taskmanagement/workitems/bulk/jobs
* [gc taskmanagement workitems bulk terminate](gc_taskmanagement_workitems_bulk_terminate.html) - /api/v2/taskmanagement/workitems/bulk/terminate


35 changes: 35 additions & 0 deletions docs/gc_taskmanagement_workitems_bulk_add.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,35 @@
## gc taskmanagement workitems bulk add

/api/v2/taskmanagement/workitems/bulk/add

### Synopsis

/api/v2/taskmanagement/workitems/bulk/add

### Options

```
-h, --help help for add
```

### Options inherited from parent commands

```
--accesstoken string accessToken override
--clientid string clientId override
--clientsecret string clientSecret override
--environment string environment override. E.g. mypurecloud.com.au or ap-southeast-2
-i, --indicateprogress Trace progress indicators to stderr
--inputformat string Data input format. Supported formats: YAML, JSON
--outputformat string Data output format. Supported formats: YAML, JSON
-p, --profile string Name of the profile to use for configuring the cli (default "DEFAULT")
--transform string Provide a Go template file for transforming output data
--transformstr string Provide a Go template string for transforming output data
```

### SEE ALSO

* [gc taskmanagement workitems bulk](gc_taskmanagement_workitems_bulk.html) - /api/v2/taskmanagement/workitems/bulk
* [gc taskmanagement workitems bulk add jobs](gc_taskmanagement_workitems_bulk_add_jobs.html) - /api/v2/taskmanagement/workitems/bulk/add/jobs


39 changes: 39 additions & 0 deletions docs/gc_taskmanagement_workitems_bulk_add_jobs.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,39 @@
## gc taskmanagement workitems bulk add jobs

/api/v2/taskmanagement/workitems/bulk/add/jobs

### Synopsis

/api/v2/taskmanagement/workitems/bulk/add/jobs

### Options

```
-h, --help help for jobs
```

### Options inherited from parent commands

```
--accesstoken string accessToken override
--clientid string clientId override
--clientsecret string clientSecret override
--environment string environment override. E.g. mypurecloud.com.au or ap-southeast-2
-i, --indicateprogress Trace progress indicators to stderr
--inputformat string Data input format. Supported formats: YAML, JSON
--outputformat string Data output format. Supported formats: YAML, JSON
-p, --profile string Name of the profile to use for configuring the cli (default "DEFAULT")
--transform string Provide a Go template file for transforming output data
--transformstr string Provide a Go template string for transforming output data
```

### SEE ALSO

* [gc taskmanagement workitems bulk add](gc_taskmanagement_workitems_bulk_add.html) - /api/v2/taskmanagement/workitems/bulk/add
* [gc taskmanagement workitems bulk add jobs create](gc_taskmanagement_workitems_bulk_add_jobs_create.html) - Create a workitem bulk add job.
* [gc taskmanagement workitems bulk add jobs delete](gc_taskmanagement_workitems_bulk_add_jobs_delete.html) - Delete a bulk add job
* [gc taskmanagement workitems bulk add jobs get](gc_taskmanagement_workitems_bulk_add_jobs_get.html) - Get the bulk add job associated with the job id.
* [gc taskmanagement workitems bulk add jobs results](gc_taskmanagement_workitems_bulk_add_jobs_results.html) - /api/v2/taskmanagement/workitems/bulk/add/jobs/{bulkJobId}/results
* [gc taskmanagement workitems bulk add jobs update](gc_taskmanagement_workitems_bulk_add_jobs_update.html) - Update workitem bulk add job.


Loading

0 comments on commit 31e984d

Please sign in to comment.