github.com/twilio/twilio-go@v1.20.1/rest/intelligence/v2/services.go

/*
 * This code was generated by
 * ___ _ _ _ _ _    _ ____    ____ ____ _    ____ ____ _  _ ____ ____ ____ ___ __   __
 *  |  | | | | |    | |  | __ |  | |__| | __ | __ |___ |\ | |___ |__/ |__|  | |  | |__/
 *  |  |_|_| | |___ | |__|    |__| |  | |    |__] |___ | \| |___ |  \ |  |  | |__| |  \
 *
 * Twilio - Intelligence
 * This is the public Twilio REST API.
 *
 * NOTE: This class is auto generated by OpenAPI Generator.
 * https://openapi-generator.tech
 * Do not edit the class manually.
 */

package openapi

import (
	"encoding/json"
	"fmt"
	"net/url"
	"strings"

	"github.com/twilio/twilio-go/client"
)

// Optional parameters for the method 'CreateService'
type CreateServiceParams struct {
	// Provides a unique and addressable name to be assigned to this Service, assigned by the developer, to be optionally used in addition to SID.
	UniqueName *string `json:"UniqueName,omitempty"`
	// Instructs the Speech Recognition service to automatically transcribe all recordings made on the account.
	AutoTranscribe *bool `json:"AutoTranscribe,omitempty"`
	// Data logging allows Twilio to improve the quality of the speech recognition & language understanding services through using customer data to refine, fine tune and evaluate machine learning models. Note: Data logging cannot be activated via API, only via www.twilio.com, as it requires additional consent.
	DataLogging *bool `json:"DataLogging,omitempty"`
	// A human readable description of this resource, up to 64 characters.
	FriendlyName *string `json:"FriendlyName,omitempty"`
	// The default language code of the audio.
	LanguageCode *string `json:"LanguageCode,omitempty"`
	// Instructs the Speech Recognition service to automatically redact PII from all transcripts made on this service.
	AutoRedaction *bool `json:"AutoRedaction,omitempty"`
	// Instructs the Speech Recognition service to automatically redact PII from all transcripts media made on this service. The auto_redaction flag must be enabled, results in error otherwise.
	MediaRedaction *bool `json:"MediaRedaction,omitempty"`
	// The URL Twilio will request when executing the Webhook.
	WebhookUrl *string `json:"WebhookUrl,omitempty"`
	//
	WebhookHttpMethod *string `json:"WebhookHttpMethod,omitempty"`
}

func (params *CreateServiceParams) SetUniqueName(UniqueName string) *CreateServiceParams {
	params.UniqueName = &UniqueName
	return params
}
func (params *CreateServiceParams) SetAutoTranscribe(AutoTranscribe bool) *CreateServiceParams {
	params.AutoTranscribe = &AutoTranscribe
	return params
}
func (params *CreateServiceParams) SetDataLogging(DataLogging bool) *CreateServiceParams {
	params.DataLogging = &DataLogging
	return params
}
func (params *CreateServiceParams) SetFriendlyName(FriendlyName string) *CreateServiceParams {
	params.FriendlyName = &FriendlyName
	return params
}
func (params *CreateServiceParams) SetLanguageCode(LanguageCode string) *CreateServiceParams {
	params.LanguageCode = &LanguageCode
	return params
}
func (params *CreateServiceParams) SetAutoRedaction(AutoRedaction bool) *CreateServiceParams {
	params.AutoRedaction = &AutoRedaction
	return params
}
func (params *CreateServiceParams) SetMediaRedaction(MediaRedaction bool) *CreateServiceParams {
	params.MediaRedaction = &MediaRedaction
	return params
}
func (params *CreateServiceParams) SetWebhookUrl(WebhookUrl string) *CreateServiceParams {
	params.WebhookUrl = &WebhookUrl
	return params
}
func (params *CreateServiceParams) SetWebhookHttpMethod(WebhookHttpMethod string) *CreateServiceParams {
	params.WebhookHttpMethod = &WebhookHttpMethod
	return params
}

// Create a new Service for the given Account
func (c *ApiService) CreateService(params *CreateServiceParams) (*IntelligenceV2Service, error) {
	path := "/v2/Services"

	data := url.Values{}
	headers := make(map[string]interface{})

	if params != nil && params.UniqueName != nil {
		data.Set("UniqueName", *params.UniqueName)
	}
	if params != nil && params.AutoTranscribe != nil {
		data.Set("AutoTranscribe", fmt.Sprint(*params.AutoTranscribe))
	}
	if params != nil && params.DataLogging != nil {
		data.Set("DataLogging", fmt.Sprint(*params.DataLogging))
	}
	if params != nil && params.FriendlyName != nil {
		data.Set("FriendlyName", *params.FriendlyName)
	}
	if params != nil && params.LanguageCode != nil {
		data.Set("LanguageCode", *params.LanguageCode)
	}
	if params != nil && params.AutoRedaction != nil {
		data.Set("AutoRedaction", fmt.Sprint(*params.AutoRedaction))
	}
	if params != nil && params.MediaRedaction != nil {
		data.Set("MediaRedaction", fmt.Sprint(*params.MediaRedaction))
	}
	if params != nil && params.WebhookUrl != nil {
		data.Set("WebhookUrl", *params.WebhookUrl)
	}
	if params != nil && params.WebhookHttpMethod != nil {
		data.Set("WebhookHttpMethod", *params.WebhookHttpMethod)
	}

	resp, err := c.requestHandler.Post(c.baseURL+path, data, headers)
	if err != nil {
		return nil, err
	}

	defer resp.Body.Close()

	ps := &IntelligenceV2Service{}
	if err := json.NewDecoder(resp.Body).Decode(ps); err != nil {
		return nil, err
	}

	return ps, err
}

// Delete a specific Service.
func (c *ApiService) DeleteService(Sid string) error {
	path := "/v2/Services/{Sid}"
	path = strings.Replace(path, "{"+"Sid"+"}", Sid, -1)

	data := url.Values{}
	headers := make(map[string]interface{})

	resp, err := c.requestHandler.Delete(c.baseURL+path, data, headers)
	if err != nil {
		return err
	}

	defer resp.Body.Close()

	return nil
}

// Fetch a specific Service.
func (c *ApiService) FetchService(Sid string) (*IntelligenceV2Service, error) {
	path := "/v2/Services/{Sid}"
	path = strings.Replace(path, "{"+"Sid"+"}", Sid, -1)

	data := url.Values{}
	headers := make(map[string]interface{})

	resp, err := c.requestHandler.Get(c.baseURL+path, data, headers)
	if err != nil {
		return nil, err
	}

	defer resp.Body.Close()

	ps := &IntelligenceV2Service{}
	if err := json.NewDecoder(resp.Body).Decode(ps); err != nil {
		return nil, err
	}

	return ps, err
}

// Optional parameters for the method 'ListService'
type ListServiceParams struct {
	// How many resources to return in each list page. The default is 50, and the maximum is 1000.
	PageSize *int `json:"PageSize,omitempty"`
	// Max number of records to return.
	Limit *int `json:"limit,omitempty"`
}

func (params *ListServiceParams) SetPageSize(PageSize int) *ListServiceParams {
	params.PageSize = &PageSize
	return params
}
func (params *ListServiceParams) SetLimit(Limit int) *ListServiceParams {
	params.Limit = &Limit
	return params
}

// Retrieve a single page of Service records from the API. Request is executed immediately.
func (c *ApiService) PageService(params *ListServiceParams, pageToken, pageNumber string) (*ListServiceResponse, error) {
	path := "/v2/Services"

	data := url.Values{}
	headers := make(map[string]interface{})

	if params != nil && params.PageSize != nil {
		data.Set("PageSize", fmt.Sprint(*params.PageSize))
	}

	if pageToken != "" {
		data.Set("PageToken", pageToken)
	}
	if pageNumber != "" {
		data.Set("Page", pageNumber)
	}

	resp, err := c.requestHandler.Get(c.baseURL+path, data, headers)
	if err != nil {
		return nil, err
	}

	defer resp.Body.Close()

	ps := &ListServiceResponse{}
	if err := json.NewDecoder(resp.Body).Decode(ps); err != nil {
		return nil, err
	}

	return ps, err
}

// Lists Service records from the API as a list. Unlike stream, this operation is eager and loads 'limit' records into memory before returning.
func (c *ApiService) ListService(params *ListServiceParams) ([]IntelligenceV2Service, error) {
	response, errors := c.StreamService(params)

	records := make([]IntelligenceV2Service, 0)
	for record := range response {
		records = append(records, record)
	}

	if err := <-errors; err != nil {
		return nil, err
	}

	return records, nil
}

// Streams Service records from the API as a channel stream. This operation lazily loads records as efficiently as possible until the limit is reached.
func (c *ApiService) StreamService(params *ListServiceParams) (chan IntelligenceV2Service, chan error) {
	if params == nil {
		params = &ListServiceParams{}
	}
	params.SetPageSize(client.ReadLimits(params.PageSize, params.Limit))

	recordChannel := make(chan IntelligenceV2Service, 1)
	errorChannel := make(chan error, 1)

	response, err := c.PageService(params, "", "")
	if err != nil {
		errorChannel <- err
		close(recordChannel)
		close(errorChannel)
	} else {
		go c.streamService(response, params, recordChannel, errorChannel)
	}

	return recordChannel, errorChannel
}

func (c *ApiService) streamService(response *ListServiceResponse, params *ListServiceParams, recordChannel chan IntelligenceV2Service, errorChannel chan error) {
	curRecord := 1

	for response != nil {
		responseRecords := response.Services
		for item := range responseRecords {
			recordChannel <- responseRecords[item]
			curRecord += 1
			if params.Limit != nil && *params.Limit < curRecord {
				close(recordChannel)
				close(errorChannel)
				return
			}
		}

		record, err := client.GetNext(c.baseURL, response, c.getNextListServiceResponse)
		if err != nil {
			errorChannel <- err
			break
		} else if record == nil {
			break
		}

		response = record.(*ListServiceResponse)
	}

	close(recordChannel)
	close(errorChannel)
}

func (c *ApiService) getNextListServiceResponse(nextPageUrl string) (interface{}, error) {
	if nextPageUrl == "" {
		return nil, nil
	}
	resp, err := c.requestHandler.Get(nextPageUrl, nil, nil)
	if err != nil {
		return nil, err
	}

	defer resp.Body.Close()

	ps := &ListServiceResponse{}
	if err := json.NewDecoder(resp.Body).Decode(ps); err != nil {
		return nil, err
	}
	return ps, nil
}

// Optional parameters for the method 'UpdateService'
type UpdateServiceParams struct {
	// The If-Match HTTP request header
	IfMatch *string `json:"If-Match,omitempty"`
	// Instructs the Speech Recognition service to automatically transcribe all recordings made on the account.
	AutoTranscribe *bool `json:"AutoTranscribe,omitempty"`
	// Data logging allows Twilio to improve the quality of the speech recognition & language understanding services through using customer data to refine, fine tune and evaluate machine learning models. Note: Data logging cannot be activated via API, only via www.twilio.com, as it requires additional consent.
	DataLogging *bool `json:"DataLogging,omitempty"`
	// A human readable description of this resource, up to 64 characters.
	FriendlyName *string `json:"FriendlyName,omitempty"`
	// The default language code of the audio.
	LanguageCode *string `json:"LanguageCode,omitempty"`
	// Provides a unique and addressable name to be assigned to this Service, assigned by the developer, to be optionally used in addition to SID.
	UniqueName *string `json:"UniqueName,omitempty"`
	// Instructs the Speech Recognition service to automatically redact PII from all transcripts made on this service.
	AutoRedaction *bool `json:"AutoRedaction,omitempty"`
	// Instructs the Speech Recognition service to automatically redact PII from all transcripts media made on this service. The auto_redaction flag must be enabled, results in error otherwise.
	MediaRedaction *bool `json:"MediaRedaction,omitempty"`
	// The URL Twilio will request when executing the Webhook.
	WebhookUrl *string `json:"WebhookUrl,omitempty"`
	//
	WebhookHttpMethod *string `json:"WebhookHttpMethod,omitempty"`
}

func (params *UpdateServiceParams) SetIfMatch(IfMatch string) *UpdateServiceParams {
	params.IfMatch = &IfMatch
	return params
}
func (params *UpdateServiceParams) SetAutoTranscribe(AutoTranscribe bool) *UpdateServiceParams {
	params.AutoTranscribe = &AutoTranscribe
	return params
}
func (params *UpdateServiceParams) SetDataLogging(DataLogging bool) *UpdateServiceParams {
	params.DataLogging = &DataLogging
	return params
}
func (params *UpdateServiceParams) SetFriendlyName(FriendlyName string) *UpdateServiceParams {
	params.FriendlyName = &FriendlyName
	return params
}
func (params *UpdateServiceParams) SetLanguageCode(LanguageCode string) *UpdateServiceParams {
	params.LanguageCode = &LanguageCode
	return params
}
func (params *UpdateServiceParams) SetUniqueName(UniqueName string) *UpdateServiceParams {
	params.UniqueName = &UniqueName
	return params
}
func (params *UpdateServiceParams) SetAutoRedaction(AutoRedaction bool) *UpdateServiceParams {
	params.AutoRedaction = &AutoRedaction
	return params
}
func (params *UpdateServiceParams) SetMediaRedaction(MediaRedaction bool) *UpdateServiceParams {
	params.MediaRedaction = &MediaRedaction
	return params
}
func (params *UpdateServiceParams) SetWebhookUrl(WebhookUrl string) *UpdateServiceParams {
	params.WebhookUrl = &WebhookUrl
	return params
}
func (params *UpdateServiceParams) SetWebhookHttpMethod(WebhookHttpMethod string) *UpdateServiceParams {
	params.WebhookHttpMethod = &WebhookHttpMethod
	return params
}

// Update a specific Service.
func (c *ApiService) UpdateService(Sid string, params *UpdateServiceParams) (*IntelligenceV2Service, error) {
	path := "/v2/Services/{Sid}"
	path = strings.Replace(path, "{"+"Sid"+"}", Sid, -1)

	data := url.Values{}
	headers := make(map[string]interface{})

	if params != nil && params.AutoTranscribe != nil {
		data.Set("AutoTranscribe", fmt.Sprint(*params.AutoTranscribe))
	}
	if params != nil && params.DataLogging != nil {
		data.Set("DataLogging", fmt.Sprint(*params.DataLogging))
	}
	if params != nil && params.FriendlyName != nil {
		data.Set("FriendlyName", *params.FriendlyName)
	}
	if params != nil && params.LanguageCode != nil {
		data.Set("LanguageCode", *params.LanguageCode)
	}
	if params != nil && params.UniqueName != nil {
		data.Set("UniqueName", *params.UniqueName)
	}
	if params != nil && params.AutoRedaction != nil {
		data.Set("AutoRedaction", fmt.Sprint(*params.AutoRedaction))
	}
	if params != nil && params.MediaRedaction != nil {
		data.Set("MediaRedaction", fmt.Sprint(*params.MediaRedaction))
	}
	if params != nil && params.WebhookUrl != nil {
		data.Set("WebhookUrl", *params.WebhookUrl)
	}
	if params != nil && params.WebhookHttpMethod != nil {
		data.Set("WebhookHttpMethod", *params.WebhookHttpMethod)
	}

	if params != nil && params.IfMatch != nil {
		headers["If-Match"] = *params.IfMatch
	}
	resp, err := c.requestHandler.Post(c.baseURL+path, data, headers)
	if err != nil {
		return nil, err
	}

	defer resp.Body.Close()

	ps := &IntelligenceV2Service{}
	if err := json.NewDecoder(resp.Body).Decode(ps); err != nil {
		return nil, err
	}

	return ps, err
}