Class: Twilio::REST::Conversations::V1::ServiceContext::ConversationList

Inherits:
ListResource
  • Object
show all
Defined in:
lib/twilio-ruby/rest/conversations/v1/service/conversation.rb

Instance Method Summary collapse

Constructor Details

#initialize(version, chat_service_sid: nil) ⇒ ConversationList

Initialize the ConversationList

Parameters:

  • version (Version) —

    Version that contains the resource

  • chat_service_sid (String) (defaults to: nil) —

    The unique ID of the Conversation Service this conversation belongs to.



22
23
24
25
26
27
28
 
# File 'lib/twilio-ruby/rest/conversations/v1/service/conversation.rb', line 22

def initialize(version, chat_service_sid: nil)
  super(version)

  # Path Solution
  @solution = {chat_service_sid: chat_service_sid}
  @uri = "/Services/#{@solution[:chat_service_sid]}/Conversations"
end

Instance Method Details

#create(friendly_name: :unset, unique_name: :unset, attributes: :unset, messaging_service_sid: :unset, date_created: :unset, date_updated: :unset, state: :unset, timers_inactive: :unset, timers_closed: :unset, x_twilio_webhook_enabled: :unset) ⇒ ConversationInstance

Create the ConversationInstance

Parameters:

  • friendly_name (String) (defaults to: :unset) —

    The human-readable name of this conversation, limited to 256 characters. Optional.

  • unique_name (String) (defaults to: :unset) —

    An application-defined string that uniquely identifies the resource. It can be used to address the resource in place of the resource’s ‘sid` in the URL.

  • attributes (String) (defaults to: :unset) —

    An optional string metadata field you can use to store any data you wish. The string value must contain structurally valid JSON if specified. Note that if the attributes are not set “{}” will be returned.

  • messaging_service_sid (String) (defaults to: :unset) —

    The unique ID of the Messaging Service this conversation belongs to.

  • date_created (Time) (defaults to: :unset) —

    The date that this resource was created.

  • date_updated (Time) (defaults to: :unset) —

    The date that this resource was last updated.

  • state (conversation.State) (defaults to: :unset) —

    Current state of this conversation. Can be either ‘active`, `inactive` or `closed` and defaults to `active`

  • timers_inactive (String) (defaults to: :unset) —

    ISO8601 duration when conversation will be switched to ‘inactive` state. Minimum value for this timer is 1 minute.

  • timers_closed (String) (defaults to: :unset) —

    ISO8601 duration when conversation will be switched to ‘closed` state. Minimum value for this timer is 10 minutes.

  • x_twilio_webhook_enabled (conversation.WebhookEnabledType) (defaults to: :unset) —

    The X-Twilio-Webhook-Enabled HTTP request header

Returns:



55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
 
# File 'lib/twilio-ruby/rest/conversations/v1/service/conversation.rb', line 55

def create(friendly_name: :unset, unique_name: :unset, attributes: :unset, messaging_service_sid: :unset, date_created: :unset, date_updated: :unset, state: :unset, timers_inactive: :unset, timers_closed: :unset, x_twilio_webhook_enabled: :unset)
  data = Twilio::Values.of({
      'FriendlyName' => friendly_name,
      'UniqueName' => unique_name,
      'Attributes' => attributes,
      'MessagingServiceSid' => messaging_service_sid,
      'DateCreated' => Twilio.serialize_iso8601_datetime(date_created),
      'DateUpdated' => Twilio.serialize_iso8601_datetime(date_updated),
      'State' => state,
      'Timers.Inactive' => timers_inactive,
      'Timers.Closed' => timers_closed,
  })
  headers = Twilio::Values.of({'X-Twilio-Webhook-Enabled' => x_twilio_webhook_enabled, })

  payload = @version.create('POST', @uri, data: data, headers: headers)

  ConversationInstance.new(@version, payload, chat_service_sid: @solution[:chat_service_sid], )
end

#each ⇒ Object

When passed a block, yields ConversationInstance records from the API. This operation lazily loads records as efficiently as possible until the limit is reached.



135
136
137
138
139
140
141
142
143
 
# File 'lib/twilio-ruby/rest/conversations/v1/service/conversation.rb', line 135

def each
  limits = @version.read_limits

  page = self.page(page_size: limits[:page_size], )

  @version.stream(page,
                  limit: limits[:limit],
                  page_limit: limits[:page_limit]).each {|x| yield x}
end

#get_page(target_url) ⇒ Page

Retrieve a single page of ConversationInstance records from the API. Request is executed immediately.

Parameters:

  • target_url (String) —

    API-generated URL for the requested results page

Returns:

  • (Page) —

    Page of ConversationInstance



178
179
180
181
182
183
184
 
# File 'lib/twilio-ruby/rest/conversations/v1/service/conversation.rb', line 178

def get_page(target_url)
  response = @version.domain.request(
      'GET',
      target_url
  )
  ConversationPage.new(@version, response, @solution)
end

#list(start_date: :unset, end_date: :unset, state: :unset, limit: nil, page_size: nil) ⇒ Array

Lists ConversationInstance records from the API as a list. Unlike stream(), this operation is eager and will load ‘limit` records into memory before returning.

Parameters:

  • start_date (String) (defaults to: :unset) —

    Start date in ISO8601 format for sorting and filtering list of Conversations.

  • end_date (String) (defaults to: :unset) —

    End date in ISO8601 format for sorting and filtering list of Conversations.

  • state (conversation.State) (defaults to: :unset) —

    State for sorting and filtering list of Conversations. Can be ‘active`, `inactive` or `closed`

  • limit (Integer) (defaults to: nil) —

    Upper limit for the number of records to return. stream() guarantees to never return more than limit. Default is no limit

  • page_size (Integer) (defaults to: nil) —

    Number of records to fetch per request, when not set will use the default value of 50 records. If no page_size is defined but a limit is defined, stream() will attempt to read the limit with the most efficient page size, i.e. min(limit, 1000)

Returns:

  • (Array) —

    Array of up to limit results



91
92
93
94
95
96
97
98
99
 
# File 'lib/twilio-ruby/rest/conversations/v1/service/conversation.rb', line 91

def list(start_date: :unset, end_date: :unset, state: :unset, limit: nil, page_size: nil)
  self.stream(
      start_date: start_date,
      end_date: end_date,
      state: state,
      limit: limit,
      page_size: page_size
  ).entries
end

#page(start_date: :unset, end_date: :unset, state: :unset, page_token: :unset, page_number: :unset, page_size: :unset) ⇒ Page

Retrieve a single page of ConversationInstance records from the API. Request is executed immediately.

Parameters:

  • start_date (String) (defaults to: :unset) —

    Start date in ISO8601 format for sorting and filtering list of Conversations.

  • end_date (String) (defaults to: :unset) —

    End date in ISO8601 format for sorting and filtering list of Conversations.

  • state (conversation.State) (defaults to: :unset) —

    State for sorting and filtering list of Conversations. Can be ‘active`, `inactive` or `closed`

  • page_token (String) (defaults to: :unset) —

    PageToken provided by the API

  • page_number (Integer) (defaults to: :unset) —

    Page Number, this value is simply for client state

  • page_size (Integer) (defaults to: :unset) —

    Number of records to return, defaults to 50

Returns:

  • (Page) —

    Page of ConversationInstance



158
159
160
161
162
163
164
165
166
167
168
169
170
171
 
# File 'lib/twilio-ruby/rest/conversations/v1/service/conversation.rb', line 158

def page(start_date: :unset, end_date: :unset, state: :unset, page_token: :unset, page_number: :unset, page_size: :unset)
  params = Twilio::Values.of({
      'StartDate' => start_date,
      'EndDate' => end_date,
      'State' => state,
      'PageToken' => page_token,
      'Page' => page_number,
      'PageSize' => page_size,
  })

  response = @version.page('GET', @uri, params: params)

  ConversationPage.new(@version, response, @solution)
end

#stream(start_date: :unset, end_date: :unset, state: :unset, limit: nil, page_size: nil) ⇒ Enumerable

Streams ConversationInstance records from the API as an Enumerable. This operation lazily loads records as efficiently as possible until the limit is reached.

Parameters:

  • start_date (String) (defaults to: :unset) —

    Start date in ISO8601 format for sorting and filtering list of Conversations.

  • end_date (String) (defaults to: :unset) —

    End date in ISO8601 format for sorting and filtering list of Conversations.

  • state (conversation.State) (defaults to: :unset) —

    State for sorting and filtering list of Conversations. Can be ‘active`, `inactive` or `closed`

  • limit (Integer) (defaults to: nil) —

    Upper limit for the number of records to return. stream() guarantees to never return more than limit. Default is no limit.

  • page_size (Integer) (defaults to: nil) —

    Number of records to fetch per request, when not set will use the default value of 50 records. If no page_size is defined but a limit is defined, stream() will attempt to read the limit with the most efficient page size, i.e. min(limit, 1000)

Returns:

  • (Enumerable) —

    Enumerable that will yield up to limit results



118
119
120
121
122
123
124
125
126
127
128
129
 
# File 'lib/twilio-ruby/rest/conversations/v1/service/conversation.rb', line 118

def stream(start_date: :unset, end_date: :unset, state: :unset, limit: nil, page_size: nil)
  limits = @version.read_limits(limit, page_size)

  page = self.page(
      start_date: start_date,
      end_date: end_date,
      state: state,
      page_size: limits[:page_size],
  )

  @version.stream(page, limit: limits[:limit], page_limit: limits[:page_limit])
end

#to_s ⇒ Object

Provide a user friendly representation



188
189
190
 
# File 'lib/twilio-ruby/rest/conversations/v1/service/conversation.rb', line 188

def to_s
  '#<Twilio.Conversations.V1.ConversationList>'
end