freeclimb 1.0.3 → 2.1.0

data/lib/freeclimb/models/{dequeue_member_request.rb → hangup_all_of.rb}

@@ -13,21 +13,21 @@ OpenAPI Generator version: 4.3.0-SNAPSHOT
 require 'date'
 
 module Freeclimb
-  class DequeueMemberRequest
-    # RequestId for this request starting with prefix *RQ* followed by 40 hexadecimal characters. FreeClimb logs generated while processing this request include this requestId. If it is not provided, FreeClimb generates a requestId and returns it as a header in the response (e.g., X-Pulse-Request-Id: <requestId>).
-    attr_accessor :request_id
+  class HangupAllOf
+    # The user defined reason for the hangup. In general, applications should use a set of enumerated values that are predefined to cover all exit points of the Call flows for the given application.
+    attr_accessor :reason
 
     # Attribute mapping from ruby-style variable name to JSON key.
     def self.attribute_map
       {
-        :'request_id' => :'requestId'
+        :'reason' => :'reason'
       }
     end
 
     # Attribute type mapping.
     def self.openapi_types
       {
-        :'request_id' => :'String'
+        :'reason' => :'String'
       }
     end
 
@@ -41,19 +41,19 @@ module Freeclimb
     # @param [Hash] attributes Model attributes in the form of hash
     def initialize(attributes = {})
       if (!attributes.is_a?(Hash))
-        fail ArgumentError, "The input argument (attributes) must be a hash in `Freeclimb::DequeueMemberRequest` initialize method"
+        fail ArgumentError, "The input argument (attributes) must be a hash in `Freeclimb::HangupAllOf` initialize method"
       end
 
       # check to see if the attribute exists and convert string to symbol for hash key
       attributes = attributes.each_with_object({}) { |(k, v), h|
         if (!self.class.attribute_map.key?(k.to_sym))
-          fail ArgumentError, "`#{k}` is not a valid attribute in `Freeclimb::DequeueMemberRequest`. Please check the name to make sure it's valid. List of attributes: " + self.class.attribute_map.keys.inspect
+          fail ArgumentError, "`#{k}` is not a valid attribute in `Freeclimb::HangupAllOf`. Please check the name to make sure it's valid. List of attributes: " + self.class.attribute_map.keys.inspect
         end
         h[k.to_sym] = v
       }
 
-      if attributes.key?(:'request_id')
-        self.request_id = attributes[:'request_id']
+      if attributes.key?(:'reason')
+        self.reason = attributes[:'reason']
       end
     end
 
@@ -75,7 +75,7 @@ module Freeclimb
     def ==(o)
       return true if self.equal?(o)
       self.class == o.class &&
-          request_id == o.request_id
+          reason == o.reason
     end
 
     # @see the `==` method
@@ -87,7 +87,7 @@ module Freeclimb
     # Calculates hash code according to all attributes.
     # @return [Integer] Hash code
     def hash
-      [request_id].hash
+      [reason].hash
     end
 
     # Builds the object from hash

data/lib/freeclimb/models/incoming_number_request.rb

@@ -20,15 +20,11 @@ module Freeclimb
     # Description for this phone number.
     attr_accessor :_alias
 
-    # RequestId for this request starting with prefix `RQ` followed by 40 hexadecimal characters. FreeClimb logs that are generated while processing this request will include this requestId. If it is not provided, FreeClimb will generate a requestId and return it as a header in the response (e.g., `X-Pulse-Request-Id: <requestId>`).
-    attr_accessor :request_id
-
     # Attribute mapping from ruby-style variable name to JSON key.
     def self.attribute_map
       {
         :'application_id' => :'applicationId',
-        :'_alias' => :'alias',
-        :'request_id' => :'requestID'
+        :'_alias' => :'alias'
       }
     end
 
@@ -36,8 +32,7 @@ module Freeclimb
     def self.openapi_types
       {
         :'application_id' => :'String',
-        :'_alias' => :'String',
-        :'request_id' => :'String'
+        :'_alias' => :'String'
       }
     end
 
@@ -69,10 +64,6 @@ module Freeclimb
       if attributes.key?(:'_alias')
         self._alias = attributes[:'_alias']
       end
-
-      if attributes.key?(:'request_id')
-        self.request_id = attributes[:'request_id']
-      end
     end
 
     # Show invalid properties with the reasons. Usually used together with valid?
@@ -94,8 +85,7 @@ module Freeclimb
       return true if self.equal?(o)
       self.class == o.class &&
           application_id == o.application_id &&
-          _alias == o._alias &&
-          request_id == o.request_id
+          _alias == o._alias
     end
 
     # @see the `==` method
@@ -107,7 +97,7 @@ module Freeclimb
     # Calculates hash code according to all attributes.
     # @return [Integer] Hash code
     def hash
-      [application_id, _alias, request_id].hash
+      [application_id, _alias].hash
     end
 
     # Builds the object from hash

data/lib/freeclimb/models/make_call_request.rb

@@ -35,12 +35,12 @@ module Freeclimb
     # Number of seconds that FreeClimb should allow the phone to ring before assuming there is no answer. Default is 30 seconds. Maximum allowed ring-time is determined by the target phone's provider. Note that most providers limit ring-time to 120 seconds.
     attr_accessor :timeout
 
-    # The requestId for this request starting with prefix \"RQ\" followed by 40 hexadecimal characters. FreeClimb logs generated while processing this request will include this requestId. If it is not provided, FreeClimb will generate a requestId and return it as a header in the response (e.g. `X-Pulse-Request-Id: <requestId>`).
-    attr_accessor :request_id
-
     # The ID of the parent Call in the case that this new Call is meant to be treated as a child of an existing Call. This attribute should be included when possible to reduce latency when adding child calls to Conferences containing the parent Call. A call can only be used as a parent once the call is in progress or as an inbound call that is still ringing.  An outbound call is considered to be in progress once the outdialConnect or outdialApiConnect webhook is invoked.  An inbound call is ringing when the inbound webhook is invoked.
     attr_accessor :parent_call_id
 
+    # Activate privacy mode in order to obscure log data that can potentially expose private information.
+    attr_accessor :privacy_mode
+
     # Attribute mapping from ruby-style variable name to JSON key.
     def self.attribute_map
       {
@@ -51,8 +51,8 @@ module Freeclimb
         :'if_machine' => :'ifMachine',
         :'if_machine_url' => :'ifMachineUrl',
         :'timeout' => :'timeout',
-        :'request_id' => :'requestId',
-        :'parent_call_id' => :'parentCallId'
+        :'parent_call_id' => :'parentCallId',
+        :'privacy_mode' => :'privacyMode'
       }
     end
 
@@ -66,8 +66,8 @@ module Freeclimb
         :'if_machine' => :'String',
         :'if_machine_url' => :'String',
         :'timeout' => :'Integer',
-        :'request_id' => :'String',
-        :'parent_call_id' => :'String'
+        :'parent_call_id' => :'String',
+        :'privacy_mode' => :'Boolean'
       }
     end
 
@@ -120,13 +120,13 @@ module Freeclimb
         self.timeout = attributes[:'timeout']
       end
 
-      if attributes.key?(:'request_id')
-        self.request_id = attributes[:'request_id']
-      end
-
       if attributes.key?(:'parent_call_id')
         self.parent_call_id = attributes[:'parent_call_id']
       end
+
+      if attributes.key?(:'privacy_mode')
+        self.privacy_mode = attributes[:'privacy_mode']
+      end
     end
 
     # Show invalid properties with the reasons. Usually used together with valid?
@@ -169,8 +169,8 @@ module Freeclimb
           if_machine == o.if_machine &&
           if_machine_url == o.if_machine_url &&
           timeout == o.timeout &&
-          request_id == o.request_id &&
-          parent_call_id == o.parent_call_id
+          parent_call_id == o.parent_call_id &&
+          privacy_mode == o.privacy_mode
     end
 
     # @see the `==` method
@@ -182,7 +182,7 @@ module Freeclimb
     # Calculates hash code according to all attributes.
     # @return [Integer] Hash code
     def hash
-      [from, to, application_id, send_digits, if_machine, if_machine_url, timeout, request_id, parent_call_id].hash
+      [from, to, application_id, send_digits, if_machine, if_machine_url, timeout, parent_call_id, privacy_mode].hash
     end
 
     # Builds the object from hash

data/lib/freeclimb/models/message_request.rb

@@ -38,9 +38,6 @@ module Freeclimb
     # When the Message changes status, this URL is invoked using HTTP POST with the messageStatus parameters.  **Note:** This is a notification only; any PerCL returned is ignored.
     attr_accessor :notification_url
 
-    # RequestId for this request, starting with prefix *RQ* followed by 40 hexadecimal characters. FreeClimb logs generated while processing this request include this requestId. If it is not provided, FreeClimb will generate a requestId and return it as a header in the response (e.g., X-Pulse-Request-Id: <requestId>).
-    attr_accessor :request_id
-
     # String that uniquely identifies this account resource.
     attr_accessor :account_id
 
@@ -55,7 +52,6 @@ module Freeclimb
         :'to' => :'to',
         :'text' => :'text',
         :'notification_url' => :'notificationUrl',
-        :'request_id' => :'requestId',
         :'account_id' => :'accountId'
       }
     end
@@ -71,7 +67,6 @@ module Freeclimb
         :'to' => :'String',
         :'text' => :'String',
         :'notification_url' => :'String',
-        :'request_id' => :'String',
         :'account_id' => :'String'
       }
     end
@@ -137,10 +132,6 @@ module Freeclimb
         self.notification_url = attributes[:'notification_url']
       end
 
-      if attributes.key?(:'request_id')
-        self.request_id = attributes[:'request_id']
-      end
-
       if attributes.key?(:'account_id')
         self.account_id = attributes[:'account_id']
       end
@@ -187,7 +178,6 @@ module Freeclimb
           to == o.to &&
           text == o.text &&
           notification_url == o.notification_url &&
-          request_id == o.request_id &&
           account_id == o.account_id
     end
 
@@ -200,7 +190,7 @@ module Freeclimb
     # Calculates hash code according to all attributes.
     # @return [Integer] Hash code
     def hash
-      [uri, date_created, date_updated, revision, from, to, text, notification_url, request_id, account_id].hash
+      [uri, date_created, date_updated, revision, from, to, text, notification_url, account_id].hash
     end
 
     # Builds the object from hash

data/lib/freeclimb/models/message_request_all_of.rb

@@ -26,9 +26,6 @@ module Freeclimb
     # When the Message changes status, this URL is invoked using HTTP POST with the messageStatus parameters.  **Note:** This is a notification only; any PerCL returned is ignored.
     attr_accessor :notification_url
 
-    # RequestId for this request, starting with prefix *RQ* followed by 40 hexadecimal characters. FreeClimb logs generated while processing this request include this requestId. If it is not provided, FreeClimb will generate a requestId and return it as a header in the response (e.g., X-Pulse-Request-Id: <requestId>).
-    attr_accessor :request_id
-
     # String that uniquely identifies this account resource.
     attr_accessor :account_id
 
@@ -39,7 +36,6 @@ module Freeclimb
         :'to' => :'to',
         :'text' => :'text',
         :'notification_url' => :'notificationUrl',
-        :'request_id' => :'requestId',
         :'account_id' => :'accountId'
       }
     end
@@ -51,7 +47,6 @@ module Freeclimb
         :'to' => :'String',
         :'text' => :'String',
         :'notification_url' => :'String',
-        :'request_id' => :'String',
         :'account_id' => :'String'
       }
     end
@@ -93,10 +88,6 @@ module Freeclimb
         self.notification_url = attributes[:'notification_url']
       end
 
-      if attributes.key?(:'request_id')
-        self.request_id = attributes[:'request_id']
-      end
-
       if attributes.key?(:'account_id')
         self.account_id = attributes[:'account_id']
       end
@@ -139,7 +130,6 @@ module Freeclimb
           to == o.to &&
           text == o.text &&
           notification_url == o.notification_url &&
-          request_id == o.request_id &&
           account_id == o.account_id
     end
 
@@ -152,7 +142,7 @@ module Freeclimb
     # Calculates hash code according to all attributes.
     # @return [Integer] Hash code
     def hash
-      [from, to, text, notification_url, request_id, account_id].hash
+      [from, to, text, notification_url, account_id].hash
     end
 
     # Builds the object from hash

data/lib/freeclimb/models/message_result.rb

@@ -32,7 +32,7 @@ module Freeclimb
     # String that uniquely identifies this message resource
     attr_accessor :message_id
 
-    # Indicates the state of the message through the message lifecycle including: new, queued, rejected, sending, sent, failed, received
+    # Indicates the state of the message through the message lifecycle including: new, queued, rejected, sending, sent, failed, received, undelivered, expired, deleted, and unknown
     attr_accessor :status
 
     # Phone number in E.164 format that sent the message.
@@ -196,7 +196,7 @@ module Freeclimb
     # Check to see if the all the properties in the model are valid
     # @return true if the model is valid
     def valid?
-      status_validator = EnumAttributeValidator.new('String', ["new", "queued", "rejected", "sending", "sent", "failed", "received", "undelivered"])
+      status_validator = EnumAttributeValidator.new('String', ["new", "queued", "rejected", "sending", "sent", "failed", "received", "undelivered", "expired", "deleted", "unknown"])
       return false unless status_validator.valid?(@status)
       true
     end
@@ -204,7 +204,7 @@ module Freeclimb
     # Custom attribute writer method checking allowed values (enum).
     # @param [Object] status Object to be assigned
     def status=(status)
-      validator = EnumAttributeValidator.new('String', ["new", "queued", "rejected", "sending", "sent", "failed", "received", "undelivered"])
+      validator = EnumAttributeValidator.new('String', ["new", "queued", "rejected", "sending", "sent", "failed", "received", "undelivered", "expired", "deleted", "unknown"])
       unless validator.valid?(status)
         fail ArgumentError, "invalid value for \"status\", must be one of #{validator.allowable_values}."
       end

data/lib/freeclimb/models/message_result_all_of.rb

@@ -20,7 +20,7 @@ module Freeclimb
     # String that uniquely identifies this message resource
     attr_accessor :message_id
 
-    # Indicates the state of the message through the message lifecycle including: new, queued, rejected, sending, sent, failed, received
+    # Indicates the state of the message through the message lifecycle including: new, queued, rejected, sending, sent, failed, received, undelivered, expired, deleted, and unknown
     attr_accessor :status
 
     # Phone number in E.164 format that sent the message.
@@ -152,7 +152,7 @@ module Freeclimb
     # Check to see if the all the properties in the model are valid
     # @return true if the model is valid
     def valid?
-      status_validator = EnumAttributeValidator.new('String', ["new", "queued", "rejected", "sending", "sent", "failed", "received", "undelivered"])
+      status_validator = EnumAttributeValidator.new('String', ["new", "queued", "rejected", "sending", "sent", "failed", "received", "undelivered", "expired", "deleted", "unknown"])
       return false unless status_validator.valid?(@status)
       true
     end
@@ -160,7 +160,7 @@ module Freeclimb
     # Custom attribute writer method checking allowed values (enum).
     # @param [Object] status Object to be assigned
     def status=(status)
-      validator = EnumAttributeValidator.new('String', ["new", "queued", "rejected", "sending", "sent", "failed", "received", "undelivered"])
+      validator = EnumAttributeValidator.new('String', ["new", "queued", "rejected", "sending", "sent", "failed", "received", "undelivered", "expired", "deleted", "unknown"])
       unless validator.valid?(status)
         fail ArgumentError, "invalid value for \"status\", must be one of #{validator.allowable_values}."
       end

data/lib/freeclimb/models/out_dial.rb

@@ -42,6 +42,9 @@ module Freeclimb
     # Maximum time in seconds the `OutDial` command waits for the called party to answer the Call. When a timeout occurs, FreeClimb invokes the `callConnectUrl` Webhook to report that the out-dialed Call has ended with a status of `noAnswer`.
     attr_accessor :timeout
 
+    # Parameter `privacyMode` will not log the `text` as required by PCI compliance.
+    attr_accessor :privacy_mode
+
     # Attribute mapping from ruby-style variable name to JSON key.
     def self.attribute_map
       {
@@ -53,7 +56,8 @@ module Freeclimb
         :'if_machine_url' => :'ifMachineUrl',
         :'send_digits' => :'sendDigits',
         :'status_callback_url' => :'statusCallbackUrl',
-        :'timeout' => :'timeout'
+        :'timeout' => :'timeout',
+        :'privacy_mode' => :'privacyMode'
       }
     end
 
@@ -68,7 +72,8 @@ module Freeclimb
         :'if_machine_url' => :'String',
         :'send_digits' => :'String',
         :'status_callback_url' => :'String',
-        :'timeout' => :'Integer'
+        :'timeout' => :'Integer',
+        :'privacy_mode' => :'Boolean'
       }
     end
 
@@ -139,6 +144,10 @@ module Freeclimb
       if attributes.key?(:'timeout')
         self.timeout = attributes[:'timeout']
       end
+
+      if attributes.key?(:'privacy_mode')
+        self.privacy_mode = attributes[:'privacy_mode']
+      end
     end
 
     # Show invalid properties with the reasons. Usually used together with valid?
@@ -187,7 +196,8 @@ module Freeclimb
           if_machine_url == o.if_machine_url &&
           send_digits == o.send_digits &&
           status_callback_url == o.status_callback_url &&
-          timeout == o.timeout && super(o)
+          timeout == o.timeout &&
+          privacy_mode == o.privacy_mode && super(o)
     end
 
     # @see the `==` method
@@ -199,7 +209,7 @@ module Freeclimb
     # Calculates hash code according to all attributes.
     # @return [Integer] Hash code
     def hash
-      [action_url, call_connect_url, calling_number, destination, if_machine, if_machine_url, send_digits, status_callback_url, timeout].hash
+      [action_url, call_connect_url, calling_number, destination, if_machine, if_machine_url, send_digits, status_callback_url, timeout, privacy_mode].hash
     end
 
     # Builds the object from hash

data/lib/freeclimb/models/out_dial_all_of.rb

@@ -41,6 +41,9 @@ module Freeclimb
     # Maximum time in seconds the `OutDial` command waits for the called party to answer the Call. When a timeout occurs, FreeClimb invokes the `callConnectUrl` Webhook to report that the out-dialed Call has ended with a status of `noAnswer`.
     attr_accessor :timeout
 
+    # Parameter `privacyMode` will not log the `text` as required by PCI compliance.
+    attr_accessor :privacy_mode
+
     # Attribute mapping from ruby-style variable name to JSON key.
     def self.attribute_map
       {
@@ -52,7 +55,8 @@ module Freeclimb
         :'if_machine_url' => :'ifMachineUrl',
         :'send_digits' => :'sendDigits',
         :'status_callback_url' => :'statusCallbackUrl',
-        :'timeout' => :'timeout'
+        :'timeout' => :'timeout',
+        :'privacy_mode' => :'privacyMode'
       }
     end
 
@@ -67,7 +71,8 @@ module Freeclimb
         :'if_machine_url' => :'String',
         :'send_digits' => :'String',
         :'status_callback_url' => :'String',
-        :'timeout' => :'Integer'
+        :'timeout' => :'Integer',
+        :'privacy_mode' => :'Boolean'
       }
     end
 
@@ -127,6 +132,10 @@ module Freeclimb
       if attributes.key?(:'timeout')
         self.timeout = attributes[:'timeout']
       end
+
+      if attributes.key?(:'privacy_mode')
+        self.privacy_mode = attributes[:'privacy_mode']
+      end
     end
 
     # Show invalid properties with the reasons. Usually used together with valid?
@@ -175,7 +184,8 @@ module Freeclimb
           if_machine_url == o.if_machine_url &&
           send_digits == o.send_digits &&
           status_callback_url == o.status_callback_url &&
-          timeout == o.timeout
+          timeout == o.timeout &&
+          privacy_mode == o.privacy_mode
     end
 
     # @see the `==` method
@@ -187,7 +197,7 @@ module Freeclimb
     # Calculates hash code according to all attributes.
     # @return [Integer] Hash code
     def hash
-      [action_url, call_connect_url, calling_number, destination, if_machine, if_machine_url, send_digits, status_callback_url, timeout].hash
+      [action_url, call_connect_url, calling_number, destination, if_machine, if_machine_url, send_digits, status_callback_url, timeout, privacy_mode].hash
     end
 
     # Builds the object from hash