Class: Twilio::REST::Memory::V1::ImportList

Inherits:
ListResource show all
Defined in:
lib/twilio-ruby/rest/memory/v1/import.rb

Defined Under Namespace

Classes: CreateProfilesImportV2Request

Instance Method Summary collapse

Constructor Details

#initialize(version, store_id: nil) ⇒ ImportList

Initialize the ImportList

Parameters:

  • version (Version) —

    Version that contains the resource



46
47
48
49
50
51
52
53
54
 
# File 'lib/twilio-ruby/rest/memory/v1/import.rb', line 46

def initialize(version, store_id: nil)
    
    apiV1Version = ApiV1Version.new version.domain, version
    super(apiV1Version)
    # Path Solution
    @solution = { store_id: store_id }
    @uri = "/Stores/#{@solution[:store_id]}/Profiles/Imports"
    
end

Instance Method Details

#create(create_profiles_import_v2_request: nil) ⇒ ImportInstance

Create the ImportInstance

Parameters:

Returns:



59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
 
# File 'lib/twilio-ruby/rest/memory/v1/import.rb', line 59

def create(create_profiles_import_v2_request: nil
)

    headers = Twilio::Values.of({'Content-Type' => 'application/x-www-form-urlencoded', })
    headers['Content-Type'] = 'application/json'
    
    
    
    
    payload = @version.create('POST', @uri, headers: headers, data: create_profiles_import_v2_request.to_json)
    ImportInstance.new(
        @version,
        payload,
        store_id: @solution[:store_id],
    )
end

#create_with_metadata(create_profiles_import_v2_request: nil) ⇒ ImportInstance

Create the ImportInstanceMetadata

Parameters:

Returns:



80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
 
# File 'lib/twilio-ruby/rest/memory/v1/import.rb', line 80

def create_with_metadata(create_profiles_import_v2_request: nil
)

    headers = Twilio::Values.of({'Content-Type' => 'application/x-www-form-urlencoded', })
    headers['Content-Type'] = 'application/json'
    
    
    
    
    response = @version.create_with_metadata('POST', @uri, headers: headers, data: create_profiles_import_v2_request.to_json)
    import_instance = ImportInstance.new(
        @version,
        response.body,
        store_id: @solution[:store_id],
    )
    ImportInstanceMetadata.new(
        @version,
        import_instance,
        response.headers,
        response.status_code
    )
end

#each ⇒ Object

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



172
173
174
175
176
177
178
179
180
181
182
183
184
 
# File 'lib/twilio-ruby/rest/memory/v1/import.rb', line 172

def each
    limits = @version.read_limits

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

    return [].each if page.nil?

    result = @version.stream(page,
        limit: limits[:limit],
        page_limit: limits[:page_limit])
    return [].each if result.nil?
    result.each {|x| yield x}
end

#get_page(target_url) ⇒ Page

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

Parameters:

  • target_url (String) —

    API-generated URL for the requested results page

Returns:

  • (Page) —

    Page of ImportInstance



209
210
211
212
213
214
215
 
# File 'lib/twilio-ruby/rest/memory/v1/import.rb', line 209

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

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

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



115
116
117
118
119
120
 
# File 'lib/twilio-ruby/rest/memory/v1/import.rb', line 115

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 ImportPageMetadata records from the API as a list.

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



155
156
157
158
159
160
161
162
163
164
165
166
 
# File 'lib/twilio-ruby/rest/memory/v1/import.rb', line 155

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)

    ImportPageMetadata.new(@version, response, @solution, limits[:limit])
end

#page(page_size: :unset) ⇒ Page

Returns Page of ImportInstance.

Returns:

  • (Page) —

    Page of ImportInstance



191
192
193
194
195
196
197
198
199
200
201
202
 
# File 'lib/twilio-ruby/rest/memory/v1/import.rb', line 191

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

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

    ImportPage.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:

  • 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



133
134
135
136
137
138
139
140
141
142
143
144
 
# File 'lib/twilio-ruby/rest/memory/v1/import.rb', line 133

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

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

    return [].each if page.nil?

    result = @version.stream(page, limit: limits[:limit], page_limit: limits[:page_limit])
    return [].each if result.nil?
    result
end

#to_s ⇒ Object

Provide a user friendly representation



220
221
222
 
# File 'lib/twilio-ruby/rest/memory/v1/import.rb', line 220

def to_s
    '#<Twilio.Memory.V1.ImportList>'
end