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

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

Instance Method Summary collapse

Constructor Details

#initialize(version) ⇒ FlowList

Initialize the FlowList

Parameters:

  • Version that contains the resource



26
27
28
29
30
31
32
33
 
# File 'lib/twilio-ruby/rest/studio/v2/flow.rb', line 26

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:

  • (defaults to: nil)

    The string that you assigned to describe the Flow.

  • (defaults to: nil)
  • (defaults to: nil)

    JSON representation of flow definition.

  • (defaults to: :unset)

    Description of change made in the revision.

Returns:

  • Created FlowInstance



41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
 
# File 'lib/twilio-ruby/rest/studio/v2/flow.rb', line 41

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,
    })

    headers = Twilio::Values.of({'Content-Type' => 'application/x-www-form-urlencoded', })
    
    
    
    
    
    payload = @version.create('POST', @uri, data: data, headers: headers)
    FlowInstance.new(
        @version,
        payload,
    )
end

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

Create the FlowInstanceMetadata

Parameters:

  • (defaults to: nil)

    The string that you assigned to describe the Flow.

  • (defaults to: nil)
  • (defaults to: nil)

    JSON representation of flow definition.

  • (defaults to: :unset)

    Description of change made in the revision.

Returns:

  • Created FlowInstance



75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
 
# File 'lib/twilio-ruby/rest/studio/v2/flow.rb', line 75

def create_with_metadata(
  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,
    })

    headers = Twilio::Values.of({'Content-Type' => 'application/x-www-form-urlencoded', })
    
    
    
    
    
    response = @version.create_with_metadata('POST', @uri, data: data, headers: headers)
    flow_instance = FlowInstance.new(
        @version,
        response.body,
    )
    FlowInstanceMetadata.new(
        @version,
        flow_instance,
        response.headers,
        response.status_code
    )
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.



173
174
175
176
177
178
179
180
181
 
# File 'lib/twilio-ruby/rest/studio/v2/flow.rb', line 173

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:

  • API-generated URL for the requested results page

Returns:

  • Page of FlowInstance



210
211
212
213
214
215
216
 
# File 'lib/twilio-ruby/rest/studio/v2/flow.rb', line 210

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:

  • (defaults to: nil)

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

  • (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 of up to limit results



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

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

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

Lists FlowPageMetadata records from the API as a list.

Parameters:

  • (defaults to: nil)

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

  • (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 of up to limit results



156
157
158
159
160
161
162
163
164
165
166
167
 
# File 'lib/twilio-ruby/rest/studio/v2/flow.rb', line 156

def list_with_metadata(limit: nil, page_size: nil)
    limits = @version.read_limits(limit, page_size)
    params = Twilio::Values.of({
        
        'PageSize' => limits[:page_size],
    });
    headers = Twilio::Values.of({})

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

    FlowPageMetadata.new(@version, response, @solution, limits[:limit])
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:

  • (defaults to: :unset)

    PageToken provided by the API

  • (defaults to: :unset)

    Page Number, this value is simply for client state

  • (defaults to: :unset)

    Number of records to return, defaults to 50

Returns:

  • Page of FlowInstance



190
191
192
193
194
195
196
197
198
199
200
201
202
203
 
# File 'lib/twilio-ruby/rest/studio/v2/flow.rb', line 190

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

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

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

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

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

Parameters:

  • (defaults to: nil)

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

  • (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 that will yield up to limit results



138
139
140
141
142
143
144
145
 
# File 'lib/twilio-ruby/rest/studio/v2/flow.rb', line 138

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



221
222
223
 
# File 'lib/twilio-ruby/rest/studio/v2/flow.rb', line 221

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