rcs 2.0.5 → 2.0.8

data/lib/rcs/phone_numbers/types/retrieve_phone_number_details_options.rb

@@ -1,93 +0,0 @@
-# frozen_string_literal: true
-
-require_relative "enhanced_contact_info"
-require "ostruct"
-require "json"
-
-module Pinnacle
-  module PhoneNumbers
-    module Types
-      # Customize your lookup with additional options.
-      class RetrievePhoneNumberDetailsOptions
-        # @return [Boolean] Allows you to force a fresh lookup from primary sources instead of cached data.
-        #  <br>
-        #  Fresh lookups will take longer to complete than cached lookups.
-        attr_reader :force
-        # @return [Boolean] Include a fraud risk and security analysis.
-        attr_reader :risk
-        # @return [Pinnacle::PhoneNumbers::Types::EnhancedContactInfo] Additional information to tailor lookup.
-        attr_reader :enhanced_contact_info
-        # @return [OpenStruct] Additional properties unmapped to the current class definition
-        attr_reader :additional_properties
-        # @return [Object]
-        attr_reader :_field_set
-        protected :_field_set
-
-        OMIT = Object.new
-
-        # @param force [Boolean] Allows you to force a fresh lookup from primary sources instead of cached data.
-        #  <br>
-        #  Fresh lookups will take longer to complete than cached lookups.
-        # @param risk [Boolean] Include a fraud risk and security analysis.
-        # @param enhanced_contact_info [Pinnacle::PhoneNumbers::Types::EnhancedContactInfo] Additional information to tailor lookup.
-        # @param additional_properties [OpenStruct] Additional properties unmapped to the current class definition
-        # @return [Pinnacle::PhoneNumbers::Types::RetrievePhoneNumberDetailsOptions]
-        def initialize(force: OMIT, risk: OMIT, enhanced_contact_info: OMIT, additional_properties: nil)
-          @force = force if force != OMIT
-          @risk = risk if risk != OMIT
-          @enhanced_contact_info = enhanced_contact_info if enhanced_contact_info != OMIT
-          @additional_properties = additional_properties
-          @_field_set = {
-            "force": force,
-            "risk": risk,
-            "enhanced_contact_info": enhanced_contact_info
-          }.reject do |_k, v|
-            v == OMIT
-          end
-        end
-
-        # Deserialize a JSON object to an instance of RetrievePhoneNumberDetailsOptions
-        #
-        # @param json_object [String]
-        # @return [Pinnacle::PhoneNumbers::Types::RetrievePhoneNumberDetailsOptions]
-        def self.from_json(json_object:)
-          struct = JSON.parse(json_object, object_class: OpenStruct)
-          parsed_json = JSON.parse(json_object)
-          force = parsed_json["force"]
-          risk = parsed_json["risk"]
-          if parsed_json["enhanced_contact_info"].nil?
-            enhanced_contact_info = nil
-          else
-            enhanced_contact_info = parsed_json["enhanced_contact_info"].to_json
-            enhanced_contact_info = Pinnacle::PhoneNumbers::Types::EnhancedContactInfo.from_json(json_object: enhanced_contact_info)
-          end
-          new(
-            force: force,
-            risk: risk,
-            enhanced_contact_info: enhanced_contact_info,
-            additional_properties: struct
-          )
-        end
-
-        # Serialize an instance of RetrievePhoneNumberDetailsOptions to a JSON object
-        #
-        # @return [String]
-        def to_json(*_args)
-          @_field_set&.to_json
-        end
-
-        # Leveraged for Union-type generation, validate_raw attempts to parse the given
-        #  hash and check each fields type against the current object's property
-        #  definitions.
-        #
-        # @param obj [Object]
-        # @return [Void]
-        def self.validate_raw(obj:)
-          obj.force&.is_a?(Boolean) != false || raise("Passed value for field obj.force is not the expected type, validation failed.")
-          obj.risk&.is_a?(Boolean) != false || raise("Passed value for field obj.risk is not the expected type, validation failed.")
-          obj.enhanced_contact_info.nil? || Pinnacle::PhoneNumbers::Types::EnhancedContactInfo.validate_raw(obj: obj.enhanced_contact_info)
-        end
-      end
-    end
-  end
-end

data/lib/rcs/phone_numbers/types/search_phone_number_by_digits.rb

@@ -1,81 +0,0 @@
-# frozen_string_literal: true
-
-require "ostruct"
-require "json"
-
-module Pinnacle
-  module PhoneNumbers
-    module Types
-      # Filter your search by digit pattern.
-      class SearchPhoneNumberByDigits
-        # @return [String] Your search will return only numbers that contain this digit sequence anywhere
-        #  within them.
-        attr_reader :contains
-        # @return [String] Your search will return only numbers that end with these digits.
-        attr_reader :ends_with
-        # @return [String] Your search will return only numbers that begin with these digits.
-        attr_reader :starts_with
-        # @return [OpenStruct] Additional properties unmapped to the current class definition
-        attr_reader :additional_properties
-        # @return [Object]
-        attr_reader :_field_set
-        protected :_field_set
-
-        OMIT = Object.new
-
-        # @param contains [String] Your search will return only numbers that contain this digit sequence anywhere
-        #  within them.
-        # @param ends_with [String] Your search will return only numbers that end with these digits.
-        # @param starts_with [String] Your search will return only numbers that begin with these digits.
-        # @param additional_properties [OpenStruct] Additional properties unmapped to the current class definition
-        # @return [Pinnacle::PhoneNumbers::Types::SearchPhoneNumberByDigits]
-        def initialize(contains: OMIT, ends_with: OMIT, starts_with: OMIT, additional_properties: nil)
-          @contains = contains if contains != OMIT
-          @ends_with = ends_with if ends_with != OMIT
-          @starts_with = starts_with if starts_with != OMIT
-          @additional_properties = additional_properties
-          @_field_set = { "contains": contains, "endsWith": ends_with, "startsWith": starts_with }.reject do |_k, v|
-            v == OMIT
-          end
-        end
-
-        # Deserialize a JSON object to an instance of SearchPhoneNumberByDigits
-        #
-        # @param json_object [String]
-        # @return [Pinnacle::PhoneNumbers::Types::SearchPhoneNumberByDigits]
-        def self.from_json(json_object:)
-          struct = JSON.parse(json_object, object_class: OpenStruct)
-          parsed_json = JSON.parse(json_object)
-          contains = parsed_json["contains"]
-          ends_with = parsed_json["endsWith"]
-          starts_with = parsed_json["startsWith"]
-          new(
-            contains: contains,
-            ends_with: ends_with,
-            starts_with: starts_with,
-            additional_properties: struct
-          )
-        end
-
-        # Serialize an instance of SearchPhoneNumberByDigits to a JSON object
-        #
-        # @return [String]
-        def to_json(*_args)
-          @_field_set&.to_json
-        end
-
-        # Leveraged for Union-type generation, validate_raw attempts to parse the given
-        #  hash and check each fields type against the current object's property
-        #  definitions.
-        #
-        # @param obj [Object]
-        # @return [Void]
-        def self.validate_raw(obj:)
-          obj.contains&.is_a?(String) != false || raise("Passed value for field obj.contains is not the expected type, validation failed.")
-          obj.ends_with&.is_a?(String) != false || raise("Passed value for field obj.ends_with is not the expected type, validation failed.")
-          obj.starts_with&.is_a?(String) != false || raise("Passed value for field obj.starts_with is not the expected type, validation failed.")
-        end
-      end
-    end
-  end
-end

data/lib/rcs/phone_numbers/types/search_phone_number_by_location.rb

@@ -1,96 +0,0 @@
-# frozen_string_literal: true
-
-require "ostruct"
-require "json"
-
-module Pinnacle
-  module PhoneNumbers
-    module Types
-      # Filter your search by geographic location to find numbers in specific regions.
-      #  <br>
-      #  Toll-free numbers ignore city and state filters.
-      class SearchPhoneNumberByLocation
-        # @return [String] Search for numbers in your target city.
-        attr_reader :city
-        # @return [String] Currently, only US numbers are supported.
-        attr_reader :country_code
-        # @return [String] Narrow your search to a specific area or exchange code. <br>
-        #  For US numbers, this is usually the 3-digit area code.
-        attr_reader :national_destination_code
-        # @return [String] Search for numbers in your target state or province using a two-letter code.
-        attr_reader :state
-        # @return [OpenStruct] Additional properties unmapped to the current class definition
-        attr_reader :additional_properties
-        # @return [Object]
-        attr_reader :_field_set
-        protected :_field_set
-
-        OMIT = Object.new
-
-        # @param city [String] Search for numbers in your target city.
-        # @param country_code [String] Currently, only US numbers are supported.
-        # @param national_destination_code [String] Narrow your search to a specific area or exchange code. <br>
-        #  For US numbers, this is usually the 3-digit area code.
-        # @param state [String] Search for numbers in your target state or province using a two-letter code.
-        # @param additional_properties [OpenStruct] Additional properties unmapped to the current class definition
-        # @return [Pinnacle::PhoneNumbers::Types::SearchPhoneNumberByLocation]
-        def initialize(city: OMIT, country_code: OMIT, national_destination_code: OMIT, state: OMIT,
-                       additional_properties: nil)
-          @city = city if city != OMIT
-          @country_code = country_code if country_code != OMIT
-          @national_destination_code = national_destination_code if national_destination_code != OMIT
-          @state = state if state != OMIT
-          @additional_properties = additional_properties
-          @_field_set = {
-            "city": city,
-            "countryCode": country_code,
-            "nationalDestinationCode": national_destination_code,
-            "state": state
-          }.reject do |_k, v|
-            v == OMIT
-          end
-        end
-
-        # Deserialize a JSON object to an instance of SearchPhoneNumberByLocation
-        #
-        # @param json_object [String]
-        # @return [Pinnacle::PhoneNumbers::Types::SearchPhoneNumberByLocation]
-        def self.from_json(json_object:)
-          struct = JSON.parse(json_object, object_class: OpenStruct)
-          parsed_json = JSON.parse(json_object)
-          city = parsed_json["city"]
-          country_code = parsed_json["countryCode"]
-          national_destination_code = parsed_json["nationalDestinationCode"]
-          state = parsed_json["state"]
-          new(
-            city: city,
-            country_code: country_code,
-            national_destination_code: national_destination_code,
-            state: state,
-            additional_properties: struct
-          )
-        end
-
-        # Serialize an instance of SearchPhoneNumberByLocation to a JSON object
-        #
-        # @return [String]
-        def to_json(*_args)
-          @_field_set&.to_json
-        end
-
-        # Leveraged for Union-type generation, validate_raw attempts to parse the given
-        #  hash and check each fields type against the current object's property
-        #  definitions.
-        #
-        # @param obj [Object]
-        # @return [Void]
-        def self.validate_raw(obj:)
-          obj.city&.is_a?(String) != false || raise("Passed value for field obj.city is not the expected type, validation failed.")
-          obj.country_code&.is_a?(String) != false || raise("Passed value for field obj.country_code is not the expected type, validation failed.")
-          obj.national_destination_code&.is_a?(String) != false || raise("Passed value for field obj.national_destination_code is not the expected type, validation failed.")
-          obj.state&.is_a?(String) != false || raise("Passed value for field obj.state is not the expected type, validation failed.")
-        end
-      end
-    end
-  end
-end

data/lib/rcs/phone_numbers/types/search_phone_number_options.rb

@@ -1,62 +0,0 @@
-# frozen_string_literal: true
-
-require "ostruct"
-require "json"
-
-module Pinnacle
-  module PhoneNumbers
-    module Types
-      # Extra search settings to control how many results you get.
-      class SearchPhoneNumberOptions
-        # @return [Integer] Set the maximum number of phone numbers to return.
-        attr_reader :limit
-        # @return [OpenStruct] Additional properties unmapped to the current class definition
-        attr_reader :additional_properties
-        # @return [Object]
-        attr_reader :_field_set
-        protected :_field_set
-
-        OMIT = Object.new
-
-        # @param limit [Integer] Set the maximum number of phone numbers to return.
-        # @param additional_properties [OpenStruct] Additional properties unmapped to the current class definition
-        # @return [Pinnacle::PhoneNumbers::Types::SearchPhoneNumberOptions]
-        def initialize(limit: OMIT, additional_properties: nil)
-          @limit = limit if limit != OMIT
-          @additional_properties = additional_properties
-          @_field_set = { "limit": limit }.reject do |_k, v|
-            v == OMIT
-          end
-        end
-
-        # Deserialize a JSON object to an instance of SearchPhoneNumberOptions
-        #
-        # @param json_object [String]
-        # @return [Pinnacle::PhoneNumbers::Types::SearchPhoneNumberOptions]
-        def self.from_json(json_object:)
-          struct = JSON.parse(json_object, object_class: OpenStruct)
-          parsed_json = JSON.parse(json_object)
-          limit = parsed_json["limit"]
-          new(limit: limit, additional_properties: struct)
-        end
-
-        # Serialize an instance of SearchPhoneNumberOptions to a JSON object
-        #
-        # @return [String]
-        def to_json(*_args)
-          @_field_set&.to_json
-        end
-
-        # Leveraged for Union-type generation, validate_raw attempts to parse the given
-        #  hash and check each fields type against the current object's property
-        #  definitions.
-        #
-        # @param obj [Object]
-        # @return [Void]
-        def self.validate_raw(obj:)
-          obj.limit&.is_a?(Integer) != false || raise("Passed value for field obj.limit is not the expected type, validation failed.")
-        end
-      end
-    end
-  end
-end

data/lib/rcs/phone_numbers/webhook/client.rb

@@ -1,193 +0,0 @@
-# frozen_string_literal: true
-
-require_relative "../../../requests"
-require_relative "../../types/attach_webhook_params"
-require_relative "../../types/configured_webhook"
-require_relative "../../types/detached_webhook_info"
-require "async"
-
-module Pinnacle
-  module PhoneNumbers
-    class WebhookClient
-      # @return [Pinnacle::RequestClient]
-      attr_reader :request_client
-
-      # @param request_client [Pinnacle::RequestClient]
-      # @return [Pinnacle::PhoneNumbers::WebhookClient]
-      def initialize(request_client:)
-        @request_client = request_client
-      end
-
-      # Connect a webhook to your phone number to receive real-time notifications for
-      #  incoming messages, delivery status updates, and other communication events.
-      #
-      # @param phone [String] The phone number you want to attach the webhook to in E.164 format. Make sure it
-      #  is url encoded (i.e. replace the leading + with %2B). <br>
-      #  Must be a phone number that you own and have already [purchased](./buy) through
-      #  the API. A phone number can have multiple webhooks attached to it.
-      # @param request [Pinnacle::Types::AttachWebhookByIdParams, Pinnacle::Types::CreateAndAttachWebhookByUrlParams]
-      # @param request_options [Pinnacle::RequestOptions]
-      # @return [Pinnacle::Types::ConfiguredWebhook]
-      # @example
-      #  api = Pinnacle::Client.new(
-      #    base_url: "https://api.example.com",
-      #    environment: Pinnacle::Environment::DEFAULT,
-      #    api_key: "YOUR_API_KEY"
-      #  )
-      #  api.phone_numbers.webhook.attach(phone: "%2B14155551234", request: { webhook_id: "wh_1234567890", event: MESSAGE_STATUS })
-      def attach(phone:, request:, request_options: nil)
-        response = @request_client.conn.post do |req|
-          req.options.timeout = request_options.timeout_in_seconds unless request_options&.timeout_in_seconds.nil?
-          req.headers["PINNACLE-API-KEY"] = request_options.api_key unless request_options&.api_key.nil?
-          req.headers = {
-        **(req.headers || {}),
-        **@request_client.get_headers,
-        **(request_options&.additional_headers || {})
-          }.compact
-          unless request_options.nil? || request_options&.additional_query_parameters.nil?
-            req.params = { **(request_options&.additional_query_parameters || {}) }.compact
-          end
-          req.body = { **(request || {}), **(request_options&.additional_body_parameters || {}) }.compact
-          req.url "#{@request_client.get_url(request_options: request_options)}/phone-numbers/#{phone}/attach-webhook"
-        end
-        Pinnacle::Types::ConfiguredWebhook.from_json(json_object: response.body)
-      end
-
-      # Disconnect a webhook from your phone number to stop receiving event
-      #  notifications for that specific number. <br>
-      #  The webhook configuration itself remains intact and available for use with other
-      #  phone numbers.
-      #
-      # @param phone [String] The phone number you want to attach the webhook to in E.164 format. Make sure it
-      #  is url encoded (i.e. replace the leading + with %2B). <br>
-      #  Must be a phone number that you own and currently has the specified webhook
-      #  attached.
-      # @param webhook_id [String] The unique identifier of the webhook you want to detach from the phone number.
-      #  <br>
-      #  This must be a valid webhook ID that is currently attached to the specified
-      #  phone number. This identifier is a string that always begins with the prefix
-      #  `wh_`, for example: `wh_1234567890`.
-      # @param request_options [Pinnacle::RequestOptions]
-      # @return [Pinnacle::Types::DetachedWebhookInfo]
-      # @example
-      #  api = Pinnacle::Client.new(
-      #    base_url: "https://api.example.com",
-      #    environment: Pinnacle::Environment::DEFAULT,
-      #    api_key: "YOUR_API_KEY"
-      #  )
-      #  api.phone_numbers.webhook.detach(phone: "+14155551234", webhook_id: "wh_1234567890")
-      def detach(phone:, webhook_id:, request_options: nil)
-        response = @request_client.conn.delete do |req|
-          req.options.timeout = request_options.timeout_in_seconds unless request_options&.timeout_in_seconds.nil?
-          req.headers["PINNACLE-API-KEY"] = request_options.api_key unless request_options&.api_key.nil?
-          req.headers = {
-        **(req.headers || {}),
-        **@request_client.get_headers,
-        **(request_options&.additional_headers || {})
-          }.compact
-          unless request_options.nil? || request_options&.additional_query_parameters.nil?
-            req.params = { **(request_options&.additional_query_parameters || {}) }.compact
-          end
-          unless request_options.nil? || request_options&.additional_body_parameters.nil?
-            req.body = { **(request_options&.additional_body_parameters || {}) }.compact
-          end
-          req.url "#{@request_client.get_url(request_options: request_options)}/phone-numbers/#{phone}/detach-webhook/#{webhook_id}"
-        end
-        Pinnacle::Types::DetachedWebhookInfo.from_json(json_object: response.body)
-      end
-    end
-
-    class AsyncWebhookClient
-      # @return [Pinnacle::AsyncRequestClient]
-      attr_reader :request_client
-
-      # @param request_client [Pinnacle::AsyncRequestClient]
-      # @return [Pinnacle::PhoneNumbers::AsyncWebhookClient]
-      def initialize(request_client:)
-        @request_client = request_client
-      end
-
-      # Connect a webhook to your phone number to receive real-time notifications for
-      #  incoming messages, delivery status updates, and other communication events.
-      #
-      # @param phone [String] The phone number you want to attach the webhook to in E.164 format. Make sure it
-      #  is url encoded (i.e. replace the leading + with %2B). <br>
-      #  Must be a phone number that you own and have already [purchased](./buy) through
-      #  the API. A phone number can have multiple webhooks attached to it.
-      # @param request [Pinnacle::Types::AttachWebhookByIdParams, Pinnacle::Types::CreateAndAttachWebhookByUrlParams]
-      # @param request_options [Pinnacle::RequestOptions]
-      # @return [Pinnacle::Types::ConfiguredWebhook]
-      # @example
-      #  api = Pinnacle::Client.new(
-      #    base_url: "https://api.example.com",
-      #    environment: Pinnacle::Environment::DEFAULT,
-      #    api_key: "YOUR_API_KEY"
-      #  )
-      #  api.phone_numbers.webhook.attach(phone: "%2B14155551234", request: { webhook_id: "wh_1234567890", event: MESSAGE_STATUS })
-      def attach(phone:, request:, request_options: nil)
-        Async do
-          response = @request_client.conn.post do |req|
-            req.options.timeout = request_options.timeout_in_seconds unless request_options&.timeout_in_seconds.nil?
-            req.headers["PINNACLE-API-KEY"] = request_options.api_key unless request_options&.api_key.nil?
-            req.headers = {
-          **(req.headers || {}),
-          **@request_client.get_headers,
-          **(request_options&.additional_headers || {})
-            }.compact
-            unless request_options.nil? || request_options&.additional_query_parameters.nil?
-              req.params = { **(request_options&.additional_query_parameters || {}) }.compact
-            end
-            req.body = { **(request || {}), **(request_options&.additional_body_parameters || {}) }.compact
-            req.url "#{@request_client.get_url(request_options: request_options)}/phone-numbers/#{phone}/attach-webhook"
-          end
-          Pinnacle::Types::ConfiguredWebhook.from_json(json_object: response.body)
-        end
-      end
-
-      # Disconnect a webhook from your phone number to stop receiving event
-      #  notifications for that specific number. <br>
-      #  The webhook configuration itself remains intact and available for use with other
-      #  phone numbers.
-      #
-      # @param phone [String] The phone number you want to attach the webhook to in E.164 format. Make sure it
-      #  is url encoded (i.e. replace the leading + with %2B). <br>
-      #  Must be a phone number that you own and currently has the specified webhook
-      #  attached.
-      # @param webhook_id [String] The unique identifier of the webhook you want to detach from the phone number.
-      #  <br>
-      #  This must be a valid webhook ID that is currently attached to the specified
-      #  phone number. This identifier is a string that always begins with the prefix
-      #  `wh_`, for example: `wh_1234567890`.
-      # @param request_options [Pinnacle::RequestOptions]
-      # @return [Pinnacle::Types::DetachedWebhookInfo]
-      # @example
-      #  api = Pinnacle::Client.new(
-      #    base_url: "https://api.example.com",
-      #    environment: Pinnacle::Environment::DEFAULT,
-      #    api_key: "YOUR_API_KEY"
-      #  )
-      #  api.phone_numbers.webhook.detach(phone: "+14155551234", webhook_id: "wh_1234567890")
-      def detach(phone:, webhook_id:, request_options: nil)
-        Async do
-          response = @request_client.conn.delete do |req|
-            req.options.timeout = request_options.timeout_in_seconds unless request_options&.timeout_in_seconds.nil?
-            req.headers["PINNACLE-API-KEY"] = request_options.api_key unless request_options&.api_key.nil?
-            req.headers = {
-          **(req.headers || {}),
-          **@request_client.get_headers,
-          **(request_options&.additional_headers || {})
-            }.compact
-            unless request_options.nil? || request_options&.additional_query_parameters.nil?
-              req.params = { **(request_options&.additional_query_parameters || {}) }.compact
-            end
-            unless request_options.nil? || request_options&.additional_body_parameters.nil?
-              req.body = { **(request_options&.additional_body_parameters || {}) }.compact
-            end
-            req.url "#{@request_client.get_url(request_options: request_options)}/phone-numbers/#{phone}/detach-webhook/#{webhook_id}"
-          end
-          Pinnacle::Types::DetachedWebhookInfo.from_json(json_object: response.body)
-        end
-      end
-    end
-  end
-end