product_fields.go

package pipedrive

import (
	"context"
	"fmt"
	"net/http"
)

// ProductFieldsService handles pipelines related
// methods of the Pipedrive API.
//
// Pipedrive API docs: https://developers.pipedrive.com/docs/api/v1/#!/ProductFields
type ProductFieldsService service

// ProductField represents a Pipedrive product field.
type ProductField struct {
	ID                 int         `json:"id"`
	Key                string      `json:"key"`
	Name               string      `json:"name"`
	OrderNr            int         `json:"order_nr"`
	PicklistData       interface{} `json:"picklist_data,omitempty"`
	FieldType          string      `json:"field_type"`
	AddTime            string      `json:"add_time"`
	UpdateTime         string      `json:"update_time"`
	ActiveFlag         bool        `json:"active_flag"`
	EditFlag           bool        `json:"edit_flag"`
	IndexVisibleFlag   bool        `json:"index_visible_flag"`
	DetailsVisibleFlag bool        `json:"details_visible_flag"`
	AddVisibleFlag     bool        `json:"add_visible_flag"`
	ImportantFlag      bool        `json:"important_flag"`
	BulkEditAllowed    bool        `json:"bulk_edit_allowed"`
	SearchableFlag     bool        `json:"searchable_flag"`
	FilteringAllowed   bool        `json:"filtering_allowed"`
	SortableFlag       bool        `json:"sortable_flag"`
	UseField           string      `json:"use_field,omitempty"`
	Link               string      `json:"link,omitempty"`
	MandatoryFlag      bool        `json:"mandatory_flag"`
	DisplayField       string      `json:"display_field,omitempty"`
	Options            []struct {
		ID    bool   `json:"id"`
		Label string `json:"label"`
	} `json:"options,omitempty"`
}

func (p ProductField) String() string {
	return Stringify(p)
}

// ProductFieldsResponse represents multiple product fields response.
type ProductFieldsResponse struct {
	Success        bool           `json:"success"`
	Data           []ProductField `json:"data"`
	AdditionalData AdditionalData `json:"additional_data"`
}

// ProductFieldResponse represents single product field response.
type ProductFieldResponse struct {
	Success        bool           `json:"success"`
	Data           ProductField   `json:"data"`
	AdditionalData AdditionalData `json:"additional_data"`
}

// List returns all data about product fields.
//
// Pipedrive API docs: https://developers.pipedrive.com/docs/api/v1/#!/ProductFields/get_productFields
func (s *ProductFieldsService) List(ctx context.Context) (*ProductFieldsResponse, *Response, error) {
	req, err := s.client.NewRequest(http.MethodGet, "/productFields", nil, nil)

	if err != nil {
		return nil, nil, err
	}

	var record *ProductFieldsResponse

	resp, err := s.client.Do(ctx, req, &record)

	if err != nil {
		return nil, resp, err
	}

	return record, resp, nil
}

// GetByID returns a specific product field.
//
// Pipedrive API docs: https://developers.pipedrive.com/docs/api/v1/#!/ProductFields/get_productFields_id
func (s *ProductFieldsService) GetByID(ctx context.Context, id int) (*ProductFieldResponse, *Response, error) {
	uri := fmt.Sprintf("/productFields/%v", id)
	req, err := s.client.NewRequest(http.MethodGet, uri, nil, nil)

	if err != nil {
		return nil, nil, err
	}

	var record *ProductFieldResponse

	resp, err := s.client.Do(ctx, req, &record)

	if err != nil {
		return nil, resp, err
	}

	return record, resp, nil
}

// ProductFieldCreateOptions specifices the optional parameters to the
// ProductFieldsService.Create method.
type ProductFieldCreateOptions struct {
	Name      string    `url:"name"`
	FieldType FieldType `url:"field_type"`
	Options   string    `url:"options"`
}

// Create a new product field.
//
// Pipedrive API docs: https://developers.pipedrive.com/docs/api/v1/#!/ProductFields/post_productFields
func (s *ProductFieldsService) Create(ctx context.Context, opt *ProductFieldCreateOptions) (*ProductFieldResponse, *Response, error) {
	req, err := s.client.NewRequest(http.MethodPost, "/productFields", nil, opt)

	if err != nil {
		return nil, nil, err
	}

	var record *ProductFieldResponse

	resp, err := s.client.Do(ctx, req, &record)

	if err != nil {
		return nil, resp, err
	}

	return record, resp, nil
}

// ProductFieldUpdateOptions specifices the optional parameters to the
// ProductFieldsService.Update method.
type ProductFieldUpdateOptions struct {
	Name    string `url:"name"`
	Options string `url:"options"`
}

// Update a specific product field.
//
// Pipedrive API docs: https://developers.pipedrive.com/docs/api/v1/#!/ProductFields/put_productFields_id
func (s *ProductFieldsService) Update(ctx context.Context, id int, opt *ProductFieldUpdateOptions) (*ProductFieldResponse, *Response, error) {
	uri := fmt.Sprintf("/productFields/%v", id)
	req, err := s.client.NewRequest(http.MethodPut, uri, nil, opt)

	if err != nil {
		return nil, nil, err
	}

	var record *ProductFieldResponse

	resp, err := s.client.Do(ctx, req, &record)

	if err != nil {
		return nil, resp, err
	}

	return record, resp, nil
}

// DeleteMultiple marks multiple product fields as deleted.
//
// Pipedrive API docs: https://developers.pipedrive.com/docs/api/v1/#!/ProductFields/delete_productFields
func (s *ProductFieldsService) DeleteMultiple(ctx context.Context, ids []int) (*Response, error) {
	req, err := s.client.NewRequest(http.MethodDelete, "/productFields", &DeleteMultipleOptions{
		Ids: arrayToString(ids, ","),
	}, nil)

	if err != nil {
		return nil, err
	}

	return s.client.Do(ctx, req, nil)
}

// Delete marks a specific product field as deleted.
//
// Pipedrive API docs: https://developers.pipedrive.com/docs/api/v1/#!/ProductFields/delete_productFields_id
func (s *ProductFieldsService) Delete(ctx context.Context, id int) (*Response, error) {
	uri := fmt.Sprintf("/productFields/%v", id)
	req, err := s.client.NewRequest(http.MethodDelete, uri, nil, nil)

	if err != nil {
		return nil, err
	}

	return s.client.Do(ctx, req, nil)
}