twilio-api-sdk 1.0.0

data/lib/twilio_ap_is/models/service_user.rb

@@ -0,0 +1,250 @@
+# twilio_ap_is
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+require 'date'
+module TwilioApIs
+  # ServiceUser Model.
+  class ServiceUser < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # The unique string that we created to identify the User resource.
+    # @return [String]
+    attr_accessor :sid
+
+    # The SID of the [Account](https://www.twilio.com/docs/iam/api/account) that
+    # created the User resource.
+    # @return [String]
+    attr_accessor :account_sid
+
+    # The SID of the [Conversation
+    # Service](https://www.twilio.com/docs/conversations/api/service-resource)
+    # the User resource is associated with.
+    # @return [String]
+    attr_accessor :chat_service_sid
+
+    # The SID of a service-level
+    # [Role](https://www.twilio.com/docs/conversations/api/role-resource)
+    # assigned to the user.
+    # @return [String]
+    attr_accessor :role_sid
+
+    # The application-defined string that uniquely identifies the resource's
+    # User within the [Conversation
+    # Service](https://www.twilio.com/docs/conversations/api/service-resource).
+    # This value is often a username or an email address, and is case-sensitive.
+    # @return [String]
+    attr_accessor :identity
+
+    # The string that you assigned to describe the resource.
+    # @return [String]
+    attr_accessor :friendly_name
+
+    # The JSON Object string that stores application-specific data. If
+    # attributes have not been set, `{}` is returned.
+    # @return [String]
+    attr_accessor :attributes
+
+    # Whether the User is actively connected to this Conversations Service and
+    # online. This value is only returned by Fetch actions that return a single
+    # resource and `null` is always returned by a Read action. This value is
+    # `null` if the Service's `reachability_enabled` is `false`, if the User has
+    # never been online for this Conversations Service, even if the Service's
+    # `reachability_enabled` is `true`.
+    # @return [TrueClass | FalseClass]
+    attr_accessor :is_online
+
+    # Whether the User has a potentially valid Push Notification registration
+    # (APN or GCM) for this Conversations Service. If at least one registration
+    # exists, `true`; otherwise `false`. This value is only returned by Fetch
+    # actions that return a single resource and `null` is always returned by a
+    # Read action. This value is `null` if the Service's `reachability_enabled`
+    # is `false`, and if the User has never had a notification registration,
+    # even if the Service's `reachability_enabled` is `true`.
+    # @return [TrueClass | FalseClass]
+    attr_accessor :is_notifiable
+
+    # The date and time in GMT when the resource was created specified in [ISO
+    # 8601](https://en.wikipedia.org/wiki/ISO_8601) format.
+    # @return [DateTime]
+    attr_accessor :date_created
+
+    # The date and time in GMT when the resource was last updated specified in
+    # [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format.
+    # @return [DateTime]
+    attr_accessor :date_updated
+
+    # An absolute API resource URL for this user.
+    # @return [String]
+    attr_accessor :url
+
+    # An absolute API resource URL for this user.
+    # @return [Object]
+    attr_accessor :links
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['sid'] = 'sid'
+      @_hash['account_sid'] = 'account_sid'
+      @_hash['chat_service_sid'] = 'chat_service_sid'
+      @_hash['role_sid'] = 'role_sid'
+      @_hash['identity'] = 'identity'
+      @_hash['friendly_name'] = 'friendly_name'
+      @_hash['attributes'] = 'attributes'
+      @_hash['is_online'] = 'is_online'
+      @_hash['is_notifiable'] = 'is_notifiable'
+      @_hash['date_created'] = 'date_created'
+      @_hash['date_updated'] = 'date_updated'
+      @_hash['url'] = 'url'
+      @_hash['links'] = 'links'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        sid
+        account_sid
+        chat_service_sid
+        role_sid
+        identity
+        friendly_name
+        attributes
+        is_online
+        is_notifiable
+        date_created
+        date_updated
+        url
+        links
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      %w[
+        sid
+        account_sid
+        chat_service_sid
+        role_sid
+        identity
+        friendly_name
+        attributes
+        is_online
+        is_notifiable
+        date_created
+        date_updated
+        url
+        links
+      ]
+    end
+
+    def initialize(sid: SKIP, account_sid: SKIP, chat_service_sid: SKIP,
+                   role_sid: SKIP, identity: SKIP, friendly_name: SKIP,
+                   attributes: SKIP, is_online: SKIP, is_notifiable: SKIP,
+                   date_created: SKIP, date_updated: SKIP, url: SKIP,
+                   links: SKIP, additional_properties: nil)
+      # Add additional model properties to the instance
+      additional_properties = {} if additional_properties.nil?
+
+      @sid = sid unless sid == SKIP
+      @account_sid = account_sid unless account_sid == SKIP
+      @chat_service_sid = chat_service_sid unless chat_service_sid == SKIP
+      @role_sid = role_sid unless role_sid == SKIP
+      @identity = identity unless identity == SKIP
+      @friendly_name = friendly_name unless friendly_name == SKIP
+      @attributes = attributes unless attributes == SKIP
+      @is_online = is_online unless is_online == SKIP
+      @is_notifiable = is_notifiable unless is_notifiable == SKIP
+      @date_created = date_created unless date_created == SKIP
+      @date_updated = date_updated unless date_updated == SKIP
+      @url = url unless url == SKIP
+      @links = links unless links == SKIP
+      @additional_properties = additional_properties
+    end
+
+    # Creates an instance of the object from a hash.
+    def self.from_hash(hash)
+      return nil unless hash
+
+      # Extract variables from the hash.
+      sid = hash.key?('sid') ? hash['sid'] : SKIP
+      account_sid = hash.key?('account_sid') ? hash['account_sid'] : SKIP
+      chat_service_sid =
+        hash.key?('chat_service_sid') ? hash['chat_service_sid'] : SKIP
+      role_sid = hash.key?('role_sid') ? hash['role_sid'] : SKIP
+      identity = hash.key?('identity') ? hash['identity'] : SKIP
+      friendly_name = hash.key?('friendly_name') ? hash['friendly_name'] : SKIP
+      attributes = hash.key?('attributes') ? hash['attributes'] : SKIP
+      is_online = hash.key?('is_online') ? hash['is_online'] : SKIP
+      is_notifiable = hash.key?('is_notifiable') ? hash['is_notifiable'] : SKIP
+      date_created = if hash.key?('date_created')
+                       (DateTimeHelper.from_rfc3339(hash['date_created']) if hash['date_created'])
+                     else
+                       SKIP
+                     end
+      date_updated = if hash.key?('date_updated')
+                       (DateTimeHelper.from_rfc3339(hash['date_updated']) if hash['date_updated'])
+                     else
+                       SKIP
+                     end
+      url = hash.key?('url') ? hash['url'] : SKIP
+      links = hash.key?('links') ? hash['links'] : SKIP
+
+      # Create a new hash for additional properties, removing known properties.
+      new_hash = hash.reject { |k, _| names.value?(k) }
+
+      additional_properties = APIHelper.get_additional_properties(
+        new_hash, proc { |value| value }
+      )
+
+      # Create object from extracted values.
+      ServiceUser.new(sid: sid,
+                      account_sid: account_sid,
+                      chat_service_sid: chat_service_sid,
+                      role_sid: role_sid,
+                      identity: identity,
+                      friendly_name: friendly_name,
+                      attributes: attributes,
+                      is_online: is_online,
+                      is_notifiable: is_notifiable,
+                      date_created: date_created,
+                      date_updated: date_updated,
+                      url: url,
+                      links: links,
+                      additional_properties: additional_properties)
+    end
+
+    def to_custom_date_created
+      DateTimeHelper.to_rfc3339(date_created)
+    end
+
+    def to_custom_date_updated
+      DateTimeHelper.to_rfc3339(date_updated)
+    end
+
+    # Provides a human-readable string representation of the object.
+    def to_s
+      class_name = self.class.name.split('::').last
+      "<#{class_name} sid: #{@sid}, account_sid: #{@account_sid}, chat_service_sid:"\
+      " #{@chat_service_sid}, role_sid: #{@role_sid}, identity: #{@identity}, friendly_name:"\
+      " #{@friendly_name}, attributes: #{@attributes}, is_online: #{@is_online}, is_notifiable:"\
+      " #{@is_notifiable}, date_created: #{@date_created}, date_updated: #{@date_updated}, url:"\
+      " #{@url}, links: #{@links}, additional_properties: #{@additional_properties}>"
+    end
+
+    # Provides a debugging-friendly string with detailed object information.
+    def inspect
+      class_name = self.class.name.split('::').last
+      "<#{class_name} sid: #{@sid.inspect}, account_sid: #{@account_sid.inspect},"\
+      " chat_service_sid: #{@chat_service_sid.inspect}, role_sid: #{@role_sid.inspect}, identity:"\
+      " #{@identity.inspect}, friendly_name: #{@friendly_name.inspect}, attributes:"\
+      " #{@attributes.inspect}, is_online: #{@is_online.inspect}, is_notifiable:"\
+      " #{@is_notifiable.inspect}, date_created: #{@date_created.inspect}, date_updated:"\
+      " #{@date_updated.inspect}, url: #{@url.inspect}, links: #{@links.inspect},"\
+      " additional_properties: #{@additional_properties}>"
+    end
+  end
+end

data/lib/twilio_ap_is/models/service_user_conversation.rb

@@ -0,0 +1,317 @@
+# twilio_ap_is
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+require 'date'
+module TwilioApIs
+  # ServiceUserConversation Model.
+  class ServiceUserConversation < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # The unique ID of the
+    # [Account](https://www.twilio.com/docs/iam/api/account) responsible for
+    # this conversation.
+    # @return [String]
+    attr_accessor :account_sid
+
+    # The unique ID of the [Conversation
+    # Service](https://www.twilio.com/docs/conversations/api/service-resource)
+    # this conversation belongs to.
+    # @return [String]
+    attr_accessor :chat_service_sid
+
+    # The unique ID of the
+    # [Conversation](https://www.twilio.com/docs/conversations/api/conversation-
+    # resource) for this User Conversation.
+    # @return [String]
+    attr_accessor :conversation_sid
+
+    # The number of unread Messages in the Conversation for the Participant.
+    # @return [Integer]
+    attr_accessor :unread_messages_count
+
+    # The index of the last Message in the Conversation that the Participant has
+    # read.
+    # @return [Integer]
+    attr_accessor :last_read_message_index
+
+    # The unique ID of the
+    # [participant](https://www.twilio.com/docs/conversations/api/conversation-p
+    # articipant-resource) the user conversation belongs to.
+    # @return [String]
+    attr_accessor :participant_sid
+
+    # The unique string that identifies the [User
+    # resource](https://www.twilio.com/docs/conversations/api/user-resource).
+    # @return [String]
+    attr_accessor :user_sid
+
+    # The human-readable name of this conversation, limited to 256 characters.
+    # Optional.
+    # @return [String]
+    attr_accessor :friendly_name
+
+    # The current state of this User Conversation. One of `inactive`, `active`
+    # or `closed`.
+    # @return [ServiceUserConversationState]
+    attr_accessor :conversation_state
+
+    # Timer date values representing state update for this conversation.
+    # @return [Object]
+    attr_accessor :timers
+
+    # An optional 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.
+    # @return [String]
+    attr_accessor :attributes
+
+    # The date that this conversation was created, given in ISO 8601 format.
+    # @return [DateTime]
+    attr_accessor :date_created
+
+    # The date that this conversation was last updated, given in ISO 8601
+    # format.
+    # @return [DateTime]
+    attr_accessor :date_updated
+
+    # Identity of the creator of this Conversation.
+    # @return [String]
+    attr_accessor :created_by
+
+    # The Notification Level of this User Conversation. One of `default` or
+    # `muted`.
+    # @return [ServiceUserConversationNotificationLevel]
+    attr_accessor :notification_level
+
+    # An application-defined string that uniquely identifies the Conversation
+    # resource. It can be used to address the resource in place of the
+    # resource's `conversation_sid` in the URL.
+    # @return [String]
+    attr_accessor :unique_name
+
+    # An application-defined string that uniquely identifies the Conversation
+    # resource. It can be used to address the resource in place of the
+    # resource's `conversation_sid` in the URL.
+    # @return [String]
+    attr_accessor :url
+
+    # Contains absolute URLs to access the
+    # [participant](https://www.twilio.com/docs/conversations/api/conversation-p
+    # articipant-resource) and
+    # [conversation](https://www.twilio.com/docs/conversations/api/conversation-
+    # resource) of this conversation.
+    # @return [Object]
+    attr_accessor :links
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['account_sid'] = 'account_sid'
+      @_hash['chat_service_sid'] = 'chat_service_sid'
+      @_hash['conversation_sid'] = 'conversation_sid'
+      @_hash['unread_messages_count'] = 'unread_messages_count'
+      @_hash['last_read_message_index'] = 'last_read_message_index'
+      @_hash['participant_sid'] = 'participant_sid'
+      @_hash['user_sid'] = 'user_sid'
+      @_hash['friendly_name'] = 'friendly_name'
+      @_hash['conversation_state'] = 'conversation_state'
+      @_hash['timers'] = 'timers'
+      @_hash['attributes'] = 'attributes'
+      @_hash['date_created'] = 'date_created'
+      @_hash['date_updated'] = 'date_updated'
+      @_hash['created_by'] = 'created_by'
+      @_hash['notification_level'] = 'notification_level'
+      @_hash['unique_name'] = 'unique_name'
+      @_hash['url'] = 'url'
+      @_hash['links'] = 'links'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        account_sid
+        chat_service_sid
+        conversation_sid
+        unread_messages_count
+        last_read_message_index
+        participant_sid
+        user_sid
+        friendly_name
+        conversation_state
+        timers
+        attributes
+        date_created
+        date_updated
+        created_by
+        notification_level
+        unique_name
+        url
+        links
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      %w[
+        account_sid
+        chat_service_sid
+        conversation_sid
+        unread_messages_count
+        last_read_message_index
+        participant_sid
+        user_sid
+        friendly_name
+        timers
+        attributes
+        date_created
+        date_updated
+        created_by
+        unique_name
+        url
+        links
+      ]
+    end
+
+    def initialize(account_sid: SKIP, chat_service_sid: SKIP,
+                   conversation_sid: SKIP, unread_messages_count: SKIP,
+                   last_read_message_index: SKIP, participant_sid: SKIP,
+                   user_sid: SKIP, friendly_name: SKIP,
+                   conversation_state: SKIP, timers: SKIP, attributes: SKIP,
+                   date_created: SKIP, date_updated: SKIP, created_by: SKIP,
+                   notification_level: SKIP, unique_name: SKIP, url: SKIP,
+                   links: SKIP, additional_properties: nil)
+      # Add additional model properties to the instance
+      additional_properties = {} if additional_properties.nil?
+
+      @account_sid = account_sid unless account_sid == SKIP
+      @chat_service_sid = chat_service_sid unless chat_service_sid == SKIP
+      @conversation_sid = conversation_sid unless conversation_sid == SKIP
+      @unread_messages_count = unread_messages_count unless unread_messages_count == SKIP
+      @last_read_message_index = last_read_message_index unless last_read_message_index == SKIP
+      @participant_sid = participant_sid unless participant_sid == SKIP
+      @user_sid = user_sid unless user_sid == SKIP
+      @friendly_name = friendly_name unless friendly_name == SKIP
+      @conversation_state = conversation_state unless conversation_state == SKIP
+      @timers = timers unless timers == SKIP
+      @attributes = attributes unless attributes == SKIP
+      @date_created = date_created unless date_created == SKIP
+      @date_updated = date_updated unless date_updated == SKIP
+      @created_by = created_by unless created_by == SKIP
+      @notification_level = notification_level unless notification_level == SKIP
+      @unique_name = unique_name unless unique_name == SKIP
+      @url = url unless url == SKIP
+      @links = links unless links == SKIP
+      @additional_properties = additional_properties
+    end
+
+    # Creates an instance of the object from a hash.
+    def self.from_hash(hash)
+      return nil unless hash
+
+      # Extract variables from the hash.
+      account_sid = hash.key?('account_sid') ? hash['account_sid'] : SKIP
+      chat_service_sid =
+        hash.key?('chat_service_sid') ? hash['chat_service_sid'] : SKIP
+      conversation_sid =
+        hash.key?('conversation_sid') ? hash['conversation_sid'] : SKIP
+      unread_messages_count =
+        hash.key?('unread_messages_count') ? hash['unread_messages_count'] : SKIP
+      last_read_message_index =
+        hash.key?('last_read_message_index') ? hash['last_read_message_index'] : SKIP
+      participant_sid =
+        hash.key?('participant_sid') ? hash['participant_sid'] : SKIP
+      user_sid = hash.key?('user_sid') ? hash['user_sid'] : SKIP
+      friendly_name = hash.key?('friendly_name') ? hash['friendly_name'] : SKIP
+      conversation_state =
+        hash.key?('conversation_state') ? hash['conversation_state'] : SKIP
+      timers = hash.key?('timers') ? hash['timers'] : SKIP
+      attributes = hash.key?('attributes') ? hash['attributes'] : SKIP
+      date_created = if hash.key?('date_created')
+                       (DateTimeHelper.from_rfc3339(hash['date_created']) if hash['date_created'])
+                     else
+                       SKIP
+                     end
+      date_updated = if hash.key?('date_updated')
+                       (DateTimeHelper.from_rfc3339(hash['date_updated']) if hash['date_updated'])
+                     else
+                       SKIP
+                     end
+      created_by = hash.key?('created_by') ? hash['created_by'] : SKIP
+      notification_level =
+        hash.key?('notification_level') ? hash['notification_level'] : SKIP
+      unique_name = hash.key?('unique_name') ? hash['unique_name'] : SKIP
+      url = hash.key?('url') ? hash['url'] : SKIP
+      links = hash.key?('links') ? hash['links'] : SKIP
+
+      # Create a new hash for additional properties, removing known properties.
+      new_hash = hash.reject { |k, _| names.value?(k) }
+
+      additional_properties = APIHelper.get_additional_properties(
+        new_hash, proc { |value| value }
+      )
+
+      # Create object from extracted values.
+      ServiceUserConversation.new(account_sid: account_sid,
+                                  chat_service_sid: chat_service_sid,
+                                  conversation_sid: conversation_sid,
+                                  unread_messages_count: unread_messages_count,
+                                  last_read_message_index: last_read_message_index,
+                                  participant_sid: participant_sid,
+                                  user_sid: user_sid,
+                                  friendly_name: friendly_name,
+                                  conversation_state: conversation_state,
+                                  timers: timers,
+                                  attributes: attributes,
+                                  date_created: date_created,
+                                  date_updated: date_updated,
+                                  created_by: created_by,
+                                  notification_level: notification_level,
+                                  unique_name: unique_name,
+                                  url: url,
+                                  links: links,
+                                  additional_properties: additional_properties)
+    end
+
+    def to_custom_date_created
+      DateTimeHelper.to_rfc3339(date_created)
+    end
+
+    def to_custom_date_updated
+      DateTimeHelper.to_rfc3339(date_updated)
+    end
+
+    # Provides a human-readable string representation of the object.
+    def to_s
+      class_name = self.class.name.split('::').last
+      "<#{class_name} account_sid: #{@account_sid}, chat_service_sid: #{@chat_service_sid},"\
+      " conversation_sid: #{@conversation_sid}, unread_messages_count: #{@unread_messages_count},"\
+      " last_read_message_index: #{@last_read_message_index}, participant_sid:"\
+      " #{@participant_sid}, user_sid: #{@user_sid}, friendly_name: #{@friendly_name},"\
+      " conversation_state: #{@conversation_state}, timers: #{@timers}, attributes:"\
+      " #{@attributes}, date_created: #{@date_created}, date_updated: #{@date_updated},"\
+      " created_by: #{@created_by}, notification_level: #{@notification_level}, unique_name:"\
+      " #{@unique_name}, url: #{@url}, links: #{@links}, additional_properties:"\
+      " #{@additional_properties}>"
+    end
+
+    # Provides a debugging-friendly string with detailed object information.
+    def inspect
+      class_name = self.class.name.split('::').last
+      "<#{class_name} account_sid: #{@account_sid.inspect}, chat_service_sid:"\
+      " #{@chat_service_sid.inspect}, conversation_sid: #{@conversation_sid.inspect},"\
+      " unread_messages_count: #{@unread_messages_count.inspect}, last_read_message_index:"\
+      " #{@last_read_message_index.inspect}, participant_sid: #{@participant_sid.inspect},"\
+      " user_sid: #{@user_sid.inspect}, friendly_name: #{@friendly_name.inspect},"\
+      " conversation_state: #{@conversation_state.inspect}, timers: #{@timers.inspect},"\
+      " attributes: #{@attributes.inspect}, date_created: #{@date_created.inspect}, date_updated:"\
+      " #{@date_updated.inspect}, created_by: #{@created_by.inspect}, notification_level:"\
+      " #{@notification_level.inspect}, unique_name: #{@unique_name.inspect}, url:"\
+      " #{@url.inspect}, links: #{@links.inspect}, additional_properties:"\
+      " #{@additional_properties}>"
+    end
+  end
+end

data/lib/twilio_ap_is/models/service_user_conversation_notification_level.rb

@@ -0,0 +1,37 @@
+# twilio_ap_is
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+module TwilioApIs
+  # The Notification Level of this User Conversation. One of `default` or
+  # `muted`.
+  class ServiceUserConversationNotificationLevel
+    SERVICE_USER_CONVERSATION_NOTIFICATION_LEVEL = [
+      # TODO: Write general description for DEFAULT
+      DEFAULT = 'default'.freeze,
+
+      # TODO: Write general description for MUTED
+      MUTED = 'muted'.freeze
+    ].freeze
+
+    def self.validate(value)
+      return false if value.nil?
+
+      SERVICE_USER_CONVERSATION_NOTIFICATION_LEVEL.include?(value)
+    end
+
+    def self.from_value(value, default_value = DEFAULT)
+      return default_value if value.nil?
+
+      str = value.to_s.strip
+
+      case str.downcase
+      when 'default' then DEFAULT
+      when 'muted' then MUTED
+      else
+        default_value
+      end
+    end
+  end
+end

data/lib/twilio_ap_is/models/service_user_conversation_state.rb

@@ -0,0 +1,41 @@
+# twilio_ap_is
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+module TwilioApIs
+  # The current state of this User Conversation. One of `inactive`, `active` or
+  # `closed`.
+  class ServiceUserConversationState
+    SERVICE_USER_CONVERSATION_STATE = [
+      # TODO: Write general description for INACTIVE
+      INACTIVE = 'inactive'.freeze,
+
+      # TODO: Write general description for ACTIVE
+      ACTIVE = 'active'.freeze,
+
+      # TODO: Write general description for CLOSED
+      CLOSED = 'closed'.freeze
+    ].freeze
+
+    def self.validate(value)
+      return false if value.nil?
+
+      SERVICE_USER_CONVERSATION_STATE.include?(value)
+    end
+
+    def self.from_value(value, default_value = INACTIVE)
+      return default_value if value.nil?
+
+      str = value.to_s.strip
+
+      case str.downcase
+      when 'inactive' then INACTIVE
+      when 'active' then ACTIVE
+      when 'closed' then CLOSED
+      else
+        default_value
+      end
+    end
+  end
+end