twilio-api-sdk 1.0.0

data/lib/twilio_ap_is/apis/conversations_v1_role_api.rb

@@ -0,0 +1,325 @@
+# twilio_ap_is
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+module TwilioApIs
+  # ConversationsV1RoleApi
+  class ConversationsV1RoleApi < BaseApi
+    # Create a new user role in your account's default service
+    # @param [String] friendly_name Required parameter: A descriptive string
+    # that you create to describe the new resource. It can be up to 64
+    # characters long.
+    # @param [RoleRoleType] type Required parameter: The type of role. Can be:
+    # `conversation` for
+    # [Conversation](https://www.twilio.com/docs/conversations/api/conversation-
+    # resource) roles or `service` for [Conversation
+    # Service](https://www.twilio.com/docs/conversations/api/service-resource)
+    # roles.
+    # @param [Array[String]] permission Required parameter: A permission that
+    # you grant to the new role. Only one permission can be granted per
+    # parameter. To assign more than one permission, repeat this parameter for
+    # each permission value. The values for this parameter depend on the role's
+    # `type`.
+    # @return [ApiResponse] Complete http response with raw body and status code.
+    def create_role(friendly_name,
+                    type,
+                    permission)
+      @api_call
+        .request(new_request_builder(HttpMethodEnum::POST,
+                                     '/v1/Roles',
+                                     Server::DEFAULT2)
+                   .form_param(new_parameter(friendly_name, key: 'FriendlyName')
+                                .is_required(true))
+                   .form_param(new_parameter(type, key: 'Type')
+                                .is_required(true))
+                   .form_param(new_parameter(permission, key: 'Permission')
+                                .is_required(true))
+                   .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(Role.method(:from_hash))
+                    .is_api_response(true))
+        .execute
+    end
+
+    # Retrieve a list of all user roles in your account's default service
+    # @param [Integer] page_size Optional parameter: How many resources to
+    # return in each list page. The default is 50, and the maximum is 50.
+    # @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_role(page_size: nil,
+                  page: nil,
+                  page_token: nil)
+      @api_call
+        .request(new_request_builder(HttpMethodEnum::GET,
+                                     '/v1/Roles',
+                                     Server::DEFAULT2)
+                   .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(ListRoleResponse.method(:from_hash))
+                    .is_api_response(true))
+        .execute
+    end
+
+    # Update an existing user role in your account's default service
+    # @param [String] sid Required parameter: The SID of the Role resource to
+    # update.
+    # @param [Array[String]] permission Required parameter: A permission that
+    # you grant to the role. Only one permission can be granted per parameter.
+    # To assign more than one permission, repeat this parameter for each
+    # permission value. Note that the update action replaces all previously
+    # assigned permissions with those defined in the update action. To remove a
+    # permission, do not include it in the subsequent update action. The values
+    # for this parameter depend on the role's `type`.
+    # @return [ApiResponse] Complete http response with raw body and status code.
+    def update_role(sid,
+                    permission)
+      @api_call
+        .request(new_request_builder(HttpMethodEnum::POST,
+                                     '/v1/Roles/{Sid}',
+                                     Server::DEFAULT2)
+                   .template_param(new_parameter(sid, key: 'Sid')
+                                    .is_required(true)
+                                    .should_encode(true))
+                   .form_param(new_parameter(permission, key: 'Permission')
+                                .is_required(true))
+                   .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(Role.method(:from_hash))
+                    .is_api_response(true))
+        .execute
+    end
+
+    # Remove a user role from your account's default service
+    # @param [String] sid Required parameter: The SID of the Role resource to
+    # delete.
+    # @return [ApiResponse] Complete http response with raw body and status code.
+    def delete_role(sid)
+      @api_call
+        .request(new_request_builder(HttpMethodEnum::DELETE,
+                                     '/v1/Roles/{Sid}',
+                                     Server::DEFAULT2)
+                   .template_param(new_parameter(sid, key: 'Sid')
+                                    .is_required(true)
+                                    .should_encode(true))
+                   .auth(Single.new('accountSid_authToken')))
+        .response(new_response_handler
+                    .is_response_void(true)
+                    .is_api_response(true))
+        .execute
+    end
+
+    # Fetch a user role from your account's default service
+    # @param [String] sid Required parameter: The SID of the Role resource to
+    # fetch.
+    # @return [ApiResponse] Complete http response with raw body and status code.
+    def fetch_role(sid)
+      @api_call
+        .request(new_request_builder(HttpMethodEnum::GET,
+                                     '/v1/Roles/{Sid}',
+                                     Server::DEFAULT2)
+                   .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(Role.method(:from_hash))
+                    .is_api_response(true))
+        .execute
+    end
+
+    # Create a new user role in your service
+    # @param [String] chat_service_sid Required parameter: The SID of the
+    # [Conversation
+    # Service](https://www.twilio.com/docs/conversations/api/service-resource)
+    # to create the Role resource under.
+    # @param [String] friendly_name Required parameter: A descriptive string
+    # that you create to describe the new resource. It can be up to 64
+    # characters long.
+    # @param [ServiceRoleRoleType] type Required parameter: The type of role.
+    # Can be: `conversation` for
+    # [Conversation](https://www.twilio.com/docs/conversations/api/conversation-
+    # resource) roles or `service` for [Conversation
+    # Service](https://www.twilio.com/docs/conversations/api/service-resource)
+    # roles.
+    # @param [Array[String]] permission Required parameter: A permission that
+    # you grant to the new role. Only one permission can be granted per
+    # parameter. To assign more than one permission, repeat this parameter for
+    # each permission value. The values for this parameter depend on the role's
+    # `type`.
+    # @return [ApiResponse] Complete http response with raw body and status code.
+    def create_service_role(chat_service_sid,
+                            friendly_name,
+                            type,
+                            permission)
+      @api_call
+        .request(new_request_builder(HttpMethodEnum::POST,
+                                     '/v1/Services/{ChatServiceSid}/Roles',
+                                     Server::DEFAULT2)
+                   .template_param(new_parameter(chat_service_sid, key: 'ChatServiceSid')
+                                    .is_required(true)
+                                    .should_encode(true))
+                   .form_param(new_parameter(friendly_name, key: 'FriendlyName')
+                                .is_required(true))
+                   .form_param(new_parameter(type, key: 'Type')
+                                .is_required(true))
+                   .form_param(new_parameter(permission, key: 'Permission')
+                                .is_required(true))
+                   .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(ServiceRole.method(:from_hash))
+                    .is_api_response(true))
+        .execute
+    end
+
+    # Retrieve a list of all user roles in your service
+    # @param [String] chat_service_sid Required parameter: The SID of the
+    # [Conversation
+    # Service](https://www.twilio.com/docs/conversations/api/service-resource)
+    # to read the Role resources from.
+    # @param [Integer] page_size Optional parameter: How many resources to
+    # return in each list page. The default is 50, and the maximum is 50.
+    # @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_role(chat_service_sid,
+                          page_size: nil,
+                          page: nil,
+                          page_token: nil)
+      @api_call
+        .request(new_request_builder(HttpMethodEnum::GET,
+                                     '/v1/Services/{ChatServiceSid}/Roles',
+                                     Server::DEFAULT2)
+                   .template_param(new_parameter(chat_service_sid, key: 'ChatServiceSid')
+                                    .is_required(true)
+                                    .should_encode(true))
+                   .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(ListServiceRoleResponse.method(:from_hash))
+                    .is_api_response(true))
+        .execute
+    end
+
+    # Update an existing user role in your service
+    # @param [String] chat_service_sid Required parameter: The SID of the
+    # [Conversation
+    # Service](https://www.twilio.com/docs/conversations/api/service-resource)
+    # to update the Role resource in.
+    # @param [String] sid Required parameter: The SID of the Role resource to
+    # update.
+    # @param [Array[String]] permission Required parameter: A permission that
+    # you grant to the role. Only one permission can be granted per parameter.
+    # To assign more than one permission, repeat this parameter for each
+    # permission value. Note that the update action replaces all previously
+    # assigned permissions with those defined in the update action. To remove a
+    # permission, do not include it in the subsequent update action. The values
+    # for this parameter depend on the role's `type`.
+    # @return [ApiResponse] Complete http response with raw body and status code.
+    def update_service_role(chat_service_sid,
+                            sid,
+                            permission)
+      @api_call
+        .request(new_request_builder(HttpMethodEnum::POST,
+                                     '/v1/Services/{ChatServiceSid}/Roles/{Sid}',
+                                     Server::DEFAULT2)
+                   .template_param(new_parameter(chat_service_sid, key: 'ChatServiceSid')
+                                    .is_required(true)
+                                    .should_encode(true))
+                   .template_param(new_parameter(sid, key: 'Sid')
+                                    .is_required(true)
+                                    .should_encode(true))
+                   .form_param(new_parameter(permission, key: 'Permission')
+                                .is_required(true))
+                   .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(ServiceRole.method(:from_hash))
+                    .is_api_response(true))
+        .execute
+    end
+
+    # Remove a user role from your service
+    # @param [String] chat_service_sid Required parameter: The SID of the
+    # [Conversation
+    # Service](https://www.twilio.com/docs/conversations/api/service-resource)
+    # to delete the Role resource from.
+    # @param [String] sid Required parameter: The SID of the Role resource to
+    # delete.
+    # @return [ApiResponse] Complete http response with raw body and status code.
+    def delete_service_role(chat_service_sid,
+                            sid)
+      @api_call
+        .request(new_request_builder(HttpMethodEnum::DELETE,
+                                     '/v1/Services/{ChatServiceSid}/Roles/{Sid}',
+                                     Server::DEFAULT2)
+                   .template_param(new_parameter(chat_service_sid, key: 'ChatServiceSid')
+                                    .is_required(true)
+                                    .should_encode(true))
+                   .template_param(new_parameter(sid, key: 'Sid')
+                                    .is_required(true)
+                                    .should_encode(true))
+                   .auth(Single.new('accountSid_authToken')))
+        .response(new_response_handler
+                    .is_response_void(true)
+                    .is_api_response(true))
+        .execute
+    end
+
+    # Fetch a user role from your service
+    # @param [String] chat_service_sid Required parameter: The SID of the
+    # [Conversation
+    # Service](https://www.twilio.com/docs/conversations/api/service-resource)
+    # to fetch the Role resource from.
+    # @param [String] sid Required parameter: The SID of the Role resource to
+    # fetch.
+    # @return [ApiResponse] Complete http response with raw body and status code.
+    def fetch_service_role(chat_service_sid,
+                           sid)
+      @api_call
+        .request(new_request_builder(HttpMethodEnum::GET,
+                                     '/v1/Services/{ChatServiceSid}/Roles/{Sid}',
+                                     Server::DEFAULT2)
+                   .template_param(new_parameter(chat_service_sid, key: 'ChatServiceSid')
+                                    .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(ServiceRole.method(:from_hash))
+                    .is_api_response(true))
+        .execute
+    end
+  end
+end

data/lib/twilio_ap_is/apis/conversations_v1_service_api.rb

@@ -0,0 +1,98 @@
+# twilio_ap_is
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+module TwilioApIs
+  # ConversationsV1ServiceApi
+  class ConversationsV1ServiceApi < BaseApi
+    # Create a new conversation service on your account
+    # @param [String] friendly_name Required parameter: The human-readable name
+    # of this service, limited to 256 characters. Optional.
+    # @return [ApiResponse] Complete http response with raw body and status code.
+    def create_service(friendly_name)
+      @api_call
+        .request(new_request_builder(HttpMethodEnum::POST,
+                                     '/v1/Services',
+                                     Server::DEFAULT2)
+                   .form_param(new_parameter(friendly_name, key: 'FriendlyName')
+                                .is_required(true))
+                   .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(Service.method(:from_hash))
+                    .is_api_response(true))
+        .execute
+    end
+
+    # Retrieve a list of all conversation services on your account
+    # @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(page_size: nil,
+                     page: nil,
+                     page_token: nil)
+      @api_call
+        .request(new_request_builder(HttpMethodEnum::GET,
+                                     '/v1/Services',
+                                     Server::DEFAULT2)
+                   .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(ListServiceResponse.method(:from_hash))
+                    .is_api_response(true))
+        .execute
+    end
+
+    # Remove a conversation service with all its nested resources from your
+    # account
+    # @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 delete_service(sid)
+      @api_call
+        .request(new_request_builder(HttpMethodEnum::DELETE,
+                                     '/v1/Services/{Sid}',
+                                     Server::DEFAULT2)
+                   .template_param(new_parameter(sid, key: 'Sid')
+                                    .is_required(true)
+                                    .should_encode(true))
+                   .auth(Single.new('accountSid_authToken')))
+        .response(new_response_handler
+                    .is_response_void(true)
+                    .is_api_response(true))
+        .execute
+    end
+
+    # Fetch a conversation service from your account
+    # @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(sid)
+      @api_call
+        .request(new_request_builder(HttpMethodEnum::GET,
+                                     '/v1/Services/{Sid}',
+                                     Server::DEFAULT2)
+                   .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(Service.method(:from_hash))
+                    .is_api_response(true))
+        .execute
+    end
+  end
+end