Class: Twilio::REST::Studio::V2::FlowList

Inherits:
ListResource show all
Defined in:
lib/twilio-ruby/rest/studio/v2/flow.rb

Overview

PLEASE NOTE that this class contains beta products that are subject to change. Use them with caution.

Instance Method Summary collapse

Constructor Details

#initialize(version) ⇒ FlowList

Initialize the FlowList

Parameters:

  • version (Version) —

    Version that contains the resource



20
21
22
23
24
25
26
 
# File 'lib/twilio-ruby/rest/studio/v2/flow.rb', line 20

def initialize(version)
  super(version)

  # Path Solution
  @solution = {}
  @uri = "/Flows"
end

Instance Method Details

#create(friendly_name: nil, status: nil, definition: nil, commit_message: :unset) ⇒ FlowInstance

Create the FlowInstance

Parameters:

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

    The string that you assigned to describe the Flow.

  • status (flow.Status) (defaults to: nil) —

    The status of the Flow. Can be: ‘draft` or `published`.

  • definition (Hash) (defaults to: nil) —

    JSON representation of flow definition.

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

    Description on change made in the revision.

Returns:



36
37
38
39
40
41
42
43
44
45
46
47
 
# File 'lib/twilio-ruby/rest/studio/v2/flow.rb', line 36

def create(friendly_name: nil, status: nil, definition: nil, commit_message: :unset)
  data = Twilio::Values.of({
      'FriendlyName' => friendly_name,
      'Status' => status,
      'Definition' => Twilio.serialize_object(definition),
      'CommitMessage' => commit_message,
  })

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

  FlowInstance.new(@version, payload, )
end

#each ⇒ Object

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



87
88
89
90
91
92
93
94
95
 
# File 'lib/twilio-ruby/rest/studio/v2/flow.rb', line 87

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

Parameters:

  • target_url (String) —

    API-generated URL for the requested results page

Returns:

  • (Page) —

    Page of FlowInstance



121
122
123
124
125
126
127
 
# File 'lib/twilio-ruby/rest/studio/v2/flow.rb', line 121

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

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

Lists FlowInstance 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



60
61
62
 
# File 'lib/twilio-ruby/rest/studio/v2/flow.rb', line 60

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 FlowInstance 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 FlowInstance



104
105
106
107
108
109
110
111
112
113
114
 
# File 'lib/twilio-ruby/rest/studio/v2/flow.rb', line 104

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)

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

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

Streams FlowInstance 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



75
76
77
78
79
80
81
 
# File 'lib/twilio-ruby/rest/studio/v2/flow.rb', line 75

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_s ⇒ Object

Provide a user friendly representation



131
132
133
 
# File 'lib/twilio-ruby/rest/studio/v2/flow.rb', line 131

def to_s
  '#<Twilio.Studio.V2.FlowList>'
end