rcs 1.0.10

data/lib/rcs.rb

@@ -0,0 +1,126 @@
+# frozen_string_literal: true
+
+require_relative "environment"
+require_relative "types_export"
+require_relative "requests"
+require_relative "rcs/company/client"
+require_relative "rcs/send/client"
+require_relative "rcs/types/rcs_functionalities"
+
+module Pinnacle
+  class Client
+    # @return [Pinnacle::CompanyClient]
+    attr_reader :company
+    # @return [Pinnacle::SendClient]
+    attr_reader :send
+
+    # @param base_url [String]
+    # @param environment [Pinnacle::Environment]
+    # @param max_retries [Long] The number of times to retry a failed request, defaults to 2.
+    # @param timeout_in_seconds [Long]
+    # @param api_key [String]
+    # @return [Pinnacle::Client]
+    def initialize(api_key:, base_url: nil, environment: Pinnacle::Environment::DEFAULT, max_retries: nil,
+                   timeout_in_seconds: nil)
+      @request_client = Pinnacle::RequestClient.new(
+        base_url: base_url,
+        environment: environment,
+        max_retries: max_retries,
+        timeout_in_seconds: timeout_in_seconds,
+        api_key: api_key
+      )
+      @company = Pinnacle::CompanyClient.new(request_client: @request_client)
+      @send = Pinnacle::SendClient.new(request_client: @request_client)
+    end
+
+    # Retrieve the RCS functionality of a phone number. For example checks if a phone
+    #  number can receive RCS message and if it can receive RCS carousels.
+    #
+    # @param phone_number [String] The phone number to check for RCS functionality. Should be in E.164 format (i.e.
+    #  +12345678901).
+    # @param request_options [Pinnacle::RequestOptions]
+    # @return [Pinnacle::RcsFunctionalities]
+    # @example
+    #  api = Pinnacle::Client.new(
+    #    base_url: "https://api.example.com",
+    #    environment: Pinnacle::Environment::DEFAULT,
+    #    api_key: "YOUR_API_KEY"
+    #  )
+    #  api.get_rcs_functionality
+    def get_rcs_functionality(phone_number: nil, request_options: nil)
+      response = @request_client.conn.get 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
+        req.params = { **(request_options&.additional_query_parameters || {}), "phoneNumber": phone_number }.compact
+        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)}/rcs_functionality"
+      end
+      Pinnacle::RcsFunctionalities.from_json(json_object: response.body)
+    end
+  end
+
+  class AsyncClient
+    # @return [Pinnacle::AsyncCompanyClient]
+    attr_reader :company
+    # @return [Pinnacle::AsyncSendClient]
+    attr_reader :send
+
+    # @param base_url [String]
+    # @param environment [Pinnacle::Environment]
+    # @param max_retries [Long] The number of times to retry a failed request, defaults to 2.
+    # @param timeout_in_seconds [Long]
+    # @param api_key [String]
+    # @return [Pinnacle::AsyncClient]
+    def initialize(api_key:, base_url: nil, environment: Pinnacle::Environment::DEFAULT, max_retries: nil,
+                   timeout_in_seconds: nil)
+      @async_request_client = Pinnacle::AsyncRequestClient.new(
+        base_url: base_url,
+        environment: environment,
+        max_retries: max_retries,
+        timeout_in_seconds: timeout_in_seconds,
+        api_key: api_key
+      )
+      @company = Pinnacle::AsyncCompanyClient.new(request_client: @async_request_client)
+      @send = Pinnacle::AsyncSendClient.new(request_client: @async_request_client)
+    end
+
+    # Retrieve the RCS functionality of a phone number. For example checks if a phone
+    #  number can receive RCS message and if it can receive RCS carousels.
+    #
+    # @param phone_number [String] The phone number to check for RCS functionality. Should be in E.164 format (i.e.
+    #  +12345678901).
+    # @param request_options [Pinnacle::RequestOptions]
+    # @return [Pinnacle::RcsFunctionalities]
+    # @example
+    #  api = Pinnacle::Client.new(
+    #    base_url: "https://api.example.com",
+    #    environment: Pinnacle::Environment::DEFAULT,
+    #    api_key: "YOUR_API_KEY"
+    #  )
+    #  api.get_rcs_functionality
+    def get_rcs_functionality(phone_number: nil, request_options: nil)
+      response = @async_request_client.conn.get 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 || {}),
+      **@async_request_client.get_headers,
+      **(request_options&.additional_headers || {})
+        }.compact
+        req.params = { **(request_options&.additional_query_parameters || {}), "phoneNumber": phone_number }.compact
+        unless request_options.nil? || request_options&.additional_body_parameters.nil?
+          req.body = { **(request_options&.additional_body_parameters || {}) }.compact
+        end
+        req.url "#{@async_request_client.get_url(request_options: request_options)}/rcs_functionality"
+      end
+      Pinnacle::RcsFunctionalities.from_json(json_object: response.body)
+    end
+  end
+end

data/lib/requests.rb

@@ -0,0 +1,163 @@
+# frozen_string_literal: true
+
+require_relative "environment"
+require "faraday"
+require "faraday/retry"
+require "async/http/faraday"
+
+module Pinnacle
+  class RequestClient
+    # @return [Faraday]
+    attr_reader :conn
+    # @return [String]
+    attr_reader :base_url
+    # @return [String]
+    attr_reader :api_key
+    # @return [String]
+    attr_reader :default_environment
+
+    # @param base_url [String]
+    # @param environment [Pinnacle::Environment]
+    # @param max_retries [Long] The number of times to retry a failed request, defaults to 2.
+    # @param timeout_in_seconds [Long]
+    # @param api_key [String]
+    # @return [Pinnacle::RequestClient]
+    def initialize(api_key:, base_url: nil, environment: Pinnacle::Environment::DEFAULT, max_retries: nil,
+                   timeout_in_seconds: nil)
+      @default_environment = environment
+      @base_url = environment || base_url
+      @api_key = api_key
+      @conn = Faraday.new do |faraday|
+        faraday.request :json
+        faraday.response :raise_error, include_request: true
+        faraday.request :retry, { max: max_retries } unless max_retries.nil?
+        faraday.options.timeout = timeout_in_seconds unless timeout_in_seconds.nil?
+      end
+    end
+
+    # @param request_options [Pinnacle::RequestOptions]
+    # @return [String]
+    def get_url(request_options: nil)
+      request_options&.base_url || @default_environment || @base_url
+    end
+
+    # @return [Hash{String => String}]
+    def get_headers
+      headers = { "X-Fern-Language": "Ruby", "X-Fern-SDK-Name": "rcs", "X-Fern-SDK-Version": "1.0.10" }
+      headers["PINNACLE-API-Key"] = ((@api_key.is_a? Method) ? @api_key.call : @api_key) unless @api_key.nil?
+      headers
+    end
+  end
+
+  class AsyncRequestClient
+    # @return [Faraday]
+    attr_reader :conn
+    # @return [String]
+    attr_reader :base_url
+    # @return [String]
+    attr_reader :api_key
+    # @return [String]
+    attr_reader :default_environment
+
+    # @param base_url [String]
+    # @param environment [Pinnacle::Environment]
+    # @param max_retries [Long] The number of times to retry a failed request, defaults to 2.
+    # @param timeout_in_seconds [Long]
+    # @param api_key [String]
+    # @return [Pinnacle::AsyncRequestClient]
+    def initialize(api_key:, base_url: nil, environment: Pinnacle::Environment::DEFAULT, max_retries: nil,
+                   timeout_in_seconds: nil)
+      @default_environment = environment
+      @base_url = environment || base_url
+      @api_key = api_key
+      @conn = Faraday.new do |faraday|
+        faraday.request :json
+        faraday.response :raise_error, include_request: true
+        faraday.adapter :async_http
+        faraday.request :retry, { max: max_retries } unless max_retries.nil?
+        faraday.options.timeout = timeout_in_seconds unless timeout_in_seconds.nil?
+      end
+    end
+
+    # @param request_options [Pinnacle::RequestOptions]
+    # @return [String]
+    def get_url(request_options: nil)
+      request_options&.base_url || @default_environment || @base_url
+    end
+
+    # @return [Hash{String => String}]
+    def get_headers
+      headers = { "X-Fern-Language": "Ruby", "X-Fern-SDK-Name": "rcs", "X-Fern-SDK-Version": "1.0.10" }
+      headers["PINNACLE-API-Key"] = ((@api_key.is_a? Method) ? @api_key.call : @api_key) unless @api_key.nil?
+      headers
+    end
+  end
+
+  # Additional options for request-specific configuration when calling APIs via the
+  #  SDK.
+  class RequestOptions
+    # @return [String]
+    attr_reader :base_url
+    # @return [String]
+    attr_reader :api_key
+    # @return [Hash{String => Object}]
+    attr_reader :additional_headers
+    # @return [Hash{String => Object}]
+    attr_reader :additional_query_parameters
+    # @return [Hash{String => Object}]
+    attr_reader :additional_body_parameters
+    # @return [Long]
+    attr_reader :timeout_in_seconds
+
+    # @param base_url [String]
+    # @param api_key [String]
+    # @param additional_headers [Hash{String => Object}]
+    # @param additional_query_parameters [Hash{String => Object}]
+    # @param additional_body_parameters [Hash{String => Object}]
+    # @param timeout_in_seconds [Long]
+    # @return [Pinnacle::RequestOptions]
+    def initialize(base_url: nil, api_key: nil, additional_headers: nil, additional_query_parameters: nil,
+                   additional_body_parameters: nil, timeout_in_seconds: nil)
+      @base_url = base_url
+      @api_key = api_key
+      @additional_headers = additional_headers
+      @additional_query_parameters = additional_query_parameters
+      @additional_body_parameters = additional_body_parameters
+      @timeout_in_seconds = timeout_in_seconds
+    end
+  end
+
+  # Additional options for request-specific configuration when calling APIs via the
+  #  SDK.
+  class IdempotencyRequestOptions
+    # @return [String]
+    attr_reader :base_url
+    # @return [String]
+    attr_reader :api_key
+    # @return [Hash{String => Object}]
+    attr_reader :additional_headers
+    # @return [Hash{String => Object}]
+    attr_reader :additional_query_parameters
+    # @return [Hash{String => Object}]
+    attr_reader :additional_body_parameters
+    # @return [Long]
+    attr_reader :timeout_in_seconds
+
+    # @param base_url [String]
+    # @param api_key [String]
+    # @param additional_headers [Hash{String => Object}]
+    # @param additional_query_parameters [Hash{String => Object}]
+    # @param additional_body_parameters [Hash{String => Object}]
+    # @param timeout_in_seconds [Long]
+    # @return [Pinnacle::IdempotencyRequestOptions]
+    def initialize(base_url: nil, api_key: nil, additional_headers: nil, additional_query_parameters: nil,
+                   additional_body_parameters: nil, timeout_in_seconds: nil)
+      @base_url = base_url
+      @api_key = api_key
+      @additional_headers = additional_headers
+      @additional_query_parameters = additional_query_parameters
+      @additional_body_parameters = additional_body_parameters
+      @timeout_in_seconds = timeout_in_seconds
+    end
+  end
+end

data/lib/types_export.rb

@@ -0,0 +1,29 @@
+# frozen_string_literal: true
+
+require_relative "rcs/company/types/company_register_response_brand"
+require_relative "rcs/company/types/company_register_response"
+require_relative "rcs/company/types/company_update_response_brand"
+require_relative "rcs/company/types/company_update_response"
+require_relative "rcs/send/types/send_rcs_response"
+require_relative "rcs/send/types/send_sms_response"
+require_relative "rcs/send/types/send_mms_response"
+require_relative "rcs/types/bad_request_error_body"
+require_relative "rcs/types/unauthorized_error_body"
+require_relative "rcs/types/internal_server_error_body"
+require_relative "rcs/types/forbidden_error_body"
+require_relative "rcs/types/rcs_functionalities"
+require_relative "rcs/types/company_additional_websites_item"
+require_relative "rcs/types/company_additional_emails_item"
+require_relative "rcs/types/company_additional_phone_numbers_item"
+require_relative "rcs/types/company"
+require_relative "rcs/types/company_details"
+require_relative "rcs/types/company_contact"
+require_relative "rcs/types/point_of_contact"
+require_relative "rcs/types/additional_website"
+require_relative "rcs/types/additional_phone_number"
+require_relative "rcs/types/additional_email"
+require_relative "rcs/types/optionals"
+require_relative "rcs/types/card"
+require_relative "rcs/types/action_type"
+require_relative "rcs/types/action_lat_long"
+require_relative "rcs/types/action"

metadata

@@ -0,0 +1,158 @@
+--- !ruby/object:Gem::Specification
+name: rcs
+version: !ruby/object:Gem::Version
+  version: 1.0.10
+platform: ruby
+authors:
+- ''
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2024-10-14 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: async-http-faraday
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0.0'
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '1.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0.0'
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '1.0'
+- !ruby/object:Gem::Dependency
+  name: faraday
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '1.10'
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '1.10'
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+- !ruby/object:Gem::Dependency
+  name: faraday-net_http
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '1.0'
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '4.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '1.0'
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '4.0'
+- !ruby/object:Gem::Dependency
+  name: faraday-retry
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '1.0'
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '1.0'
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+description: ''
+email: ''
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- lib/environment.rb
+- lib/gemconfig.rb
+- lib/rcs.rb
+- lib/rcs/company/client.rb
+- lib/rcs/company/types/company_register_response.rb
+- lib/rcs/company/types/company_register_response_brand.rb
+- lib/rcs/company/types/company_update_response.rb
+- lib/rcs/company/types/company_update_response_brand.rb
+- lib/rcs/send/client.rb
+- lib/rcs/send/types/send_mms_response.rb
+- lib/rcs/send/types/send_rcs_response.rb
+- lib/rcs/send/types/send_sms_response.rb
+- lib/rcs/types/action.rb
+- lib/rcs/types/action_lat_long.rb
+- lib/rcs/types/action_type.rb
+- lib/rcs/types/additional_email.rb
+- lib/rcs/types/additional_phone_number.rb
+- lib/rcs/types/additional_website.rb
+- lib/rcs/types/bad_request_error_body.rb
+- lib/rcs/types/card.rb
+- lib/rcs/types/company.rb
+- lib/rcs/types/company_additional_emails_item.rb
+- lib/rcs/types/company_additional_phone_numbers_item.rb
+- lib/rcs/types/company_additional_websites_item.rb
+- lib/rcs/types/company_contact.rb
+- lib/rcs/types/company_details.rb
+- lib/rcs/types/forbidden_error_body.rb
+- lib/rcs/types/internal_server_error_body.rb
+- lib/rcs/types/optionals.rb
+- lib/rcs/types/point_of_contact.rb
+- lib/rcs/types/rcs_functionalities.rb
+- lib/rcs/types/unauthorized_error_body.rb
+- lib/requests.rb
+- lib/types_export.rb
+homepage: https://github.com/pinnacle-dev/rcs-ruby
+licenses: []
+metadata:
+  homepage_uri: https://github.com/pinnacle-dev/rcs-ruby
+  source_code_uri: https://github.com/pinnacle-dev/rcs-ruby
+  changelog_uri: https://github.com/pinnacle-dev/rcs-ruby/blob/master/CHANGELOG.md
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 2.7.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.1.6
+signing_key: 
+specification_version: 4
+summary: ''
+test_files: []