lib/twilio-ruby/rest/ip_messaging/v2/credential.rb in twilio-ruby-5.77.0 vs lib/twilio-ruby/rest/ip_messaging/v2/credential.rb in twilio-ruby-6.0.0.pre.rc.1
- old
+ new
@@ -1,374 +1,430 @@
##
-# This code was generated by
-# \ / _ _ _| _ _
-# | (_)\/(_)(_|\/| |(/_ v1.0.0
-# / /
+# This code was generated by
+# ___ _ _ _ _ _ _ ____ ____ ____ _ ____ ____ _ _ ____ ____ ____ ___ __ __
+# | | | | | | | | | __ | | |__| | __ | __ |___ |\ | |___ |__/ |__| | | | |__/
+# | |_|_| | |___ | |__| |__| | | | |__] |___ | \| |___ | \ | | | |__| | \
#
-# frozen_string_literal: true
+# Twilio - Ip_messaging
+# This is the public Twilio REST API.
+#
+# NOTE: This class is auto generated by OpenAPI Generator.
+# https://openapi-generator.tech
+# Do not edit the class manually.
+#
+
module Twilio
- module REST
- class IpMessaging < Domain
- class V2 < Version
- class CredentialList < ListResource
- ##
- # Initialize the CredentialList
- # @param [Version] version Version that contains the resource
- # @return [CredentialList] CredentialList
- def initialize(version)
- super(version)
+ module REST
+ class IpMessaging < IpMessagingBase
+ class V2 < Version
+ class CredentialList < ListResource
+ ##
+ # 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
+ ##
+ # Create the CredentialInstance
+ # @param [PushService] type
+ # @param [String] friendly_name
+ # @param [String] certificate
+ # @param [String] private_key
+ # @param [Boolean] sandbox
+ # @param [String] api_key
+ # @param [String] secret
+ # @return [CredentialInstance] Created CredentialInstance
+ def create(
+ type: nil,
+ friendly_name: :unset,
+ certificate: :unset,
+ private_key: :unset,
+ sandbox: :unset,
+ api_key: :unset,
+ secret: :unset
+ )
- # Path Solution
- @solution = {}
- @uri = "/Credentials"
- end
+ data = Twilio::Values.of({
+ 'Type' => type,
+ 'FriendlyName' => friendly_name,
+ 'Certificate' => certificate,
+ 'PrivateKey' => private_key,
+ 'Sandbox' => sandbox,
+ 'ApiKey' => api_key,
+ 'Secret' => secret,
+ })
- ##
- # 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()
- # guarantees to never return more than limit. Default is no limit
- # @param [Integer] page_size 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)
- # @return [Array] Array of up to limit results
- def list(limit: nil, page_size: nil)
- self.stream(limit: limit, page_size: page_size).entries
- end
+ payload = @version.create('POST', @uri, data: data)
+ CredentialInstance.new(
+ @version,
+ payload,
+ )
+ 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()
- # guarantees to never return more than limit. Default is no limit.
- # @param [Integer] page_size 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)
- # @return [Enumerable] Enumerable that will yield up to limit results
- def stream(limit: nil, page_size: nil)
- limits = @version.read_limits(limit, page_size)
+
+ ##
+ # 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()
+ # guarantees to never return more than limit. Default is no limit
+ # @param [Integer] page_size 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)
+ # @return [Array] Array of up to limit results
+ def list(limit: nil, page_size: nil)
+ self.stream(
+ limit: limit,
+ page_size: page_size
+ ).entries
+ end
- page = self.page(page_size: limits[:page_size], )
+ ##
+ # Streams Instance 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()
+ # guarantees to never return more than limit. Default is no limit
+ # @param [Integer] page_size 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)
+ # @return [Enumerable] Enumerable that will yield up to limit results
+ def stream(limit: nil, page_size: nil)
+ limits = @version.read_limits(limit, page_size)
- @version.stream(page, limit: limits[:limit], page_limit: limits[:page_limit])
- end
+ page = self.page(
+ page_size: limits[:page_size], )
- ##
- # When passed a block, yields CredentialInstance records from the API.
- # This operation lazily loads records as efficiently as possible until the limit
- # is reached.
- def each
- limits = @version.read_limits
+ @version.stream(page, limit: limits[:limit], page_limit: limits[:page_limit])
+ end
- page = self.page(page_size: limits[:page_size], )
+ ##
+ # When passed a block, yields CredentialInstance records from the API.
+ # This operation lazily loads records as efficiently as possible until the limit
+ # is reached.
+ def each
+ limits = @version.read_limits
- @version.stream(page,
+ page = self.page(page_size: limits[:page_size], )
+
+ @version.stream(page,
limit: limits[:limit],
page_limit: limits[:page_limit]).each {|x| yield x}
- end
+ 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
- # @param [Integer] page_size Number of records to return, defaults to 50
- # @return [Page] Page of CredentialInstance
- def page(page_token: :unset, page_number: :unset, page_size: :unset)
- params = Twilio::Values.of({
- 'PageToken' => page_token,
- 'Page' => page_number,
- 'PageSize' => page_size,
- })
+ ##
+ # 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
+ # @param [Integer] page_size Number of records to return, defaults to 50
+ # @return [Page] Page of CredentialInstance
+ def page(page_token: :unset, page_number: :unset, page_size: :unset)
+ params = Twilio::Values.of({
+
+ 'PageToken' => page_token,
+ 'Page' => page_number,
+ 'PageSize' => page_size,
+ })
- response = @version.page('GET', @uri, params: params)
+ response = @version.page('GET', @uri, params: params)
- CredentialPage.new(@version, response, @solution)
- end
+ CredentialPage.new(@version, response, @solution)
+ end
- ##
- # Retrieve a single page of CredentialInstance records from the API.
- # Request is executed immediately.
- # @param [String] target_url API-generated URL for the requested results page
- # @return [Page] Page of CredentialInstance
- def get_page(target_url)
- response = @version.domain.request(
- 'GET',
- target_url
- )
- CredentialPage.new(@version, response, @solution)
- end
+ ##
+ # Retrieve a single page of CredentialInstance records from the API.
+ # Request is executed immediately.
+ # @param [String] target_url API-generated URL for the requested results page
+ # @return [Page] Page of CredentialInstance
+ def get_page(target_url)
+ response = @version.domain.request(
+ 'GET',
+ target_url
+ )
+ CredentialPage.new(@version, response, @solution)
+ end
+
- ##
- # Create the CredentialInstance
- # @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] Created CredentialInstance
- def create(type: nil, friendly_name: :unset, certificate: :unset, private_key: :unset, sandbox: :unset, api_key: :unset, secret: :unset)
- data = Twilio::Values.of({
- 'Type' => type,
- 'FriendlyName' => friendly_name,
- 'Certificate' => certificate,
- 'PrivateKey' => private_key,
- 'Sandbox' => sandbox,
- 'ApiKey' => api_key,
- 'Secret' => secret,
- })
- payload = @version.create('POST', @uri, data: data)
+ # Provide a user friendly representation
+ def to_s
+ '#<Twilio.IpMessaging.V2.CredentialList>'
+ end
+ end
- CredentialInstance.new(@version, payload, )
- end
- ##
- # Provide a user friendly representation
- def to_s
- '#<Twilio.IpMessaging.V2.CredentialList>'
- end
- end
+ class CredentialContext < InstanceContext
+ ##
+ # Initialize the CredentialContext
+ # @param [Version] version Version that contains the resource
+ # @param [String] sid
+ # @return [CredentialContext] CredentialContext
+ def initialize(version, sid)
+ super(version)
- 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 = { sid: sid, }
+ @uri = "/Credentials/#{@solution[:sid]}"
- # Path Solution
- @solution = solution
- end
+
+ end
+ ##
+ # Delete the CredentialInstance
+ # @return [Boolean] True if delete succeeds, false otherwise
+ def delete
- ##
- # Build an instance of CredentialInstance
- # @param [Hash] payload Payload response from the API
- # @return [CredentialInstance] CredentialInstance
- def get_instance(payload)
- CredentialInstance.new(@version, payload, )
- end
+ @version.delete('DELETE', @uri)
+ end
- ##
- # Provide a user friendly representation
- def to_s
- '<Twilio.IpMessaging.V2.CredentialPage>'
- end
- end
+ ##
+ # Fetch the CredentialInstance
+ # @return [CredentialInstance] Fetched CredentialInstance
+ def fetch
- 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)
+ payload = @version.fetch('GET', @uri)
+ CredentialInstance.new(
+ @version,
+ payload,
+ sid: @solution[:sid],
+ )
+ end
- # Path Solution
- @solution = {sid: sid, }
- @uri = "/Credentials/#{@solution[:sid]}"
- end
+ ##
+ # Update the CredentialInstance
+ # @param [String] friendly_name
+ # @param [String] certificate
+ # @param [String] private_key
+ # @param [Boolean] sandbox
+ # @param [String] api_key
+ # @param [String] secret
+ # @return [CredentialInstance] Updated CredentialInstance
+ def update(
+ friendly_name: :unset,
+ certificate: :unset,
+ private_key: :unset,
+ sandbox: :unset,
+ api_key: :unset,
+ secret: :unset
+ )
- ##
- # Fetch the CredentialInstance
- # @return [CredentialInstance] Fetched CredentialInstance
- def fetch
- payload = @version.fetch('GET', @uri)
+ data = Twilio::Values.of({
+ 'FriendlyName' => friendly_name,
+ 'Certificate' => certificate,
+ 'PrivateKey' => private_key,
+ 'Sandbox' => sandbox,
+ 'ApiKey' => api_key,
+ 'Secret' => secret,
+ })
- CredentialInstance.new(@version, payload, sid: @solution[:sid], )
- end
+ payload = @version.update('POST', @uri, data: data)
+ 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: :unset, certificate: :unset, private_key: :unset, sandbox: :unset, api_key: :unset, secret: :unset)
- data = Twilio::Values.of({
- 'FriendlyName' => friendly_name,
- 'Certificate' => certificate,
- 'PrivateKey' => private_key,
- 'Sandbox' => sandbox,
- 'ApiKey' => api_key,
- 'Secret' => secret,
- })
- payload = @version.update('POST', @uri, data: data)
+ ##
+ # Provide a user friendly representation
+ def to_s
+ context = @solution.map{|k, v| "#{k}: #{v}"}.join(',')
+ "#<Twilio.IpMessaging.V2.CredentialContext #{context}>"
+ end
- CredentialInstance.new(@version, payload, sid: @solution[:sid], )
- end
+ ##
+ # Provide a detailed, user friendly representation
+ def inspect
+ context = @solution.map{|k, v| "#{k}: #{v}"}.join(',')
+ "#<Twilio.IpMessaging.V2.CredentialContext #{context}>"
+ end
+ end
- ##
- # Delete the CredentialInstance
- # @return [Boolean] true if delete succeeds, false otherwise
- def delete
- @version.delete('DELETE', @uri)
- 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)
- ##
- # Provide a user friendly representation
- def to_s
- context = @solution.map {|k, v| "#{k}: #{v}"}.join(',')
- "#<Twilio.IpMessaging.V2.CredentialContext #{context}>"
- end
+ # Path Solution
+ @solution = solution
+ end
- ##
- # Provide a detailed, user friendly representation
- def inspect
- context = @solution.map {|k, v| "#{k}: #{v}"}.join(',')
- "#<Twilio.IpMessaging.V2.CredentialContext #{context}>"
- end
- end
+ ##
+ # Build an instance of CredentialInstance
+ # @param [Hash] payload Payload response from the API
+ # @return [CredentialInstance] CredentialInstance
+ def get_instance(payload)
+ CredentialInstance.new(@version, payload)
+ 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)
+ ##
+ # Provide a user friendly representation
+ def to_s
+ '<Twilio.IpMessaging.V2.CredentialPage>'
+ 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] account_sid The SID of the
+ # {Account}[https://www.twilio.com/docs/iam/api/account] that created this Credential
+ # resource.
+ # @param [String] sid The SID of the Call resource to fetch.
+ # @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'],
+ 'type' => payload['type'],
+ 'sandbox' => payload['sandbox'],
+ 'date_created' => Twilio.deserialize_iso8601_datetime(payload['date_created']),
+ 'date_updated' => Twilio.deserialize_iso8601_datetime(payload['date_updated']),
+ 'url' => payload['url'],
+ }
- # Marshaled Properties
- @properties = {
- 'sid' => payload['sid'],
- 'account_sid' => payload['account_sid'],
- 'friendly_name' => payload['friendly_name'],
- 'type' => payload['type'],
- 'sandbox' => payload['sandbox'],
- 'date_created' => Twilio.deserialize_iso8601_datetime(payload['date_created']),
- 'date_updated' => Twilio.deserialize_iso8601_datetime(payload['date_updated']),
- 'url' => payload['url'],
- }
+ # Context
+ @instance_context = nil
+ @params = { 'sid' => sid || @properties['sid'] , }
+ end
- # 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
+ # @return [CredentialContext] CallContext for this CallInstance
+ def context
+ unless @instance_context
+ @instance_context = CredentialContext.new(@version , @params['sid'])
+ end
+ @instance_context
+ end
+
+ ##
+ # @return [String]
+ def sid
+ @properties['sid']
+ end
+
+ ##
+ # @return [String]
+ def account_sid
+ @properties['account_sid']
+ end
+
+ ##
+ # @return [String]
+ def friendly_name
+ @properties['friendly_name']
+ end
+
+ ##
+ # @return [PushService]
+ def type
+ @properties['type']
+ end
+
+ ##
+ # @return [String]
+ def sandbox
+ @properties['sandbox']
+ end
+
+ ##
+ # @return [Time]
+ def date_created
+ @properties['date_created']
+ end
+
+ ##
+ # @return [Time]
+ def date_updated
+ @properties['date_updated']
+ end
+
+ ##
+ # @return [String]
+ def url
+ @properties['url']
+ end
+
+ ##
+ # Delete the CredentialInstance
+ # @return [Boolean] True if delete succeeds, false otherwise
+ def delete
- ##
- # Generate an instance context for the instance, the context is capable of
- # performing various actions. All instance actions are proxied to the context
- # @return [CredentialContext] CredentialContext for this CredentialInstance
- def context
- unless @instance_context
- @instance_context = CredentialContext.new(@version, @params['sid'], )
- end
- @instance_context
- end
+ context.delete
+ end
- ##
- # @return [String] The sid
- def sid
- @properties['sid']
- end
+ ##
+ # Fetch the CredentialInstance
+ # @return [CredentialInstance] Fetched CredentialInstance
+ def fetch
- ##
- # @return [String] The account_sid
- def account_sid
- @properties['account_sid']
- end
+ context.fetch
+ end
- ##
- # @return [String] The friendly_name
- def friendly_name
- @properties['friendly_name']
- end
+ ##
+ # Update the CredentialInstance
+ # @param [String] friendly_name
+ # @param [String] certificate
+ # @param [String] private_key
+ # @param [Boolean] sandbox
+ # @param [String] api_key
+ # @param [String] secret
+ # @return [CredentialInstance] Updated CredentialInstance
+ def update(
+ friendly_name: :unset,
+ certificate: :unset,
+ private_key: :unset,
+ sandbox: :unset,
+ api_key: :unset,
+ secret: :unset
+ )
- ##
- # @return [credential.PushService] The type
- def type
- @properties['type']
- end
+ context.update(
+ friendly_name: friendly_name,
+ certificate: certificate,
+ private_key: private_key,
+ sandbox: sandbox,
+ api_key: api_key,
+ secret: secret,
+ )
+ end
- ##
- # @return [String] The sandbox
- def sandbox
- @properties['sandbox']
- end
+ ##
+ # Provide a user friendly representation
+ def to_s
+ values = @params.map{|k, v| "#{k}: #{v}"}.join(" ")
+ "<Twilio.IpMessaging.V2.CredentialInstance #{values}>"
+ end
- ##
- # @return [Time] The date_created
- def date_created
- @properties['date_created']
- end
+ ##
+ # Provide a detailed, user friendly representation
+ def inspect
+ values = @properties.map{|k, v| "#{k}: #{v}"}.join(" ")
+ "<Twilio.IpMessaging.V2.CredentialInstance #{values}>"
+ end
+ end
- ##
- # @return [Time] The date_updated
- def date_updated
- @properties['date_updated']
- end
-
- ##
- # @return [String] The url
- def url
- @properties['url']
- end
-
- ##
- # Fetch the 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: :unset, certificate: :unset, private_key: :unset, sandbox: :unset, api_key: :unset, secret: :unset)
- context.update(
- friendly_name: friendly_name,
- certificate: certificate,
- private_key: private_key,
- sandbox: sandbox,
- api_key: api_key,
- secret: secret,
- )
- end
-
- ##
- # Delete the CredentialInstance
- # @return [Boolean] true if delete succeeds, false otherwise
- def delete
- context.delete
- end
-
- ##
- # Provide a user friendly representation
- def to_s
- values = @params.map{|k, v| "#{k}: #{v}"}.join(" ")
- "<Twilio.IpMessaging.V2.CredentialInstance #{values}>"
- end
-
- ##
- # Provide a detailed, user friendly representation
- def inspect
- values = @properties.map{|k, v| "#{k}: #{v}"}.join(" ")
- "<Twilio.IpMessaging.V2.CredentialInstance #{values}>"
- end
+ end
end
- end
end
- end
-end
\ No newline at end of file
+end