rcs 1.0.14 → 1.0.15

data/lib/rcs/types/messaging.rb

@@ -0,0 +1,95 @@
+# frozen_string_literal: true
+
+require "ostruct"
+require "json"
+
+module Pinnacle
+  class Messaging
+    # @return [String] Explain how users will opt in to receive messages.
+    attr_reader :opt_in
+    # @return [String] Explain how users will opt out of receiving messages.
+    attr_reader :opt_out
+    # @return [Array<String>] Please provide the unique keywords to opt out. Each keyword should not contain
+    #  spaces.
+    attr_reader :opt_out_keywords
+    # @return [String] Please define what your agent will do.
+    attr_reader :agent_use_case
+    # @return [String] Please provide some example messages that your agent will send.
+    attr_reader :expected_agent_responses
+    # @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 opt_in [String] Explain how users will opt in to receive messages.
+    # @param opt_out [String] Explain how users will opt out of receiving messages.
+    # @param opt_out_keywords [Array<String>] Please provide the unique keywords to opt out. Each keyword should not contain
+    #  spaces.
+    # @param agent_use_case [String] Please define what your agent will do.
+    # @param expected_agent_responses [String] Please provide some example messages that your agent will send.
+    # @param additional_properties [OpenStruct] Additional properties unmapped to the current class definition
+    # @return [Pinnacle::Messaging]
+    def initialize(opt_in:, opt_out:, opt_out_keywords:, agent_use_case:, expected_agent_responses:,
+                   additional_properties: nil)
+      @opt_in = opt_in
+      @opt_out = opt_out
+      @opt_out_keywords = opt_out_keywords
+      @agent_use_case = agent_use_case
+      @expected_agent_responses = expected_agent_responses
+      @additional_properties = additional_properties
+      @_field_set = {
+        "optIn": opt_in,
+        "optOut": opt_out,
+        "optOutKeywords": opt_out_keywords,
+        "agentUseCase": agent_use_case,
+        "expectedAgentResponses": expected_agent_responses
+      }
+    end
+
+    # Deserialize a JSON object to an instance of Messaging
+    #
+    # @param json_object [String]
+    # @return [Pinnacle::Messaging]
+    def self.from_json(json_object:)
+      struct = JSON.parse(json_object, object_class: OpenStruct)
+      parsed_json = JSON.parse(json_object)
+      opt_in = parsed_json["optIn"]
+      opt_out = parsed_json["optOut"]
+      opt_out_keywords = parsed_json["optOutKeywords"]
+      agent_use_case = parsed_json["agentUseCase"]
+      expected_agent_responses = parsed_json["expectedAgentResponses"]
+      new(
+        opt_in: opt_in,
+        opt_out: opt_out,
+        opt_out_keywords: opt_out_keywords,
+        agent_use_case: agent_use_case,
+        expected_agent_responses: expected_agent_responses,
+        additional_properties: struct
+      )
+    end
+
+    # Serialize an instance of Messaging 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.opt_in.is_a?(String) != false || raise("Passed value for field obj.opt_in is not the expected type, validation failed.")
+      obj.opt_out.is_a?(String) != false || raise("Passed value for field obj.opt_out is not the expected type, validation failed.")
+      obj.opt_out_keywords.is_a?(Array) != false || raise("Passed value for field obj.opt_out_keywords is not the expected type, validation failed.")
+      obj.agent_use_case.is_a?(String) != false || raise("Passed value for field obj.agent_use_case is not the expected type, validation failed.")
+      obj.expected_agent_responses.is_a?(String) != false || raise("Passed value for field obj.expected_agent_responses is not the expected type, validation failed.")
+    end
+  end
+end

data/lib/rcs/types/sender_metadata.rb

@@ -0,0 +1,74 @@
+# frozen_string_literal: true
+
+require "ostruct"
+require "json"
+
+module Pinnacle
+  class SenderMetadata
+    # @return [String]
+    attr_reader :city
+    # @return [String]
+    attr_reader :state
+    # @return [String]
+    attr_reader :country
+    # @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]
+    # @param state [String]
+    # @param country [String]
+    # @param additional_properties [OpenStruct] Additional properties unmapped to the current class definition
+    # @return [Pinnacle::SenderMetadata]
+    def initialize(city: OMIT, state: OMIT, country: OMIT, additional_properties: nil)
+      @city = city if city != OMIT
+      @state = state if state != OMIT
+      @country = country if country != OMIT
+      @additional_properties = additional_properties
+      @_field_set = { "city": city, "state": state, "country": country }.reject do |_k, v|
+        v == OMIT
+      end
+    end
+
+    # Deserialize a JSON object to an instance of SenderMetadata
+    #
+    # @param json_object [String]
+    # @return [Pinnacle::SenderMetadata]
+    def self.from_json(json_object:)
+      struct = JSON.parse(json_object, object_class: OpenStruct)
+      parsed_json = JSON.parse(json_object)
+      city = parsed_json["city"]
+      state = parsed_json["state"]
+      country = parsed_json["country"]
+      new(
+        city: city,
+        state: state,
+        country: country,
+        additional_properties: struct
+      )
+    end
+
+    # Serialize an instance of SenderMetadata 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.state&.is_a?(String) != false || raise("Passed value for field obj.state is not the expected type, validation failed.")
+      obj.country&.is_a?(String) != false || raise("Passed value for field obj.country is not the expected type, validation failed.")
+    end
+  end
+end

data/lib/requests.rb

@@ -43,7 +43,7 @@ module Pinnacle
 
     # @return [Hash{String => String}]
     def get_headers
-      headers = { "X-Fern-Language": "Ruby", "X-Fern-SDK-Name": "rcs", "X-Fern-SDK-Version": "1.0.14" }
+      headers = { "X-Fern-Language": "Ruby", "X-Fern-SDK-Name": "rcs", "X-Fern-SDK-Version": "1.0.15" }
       headers["PINNACLE-API-Key"] = ((@api_key.is_a? Method) ? @api_key.call : @api_key) unless @api_key.nil?
       headers
     end
@@ -87,7 +87,7 @@ module Pinnacle
 
     # @return [Hash{String => String}]
     def get_headers
-      headers = { "X-Fern-Language": "Ruby", "X-Fern-SDK-Name": "rcs", "X-Fern-SDK-Version": "1.0.14" }
+      headers = { "X-Fern-Language": "Ruby", "X-Fern-SDK-Name": "rcs", "X-Fern-SDK-Version": "1.0.15" }
       headers["PINNACLE-API-Key"] = ((@api_key.is_a? Method) ? @api_key.call : @api_key) unless @api_key.nil?
       headers
     end

data/lib/types_export.rb

@@ -18,9 +18,11 @@ 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_category"
 require_relative "rcs/types/company_details"
 require_relative "rcs/types/company_contact"
 require_relative "rcs/types/point_of_contact"
+require_relative "rcs/types/messaging"
 require_relative "rcs/types/additional_website"
 require_relative "rcs/types/additional_phone_number"
 require_relative "rcs/types/additional_email"
@@ -29,3 +31,14 @@ require_relative "rcs/types/card"
 require_relative "rcs/types/action_type"
 require_relative "rcs/types/action_lat_long"
 require_relative "rcs/types/action"
+require_relative "rcs/types/inbound_message_message_type"
+require_relative "rcs/types/inbound_message_metadata"
+require_relative "rcs/types/inbound_message"
+require_relative "rcs/types/sender_metadata"
+require_relative "rcs/types/message_metadata"
+require_relative "rcs/types/inbound_text_message"
+require_relative "rcs/types/media_payload"
+require_relative "rcs/types/inbound_media_message"
+require_relative "rcs/types/inbound_action_message"
+require_relative "rcs/types/inbound_location_message_coordinates"
+require_relative "rcs/types/inbound_location_message"

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: rcs
 version: !ruby/object:Gem::Version
-  version: 1.0.14
+  version: 1.0.15
 platform: ruby
 authors:
 - ''
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2024-11-08 00:00:00.000000000 Z
+date: 2024-11-29 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: async-http-faraday
@@ -121,14 +121,27 @@ files:
 - 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_category.rb
 - lib/rcs/types/company_contact.rb
 - lib/rcs/types/company_details.rb
 - lib/rcs/types/forbidden_error_body.rb
+- lib/rcs/types/inbound_action_message.rb
+- lib/rcs/types/inbound_location_message.rb
+- lib/rcs/types/inbound_location_message_coordinates.rb
+- lib/rcs/types/inbound_media_message.rb
+- lib/rcs/types/inbound_message.rb
+- lib/rcs/types/inbound_message_message_type.rb
+- lib/rcs/types/inbound_message_metadata.rb
+- lib/rcs/types/inbound_text_message.rb
 - lib/rcs/types/internal_server_error_body.rb
+- lib/rcs/types/media_payload.rb
+- lib/rcs/types/message_metadata.rb
+- lib/rcs/types/messaging.rb
 - lib/rcs/types/optionals.rb
 - lib/rcs/types/payment_required_error_body.rb
 - lib/rcs/types/point_of_contact.rb
 - lib/rcs/types/rcs_functionalities.rb
+- lib/rcs/types/sender_metadata.rb
 - lib/rcs/types/unauthorized_error_body.rb
 - lib/requests.rb
 - lib/types_export.rb