lib/twilio-ruby/rest/chat/v1/credential.rb in twilio-ruby-5.0.0.rc18 vs lib/twilio-ruby/rest/chat/v1/credential.rb in twilio-ruby-5.0.0.rc19
- old
+ new
@@ -1,10 +1,10 @@
##
# This code was generated by
# \ / _ _ _| _ _
# | (_)\/(_)(_|\/| |(/_ v1.0.0
-# / /
+# / /
module Twilio
module REST
class Chat < Domain
class V1 < Version
@@ -13,16 +13,16 @@
# Initialize the CredentialList
# @param [Version] version Version that contains the resource
# @return [CredentialList] CredentialList
def initialize(version)
super(version)
-
+
# Path Solution
@solution = {}
@uri = "/Credentials"
end
-
+
##
# Lists CredentialInstance records from the API as a list.
# Unlike stream(), this operation is eager and will load `limit` records into
# memory before returning.
# @param [Integer] limit Upper limit for the number of records to return. stream()
@@ -36,11 +36,11 @@
self.stream(
limit: limit,
page_size: page_size
).entries
end
-
+
##
# Streams CredentialInstance records from the API as an Enumerable.
# This operation lazily loads records as efficiently as possible until the limit
# is reached.
# @param [Integer] limit Upper limit for the number of records to return. stream()
@@ -50,18 +50,18 @@
# but a limit is defined, stream() will attempt to read the
# limit with the most efficient page size, i.e. min(limit, 1000)
# @return [Enumerable] Enumerable that will yield up to limit results
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
-
+
##
# When passed a block, yields CredentialInstance records from the API.
# This operation lazily loads records as efficiently as possible until the limit
# is reached.
# @param [Integer] limit Upper limit for the number of records to return. stream()
@@ -70,20 +70,20 @@
# 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)
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
-
+
##
# Retrieve a single page of CredentialInstance records from the API.
# Request is executed immediately.
# @param [String] page_token PageToken provided by the API
# @param [Integer] page_number Page Number, this value is simply for client state
@@ -100,172 +100,176 @@
@uri,
params
)
return CredentialPage.new(@version, response, @solution)
end
-
+
##
# Retrieve a single page of CredentialInstance records from the API.
# Request is executed immediately.
# @param [credential.PushService] type The type
# @param [String] friendly_name The friendly_name
# @param [String] certificate The certificate
# @param [String] private_key The private_key
# @param [Boolean] sandbox The sandbox
# @param [String] api_key The api_key
+ # @param [String] secret The secret
# @return [CredentialInstance] Newly created CredentialInstance
- def create(type: nil, friendly_name: nil, certificate: nil, private_key: nil, sandbox: nil, api_key: nil)
+ def create(type: nil, friendly_name: nil, certificate: nil, private_key: nil, sandbox: nil, api_key: nil, secret: nil)
data = {
'Type' => type,
'FriendlyName' => friendly_name,
'Certificate' => certificate,
'PrivateKey' => private_key,
'Sandbox' => sandbox,
'ApiKey' => api_key,
+ 'Secret' => secret,
}
-
+
payload = @version.create(
'POST',
@uri,
data: data
)
-
+
return CredentialInstance.new(
@version,
payload,
)
end
-
+
##
# Provide a user friendly representation
def to_s
'#<Twilio.Chat.V1.CredentialList>'
end
end
-
+
class CredentialPage < Page
##
# Initialize the CredentialPage
# @param [Version] version Version that contains the resource
# @param [Response] response Response from the API
# @param [Hash] solution Path solution for the resource
# @return [CredentialPage] CredentialPage
def initialize(version, response, solution)
super(version, response)
-
+
# Path Solution
@solution = solution
end
-
+
##
# Build an instance of CredentialInstance
# @param [Hash] payload Payload response from the API
# @return [CredentialInstance] CredentialInstance
def get_instance(payload)
return CredentialInstance.new(
@version,
payload,
)
end
-
+
##
# Provide a user friendly representation
def to_s
'<Twilio.Chat.V1.CredentialPage>'
end
end
-
+
class CredentialContext < InstanceContext
##
# Initialize the CredentialContext
# @param [Version] version Version that contains the resource
# @param [String] sid The sid
# @return [CredentialContext] CredentialContext
def initialize(version, sid)
super(version)
-
+
# Path Solution
@solution = {
sid: sid,
}
@uri = "/Credentials/#{@solution[:sid]}"
end
-
+
##
# Fetch a CredentialInstance
# @return [CredentialInstance] Fetched CredentialInstance
def fetch
params = {}
-
+
payload = @version.fetch(
'GET',
@uri,
params,
)
-
+
return CredentialInstance.new(
@version,
payload,
sid: @solution[:sid],
)
end
-
+
##
# Update the CredentialInstance
# @param [String] friendly_name The friendly_name
# @param [String] certificate The certificate
# @param [String] private_key The private_key
# @param [Boolean] sandbox The sandbox
# @param [String] api_key The api_key
+ # @param [String] secret The secret
# @return [CredentialInstance] Updated CredentialInstance
- def update(friendly_name: nil, certificate: nil, private_key: nil, sandbox: nil, api_key: nil)
+ def update(friendly_name: nil, certificate: nil, private_key: nil, sandbox: nil, api_key: nil, secret: nil)
data = {
'FriendlyName' => friendly_name,
'Certificate' => certificate,
'PrivateKey' => private_key,
'Sandbox' => sandbox,
'ApiKey' => api_key,
+ 'Secret' => secret,
}
-
+
payload = @version.update(
'POST',
@uri,
data: data,
)
-
+
return CredentialInstance.new(
@version,
payload,
sid: @solution[:sid],
)
end
-
+
##
# Deletes the CredentialInstance
# @return [Boolean] true if delete succeeds, true otherwise
def delete
return @version.delete('delete', @uri)
end
-
+
##
# Provide a user friendly representation
def to_s
context = @solution.map {|k, v| "#{k}: #{v}"}.join(',')
"#<Twilio.Chat.V1.CredentialContext #{context}>"
end
end
-
+
class CredentialInstance < InstanceResource
##
# Initialize the CredentialInstance
# @param [Version] version Version that contains the resource
# @param [Hash] payload payload that contains response from Twilio
# @param [String] sid The sid
# @return [CredentialInstance] CredentialInstance
def initialize(version, payload, sid: nil)
super(version)
-
+
# Marshaled Properties
@properties = {
'sid' => payload['sid'],
'account_sid' => payload['account_sid'],
'friendly_name' => payload['friendly_name'],
@@ -273,18 +277,18 @@
'sandbox' => payload['sandbox'],
'date_created' => Twilio.deserialize_iso8601(payload['date_created']),
'date_updated' => Twilio.deserialize_iso8601(payload['date_updated']),
'url' => payload['url'],
}
-
+
# Context
@instance_context = nil
@params = {
'sid' => sid || @properties['sid'],
}
end
-
+
##
# Generate an instance context for the instance, the context is capable of
# performing various actions. All instance actions are proxied to the context
# @param [Version] version Version that contains the resource
# @return [CredentialContext] CredentialContext for this CredentialInstance
@@ -295,74 +299,76 @@
@params['sid'],
)
end
@instance_context
end
-
+
def sid
@properties['sid']
end
-
+
def account_sid
@properties['account_sid']
end
-
+
def friendly_name
@properties['friendly_name']
end
-
+
def type
@properties['type']
end
-
+
def sandbox
@properties['sandbox']
end
-
+
def date_created
@properties['date_created']
end
-
+
def date_updated
@properties['date_updated']
end
-
+
def url
@properties['url']
end
-
+
##
# Fetch a CredentialInstance
# @return [CredentialInstance] Fetched CredentialInstance
def fetch
context.fetch
end
-
+
##
# Update the CredentialInstance
# @param [String] friendly_name The friendly_name
# @param [String] certificate The certificate
# @param [String] private_key The private_key
# @param [Boolean] sandbox The sandbox
# @param [String] api_key The api_key
+ # @param [String] secret The secret
# @return [CredentialInstance] Updated CredentialInstance
- def update(friendly_name: nil, certificate: nil, private_key: nil, sandbox: nil, api_key: nil)
+ def update(friendly_name: nil, certificate: nil, private_key: nil, sandbox: nil, api_key: nil, secret: nil)
context.update(
friendly_name: friendly_name,
certificate: certificate,
private_key: private_key,
sandbox: sandbox,
api_key: api_key,
+ secret: secret,
)
end
-
+
##
# Deletes the CredentialInstance
# @return [Boolean] true if delete succeeds, true otherwise
def delete
context.delete
end
-
+
##
# Provide a user friendly representation
def to_s
values = @params.map{|k, v| "#{k}: #{v}"}.join(" ")
"<Twilio.Chat.V1.CredentialInstance #{values}>"
\ No newline at end of file