rcs 1.0.10

data/lib/rcs/types/company_details.rb

@@ -0,0 +1,110 @@
+# frozen_string_literal: true
+
+require "ostruct"
+require "json"
+
+module Pinnacle
+  class CompanyDetails
+    # @return [String] The name of the company.
+    attr_reader :name
+    # @return [String] The address of the company.
+    attr_reader :address
+    # @return [String] The EIN (Employer Identification Number) of the company.
+    attr_reader :ein
+    # @return [String] A description of the company.
+    attr_reader :description
+    # @return [String] The brand color in hex format, must pass a contrast ratio of at least 4.5:1 with
+    #  white.
+    attr_reader :brand_color
+    # @return [String] URL of the company logo.
+    attr_reader :logo_url
+    # @return [String] URL of the company's hero image.
+    attr_reader :hero_url
+    # @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 name [String] The name 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.
+    # @param brand_color [String] The brand color in hex format, must pass a contrast ratio of at least 4.5:1 with
+    #  white.
+    # @param logo_url [String] URL of the company logo.
+    # @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)
+      @name = name
+      @address = address
+      @ein = ein
+      @description = description
+      @brand_color = brand_color
+      @logo_url = logo_url
+      @hero_url = hero_url
+      @additional_properties = additional_properties
+      @_field_set = {
+        "name": name,
+        "address": address,
+        "ein": ein,
+        "description": description,
+        "brandColor": brand_color,
+        "logoUrl": logo_url,
+        "heroUrl": hero_url
+      }
+    end
+
+    # Deserialize a JSON object to an instance of CompanyDetails
+    #
+    # @param json_object [String]
+    # @return [Pinnacle::CompanyDetails]
+    def self.from_json(json_object:)
+      struct = JSON.parse(json_object, object_class: OpenStruct)
+      parsed_json = JSON.parse(json_object)
+      name = parsed_json["name"]
+      address = parsed_json["address"]
+      ein = parsed_json["ein"]
+      description = parsed_json["description"]
+      brand_color = parsed_json["brandColor"]
+      logo_url = parsed_json["logoUrl"]
+      hero_url = parsed_json["heroUrl"]
+      new(
+        name: name,
+        address: address,
+        ein: ein,
+        description: description,
+        brand_color: brand_color,
+        logo_url: logo_url,
+        hero_url: hero_url,
+        additional_properties: struct
+      )
+    end
+
+    # Serialize an instance of CompanyDetails 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.name.is_a?(String) != false || raise("Passed value for field obj.name 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.")
+      obj.brand_color.is_a?(String) != false || raise("Passed value for field obj.brand_color is not the expected type, validation failed.")
+      obj.logo_url.is_a?(String) != false || raise("Passed value for field obj.logo_url is not the expected type, validation failed.")
+      obj.hero_url.is_a?(String) != false || raise("Passed value for field obj.hero_url is not the expected type, validation failed.")
+    end
+  end
+end

data/lib/rcs/types/forbidden_error_body.rb

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

data/lib/rcs/types/internal_server_error_body.rb

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

data/lib/rcs/types/optionals.rb

@@ -0,0 +1,99 @@
+# frozen_string_literal: true
+
+require_relative "additional_website"
+require_relative "additional_phone_number"
+require_relative "additional_email"
+require "ostruct"
+require "json"
+
+module Pinnacle
+  class Optionals
+    # @return [Array<Pinnacle::AdditionalWebsite>] List of additional websites, up to 2.
+    attr_reader :additional_websites
+    # @return [Array<Pinnacle::AdditionalPhoneNumber>] List of additional phone numbers, up to 2.
+    attr_reader :additional_phone_numbers
+    # @return [Array<Pinnacle::AdditionalEmail>] List of additional email addresses, up to 2.
+    attr_reader :additional_emails
+    # @return [Array<String>]
+    attr_reader :test_numbers
+    # @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 additional_websites [Array<Pinnacle::AdditionalWebsite>] List of additional websites, up to 2.
+    # @param additional_phone_numbers [Array<Pinnacle::AdditionalPhoneNumber>] List of additional phone numbers, up to 2.
+    # @param additional_emails [Array<Pinnacle::AdditionalEmail>] List of additional email addresses, up to 2.
+    # @param test_numbers [Array<String>]
+    # @param additional_properties [OpenStruct] Additional properties unmapped to the current class definition
+    # @return [Pinnacle::Optionals]
+    def initialize(additional_websites: OMIT, additional_phone_numbers: OMIT, additional_emails: OMIT,
+                   test_numbers: OMIT, additional_properties: nil)
+      @additional_websites = additional_websites if additional_websites != OMIT
+      @additional_phone_numbers = additional_phone_numbers if additional_phone_numbers != OMIT
+      @additional_emails = additional_emails if additional_emails != OMIT
+      @test_numbers = test_numbers if test_numbers != OMIT
+      @additional_properties = additional_properties
+      @_field_set = {
+        "additionalWebsites": additional_websites,
+        "additionalPhoneNumbers": additional_phone_numbers,
+        "additionalEmails": additional_emails,
+        "testNumbers": test_numbers
+      }.reject do |_k, v|
+        v == OMIT
+      end
+    end
+
+    # Deserialize a JSON object to an instance of Optionals
+    #
+    # @param json_object [String]
+    # @return [Pinnacle::Optionals]
+    def self.from_json(json_object:)
+      struct = JSON.parse(json_object, object_class: OpenStruct)
+      parsed_json = JSON.parse(json_object)
+      additional_websites = parsed_json["additionalWebsites"]&.map do |item|
+        item = item.to_json
+        Pinnacle::AdditionalWebsite.from_json(json_object: item)
+      end
+      additional_phone_numbers = parsed_json["additionalPhoneNumbers"]&.map do |item|
+        item = item.to_json
+        Pinnacle::AdditionalPhoneNumber.from_json(json_object: item)
+      end
+      additional_emails = parsed_json["additionalEmails"]&.map do |item|
+        item = item.to_json
+        Pinnacle::AdditionalEmail.from_json(json_object: item)
+      end
+      test_numbers = parsed_json["testNumbers"]
+      new(
+        additional_websites: additional_websites,
+        additional_phone_numbers: additional_phone_numbers,
+        additional_emails: additional_emails,
+        test_numbers: test_numbers,
+        additional_properties: struct
+      )
+    end
+
+    # Serialize an instance of Optionals 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.additional_websites&.is_a?(Array) != false || raise("Passed value for field obj.additional_websites is not the expected type, validation failed.")
+      obj.additional_phone_numbers&.is_a?(Array) != false || raise("Passed value for field obj.additional_phone_numbers is not the expected type, validation failed.")
+      obj.additional_emails&.is_a?(Array) != false || raise("Passed value for field obj.additional_emails 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.")
+    end
+  end
+end

data/lib/rcs/types/point_of_contact.rb

@@ -0,0 +1,72 @@
+# frozen_string_literal: true
+
+require "ostruct"
+require "json"
+
+module Pinnacle
+  class PointOfContact
+    # @return [String] Point of contact's name.
+    attr_reader :poc_name
+    # @return [String] Point of contact's title.
+    attr_reader :poc_title
+    # @return [String] Point of contact's email address.
+    attr_reader :poc_email
+    # @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 poc_name [String] Point of contact's name.
+    # @param poc_title [String] Point of contact's title.
+    # @param poc_email [String] Point of contact's email address.
+    # @param additional_properties [OpenStruct] Additional properties unmapped to the current class definition
+    # @return [Pinnacle::PointOfContact]
+    def initialize(poc_name:, poc_title:, poc_email:, additional_properties: nil)
+      @poc_name = poc_name
+      @poc_title = poc_title
+      @poc_email = poc_email
+      @additional_properties = additional_properties
+      @_field_set = { "pocName": poc_name, "pocTitle": poc_title, "pocEmail": poc_email }
+    end
+
+    # Deserialize a JSON object to an instance of PointOfContact
+    #
+    # @param json_object [String]
+    # @return [Pinnacle::PointOfContact]
+    def self.from_json(json_object:)
+      struct = JSON.parse(json_object, object_class: OpenStruct)
+      parsed_json = JSON.parse(json_object)
+      poc_name = parsed_json["pocName"]
+      poc_title = parsed_json["pocTitle"]
+      poc_email = parsed_json["pocEmail"]
+      new(
+        poc_name: poc_name,
+        poc_title: poc_title,
+        poc_email: poc_email,
+        additional_properties: struct
+      )
+    end
+
+    # Serialize an instance of PointOfContact 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.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.")
+    end
+  end
+end

data/lib/rcs/types/rcs_functionalities.rb

@@ -0,0 +1,117 @@
+# frozen_string_literal: true
+
+require "ostruct"
+require "json"
+
+module Pinnacle
+  class RcsFunctionalities
+    # @return [Boolean] Indicates if RCS is enabled.
+    attr_reader :is_enabled
+    # @return [Boolean] Indicates if standalone rich cards are supported.
+    attr_reader :standalone_rich_card
+    # @return [Boolean] Indicates if carousel rich cards are supported.
+    attr_reader :carousel_rich_card
+    # @return [Boolean] Indicates if buttons to create a calendar event are supported.
+    attr_reader :create_calendar_event_action
+    # @return [Boolean] Indicates if dial buttons are supported.
+    attr_reader :dial_action
+    # @return [Boolean] Indicates if open URL buttons are supported.
+    attr_reader :open_url_action
+    # @return [Boolean] Indicates if share location buttons are supported.
+    attr_reader :share_location_action
+    # @return [Boolean] Indicates if view location buttons are supported.
+    attr_reader :view_location_action
+    # @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 is_enabled [Boolean] Indicates if RCS is enabled.
+    # @param standalone_rich_card [Boolean] Indicates if standalone rich cards are supported.
+    # @param carousel_rich_card [Boolean] Indicates if carousel rich cards are supported.
+    # @param create_calendar_event_action [Boolean] Indicates if buttons to create a calendar event are supported.
+    # @param dial_action [Boolean] Indicates if dial buttons are supported.
+    # @param open_url_action [Boolean] Indicates if open URL buttons are supported.
+    # @param share_location_action [Boolean] Indicates if share location buttons are supported.
+    # @param view_location_action [Boolean] Indicates if view location buttons are supported.
+    # @param additional_properties [OpenStruct] Additional properties unmapped to the current class definition
+    # @return [Pinnacle::RcsFunctionalities]
+    def initialize(is_enabled:, standalone_rich_card:, carousel_rich_card:, create_calendar_event_action:,
+                   dial_action:, open_url_action:, share_location_action:, view_location_action:, additional_properties: nil)
+      @is_enabled = is_enabled
+      @standalone_rich_card = standalone_rich_card
+      @carousel_rich_card = carousel_rich_card
+      @create_calendar_event_action = create_calendar_event_action
+      @dial_action = dial_action
+      @open_url_action = open_url_action
+      @share_location_action = share_location_action
+      @view_location_action = view_location_action
+      @additional_properties = additional_properties
+      @_field_set = {
+        "is_enabled": is_enabled,
+        "standalone_rich_card": standalone_rich_card,
+        "carousel_rich_card": carousel_rich_card,
+        "create_calendar_event_action": create_calendar_event_action,
+        "dial_action": dial_action,
+        "open_url_action": open_url_action,
+        "share_location_action": share_location_action,
+        "view_location_action": view_location_action
+      }
+    end
+
+    # Deserialize a JSON object to an instance of RcsFunctionalities
+    #
+    # @param json_object [String]
+    # @return [Pinnacle::RcsFunctionalities]
+    def self.from_json(json_object:)
+      struct = JSON.parse(json_object, object_class: OpenStruct)
+      parsed_json = JSON.parse(json_object)
+      is_enabled = parsed_json["is_enabled"]
+      standalone_rich_card = parsed_json["standalone_rich_card"]
+      carousel_rich_card = parsed_json["carousel_rich_card"]
+      create_calendar_event_action = parsed_json["create_calendar_event_action"]
+      dial_action = parsed_json["dial_action"]
+      open_url_action = parsed_json["open_url_action"]
+      share_location_action = parsed_json["share_location_action"]
+      view_location_action = parsed_json["view_location_action"]
+      new(
+        is_enabled: is_enabled,
+        standalone_rich_card: standalone_rich_card,
+        carousel_rich_card: carousel_rich_card,
+        create_calendar_event_action: create_calendar_event_action,
+        dial_action: dial_action,
+        open_url_action: open_url_action,
+        share_location_action: share_location_action,
+        view_location_action: view_location_action,
+        additional_properties: struct
+      )
+    end
+
+    # Serialize an instance of RcsFunctionalities 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.is_enabled.is_a?(Boolean) != false || raise("Passed value for field obj.is_enabled is not the expected type, validation failed.")
+      obj.standalone_rich_card.is_a?(Boolean) != false || raise("Passed value for field obj.standalone_rich_card is not the expected type, validation failed.")
+      obj.carousel_rich_card.is_a?(Boolean) != false || raise("Passed value for field obj.carousel_rich_card is not the expected type, validation failed.")
+      obj.create_calendar_event_action.is_a?(Boolean) != false || raise("Passed value for field obj.create_calendar_event_action is not the expected type, validation failed.")
+      obj.dial_action.is_a?(Boolean) != false || raise("Passed value for field obj.dial_action is not the expected type, validation failed.")
+      obj.open_url_action.is_a?(Boolean) != false || raise("Passed value for field obj.open_url_action is not the expected type, validation failed.")
+      obj.share_location_action.is_a?(Boolean) != false || raise("Passed value for field obj.share_location_action is not the expected type, validation failed.")
+      obj.view_location_action.is_a?(Boolean) != false || raise("Passed value for field obj.view_location_action is not the expected type, validation failed.")
+    end
+  end
+end

data/lib/rcs/types/unauthorized_error_body.rb

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