skalinsdk

type API interface {
	PutData(url, contentType string, extraHeaders map[string][]string, body []byte, queryParams *url.Values, expectedStatusCode int) (*http.Response, []byte, error)
	PostData(url, contentType string, extraHeaders map[string][]string, body []byte, queryParams *url.Values, expectedStatusCode int) (*http.Response, []byte, error)
	PatchData(url, contentType string, extraHeaders map[string][]string, body []byte, queryParams *url.Values, expectedStatusCode int) (*http.Response, []byte, error)
	GetData(url, contentType string, extraHeaders map[string][]string, body []byte, queryParams *url.Values, expectedStatusCode int) (*http.Response, []byte, error)
	DeleteData(url, contentType string, extraHeaders map[string][]string, body []byte, queryParams *url.Values, expectedStatusCode int) (*http.Response, []byte, error)

	WithToken(token string) API
	GetLogger() *CustomLog
	GetClientID() *string
	SetLogger(logrus.FieldLogger)
	// contains filtered or unexported methods
}

type Agreement struct {
	Id               string      `json:"id,omitempty"`
	CustomerId       *string     `json:"customerId,omitempty"` // correspond to the customer Id
	Customer         *string     `json:"customer,omitempty"`   // correspond to the customer refId
	RefId            string      `json:"refId,omitempty"`
	StartDate        *SkalinDate `json:"startDate,omitempty"`   // need to be at format `YYYY-MM-DD`
	EndDate          *SkalinDate `json:"endDate,omitempty"`     // need to be at format `YYYY-MM-DD`
	RenewalDate      *SkalinDate `json:"renewalDate,omitempty"` // need to be at format `YYYY-MM-DD`
	AutoRenew        bool        `json:"autoRenew,omitempty"`
	Engagement       *int        `json:"engagement,omitempty"` // need pointer because engagement value can be 0
	EngagementPeriod string      `json:"engagementPeriod,omitempty"`
	Notice           *int        `json:"notice,omitempty"` // need pointer because engagement value can be 0
	NoticePeriod     string      `json:"noticePeriod,omitempty"`
	Plan             string      `json:"plan,omitempty"`
	Type             string      `json:"type,omitempty"`
	Mrr              *int        `json:"mrr,omitempty"`
	Fee              *int        `json:"fee,omitempty"`
}

type Contact struct {
	Id               string           `json:"id,omitempty"`
	CustomerId       *string          `json:"customerId,omitempty"` // correspond to the customer Id
	Customer         *string          `json:"customer,omitempty"`   // correspond to the customer refId
	RefId            string           `json:"refId,omitempty"`
	Email            string           `json:"email,omitempty"`
	FirstName        string           `json:"firstName,omitempty"`
	LastName         string           `json:"lastName,omitempty"`
	Phone            string           `json:"phone,omitempty"`
	NpsScore         *int             `json:"npsScore,omitempty"`
	Tags             []string         `json:"tags,omitempty"`
	LastActivityTs   *time.Time       `json:"lastActivityTs,omitempty"`
	CustomAttributes CustomAttributes `json:"-"`
}

type CustomAttributes map[string]interface{}

type CustomLog struct {
	logrus.FieldLogger
}

type Customer struct {
	Id               string           `json:"id,omitempty"`
	RefId            string           `json:"refId,omitempty"`
	Name             string           `json:"name,omitempty"`
	Stage            string           `json:"stage,omitempty"`
	Tags             []string         `json:"tags,omitempty"`
	LastActivityTs   *time.Time       `json:"lastActivityTs,omitempty"`
	CustomAttributes CustomAttributes `json:"-"`
}

type CustomerResponse struct {
	Status string   `json:"status"`
	Data   Customer `json:"data"`
}

type EntitiesGeneric interface {
	Customer | Contact | Agreement | Tag
}

type EntitySlice[T EntitiesGeneric] interface {
	~[]T // permit to define a core type to use `make` and `append` on generic (https://go.dev/ref/spec#Core_types)
}

type GenericResponse[T EntitySlice[V] | EntitiesGeneric, V EntitiesGeneric, U ResponseMetadata] struct {
	Status   string `json:"status"`
	Data     T      `json:"data"`
	Metadata U      `json:"metadata,omitempty"`
}

type GetParams struct {
	Page    *int
	Size    *int
	Sort    *string
	Filters map[string]interface{}
}

type HitAction string

type HitEvent struct {
	Name      string `json:"name" validate:"required"`
	EventName string `json:"event_name" validate:"required"`
}

type HitIdentity struct {
	ID    *string `json:"id,omitempty" validate:"required_without=Email"`
	Email *string `json:"email,omitempty" validate:"required_without=ID,omitempty,email"`
}

type HitTrack struct {
	Action        HitAction   `validate:"required"`
	VisitorID     string      `validate:"required,len=16"`
	VisitID       string      `validate:"required,len=16"`
	Identity      HitIdentity `validate:"required"`
	Event         *HitEvent   `validate:"required_if=Action ev"` // mandatory if action is event
	EventID       *string     `validate:"omitempty,len=16"`
	CustomerID    *string
	Ts            *time.Time
	URL           *string
	CIP           *string // client ip
	CustomHeaders map[string][]string
}

type MockAPI struct {
	mock.Mock
}

type PaginationMetadata struct {
	Pagination struct {
		Size        int  `json:"size"`
		Page        int  `json:"page"`
		Total       int  `json:"total"`
		HasNextPage bool `json:"hasNextPage"`
	} `json:"pagination"`
}

type ResponseMetadata interface {
	PaginationMetadata
}

type Skalin interface {
	GetContacts(*GetParams) ([]Contact, error)
	SaveContact(Contact) (*Contact, error)
	UpdateContact(Contact) (*Contact, error)
	CreateContactForCustomer(Contact, string) (*Contact, error)
	DeleteContact(Contact) error

	GetCustomers(*GetParams) ([]Customer, error)
	SaveCustomer(Customer) (*Customer, error)

	GetAgreements(*GetParams) ([]Agreement, error)
	SaveAgreement(Agreement) (*Agreement, error)
	UpdateAgreement(Agreement) (*Agreement, error)
	CreateAgreementForCustomer(Agreement, string) (*Agreement, error)
	DeleteAgreement(Agreement) error

	GetTags(*GetParams) ([]Tag, error)
	GetTagByID(id string) (*Tag, error)

	SetLogger(logger logrus.FieldLogger)
}

type SkalinAPI struct {
	// contains filtered or unexported fields
}

type SkalinDate time.Time

type SkalinResponseError struct {
	Status  string `json:"status,omitempty"`
	Message string `json:"message,omitempty"`
	Code    int    `json:"code,omitempty"`
}

type SkalinTracking interface {
	Hit(HitTrack) error
}

type Tag struct {
	Id     string `json:"id"`
	Name   string `json:"name"`
	Type   string `json:"type"`
	Entity string `json:"entity"`
	Color  string `json:"color"`
}