freeclimb 5.0.0 → 5.1.0

data/lib/freeclimb/models/tfn_campaign.rb

@@ -0,0 +1,370 @@
+=begin
+#FreeClimb API
+
+#FreeClimb is a cloud-based application programming interface (API) that puts the power of the Vail platform in your hands. FreeClimb simplifies the process of creating applications that can use a full range of telephony features without requiring specialized or on-site telephony equipment. Using the FreeClimb REST API to write applications is easy! You have the option to use the language of your choice or hit the API directly. Your application can execute a command by issuing a RESTful request to the FreeClimb API. The base URL to send HTTP requests to the FreeClimb REST API is: /apiserver. FreeClimb authenticates and processes your request.
+
+The version of the OpenAPI document: 1.0.0
+Contact: support@freeclimb.com
+Generated by: https://openapi-generator.tech
+OpenAPI Generator version: 7.9.0
+
+=end
+
+require 'date'
+require 'time'
+
+module Freeclimb
+  class TFNCampaign
+    # ID of the account that created this participant.
+    attr_accessor :account_id
+
+    # TFNCampaignId
+    attr_accessor :campaign_id
+
+    attr_accessor :use_case
+
+    attr_accessor :registration_status
+
+    attr_accessor :date_created
+
+    attr_accessor :date_updated
+
+    attr_accessor :date_created_iso
+
+    attr_accessor :date_updated_iso
+
+    attr_accessor :revision
+
+    class EnumAttributeValidator
+      attr_reader :datatype
+      attr_reader :allowable_values
+
+      def initialize(datatype, allowable_values)
+        @allowable_values = allowable_values.map do |value|
+          case datatype.to_s
+          when /Integer/i
+            value.to_i
+          when /Float/i
+            value.to_f
+          else
+            value
+          end
+        end
+      end
+
+      def valid?(value)
+        !value || allowable_values.include?(value)
+      end
+    end
+
+    # Attribute mapping from ruby-style variable name to JSON key.
+    def self.attribute_map
+      {
+        :'account_id' => :'accountId',
+        :'campaign_id' => :'campaignId',
+        :'use_case' => :'useCase',
+        :'registration_status' => :'registrationStatus',
+        :'date_created' => :'dateCreated',
+        :'date_updated' => :'dateUpdated',
+        :'date_created_iso' => :'dateCreatedISO',
+        :'date_updated_iso' => :'dateUpdatedISO',
+        :'revision' => :'revision'
+      }
+    end
+
+    # Returns all the JSON keys this model knows about
+    def self.acceptable_attributes
+      attribute_map.values
+    end
+
+    # Attribute type mapping.
+    def self.openapi_types
+      {
+        :'account_id' => :'String',
+        :'campaign_id' => :'String',
+        :'use_case' => :'String',
+        :'registration_status' => :'SMSTollFreeCampaignRegistrationStatus',
+        :'date_created' => :'String',
+        :'date_updated' => :'String',
+        :'date_created_iso' => :'String',
+        :'date_updated_iso' => :'String',
+        :'revision' => :'Integer'
+      }
+    end
+
+    # List of attributes with nullable: true
+    def self.openapi_nullable
+      Set.new([
+        :'account_id',
+      ])
+    end
+
+    # Initializes the object
+    # @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::TFNCampaign` 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::TFNCampaign`. 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?(:'account_id')
+        self.account_id = attributes[:'account_id']
+      end
+
+      if attributes.key?(:'campaign_id')
+        self.campaign_id = attributes[:'campaign_id']
+      end
+
+      if attributes.key?(:'use_case')
+        self.use_case = attributes[:'use_case']
+      end
+
+      if attributes.key?(:'registration_status')
+        self.registration_status = attributes[:'registration_status']
+      end
+
+      if attributes.key?(:'date_created')
+        self.date_created = attributes[:'date_created']
+      end
+
+      if attributes.key?(:'date_updated')
+        self.date_updated = attributes[:'date_updated']
+      end
+
+      if attributes.key?(:'date_created_iso')
+        self.date_created_iso = attributes[:'date_created_iso']
+      end
+
+      if attributes.key?(:'date_updated_iso')
+        self.date_updated_iso = attributes[:'date_updated_iso']
+      end
+
+      if attributes.key?(:'revision')
+        self.revision = attributes[:'revision']
+      end
+    end
+
+    # Show invalid properties with the reasons. Usually used together with valid?
+    # @return Array for valid properties with the reasons
+    def list_invalid_properties
+      invalid_properties = Array.new
+      if @campaign_id.nil?
+        invalid_properties.push('invalid value for "campaign_id", campaign_id cannot be nil.')
+      end
+
+      pattern = Regexp.new(/cmptfn_[a-fA-F0-9]{40}/)
+      if @campaign_id !~ pattern
+        invalid_properties.push("invalid value for \"campaign_id\", must conform to the pattern #{pattern}.")
+      end
+
+      if @use_case.nil?
+        invalid_properties.push('invalid value for "use_case", use_case cannot be nil.')
+      end
+
+      if @registration_status.nil?
+        invalid_properties.push('invalid value for "registration_status", registration_status cannot be nil.')
+      end
+
+      if @date_created.nil?
+        invalid_properties.push('invalid value for "date_created", date_created cannot be nil.')
+      end
+
+      if @date_updated.nil?
+        invalid_properties.push('invalid value for "date_updated", date_updated cannot be nil.')
+      end
+
+      if @date_created_iso.nil?
+        invalid_properties.push('invalid value for "date_created_iso", date_created_iso cannot be nil.')
+      end
+
+      if @date_updated_iso.nil?
+        invalid_properties.push('invalid value for "date_updated_iso", date_updated_iso cannot be nil.')
+      end
+
+      if @revision.nil?
+        invalid_properties.push('invalid value for "revision", revision cannot be nil.')
+      end
+
+      invalid_properties
+    end
+
+    # Check to see if the all the properties in the model are valid
+    # @return true if the model is valid
+    def valid?
+      
+      if @account_id.nil?
+        false
+      else
+        list_invalid_properties.length() == 0
+      end
+    end
+
+    # Custom attribute writer method with validation
+    # @param [Object] campaign_id Value to be assigned
+    def campaign_id=(campaign_id)
+      if campaign_id.nil?
+        fail ArgumentError, 'campaign_id cannot be nil'
+      end
+
+      pattern = Regexp.new(/cmptfn_[a-fA-F0-9]{40}/)
+      if campaign_id !~ pattern
+        fail ArgumentError, "invalid value for \"campaign_id\", must conform to the pattern #{pattern}."
+      end
+
+      @campaign_id = campaign_id
+    end
+
+    # Checks equality by comparing each attribute.
+    # @param [Object] Object to be compared
+    def ==(o)
+      return true if self.equal?(o)
+      self.class == o.class &&
+          account_id == o.account_id &&
+          campaign_id == o.campaign_id &&
+          use_case == o.use_case &&
+          registration_status == o.registration_status &&
+          date_created == o.date_created &&
+          date_updated == o.date_updated &&
+          date_created_iso == o.date_created_iso &&
+          date_updated_iso == o.date_updated_iso &&
+          revision == o.revision
+    end
+
+    # @see the `==` method
+    # @param [Object] Object to be compared
+    def eql?(o)
+      self == o
+    end
+
+    # Calculates hash code according to all attributes.
+    # @return [Integer] Hash code
+    def hash
+      [account_id, campaign_id, use_case, registration_status, date_created, date_updated, date_created_iso, date_updated_iso, revision].hash
+    end
+
+    # Builds the object from hash
+    # @param [Hash] attributes Model attributes in the form of hash
+    # @return [Object] Returns the model itself
+    def self.build_from_hash(attributes)
+      new.build_from_hash(attributes)
+    end
+
+    # Builds the object from hash
+    # @param [Hash] attributes Model attributes in the form of hash
+    # @return [Object] Returns the model itself
+    def build_from_hash(attributes)
+      return nil unless attributes.is_a?(Hash)
+      self.class.openapi_types.each_pair do |key, type|
+        if attributes[self.class.attribute_map[key]].nil? && self.class.openapi_nullable.include?(key)
+          self.send("#{key}=", nil)
+        elsif type =~ /\AArray<(.*)>/i
+          # check to ensure the input is an array given that the attribute
+          # is documented as an array but the input is not
+          if attributes[self.class.attribute_map[key]].is_a?(Array)
+            self.send("#{key}=", attributes[self.class.attribute_map[key]].map { |v| _deserialize($1, v) })
+          end
+        elsif !attributes[self.class.attribute_map[key]].nil?
+          self.send("#{key}=", _deserialize(type, attributes[self.class.attribute_map[key]]))
+        end
+      end
+
+      self
+    end
+
+    # Deserializes the data based on type
+    # @param string type Data type
+    # @param string value Value to be deserialized
+    # @return [Object] Deserialized data
+    def _deserialize(type, value)
+      case type.to_sym
+      when :Time
+        Time.parse(value)
+      when :Date
+        Date.parse(value)
+      when :String
+        value.to_s
+      when :Integer
+        value.to_i
+      when :Float
+        value.to_f
+      when :Boolean
+        if value.to_s =~ /\A(true|t|yes|y|1)\z/i
+          true
+        else
+          false
+        end
+      when :Object
+        # generic object (usually a Hash), return directly
+        value
+      when /\AArray<(?<inner_type>.+)>\z/
+        inner_type = Regexp.last_match[:inner_type]
+        value.map { |v| _deserialize(inner_type, v) }
+      when /\AHash<(?<k_type>.+?), (?<v_type>.+)>\z/
+        k_type = Regexp.last_match[:k_type]
+        v_type = Regexp.last_match[:v_type]
+        {}.tap do |hash|
+          value.each do |k, v|
+            hash[_deserialize(k_type, k)] = _deserialize(v_type, v)
+          end
+        end
+      else # model
+        # models (e.g. Pet) or oneOf
+        klass = Freeclimb.const_get(type)
+        klass.respond_to?(:openapi_one_of) ? klass.build(value) : klass.build_from_hash(value)
+      end
+    end
+
+    # Returns the string representation of the object
+    # @return [String] String presentation of the object
+    def to_s
+      to_hash.to_s
+    end
+
+    # to_body is an alias to to_hash (backward compatibility)
+    # @return [Hash] Returns the object in the form of hash
+    def to_body
+      to_hash
+    end
+
+    # Returns the object in the form of hash
+    # @return [Hash] Returns the object in the form of hash
+    def to_hash
+      hash = {}
+      self.class.attribute_map.each_pair do |attr, param|
+        value = self.send(attr)
+        if value.nil?
+          is_nullable = self.class.openapi_nullable.include?(attr)
+          next if !is_nullable || (is_nullable && !instance_variable_defined?(:"@#{attr}"))
+        end
+
+        hash[param] = _to_hash(value)
+      end
+      hash
+    end
+
+    # Outputs non-array value in the form of hash
+    # For object, use to_hash. Otherwise, just return the value
+    # @param [Object] value Any valid value
+    # @return [Hash] Returns the value in the form of hash
+    def _to_hash(value)
+      if value.is_a?(Array)
+        value.compact.map { |v| _to_hash(v) }
+      elsif value.is_a?(Hash)
+        {}.tap do |hash|
+          value.each { |k, v| hash[k] = _to_hash(v) }
+        end
+      elsif value.respond_to? :to_hash
+        value.to_hash
+      else
+        value
+      end
+    end
+  end
+end

data/lib/freeclimb/models/unpark.rb

@@ -18,8 +18,7 @@ module Freeclimb
   class Unpark < PerclCommand
     # Attribute mapping from ruby-style variable name to JSON key.
     def self.attribute_map
-      {
-      }
+      {}
     end
 
     # Returns all the JSON keys this model knows about, including the ones defined in its parent(s)
@@ -29,8 +28,7 @@ module Freeclimb
 
     # Attribute type mapping.
     def self.openapi_types
-      {
-      }
+      {}
     end
 
     # List of attributes with nullable: true

data/lib/freeclimb/version.rb

@@ -11,5 +11,5 @@ OpenAPI Generator version: 7.9.0
 =end
 
 module Freeclimb
-  VERSION = '5.0.0'
+  VERSION = '5.1.0'
 end

data/lib/freeclimb.rb

@@ -98,6 +98,7 @@ require 'freeclimb/models/sms_toll_free_campaign'
 require 'freeclimb/models/sms_toll_free_campaign_registration_status'
 require 'freeclimb/models/sms_toll_free_campaigns_list_result'
 require 'freeclimb/models/tfn'
+require 'freeclimb/models/tfn_campaign'
 require 'freeclimb/models/transcribe_reason'
 require 'freeclimb/models/transcribe_term_reason'
 require 'freeclimb/models/transcribe_utterance_record'

data/openapi.json

@@ -151,12 +151,7 @@
       },
       "GetDigitsReason": {
         "type": "string",
-        "enum": [
-          "finishKey",
-          "timeout",
-          "maxDigits",
-          "tone"
-        ],
+        "enum": ["finishKey", "timeout", "maxDigits", "tone"],
         "description": "This field explains how the GetDigits action ended. The value is one of the below: •finishKey - The finish key as specified had been pressed by the caller. Digit string has all keys up to, but not including, the finish key.  •timeout - The timeout limit was reached prior to any other criteria being met. If any digits were collected, they will be included.  •maxDigits - The maximum number of digits was reached and digit collection ended.  •tone - Answering machine or fax tone detection occurred, interrupting digit collection. Any digits received up to this point are included in this webhook."
       },
       "ConferenceStatus": {
@@ -420,12 +415,7 @@
       "SMSTenDLCBrandIdentityStatus": {
         "type": "string",
         "description": "TCR assessment of the brand identification status.",
-        "enum": [
-          "SELF_DECLARED",
-          "UNVERIFIED",
-          "VERIFIED",
-          "VETTED_VERIFIED"
-        ]
+        "enum": ["SELF_DECLARED", "UNVERIFIED", "VERIFIED", "VETTED_VERIFIED"]
       },
       "CompletionResultStatus": {
         "type": "string",
@@ -494,32 +484,32 @@
       "Webhook": {
         "type": "object",
         "discriminator": {
-         "propertyName": "requestType",
-         "mapping": {
-           "addToConferenceNotification":  "#/components/schemas/AddToConferenceNotificationWebhook",
-           "addToQueueNotification": "#/components/schemas/AddToQueueNotificationWebhook",
-           "callControl": "#/components/schemas/CallControlWebhook",
-           "callStatus": "#/components/schemas/CallStatusWebhook",
-           "conferenceRecordingStatus": "#/components/schemas/ConferenceRecordingStatusWebhook",
-           "conferenceStatus": "#/components/schemas/ConferenceStatusWebhook",
-           "createConference": "#/components/schemas/CreateConferenceWebhook",
-           "dequeue": "#/components/schemas/DequeueWebhook",
-           "getDigits": "#/components/schemas/GetDigitsWebhook",
-           "getSpeech": "#/components/schemas/GetSpeechWebhook",
-           "inboundCall": "#/components/schemas/InboundCallWebhook",
-           "leaveConference": "#/components/schemas/LeaveConferenceWebhook",
-           "machineDetected": "#/components/schemas/MachineDetectedWebhook",
-           "messageDelivery": "#/components/schemas/MessageDeliveryWebhook",
-           "messageStatus": "#/components/schemas/MessageStatusWebhook",
-           "outDialApiConnect": "#/components/schemas/OutDialApiConnectWebhook",
-           "outDialConnect": "#/components/schemas/OutDialConnectWebhook",
-           "outDialStart": "#/components/schemas/OutDialStartWebhook",
-           "queueWait": "#/components/schemas/QueueWaitWebhook",
-           "record": "#/components/schemas/RecordWebhook",
-           "redirect": "#/components/schemas/RedirectWebhook",
-           "removeFromQueueNotification": "#/components/schemas/RemoveFromQueueNotificationWebhook",
-           "transcribe": "#/components/schemas/TranscribeWebhook"
-         }
+          "propertyName": "requestType",
+          "mapping": {
+            "addToConferenceNotification": "#/components/schemas/AddToConferenceNotificationWebhook",
+            "addToQueueNotification": "#/components/schemas/AddToQueueNotificationWebhook",
+            "callControl": "#/components/schemas/CallControlWebhook",
+            "callStatus": "#/components/schemas/CallStatusWebhook",
+            "conferenceRecordingStatus": "#/components/schemas/ConferenceRecordingStatusWebhook",
+            "conferenceStatus": "#/components/schemas/ConferenceStatusWebhook",
+            "createConference": "#/components/schemas/CreateConferenceWebhook",
+            "dequeue": "#/components/schemas/DequeueWebhook",
+            "getDigits": "#/components/schemas/GetDigitsWebhook",
+            "getSpeech": "#/components/schemas/GetSpeechWebhook",
+            "inboundCall": "#/components/schemas/InboundCallWebhook",
+            "leaveConference": "#/components/schemas/LeaveConferenceWebhook",
+            "machineDetected": "#/components/schemas/MachineDetectedWebhook",
+            "messageDelivery": "#/components/schemas/MessageDeliveryWebhook",
+            "messageStatus": "#/components/schemas/MessageStatusWebhook",
+            "outDialApiConnect": "#/components/schemas/OutDialApiConnectWebhook",
+            "outDialConnect": "#/components/schemas/OutDialConnectWebhook",
+            "outDialStart": "#/components/schemas/OutDialStartWebhook",
+            "queueWait": "#/components/schemas/QueueWaitWebhook",
+            "record": "#/components/schemas/RecordWebhook",
+            "redirect": "#/components/schemas/RedirectWebhook",
+            "removeFromQueueNotification": "#/components/schemas/RemoveFromQueueNotificationWebhook",
+            "transcribe": "#/components/schemas/TranscribeWebhook"
+          }
         },
         "properties": {
           "requestType": {
@@ -3596,11 +3586,76 @@
                   "format": "uri"
                 },
                 "nullable": true
+              },
+              "tfn": {
+                "$ref": "#/components/schemas/TFN",
+                "nullable": true
+              },
+              "phoneNumberId": {
+                "type": "string",
+                "description": "String that uniquely identifies the phoneNumber resource used to send this Message",
+                "nullable": true
+              },
+              "applicationId": {
+                "type": "string",
+                "description": "String that uniquely identifies the Application resource used to send this Message",
+                "nullable": true
               }
             }
           }
         ]
       },
+      "TFNCampaign": {
+        "type": "object",
+        "required": [
+          "accountId",
+          "campaignId",
+          "useCase",
+          "registrationStatus",
+          "dateCreated",
+          "dateUpdated",
+          "dateCreatedISO",
+          "dateUpdatedISO",
+          "revision"
+        ],
+        "properties": {
+          "accountId": {
+            "type": "string",
+            "description": "ID of the account that created this participant.",
+            "nullable": true
+          },
+          "campaignId": {
+            "$ref": "#/components/schemas/TFNCampaignId"
+          },
+          "useCase": {
+            "type": "string"
+          },
+          "registrationStatus": {
+            "$ref": "#/components/schemas/SMSTollFreeCampaignRegistrationStatus"
+          },
+          "dateCreated": {
+            "type": "string"
+          },
+          "dateUpdated": {
+            "type": "string"
+          },
+          "dateCreatedISO": {
+            "type": "string"
+          },
+          "dateUpdatedISO": {
+            "type": "string"
+          },
+          "revision": {
+            "type": "integer"
+          }
+        }
+      },
+      "TFNCampaignId": {
+        "type": "string",
+        "description": "TFNCampaignId",
+        "pattern": "cmptfn_[a-fA-F0-9]{40}",
+        "example": "cmptfn_387ec3f6e03b340553f35f29c8f118cdf3eae08a"
+      },
       "CreateConferenceRequest": {
         "type": "object",
         "properties": {