Class: Twilio::REST::Preview::Understand::AssistantContext::FieldTypeList

Inherits:
ListResource
  • Object
show all
Defined in:
lib/twilio-ruby/rest/preview/understand/assistant/field_type.rb

Overview

PLEASE NOTE that this class contains preview products that are subject to change. Use them with caution. If you currently do not have developer preview access, please contact [email protected]

Instance Method Summary collapse

Constructor Details

#initialize(version, assistant_sid: nil) ⇒ FieldTypeList

Initialize the FieldTypeList

Parameters:

  • version (Version)

    Version that contains the resource

  • assistant_sid (String) (defaults to: nil)

    The unique ID of the Assistant.


22
23
24
25
26
27
28
# File 'lib/twilio-ruby/rest/preview/understand/assistant/field_type.rb', line 22

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

  # Path Solution
  @solution = {assistant_sid: assistant_sid}
  @uri = "/Assistants/#{@solution[:assistant_sid]}/FieldTypes"
end

Instance Method Details

#create(unique_name: nil, friendly_name: :unset) ⇒ FieldTypeInstance

Create the FieldTypeInstance

Parameters:

  • unique_name (String) (defaults to: nil)

    A user-provided string that uniquely identifies this resource as an alternative to the sid. Unique up to 64 characters long.

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

    A user-provided string that identifies this resource. It is non-unique and can up to 255 characters long.

Returns:


117
118
119
120
121
122
123
# File 'lib/twilio-ruby/rest/preview/understand/assistant/field_type.rb', line 117

def create(unique_name: nil, friendly_name: :unset)
  data = Twilio::Values.of({'UniqueName' => unique_name, 'FriendlyName' => friendly_name, })

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

  FieldTypeInstance.new(@version, payload, assistant_sid: @solution[:assistant_sid], )
end

#eachObject

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


68
69
70
71
72
73
74
75
76
# File 'lib/twilio-ruby/rest/preview/understand/assistant/field_type.rb', line 68

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 FieldTypeInstance records from the API. Request is executed immediately.

Parameters:

  • target_url (String)

    API-generated URL for the requested results page

Returns:

  • (Page)

    Page of FieldTypeInstance


102
103
104
105
106
107
108
# File 'lib/twilio-ruby/rest/preview/understand/assistant/field_type.rb', line 102

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

#list(limit: nil, page_size: nil) ⇒ Array

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

Parameters:

  • 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


41
42
43
# File 'lib/twilio-ruby/rest/preview/understand/assistant/field_type.rb', line 41

def list(limit: nil, page_size: nil)
  self.stream(limit: limit, page_size: page_size).entries
end

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

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

Parameters:

  • 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 FieldTypeInstance


85
86
87
88
89
90
91
92
93
94
95
# File 'lib/twilio-ruby/rest/preview/understand/assistant/field_type.rb', line 85

def page(page_token: :unset, page_number: :unset, page_size: :unset)
  params = Twilio::Values.of({
      'PageToken' => page_token,
      'Page' => page_number,
      'PageSize' => page_size,
  })

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

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

#stream(limit: nil, page_size: nil) ⇒ Enumerable

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

Parameters:

  • 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


56
57
58
59
60
61
62
# File 'lib/twilio-ruby/rest/preview/understand/assistant/field_type.rb', line 56

def stream(limit: nil, page_size: nil)
  limits = @version.read_limits(limit, page_size)

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

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

#to_sObject

Provide a user friendly representation


127
128
129
# File 'lib/twilio-ruby/rest/preview/understand/assistant/field_type.rb', line 127

def to_s
  '#<Twilio.Preview.Understand.FieldTypeList>'
end