Common

6min

Go SDK is divided into 3 clients:
Floating client
License client
Management client
Response Types
There are 3 response wrapper types. These are used for future extendability and ease of use.
Client.Response
Management_response.SearchResult
Error
Client.Response
Response type is used by all 3 clients, and it's a generic wrapper for any request:
Go
|
type Response[T any] struct {
	Payload []byte // raw response JSON
	Value   T      // typed value
	Error   error  // error, if it exists
}
type Response[T any] struct {
	Payload []byte // raw response JSON
	Value   T      // typed value
	Error   error  // error, if it exists
}
﻿
As an example, license_client.ActivateLicense would return client.Response[LicenseResponse], so response.Value would be of type LicenseResponse. Example:
Go
|
resp := client.ActivateLicense(context.Background(), ...)

// access LicenseResponse fields
resp.Value.LicenseKey

// or get whole LicenseResponse struct
license := resp.Value
license.LicenseKey
resp := client.ActivateLicense(context.Background(), ...)

// access LicenseResponse fields
resp.Value.LicenseKey

// or get whole LicenseResponse struct
license := resp.Value
license.LicenseKey
﻿
Management_response.SearchResult
SearchResult is used only in management client to wrap search/list request responses. For example, for ListCustomers request.
Error
Error type is commonly used as response for Delete requests, e.g. DeleteCustomer.

Updated 05 Sep 2023

Did this page help you?

TABLE OF CONTENTS

Response Types

Client.Response

Management_response.SearchResult

Error