numberinsight.go

package vonage

import (
	"context"

	"github.com/antihax/optional"
	"github.com/vonage/vonage-go-sdk/internal/numberinsight"
)

// NumberInsightClient for working with the NumberInsight API
type NumberInsightClient struct {
	Config    *numberinsight.Configuration
	apiKey    string
	apiSecret string
}

// NewNumberInsightClient Creates a new NumberInsight Client, supplying an Auth to work with
func NewNumberInsightClient(Auth Auth) *NumberInsightClient {
	client := new(NumberInsightClient)
	creds := Auth.GetCreds()
	client.apiKey = creds[0]
	client.apiSecret = creds[1]

	client.Config = numberinsight.NewConfiguration()
	client.Config.UserAgent = GetUserAgent()
	return client
}

type NiErrorResponse struct {
	Status        int32
	StatusMessage string
}

type NiOpts struct {
	Country string
}

type NiResponseJsonBasic struct {
	Status                    numberinsight.NiBasicStatus
	StatusMessage             string
	RequestId                 string
	InternationalFormatNumber string
	NationalFormatNumber      string
	CountryCode               string
	CountryCodeIso3           string
	CountryName               string
	CountryPrefix             string
}

// Basic does a basic-level lookup for data about a number
func (client *NumberInsightClient) Basic(number string, opts NiOpts) (NiResponseJsonBasic, NiErrorResponse, error) {
	// create the client
	numberinsightClient := numberinsight.NewAPIClient(client.Config)

	niOpts := numberinsight.GetNumberInsightBasicOpts{}

	if opts.Country != "" {
		niOpts.Country = optional.NewString(opts.Country)
	}

	// we need context for the API key
	ctx := context.Background()
	ctx = context.WithValue(ctx, numberinsight.ContextAPIKey, numberinsight.APIKey{Key: client.apiKey})
	ctx = context.WithValue(ctx, numberinsight.ContextAPISecret, numberinsight.APIKey{Key: client.apiSecret})

	result, _, err := numberinsightClient.DefaultApi.GetNumberInsightBasic(ctx, "json", number, &niOpts)

	// catch HTTP errors
	if err != nil {
		return NiResponseJsonBasic{}, NiErrorResponse{}, err
	}

	if result.Status != 0 {
		errResp := NiErrorResponse{
			Status:        int32(result.Status),
			StatusMessage: result.StatusMessage,
		}
		return NiResponseJsonBasic(result), errResp, nil
	}

	return NiResponseJsonBasic(result), NiErrorResponse{}, nil
}

type NiResponseJsonStandard struct {
	Status                    numberinsight.NiBasicStatus
	StatusMessage             string
	RequestId                 string
	InternationalFormatNumber string
	NationalFormatNumber      string
	CountryCode               string
	CountryCodeIso3           string
	CountryName               string
	CountryPrefix             string
	RequestPrice              string
	RefundPrice               string
	RemainingBalance          string
	CurrentCarrier            numberinsight.NiCurrentCarrierProperties
	OriginalCarrier           numberinsight.NiInitialCarrierProperties
	Ported                    string
	Roaming                   numberinsight.NiRoaming
	CallerIdentity            numberinsight.NiCallerIdentity
	CallerName                string
	LastName                  string
	FirstName                 string
	CallerType                string
}

// Standard does a Standard-level lookup for data about a number
func (client *NumberInsightClient) Standard(number string, opts NiOpts) (NiResponseJsonStandard, NiErrorResponse, error) {
	// create the client
	numberinsightClient := numberinsight.NewAPIClient(client.Config)

	niOpts := numberinsight.GetNumberInsightStandardOpts{}

	// we need context for the API key
	ctx := context.Background()
	ctx = context.WithValue(ctx, numberinsight.ContextAPIKey, numberinsight.APIKey{Key: client.apiKey})
	ctx = context.WithValue(ctx, numberinsight.ContextAPISecret, numberinsight.APIKey{Key: client.apiSecret})

	result, _, err := numberinsightClient.DefaultApi.GetNumberInsightStandard(ctx, "json", number, &niOpts)

	// catch HTTP errors
	if err != nil {
		return NiResponseJsonStandard{}, NiErrorResponse{}, err
	}

	if result.Status != 0 {
		errResp := NiErrorResponse{
			Status:        int32(result.Status),
			StatusMessage: result.StatusMessage,
		}
		return NiResponseJsonStandard(result), errResp, nil
	}

	return NiResponseJsonStandard(result), NiErrorResponse{}, nil
}

type NiResponseAsync struct {
	RequestId        string
	Number           string
	RemainingBalance string
	RequestPrice     string
	Status           numberinsight.NiStandardAdvancedStatus
	StatusMessage    string
}

// AdvancedAsync requests a callback with advanced-level information about a number
func (client *NumberInsightClient) AdvancedAsync(number string, callback string, opts NiOpts) (NiResponseAsync, NiErrorResponse, error) {
	// create the client
	numberinsightClient := numberinsight.NewAPIClient(client.Config)

	niOpts := numberinsight.GetNumberInsightAsyncOpts{}

	// we need context for the API key
	ctx := context.Background()
	ctx = context.WithValue(ctx, numberinsight.ContextAPIKey, numberinsight.APIKey{Key: client.apiKey})
	ctx = context.WithValue(ctx, numberinsight.ContextAPISecret, numberinsight.APIKey{Key: client.apiSecret})

	result, _, err := numberinsightClient.DefaultApi.GetNumberInsightAsync(ctx, "json", callback, number, &niOpts)

	// catch HTTP errors
	if err != nil {
		return NiResponseAsync{}, NiErrorResponse{}, err
	}

	if result.Status != 0 {
		errResp := NiErrorResponse{
			Status:        int32(result.Status),
			StatusMessage: result.StatusMessage,
		}
		return NiResponseAsync(result), errResp, nil
	}

	return NiResponseAsync(result), NiErrorResponse{}, nil
}