Class: Twilio::REST::Preview::Sync::ServiceContext::DocumentContext

Inherits:
InstanceContext
  • Object
show all
Defined in:
lib/twilio-ruby/rest/preview/sync/service/document.rb,
lib/twilio-ruby/rest/preview/sync/service/document/document_permission.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]

Defined Under Namespace

Classes: DocumentPermissionContext, DocumentPermissionInstance, DocumentPermissionList, DocumentPermissionPage

Instance Method Summary collapse

Constructor Details

#initialize(version, service_sid, sid) ⇒ DocumentContext

Initialize the DocumentContext

Parameters:

  • version (Version)

    Version that contains the resource

  • service_sid (String)

    The service_sid

  • sid (String)

    The sid


170
171
172
173
174
175
176
177
178
179
# File 'lib/twilio-ruby/rest/preview/sync/service/document.rb', line 170

def initialize(version, service_sid, sid)
  super(version)

  # Path Solution
  @solution = {service_sid: service_sid, sid: sid, }
  @uri = "/Services/#{@solution[:service_sid]}/Documents/#{@solution[:sid]}"

  # Dependents
  @document_permissions = nil
end

Instance Method Details

#deleteBoolean

Delete the DocumentInstance

Returns:

  • (Boolean)

    true if delete succeeds, false otherwise


193
194
195
# File 'lib/twilio-ruby/rest/preview/sync/service/document.rb', line 193

def delete
   @version.delete('DELETE', @uri)
end

#document_permissions(identity = :unset) ⇒ DocumentPermissionList, DocumentPermissionContext

Access the document_permissions

Returns:

Raises:

  • (ArgumentError)

215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
# File 'lib/twilio-ruby/rest/preview/sync/service/document.rb', line 215

def document_permissions(identity=:unset)
  raise ArgumentError, 'identity cannot be nil' if identity.nil?

  if identity != :unset
    return DocumentPermissionContext.new(@version, @solution[:service_sid], @solution[:sid], identity, )
  end

  unless @document_permissions
    @document_permissions = DocumentPermissionList.new(
        @version,
        service_sid: @solution[:service_sid],
        document_sid: @solution[:sid],
    )
  end

  @document_permissions
end

#fetchDocumentInstance

Fetch the DocumentInstance

Returns:


184
185
186
187
188
# File 'lib/twilio-ruby/rest/preview/sync/service/document.rb', line 184

def fetch
  payload = @version.fetch('GET', @uri)

  DocumentInstance.new(@version, payload, service_sid: @solution[:service_sid], sid: @solution[:sid], )
end

#inspectObject

Provide a detailed, user friendly representation


242
243
244
245
# File 'lib/twilio-ruby/rest/preview/sync/service/document.rb', line 242

def inspect
  context = @solution.map {|k, v| "#{k}: #{v}"}.join(',')
  "#<Twilio.Preview.Sync.DocumentContext #{context}>"
end

#to_sObject

Provide a user friendly representation


235
236
237
238
# File 'lib/twilio-ruby/rest/preview/sync/service/document.rb', line 235

def to_s
  context = @solution.map {|k, v| "#{k}: #{v}"}.join(',')
  "#<Twilio.Preview.Sync.DocumentContext #{context}>"
end

#update(data: nil, if_match: :unset) ⇒ DocumentInstance

Update the DocumentInstance

Parameters:

  • data (Hash) (defaults to: nil)

    The data

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

    The If-Match HTTP request header

Returns:


202
203
204
205
206
207
208
209
# File 'lib/twilio-ruby/rest/preview/sync/service/document.rb', line 202

def update(data: nil, if_match: :unset)
  data = Twilio::Values.of({'Data' => Twilio.serialize_object(data), })
  headers = Twilio::Values.of({'If-Match' => if_match, })

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

  DocumentInstance.new(@version, payload, service_sid: @solution[:service_sid], sid: @solution[:sid], )
end