Document the format of types in client.go

client.go provides an interface and types that are consumed by the Terraform provider.

This format does not usually match the internal API structures (which are found in internal/api).

Often, the structures in client.go are a composite type merging the request and response fields.

We should document this intention and provide examples in the README.md so that it is clear to developers and reviewers what expectations we have.

Navigation Menu