freeclimb 4.3.0 → 4.4.1

data/lib/freeclimb/api/default_api.rb

@@ -1406,6 +1406,363 @@ module Freeclimb
       return data, status_code, headers
     end
 
+    # Get a 10DLC SMS Brand
+    # @param brand_id [String] String that uniquely identifies this brand resource.
+    # @param [Hash] opts the optional parameters
+    # @return [SMSTenDLCBrand]
+    def get_ten_dlc_sms_brand(brand_id, opts = {})
+      data, _status_code, _headers = get_ten_dlc_sms_brand_with_http_info(brand_id, opts)
+      data
+    end
+
+    # Get a 10DLC SMS Brand
+    # @param brand_id [String] String that uniquely identifies this brand resource.
+    # @param [Hash] opts the optional parameters
+    # @return [Array<(SMSTenDLCBrand, Integer, Hash)>] SMSTenDLCBrand data, response status code and response headers
+    def get_ten_dlc_sms_brand_with_http_info(brand_id, opts = {})
+      if @api_client.config.debugging
+        @api_client.config.logger.debug 'Calling API: DefaultApi.get_ten_dlc_sms_brand ...'
+      end
+
+      # verify the required parameter 'brand_id' is set
+      if @api_client.config.client_side_validation && brand_id.nil?
+        fail ArgumentError, "Missing the required parameter 'brand_id' when calling DefaultApi.get_ten_dlc_sms_brand"
+      end
+      # resource path
+      local_var_path = '/Accounts/{accountId}/Messages/10DLC/Brands/{brandId}'.sub('{' + 'accountId' + '}', CGI.escape(account_id.to_s)).sub('{' + 'brandId' + '}', CGI.escape(brand_id.to_s))
+
+      # query parameters
+      query_params = opts[:query_params] || {}
+
+      # header parameters
+      header_params = opts[:header_params] || {}
+      # HTTP header 'Accept' (if needed)
+      header_params['Accept'] = @api_client.select_header_accept(['application/json'])
+
+      # form parameters
+      form_params = opts[:form_params] || {}
+
+      # http body (model)
+      post_body = opts[:debug_body]
+
+      # return_type
+      return_type = opts[:debug_return_type] || 'SMSTenDLCBrand'
+
+      # auth_names
+      auth_names = opts[:debug_auth_names] || ['fc']
+
+      new_options = opts.merge(
+        :operation => :"DefaultApi.get_ten_dlc_sms_brand",
+        :header_params => header_params,
+        :query_params => query_params,
+        :form_params => form_params,
+        :body => post_body,
+        :auth_names => auth_names,
+        :return_type => return_type
+      )
+
+      data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
+      if @api_client.config.debugging
+        @api_client.config.logger.debug "API called: DefaultApi#get_ten_dlc_sms_brand\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+      end
+      return data, status_code, headers
+    end
+
+    # Get list of SMS 10DLC Brands
+    # @param [Hash] opts the optional parameters
+    # @return [SMSTenDLCBrandsListResult]
+    def get_ten_dlc_sms_brands(opts = {})
+      data, _status_code, _headers = get_ten_dlc_sms_brands_with_http_info(opts)
+      data
+    end
+
+    # Get list of SMS 10DLC Brands
+    # @param [Hash] opts the optional parameters
+    # @return [Array<(SMSTenDLCBrandsListResult, Integer, Hash)>] SMSTenDLCBrandsListResult data, response status code and response headers
+    def get_ten_dlc_sms_brands_with_http_info(opts = {})
+      if @api_client.config.debugging
+        @api_client.config.logger.debug 'Calling API: DefaultApi.get_ten_dlc_sms_brands ...'
+      end
+      # resource path
+      local_var_path = '/Accounts/{accountId}/Messages/10DLC/Brands'.sub('{' + 'accountId' + '}', CGI.escape(account_id.to_s))
+
+      # query parameters
+      query_params = opts[:query_params] || {}
+
+      # header parameters
+      header_params = opts[:header_params] || {}
+      # HTTP header 'Accept' (if needed)
+      header_params['Accept'] = @api_client.select_header_accept(['application/json'])
+
+      # form parameters
+      form_params = opts[:form_params] || {}
+
+      # http body (model)
+      post_body = opts[:debug_body]
+
+      # return_type
+      return_type = opts[:debug_return_type] || 'SMSTenDLCBrandsListResult'
+
+      # auth_names
+      auth_names = opts[:debug_auth_names] || ['fc']
+
+      new_options = opts.merge(
+        :operation => :"DefaultApi.get_ten_dlc_sms_brands",
+        :header_params => header_params,
+        :query_params => query_params,
+        :form_params => form_params,
+        :body => post_body,
+        :auth_names => auth_names,
+        :return_type => return_type
+      )
+
+      data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
+      if @api_client.config.debugging
+        @api_client.config.logger.debug "API called: DefaultApi#get_ten_dlc_sms_brands\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+      end
+      return data, status_code, headers
+    end
+
+    # Get a 10DLC SMS Campaign
+    # @param campaign_id [String] String that uniquely identifies this campaign resource.
+    # @param [Hash] opts the optional parameters
+    # @return [SMSTenDLCCampaign]
+    def get_ten_dlc_sms_campaign(campaign_id, opts = {})
+      data, _status_code, _headers = get_ten_dlc_sms_campaign_with_http_info(campaign_id, opts)
+      data
+    end
+
+    # Get a 10DLC SMS Campaign
+    # @param campaign_id [String] String that uniquely identifies this campaign resource.
+    # @param [Hash] opts the optional parameters
+    # @return [Array<(SMSTenDLCCampaign, Integer, Hash)>] SMSTenDLCCampaign data, response status code and response headers
+    def get_ten_dlc_sms_campaign_with_http_info(campaign_id, opts = {})
+      if @api_client.config.debugging
+        @api_client.config.logger.debug 'Calling API: DefaultApi.get_ten_dlc_sms_campaign ...'
+      end
+
+      # verify the required parameter 'campaign_id' is set
+      if @api_client.config.client_side_validation && campaign_id.nil?
+        fail ArgumentError, "Missing the required parameter 'campaign_id' when calling DefaultApi.get_ten_dlc_sms_campaign"
+      end
+      # resource path
+      local_var_path = '/Accounts/{accountId}/Messages/10DLC/Campaigns/{campaignId}'.sub('{' + 'accountId' + '}', CGI.escape(account_id.to_s)).sub('{' + 'campaignId' + '}', CGI.escape(campaign_id.to_s))
+
+      # query parameters
+      query_params = opts[:query_params] || {}
+
+      # header parameters
+      header_params = opts[:header_params] || {}
+      # HTTP header 'Accept' (if needed)
+      header_params['Accept'] = @api_client.select_header_accept(['application/json'])
+
+      # form parameters
+      form_params = opts[:form_params] || {}
+
+      # http body (model)
+      post_body = opts[:debug_body]
+
+      # return_type
+      return_type = opts[:debug_return_type] || 'SMSTenDLCCampaign'
+
+      # auth_names
+      auth_names = opts[:debug_auth_names] || ['fc']
+
+      new_options = opts.merge(
+        :operation => :"DefaultApi.get_ten_dlc_sms_campaign",
+        :header_params => header_params,
+        :query_params => query_params,
+        :form_params => form_params,
+        :body => post_body,
+        :auth_names => auth_names,
+        :return_type => return_type
+      )
+
+      data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
+      if @api_client.config.debugging
+        @api_client.config.logger.debug "API called: DefaultApi#get_ten_dlc_sms_campaign\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+      end
+      return data, status_code, headers
+    end
+
+    # Get list of SMS 10DLC Campaigns
+    # @param [Hash] opts the optional parameters
+    # @option opts [String] :brand_id The unique identifier for a brand
+    # @return [SMSTenDLCCampaignsListResult]
+    def get_ten_dlc_sms_campaigns(opts = {})
+      data, _status_code, _headers = get_ten_dlc_sms_campaigns_with_http_info(opts)
+      data
+    end
+
+    # Get list of SMS 10DLC Campaigns
+    # @param [Hash] opts the optional parameters
+    # @option opts [String] :brand_id The unique identifier for a brand
+    # @return [Array<(SMSTenDLCCampaignsListResult, Integer, Hash)>] SMSTenDLCCampaignsListResult data, response status code and response headers
+    def get_ten_dlc_sms_campaigns_with_http_info(opts = {})
+      if @api_client.config.debugging
+        @api_client.config.logger.debug 'Calling API: DefaultApi.get_ten_dlc_sms_campaigns ...'
+      end
+      # resource path
+      local_var_path = '/Accounts/{accountId}/Messages/10DLC/Campaigns'.sub('{' + 'accountId' + '}', CGI.escape(account_id.to_s))
+
+      # query parameters
+      query_params = opts[:query_params] || {}
+      query_params[:'brandId'] = opts[:'brand_id'] if !opts[:'brand_id'].nil?
+
+      # header parameters
+      header_params = opts[:header_params] || {}
+      # HTTP header 'Accept' (if needed)
+      header_params['Accept'] = @api_client.select_header_accept(['application/json'])
+
+      # form parameters
+      form_params = opts[:form_params] || {}
+
+      # http body (model)
+      post_body = opts[:debug_body]
+
+      # return_type
+      return_type = opts[:debug_return_type] || 'SMSTenDLCCampaignsListResult'
+
+      # auth_names
+      auth_names = opts[:debug_auth_names] || ['fc']
+
+      new_options = opts.merge(
+        :operation => :"DefaultApi.get_ten_dlc_sms_campaigns",
+        :header_params => header_params,
+        :query_params => query_params,
+        :form_params => form_params,
+        :body => post_body,
+        :auth_names => auth_names,
+        :return_type => return_type
+      )
+
+      data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
+      if @api_client.config.debugging
+        @api_client.config.logger.debug "API called: DefaultApi#get_ten_dlc_sms_campaigns\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+      end
+      return data, status_code, headers
+    end
+
+    # Get a 10DLC SMS Partner Campaign
+    # @param campaign_id [String] String that uniquely identifies this campaign resource.
+    # @param [Hash] opts the optional parameters
+    # @return [SMSTenDLCPartnerCampaign]
+    def get_ten_dlc_sms_partner_campaign(campaign_id, opts = {})
+      data, _status_code, _headers = get_ten_dlc_sms_partner_campaign_with_http_info(campaign_id, opts)
+      data
+    end
+
+    # Get a 10DLC SMS Partner Campaign
+    # @param campaign_id [String] String that uniquely identifies this campaign resource.
+    # @param [Hash] opts the optional parameters
+    # @return [Array<(SMSTenDLCPartnerCampaign, Integer, Hash)>] SMSTenDLCPartnerCampaign data, response status code and response headers
+    def get_ten_dlc_sms_partner_campaign_with_http_info(campaign_id, opts = {})
+      if @api_client.config.debugging
+        @api_client.config.logger.debug 'Calling API: DefaultApi.get_ten_dlc_sms_partner_campaign ...'
+      end
+
+      # verify the required parameter 'campaign_id' is set
+      if @api_client.config.client_side_validation && campaign_id.nil?
+        fail ArgumentError, "Missing the required parameter 'campaign_id' when calling DefaultApi.get_ten_dlc_sms_partner_campaign"
+      end
+      # resource path
+      local_var_path = '/Accounts/{accountId}/Messages/10DLC/PartnerCampaigns/{campaignId}'.sub('{' + 'accountId' + '}', CGI.escape(account_id.to_s)).sub('{' + 'campaignId' + '}', CGI.escape(campaign_id.to_s))
+
+      # query parameters
+      query_params = opts[:query_params] || {}
+
+      # header parameters
+      header_params = opts[:header_params] || {}
+      # HTTP header 'Accept' (if needed)
+      header_params['Accept'] = @api_client.select_header_accept(['application/json'])
+
+      # form parameters
+      form_params = opts[:form_params] || {}
+
+      # http body (model)
+      post_body = opts[:debug_body]
+
+      # return_type
+      return_type = opts[:debug_return_type] || 'SMSTenDLCPartnerCampaign'
+
+      # auth_names
+      auth_names = opts[:debug_auth_names] || ['fc']
+
+      new_options = opts.merge(
+        :operation => :"DefaultApi.get_ten_dlc_sms_partner_campaign",
+        :header_params => header_params,
+        :query_params => query_params,
+        :form_params => form_params,
+        :body => post_body,
+        :auth_names => auth_names,
+        :return_type => return_type
+      )
+
+      data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
+      if @api_client.config.debugging
+        @api_client.config.logger.debug "API called: DefaultApi#get_ten_dlc_sms_partner_campaign\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+      end
+      return data, status_code, headers
+    end
+
+    # Get list of SMS 10DLC Partner Campaigns
+    # @param [Hash] opts the optional parameters
+    # @option opts [String] :brand_id The unique identifier for a brand
+    # @return [SMSTenDLCPartnerCampaignsListResult]
+    def get_ten_dlc_sms_partner_campaigns(opts = {})
+      data, _status_code, _headers = get_ten_dlc_sms_partner_campaigns_with_http_info(opts)
+      data
+    end
+
+    # Get list of SMS 10DLC Partner Campaigns
+    # @param [Hash] opts the optional parameters
+    # @option opts [String] :brand_id The unique identifier for a brand
+    # @return [Array<(SMSTenDLCPartnerCampaignsListResult, Integer, Hash)>] SMSTenDLCPartnerCampaignsListResult data, response status code and response headers
+    def get_ten_dlc_sms_partner_campaigns_with_http_info(opts = {})
+      if @api_client.config.debugging
+        @api_client.config.logger.debug 'Calling API: DefaultApi.get_ten_dlc_sms_partner_campaigns ...'
+      end
+      # resource path
+      local_var_path = '/Accounts/{accountId}/Messages/10DLC/PartnerCampaigns'.sub('{' + 'accountId' + '}', CGI.escape(account_id.to_s))
+
+      # query parameters
+      query_params = opts[:query_params] || {}
+      query_params[:'brandId'] = opts[:'brand_id'] if !opts[:'brand_id'].nil?
+
+      # header parameters
+      header_params = opts[:header_params] || {}
+      # HTTP header 'Accept' (if needed)
+      header_params['Accept'] = @api_client.select_header_accept(['application/json'])
+
+      # form parameters
+      form_params = opts[:form_params] || {}
+
+      # http body (model)
+      post_body = opts[:debug_body]
+
+      # return_type
+      return_type = opts[:debug_return_type] || 'SMSTenDLCPartnerCampaignsListResult'
+
+      # auth_names
+      auth_names = opts[:debug_auth_names] || ['fc']
+
+      new_options = opts.merge(
+        :operation => :"DefaultApi.get_ten_dlc_sms_partner_campaigns",
+        :header_params => header_params,
+        :query_params => query_params,
+        :form_params => form_params,
+        :body => post_body,
+        :auth_names => auth_names,
+        :return_type => return_type
+      )
+
+      data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
+      if @api_client.config.debugging
+        @api_client.config.logger.debug "API called: DefaultApi#get_ten_dlc_sms_partner_campaigns\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+      end
+      return data, status_code, headers
+    end
+
     # List Active Queues
     # @param [Hash] opts the optional parameters
     # @option opts [String] :_alias Return only the Queue resources with aliases that exactly match this name.
@@ -1949,6 +2306,7 @@ module Freeclimb
     # @option opts [Boolean] :has_application Indication of whether the phone number has an application linked to it. (default to false)
     # @option opts [Boolean] :voice_enabled Indicates whether the phone number can handle Calls. Typically set to true for all numbers. (default to true)
     # @option opts [Boolean] :sms_enabled Indication of whether the phone number can handle sending and receiving SMS messages. Typically set to true for all numbers. (default to true)
+    # @option opts [Boolean] :has_campaign Indication of whether the phone number has a campaign associated with it
     # @option opts [Boolean] :capabilities_voice 
     # @option opts [Boolean] :capabilities_sms 
     # @option opts [Boolean] :capabilities_toll_free 
@@ -1971,6 +2329,7 @@ module Freeclimb
     # @option opts [Boolean] :has_application Indication of whether the phone number has an application linked to it.
     # @option opts [Boolean] :voice_enabled Indicates whether the phone number can handle Calls. Typically set to true for all numbers.
     # @option opts [Boolean] :sms_enabled Indication of whether the phone number can handle sending and receiving SMS messages. Typically set to true for all numbers.
+    # @option opts [Boolean] :has_campaign Indication of whether the phone number has a campaign associated with it
     # @option opts [Boolean] :capabilities_voice 
     # @option opts [Boolean] :capabilities_sms 
     # @option opts [Boolean] :capabilities_toll_free 
@@ -1995,6 +2354,7 @@ module Freeclimb
       query_params[:'hasApplication'] = opts[:'has_application'] if !opts[:'has_application'].nil?
       query_params[:'voiceEnabled'] = opts[:'voice_enabled'] if !opts[:'voice_enabled'].nil?
       query_params[:'smsEnabled'] = opts[:'sms_enabled'] if !opts[:'sms_enabled'].nil?
+      query_params[:'hasCampaign'] = opts[:'has_campaign'] if !opts[:'has_campaign'].nil?
       query_params[:'capabilities.voice'] = opts[:'capabilities_voice'] if !opts[:'capabilities_voice'].nil?
       query_params[:'capabilities.sms'] = opts[:'capabilities_sms'] if !opts[:'capabilities_sms'].nil?
       query_params[:'capabilities.tollFree'] = opts[:'capabilities_toll_free'] if !opts[:'capabilities_toll_free'].nil?

data/lib/freeclimb/models/incoming_number_request.rb

@@ -21,11 +21,15 @@ module Freeclimb
     # Description for this phone number.
     attr_accessor :_alias
 
+    # The campaign ID generated by the campaign registry
+    attr_accessor :campaign_id
+
     # Attribute mapping from ruby-style variable name to JSON key.
     def self.attribute_map
       {
         :'application_id' => :'applicationId',
-        :'_alias' => :'alias'
+        :'_alias' => :'alias',
+        :'campaign_id' => :'campaignId'
       }
     end
 
@@ -38,13 +42,15 @@ module Freeclimb
     def self.openapi_types
       {
         :'application_id' => :'String',
-        :'_alias' => :'String'
+        :'_alias' => :'String',
+        :'campaign_id' => :'String'
       }
     end
 
     # List of attributes with nullable: true
     def self.openapi_nullable
       Set.new([
+        :'campaign_id'
       ])
     end
 
@@ -70,6 +76,10 @@ module Freeclimb
       if attributes.key?(:'_alias')
         self._alias = attributes[:'_alias']
       end
+
+      if attributes.key?(:'campaign_id')
+        self.campaign_id = attributes[:'campaign_id']
+      end
     end
 
     # Show invalid properties with the reasons. Usually used together with valid?
@@ -91,7 +101,8 @@ module Freeclimb
       return true if self.equal?(o)
       self.class == o.class &&
           application_id == o.application_id &&
-          _alias == o._alias
+          _alias == o._alias &&
+          campaign_id == o.campaign_id
     end
 
     # @see the `==` method
@@ -103,7 +114,7 @@ module Freeclimb
     # Calculates hash code according to all attributes.
     # @return [Integer] Hash code
     def hash
-      [application_id, _alias].hash
+      [application_id, _alias, campaign_id].hash
     end
 
     # Builds the object from hash