Files
sdk/api_referral.go

393 lines
13 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"
)
// ReferralAPIService ReferralAPI service
type ReferralAPIService service
type ReferralAPIGetReferralRequest struct {
ctx context.Context
ApiService *ReferralAPIService
}
func (r ReferralAPIGetReferralRequest) Execute() (*ReferralMyReferrals, *http.Response, error) {
return r.ApiService.GetReferralExecute(r)
}
/*
GetReferral Returns the caller's referral code, share link and the referrals they have made.
Returns the caller's referral code, share link and the referrals they have made.
The code is a stable, deterministic function of the org, so the link in this
response is the same one every time. Each row carries the referee and the status
of that attribution.
IT IS A PURE READ. It advances no referral, grants nothing and deposits nothing
— a GET reports state, it never changes it. Qualification is the admin sweep's
job (POST /v1/admin/referral/sweep). The one row this handler can write is the
caller's OWN code-directory entry (EnsureCode), which materialises a value
deriveCode already computes deterministically from the org id so the code has an
O(1) reverse lookup; it carries no money, no referral state and no other tenant.
@param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
@return ReferralAPIGetReferralRequest
*/
func (a *ReferralAPIService) GetReferral(ctx context.Context) ReferralAPIGetReferralRequest {
return ReferralAPIGetReferralRequest{
ApiService: a,
ctx: ctx,
}
}
// Execute executes the request
//
// @return ReferralMyReferrals
func (a *ReferralAPIService) GetReferralExecute(r ReferralAPIGetReferralRequest) (*ReferralMyReferrals, *http.Response, error) {
var (
localVarHTTPMethod = http.MethodGet
localVarPostBody interface{}
formFiles []formFile
localVarReturnValue *ReferralMyReferrals
)
localBasePath, err := a.client.cfg.ServerURLWithContext(r.ctx, "ReferralAPIService.GetReferral")
if err != nil {
return localVarReturnValue, nil, &GenericOpenAPIError{error: err.Error()}
}
localVarPath := localBasePath + "/v1/referral"
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 ReferralAPIPostReferralClaimRequest struct {
ctx context.Context
ApiService *ReferralAPIService
referralClaimRequest *ReferralClaimRequest
}
func (r ReferralAPIPostReferralClaimRequest) ReferralClaimRequest(referralClaimRequest ReferralClaimRequest) ReferralAPIPostReferralClaimRequest {
r.referralClaimRequest = &referralClaimRequest
return r
}
func (r ReferralAPIPostReferralClaimRequest) Execute() (*ReferralClaimView, *http.Response, error) {
return r.ApiService.PostReferralClaimExecute(r)
}
/*
PostReferralClaim Records that the caller's org signed up through a referral code.
Records that the caller's org signed up through a referral code.
The REFEREE is the validated caller, never a client field, and the referrer is
resolved from the code — so a caller can only ever attach THEMSELVES to someone
else's code. Referring yourself is 400 and an unknown code is 404.
It is idempotent and first-touch: an org can be referred once, ever. A repeat
call returns the referral already on file with created=false and 200, where the
first call answers 201.
Recording a referral grants nothing, and neither does anything downstream of it:
the edge later advances to qualified when the referee makes metered spend
(POST /v1/admin/referral/sweep), and that is the end of it. No credit is ever
issued from this package.
@param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
@return ReferralAPIPostReferralClaimRequest
*/
func (a *ReferralAPIService) PostReferralClaim(ctx context.Context) ReferralAPIPostReferralClaimRequest {
return ReferralAPIPostReferralClaimRequest{
ApiService: a,
ctx: ctx,
}
}
// Execute executes the request
//
// @return ReferralClaimView
func (a *ReferralAPIService) PostReferralClaimExecute(r ReferralAPIPostReferralClaimRequest) (*ReferralClaimView, *http.Response, error) {
var (
localVarHTTPMethod = http.MethodPost
localVarPostBody interface{}
formFiles []formFile
localVarReturnValue *ReferralClaimView
)
localBasePath, err := a.client.cfg.ServerURLWithContext(r.ctx, "ReferralAPIService.PostReferralClaim")
if err != nil {
return localVarReturnValue, nil, &GenericOpenAPIError{error: err.Error()}
}
localVarPath := localBasePath + "/v1/referral/claim"
localVarHeaderParams := make(map[string]string)
localVarQueryParams := url.Values{}
localVarFormParams := url.Values{}
if r.referralClaimRequest == nil {
return localVarReturnValue, nil, reportError("referralClaimRequest is required and must be specified")
}
// 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", "application/problem+json"}
// set Accept header
localVarHTTPHeaderAccept := selectHeaderAccept(localVarHTTPHeaderAccepts)
if localVarHTTPHeaderAccept != "" {
localVarHeaderParams["Accept"] = localVarHTTPHeaderAccept
}
// body params
localVarPostBody = r.referralClaimRequest
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 ReferralAPIPutReferralRequest struct {
ctx context.Context
ApiService *ReferralAPIService
referralSetCodeRequest *ReferralSetCodeRequest
}
func (r ReferralAPIPutReferralRequest) ReferralSetCodeRequest(referralSetCodeRequest ReferralSetCodeRequest) ReferralAPIPutReferralRequest {
r.referralSetCodeRequest = &referralSetCodeRequest
return r
}
func (r ReferralAPIPutReferralRequest) Execute() (*ReferralMyReferrals, *http.Response, error) {
return r.ApiService.PutReferralExecute(r)
}
/*
PutReferral Updates the caller's referral code and returns the updated referral summary.
Updates the caller's referral code and returns the updated referral summary.
@param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
@return ReferralAPIPutReferralRequest
*/
func (a *ReferralAPIService) PutReferral(ctx context.Context) ReferralAPIPutReferralRequest {
return ReferralAPIPutReferralRequest{
ApiService: a,
ctx: ctx,
}
}
// Execute executes the request
//
// @return ReferralMyReferrals
func (a *ReferralAPIService) PutReferralExecute(r ReferralAPIPutReferralRequest) (*ReferralMyReferrals, *http.Response, error) {
var (
localVarHTTPMethod = http.MethodPut
localVarPostBody interface{}
formFiles []formFile
localVarReturnValue *ReferralMyReferrals
)
localBasePath, err := a.client.cfg.ServerURLWithContext(r.ctx, "ReferralAPIService.PutReferral")
if err != nil {
return localVarReturnValue, nil, &GenericOpenAPIError{error: err.Error()}
}
localVarPath := localBasePath + "/v1/referral"
localVarHeaderParams := make(map[string]string)
localVarQueryParams := url.Values{}
localVarFormParams := url.Values{}
if r.referralSetCodeRequest == nil {
return localVarReturnValue, nil, reportError("referralSetCodeRequest is required and must be specified")
}
// 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", "application/problem+json"}
// set Accept header
localVarHTTPHeaderAccept := selectHeaderAccept(localVarHTTPHeaderAccepts)
if localVarHTTPHeaderAccept != "" {
localVarHeaderParams["Accept"] = localVarHTTPHeaderAccept
}
// body params
localVarPostBody = r.referralSetCodeRequest
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
}