twilio-ruby 5.6.0 → 5.33.0

data/lib/twilio-ruby/rest/notify/v1/credential.rb

@@ -3,6 +3,8 @@
 # \ / _    _  _|   _  _
 #  | (_)\/(_)(_|\/| |(/_  v1.0.0
 #       /       /
+#
+# frozen_string_literal: true
 
 module Twilio
   module REST
@@ -52,7 +54,7 @@ module Twilio
           def stream(limit: nil, page_size: nil)
             limits = @version.read_limits(limit, page_size)
 
-            page = self.page(page_size: limits[:page_size])
+            page = self.page(page_size: limits[:page_size], )
 
             @version.stream(page, limit: limits[:limit], page_limit: limits[:page_limit])
           end
@@ -64,7 +66,7 @@ module Twilio
           def each
             limits = @version.read_limits
 
-            page = self.page(page_size: limits[:page_size])
+            page = self.page(page_size: limits[:page_size], )
 
             @version.stream(page,
                             limit: limits[:limit],
@@ -108,13 +110,23 @@ module Twilio
           ##
           # 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
+          # @param [credential.PushService] type The Credential type. Can be: `gcm`, `fcm`,
+          #   or `apn`.
+          # @param [String] friendly_name A descriptive string that you create to describe
+          #   the resource. It can be up to 64 characters long.
+          # @param [String] certificate [APN only] The URL-encoded representation of the
+          #   certificate. Strip everything outside of the headers, e.g. `-----BEGIN
+          #   CERTIFICATE-----MIIFnTCCBIWgAwIBAgIIAjy9H849+E8wDQYJKoZIhvcNAQEFBQAwgZYxCzAJBgNV.....A==-----END CERTIFICATE-----`
+          # @param [String] private_key [APN only] The URL-encoded representation of the
+          #   private key. Strip everything outside of the headers, e.g. `-----BEGIN RSA
+          #   PRIVATE
+          #   KEY-----MIIEpQIBAAKCAQEAuyf/lNrH9ck8DmNyo3fGgvCI1l9s+cmBY3WIz+cUDqmxiieR\n.-----END RSA PRIVATE KEY-----`
+          # @param [Boolean] sandbox [APN only] Whether to send the credential to sandbox
+          #   APNs. Can be `true` to send to sandbox APNs or `false` to send to production.
+          # @param [String] api_key [GCM only] The `Server key` of your project from
+          #   Firebase console under Settings / Cloud messaging.
+          # @param [String] secret [FCM only] The `Server key` of your project from Firebase
+          #   console under Settings / Cloud messaging.
           # @return [CredentialInstance] Newly 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({
@@ -133,7 +145,7 @@ module Twilio
                 data: data
             )
 
-            CredentialInstance.new(@version, payload)
+            CredentialInstance.new(@version, payload, )
           end
 
           ##
@@ -164,7 +176,7 @@ module Twilio
           # @param [Hash] payload Payload response from the API
           # @return [CredentialInstance] CredentialInstance
           def get_instance(payload)
-            CredentialInstance.new(@version, payload)
+            CredentialInstance.new(@version, payload, )
           end
 
           ##
@@ -180,13 +192,14 @@ module Twilio
           ##
           # Initialize the CredentialContext
           # @param [Version] version Version that contains the resource
-          # @param [String] sid The sid
+          # @param [String] sid The Twilio-provided string that uniquely identifies the
+          #   Credential resource to fetch.
           # @return [CredentialContext] CredentialContext
           def initialize(version, sid)
             super(version)
 
             # Path Solution
-            @solution = {sid: sid}
+            @solution = {sid: sid, }
             @uri = "/Credentials/#{@solution[:sid]}"
           end
 
@@ -202,17 +215,26 @@ module Twilio
                 params,
             )
 
-            CredentialInstance.new(@version, payload, sid: @solution[:sid])
+            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
+          # @param [String] friendly_name A descriptive string that you create to describe
+          #   the resource. It can be up to 64 characters long.
+          # @param [String] certificate [APN only] The URL-encoded representation of the
+          #   certificate. Strip everything outside of the headers, e.g. `-----BEGIN
+          #   CERTIFICATE-----MIIFnTCCBIWgAwIBAgIIAjy9H849+E8wDQYJKoZIhvcNAQEFBQAwgZYxCzAJBgNV.....A==-----END CERTIFICATE-----`
+          # @param [String] private_key [APN only] The URL-encoded representation of the
+          #   private key. Strip everything outside of the headers, e.g. `-----BEGIN RSA
+          #   PRIVATE
+          #   KEY-----MIIEpQIBAAKCAQEAuyf/lNrH9ck8DmNyo3fGgvCI1l9s+cmBY3WIz+cUDqmxiieR\n.-----END RSA PRIVATE KEY-----`
+          # @param [Boolean] sandbox [APN only] Whether to send the credential to sandbox
+          #   APNs. Can be `true` to send to sandbox APNs or `false` to send to production.
+          # @param [String] api_key [GCM only] The `Server key` of your project from
+          #   Firebase console under Settings / Cloud messaging.
+          # @param [String] secret [FCM only] The `Server key` of your project from Firebase
+          #   console under Settings / Cloud messaging.
           # @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({
@@ -230,12 +252,12 @@ module Twilio
                 data: data,
             )
 
-            CredentialInstance.new(@version, payload, sid: @solution[:sid])
+            CredentialInstance.new(@version, payload, sid: @solution[:sid], )
           end
 
           ##
           # Deletes the CredentialInstance
-          # @return [Boolean] true if delete succeeds, true otherwise
+          # @return [Boolean] true if delete succeeds, false otherwise
           def delete
             @version.delete('delete', @uri)
           end
@@ -246,6 +268,13 @@ module Twilio
             context = @solution.map {|k, v| "#{k}: #{v}"}.join(',')
             "#<Twilio.Notify.V1.CredentialContext #{context}>"
           end
+
+          ##
+          # Provide a detailed, user friendly representation
+          def inspect
+            context = @solution.map {|k, v| "#{k}: #{v}"}.join(',')
+            "#<Twilio.Notify.V1.CredentialContext #{context}>"
+          end
         end
 
         ##
@@ -255,7 +284,8 @@ module Twilio
           # 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
+          # @param [String] sid The Twilio-provided string that uniquely identifies the
+          #   Credential resource to fetch.
           # @return [CredentialInstance] CredentialInstance
           def initialize(version, payload, sid: nil)
             super(version)
@@ -274,7 +304,7 @@ module Twilio
 
             # Context
             @instance_context = nil
-            @params = {'sid' => sid || @properties['sid']}
+            @params = {'sid' => sid || @properties['sid'], }
           end
 
           ##
@@ -283,55 +313,55 @@ module Twilio
           # @return [CredentialContext] CredentialContext for this CredentialInstance
           def context
             unless @instance_context
-              @instance_context = CredentialContext.new(@version, @params['sid'])
+              @instance_context = CredentialContext.new(@version, @params['sid'], )
             end
             @instance_context
           end
 
           ##
-          # @return [String] The sid
+          # @return [String] The unique string that identifies the resource
           def sid
             @properties['sid']
           end
 
           ##
-          # @return [String] The account_sid
+          # @return [String] The SID of the Account that created the resource
           def account_sid
             @properties['account_sid']
           end
 
           ##
-          # @return [String] The friendly_name
+          # @return [String] The string that you assigned to describe the resource
           def friendly_name
             @properties['friendly_name']
           end
 
           ##
-          # @return [credential.PushService] The type
+          # @return [credential.PushService] The Credential type, one of `gcm`, `fcm`, or `apn`
           def type
             @properties['type']
           end
 
           ##
-          # @return [String] The sandbox
+          # @return [String] [APN only] Whether to send the credential to sandbox APNs
           def sandbox
             @properties['sandbox']
           end
 
           ##
-          # @return [Time] The date_created
+          # @return [Time] The RFC 2822 date and time in GMT when the resource was created
           def date_created
             @properties['date_created']
           end
 
           ##
-          # @return [Time] The date_updated
+          # @return [Time] The RFC 2822 date and time in GMT when the resource was last updated
           def date_updated
             @properties['date_updated']
           end
 
           ##
-          # @return [String] The url
+          # @return [String] The absolute URL of the Credential resource
           def url
             @properties['url']
           end
@@ -345,12 +375,21 @@ module Twilio
 
           ##
           # 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
+          # @param [String] friendly_name A descriptive string that you create to describe
+          #   the resource. It can be up to 64 characters long.
+          # @param [String] certificate [APN only] The URL-encoded representation of the
+          #   certificate. Strip everything outside of the headers, e.g. `-----BEGIN
+          #   CERTIFICATE-----MIIFnTCCBIWgAwIBAgIIAjy9H849+E8wDQYJKoZIhvcNAQEFBQAwgZYxCzAJBgNV.....A==-----END CERTIFICATE-----`
+          # @param [String] private_key [APN only] The URL-encoded representation of the
+          #   private key. Strip everything outside of the headers, e.g. `-----BEGIN RSA
+          #   PRIVATE
+          #   KEY-----MIIEpQIBAAKCAQEAuyf/lNrH9ck8DmNyo3fGgvCI1l9s+cmBY3WIz+cUDqmxiieR\n.-----END RSA PRIVATE KEY-----`
+          # @param [Boolean] sandbox [APN only] Whether to send the credential to sandbox
+          #   APNs. Can be `true` to send to sandbox APNs or `false` to send to production.
+          # @param [String] api_key [GCM only] The `Server key` of your project from
+          #   Firebase console under Settings / Cloud messaging.
+          # @param [String] secret [FCM only] The `Server key` of your project from Firebase
+          #   console under Settings / Cloud messaging.
           # @return [CredentialInstance] Updated CredentialInstance
           def update(friendly_name: :unset, certificate: :unset, private_key: :unset, sandbox: :unset, api_key: :unset, secret: :unset)
             context.update(
@@ -365,7 +404,7 @@ module Twilio
 
           ##
           # Deletes the CredentialInstance
-          # @return [Boolean] true if delete succeeds, true otherwise
+          # @return [Boolean] true if delete succeeds, false otherwise
           def delete
             context.delete
           end

data/lib/twilio-ruby/rest/notify/v1/service/binding.rb

@@ -3,6 +3,8 @@
 # \ / _    _  _|   _  _
 #  | (_)\/(_)(_|\/| |(/_  v1.0.0
 #       /       /
+#
+# frozen_string_literal: true
 
 module Twilio
   module REST
@@ -15,7 +17,9 @@ module Twilio
             ##
             # Initialize the BindingList
             # @param [Version] version Version that contains the resource
-            # @param [String] service_sid The service_sid
+            # @param [String] service_sid The SID of the
+            #   [Service](https://www.twilio.com/docs/notify/api/service-resource) the resource
+            #   is associated with.
             # @return [BindingList] BindingList
             def initialize(version, service_sid: nil)
               super(version)
@@ -28,13 +32,31 @@ module Twilio
             ##
             # Retrieve a single page of BindingInstance records from the API.
             # Request is executed immediately.
-            # @param [String] identity The identity
-            # @param [binding.BindingType] binding_type The binding_type
-            # @param [String] address The address
-            # @param [String] tag The tag
-            # @param [String] notification_protocol_version The notification_protocol_version
-            # @param [String] credential_sid The credential_sid
-            # @param [String] endpoint The endpoint
+            # @param [String] identity The `identity` value that uniquely identifies the new
+            #   resource's [User](https://www.twilio.com/docs/chat/rest/user-resource) within
+            #   the [Service](https://www.twilio.com/docs/notify/api/service-resource). Up to 20
+            #   Bindings can be created for the same Identity in a given Service.
+            # @param [binding.BindingType] binding_type The transport technology to use for
+            #   the Binding. Can be: `apn`, `fcm`, `gcm`, `sms`, or `facebook-messenger`.
+            # @param [String] address The channel-specific address. For APNS, the device
+            #   token. For FCM and GCM, the registration token. For SMS, a phone number in E.164
+            #   format. For Facebook Messenger, the Messenger ID of the user or a phone number
+            #   in E.164 format.
+            # @param [String] tag A tag that can be used to select the Bindings to notify.
+            #   Repeat this parameter to specify more than one tag, up to a total of 20 tags.
+            # @param [String] notification_protocol_version The protocol version to use to
+            #   send the notification. This defaults to the value of
+            #   `default_xxxx_notification_protocol_version` for the protocol in the
+            #   [Service](https://www.twilio.com/docs/notify/api/service-resource). The current
+            #   version is `"3"` for `apn`, `fcm`, and `gcm` type Bindings. The parameter is not
+            #   applicable to `sms` and `facebook-messenger` type Bindings as the data format is
+            #   fixed.
+            # @param [String] credential_sid The SID of the
+            #   [Credential](https://www.twilio.com/docs/notify/api/credential-resource)
+            #   resource to be used to send notifications to this Binding. If present, this
+            #   overrides the Credential specified in the Service resource. Applies to only
+            #   `apn`, `fcm`, and `gcm` type Bindings.
+            # @param [String] endpoint Deprecated.
             # @return [BindingInstance] Newly created BindingInstance
             def create(identity: nil, binding_type: nil, address: nil, tag: :unset, notification_protocol_version: :unset, credential_sid: :unset, endpoint: :unset)
               data = Twilio::Values.of({
@@ -53,17 +75,23 @@ module Twilio
                   data: data
               )
 
-              BindingInstance.new(@version, payload, service_sid: @solution[:service_sid])
+              BindingInstance.new(@version, payload, service_sid: @solution[:service_sid], )
             end
 
             ##
             # Lists BindingInstance records from the API as a list.
             # Unlike stream(), this operation is eager and will load `limit` records into
             # memory before returning.
-            # @param [Date] start_date The start_date
-            # @param [Date] end_date The end_date
-            # @param [String] identity The identity
-            # @param [String] tag The tag
+            # @param [Date] start_date Only include usage that has occurred on or after this
+            #   date. Specify the date in GMT and format as `YYYY-MM-DD`.
+            # @param [Date] end_date Only include usage that occurred on or before this date.
+            #   Specify the date in GMT and format as `YYYY-MM-DD`.
+            # @param [String] identity The
+            #   [User](https://www.twilio.com/docs/chat/rest/user-resource)'s `identity` value
+            #   of the resources to read.
+            # @param [String] tag Only list Bindings that have all of the specified Tags. The
+            #   following implicit tags are available: `all`, `apn`, `fcm`, `gcm`, `sms`,
+            #   `facebook-messenger`. Up to 5 tags are allowed.
             # @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
@@ -86,10 +114,16 @@ module Twilio
             # Streams BindingInstance records from the API as an Enumerable.
             # This operation lazily loads records as efficiently as possible until the limit
             # is reached.
-            # @param [Date] start_date The start_date
-            # @param [Date] end_date The end_date
-            # @param [String] identity The identity
-            # @param [String] tag The tag
+            # @param [Date] start_date Only include usage that has occurred on or after this
+            #   date. Specify the date in GMT and format as `YYYY-MM-DD`.
+            # @param [Date] end_date Only include usage that occurred on or before this date.
+            #   Specify the date in GMT and format as `YYYY-MM-DD`.
+            # @param [String] identity The
+            #   [User](https://www.twilio.com/docs/chat/rest/user-resource)'s `identity` value
+            #   of the resources to read.
+            # @param [String] tag Only list Bindings that have all of the specified Tags. The
+            #   following implicit tags are available: `all`, `apn`, `fcm`, `gcm`, `sms`,
+            #   `facebook-messenger`. Up to 5 tags are allowed.
             # @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
@@ -118,7 +152,7 @@ module Twilio
             def each
               limits = @version.read_limits
 
-              page = self.page(page_size: limits[:page_size])
+              page = self.page(page_size: limits[:page_size], )
 
               @version.stream(page,
                               limit: limits[:limit],
@@ -128,10 +162,16 @@ module Twilio
             ##
             # Retrieve a single page of BindingInstance records from the API.
             # Request is executed immediately.
-            # @param [Date] start_date The start_date
-            # @param [Date] end_date The end_date
-            # @param [String] identity The identity
-            # @param [String] tag The tag
+            # @param [Date] start_date Only include usage that has occurred on or after this
+            #   date. Specify the date in GMT and format as `YYYY-MM-DD`.
+            # @param [Date] end_date Only include usage that occurred on or before this date.
+            #   Specify the date in GMT and format as `YYYY-MM-DD`.
+            # @param [String] identity The
+            #   [User](https://www.twilio.com/docs/chat/rest/user-resource)'s `identity` value
+            #   of the resources to read.
+            # @param [String] tag Only list Bindings that have all of the specified Tags. The
+            #   following implicit tags are available: `all`, `apn`, `fcm`, `gcm`, `sms`,
+            #   `facebook-messenger`. Up to 5 tags are allowed.
             # @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
@@ -195,7 +235,7 @@ module Twilio
             # @param [Hash] payload Payload response from the API
             # @return [BindingInstance] BindingInstance
             def get_instance(payload)
-              BindingInstance.new(@version, payload, service_sid: @solution[:service_sid])
+              BindingInstance.new(@version, payload, service_sid: @solution[:service_sid], )
             end
 
             ##
@@ -211,14 +251,17 @@ module Twilio
             ##
             # Initialize the BindingContext
             # @param [Version] version Version that contains the resource
-            # @param [String] service_sid The service_sid
-            # @param [String] sid The sid
+            # @param [String] service_sid The SID of the
+            #   [Service](https://www.twilio.com/docs/notify/api/service-resource) to fetch the
+            #   resource from.
+            # @param [String] sid The Twilio-provided string that uniquely identifies the
+            #   Binding resource to fetch.
             # @return [BindingContext] BindingContext
             def initialize(version, service_sid, sid)
               super(version)
 
               # Path Solution
-              @solution = {service_sid: service_sid, sid: sid}
+              @solution = {service_sid: service_sid, sid: sid, }
               @uri = "/Services/#{@solution[:service_sid]}/Bindings/#{@solution[:sid]}"
             end
 
@@ -234,12 +277,12 @@ module Twilio
                   params,
               )
 
-              BindingInstance.new(@version, payload, service_sid: @solution[:service_sid], sid: @solution[:sid])
+              BindingInstance.new(@version, payload, service_sid: @solution[:service_sid], sid: @solution[:sid], )
             end
 
             ##
             # Deletes the BindingInstance
-            # @return [Boolean] true if delete succeeds, true otherwise
+            # @return [Boolean] true if delete succeeds, false otherwise
             def delete
               @version.delete('delete', @uri)
             end
@@ -250,6 +293,13 @@ module Twilio
               context = @solution.map {|k, v| "#{k}: #{v}"}.join(',')
               "#<Twilio.Notify.V1.BindingContext #{context}>"
             end
+
+            ##
+            # Provide a detailed, user friendly representation
+            def inspect
+              context = @solution.map {|k, v| "#{k}: #{v}"}.join(',')
+              "#<Twilio.Notify.V1.BindingContext #{context}>"
+            end
           end
 
           ##
@@ -259,8 +309,11 @@ module Twilio
             # Initialize the BindingInstance
             # @param [Version] version Version that contains the resource
             # @param [Hash] payload payload that contains response from Twilio
-            # @param [String] service_sid The service_sid
-            # @param [String] sid The sid
+            # @param [String] service_sid The SID of the
+            #   [Service](https://www.twilio.com/docs/notify/api/service-resource) the resource
+            #   is associated with.
+            # @param [String] sid The Twilio-provided string that uniquely identifies the
+            #   Binding resource to fetch.
             # @return [BindingInstance] BindingInstance
             def initialize(version, payload, service_sid: nil, sid: nil)
               super(version)
@@ -285,7 +338,7 @@ module Twilio
 
               # Context
               @instance_context = nil
-              @params = {'service_sid' => service_sid, 'sid' => sid || @properties['sid']}
+              @params = {'service_sid' => service_sid, 'sid' => sid || @properties['sid'], }
             end
 
             ##
@@ -294,91 +347,91 @@ module Twilio
             # @return [BindingContext] BindingContext for this BindingInstance
             def context
               unless @instance_context
-                @instance_context = BindingContext.new(@version, @params['service_sid'], @params['sid'])
+                @instance_context = BindingContext.new(@version, @params['service_sid'], @params['sid'], )
               end
               @instance_context
             end
 
             ##
-            # @return [String] The sid
+            # @return [String] The unique string that identifies the resource
             def sid
               @properties['sid']
             end
 
             ##
-            # @return [String] The account_sid
+            # @return [String] The SID of the Account that created the resource
             def account_sid
               @properties['account_sid']
             end
 
             ##
-            # @return [String] The service_sid
+            # @return [String] The SID of the Service that the resource is associated with
             def service_sid
               @properties['service_sid']
             end
 
             ##
-            # @return [String] The credential_sid
+            # @return [String] The SID of the Credential resource to be used to send notifications to this Binding
             def credential_sid
               @properties['credential_sid']
             end
 
             ##
-            # @return [Time] The date_created
+            # @return [Time] The RFC 2822 date and time in GMT when the resource was created
             def date_created
               @properties['date_created']
             end
 
             ##
-            # @return [Time] The date_updated
+            # @return [Time] The RFC 2822 date and time in GMT when the resource was last updated
             def date_updated
               @properties['date_updated']
             end
 
             ##
-            # @return [String] The notification_protocol_version
+            # @return [String] The protocol version to use to send the notification
             def notification_protocol_version
               @properties['notification_protocol_version']
             end
 
             ##
-            # @return [String] The endpoint
+            # @return [String] Deprecated
             def endpoint
               @properties['endpoint']
             end
 
             ##
-            # @return [String] The identity
+            # @return [String] The `identity` value that identifies the new resource's User
             def identity
               @properties['identity']
             end
 
             ##
-            # @return [String] The binding_type
+            # @return [String] The type of the Binding
             def binding_type
               @properties['binding_type']
             end
 
             ##
-            # @return [String] The address
+            # @return [String] The channel-specific address
             def address
               @properties['address']
             end
 
             ##
-            # @return [String] The tags
+            # @return [String] The list of tags associated with this Binding
             def tags
               @properties['tags']
             end
 
             ##
-            # @return [String] The url
+            # @return [String] The absolute URL of the Binding resource
             def url
               @properties['url']
             end
 
             ##
-            # @return [String] The links
+            # @return [String] The URLs of related resources
             def links
               @properties['links']
             end
@@ -392,7 +445,7 @@ module Twilio
 
             ##
             # Deletes the BindingInstance
-            # @return [Boolean] true if delete succeeds, true otherwise
+            # @return [Boolean] true if delete succeeds, false otherwise
             def delete
               context.delete
             end