lib/twilio-ruby/rest/conversations/v1/conversation/webhook.rb in twilio-ruby-5.40.2 vs lib/twilio-ruby/rest/conversations/v1/conversation/webhook.rb in twilio-ruby-5.40.3

- old
+ new

@@ -15,12 +15,13 @@ # PLEASE NOTE that this class contains beta products that are subject to change. Use them with caution. class WebhookList < ListResource ## # Initialize the WebhookList # @param [Version] version Version that contains the resource - # @param [String] conversation_sid The unique id of the - # [Conversation](https://www.twilio.com/docs/conversations/api/conversation-resource) for this webhook. + # @param [String] conversation_sid The unique ID of the + # [Conversation](https://www.twilio.com/docs/conversations/api/conversation-resource) + # for this webhook. # @return [WebhookList] WebhookList def initialize(version, conversation_sid: nil) super(version) # Path Solution @@ -118,11 +119,11 @@ # sending a webhook request. # @param [String] configuration_filters The list of events, firing webhook event # for this Conversation. # @param [String] configuration_triggers The list of keywords, firing webhook # event for this Conversation. - # @param [String] configuration_flow_sid The studio flow sid, where the webhook + # @param [String] configuration_flow_sid The studio flow SID, where the webhook # should be sent to. # @param [String] configuration_replay_after The message index for which and it's # successors the webhook will be replayed. Not set by default # @return [WebhookInstance] Created WebhookInstance def create(target: nil, configuration_url: :unset, configuration_method: :unset, configuration_filters: :unset, configuration_triggers: :unset, configuration_flow_sid: :unset, configuration_replay_after: :unset) @@ -183,12 +184,13 @@ # PLEASE NOTE that this class contains beta products that are subject to change. Use them with caution. class WebhookContext < InstanceContext ## # Initialize the WebhookContext # @param [Version] version Version that contains the resource - # @param [String] conversation_sid The unique id of the - # [Conversation](https://www.twilio.com/docs/conversations/api/conversation-resource) for this webhook. + # @param [String] conversation_sid The unique ID of the + # [Conversation](https://www.twilio.com/docs/conversations/api/conversation-resource) + # for this webhook. # @param [String] sid A 34 character string that uniquely identifies this # resource. # @return [WebhookContext] WebhookContext def initialize(version, conversation_sid, sid) super(version) @@ -220,11 +222,11 @@ # sending a webhook request. # @param [String] configuration_filters The list of events, firing webhook event # for this Conversation. # @param [String] configuration_triggers The list of keywords, firing webhook # event for this Conversation. - # @param [String] configuration_flow_sid The studio flow sid, where the webhook + # @param [String] configuration_flow_sid The studio flow SID, where the webhook # should be sent to. # @return [WebhookInstance] Updated WebhookInstance def update(configuration_url: :unset, configuration_method: :unset, configuration_filters: :unset, configuration_triggers: :unset, configuration_flow_sid: :unset) data = Twilio::Values.of({ 'Configuration.Url' => configuration_url, @@ -271,12 +273,13 @@ class WebhookInstance < InstanceResource ## # Initialize the WebhookInstance # @param [Version] version Version that contains the resource # @param [Hash] payload payload that contains response from Twilio - # @param [String] conversation_sid The unique id of the - # [Conversation](https://www.twilio.com/docs/conversations/api/conversation-resource) for this webhook. + # @param [String] conversation_sid The unique ID of the + # [Conversation](https://www.twilio.com/docs/conversations/api/conversation-resource) + # for this webhook. # @param [String] sid A 34 character string that uniquely identifies this # resource. # @return [WebhookInstance] WebhookInstance def initialize(version, payload, conversation_sid: nil, sid: nil) super(version) @@ -314,17 +317,17 @@ def sid @properties['sid'] end ## - # @return [String] The unique id of the Account responsible for this conversation. + # @return [String] The unique ID of the Account responsible for this conversation. def account_sid @properties['account_sid'] end ## - # @return [String] The unique id of the Conversation for this webhook. + # @return [String] The unique ID of the Conversation for this webhook. def conversation_sid @properties['conversation_sid'] end ## @@ -372,10 +375,10 @@ # sending a webhook request. # @param [String] configuration_filters The list of events, firing webhook event # for this Conversation. # @param [String] configuration_triggers The list of keywords, firing webhook # event for this Conversation. - # @param [String] configuration_flow_sid The studio flow sid, where the webhook + # @param [String] configuration_flow_sid The studio flow SID, where the webhook # should be sent to. # @return [WebhookInstance] Updated WebhookInstance def update(configuration_url: :unset, configuration_method: :unset, configuration_filters: :unset, configuration_triggers: :unset, configuration_flow_sid: :unset) context.update( configuration_url: configuration_url, \ No newline at end of file