github.com/twilio/twilio-go@v1.20.1/rest/conversations/v1/services_conversations_messages_receipts.go (about)

     1  /*
     2   * This code was generated by
     3   * ___ _ _ _ _ _    _ ____    ____ ____ _    ____ ____ _  _ ____ ____ ____ ___ __   __
     4   *  |  | | | | |    | |  | __ |  | |__| | __ | __ |___ |\ | |___ |__/ |__|  | |  | |__/
     5   *  |  |_|_| | |___ | |__|    |__| |  | |    |__] |___ | \| |___ |  \ |  |  | |__| |  \
     6   *
     7   * Twilio - Conversations
     8   * This is the public Twilio REST API.
     9   *
    10   * NOTE: This class is auto generated by OpenAPI Generator.
    11   * https://openapi-generator.tech
    12   * Do not edit the class manually.
    13   */
    14  
    15  package openapi
    16  
    17  import (
    18  	"encoding/json"
    19  	"fmt"
    20  	"net/url"
    21  	"strings"
    22  
    23  	"github.com/twilio/twilio-go/client"
    24  )
    25  
    26  // Fetch the delivery and read receipts of the conversation message
    27  func (c *ApiService) FetchServiceConversationMessageReceipt(ChatServiceSid string, ConversationSid string, MessageSid string, Sid string) (*ConversationsV1ServiceConversationMessageReceipt, error) {
    28  	path := "/v1/Services/{ChatServiceSid}/Conversations/{ConversationSid}/Messages/{MessageSid}/Receipts/{Sid}"
    29  	path = strings.Replace(path, "{"+"ChatServiceSid"+"}", ChatServiceSid, -1)
    30  	path = strings.Replace(path, "{"+"ConversationSid"+"}", ConversationSid, -1)
    31  	path = strings.Replace(path, "{"+"MessageSid"+"}", MessageSid, -1)
    32  	path = strings.Replace(path, "{"+"Sid"+"}", Sid, -1)
    33  
    34  	data := url.Values{}
    35  	headers := make(map[string]interface{})
    36  
    37  	resp, err := c.requestHandler.Get(c.baseURL+path, data, headers)
    38  	if err != nil {
    39  		return nil, err
    40  	}
    41  
    42  	defer resp.Body.Close()
    43  
    44  	ps := &ConversationsV1ServiceConversationMessageReceipt{}
    45  	if err := json.NewDecoder(resp.Body).Decode(ps); err != nil {
    46  		return nil, err
    47  	}
    48  
    49  	return ps, err
    50  }
    51  
    52  // Optional parameters for the method 'ListServiceConversationMessageReceipt'
    53  type ListServiceConversationMessageReceiptParams struct {
    54  	// How many resources to return in each list page. The default is 50, and the maximum is 1000.
    55  	PageSize *int `json:"PageSize,omitempty"`
    56  	// Max number of records to return.
    57  	Limit *int `json:"limit,omitempty"`
    58  }
    59  
    60  func (params *ListServiceConversationMessageReceiptParams) SetPageSize(PageSize int) *ListServiceConversationMessageReceiptParams {
    61  	params.PageSize = &PageSize
    62  	return params
    63  }
    64  func (params *ListServiceConversationMessageReceiptParams) SetLimit(Limit int) *ListServiceConversationMessageReceiptParams {
    65  	params.Limit = &Limit
    66  	return params
    67  }
    68  
    69  // Retrieve a single page of ServiceConversationMessageReceipt records from the API. Request is executed immediately.
    70  func (c *ApiService) PageServiceConversationMessageReceipt(ChatServiceSid string, ConversationSid string, MessageSid string, params *ListServiceConversationMessageReceiptParams, pageToken, pageNumber string) (*ListServiceConversationMessageReceiptResponse, error) {
    71  	path := "/v1/Services/{ChatServiceSid}/Conversations/{ConversationSid}/Messages/{MessageSid}/Receipts"
    72  
    73  	path = strings.Replace(path, "{"+"ChatServiceSid"+"}", ChatServiceSid, -1)
    74  	path = strings.Replace(path, "{"+"ConversationSid"+"}", ConversationSid, -1)
    75  	path = strings.Replace(path, "{"+"MessageSid"+"}", MessageSid, -1)
    76  
    77  	data := url.Values{}
    78  	headers := make(map[string]interface{})
    79  
    80  	if params != nil && params.PageSize != nil {
    81  		data.Set("PageSize", fmt.Sprint(*params.PageSize))
    82  	}
    83  
    84  	if pageToken != "" {
    85  		data.Set("PageToken", pageToken)
    86  	}
    87  	if pageNumber != "" {
    88  		data.Set("Page", pageNumber)
    89  	}
    90  
    91  	resp, err := c.requestHandler.Get(c.baseURL+path, data, headers)
    92  	if err != nil {
    93  		return nil, err
    94  	}
    95  
    96  	defer resp.Body.Close()
    97  
    98  	ps := &ListServiceConversationMessageReceiptResponse{}
    99  	if err := json.NewDecoder(resp.Body).Decode(ps); err != nil {
   100  		return nil, err
   101  	}
   102  
   103  	return ps, err
   104  }
   105  
   106  // Lists ServiceConversationMessageReceipt records from the API as a list. Unlike stream, this operation is eager and loads 'limit' records into memory before returning.
   107  func (c *ApiService) ListServiceConversationMessageReceipt(ChatServiceSid string, ConversationSid string, MessageSid string, params *ListServiceConversationMessageReceiptParams) ([]ConversationsV1ServiceConversationMessageReceipt, error) {
   108  	response, errors := c.StreamServiceConversationMessageReceipt(ChatServiceSid, ConversationSid, MessageSid, params)
   109  
   110  	records := make([]ConversationsV1ServiceConversationMessageReceipt, 0)
   111  	for record := range response {
   112  		records = append(records, record)
   113  	}
   114  
   115  	if err := <-errors; err != nil {
   116  		return nil, err
   117  	}
   118  
   119  	return records, nil
   120  }
   121  
   122  // Streams ServiceConversationMessageReceipt records from the API as a channel stream. This operation lazily loads records as efficiently as possible until the limit is reached.
   123  func (c *ApiService) StreamServiceConversationMessageReceipt(ChatServiceSid string, ConversationSid string, MessageSid string, params *ListServiceConversationMessageReceiptParams) (chan ConversationsV1ServiceConversationMessageReceipt, chan error) {
   124  	if params == nil {
   125  		params = &ListServiceConversationMessageReceiptParams{}
   126  	}
   127  	params.SetPageSize(client.ReadLimits(params.PageSize, params.Limit))
   128  
   129  	recordChannel := make(chan ConversationsV1ServiceConversationMessageReceipt, 1)
   130  	errorChannel := make(chan error, 1)
   131  
   132  	response, err := c.PageServiceConversationMessageReceipt(ChatServiceSid, ConversationSid, MessageSid, params, "", "")
   133  	if err != nil {
   134  		errorChannel <- err
   135  		close(recordChannel)
   136  		close(errorChannel)
   137  	} else {
   138  		go c.streamServiceConversationMessageReceipt(response, params, recordChannel, errorChannel)
   139  	}
   140  
   141  	return recordChannel, errorChannel
   142  }
   143  
   144  func (c *ApiService) streamServiceConversationMessageReceipt(response *ListServiceConversationMessageReceiptResponse, params *ListServiceConversationMessageReceiptParams, recordChannel chan ConversationsV1ServiceConversationMessageReceipt, errorChannel chan error) {
   145  	curRecord := 1
   146  
   147  	for response != nil {
   148  		responseRecords := response.DeliveryReceipts
   149  		for item := range responseRecords {
   150  			recordChannel <- responseRecords[item]
   151  			curRecord += 1
   152  			if params.Limit != nil && *params.Limit < curRecord {
   153  				close(recordChannel)
   154  				close(errorChannel)
   155  				return
   156  			}
   157  		}
   158  
   159  		record, err := client.GetNext(c.baseURL, response, c.getNextListServiceConversationMessageReceiptResponse)
   160  		if err != nil {
   161  			errorChannel <- err
   162  			break
   163  		} else if record == nil {
   164  			break
   165  		}
   166  
   167  		response = record.(*ListServiceConversationMessageReceiptResponse)
   168  	}
   169  
   170  	close(recordChannel)
   171  	close(errorChannel)
   172  }
   173  
   174  func (c *ApiService) getNextListServiceConversationMessageReceiptResponse(nextPageUrl string) (interface{}, error) {
   175  	if nextPageUrl == "" {
   176  		return nil, nil
   177  	}
   178  	resp, err := c.requestHandler.Get(nextPageUrl, nil, nil)
   179  	if err != nil {
   180  		return nil, err
   181  	}
   182  
   183  	defer resp.Body.Close()
   184  
   185  	ps := &ListServiceConversationMessageReceiptResponse{}
   186  	if err := json.NewDecoder(resp.Body).Decode(ps); err != nil {
   187  		return nil, err
   188  	}
   189  	return ps, nil
   190  }