Files
sdk/api_destination.go

593 lines
22 KiB
Go

/*
Hanzo Cloud API
The Hanzo Cloud API as a customer calls it: every operation under /v1/ except the operator's admin product, relay routes, legacy spellings and capabilities still reached by flag. Tagged by product: the first path segment after /v1/.
API version: v1
*/
// Code generated by OpenAPI Generator (https://openapi-generator.tech); DO NOT EDIT.
package hanzoai
import (
"bytes"
"context"
"io"
"net/http"
"net/url"
"strings"
)
// DestinationAPIService DestinationAPI service
type DestinationAPIService service
type DestinationAPIDeleteDestinationByPlatformRequest struct {
ctx context.Context
ApiService *DestinationAPIService
platform string
}
func (r DestinationAPIDeleteDestinationByPlatformRequest) Execute() (*DestinationDestinationDisconnected, *http.Response, error) {
return r.ApiService.DeleteDestinationByPlatformExecute(r)
}
/*
DeleteDestinationByPlatform Forgets a destination for the caller's org: every credential held in KMS, then the stored config.
Forgets a destination for the caller's org: every credential held in
KMS, then the stored config. Idempotent, and it requires org admin.
@param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
@param platform Platform is the destination to act on, from the path: ga4 | meta | tiktok | linkedin | x | reddit | insights.
@return DestinationAPIDeleteDestinationByPlatformRequest
*/
func (a *DestinationAPIService) DeleteDestinationByPlatform(ctx context.Context, platform string) DestinationAPIDeleteDestinationByPlatformRequest {
return DestinationAPIDeleteDestinationByPlatformRequest{
ApiService: a,
ctx: ctx,
platform: platform,
}
}
// Execute executes the request
//
// @return DestinationDestinationDisconnected
func (a *DestinationAPIService) DeleteDestinationByPlatformExecute(r DestinationAPIDeleteDestinationByPlatformRequest) (*DestinationDestinationDisconnected, *http.Response, error) {
var (
localVarHTTPMethod = http.MethodDelete
localVarPostBody interface{}
formFiles []formFile
localVarReturnValue *DestinationDestinationDisconnected
)
localBasePath, err := a.client.cfg.ServerURLWithContext(r.ctx, "DestinationAPIService.DeleteDestinationByPlatform")
if err != nil {
return localVarReturnValue, nil, &GenericOpenAPIError{error: err.Error()}
}
localVarPath := localBasePath + "/v1/destination/{platform}"
localVarPath = strings.Replace(localVarPath, "{"+"platform"+"}", url.PathEscape(parameterValueToString(r.platform, "platform")), -1)
localVarHeaderParams := make(map[string]string)
localVarQueryParams := url.Values{}
localVarFormParams := url.Values{}
// to determine the Content-Type header
localVarHTTPContentTypes := []string{}
// set Content-Type header
localVarHTTPContentType := selectHeaderContentType(localVarHTTPContentTypes)
if localVarHTTPContentType != "" {
localVarHeaderParams["Content-Type"] = localVarHTTPContentType
}
// to determine the Accept header
localVarHTTPHeaderAccepts := []string{"application/json", "application/problem+json"}
// set Accept header
localVarHTTPHeaderAccept := selectHeaderAccept(localVarHTTPHeaderAccepts)
if localVarHTTPHeaderAccept != "" {
localVarHeaderParams["Accept"] = localVarHTTPHeaderAccept
}
req, err := a.client.prepareRequest(r.ctx, localVarPath, localVarHTTPMethod, localVarPostBody, localVarHeaderParams, localVarQueryParams, localVarFormParams, formFiles)
if err != nil {
return localVarReturnValue, nil, err
}
localVarHTTPResponse, err := a.client.callAPI(req)
if err != nil || localVarHTTPResponse == nil {
return localVarReturnValue, localVarHTTPResponse, err
}
localVarBody, err := io.ReadAll(localVarHTTPResponse.Body)
localVarHTTPResponse.Body.Close()
localVarHTTPResponse.Body = io.NopCloser(bytes.NewBuffer(localVarBody))
if err != nil {
return localVarReturnValue, localVarHTTPResponse, err
}
if localVarHTTPResponse.StatusCode >= 300 {
newErr := &GenericOpenAPIError{
body: localVarBody,
error: localVarHTTPResponse.Status,
}
var v ProblemDetails
err = a.client.decode(&v, localVarBody, localVarHTTPResponse.Header.Get("Content-Type"))
if err != nil {
newErr.error = err.Error()
return localVarReturnValue, localVarHTTPResponse, newErr
}
newErr.error = formatErrorMessage(localVarHTTPResponse.Status, &v)
newErr.model = v
return localVarReturnValue, localVarHTTPResponse, newErr
}
err = a.client.decode(&localVarReturnValue, localVarBody, localVarHTTPResponse.Header.Get("Content-Type"))
if err != nil {
newErr := &GenericOpenAPIError{
body: localVarBody,
error: err.Error(),
}
return localVarReturnValue, localVarHTTPResponse, newErr
}
return localVarReturnValue, localVarHTTPResponse, nil
}
type DestinationAPIGetDestinationRequest struct {
ctx context.Context
ApiService *DestinationAPIService
}
func (r DestinationAPIGetDestinationRequest) Execute() (*DestinationDestinationList, *http.Response, error) {
return r.ApiService.GetDestinationExecute(r)
}
/*
GetDestination Reports every destination this deployment can forward to, each with the caller org's connection state: whether it is connected, whether it is enabled, whether a credential resolves right now, and the config fields the console renders for it.
Reports every destination this deployment can forward to, each with the
caller org's connection state: whether it is connected, whether it is enabled,
whether a credential resolves right now, and the config fields the console
renders for it.
@param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
@return DestinationAPIGetDestinationRequest
*/
func (a *DestinationAPIService) GetDestination(ctx context.Context) DestinationAPIGetDestinationRequest {
return DestinationAPIGetDestinationRequest{
ApiService: a,
ctx: ctx,
}
}
// Execute executes the request
//
// @return DestinationDestinationList
func (a *DestinationAPIService) GetDestinationExecute(r DestinationAPIGetDestinationRequest) (*DestinationDestinationList, *http.Response, error) {
var (
localVarHTTPMethod = http.MethodGet
localVarPostBody interface{}
formFiles []formFile
localVarReturnValue *DestinationDestinationList
)
localBasePath, err := a.client.cfg.ServerURLWithContext(r.ctx, "DestinationAPIService.GetDestination")
if err != nil {
return localVarReturnValue, nil, &GenericOpenAPIError{error: err.Error()}
}
localVarPath := localBasePath + "/v1/destination"
localVarHeaderParams := make(map[string]string)
localVarQueryParams := url.Values{}
localVarFormParams := url.Values{}
// to determine the Content-Type header
localVarHTTPContentTypes := []string{}
// set Content-Type header
localVarHTTPContentType := selectHeaderContentType(localVarHTTPContentTypes)
if localVarHTTPContentType != "" {
localVarHeaderParams["Content-Type"] = localVarHTTPContentType
}
// to determine the Accept header
localVarHTTPHeaderAccepts := []string{"application/json", "application/problem+json"}
// set Accept header
localVarHTTPHeaderAccept := selectHeaderAccept(localVarHTTPHeaderAccepts)
if localVarHTTPHeaderAccept != "" {
localVarHeaderParams["Accept"] = localVarHTTPHeaderAccept
}
req, err := a.client.prepareRequest(r.ctx, localVarPath, localVarHTTPMethod, localVarPostBody, localVarHeaderParams, localVarQueryParams, localVarFormParams, formFiles)
if err != nil {
return localVarReturnValue, nil, err
}
localVarHTTPResponse, err := a.client.callAPI(req)
if err != nil || localVarHTTPResponse == nil {
return localVarReturnValue, localVarHTTPResponse, err
}
localVarBody, err := io.ReadAll(localVarHTTPResponse.Body)
localVarHTTPResponse.Body.Close()
localVarHTTPResponse.Body = io.NopCloser(bytes.NewBuffer(localVarBody))
if err != nil {
return localVarReturnValue, localVarHTTPResponse, err
}
if localVarHTTPResponse.StatusCode >= 300 {
newErr := &GenericOpenAPIError{
body: localVarBody,
error: localVarHTTPResponse.Status,
}
var v ProblemDetails
err = a.client.decode(&v, localVarBody, localVarHTTPResponse.Header.Get("Content-Type"))
if err != nil {
newErr.error = err.Error()
return localVarReturnValue, localVarHTTPResponse, newErr
}
newErr.error = formatErrorMessage(localVarHTTPResponse.Status, &v)
newErr.model = v
return localVarReturnValue, localVarHTTPResponse, newErr
}
err = a.client.decode(&localVarReturnValue, localVarBody, localVarHTTPResponse.Header.Get("Content-Type"))
if err != nil {
newErr := &GenericOpenAPIError{
body: localVarBody,
error: err.Error(),
}
return localVarReturnValue, localVarHTTPResponse, newErr
}
return localVarReturnValue, localVarHTTPResponse, nil
}
type DestinationAPIGetDestinationByPlatformRequest struct {
ctx context.Context
ApiService *DestinationAPIService
platform string
}
func (r DestinationAPIGetDestinationByPlatformRequest) Execute() (*DestinationDestinationStatus, *http.Response, error) {
return r.ApiService.GetDestinationByPlatformExecute(r)
}
/*
GetDestinationByPlatform Reports one destination's card for the caller's org — its config fields, its connection state, and whether a credential resolves right now.
Reports one destination's card for the caller's org — its config fields,
its connection state, and whether a credential resolves right now. A platform
this deployment does not carry is not found.
@param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
@param platform Platform is the destination to act on, from the path: ga4 | meta | tiktok | linkedin | x | reddit | insights.
@return DestinationAPIGetDestinationByPlatformRequest
*/
func (a *DestinationAPIService) GetDestinationByPlatform(ctx context.Context, platform string) DestinationAPIGetDestinationByPlatformRequest {
return DestinationAPIGetDestinationByPlatformRequest{
ApiService: a,
ctx: ctx,
platform: platform,
}
}
// Execute executes the request
//
// @return DestinationDestinationStatus
func (a *DestinationAPIService) GetDestinationByPlatformExecute(r DestinationAPIGetDestinationByPlatformRequest) (*DestinationDestinationStatus, *http.Response, error) {
var (
localVarHTTPMethod = http.MethodGet
localVarPostBody interface{}
formFiles []formFile
localVarReturnValue *DestinationDestinationStatus
)
localBasePath, err := a.client.cfg.ServerURLWithContext(r.ctx, "DestinationAPIService.GetDestinationByPlatform")
if err != nil {
return localVarReturnValue, nil, &GenericOpenAPIError{error: err.Error()}
}
localVarPath := localBasePath + "/v1/destination/{platform}"
localVarPath = strings.Replace(localVarPath, "{"+"platform"+"}", url.PathEscape(parameterValueToString(r.platform, "platform")), -1)
localVarHeaderParams := make(map[string]string)
localVarQueryParams := url.Values{}
localVarFormParams := url.Values{}
// to determine the Content-Type header
localVarHTTPContentTypes := []string{}
// set Content-Type header
localVarHTTPContentType := selectHeaderContentType(localVarHTTPContentTypes)
if localVarHTTPContentType != "" {
localVarHeaderParams["Content-Type"] = localVarHTTPContentType
}
// to determine the Accept header
localVarHTTPHeaderAccepts := []string{"application/json", "application/problem+json"}
// set Accept header
localVarHTTPHeaderAccept := selectHeaderAccept(localVarHTTPHeaderAccepts)
if localVarHTTPHeaderAccept != "" {
localVarHeaderParams["Accept"] = localVarHTTPHeaderAccept
}
req, err := a.client.prepareRequest(r.ctx, localVarPath, localVarHTTPMethod, localVarPostBody, localVarHeaderParams, localVarQueryParams, localVarFormParams, formFiles)
if err != nil {
return localVarReturnValue, nil, err
}
localVarHTTPResponse, err := a.client.callAPI(req)
if err != nil || localVarHTTPResponse == nil {
return localVarReturnValue, localVarHTTPResponse, err
}
localVarBody, err := io.ReadAll(localVarHTTPResponse.Body)
localVarHTTPResponse.Body.Close()
localVarHTTPResponse.Body = io.NopCloser(bytes.NewBuffer(localVarBody))
if err != nil {
return localVarReturnValue, localVarHTTPResponse, err
}
if localVarHTTPResponse.StatusCode >= 300 {
newErr := &GenericOpenAPIError{
body: localVarBody,
error: localVarHTTPResponse.Status,
}
var v ProblemDetails
err = a.client.decode(&v, localVarBody, localVarHTTPResponse.Header.Get("Content-Type"))
if err != nil {
newErr.error = err.Error()
return localVarReturnValue, localVarHTTPResponse, newErr
}
newErr.error = formatErrorMessage(localVarHTTPResponse.Status, &v)
newErr.model = v
return localVarReturnValue, localVarHTTPResponse, newErr
}
err = a.client.decode(&localVarReturnValue, localVarBody, localVarHTTPResponse.Header.Get("Content-Type"))
if err != nil {
newErr := &GenericOpenAPIError{
body: localVarBody,
error: err.Error(),
}
return localVarReturnValue, localVarHTTPResponse, newErr
}
return localVarReturnValue, localVarHTTPResponse, nil
}
type DestinationAPIPostDestinationByPlatformRequest struct {
ctx context.Context
ApiService *DestinationAPIService
platform string
requestBody *map[string]interface{}
}
func (r DestinationAPIPostDestinationByPlatformRequest) RequestBody(requestBody map[string]interface{}) DestinationAPIPostDestinationByPlatformRequest {
r.requestBody = &requestBody
return r
}
func (r DestinationAPIPostDestinationByPlatformRequest) Execute() (*DestinationStatus, *http.Response, error) {
return r.ApiService.PostDestinationByPlatformExecute(r)
}
/*
PostDestinationByPlatform Connect one conversion destination for your org, or update the one you have
Stores the addressed platform's non-secret ids (its measurement, pixel or dataset ids) and seals its API credential into KMS under a path scoped to the caller's own org, then answers the same status card the read routes do — with live telling you whether the credential actually resolves right now. The body's property NAMES are the platform's own: each field the platform declares, plus each secret under its camelCase name, so the accepted keys differ per platform and a missing REQUIRED field is refused. Connecting is an ORG ADMIN action — a validated member without the admin bit gets 403 — and it fails closed with 503 when the KMS master key is unavailable rather than persisting a destination whose secret was never sealed. The secret itself never appears in the response, in the store, or in a log line; only its NAME is ever published. Set enabled to false to keep the connection but stop the analytics fan-out to it.
@param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
@param platform
@return DestinationAPIPostDestinationByPlatformRequest
*/
func (a *DestinationAPIService) PostDestinationByPlatform(ctx context.Context, platform string) DestinationAPIPostDestinationByPlatformRequest {
return DestinationAPIPostDestinationByPlatformRequest{
ApiService: a,
ctx: ctx,
platform: platform,
}
}
// Execute executes the request
//
// @return DestinationStatus
func (a *DestinationAPIService) PostDestinationByPlatformExecute(r DestinationAPIPostDestinationByPlatformRequest) (*DestinationStatus, *http.Response, error) {
var (
localVarHTTPMethod = http.MethodPost
localVarPostBody interface{}
formFiles []formFile
localVarReturnValue *DestinationStatus
)
localBasePath, err := a.client.cfg.ServerURLWithContext(r.ctx, "DestinationAPIService.PostDestinationByPlatform")
if err != nil {
return localVarReturnValue, nil, &GenericOpenAPIError{error: err.Error()}
}
localVarPath := localBasePath + "/v1/destination/{platform}"
localVarPath = strings.Replace(localVarPath, "{"+"platform"+"}", url.PathEscape(parameterValueToString(r.platform, "platform")), -1)
localVarHeaderParams := make(map[string]string)
localVarQueryParams := url.Values{}
localVarFormParams := url.Values{}
// to determine the Content-Type header
localVarHTTPContentTypes := []string{"application/json"}
// set Content-Type header
localVarHTTPContentType := selectHeaderContentType(localVarHTTPContentTypes)
if localVarHTTPContentType != "" {
localVarHeaderParams["Content-Type"] = localVarHTTPContentType
}
// to determine the Accept header
localVarHTTPHeaderAccepts := []string{"application/json"}
// set Accept header
localVarHTTPHeaderAccept := selectHeaderAccept(localVarHTTPHeaderAccepts)
if localVarHTTPHeaderAccept != "" {
localVarHeaderParams["Accept"] = localVarHTTPHeaderAccept
}
// body params
localVarPostBody = r.requestBody
req, err := a.client.prepareRequest(r.ctx, localVarPath, localVarHTTPMethod, localVarPostBody, localVarHeaderParams, localVarQueryParams, localVarFormParams, formFiles)
if err != nil {
return localVarReturnValue, nil, err
}
localVarHTTPResponse, err := a.client.callAPI(req)
if err != nil || localVarHTTPResponse == nil {
return localVarReturnValue, localVarHTTPResponse, err
}
localVarBody, err := io.ReadAll(localVarHTTPResponse.Body)
localVarHTTPResponse.Body.Close()
localVarHTTPResponse.Body = io.NopCloser(bytes.NewBuffer(localVarBody))
if err != nil {
return localVarReturnValue, localVarHTTPResponse, err
}
if localVarHTTPResponse.StatusCode >= 300 {
newErr := &GenericOpenAPIError{
body: localVarBody,
error: localVarHTTPResponse.Status,
}
return localVarReturnValue, localVarHTTPResponse, newErr
}
err = a.client.decode(&localVarReturnValue, localVarBody, localVarHTTPResponse.Header.Get("Content-Type"))
if err != nil {
newErr := &GenericOpenAPIError{
body: localVarBody,
error: err.Error(),
}
return localVarReturnValue, localVarHTTPResponse, newErr
}
return localVarReturnValue, localVarHTTPResponse, nil
}
type DestinationAPIPostDestinationByPlatformTestRequest struct {
ctx context.Context
ApiService *DestinationAPIService
platform string
}
func (r DestinationAPIPostDestinationByPlatformTestRequest) Execute() (*DestinationDestinationTest, *http.Response, error) {
return r.ApiService.PostDestinationByPlatformTestExecute(r)
}
/*
PostDestinationByPlatformTest Sends ONE synthetic conversion through the connected destination end to end and reports what the platform said.
Sends ONE synthetic conversion through the connected destination end to
end and reports what the platform said. Where the platform can check one without
recording it, it is a lead and nothing is kept: GA4 answers from its validation
server, Google Ads validates without importing, and Meta files it under the
connection's Test Event Code (and is refused without one). Anywhere else it is a
page view. A send the platform refuses is reported as data — {"ok": false,
"error": …} at 200 — so the console shows the platform's own words rather than
an error about Hanzo. It requires org admin.
@param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
@param platform Platform is the destination to act on, from the path: ga4 | meta | tiktok | linkedin | x | reddit | insights.
@return DestinationAPIPostDestinationByPlatformTestRequest
*/
func (a *DestinationAPIService) PostDestinationByPlatformTest(ctx context.Context, platform string) DestinationAPIPostDestinationByPlatformTestRequest {
return DestinationAPIPostDestinationByPlatformTestRequest{
ApiService: a,
ctx: ctx,
platform: platform,
}
}
// Execute executes the request
//
// @return DestinationDestinationTest
func (a *DestinationAPIService) PostDestinationByPlatformTestExecute(r DestinationAPIPostDestinationByPlatformTestRequest) (*DestinationDestinationTest, *http.Response, error) {
var (
localVarHTTPMethod = http.MethodPost
localVarPostBody interface{}
formFiles []formFile
localVarReturnValue *DestinationDestinationTest
)
localBasePath, err := a.client.cfg.ServerURLWithContext(r.ctx, "DestinationAPIService.PostDestinationByPlatformTest")
if err != nil {
return localVarReturnValue, nil, &GenericOpenAPIError{error: err.Error()}
}
localVarPath := localBasePath + "/v1/destination/{platform}/test"
localVarPath = strings.Replace(localVarPath, "{"+"platform"+"}", url.PathEscape(parameterValueToString(r.platform, "platform")), -1)
localVarHeaderParams := make(map[string]string)
localVarQueryParams := url.Values{}
localVarFormParams := url.Values{}
// to determine the Content-Type header
localVarHTTPContentTypes := []string{}
// set Content-Type header
localVarHTTPContentType := selectHeaderContentType(localVarHTTPContentTypes)
if localVarHTTPContentType != "" {
localVarHeaderParams["Content-Type"] = localVarHTTPContentType
}
// to determine the Accept header
localVarHTTPHeaderAccepts := []string{"application/json", "application/problem+json"}
// set Accept header
localVarHTTPHeaderAccept := selectHeaderAccept(localVarHTTPHeaderAccepts)
if localVarHTTPHeaderAccept != "" {
localVarHeaderParams["Accept"] = localVarHTTPHeaderAccept
}
req, err := a.client.prepareRequest(r.ctx, localVarPath, localVarHTTPMethod, localVarPostBody, localVarHeaderParams, localVarQueryParams, localVarFormParams, formFiles)
if err != nil {
return localVarReturnValue, nil, err
}
localVarHTTPResponse, err := a.client.callAPI(req)
if err != nil || localVarHTTPResponse == nil {
return localVarReturnValue, localVarHTTPResponse, err
}
localVarBody, err := io.ReadAll(localVarHTTPResponse.Body)
localVarHTTPResponse.Body.Close()
localVarHTTPResponse.Body = io.NopCloser(bytes.NewBuffer(localVarBody))
if err != nil {
return localVarReturnValue, localVarHTTPResponse, err
}
if localVarHTTPResponse.StatusCode >= 300 {
newErr := &GenericOpenAPIError{
body: localVarBody,
error: localVarHTTPResponse.Status,
}
var v ProblemDetails
err = a.client.decode(&v, localVarBody, localVarHTTPResponse.Header.Get("Content-Type"))
if err != nil {
newErr.error = err.Error()
return localVarReturnValue, localVarHTTPResponse, newErr
}
newErr.error = formatErrorMessage(localVarHTTPResponse.Status, &v)
newErr.model = v
return localVarReturnValue, localVarHTTPResponse, newErr
}
err = a.client.decode(&localVarReturnValue, localVarBody, localVarHTTPResponse.Header.Get("Content-Type"))
if err != nil {
newErr := &GenericOpenAPIError{
body: localVarBody,
error: err.Error(),
}
return localVarReturnValue, localVarHTTPResponse, newErr
}
return localVarReturnValue, localVarHTTPResponse, nil
}