customer.go

package gaia

import (
	"fmt"
	"time"

	"github.com/mitchellh/copystructure"
	"go.aporeto.io/elemental"
)

// CustomerProviderValue represents the possible values for attribute "provider".
type CustomerProviderValue string

const (
	// CustomerProviderAWS represents the value AWS.
	CustomerProviderAWS CustomerProviderValue = "AWS"

	// CustomerProviderAporeto represents the value Aporeto.
	CustomerProviderAporeto CustomerProviderValue = "Aporeto"
)

// CustomerStateValue represents the possible values for attribute "state".
type CustomerStateValue string

const (
	// CustomerStateSubscribeFailed represents the value SubscribeFailed.
	CustomerStateSubscribeFailed CustomerStateValue = "SubscribeFailed"

	// CustomerStateSubscribePending represents the value SubscribePending.
	CustomerStateSubscribePending CustomerStateValue = "SubscribePending"

	// CustomerStateSubscribeSuccess represents the value SubscribeSuccess.
	CustomerStateSubscribeSuccess CustomerStateValue = "SubscribeSuccess"

	// CustomerStateUnsubscribePending represents the value UnsubscribePending.
	CustomerStateUnsubscribePending CustomerStateValue = "UnsubscribePending"

	// CustomerStateUnsubscribeSuccess represents the value UnsubscribeSuccess.
	CustomerStateUnsubscribeSuccess CustomerStateValue = "UnsubscribeSuccess"
)

// CustomerIdentity represents the Identity of the object.
var CustomerIdentity = elemental.Identity{
	Name:     "customer",
	Category: "customers",
	Package:  "bill",
	Private:  true,
}

// CustomersList represents a list of Customers
type CustomersList []*Customer

// Identity returns the identity of the objects in the list.
func (o CustomersList) Identity() elemental.Identity {

	return CustomerIdentity
}

// Copy returns a pointer to a copy the CustomersList.
func (o CustomersList) Copy() elemental.Identifiables {

	copy := append(CustomersList{}, o...)
	return &copy
}

// Append appends the objects to the a new copy of the CustomersList.
func (o CustomersList) Append(objects ...elemental.Identifiable) elemental.Identifiables {

	out := append(CustomersList{}, o...)
	for _, obj := range objects {
		out = append(out, obj.(*Customer))
	}

	return out
}

// List converts the object to an elemental.IdentifiablesList.
func (o CustomersList) List() elemental.IdentifiablesList {

	out := make(elemental.IdentifiablesList, len(o))
	for i := 0; i < len(o); i++ {
		out[i] = o[i]
	}

	return out
}

// DefaultOrder returns the default ordering fields of the content.
func (o CustomersList) DefaultOrder() []string {

	return []string{}
}

// ToSparse returns the CustomersList converted to SparseCustomersList.
// Objects in the list will only contain the given fields. No field means entire field set.
func (o CustomersList) ToSparse(fields ...string) elemental.Identifiables {

	out := make(SparseCustomersList, len(o))
	for i := 0; i < len(o); i++ {
		out[i] = o[i].ToSparse(fields...).(*SparseCustomer)
	}

	return out
}

// Version returns the version of the content.
func (o CustomersList) Version() int {

	return 1
}

// Customer represents the model of a customer
type Customer struct {
	// Identifier of the object.
	ID string `json:"ID" msgpack:"ID" bson:"_id" mapstructure:"ID,omitempty"`

	// Creation date of the object.
	CreateTime time.Time `json:"createTime" msgpack:"createTime" bson:"createtime" mapstructure:"createTime,omitempty"`

	// Provider holds the name of the provider to be billed for this service.
	Provider CustomerProviderValue `json:"provider" msgpack:"provider" bson:"provider" mapstructure:"provider,omitempty"`

	// ProviderCustomerID holds the customer id as used by the provider for this
	// customer to enable provider billing.
	ProviderCustomerID string `json:"providerCustomerID" msgpack:"providerCustomerID" bson:"providercustomerid" mapstructure:"providerCustomerID,omitempty"`

	// State holds the status of the customer with the provider.
	State CustomerStateValue `json:"state" msgpack:"state" bson:"state" mapstructure:"state,omitempty"`

	// Last update date of the object.
	UpdateTime time.Time `json:"updateTime" msgpack:"updateTime" bson:"updatetime" mapstructure:"updateTime,omitempty"`

	ModelVersion int `json:"-" msgpack:"-" bson:"_modelversion"`
}

// NewCustomer returns a new *Customer
func NewCustomer() *Customer {

	return &Customer{
		ModelVersion: 1,
		Provider:     CustomerProviderAporeto,
		State:        CustomerStateSubscribePending,
	}
}

// Identity returns the Identity of the object.
func (o *Customer) Identity() elemental.Identity {

	return CustomerIdentity
}

// Identifier returns the value of the object's unique identifier.
func (o *Customer) Identifier() string {

	return o.ID
}

// SetIdentifier sets the value of the object's unique identifier.
func (o *Customer) SetIdentifier(id string) {

	o.ID = id
}

// Version returns the hardcoded version of the model.
func (o *Customer) Version() int {

	return 1
}

// BleveType implements the bleve.Classifier Interface.
func (o *Customer) BleveType() string {

	return "customer"
}

// DefaultOrder returns the list of default ordering fields.
func (o *Customer) DefaultOrder() []string {

	return []string{}
}

// Doc returns the documentation for the object
func (o *Customer) Doc() string {

	return `This api allows to view and manage basic information about customer profile for
billing purposes.`
}

func (o *Customer) String() string {

	return fmt.Sprintf("<%s:%s>", o.Identity().Name, o.Identifier())
}

// GetCreateTime returns the CreateTime of the receiver.
func (o *Customer) GetCreateTime() time.Time {

	return o.CreateTime
}

// SetCreateTime sets the property CreateTime of the receiver using the given value.
func (o *Customer) SetCreateTime(createTime time.Time) {

	o.CreateTime = createTime
}

// GetUpdateTime returns the UpdateTime of the receiver.
func (o *Customer) GetUpdateTime() time.Time {

	return o.UpdateTime
}

// SetUpdateTime sets the property UpdateTime of the receiver using the given value.
func (o *Customer) SetUpdateTime(updateTime time.Time) {

	o.UpdateTime = updateTime
}

// ToSparse returns the sparse version of the model.
// The returned object will only contain the given fields. No field means entire field set.
func (o *Customer) ToSparse(fields ...string) elemental.SparseIdentifiable {

	if len(fields) == 0 {
		// nolint: goimports
		return &SparseCustomer{
			ID:                 &o.ID,
			CreateTime:         &o.CreateTime,
			Provider:           &o.Provider,
			ProviderCustomerID: &o.ProviderCustomerID,
			State:              &o.State,
			UpdateTime:         &o.UpdateTime,
		}
	}

	sp := &SparseCustomer{}
	for _, f := range fields {
		switch f {
		case "ID":
			sp.ID = &(o.ID)
		case "createTime":
			sp.CreateTime = &(o.CreateTime)
		case "provider":
			sp.Provider = &(o.Provider)
		case "providerCustomerID":
			sp.ProviderCustomerID = &(o.ProviderCustomerID)
		case "state":
			sp.State = &(o.State)
		case "updateTime":
			sp.UpdateTime = &(o.UpdateTime)
		}
	}

	return sp
}

// Patch apply the non nil value of a *SparseCustomer to the object.
func (o *Customer) Patch(sparse elemental.SparseIdentifiable) {
	if !sparse.Identity().IsEqual(o.Identity()) {
		panic("cannot patch from a parse with different identity")
	}

	so := sparse.(*SparseCustomer)
	if so.ID != nil {
		o.ID = *so.ID
	}
	if so.CreateTime != nil {
		o.CreateTime = *so.CreateTime
	}
	if so.Provider != nil {
		o.Provider = *so.Provider
	}
	if so.ProviderCustomerID != nil {
		o.ProviderCustomerID = *so.ProviderCustomerID
	}
	if so.State != nil {
		o.State = *so.State
	}
	if so.UpdateTime != nil {
		o.UpdateTime = *so.UpdateTime
	}
}

// DeepCopy returns a deep copy if the Customer.
func (o *Customer) DeepCopy() *Customer {

	if o == nil {
		return nil
	}

	out := &Customer{}
	o.DeepCopyInto(out)

	return out
}

// DeepCopyInto copies the receiver into the given *Customer.
func (o *Customer) DeepCopyInto(out *Customer) {

	target, err := copystructure.Copy(o)
	if err != nil {
		panic(fmt.Sprintf("Unable to deepcopy Customer: %s", err))
	}

	*out = *target.(*Customer)
}

// Validate valides the current information stored into the structure.
func (o *Customer) Validate() error {

	errors := elemental.Errors{}
	requiredErrors := elemental.Errors{}

	if err := elemental.ValidateStringInList("provider", string(o.Provider), []string{"Aporeto", "AWS"}, false); err != nil {
		errors = errors.Append(err)
	}

	if err := elemental.ValidateStringInList("state", string(o.State), []string{"SubscribePending", "SubscribeFailed", "SubscribeSuccess", "UnsubscribePending", "UnsubscribeSuccess"}, false); err != nil {
		errors = errors.Append(err)
	}

	if len(requiredErrors) > 0 {
		return requiredErrors
	}

	if len(errors) > 0 {
		return errors
	}

	return nil
}

// SpecificationForAttribute returns the AttributeSpecification for the given attribute name key.
func (*Customer) SpecificationForAttribute(name string) elemental.AttributeSpecification {

	if v, ok := CustomerAttributesMap[name]; ok {
		return v
	}

	// We could not find it, so let's check on the lower case indexed spec map
	return CustomerLowerCaseAttributesMap[name]
}

// AttributeSpecifications returns the full attribute specifications map.
func (*Customer) AttributeSpecifications() map[string]elemental.AttributeSpecification {

	return CustomerAttributesMap
}

// ValueForAttribute returns the value for the given attribute.
// This is a very advanced function that you should not need but in some
// very specific use cases.
func (o *Customer) ValueForAttribute(name string) interface{} {

	switch name {
	case "ID":
		return o.ID
	case "createTime":
		return o.CreateTime
	case "provider":
		return o.Provider
	case "providerCustomerID":
		return o.ProviderCustomerID
	case "state":
		return o.State
	case "updateTime":
		return o.UpdateTime
	}

	return nil
}

// CustomerAttributesMap represents the map of attribute for Customer.
var CustomerAttributesMap = map[string]elemental.AttributeSpecification{
	"ID": elemental.AttributeSpecification{
		AllowedChoices: []string{},
		Autogenerated:  true,
		ConvertedName:  "ID",
		Description:    `Identifier of the object.`,
		Exposed:        true,
		Filterable:     true,
		Identifier:     true,
		Name:           "ID",
		Orderable:      true,
		ReadOnly:       true,
		Stored:         true,
		Type:           "string",
	},
	"CreateTime": elemental.AttributeSpecification{
		AllowedChoices: []string{},
		Autogenerated:  true,
		ConvertedName:  "CreateTime",
		Description:    `Creation date of the object.`,
		Exposed:        true,
		Getter:         true,
		Name:           "createTime",
		Orderable:      true,
		ReadOnly:       true,
		Setter:         true,
		Stored:         true,
		Type:           "time",
	},
	"Provider": elemental.AttributeSpecification{
		AllowedChoices: []string{"Aporeto", "AWS"},
		ConvertedName:  "Provider",
		DefaultValue:   CustomerProviderAporeto,
		Description:    `Provider holds the name of the provider to be billed for this service.`,
		Exposed:        true,
		Filterable:     true,
		Name:           "provider",
		Stored:         true,
		Type:           "enum",
	},
	"ProviderCustomerID": elemental.AttributeSpecification{
		AllowedChoices: []string{},
		ConvertedName:  "ProviderCustomerID",
		Description: `ProviderCustomerID holds the customer id as used by the provider for this
customer to enable provider billing.`,
		Exposed:   true,
		Name:      "providerCustomerID",
		Orderable: true,
		Stored:    true,
		Type:      "string",
	},
	"State": elemental.AttributeSpecification{
		AllowedChoices: []string{"SubscribePending", "SubscribeFailed", "SubscribeSuccess", "UnsubscribePending", "UnsubscribeSuccess"},
		ConvertedName:  "State",
		DefaultValue:   CustomerStateSubscribePending,
		Description:    `State holds the status of the customer with the provider.`,
		Exposed:        true,
		Name:           "state",
		ReadOnly:       true,
		Stored:         true,
		Type:           "enum",
	},
	"UpdateTime": elemental.AttributeSpecification{
		AllowedChoices: []string{},
		Autogenerated:  true,
		ConvertedName:  "UpdateTime",
		Description:    `Last update date of the object.`,
		Exposed:        true,
		Getter:         true,
		Name:           "updateTime",
		Orderable:      true,
		ReadOnly:       true,
		Setter:         true,
		Stored:         true,
		Type:           "time",
	},
}

// CustomerLowerCaseAttributesMap represents the map of attribute for Customer.
var CustomerLowerCaseAttributesMap = map[string]elemental.AttributeSpecification{
	"id": elemental.AttributeSpecification{
		AllowedChoices: []string{},
		Autogenerated:  true,
		ConvertedName:  "ID",
		Description:    `Identifier of the object.`,
		Exposed:        true,
		Filterable:     true,
		Identifier:     true,
		Name:           "ID",
		Orderable:      true,
		ReadOnly:       true,
		Stored:         true,
		Type:           "string",
	},
	"createtime": elemental.AttributeSpecification{
		AllowedChoices: []string{},
		Autogenerated:  true,
		ConvertedName:  "CreateTime",
		Description:    `Creation date of the object.`,
		Exposed:        true,
		Getter:         true,
		Name:           "createTime",
		Orderable:      true,
		ReadOnly:       true,
		Setter:         true,
		Stored:         true,
		Type:           "time",
	},
	"provider": elemental.AttributeSpecification{
		AllowedChoices: []string{"Aporeto", "AWS"},
		ConvertedName:  "Provider",
		DefaultValue:   CustomerProviderAporeto,
		Description:    `Provider holds the name of the provider to be billed for this service.`,
		Exposed:        true,
		Filterable:     true,
		Name:           "provider",
		Stored:         true,
		Type:           "enum",
	},
	"providercustomerid": elemental.AttributeSpecification{
		AllowedChoices: []string{},
		ConvertedName:  "ProviderCustomerID",
		Description: `ProviderCustomerID holds the customer id as used by the provider for this
customer to enable provider billing.`,
		Exposed:   true,
		Name:      "providerCustomerID",
		Orderable: true,
		Stored:    true,
		Type:      "string",
	},
	"state": elemental.AttributeSpecification{
		AllowedChoices: []string{"SubscribePending", "SubscribeFailed", "SubscribeSuccess", "UnsubscribePending", "UnsubscribeSuccess"},
		ConvertedName:  "State",
		DefaultValue:   CustomerStateSubscribePending,
		Description:    `State holds the status of the customer with the provider.`,
		Exposed:        true,
		Name:           "state",
		ReadOnly:       true,
		Stored:         true,
		Type:           "enum",
	},
	"updatetime": elemental.AttributeSpecification{
		AllowedChoices: []string{},
		Autogenerated:  true,
		ConvertedName:  "UpdateTime",
		Description:    `Last update date of the object.`,
		Exposed:        true,
		Getter:         true,
		Name:           "updateTime",
		Orderable:      true,
		ReadOnly:       true,
		Setter:         true,
		Stored:         true,
		Type:           "time",
	},
}

// SparseCustomersList represents a list of SparseCustomers
type SparseCustomersList []*SparseCustomer

// Identity returns the identity of the objects in the list.
func (o SparseCustomersList) Identity() elemental.Identity {

	return CustomerIdentity
}

// Copy returns a pointer to a copy the SparseCustomersList.
func (o SparseCustomersList) Copy() elemental.Identifiables {

	copy := append(SparseCustomersList{}, o...)
	return &copy
}

// Append appends the objects to the a new copy of the SparseCustomersList.
func (o SparseCustomersList) Append(objects ...elemental.Identifiable) elemental.Identifiables {

	out := append(SparseCustomersList{}, o...)
	for _, obj := range objects {
		out = append(out, obj.(*SparseCustomer))
	}

	return out
}

// List converts the object to an elemental.IdentifiablesList.
func (o SparseCustomersList) List() elemental.IdentifiablesList {

	out := make(elemental.IdentifiablesList, len(o))
	for i := 0; i < len(o); i++ {
		out[i] = o[i]
	}

	return out
}

// DefaultOrder returns the default ordering fields of the content.
func (o SparseCustomersList) DefaultOrder() []string {

	return []string{}
}

// ToPlain returns the SparseCustomersList converted to CustomersList.
func (o SparseCustomersList) ToPlain() elemental.IdentifiablesList {

	out := make(elemental.IdentifiablesList, len(o))
	for i := 0; i < len(o); i++ {
		out[i] = o[i].ToPlain()
	}

	return out
}

// Version returns the version of the content.
func (o SparseCustomersList) Version() int {

	return 1
}

// SparseCustomer represents the sparse version of a customer.
type SparseCustomer struct {
	// Identifier of the object.
	ID *string `json:"ID,omitempty" msgpack:"ID,omitempty" bson:"_id" mapstructure:"ID,omitempty"`

	// Creation date of the object.
	CreateTime *time.Time `json:"createTime,omitempty" msgpack:"createTime,omitempty" bson:"createtime,omitempty" mapstructure:"createTime,omitempty"`

	// Provider holds the name of the provider to be billed for this service.
	Provider *CustomerProviderValue `json:"provider,omitempty" msgpack:"provider,omitempty" bson:"provider,omitempty" mapstructure:"provider,omitempty"`

	// ProviderCustomerID holds the customer id as used by the provider for this
	// customer to enable provider billing.
	ProviderCustomerID *string `json:"providerCustomerID,omitempty" msgpack:"providerCustomerID,omitempty" bson:"providercustomerid,omitempty" mapstructure:"providerCustomerID,omitempty"`

	// State holds the status of the customer with the provider.
	State *CustomerStateValue `json:"state,omitempty" msgpack:"state,omitempty" bson:"state,omitempty" mapstructure:"state,omitempty"`

	// Last update date of the object.
	UpdateTime *time.Time `json:"updateTime,omitempty" msgpack:"updateTime,omitempty" bson:"updatetime,omitempty" mapstructure:"updateTime,omitempty"`

	ModelVersion int `json:"-" msgpack:"-" bson:"_modelversion"`
}

// NewSparseCustomer returns a new  SparseCustomer.
func NewSparseCustomer() *SparseCustomer {
	return &SparseCustomer{}
}

// Identity returns the Identity of the sparse object.
func (o *SparseCustomer) Identity() elemental.Identity {

	return CustomerIdentity
}

// Identifier returns the value of the sparse object's unique identifier.
func (o *SparseCustomer) Identifier() string {

	if o.ID == nil {
		return ""
	}
	return *o.ID
}

// SetIdentifier sets the value of the sparse object's unique identifier.
func (o *SparseCustomer) SetIdentifier(id string) {

	o.ID = &id
}

// Version returns the hardcoded version of the model.
func (o *SparseCustomer) Version() int {

	return 1
}

// ToPlain returns the plain version of the sparse model.
func (o *SparseCustomer) ToPlain() elemental.PlainIdentifiable {

	out := NewCustomer()
	if o.ID != nil {
		out.ID = *o.ID
	}
	if o.CreateTime != nil {
		out.CreateTime = *o.CreateTime
	}
	if o.Provider != nil {
		out.Provider = *o.Provider
	}
	if o.ProviderCustomerID != nil {
		out.ProviderCustomerID = *o.ProviderCustomerID
	}
	if o.State != nil {
		out.State = *o.State
	}
	if o.UpdateTime != nil {
		out.UpdateTime = *o.UpdateTime
	}

	return out
}

// GetCreateTime returns the CreateTime of the receiver.
func (o *SparseCustomer) GetCreateTime() time.Time {

	return *o.CreateTime
}

// SetCreateTime sets the property CreateTime of the receiver using the address of the given value.
func (o *SparseCustomer) SetCreateTime(createTime time.Time) {

	o.CreateTime = &createTime
}

// GetUpdateTime returns the UpdateTime of the receiver.
func (o *SparseCustomer) GetUpdateTime() time.Time {

	return *o.UpdateTime
}

// SetUpdateTime sets the property UpdateTime of the receiver using the address of the given value.
func (o *SparseCustomer) SetUpdateTime(updateTime time.Time) {

	o.UpdateTime = &updateTime
}

// DeepCopy returns a deep copy if the SparseCustomer.
func (o *SparseCustomer) DeepCopy() *SparseCustomer {

	if o == nil {
		return nil
	}

	out := &SparseCustomer{}
	o.DeepCopyInto(out)

	return out
}

// DeepCopyInto copies the receiver into the given *SparseCustomer.
func (o *SparseCustomer) DeepCopyInto(out *SparseCustomer) {

	target, err := copystructure.Copy(o)
	if err != nil {
		panic(fmt.Sprintf("Unable to deepcopy SparseCustomer: %s", err))
	}

	*out = *target.(*SparseCustomer)
}