twilio-api-sdk 1.0.0

data/lib/twilio_ap_is/models/configuration_webhook.rb

@@ -0,0 +1,154 @@
+# twilio_ap_is
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+module TwilioApIs
+  # ConfigurationWebhook Model.
+  class ConfigurationWebhook < 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 HTTP method to be used when sending a webhook request.
+    # @return [ConfigurationWebhookMethod]
+    attr_accessor :method
+
+    # The list of webhook event triggers that are enabled for this Service:
+    # `onMessageAdded`, `onMessageUpdated`, `onMessageRemoved`, `onMessageAdd`,
+    # `onMessageUpdate`, `onMessageRemove`, `onConversationUpdated`,
+    # `onConversationRemoved`, `onConversationAdd`, `onConversationAdded`,
+    # `onConversationRemove`, `onConversationUpdate`,
+    # `onConversationStateUpdated`, `onParticipantAdded`,
+    # `onParticipantUpdated`, `onParticipantRemoved`, `onParticipantAdd`,
+    # `onParticipantRemove`, `onParticipantUpdate`, `onDeliveryUpdated`,
+    # `onUserAdded`, `onUserUpdate`, `onUserUpdated`
+    # @return [Array[String]]
+    attr_accessor :filters
+
+    # The absolute url the pre-event webhook request should be sent to.
+    # @return [String]
+    attr_accessor :pre_webhook_url
+
+    # The absolute url the post-event webhook request should be sent to.
+    # @return [String]
+    attr_accessor :post_webhook_url
+
+    # The routing target of the webhook. Can be ordinary or route internally to
+    # Flex
+    # @return [ConfigurationWebhookTarget]
+    attr_accessor :target
+
+    # An absolute API resource API resource URL for this webhook.
+    # @return [String]
+    attr_accessor :url
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['account_sid'] = 'account_sid'
+      @_hash['method'] = 'method'
+      @_hash['filters'] = 'filters'
+      @_hash['pre_webhook_url'] = 'pre_webhook_url'
+      @_hash['post_webhook_url'] = 'post_webhook_url'
+      @_hash['target'] = 'target'
+      @_hash['url'] = 'url'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        account_sid
+        method
+        filters
+        pre_webhook_url
+        post_webhook_url
+        target
+        url
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      %w[
+        account_sid
+        filters
+        pre_webhook_url
+        post_webhook_url
+        url
+      ]
+    end
+
+    def initialize(account_sid: SKIP, method: SKIP, filters: SKIP,
+                   pre_webhook_url: SKIP, post_webhook_url: SKIP, target: SKIP,
+                   url: 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
+      @method = method unless method == SKIP
+      @filters = filters unless filters == SKIP
+      @pre_webhook_url = pre_webhook_url unless pre_webhook_url == SKIP
+      @post_webhook_url = post_webhook_url unless post_webhook_url == SKIP
+      @target = target unless target == SKIP
+      @url = url unless url == 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
+      method = hash.key?('method') ? hash['method'] : SKIP
+      filters = hash.key?('filters') ? hash['filters'] : SKIP
+      pre_webhook_url =
+        hash.key?('pre_webhook_url') ? hash['pre_webhook_url'] : SKIP
+      post_webhook_url =
+        hash.key?('post_webhook_url') ? hash['post_webhook_url'] : SKIP
+      target = hash.key?('target') ? hash['target'] : SKIP
+      url = hash.key?('url') ? hash['url'] : 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.
+      ConfigurationWebhook.new(account_sid: account_sid,
+                               method: method,
+                               filters: filters,
+                               pre_webhook_url: pre_webhook_url,
+                               post_webhook_url: post_webhook_url,
+                               target: target,
+                               url: url,
+                               additional_properties: additional_properties)
+    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}, method: #{@method}, filters: #{@filters},"\
+      " pre_webhook_url: #{@pre_webhook_url}, post_webhook_url: #{@post_webhook_url}, target:"\
+      " #{@target}, url: #{@url}, 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}, method: #{@method.inspect}, filters:"\
+      " #{@filters.inspect}, pre_webhook_url: #{@pre_webhook_url.inspect}, post_webhook_url:"\
+      " #{@post_webhook_url.inspect}, target: #{@target.inspect}, url: #{@url.inspect},"\
+      " additional_properties: #{@additional_properties}>"
+    end
+  end
+end

data/lib/twilio_ap_is/models/configuration_webhook_method.rb

@@ -0,0 +1,46 @@
+# twilio_ap_is
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+module TwilioApIs
+  # The HTTP method to be used when sending a webhook request., The HTTP method
+  # we should use to call `conference_recording_status_callback`. Can be: `GET`
+  # or `POST` and defaults to `POST`., The HTTP method we should use to call
+  # `conference_status_callback`. Can be: `GET` or `POST` and defaults to
+  # `POST`., The HTTP method we should use when we call
+  # `recording_status_callback`. Can be: `GET` or `POST` and defaults to
+  # `POST`., The HTTP method we should use to call `status_callback`. Can be:
+  # `POST` or `GET` and the default is `POST`., The HTTP method we should use to
+  # call `wait_url`. Can be `GET` or `POST` and the default is `POST`. When
+  # using a static audio file, this should be `GET` so that we can cache the
+  # file., The method to be used when calling the webhook's URL.
+  class ConfigurationWebhookMethod
+    CONFIGURATION_WEBHOOK_METHOD = [
+      # TODO: Write general description for GET
+      GET = 'GET'.freeze,
+
+      # TODO: Write general description for POST
+      POST = 'POST'.freeze
+    ].freeze
+
+    def self.validate(value)
+      return false if value.nil?
+
+      CONFIGURATION_WEBHOOK_METHOD.include?(value)
+    end
+
+    def self.from_value(value, default_value = GET)
+      return default_value if value.nil?
+
+      str = value.to_s.strip
+
+      case str.downcase
+      when 'get' then GET
+      when 'post' then POST
+      else
+        default_value
+      end
+    end
+  end
+end

data/lib/twilio_ap_is/models/configuration_webhook_target.rb

@@ -0,0 +1,37 @@
+# twilio_ap_is
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+module TwilioApIs
+  # The routing target of the webhook. Can be ordinary or route internally to
+  # Flex
+  class ConfigurationWebhookTarget
+    CONFIGURATION_WEBHOOK_TARGET = [
+      # TODO: Write general description for WEBHOOK
+      WEBHOOK = 'webhook'.freeze,
+
+      # TODO: Write general description for FLEX
+      FLEX = 'flex'.freeze
+    ].freeze
+
+    def self.validate(value)
+      return false if value.nil?
+
+      CONFIGURATION_WEBHOOK_TARGET.include?(value)
+    end
+
+    def self.from_value(value, default_value = WEBHOOK)
+      return default_value if value.nil?
+
+      str = value.to_s.strip
+
+      case str.downcase
+      when 'webhook' then WEBHOOK
+      when 'flex' then FLEX
+      else
+        default_value
+      end
+    end
+  end
+end

data/lib/twilio_ap_is/models/conversation.rb

@@ -0,0 +1,264 @@
+# twilio_ap_is
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+require 'date'
+module TwilioApIs
+  # Conversation Model.
+  class Conversation < 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 [Messaging
+    # Service](https://www.twilio.com/docs/messaging/api/service-resource) this
+    # conversation belongs to.
+    # @return [String]
+    attr_accessor :messaging_service_sid
+
+    # A 34 character string that uniquely identifies this resource.
+    # @return [String]
+    attr_accessor :sid
+
+    # The human-readable name of this conversation, limited to 256 characters.
+    # Optional.
+    # @return [String]
+    attr_accessor :friendly_name
+
+    # An application-defined string that uniquely identifies the resource. It
+    # can be used to address the resource in place of the resource's `sid` in
+    # the URL.
+    # @return [String]
+    attr_accessor :unique_name
+
+    # 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
+
+    # Current state of this conversation. Can be either `initializing`,
+    # `active`, `inactive` or `closed` and defaults to `active`
+    # @return [ConversationState]
+    attr_accessor :state
+
+    # The date that this resource was created.
+    # @return [DateTime]
+    attr_accessor :date_created
+
+    # The date that this resource was last updated.
+    # @return [DateTime]
+    attr_accessor :date_updated
+
+    # Timer date values representing state update for this conversation.
+    # @return [Object]
+    attr_accessor :timers
+
+    # An absolute API resource URL for this conversation.
+    # @return [String]
+    attr_accessor :url
+
+    # Contains absolute URLs to access the
+    # [participants](https://www.twilio.com/docs/conversations/api/conversation-
+    # participant-resource),
+    # [messages](https://www.twilio.com/docs/conversations/api/conversation-mess
+    # age-resource) and
+    # [webhooks](https://www.twilio.com/docs/conversations/api/conversation-scop
+    # ed-webhook-resource) of this conversation.
+    # @return [Object]
+    attr_accessor :links
+
+    # Contains absolute URLs to access the
+    # [participants](https://www.twilio.com/docs/conversations/api/conversation-
+    # participant-resource),
+    # [messages](https://www.twilio.com/docs/conversations/api/conversation-mess
+    # age-resource) and
+    # [webhooks](https://www.twilio.com/docs/conversations/api/conversation-scop
+    # ed-webhook-resource) of this conversation.
+    # @return [Object]
+    attr_accessor :bindings
+
+    # 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['messaging_service_sid'] = 'messaging_service_sid'
+      @_hash['sid'] = 'sid'
+      @_hash['friendly_name'] = 'friendly_name'
+      @_hash['unique_name'] = 'unique_name'
+      @_hash['attributes'] = 'attributes'
+      @_hash['state'] = 'state'
+      @_hash['date_created'] = 'date_created'
+      @_hash['date_updated'] = 'date_updated'
+      @_hash['timers'] = 'timers'
+      @_hash['url'] = 'url'
+      @_hash['links'] = 'links'
+      @_hash['bindings'] = 'bindings'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        account_sid
+        chat_service_sid
+        messaging_service_sid
+        sid
+        friendly_name
+        unique_name
+        attributes
+        state
+        date_created
+        date_updated
+        timers
+        url
+        links
+        bindings
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      %w[
+        account_sid
+        chat_service_sid
+        messaging_service_sid
+        sid
+        friendly_name
+        unique_name
+        attributes
+        date_created
+        date_updated
+        timers
+        url
+        links
+        bindings
+      ]
+    end
+
+    def initialize(account_sid: SKIP, chat_service_sid: SKIP,
+                   messaging_service_sid: SKIP, sid: SKIP, friendly_name: SKIP,
+                   unique_name: SKIP, attributes: SKIP, state: SKIP,
+                   date_created: SKIP, date_updated: SKIP, timers: SKIP,
+                   url: SKIP, links: SKIP, bindings: 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
+      @messaging_service_sid = messaging_service_sid unless messaging_service_sid == SKIP
+      @sid = sid unless sid == SKIP
+      @friendly_name = friendly_name unless friendly_name == SKIP
+      @unique_name = unique_name unless unique_name == SKIP
+      @attributes = attributes unless attributes == SKIP
+      @state = state unless state == SKIP
+      @date_created = date_created unless date_created == SKIP
+      @date_updated = date_updated unless date_updated == SKIP
+      @timers = timers unless timers == SKIP
+      @url = url unless url == SKIP
+      @links = links unless links == SKIP
+      @bindings = bindings unless bindings == 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
+      messaging_service_sid =
+        hash.key?('messaging_service_sid') ? hash['messaging_service_sid'] : SKIP
+      sid = hash.key?('sid') ? hash['sid'] : SKIP
+      friendly_name = hash.key?('friendly_name') ? hash['friendly_name'] : SKIP
+      unique_name = hash.key?('unique_name') ? hash['unique_name'] : SKIP
+      attributes = hash.key?('attributes') ? hash['attributes'] : SKIP
+      state = hash.key?('state') ? hash['state'] : 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
+      timers = hash.key?('timers') ? hash['timers'] : SKIP
+      url = hash.key?('url') ? hash['url'] : SKIP
+      links = hash.key?('links') ? hash['links'] : SKIP
+      bindings = hash.key?('bindings') ? hash['bindings'] : 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.
+      Conversation.new(account_sid: account_sid,
+                       chat_service_sid: chat_service_sid,
+                       messaging_service_sid: messaging_service_sid,
+                       sid: sid,
+                       friendly_name: friendly_name,
+                       unique_name: unique_name,
+                       attributes: attributes,
+                       state: state,
+                       date_created: date_created,
+                       date_updated: date_updated,
+                       timers: timers,
+                       url: url,
+                       links: links,
+                       bindings: bindings,
+                       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},"\
+      " messaging_service_sid: #{@messaging_service_sid}, sid: #{@sid}, friendly_name:"\
+      " #{@friendly_name}, unique_name: #{@unique_name}, attributes: #{@attributes}, state:"\
+      " #{@state}, date_created: #{@date_created}, date_updated: #{@date_updated}, timers:"\
+      " #{@timers}, url: #{@url}, links: #{@links}, bindings: #{@bindings}, 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}, messaging_service_sid: #{@messaging_service_sid.inspect},"\
+      " sid: #{@sid.inspect}, friendly_name: #{@friendly_name.inspect}, unique_name:"\
+      " #{@unique_name.inspect}, attributes: #{@attributes.inspect}, state: #{@state.inspect},"\
+      " date_created: #{@date_created.inspect}, date_updated: #{@date_updated.inspect}, timers:"\
+      " #{@timers.inspect}, url: #{@url.inspect}, links: #{@links.inspect}, bindings:"\
+      " #{@bindings.inspect}, additional_properties: #{@additional_properties}>"
+    end
+  end
+end