rcs 1.0.14 → 1.0.15

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 7c64d425bcacc2baf86894e594e3e03d7227f5c7221ad06c944a90138011d5fe
-  data.tar.gz: c3f8a91fdfacd860df015784ec8d51af1c91c0913f68cffc12a9f064614215bf
+  metadata.gz: cd6b24540486cc673f369e84cd9c3a56d58837b4143a11f79b0b8ad8d7056ee4
+  data.tar.gz: 708a541bf38d32fde5b6ef6d6338d9e3494f681f60d5811dbbc384e0bb58cf02
 SHA512:
-  metadata.gz: 50f8276cace3809d5a71d693115c584a68261e36970e46365124d6690d6aecdcbfff0cf67ecf661da9f3d82fc8ade6237e3b173bcf85a367453ed30167f75287
-  data.tar.gz: e9f306e9917eaa8afd72388d7a0a46e83eced1d1e7da446a20ea9c4289c25a1e5fd1a2e78cb829b96a7ccdc77ad028f5a676201470b804960ea7d6c4a7508200
+  metadata.gz: b4fc78e103e1274d2ceac57826ce3bd7772901e5222fe486d2e133e3b2bd3570e26506db5438e699986b0a1bbdd9c0ae843e1e5fb8eef5f997e8df22886a2b8f
+  data.tar.gz: cf3dfa9bc7e5ad188baefef9983d6f1ac5230eafa3d08c9a9006581feb5f774bfd6213acdf0191f80f7985385fab06e2dccd6f8b00c684f637079052d2bd57c1

data/lib/rcs/company/client.rb

@@ -5,6 +5,7 @@ require_relative "../types/company"
 require "json"
 require_relative "../types/company_details"
 require_relative "../types/company_contact"
+require_relative "../types/messaging"
 require_relative "../types/point_of_contact"
 require_relative "../types/optionals"
 require_relative "types/company_register_response"
@@ -66,6 +67,7 @@ module Pinnacle
     #
     # @param company [Hash] Request of type Pinnacle::CompanyDetails, as a Hash
     #   * :name (String)
+    #   * :category (Pinnacle::CompanyCategory)
     #   * :address (String)
     #   * :ein (String)
     #   * :description (String)
@@ -81,6 +83,12 @@ module Pinnacle
     #   * :primary_email_label (String)
     #   * :privacy_policy_url (String)
     #   * :tos_url (String)
+    # @param messaging [Hash] Request of type Pinnacle::Messaging, as a Hash
+    #   * :opt_in (String)
+    #   * :opt_out (String)
+    #   * :opt_out_keywords (Array<String>)
+    #   * :agent_use_case (String)
+    #   * :expected_agent_responses (String)
     # @param point_of_contact [Hash] Request of type Pinnacle::PointOfContact, as a Hash
     #   * :poc_name (String)
     #   * :poc_title (String)
@@ -99,11 +107,17 @@ module Pinnacle
     #    api_key: "YOUR_API_KEY"
     #  )
     #  api.company.register(
-    #    company: { name: "name", address: "address", ein: "ein", description: "description", brand_color: "brandColor", logo_url: "logoUrl", hero_url: "heroUrl" },
+    #    company: { name: "name", category: ENTERTAINMENT, address: "address", ein: "ein", description: "description", brand_color: "brandColor", logo_url: "logoUrl", hero_url: "heroUrl" },
     #    company_contact: { primary_website_url: "primaryWebsiteUrl", primary_website_label: "primaryWebsiteLabel", primary_phone: "primaryPhone", primary_phone_label: "primaryPhoneLabel", primary_email: "primaryEmail", primary_email_label: "primaryEmailLabel", privacy_policy_url: "privacyPolicyUrl", tos_url: "tosUrl" },
+    #    messaging: { opt_in: "By opting in, you agree to receive messages from Pinnacle, including updates and promotions. Reply “STOP” to unsubscribe. Standard message and data rates may apply.", opt_out: "Reply with keywords like STOP or UNSUBSCRIBE to opt-out. A confirmation message will be sent, and no further messages will be received unless you re-subscribe.", opt_out_keywords: ["STOP", "UNSUBSCRIBE"], agent_use_case: "Pinnacle’s agent assists with product updates, promotions, order tracking, and support. It answers FAQs, provides order updates, and helps with opt-in/out processes. Escalates to live support when needed.", expected_agent_responses: "General Inquiry: “How can I assist you today?”
+    #  Order Status: “Provide your order number.”
+    #  Opt-In: “You’re now subscribed!”
+    #  Opt-Out: “You have unsubscribed.”
+    #  Escalation: “Connecting to a live agent.”
+    #  " },
     #    point_of_contact: { poc_name: "pocName", poc_title: "pocTitle", poc_email: "pocEmail" }
     #  )
-    def register(company:, company_contact:, point_of_contact:, optionals: nil, request_options: nil)
+    def register(company:, company_contact:, messaging:, point_of_contact:, optionals: nil, 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?
@@ -119,6 +133,7 @@ module Pinnacle
           **(request_options&.additional_body_parameters || {}),
           company: company,
           companyContact: company_contact,
+          messaging: messaging,
           pointOfContact: point_of_contact,
           optionals: optionals
         }.compact
@@ -134,6 +149,7 @@ module Pinnacle
     #   * :id (Integer)
     #   * :created_at (DateTime)
     #   * :name (String)
+    #   * :category (Pinnacle::CompanyCategory)
     #   * :address (String)
     #   * :ein (String)
     #   * :description (String)
@@ -151,6 +167,11 @@ module Pinnacle
     #   * :poc_name (String)
     #   * :poc_title (String)
     #   * :poc_email (String)
+    #   * :opt_in (String)
+    #   * :opt_out (String)
+    #   * :opt_out_keywords (Array<String>)
+    #   * :agent_use_case (String)
+    #   * :expected_agent_responses (String)
     #   * :test_numbers (Array<String>)
     #   * :status (String)
     #   * :additional_websites (Array<Pinnacle::CompanyAdditionalWebsitesItem>)
@@ -165,6 +186,12 @@ module Pinnacle
     #   * :primary_email_label (String)
     #   * :privacy_policy_url (String)
     #   * :tos_url (String)
+    # @param messaging [Hash] Request of type Pinnacle::Messaging, as a Hash
+    #   * :opt_in (String)
+    #   * :opt_out (String)
+    #   * :opt_out_keywords (Array<String>)
+    #   * :agent_use_case (String)
+    #   * :expected_agent_responses (String)
     # @param point_of_contact [Hash] Request of type Pinnacle::PointOfContact, as a Hash
     #   * :poc_name (String)
     #   * :poc_title (String)
@@ -183,7 +210,7 @@ module Pinnacle
     #    api_key: "YOUR_API_KEY"
     #  )
     #  api.company.update(company_id: "companyId")
-    def update(company_id:, company: nil, company_contact: nil, point_of_contact: nil, optionals: nil,
+    def update(company_id:, company: nil, company_contact: nil, messaging: nil, point_of_contact: nil, optionals: nil,
                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?
@@ -201,6 +228,7 @@ module Pinnacle
           companyId: company_id,
           company: company,
           companyContact: company_contact,
+          messaging: messaging,
           pointOfContact: point_of_contact,
           optionals: optionals
         }.compact
@@ -266,6 +294,7 @@ module Pinnacle
     #
     # @param company [Hash] Request of type Pinnacle::CompanyDetails, as a Hash
     #   * :name (String)
+    #   * :category (Pinnacle::CompanyCategory)
     #   * :address (String)
     #   * :ein (String)
     #   * :description (String)
@@ -281,6 +310,12 @@ module Pinnacle
     #   * :primary_email_label (String)
     #   * :privacy_policy_url (String)
     #   * :tos_url (String)
+    # @param messaging [Hash] Request of type Pinnacle::Messaging, as a Hash
+    #   * :opt_in (String)
+    #   * :opt_out (String)
+    #   * :opt_out_keywords (Array<String>)
+    #   * :agent_use_case (String)
+    #   * :expected_agent_responses (String)
     # @param point_of_contact [Hash] Request of type Pinnacle::PointOfContact, as a Hash
     #   * :poc_name (String)
     #   * :poc_title (String)
@@ -299,11 +334,17 @@ module Pinnacle
     #    api_key: "YOUR_API_KEY"
     #  )
     #  api.company.register(
-    #    company: { name: "name", address: "address", ein: "ein", description: "description", brand_color: "brandColor", logo_url: "logoUrl", hero_url: "heroUrl" },
+    #    company: { name: "name", category: ENTERTAINMENT, address: "address", ein: "ein", description: "description", brand_color: "brandColor", logo_url: "logoUrl", hero_url: "heroUrl" },
     #    company_contact: { primary_website_url: "primaryWebsiteUrl", primary_website_label: "primaryWebsiteLabel", primary_phone: "primaryPhone", primary_phone_label: "primaryPhoneLabel", primary_email: "primaryEmail", primary_email_label: "primaryEmailLabel", privacy_policy_url: "privacyPolicyUrl", tos_url: "tosUrl" },
+    #    messaging: { opt_in: "By opting in, you agree to receive messages from Pinnacle, including updates and promotions. Reply “STOP” to unsubscribe. Standard message and data rates may apply.", opt_out: "Reply with keywords like STOP or UNSUBSCRIBE to opt-out. A confirmation message will be sent, and no further messages will be received unless you re-subscribe.", opt_out_keywords: ["STOP", "UNSUBSCRIBE"], agent_use_case: "Pinnacle’s agent assists with product updates, promotions, order tracking, and support. It answers FAQs, provides order updates, and helps with opt-in/out processes. Escalates to live support when needed.", expected_agent_responses: "General Inquiry: “How can I assist you today?”
+    #  Order Status: “Provide your order number.”
+    #  Opt-In: “You’re now subscribed!”
+    #  Opt-Out: “You have unsubscribed.”
+    #  Escalation: “Connecting to a live agent.”
+    #  " },
     #    point_of_contact: { poc_name: "pocName", poc_title: "pocTitle", poc_email: "pocEmail" }
     #  )
-    def register(company:, company_contact:, point_of_contact:, optionals: nil, request_options: nil)
+    def register(company:, company_contact:, messaging:, point_of_contact:, optionals: nil, 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?
@@ -320,6 +361,7 @@ module Pinnacle
             **(request_options&.additional_body_parameters || {}),
             company: company,
             companyContact: company_contact,
+            messaging: messaging,
             pointOfContact: point_of_contact,
             optionals: optionals
           }.compact
@@ -336,6 +378,7 @@ module Pinnacle
     #   * :id (Integer)
     #   * :created_at (DateTime)
     #   * :name (String)
+    #   * :category (Pinnacle::CompanyCategory)
     #   * :address (String)
     #   * :ein (String)
     #   * :description (String)
@@ -353,6 +396,11 @@ module Pinnacle
     #   * :poc_name (String)
     #   * :poc_title (String)
     #   * :poc_email (String)
+    #   * :opt_in (String)
+    #   * :opt_out (String)
+    #   * :opt_out_keywords (Array<String>)
+    #   * :agent_use_case (String)
+    #   * :expected_agent_responses (String)
     #   * :test_numbers (Array<String>)
     #   * :status (String)
     #   * :additional_websites (Array<Pinnacle::CompanyAdditionalWebsitesItem>)
@@ -367,6 +415,12 @@ module Pinnacle
     #   * :primary_email_label (String)
     #   * :privacy_policy_url (String)
     #   * :tos_url (String)
+    # @param messaging [Hash] Request of type Pinnacle::Messaging, as a Hash
+    #   * :opt_in (String)
+    #   * :opt_out (String)
+    #   * :opt_out_keywords (Array<String>)
+    #   * :agent_use_case (String)
+    #   * :expected_agent_responses (String)
     # @param point_of_contact [Hash] Request of type Pinnacle::PointOfContact, as a Hash
     #   * :poc_name (String)
     #   * :poc_title (String)
@@ -385,7 +439,7 @@ module Pinnacle
     #    api_key: "YOUR_API_KEY"
     #  )
     #  api.company.update(company_id: "companyId")
-    def update(company_id:, company: nil, company_contact: nil, point_of_contact: nil, optionals: nil,
+    def update(company_id:, company: nil, company_contact: nil, messaging: nil, point_of_contact: nil, optionals: nil,
                request_options: nil)
       Async do
         response = @request_client.conn.post do |req|
@@ -404,6 +458,7 @@ module Pinnacle
             companyId: company_id,
             company: company,
             companyContact: company_contact,
+            messaging: messaging,
             pointOfContact: point_of_contact,
             optionals: optionals
           }.compact

data/lib/rcs/types/company.rb

@@ -1,6 +1,7 @@
 # frozen_string_literal: true
 
 require "date"
+require_relative "company_category"
 require_relative "company_additional_websites_item"
 require_relative "company_additional_emails_item"
 require_relative "company_additional_phone_numbers_item"
@@ -15,6 +16,8 @@ module Pinnacle
     attr_reader :created_at
     # @return [String] The name of the company
     attr_reader :name
+    # @return [Pinnacle::CompanyCategory] The category of the company
+    attr_reader :category
     # @return [String] The address of the company
     attr_reader :address
     # @return [String] The Employer Identification Number (EIN) of the company
@@ -49,6 +52,17 @@ module Pinnacle
     attr_reader :poc_title
     # @return [String] The email address of the point of contact
     attr_reader :poc_email
+    # @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 [Array<String>] A list of test phone numbers
     attr_reader :test_numbers
     # @return [String] The approval status of the company
@@ -70,6 +84,7 @@ module Pinnacle
     # @param id [Integer] The unique identifier for the company
     # @param created_at [DateTime] The date and time when the company was created
     # @param name [String] The name of the company
+    # @param category [Pinnacle::CompanyCategory] The category of the company
     # @param address [String] The address of the company
     # @param ein [String] The Employer Identification Number (EIN) of the company
     # @param description [String] A description of the company
@@ -87,6 +102,12 @@ module Pinnacle
     # @param poc_name [String] The name of the point of contact
     # @param poc_title [String] The title of the point of contact
     # @param poc_email [String] The email address of the point of contact
+    # @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 test_numbers [Array<String>] A list of test phone numbers
     # @param status [String] The approval status of the company
     # @param additional_websites [Array<Pinnacle::CompanyAdditionalWebsitesItem>] A list of additional websites
@@ -94,11 +115,12 @@ module Pinnacle
     # @param additional_phone_numbers [Array<Pinnacle::CompanyAdditionalPhoneNumbersItem>] A list of additional phone numbers
     # @param additional_properties [OpenStruct] Additional properties unmapped to the current class definition
     # @return [Pinnacle::Company]
-    def initialize(id: OMIT, created_at: OMIT, name: OMIT, address: OMIT, ein: OMIT, description: OMIT,
-                   brand_color: OMIT, logo_url: OMIT, hero_url: OMIT, primary_website_url: OMIT, primary_website_label: OMIT, primary_phone: OMIT, primary_phone_label: OMIT, primary_email: OMIT, primary_email_label: OMIT, privacy_policy_url: OMIT, tos_url: OMIT, poc_name: OMIT, poc_title: OMIT, poc_email: OMIT, test_numbers: OMIT, status: OMIT, additional_websites: OMIT, additional_emails: OMIT, additional_phone_numbers: OMIT, additional_properties: nil)
+    def initialize(id: OMIT, created_at: OMIT, name: OMIT, category: OMIT, address: OMIT, ein: OMIT, description: OMIT,
+                   brand_color: OMIT, logo_url: OMIT, hero_url: OMIT, primary_website_url: OMIT, primary_website_label: OMIT, primary_phone: OMIT, primary_phone_label: OMIT, primary_email: OMIT, primary_email_label: OMIT, privacy_policy_url: OMIT, tos_url: OMIT, poc_name: OMIT, poc_title: OMIT, poc_email: OMIT, opt_in: OMIT, opt_out: OMIT, opt_out_keywords: OMIT, agent_use_case: OMIT, expected_agent_responses: OMIT, test_numbers: OMIT, status: OMIT, additional_websites: OMIT, additional_emails: OMIT, additional_phone_numbers: OMIT, additional_properties: nil)
       @id = id if id != OMIT
       @created_at = created_at if created_at != OMIT
       @name = name if name != OMIT
+      @category = category if category != OMIT
       @address = address if address != OMIT
       @ein = ein if ein != OMIT
       @description = description if description != OMIT
@@ -116,6 +138,11 @@ module Pinnacle
       @poc_name = poc_name if poc_name != OMIT
       @poc_title = poc_title if poc_title != OMIT
       @poc_email = poc_email if poc_email != OMIT
+      @opt_in = opt_in if opt_in != OMIT
+      @opt_out = opt_out if opt_out != OMIT
+      @opt_out_keywords = opt_out_keywords if opt_out_keywords != OMIT
+      @agent_use_case = agent_use_case if agent_use_case != OMIT
+      @expected_agent_responses = expected_agent_responses if expected_agent_responses != OMIT
       @test_numbers = test_numbers if test_numbers != OMIT
       @status = status if status != OMIT
       @additional_websites = additional_websites if additional_websites != OMIT
@@ -126,6 +153,7 @@ module Pinnacle
         "id": id,
         "createdAt": created_at,
         "name": name,
+        "category": category,
         "address": address,
         "ein": ein,
         "description": description,
@@ -143,6 +171,11 @@ module Pinnacle
         "pocName": poc_name,
         "pocTitle": poc_title,
         "pocEmail": poc_email,
+        "optIn": opt_in,
+        "optOut": opt_out,
+        "optOutKeywords": opt_out_keywords,
+        "agentUseCase": agent_use_case,
+        "expectedAgentResponses": expected_agent_responses,
         "testNumbers": test_numbers,
         "status": status,
         "additionalWebsites": additional_websites,
@@ -163,6 +196,7 @@ module Pinnacle
       id = parsed_json["id"]
       created_at = (DateTime.parse(parsed_json["createdAt"]) unless parsed_json["createdAt"].nil?)
       name = parsed_json["name"]
+      category = parsed_json["category"]
       address = parsed_json["address"]
       ein = parsed_json["ein"]
       description = parsed_json["description"]
@@ -180,6 +214,11 @@ module Pinnacle
       poc_name = parsed_json["pocName"]
       poc_title = parsed_json["pocTitle"]
       poc_email = parsed_json["pocEmail"]
+      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"]
       test_numbers = parsed_json["testNumbers"]
       status = parsed_json["status"]
       additional_websites = parsed_json["additionalWebsites"]&.map do |item|
@@ -198,6 +237,7 @@ module Pinnacle
         id: id,
         created_at: created_at,
         name: name,
+        category: category,
         address: address,
         ein: ein,
         description: description,
@@ -215,6 +255,11 @@ module Pinnacle
         poc_name: poc_name,
         poc_title: poc_title,
         poc_email: poc_email,
+        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,
         test_numbers: test_numbers,
         status: status,
         additional_websites: additional_websites,
@@ -241,6 +286,7 @@ module Pinnacle
       obj.id&.is_a?(Integer) != false || raise("Passed value for field obj.id is not the expected type, validation failed.")
       obj.created_at&.is_a?(DateTime) != false || raise("Passed value for field obj.created_at is not the expected type, validation failed.")
       obj.name&.is_a?(String) != false || raise("Passed value for field obj.name is not the expected type, validation failed.")
+      obj.category&.is_a?(Pinnacle::CompanyCategory) != false || raise("Passed value for field obj.category is not the expected type, validation failed.")
       obj.address&.is_a?(String) != false || raise("Passed value for field obj.address is not the expected type, validation failed.")
       obj.ein&.is_a?(String) != false || raise("Passed value for field obj.ein is not the expected type, validation failed.")
       obj.description&.is_a?(String) != false || raise("Passed value for field obj.description is not the expected type, validation failed.")
@@ -258,6 +304,11 @@ module Pinnacle
       obj.poc_name&.is_a?(String) != false || raise("Passed value for field obj.poc_name is not the expected type, validation failed.")
       obj.poc_title&.is_a?(String) != false || raise("Passed value for field obj.poc_title is not the expected type, validation failed.")
       obj.poc_email&.is_a?(String) != false || raise("Passed value for field obj.poc_email is not the expected type, validation failed.")
+      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.")
       obj.test_numbers&.is_a?(Array) != false || raise("Passed value for field obj.test_numbers is not the expected type, validation failed.")
       obj.status&.is_a?(String) != false || raise("Passed value for field obj.status is not the expected type, validation failed.")
       obj.additional_websites&.is_a?(Array) != false || raise("Passed value for field obj.additional_websites is not the expected type, validation failed.")

data/lib/rcs/types/company_category.rb

@@ -0,0 +1,20 @@
+# frozen_string_literal: true
+
+module Pinnacle
+  class CompanyCategory
+    ENTERTAINMENT = "Entertainment"
+    FINANCE = "Finance"
+    FOOD_BEVERAGE = "Food & Beverage"
+    GAMES = "Games"
+    HEALTH = "Health"
+    MISC = "Misc"
+    NEWS = "News"
+    OTHER = "Other"
+    PRODUCTIVITY = "Productivity"
+    SHOPPING_RETAIL = "Shopping & Retail"
+    SOCIAL = "Social"
+    SPORTS = "Sports"
+    TRAVEL = "Travel"
+    UTILITIES = "Utilities"
+  end
+end

data/lib/rcs/types/company_details.rb

@@ -1,5 +1,6 @@
 # frozen_string_literal: true
 
+require_relative "company_category"
 require "ostruct"
 require "json"
 
@@ -7,6 +8,8 @@ module Pinnacle
   class CompanyDetails
     # @return [String] The name of the company.
     attr_reader :name
+    # @return [Pinnacle::CompanyCategory] The category of the company.
+    attr_reader :category
     # @return [String] The address of the company.
     attr_reader :address
     # @return [String] The EIN (Employer Identification Number) of the company.
@@ -29,6 +32,7 @@ module Pinnacle
     OMIT = Object.new
 
     # @param name [String] The name of the company.
+    # @param category [Pinnacle::CompanyCategory] The category of the company.
     # @param address [String] The address of the company.
     # @param ein [String] The EIN (Employer Identification Number) of the company.
     # @param description [String] A description of the company.
@@ -38,8 +42,10 @@ module Pinnacle
     # @param hero_url [String] URL of the company's hero image.
     # @param additional_properties [OpenStruct] Additional properties unmapped to the current class definition
     # @return [Pinnacle::CompanyDetails]
-    def initialize(name:, address:, ein:, description:, brand_color:, logo_url:, hero_url:, additional_properties: nil)
+    def initialize(name:, category:, address:, ein:, description:, brand_color:, logo_url:, hero_url:,
+                   additional_properties: nil)
       @name = name
+      @category = category
       @address = address
       @ein = ein
       @description = description
@@ -49,6 +55,7 @@ module Pinnacle
       @additional_properties = additional_properties
       @_field_set = {
         "name": name,
+        "category": category,
         "address": address,
         "ein": ein,
         "description": description,
@@ -66,6 +73,7 @@ module Pinnacle
       struct = JSON.parse(json_object, object_class: OpenStruct)
       parsed_json = JSON.parse(json_object)
       name = parsed_json["name"]
+      category = parsed_json["category"]
       address = parsed_json["address"]
       ein = parsed_json["ein"]
       description = parsed_json["description"]
@@ -74,6 +82,7 @@ module Pinnacle
       hero_url = parsed_json["heroUrl"]
       new(
         name: name,
+        category: category,
         address: address,
         ein: ein,
         description: description,
@@ -99,6 +108,7 @@ module Pinnacle
     # @return [Void]
     def self.validate_raw(obj:)
       obj.name.is_a?(String) != false || raise("Passed value for field obj.name is not the expected type, validation failed.")
+      obj.category.is_a?(Pinnacle::CompanyCategory) != false || raise("Passed value for field obj.category is not the expected type, validation failed.")
       obj.address.is_a?(String) != false || raise("Passed value for field obj.address is not the expected type, validation failed.")
       obj.ein.is_a?(String) != false || raise("Passed value for field obj.ein is not the expected type, validation failed.")
       obj.description.is_a?(String) != false || raise("Passed value for field obj.description is not the expected type, validation failed.")

data/lib/rcs/types/inbound_action_message.rb

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