Consolidate the various approaches for making custom calls to the Genesys Cloud API apart from the SDK Client into a single Custom API Client library.#2204
Open
bbbco wants to merge 1 commit intoMyPureCloud:devfrom
Conversation
…esys Cloud API apart from the SDK Client into a single Custom API Client library.
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Introduces a shared custom_api_client package that wraps the SDK's APIClient.CallAPI() method, then migrates all proxy files that were making direct CallAPI or raw http.Client calls to
use it. This eliminates ~1,400 lines of duplicated boilerplate (authorization headers, content-type negotiation, query parameter encoding, error handling, JSON unmarshaling) across 21
files.
Motivation
Proxy files that needed to call API endpoints without generated SDK methods were each independently constructing HTTP requests — building auth headers, setting content types, encoding query params, handling errors, and unmarshaling responses. This was error-prone, inconsistent, and created a maintenance burden. Some files used APIClient.CallAPI() directly, others used raw net/http.Client, and each had slightly different error handling.
What's included
New package: genesyscloud/custom_api_client/
Migrated files (21 files across 16 packages):
Documentation:
What was NOT changed