Skip to content

Commit

Permalink
96.0.0
Browse files Browse the repository at this point in the history
  • Loading branch information
PureCloud Jenkins committed Apr 6, 2023
1 parent f91c41d commit 15cbbd1
Show file tree
Hide file tree
Showing 241 changed files with 5,066 additions and 3,269 deletions.
10 changes: 9 additions & 1 deletion .openapi-generator/FILES
Original file line number Diff line number Diff line change
Expand Up @@ -727,6 +727,8 @@ docs/GetOauthAuthorization-example.txt
docs/GetOauthAuthorizations-example.txt
docs/GetOauthClient-example.txt
docs/GetOauthClientUsageQueryResult-example.txt
docs/GetOauthClientUsageQueryResult-example.txt
docs/GetOauthClientUsageSummary-example.txt
docs/GetOauthClientUsageSummary-example.txt
docs/GetOauthClients-example.txt
docs/GetOauthScope-example.txt
Expand Down Expand Up @@ -1251,6 +1253,7 @@ docs/PatchCoachingNotification-example.txt
docs/PatchConversationParticipant-example.txt
docs/PatchConversationParticipantAttributes-example.txt
docs/PatchConversationSecureattributes-example.txt
docs/PatchConversationsAftercallworkConversationIdParticipantCommunication-example.txt
docs/PatchConversationsCall-example.txt
docs/PatchConversationsCallParticipant-example.txt
docs/PatchConversationsCallParticipantAttributes-example.txt
Expand Down Expand Up @@ -1654,6 +1657,7 @@ docs/PostNotificationsChannelSubscriptions-example.txt
docs/PostNotificationsChannels-example.txt
docs/PostOauthClientSecret-example.txt
docs/PostOauthClientUsageQuery-example.txt
docs/PostOauthClientUsageQuery-example.txt
docs/PostOauthClients-example.txt
docs/PostOrgauthorizationPairings-example.txt
docs/PostOrgauthorizationTrusteeGroups-example.txt
Expand Down Expand Up @@ -2184,6 +2188,7 @@ platformclientv2/adhocrecordingtopicworkspacedata.go
platformclientv2/adjacents.go
platformclientv2/admintimeoffrequestpatch.go
platformclientv2/aftercallwork.go
platformclientv2/aftercallworkupdate.go
platformclientv2/agent.go
platformclientv2/agentactivity.go
platformclientv2/agentactivitychangedtopicagentactivity.go
Expand Down Expand Up @@ -3403,6 +3408,7 @@ platformclientv2/evaluationquestion.go
platformclientv2/evaluationquestiongroup.go
platformclientv2/evaluationquestiongroupscore.go
platformclientv2/evaluationquestionscore.go
platformclientv2/evaluationreference.go
platformclientv2/evaluationresponse.go
platformclientv2/evaluationscoringset.go
platformclientv2/evaluationsettings.go
Expand All @@ -3428,7 +3434,6 @@ platformclientv2/expirededgelisting.go
platformclientv2/exportscriptrequest.go
platformclientv2/exportscriptresponse.go
platformclientv2/exporturi.go
platformclientv2/extendedwrapup.go
platformclientv2/extension.go
platformclientv2/extensionentitylisting.go
platformclientv2/extensionpool.go
Expand Down Expand Up @@ -4170,6 +4175,7 @@ platformclientv2/organizationapi.go
platformclientv2/organizationauthorizationapi.go
platformclientv2/organizationfeatures.go
platformclientv2/organizationpresence.go
platformclientv2/organizationpresencedefinition.go
platformclientv2/organizationpresenceentitylisting.go
platformclientv2/organizationproductentitylisting.go
platformclientv2/organizationroleentitylisting.go
Expand Down Expand Up @@ -4980,6 +4986,7 @@ platformclientv2/supportcentersettings.go
platformclientv2/supportcenterstylesetting.go
platformclientv2/supportedcontent.go
platformclientv2/supportedcontentlisting.go
platformclientv2/supportedcontentprofile.go
platformclientv2/supportedcontentreference.go
platformclientv2/supporteddialectsentitylisting.go
platformclientv2/supportedlanguage.go
Expand Down Expand Up @@ -5704,6 +5711,7 @@ platformclientv2/wrapupcodemapping.go
platformclientv2/wrapupcodereference.go
platformclientv2/wrapupcoderequest.go
platformclientv2/wrapupdetaileventtopicwrapupevent.go
platformclientv2/wrapupinput.go
platformclientv2/writabledialercontact.go
platformclientv2/writabledivision.go
platformclientv2/writableentity.go
Expand Down
82 changes: 58 additions & 24 deletions APIData.json

Large diffs are not rendered by default.

49 changes: 46 additions & 3 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@ title: Platform API Client SDK - Go

A Go package to interface with the Genesys Cloud Platform API. View the documentation on the [pkg.go.dev](https://pkg.go.dev/github.com/MyPureCloud/platform-client-sdk-go). Browse the source code on [Github](https://github.com/MyPureCloud/platform-client-sdk-go).

Latest version: 95.0.0 [![GitHub release](https://img.shields.io/github/release/mypurecloud/platform-client-sdk-go.svg)](https://github.com/MyPureCloud/platform-client-sdk-go)
Latest version: 96.0.0 [![GitHub release](https://img.shields.io/github/release/mypurecloud/platform-client-sdk-go.svg)](https://github.com/MyPureCloud/platform-client-sdk-go)
[![Release Notes Badge](https://developer-content.genesys.cloud/images/sdk-release-notes.png)](https://github.com/MyPureCloud/platform-client-sdk-go/blob/master/releaseNotes.md)

## Golang Version Dependency
Expand All @@ -18,7 +18,7 @@ Some macOS users encounter the error "argument list too long" when building or i
Retrieve the package from https://github.com/MyPureCloud/platform-client-sdk-go using `go get`:

```go
go get github.com/mypurecloud/platform-client-sdk-go/v95/platformclientv2
go get github.com/mypurecloud/platform-client-sdk-go/v96/platformclientv2
```

## Using the SDK
Expand All @@ -27,7 +27,7 @@ go get github.com/mypurecloud/platform-client-sdk-go/v95/platformclientv2

```go
import (
"github.com/mypurecloud/platform-client-sdk-go/v95/platformclientv2"
"github.com/mypurecloud/platform-client-sdk-go/v96/platformclientv2"
)
```

Expand Down Expand Up @@ -105,6 +105,32 @@ config.LoggingConfiguration.SetLogToConsole(true)
config.LoggingConfiguration.SetLogFilePath("/var/log/golangsdk.log")
```

#### SDK Proxy

Using a proxy is accomplished by setting the proxy settings on the configuration object

The `ProxyConfiguration` object has 3 properties that determine the URL for proxying.
Port - Port of the Proxy server
Host - Host Ip or DNS of the proxy server
Protocol - Protocol required to connect to the Proxy (http or https)

The 'ProxyConfiguration' has another section which is an optional section. If the proxy requires authentication to connect to
'Auth' needs to be mentioned under the 'ProxyConfiguration'.

Example logging configuration:
```go
proxyconf := ProxyConfiguration{}
config.ProxyConfiguration := &proxyconf
config.ProxyConfiguration.Host = platformclientv2.LTrace
config.ProxyConfiguration.Port = true
config.ProxyConfiguration.Protocol = true

auth := Auth{}
config.ProxyConfiguration.Auth = &auth
config.ProxyConfiguration.Auth.UserName = userName
config.ProxyConfiguration.Auth.Password = password
```

#### Configuration file

A number of configuration parameters can be applied using a configuration file. There are two sources for this file:
Expand Down Expand Up @@ -134,6 +160,12 @@ refresh_token_wait_max = 10
[general]
live_reload_config = true
host = https://api.mypurecloud.com
[proxy]
port = 8888
host = hostserverip
protocol = http
auth-username = username
auth-password = password
```

JSON:
Expand All @@ -159,8 +191,19 @@ JSON:
"general": {
"live_reload_config": true,
"host": "https://api.mypurecloud.com"
},
{
"proxy": {
"host": "hostname",
"protocol": "http",
"port": "8888"
"auth": {
"username": "username",
"password": "password"
}
}
}
}
```

#### Setting the environment
Expand Down
2,105 changes: 1,238 additions & 867 deletions SDKData.json

Large diffs are not rendered by default.

49 changes: 46 additions & 3 deletions docs/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@ title: Platform API Client SDK - Go

A Go package to interface with the Genesys Cloud Platform API. View the documentation on the [pkg.go.dev](https://pkg.go.dev/github.com/MyPureCloud/platform-client-sdk-go). Browse the source code on [Github](https://github.com/MyPureCloud/platform-client-sdk-go).

Latest version: 95.0.0 [![GitHub release](https://img.shields.io/github/release/mypurecloud/platform-client-sdk-go.svg)](https://github.com/MyPureCloud/platform-client-sdk-go)
Latest version: 96.0.0 [![GitHub release](https://img.shields.io/github/release/mypurecloud/platform-client-sdk-go.svg)](https://github.com/MyPureCloud/platform-client-sdk-go)
[![Release Notes Badge](https://developer-content.genesys.cloud/images/sdk-release-notes.png)](https://github.com/MyPureCloud/platform-client-sdk-go/blob/master/releaseNotes.md)

## Golang Version Dependency
Expand All @@ -18,7 +18,7 @@ Some macOS users encounter the error "argument list too long" when building or i
Retrieve the package from https://github.com/MyPureCloud/platform-client-sdk-go using `go get`:

```go
go get github.com/mypurecloud/platform-client-sdk-go/v95/platformclientv2
go get github.com/mypurecloud/platform-client-sdk-go/v96/platformclientv2
```

## Using the SDK
Expand All @@ -27,7 +27,7 @@ go get github.com/mypurecloud/platform-client-sdk-go/v95/platformclientv2

```go
import (
"github.com/mypurecloud/platform-client-sdk-go/v95/platformclientv2"
"github.com/mypurecloud/platform-client-sdk-go/v96/platformclientv2"
)
```

Expand Down Expand Up @@ -105,6 +105,32 @@ config.LoggingConfiguration.SetLogToConsole(true)
config.LoggingConfiguration.SetLogFilePath("/var/log/golangsdk.log")
```

#### SDK Proxy

Using a proxy is accomplished by setting the proxy settings on the configuration object

The `ProxyConfiguration` object has 3 properties that determine the URL for proxying.
Port - Port of the Proxy server
Host - Host Ip or DNS of the proxy server
Protocol - Protocol required to connect to the Proxy (http or https)

The 'ProxyConfiguration' has another section which is an optional section. If the proxy requires authentication to connect to
'Auth' needs to be mentioned under the 'ProxyConfiguration'.

Example logging configuration:
```go
proxyconf := ProxyConfiguration{}
config.ProxyConfiguration := &proxyconf
config.ProxyConfiguration.Host = platformclientv2.LTrace
config.ProxyConfiguration.Port = true
config.ProxyConfiguration.Protocol = true

auth := Auth{}
config.ProxyConfiguration.Auth = &auth
config.ProxyConfiguration.Auth.UserName = userName
config.ProxyConfiguration.Auth.Password = password
```

#### Configuration file

A number of configuration parameters can be applied using a configuration file. There are two sources for this file:
Expand Down Expand Up @@ -134,6 +160,12 @@ refresh_token_wait_max = 10
[general]
live_reload_config = true
host = https://api.mypurecloud.com
[proxy]
port = 8888
host = hostserverip
protocol = http
auth-username = username
auth-password = password
```

JSON:
Expand All @@ -159,8 +191,19 @@ JSON:
"general": {
"live_reload_config": true,
"host": "https://api.mypurecloud.com"
},
{
"proxy": {
"host": "hostname",
"protocol": "http",
"port": "8888"
"auth": {
"username": "username",
"password": "password"
}
}
}
}
```

#### Setting the environment
Expand Down
Loading

0 comments on commit 15cbbd1

Please sign in to comment.