twilio-api-sdk 1.0.0

data/lib/twilio_ap_is/apis/conversations_v1_message_api.rb

@@ -0,0 +1,497 @@
+# twilio_ap_is
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+module TwilioApIs
+  # ConversationsV1MessageApi
+  class ConversationsV1MessageApi < BaseApi
+    # Add a new message to the conversation
+    # @param [String] conversation_sid Required parameter: The unique ID of the
+    # [Conversation](https://www.twilio.com/docs/conversations/api/conversation-
+    # resource) for this message.
+    # @param [ChannelWebhookEnabledType] x_twilio_webhook_enabled Optional
+    # parameter: The X-Twilio-Webhook-Enabled HTTP request header
+    # @param [String] author Optional parameter: The channel specific identifier
+    # of the message's author. Defaults to `system`.
+    # @param [String] body Optional parameter: The content of the message, can
+    # be up to 1,600 characters long.
+    # @param [DateTime] date_created Optional parameter: The date that this
+    # resource was created.
+    # @param [DateTime] date_updated Optional parameter: The date that this
+    # resource was last updated. `null` if the message has not been edited.
+    # @param [String] attributes Optional parameter: A string metadata field you
+    # can use to store any data you wish. The string value must contain
+    # structurally valid JSON if specified.  **Note** that if the attributes are
+    # not set "{}" will be returned.
+    # @param [String] media_sid Optional parameter: The Media SID to be attached
+    # to the new Message.
+    # @param [String] content_sid Optional parameter: The unique ID of the
+    # multi-channel [Rich Content](https://www.twilio.com/docs/content)
+    # template, required for template-generated messages.  **Note** that if this
+    # field is set, `Body` and `MediaSid` parameters are ignored.
+    # @param [String] content_variables Optional parameter: A structurally valid
+    # JSON string that contains values to resolve Rich Content template
+    # variables.
+    # @param [String] subject Optional parameter: The subject of the message,
+    # can be up to 256 characters long.
+    # @return [ApiResponse] Complete http response with raw body and status code.
+    def create_conversation_message(conversation_sid,
+                                    x_twilio_webhook_enabled: nil,
+                                    author: nil,
+                                    body: nil,
+                                    date_created: nil,
+                                    date_updated: nil,
+                                    attributes: nil,
+                                    media_sid: nil,
+                                    content_sid: nil,
+                                    content_variables: nil,
+                                    subject: nil)
+      @api_call
+        .request(new_request_builder(HttpMethodEnum::POST,
+                                     '/v1/Conversations/{ConversationSid}/Messages',
+                                     Server::DEFAULT2)
+                   .template_param(new_parameter(conversation_sid, key: 'ConversationSid')
+                                    .is_required(true)
+                                    .should_encode(true))
+                   .header_param(new_parameter(x_twilio_webhook_enabled, key: 'X-Twilio-Webhook-Enabled'))
+                   .form_param(new_parameter(author, key: 'Author'))
+                   .form_param(new_parameter(body, key: 'Body'))
+                   .form_param(new_parameter(date_created, key: 'DateCreated'))
+                   .form_param(new_parameter(date_updated, key: 'DateUpdated'))
+                   .form_param(new_parameter(attributes, key: 'Attributes'))
+                   .form_param(new_parameter(media_sid, key: 'MediaSid'))
+                   .form_param(new_parameter(content_sid, key: 'ContentSid'))
+                   .form_param(new_parameter(content_variables, key: 'ContentVariables'))
+                   .form_param(new_parameter(subject, key: 'Subject'))
+                   .header_param(new_parameter('application/x-www-form-urlencoded', key: 'content-type'))
+                   .header_param(new_parameter('application/json', key: 'accept'))
+                   .auth(Single.new('accountSid_authToken')))
+        .response(new_response_handler
+                    .deserializer(APIHelper.method(:custom_type_deserializer))
+                    .deserialize_into(ConversationMessage.method(:from_hash))
+                    .is_api_response(true))
+        .execute
+    end
+
+    # Retrieve a list of all messages in the conversation
+    # @param [String] conversation_sid Required parameter: The unique ID of the
+    # [Conversation](https://www.twilio.com/docs/conversations/api/conversation-
+    # resource) for messages.
+    # @param [ConversationMessageOrderType] order Optional parameter: The sort
+    # order of the returned messages. Can be: `asc` (ascending) or `desc`
+    # (descending), with `asc` as the default.
+    # @param [Integer] page_size Optional parameter: How many resources to
+    # return in each list page. The default is 50, and the maximum is 100.
+    # @param [Integer] page Optional parameter: The page index. This value is
+    # simply for client state.
+    # @param [String] page_token Optional parameter: The page token. This is
+    # provided by the API.
+    # @return [ApiResponse] Complete http response with raw body and status code.
+    def list_conversation_message(conversation_sid,
+                                  order: nil,
+                                  page_size: nil,
+                                  page: nil,
+                                  page_token: nil)
+      @api_call
+        .request(new_request_builder(HttpMethodEnum::GET,
+                                     '/v1/Conversations/{ConversationSid}/Messages',
+                                     Server::DEFAULT2)
+                   .template_param(new_parameter(conversation_sid, key: 'ConversationSid')
+                                    .is_required(true)
+                                    .should_encode(true))
+                   .query_param(new_parameter(order, key: 'Order'))
+                   .query_param(new_parameter(page_size, key: 'PageSize'))
+                   .query_param(new_parameter(page, key: 'Page'))
+                   .query_param(new_parameter(page_token, key: 'PageToken'))
+                   .header_param(new_parameter('application/json', key: 'accept'))
+                   .auth(Single.new('accountSid_authToken')))
+        .response(new_response_handler
+                    .deserializer(APIHelper.method(:custom_type_deserializer))
+                    .deserialize_into(ListConversationMessageResponse.method(:from_hash))
+                    .is_api_response(true))
+        .execute
+    end
+
+    # Update an existing message in the conversation
+    # @param [String] conversation_sid Required parameter: The unique ID of the
+    # [Conversation](https://www.twilio.com/docs/conversations/api/conversation-
+    # resource) for this message.
+    # @param [String] sid Required parameter: A 34 character string that
+    # uniquely identifies this resource.
+    # @param [ChannelWebhookEnabledType] x_twilio_webhook_enabled Optional
+    # parameter: The X-Twilio-Webhook-Enabled HTTP request header
+    # @param [String] author Optional parameter: The channel specific identifier
+    # of the message's author. Defaults to `system`.
+    # @param [String] body Optional parameter: The content of the message, can
+    # be up to 1,600 characters long.
+    # @param [DateTime] date_created Optional parameter: The date that this
+    # resource was created.
+    # @param [DateTime] date_updated Optional parameter: The date that this
+    # resource was last updated. `null` if the message has not been edited.
+    # @param [String] attributes Optional parameter: A string metadata field you
+    # can use to store any data you wish. The string value must contain
+    # structurally valid JSON if specified.  **Note** that if the attributes are
+    # not set "{}" will be returned.
+    # @param [String] subject Optional parameter: The subject of the message,
+    # can be up to 256 characters long.
+    # @return [ApiResponse] Complete http response with raw body and status code.
+    def update_conversation_message(conversation_sid,
+                                    sid,
+                                    x_twilio_webhook_enabled: nil,
+                                    author: nil,
+                                    body: nil,
+                                    date_created: nil,
+                                    date_updated: nil,
+                                    attributes: nil,
+                                    subject: nil)
+      @api_call
+        .request(new_request_builder(HttpMethodEnum::POST,
+                                     '/v1/Conversations/{ConversationSid}/Messages/{Sid}',
+                                     Server::DEFAULT2)
+                   .template_param(new_parameter(conversation_sid, key: 'ConversationSid')
+                                    .is_required(true)
+                                    .should_encode(true))
+                   .template_param(new_parameter(sid, key: 'Sid')
+                                    .is_required(true)
+                                    .should_encode(true))
+                   .header_param(new_parameter(x_twilio_webhook_enabled, key: 'X-Twilio-Webhook-Enabled'))
+                   .form_param(new_parameter(author, key: 'Author'))
+                   .form_param(new_parameter(body, key: 'Body'))
+                   .form_param(new_parameter(date_created, key: 'DateCreated'))
+                   .form_param(new_parameter(date_updated, key: 'DateUpdated'))
+                   .form_param(new_parameter(attributes, key: 'Attributes'))
+                   .form_param(new_parameter(subject, key: 'Subject'))
+                   .header_param(new_parameter('application/x-www-form-urlencoded', key: 'content-type'))
+                   .header_param(new_parameter('application/json', key: 'accept'))
+                   .auth(Single.new('accountSid_authToken')))
+        .response(new_response_handler
+                    .deserializer(APIHelper.method(:custom_type_deserializer))
+                    .deserialize_into(ConversationMessage.method(:from_hash))
+                    .is_api_response(true))
+        .execute
+    end
+
+    # Remove a message from the conversation
+    # @param [String] conversation_sid Required parameter: The unique ID of the
+    # [Conversation](https://www.twilio.com/docs/conversations/api/conversation-
+    # resource) for this message.
+    # @param [String] sid Required parameter: A 34 character string that
+    # uniquely identifies this resource.
+    # @param [ChannelWebhookEnabledType] x_twilio_webhook_enabled Optional
+    # parameter: The X-Twilio-Webhook-Enabled HTTP request header
+    # @return [ApiResponse] Complete http response with raw body and status code.
+    def delete_conversation_message(conversation_sid,
+                                    sid,
+                                    x_twilio_webhook_enabled: nil)
+      @api_call
+        .request(new_request_builder(HttpMethodEnum::DELETE,
+                                     '/v1/Conversations/{ConversationSid}/Messages/{Sid}',
+                                     Server::DEFAULT2)
+                   .template_param(new_parameter(conversation_sid, key: 'ConversationSid')
+                                    .is_required(true)
+                                    .should_encode(true))
+                   .template_param(new_parameter(sid, key: 'Sid')
+                                    .is_required(true)
+                                    .should_encode(true))
+                   .header_param(new_parameter(x_twilio_webhook_enabled, key: 'X-Twilio-Webhook-Enabled'))
+                   .auth(Single.new('accountSid_authToken')))
+        .response(new_response_handler
+                    .is_response_void(true)
+                    .is_api_response(true))
+        .execute
+    end
+
+    # Fetch a message from the conversation
+    # @param [String] conversation_sid Required parameter: The unique ID of the
+    # [Conversation](https://www.twilio.com/docs/conversations/api/conversation-
+    # resource) for this message.
+    # @param [String] sid Required parameter: A 34 character string that
+    # uniquely identifies this resource.
+    # @return [ApiResponse] Complete http response with raw body and status code.
+    def fetch_conversation_message(conversation_sid,
+                                   sid)
+      @api_call
+        .request(new_request_builder(HttpMethodEnum::GET,
+                                     '/v1/Conversations/{ConversationSid}/Messages/{Sid}',
+                                     Server::DEFAULT2)
+                   .template_param(new_parameter(conversation_sid, key: 'ConversationSid')
+                                    .is_required(true)
+                                    .should_encode(true))
+                   .template_param(new_parameter(sid, key: 'Sid')
+                                    .is_required(true)
+                                    .should_encode(true))
+                   .header_param(new_parameter('application/json', key: 'accept'))
+                   .auth(Single.new('accountSid_authToken')))
+        .response(new_response_handler
+                    .deserializer(APIHelper.method(:custom_type_deserializer))
+                    .deserialize_into(ConversationMessage.method(:from_hash))
+                    .is_api_response(true))
+        .execute
+    end
+
+    # Add a new message to the conversation in a specific service
+    # @param [String] chat_service_sid Required parameter: The SID of the
+    # [Conversation
+    # Service](https://www.twilio.com/docs/conversations/api/service-resource)
+    # the Participant resource is associated with.
+    # @param [String] conversation_sid Required parameter: The unique ID of the
+    # [Conversation](https://www.twilio.com/docs/conversations/api/conversation-
+    # resource) for this message.
+    # @param [ChannelWebhookEnabledType] x_twilio_webhook_enabled Optional
+    # parameter: The X-Twilio-Webhook-Enabled HTTP request header
+    # @param [String] author Optional parameter: The channel specific identifier
+    # of the message's author. Defaults to `system`.
+    # @param [String] body Optional parameter: The content of the message, can
+    # be up to 1,600 characters long.
+    # @param [DateTime] date_created Optional parameter: The date that this
+    # resource was created.
+    # @param [DateTime] date_updated Optional parameter: The date that this
+    # resource was last updated. `null` if the message has not been edited.
+    # @param [String] attributes Optional parameter: A string metadata field you
+    # can use to store any data you wish. The string value must contain
+    # structurally valid JSON if specified.  **Note** that if the attributes are
+    # not set "{}" will be returned.
+    # @param [String] media_sid Optional parameter: The Media SID to be attached
+    # to the new Message.
+    # @param [String] content_sid Optional parameter: The unique ID of the
+    # multi-channel [Rich Content](https://www.twilio.com/docs/content)
+    # template, required for template-generated messages.  **Note** that if this
+    # field is set, `Body` and `MediaSid` parameters are ignored.
+    # @param [String] content_variables Optional parameter: A structurally valid
+    # JSON string that contains values to resolve Rich Content template
+    # variables.
+    # @param [String] subject Optional parameter: The subject of the message,
+    # can be up to 256 characters long.
+    # @return [ApiResponse] Complete http response with raw body and status code.
+    def create_service_conversation_message(chat_service_sid,
+                                            conversation_sid,
+                                            x_twilio_webhook_enabled: nil,
+                                            author: nil,
+                                            body: nil,
+                                            date_created: nil,
+                                            date_updated: nil,
+                                            attributes: nil,
+                                            media_sid: nil,
+                                            content_sid: nil,
+                                            content_variables: nil,
+                                            subject: nil)
+      @api_call
+        .request(new_request_builder(HttpMethodEnum::POST,
+                                     '/v1/Services/{ChatServiceSid}/Conversations/{ConversationSid}/Messages',
+                                     Server::DEFAULT2)
+                   .template_param(new_parameter(chat_service_sid, key: 'ChatServiceSid')
+                                    .is_required(true)
+                                    .should_encode(true))
+                   .template_param(new_parameter(conversation_sid, key: 'ConversationSid')
+                                    .is_required(true)
+                                    .should_encode(true))
+                   .header_param(new_parameter(x_twilio_webhook_enabled, key: 'X-Twilio-Webhook-Enabled'))
+                   .form_param(new_parameter(author, key: 'Author'))
+                   .form_param(new_parameter(body, key: 'Body'))
+                   .form_param(new_parameter(date_created, key: 'DateCreated'))
+                   .form_param(new_parameter(date_updated, key: 'DateUpdated'))
+                   .form_param(new_parameter(attributes, key: 'Attributes'))
+                   .form_param(new_parameter(media_sid, key: 'MediaSid'))
+                   .form_param(new_parameter(content_sid, key: 'ContentSid'))
+                   .form_param(new_parameter(content_variables, key: 'ContentVariables'))
+                   .form_param(new_parameter(subject, key: 'Subject'))
+                   .header_param(new_parameter('application/x-www-form-urlencoded', key: 'content-type'))
+                   .header_param(new_parameter('application/json', key: 'accept'))
+                   .auth(Single.new('accountSid_authToken')))
+        .response(new_response_handler
+                    .deserializer(APIHelper.method(:custom_type_deserializer))
+                    .deserialize_into(ServiceConversationMessage.method(:from_hash))
+                    .is_api_response(true))
+        .execute
+    end
+
+    # Retrieve a list of all messages in the conversation
+    # @param [String] chat_service_sid Required parameter: The SID of the
+    # [Conversation
+    # Service](https://www.twilio.com/docs/conversations/api/service-resource)
+    # the Participant resource is associated with.
+    # @param [String] conversation_sid Required parameter: The unique ID of the
+    # [Conversation](https://www.twilio.com/docs/conversations/api/conversation-
+    # resource) for messages.
+    # @param [ServiceConversationMessageOrderType] order Optional parameter: The
+    # sort order of the returned messages. Can be: `asc` (ascending) or `desc`
+    # (descending), with `asc` as the default.
+    # @param [Integer] page_size Optional parameter: How many resources to
+    # return in each list page. The default is 50, and the maximum is 100.
+    # @param [Integer] page Optional parameter: The page index. This value is
+    # simply for client state.
+    # @param [String] page_token Optional parameter: The page token. This is
+    # provided by the API.
+    # @return [ApiResponse] Complete http response with raw body and status code.
+    def list_service_conversation_message(chat_service_sid,
+                                          conversation_sid,
+                                          order: nil,
+                                          page_size: nil,
+                                          page: nil,
+                                          page_token: nil)
+      @api_call
+        .request(new_request_builder(HttpMethodEnum::GET,
+                                     '/v1/Services/{ChatServiceSid}/Conversations/{ConversationSid}/Messages',
+                                     Server::DEFAULT2)
+                   .template_param(new_parameter(chat_service_sid, key: 'ChatServiceSid')
+                                    .is_required(true)
+                                    .should_encode(true))
+                   .template_param(new_parameter(conversation_sid, key: 'ConversationSid')
+                                    .is_required(true)
+                                    .should_encode(true))
+                   .query_param(new_parameter(order, key: 'Order'))
+                   .query_param(new_parameter(page_size, key: 'PageSize'))
+                   .query_param(new_parameter(page, key: 'Page'))
+                   .query_param(new_parameter(page_token, key: 'PageToken'))
+                   .header_param(new_parameter('application/json', key: 'accept'))
+                   .auth(Single.new('accountSid_authToken')))
+        .response(new_response_handler
+                    .deserializer(APIHelper.method(:custom_type_deserializer))
+                    .deserialize_into(ListServiceConversationMessageResponse.method(:from_hash))
+                    .is_api_response(true))
+        .execute
+    end
+
+    # Update an existing message in the conversation
+    # @param [String] chat_service_sid Required parameter: The SID of the
+    # [Conversation
+    # Service](https://www.twilio.com/docs/conversations/api/service-resource)
+    # the Participant resource is associated with.
+    # @param [String] conversation_sid Required parameter: The unique ID of the
+    # [Conversation](https://www.twilio.com/docs/conversations/api/conversation-
+    # resource) for this message.
+    # @param [String] sid Required parameter: A 34 character string that
+    # uniquely identifies this resource.
+    # @param [ChannelWebhookEnabledType] x_twilio_webhook_enabled Optional
+    # parameter: The X-Twilio-Webhook-Enabled HTTP request header
+    # @param [String] author Optional parameter: The channel specific identifier
+    # of the message's author. Defaults to `system`.
+    # @param [String] body Optional parameter: The content of the message, can
+    # be up to 1,600 characters long.
+    # @param [DateTime] date_created Optional parameter: The date that this
+    # resource was created.
+    # @param [DateTime] date_updated Optional parameter: The date that this
+    # resource was last updated. `null` if the message has not been edited.
+    # @param [String] attributes Optional parameter: A string metadata field you
+    # can use to store any data you wish. The string value must contain
+    # structurally valid JSON if specified.  **Note** that if the attributes are
+    # not set "{}" will be returned.
+    # @param [String] subject Optional parameter: The subject of the message,
+    # can be up to 256 characters long.
+    # @return [ApiResponse] Complete http response with raw body and status code.
+    def update_service_conversation_message(chat_service_sid,
+                                            conversation_sid,
+                                            sid,
+                                            x_twilio_webhook_enabled: nil,
+                                            author: nil,
+                                            body: nil,
+                                            date_created: nil,
+                                            date_updated: nil,
+                                            attributes: nil,
+                                            subject: nil)
+      @api_call
+        .request(new_request_builder(HttpMethodEnum::POST,
+                                     '/v1/Services/{ChatServiceSid}/Conversations/{ConversationSid}/Messages/{Sid}',
+                                     Server::DEFAULT2)
+                   .template_param(new_parameter(chat_service_sid, key: 'ChatServiceSid')
+                                    .is_required(true)
+                                    .should_encode(true))
+                   .template_param(new_parameter(conversation_sid, key: 'ConversationSid')
+                                    .is_required(true)
+                                    .should_encode(true))
+                   .template_param(new_parameter(sid, key: 'Sid')
+                                    .is_required(true)
+                                    .should_encode(true))
+                   .header_param(new_parameter(x_twilio_webhook_enabled, key: 'X-Twilio-Webhook-Enabled'))
+                   .form_param(new_parameter(author, key: 'Author'))
+                   .form_param(new_parameter(body, key: 'Body'))
+                   .form_param(new_parameter(date_created, key: 'DateCreated'))
+                   .form_param(new_parameter(date_updated, key: 'DateUpdated'))
+                   .form_param(new_parameter(attributes, key: 'Attributes'))
+                   .form_param(new_parameter(subject, key: 'Subject'))
+                   .header_param(new_parameter('application/x-www-form-urlencoded', key: 'content-type'))
+                   .header_param(new_parameter('application/json', key: 'accept'))
+                   .auth(Single.new('accountSid_authToken')))
+        .response(new_response_handler
+                    .deserializer(APIHelper.method(:custom_type_deserializer))
+                    .deserialize_into(ServiceConversationMessage.method(:from_hash))
+                    .is_api_response(true))
+        .execute
+    end
+
+    # Remove a message from the conversation
+    # @param [String] chat_service_sid Required parameter: The SID of the
+    # [Conversation
+    # Service](https://www.twilio.com/docs/conversations/api/service-resource)
+    # the Participant resource is associated with.
+    # @param [String] conversation_sid Required parameter: The unique ID of the
+    # [Conversation](https://www.twilio.com/docs/conversations/api/conversation-
+    # resource) for this message.
+    # @param [String] sid Required parameter: A 34 character string that
+    # uniquely identifies this resource.
+    # @param [ChannelWebhookEnabledType] x_twilio_webhook_enabled Optional
+    # parameter: The X-Twilio-Webhook-Enabled HTTP request header
+    # @return [ApiResponse] Complete http response with raw body and status code.
+    def delete_service_conversation_message(chat_service_sid,
+                                            conversation_sid,
+                                            sid,
+                                            x_twilio_webhook_enabled: nil)
+      @api_call
+        .request(new_request_builder(HttpMethodEnum::DELETE,
+                                     '/v1/Services/{ChatServiceSid}/Conversations/{ConversationSid}/Messages/{Sid}',
+                                     Server::DEFAULT2)
+                   .template_param(new_parameter(chat_service_sid, key: 'ChatServiceSid')
+                                    .is_required(true)
+                                    .should_encode(true))
+                   .template_param(new_parameter(conversation_sid, key: 'ConversationSid')
+                                    .is_required(true)
+                                    .should_encode(true))
+                   .template_param(new_parameter(sid, key: 'Sid')
+                                    .is_required(true)
+                                    .should_encode(true))
+                   .header_param(new_parameter(x_twilio_webhook_enabled, key: 'X-Twilio-Webhook-Enabled'))
+                   .auth(Single.new('accountSid_authToken')))
+        .response(new_response_handler
+                    .is_response_void(true)
+                    .is_api_response(true))
+        .execute
+    end
+
+    # Fetch a message from the conversation
+    # @param [String] chat_service_sid Required parameter: The SID of the
+    # [Conversation
+    # Service](https://www.twilio.com/docs/conversations/api/service-resource)
+    # the Participant resource is associated with.
+    # @param [String] conversation_sid Required parameter: The unique ID of the
+    # [Conversation](https://www.twilio.com/docs/conversations/api/conversation-
+    # resource) for this message.
+    # @param [String] sid Required parameter: A 34 character string that
+    # uniquely identifies this resource.
+    # @return [ApiResponse] Complete http response with raw body and status code.
+    def fetch_service_conversation_message(chat_service_sid,
+                                           conversation_sid,
+                                           sid)
+      @api_call
+        .request(new_request_builder(HttpMethodEnum::GET,
+                                     '/v1/Services/{ChatServiceSid}/Conversations/{ConversationSid}/Messages/{Sid}',
+                                     Server::DEFAULT2)
+                   .template_param(new_parameter(chat_service_sid, key: 'ChatServiceSid')
+                                    .is_required(true)
+                                    .should_encode(true))
+                   .template_param(new_parameter(conversation_sid, key: 'ConversationSid')
+                                    .is_required(true)
+                                    .should_encode(true))
+                   .template_param(new_parameter(sid, key: 'Sid')
+                                    .is_required(true)
+                                    .should_encode(true))
+                   .header_param(new_parameter('application/json', key: 'accept'))
+                   .auth(Single.new('accountSid_authToken')))
+        .response(new_response_handler
+                    .deserializer(APIHelper.method(:custom_type_deserializer))
+                    .deserialize_into(ServiceConversationMessage.method(:from_hash))
+                    .is_api_response(true))
+        .execute
+    end
+  end
+end

data/lib/twilio_ap_is/apis/conversations_v1_notification_api.rb

@@ -0,0 +1,124 @@
+# twilio_ap_is
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+module TwilioApIs
+  # ConversationsV1NotificationApi
+  class ConversationsV1NotificationApi < BaseApi
+    # Update push notification service settings
+    # @param [String] chat_service_sid Required parameter: The SID of the
+    # [Conversation
+    # Service](https://www.twilio.com/docs/conversations/api/service-resource)
+    # the Configuration applies to.
+    # @param [TrueClass | FalseClass] log_enabled Optional parameter: Weather
+    # the notification logging is enabled.
+    # @param [TrueClass | FalseClass] new_message_enabled Optional parameter:
+    # Whether to send a notification when a new message is added to a
+    # conversation. The default is `false`.
+    # @param [String] new_message_template Optional parameter: The template to
+    # use to create the notification text displayed when a new message is added
+    # to a conversation and `new_message.enabled` is `true`.
+    # @param [String] new_message_sound Optional parameter: The name of the
+    # sound to play when a new message is added to a conversation and
+    # `new_message.enabled` is `true`.
+    # @param [TrueClass | FalseClass] new_message_badge_count_enabled Optional
+    # parameter: Whether the new message badge is enabled. The default is
+    # `false`.
+    # @param [TrueClass | FalseClass] added_to_conversation_enabled Optional
+    # parameter: Whether to send a notification when a participant is added to a
+    # conversation. The default is `false`.
+    # @param [String] added_to_conversation_template Optional parameter: The
+    # template to use to create the notification text displayed when a
+    # participant is added to a conversation and `added_to_conversation.enabled`
+    # is `true`.
+    # @param [String] added_to_conversation_sound Optional parameter: The name
+    # of the sound to play when a participant is added to a conversation and
+    # `added_to_conversation.enabled` is `true`.
+    # @param [TrueClass | FalseClass] removed_from_conversation_enabled Optional
+    # parameter: Whether to send a notification to a user when they are removed
+    # from a conversation. The default is `false`.
+    # @param [String] removed_from_conversation_template Optional parameter: The
+    # template to use to create the notification text displayed to a user when
+    # they are removed from a conversation and
+    # `removed_from_conversation.enabled` is `true`.
+    # @param [String] removed_from_conversation_sound Optional parameter: The
+    # name of the sound to play to a user when they are removed from a
+    # conversation and `removed_from_conversation.enabled` is `true`.
+    # @param [TrueClass | FalseClass] new_message_with_media_enabled Optional
+    # parameter: Whether to send a notification when a new message with
+    # media/file attachments is added to a conversation. The default is
+    # `false`.
+    # @param [String] new_message_with_media_template Optional parameter: The
+    # template to use to create the notification text displayed when a new
+    # message with media/file attachments is added to a conversation and
+    # `new_message.attachments.enabled` is `true`.
+    # @return [ApiResponse] Complete http response with raw body and status code.
+    def update_service_notification(chat_service_sid,
+                                    log_enabled: nil,
+                                    new_message_enabled: nil,
+                                    new_message_template: nil,
+                                    new_message_sound: nil,
+                                    new_message_badge_count_enabled: nil,
+                                    added_to_conversation_enabled: nil,
+                                    added_to_conversation_template: nil,
+                                    added_to_conversation_sound: nil,
+                                    removed_from_conversation_enabled: nil,
+                                    removed_from_conversation_template: nil,
+                                    removed_from_conversation_sound: nil,
+                                    new_message_with_media_enabled: nil,
+                                    new_message_with_media_template: nil)
+      @api_call
+        .request(new_request_builder(HttpMethodEnum::POST,
+                                     '/v1/Services/{ChatServiceSid}/Configuration/Notifications',
+                                     Server::DEFAULT2)
+                   .template_param(new_parameter(chat_service_sid, key: 'ChatServiceSid')
+                                    .is_required(true)
+                                    .should_encode(true))
+                   .form_param(new_parameter(log_enabled, key: 'LogEnabled'))
+                   .form_param(new_parameter(new_message_enabled, key: 'NewMessage.Enabled'))
+                   .form_param(new_parameter(new_message_template, key: 'NewMessage.Template'))
+                   .form_param(new_parameter(new_message_sound, key: 'NewMessage.Sound'))
+                   .form_param(new_parameter(new_message_badge_count_enabled, key: 'NewMessage.BadgeCountEnabled'))
+                   .form_param(new_parameter(added_to_conversation_enabled, key: 'AddedToConversation.Enabled'))
+                   .form_param(new_parameter(added_to_conversation_template, key: 'AddedToConversation.Template'))
+                   .form_param(new_parameter(added_to_conversation_sound, key: 'AddedToConversation.Sound'))
+                   .form_param(new_parameter(removed_from_conversation_enabled, key: 'RemovedFromConversation.Enabled'))
+                   .form_param(new_parameter(removed_from_conversation_template, key: 'RemovedFromConversation.Template'))
+                   .form_param(new_parameter(removed_from_conversation_sound, key: 'RemovedFromConversation.Sound'))
+                   .form_param(new_parameter(new_message_with_media_enabled, key: 'NewMessage.WithMedia.Enabled'))
+                   .form_param(new_parameter(new_message_with_media_template, key: 'NewMessage.WithMedia.Template'))
+                   .header_param(new_parameter('application/x-www-form-urlencoded', key: 'content-type'))
+                   .header_param(new_parameter('application/json', key: 'accept'))
+                   .auth(Single.new('accountSid_authToken')))
+        .response(new_response_handler
+                    .deserializer(APIHelper.method(:custom_type_deserializer))
+                    .deserialize_into(ServiceNotification.method(:from_hash))
+                    .is_api_response(true))
+        .execute
+    end
+
+    # Fetch push notification service settings
+    # @param [String] chat_service_sid Required parameter: The SID of the
+    # [Conversation
+    # Service](https://www.twilio.com/docs/conversations/api/service-resource)
+    # the Configuration applies to.
+    # @return [ApiResponse] Complete http response with raw body and status code.
+    def fetch_service_notification(chat_service_sid)
+      @api_call
+        .request(new_request_builder(HttpMethodEnum::GET,
+                                     '/v1/Services/{ChatServiceSid}/Configuration/Notifications',
+                                     Server::DEFAULT2)
+                   .template_param(new_parameter(chat_service_sid, key: 'ChatServiceSid')
+                                    .is_required(true)
+                                    .should_encode(true))
+                   .header_param(new_parameter('application/json', key: 'accept'))
+                   .auth(Single.new('accountSid_authToken')))
+        .response(new_response_handler
+                    .deserializer(APIHelper.method(:custom_type_deserializer))
+                    .deserialize_into(ServiceNotification.method(:from_hash))
+                    .is_api_response(true))
+        .execute
+    end
+  end
+end