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



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



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



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.



184
185
186
187
188
189
190
191
192
193
194
195
196
 
# File 'lib/twilio-ruby/rest/memory/v1/import.rb', line 184

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.



225
226
227
228
229
230
231
 
# File 'lib/twilio-ruby/rest/memory/v1/import.rb', line 225

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

#list(page_token: :unset, order_by: :unset, 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.



117
118
119
120
121
122
123
124
 
# File 'lib/twilio-ruby/rest/memory/v1/import.rb', line 117

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

#list_with_metadata(page_token: :unset, order_by: :unset, limit: nil, page_size: nil) ⇒ Array 



165
166
167
168
169
170
171
172
173
174
175
176
177
178
 
# File 'lib/twilio-ruby/rest/memory/v1/import.rb', line 165

def list_with_metadata(page_token: :unset, order_by: :unset, limit: nil, page_size: nil)
    limits = @version.read_limits(limit, page_size)
    params = Twilio::Values.of({
        'pageToken' => page_token,
        'orderBy' => order_by,
        
        '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_token: :unset, order_by: :unset, page_size: :unset) ⇒ Page 



205
206
207
208
209
210
211
212
213
214
215
216
217
218
 
# File 'lib/twilio-ruby/rest/memory/v1/import.rb', line 205

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

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

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

#stream(page_token: :unset, order_by: :unset, 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.



139
140
141
142
143
144
145
146
147
148
149
150
151
152
 
# File 'lib/twilio-ruby/rest/memory/v1/import.rb', line 139

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

    page = self.page(
        page_token: page_token,
        order_by: order_by,
        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



236
237
238
 
# File 'lib/twilio-ruby/rest/memory/v1/import.rb', line 236

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