rcs 1.0.17 → 2.0.0.pre.rc.1

data/lib/rcs/{company/types/company_register_response_brand.rb → types/basic_phone_information_contact.rb}

@@ -4,12 +4,11 @@ require "ostruct"
 require "json"
 
 module Pinnacle
-  class Company
-    class CompanyRegisterResponseBrand
-      # @return [String]
+  module Types
+    # Contact information linked to the phone number registration, if available.
+    class BasicPhoneInformationContact
+      # @return [String] Registered name associated with the phone number.
       attr_reader :name
-      # @return [Float]
-      attr_reader :id
       # @return [OpenStruct] Additional properties unmapped to the current class definition
       attr_reader :additional_properties
       # @return [Object]
@@ -18,34 +17,27 @@ module Pinnacle
 
       OMIT = Object.new
 
-      # @param name [String]
-      # @param id [Float]
+      # @param name [String] Registered name associated with the phone number.
       # @param additional_properties [OpenStruct] Additional properties unmapped to the current class definition
-      # @return [Pinnacle::Company::CompanyRegisterResponseBrand]
-      def initialize(name:, id:, additional_properties: nil)
+      # @return [Pinnacle::Types::BasicPhoneInformationContact]
+      def initialize(name:, additional_properties: nil)
         @name = name
-        @id = id
         @additional_properties = additional_properties
-        @_field_set = { "name": name, "id": id }
+        @_field_set = { "name": name }
       end
 
-      # Deserialize a JSON object to an instance of CompanyRegisterResponseBrand
+      # Deserialize a JSON object to an instance of BasicPhoneInformationContact
       #
       # @param json_object [String]
-      # @return [Pinnacle::Company::CompanyRegisterResponseBrand]
+      # @return [Pinnacle::Types::BasicPhoneInformationContact]
       def self.from_json(json_object:)
         struct = JSON.parse(json_object, object_class: OpenStruct)
         parsed_json = JSON.parse(json_object)
         name = parsed_json["name"]
-        id = parsed_json["id"]
-        new(
-          name: name,
-          id: id,
-          additional_properties: struct
-        )
+        new(name: name, additional_properties: struct)
       end
 
-      # Serialize an instance of CompanyRegisterResponseBrand to a JSON object
+      # Serialize an instance of BasicPhoneInformationContact to a JSON object
       #
       # @return [String]
       def to_json(*_args)
@@ -60,7 +52,6 @@ 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.id.is_a?(Float) != false || raise("Passed value for field obj.id is not the expected type, validation failed.")
       end
     end
   end

data/lib/rcs/types/basic_phone_information_location.rb

@@ -0,0 +1,74 @@
+# frozen_string_literal: true
+
+require_relative "basic_phone_information_location_country"
+require "ostruct"
+require "json"
+
+module Pinnacle
+  module Types
+    # Geographic and political details where the phone number is registered.
+    class BasicPhoneInformationLocation
+      # @return [Pinnacle::Types::BasicPhoneInformationLocationCountry] Information about the country of registration.
+      attr_reader :country
+      # @return [String] Location description including region, state/province, and city.
+      attr_reader :place
+      # @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 country [Pinnacle::Types::BasicPhoneInformationLocationCountry] Information about the country of registration.
+      # @param place [String] Location description including region, state/province, and city.
+      # @param additional_properties [OpenStruct] Additional properties unmapped to the current class definition
+      # @return [Pinnacle::Types::BasicPhoneInformationLocation]
+      def initialize(country:, place:, additional_properties: nil)
+        @country = country
+        @place = place
+        @additional_properties = additional_properties
+        @_field_set = { "country": country, "place": place }
+      end
+
+      # Deserialize a JSON object to an instance of BasicPhoneInformationLocation
+      #
+      # @param json_object [String]
+      # @return [Pinnacle::Types::BasicPhoneInformationLocation]
+      def self.from_json(json_object:)
+        struct = JSON.parse(json_object, object_class: OpenStruct)
+        parsed_json = JSON.parse(json_object)
+        if parsed_json["country"].nil?
+          country = nil
+        else
+          country = parsed_json["country"].to_json
+          country = Pinnacle::Types::BasicPhoneInformationLocationCountry.from_json(json_object: country)
+        end
+        place = parsed_json["place"]
+        new(
+          country: country,
+          place: place,
+          additional_properties: struct
+        )
+      end
+
+      # Serialize an instance of BasicPhoneInformationLocation 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:)
+        Pinnacle::Types::BasicPhoneInformationLocationCountry.validate_raw(obj: obj.country)
+        obj.place.is_a?(String) != false || raise("Passed value for field obj.place is not the expected type, validation failed.")
+      end
+    end
+  end
+end

data/lib/rcs/types/basic_phone_information_location_country.rb

@@ -0,0 +1,75 @@
+# frozen_string_literal: true
+
+require "ostruct"
+require "json"
+
+module Pinnacle
+  module Types
+    # Information about the country of registration.
+    class BasicPhoneInformationLocationCountry
+      # @return [String] Two-letter country code where the number is registered.
+      attr_reader :code
+      # @return [String] Full name of the country.
+      attr_reader :name
+      # @return [String] International dialing prefix for the country.
+      attr_reader :prefix
+      # @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 code [String] Two-letter country code where the number is registered.
+      # @param name [String] Full name of the country.
+      # @param prefix [String] International dialing prefix for the country.
+      # @param additional_properties [OpenStruct] Additional properties unmapped to the current class definition
+      # @return [Pinnacle::Types::BasicPhoneInformationLocationCountry]
+      def initialize(code:, name:, prefix:, additional_properties: nil)
+        @code = code
+        @name = name
+        @prefix = prefix
+        @additional_properties = additional_properties
+        @_field_set = { "code": code, "name": name, "prefix": prefix }
+      end
+
+      # Deserialize a JSON object to an instance of BasicPhoneInformationLocationCountry
+      #
+      # @param json_object [String]
+      # @return [Pinnacle::Types::BasicPhoneInformationLocationCountry]
+      def self.from_json(json_object:)
+        struct = JSON.parse(json_object, object_class: OpenStruct)
+        parsed_json = JSON.parse(json_object)
+        code = parsed_json["code"]
+        name = parsed_json["name"]
+        prefix = parsed_json["prefix"]
+        new(
+          code: code,
+          name: name,
+          prefix: prefix,
+          additional_properties: struct
+        )
+      end
+
+      # Serialize an instance of BasicPhoneInformationLocationCountry 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.code.is_a?(String) != false || raise("Passed value for field obj.code 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.prefix.is_a?(String) != false || raise("Passed value for field obj.prefix is not the expected type, validation failed.")
+      end
+    end
+  end
+end

data/lib/rcs/types/brand_status.rb

@@ -0,0 +1,92 @@
+# frozen_string_literal: true
+
+require_relative "brand_status_enum"
+require "ostruct"
+require "json"
+
+module Pinnacle
+  module Types
+    # Response for get brand status.
+    class BrandStatus
+      # @return [Array<String>] List of errors that occurred.
+      attr_reader :errors
+      # @return [Integer] Id of the brand.
+      attr_reader :id
+      # @return [Pinnacle::Types::BrandStatusEnum] Current review status of the brand. <br>
+      #  `INCOMPLETE`: Has not been submitted. Use the [submit
+      #  endpoint](../brands/submit). <br>
+      #  `PENDING`: Currently being reviewed. <br>
+      #  `VERIFIED`: Verified and good to go. <br>
+      #  `UNVERIFIED`: No longer verified due to an update in the brand details. Requires
+      #  vetting to be reverified. <br>
+      #  `VETTED`: Brand has been vetted by an external provider and has received vetting
+      #  scores. <br>
+      attr_reader :status
+      # @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>] List of errors that occurred.
+      # @param id [Integer] Id of the brand.
+      # @param status [Pinnacle::Types::BrandStatusEnum] Current review status of the brand. <br>
+      #  `INCOMPLETE`: Has not been submitted. Use the [submit
+      #  endpoint](../brands/submit). <br>
+      #  `PENDING`: Currently being reviewed. <br>
+      #  `VERIFIED`: Verified and good to go. <br>
+      #  `UNVERIFIED`: No longer verified due to an update in the brand details. Requires
+      #  vetting to be reverified. <br>
+      #  `VETTED`: Brand has been vetted by an external provider and has received vetting
+      #  scores. <br>
+      # @param additional_properties [OpenStruct] Additional properties unmapped to the current class definition
+      # @return [Pinnacle::Types::BrandStatus]
+      def initialize(errors:, id:, status:, additional_properties: nil)
+        @errors = errors
+        @id = id
+        @status = status
+        @additional_properties = additional_properties
+        @_field_set = { "errors": errors, "id": id, "status": status }
+      end
+
+      # Deserialize a JSON object to an instance of BrandStatus
+      #
+      # @param json_object [String]
+      # @return [Pinnacle::Types::BrandStatus]
+      def self.from_json(json_object:)
+        struct = JSON.parse(json_object, object_class: OpenStruct)
+        parsed_json = JSON.parse(json_object)
+        errors = parsed_json["errors"]
+        id = parsed_json["id"]
+        status = parsed_json["status"]
+        new(
+          errors: errors,
+          id: id,
+          status: status,
+          additional_properties: struct
+        )
+      end
+
+      # Serialize an instance of BrandStatus 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.")
+        obj.id.is_a?(Integer) != false || raise("Passed value for field obj.id is not the expected type, validation failed.")
+        obj.status.is_a?(Pinnacle::Types::BrandStatusEnum) != false || raise("Passed value for field obj.status is not the expected type, validation failed.")
+      end
+    end
+  end
+end

data/lib/rcs/types/brand_status_enum.rb

@@ -0,0 +1,21 @@
+# frozen_string_literal: true
+
+module Pinnacle
+  module Types
+    # Current review status of the brand.
+    #  `INCOMPLETE`: Has not been submitted.
+    #  `PENDING`: Currently being reviewed.
+    #  `VERIFIED`: Verified and good to go.
+    #  `UNVERIFIED`: No longer verified due to an update in the brand details.
+    #  `VETTED`: Brand has been vetted by an external provider and has received vetting
+    #  scores.
+    class BrandStatusEnum
+      PENDING = "PENDING"
+      UNVERIFIED = "UNVERIFIED"
+      VERIFIED = "VERIFIED"
+      VETTED = "VETTED"
+      FAILED = "FAILED"
+      INCOMPLETE = "INCOMPLETE"
+    end
+  end
+end

data/lib/rcs/types/buy_response_capabilities.rb

@@ -0,0 +1,77 @@
+# frozen_string_literal: true
+
+require "ostruct"
+require "json"
+
+module Pinnacle
+  module Types
+    # Enabled communication features for the phone number.
+    class BuyResponseCapabilities
+      # @return [Boolean] Indicates if SMS messaging is enabled and functional.
+      attr_reader :sms
+      # @return [Boolean] Indicates if multimedia messaging (images, videos, files) is enabled and
+      #  functional.
+      attr_reader :mms
+      # @return [Boolean] Indicates if voice calling is enabled and functional.
+      attr_reader :voice
+      # @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 sms [Boolean] Indicates if SMS messaging is enabled and functional.
+      # @param mms [Boolean] Indicates if multimedia messaging (images, videos, files) is enabled and
+      #  functional.
+      # @param voice [Boolean] Indicates if voice calling is enabled and functional.
+      # @param additional_properties [OpenStruct] Additional properties unmapped to the current class definition
+      # @return [Pinnacle::Types::BuyResponseCapabilities]
+      def initialize(sms:, mms:, voice:, additional_properties: nil)
+        @sms = sms
+        @mms = mms
+        @voice = voice
+        @additional_properties = additional_properties
+        @_field_set = { "sms": sms, "mms": mms, "voice": voice }
+      end
+
+      # Deserialize a JSON object to an instance of BuyResponseCapabilities
+      #
+      # @param json_object [String]
+      # @return [Pinnacle::Types::BuyResponseCapabilities]
+      def self.from_json(json_object:)
+        struct = JSON.parse(json_object, object_class: OpenStruct)
+        parsed_json = JSON.parse(json_object)
+        sms = parsed_json["sms"]
+        mms = parsed_json["mms"]
+        voice = parsed_json["voice"]
+        new(
+          sms: sms,
+          mms: mms,
+          voice: voice,
+          additional_properties: struct
+        )
+      end
+
+      # Serialize an instance of BuyResponseCapabilities 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.sms.is_a?(Boolean) != false || raise("Passed value for field obj.sms is not the expected type, validation failed.")
+        obj.mms.is_a?(Boolean) != false || raise("Passed value for field obj.mms is not the expected type, validation failed.")
+        obj.voice.is_a?(Boolean) != false || raise("Passed value for field obj.voice is not the expected type, validation failed.")
+      end
+    end
+  end
+end

data/lib/rcs/types/campaign_enum.rb

@@ -0,0 +1,15 @@
+# frozen_string_literal: true
+
+module Pinnacle
+  module Types
+    # The type of campaign:
+    #  - TOLL_FREE: Toll-free number campaigns
+    #  - 10DLC: 10-digit long code campaigns for A2P messaging
+    #  - RCS: Rich Communication Services campaigns
+    class CampaignEnum
+      TOLL_FREE = "TOLL_FREE"
+      TEN_DLC = "10DLC"
+      RCS = "RCS"
+    end
+  end
+end

data/lib/rcs/types/campaign_query.rb

@@ -0,0 +1,69 @@
+# frozen_string_literal: true
+
+require_relative "campaign_enum"
+require "ostruct"
+require "json"
+
+module Pinnacle
+  module Types
+    # Information about the campaign associated with a conversation
+    class CampaignQuery
+      # @return [String] Unique identifier for the campaign
+      attr_reader :id
+      # @return [Pinnacle::Types::CampaignEnum]
+      attr_reader :type
+      # @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 id [String] Unique identifier for the campaign
+      # @param type [Pinnacle::Types::CampaignEnum]
+      # @param additional_properties [OpenStruct] Additional properties unmapped to the current class definition
+      # @return [Pinnacle::Types::CampaignQuery]
+      def initialize(id:, type:, additional_properties: nil)
+        @id = id
+        @type = type
+        @additional_properties = additional_properties
+        @_field_set = { "id": id, "type": type }
+      end
+
+      # Deserialize a JSON object to an instance of CampaignQuery
+      #
+      # @param json_object [String]
+      # @return [Pinnacle::Types::CampaignQuery]
+      def self.from_json(json_object:)
+        struct = JSON.parse(json_object, object_class: OpenStruct)
+        parsed_json = JSON.parse(json_object)
+        id = parsed_json["id"]
+        type = parsed_json["type"]
+        new(
+          id: id,
+          type: type,
+          additional_properties: struct
+        )
+      end
+
+      # Serialize an instance of CampaignQuery 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.id.is_a?(String) != false || raise("Passed value for field obj.id is not the expected type, validation failed.")
+        obj.type.is_a?(Pinnacle::Types::CampaignEnum) != false || raise("Passed value for field obj.type is not the expected type, validation failed.")
+      end
+    end
+  end
+end

data/lib/rcs/{company/types/company_register_request_company_id.rb → types/campaign_submission_result.rb}

@@ -4,11 +4,10 @@ require "ostruct"
 require "json"
 
 module Pinnacle
-  class Company
-    # Register an existing company
-    class CompanyRegisterRequestCompanyId
-      # @return [String] ID of an existing company to register
-      attr_reader :company_id
+  module Types
+    class CampaignSubmissionResult
+      # @return [Boolean] Indicates whether the campaign submission was successful.
+      attr_reader :success
       # @return [OpenStruct] Additional properties unmapped to the current class definition
       attr_reader :additional_properties
       # @return [Object]
@@ -17,27 +16,27 @@ module Pinnacle
 
       OMIT = Object.new
 
-      # @param company_id [String] ID of an existing company to register
+      # @param success [Boolean] Indicates whether the campaign submission was successful.
       # @param additional_properties [OpenStruct] Additional properties unmapped to the current class definition
-      # @return [Pinnacle::Company::CompanyRegisterRequestCompanyId]
-      def initialize(company_id:, additional_properties: nil)
-        @company_id = company_id
+      # @return [Pinnacle::Types::CampaignSubmissionResult]
+      def initialize(success:, additional_properties: nil)
+        @success = success
         @additional_properties = additional_properties
-        @_field_set = { "companyId": company_id }
+        @_field_set = { "success": success }
       end
 
-      # Deserialize a JSON object to an instance of CompanyRegisterRequestCompanyId
+      # Deserialize a JSON object to an instance of CampaignSubmissionResult
       #
       # @param json_object [String]
-      # @return [Pinnacle::Company::CompanyRegisterRequestCompanyId]
+      # @return [Pinnacle::Types::CampaignSubmissionResult]
       def self.from_json(json_object:)
         struct = JSON.parse(json_object, object_class: OpenStruct)
         parsed_json = JSON.parse(json_object)
-        company_id = parsed_json["companyId"]
-        new(company_id: company_id, additional_properties: struct)
+        success = parsed_json["success"]
+        new(success: success, additional_properties: struct)
       end
 
-      # Serialize an instance of CompanyRegisterRequestCompanyId to a JSON object
+      # Serialize an instance of CampaignSubmissionResult to a JSON object
       #
       # @return [String]
       def to_json(*_args)
@@ -51,7 +50,7 @@ module Pinnacle
       # @param obj [Object]
       # @return [Void]
       def self.validate_raw(obj:)
-        obj.company_id.is_a?(String) != false || raise("Passed value for field obj.company_id is not the expected type, validation failed.")
+        obj.success.is_a?(Boolean) != false || raise("Passed value for field obj.success is not the expected type, validation failed.")
       end
     end
   end

data/lib/rcs/types/campaign_validation_response_errors_item.rb

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