rcs 2.0.5.pre.rc.1 → 2.0.5

data/.fern/metadata.json

@@ -1,12 +0,0 @@
-{
-  "cliVersion": "3.40.1",
-  "generatorName": "fernapi/fern-ruby-sdk",
-  "generatorVersion": "1.0.0-rc78",
-  "generatorConfig": {
-    "flattenModuleStructure": true,
-    "clientClassName": "PinnacleBaseClient",
-    "useProvidedDefaults": true,
-    "enableWireTests": true
-  },
-  "sdkVersion": "2.0.5-rc.1"
-}

data/.fernignore

@@ -1,6 +0,0 @@
-# Specify files that shouldn't be modified by Fern
-README.md
-lib/pinnacle/wrapper
-lib/pinnacle/client.rb
-lib/pinnacle.rb
-custom.gemspec.rb

data/.rubocop.yml

@@ -1,60 +0,0 @@
-plugins:
-  - rubocop-minitest
-
-AllCops:
-  TargetRubyVersion: 3.3
-  NewCops: enable
-
-Style/StringLiterals:
-  EnforcedStyle: double_quotes
-
-Style/StringLiteralsInInterpolation:
-  EnforcedStyle: double_quotes
-
-Style/AccessModifierDeclarations:
-  Enabled: false
-
-Lint/ConstantDefinitionInBlock:
-  Enabled: false
-
-Metrics/AbcSize:
-  Enabled: false
-
-Metrics/BlockLength:
-  Enabled: false
-
-Metrics/ClassLength:
-  Enabled: false
-
-Metrics/MethodLength:
-  Enabled: false
-
-Metrics/ParameterLists:
-  Enabled: false
-
-Metrics/PerceivedComplexity:
-  Enabled: false
-
-Metrics/CyclomaticComplexity:
-  Enabled: false
-
-Metrics/ModuleLength:
-  Enabled: false
-
-Layout/LineLength:
-  Enabled: false
-
-Naming/VariableNumber:
-  EnforcedStyle: snake_case
-
-Style/Documentation:
-  Enabled: false
-
-Style/Lambda:
-  EnforcedStyle: literal
-
-Minitest/MultipleAssertions:
-  Enabled: false
-
-Minitest/UselessAssertion:
-  Enabled: false

data/README.md

@@ -1,121 +0,0 @@
-# Pinnacle Ruby Library
-
-The Pinnacle Ruby library provides access to the Pinnacle API from Ruby.
-
-## Documentation
-
-API reference documentation is available [here](docs.trypinnacle.app).
-
-## Installation
-
-Install the gem and add to your application's Gemfile by executing:
-
-```sh
-bundle add rcs
-```
-
-If bundler is not being used to manage dependencies, install the gem by executing:
-
-```sh
-gem install rcs
-```
-
-## Instantiation
-
-```ruby
-require "rcs"
-
-client = Pinnacle::Client.new(api_key: "YOUR_API_KEY")
-```
-
-
-## Async Client
-The SDK exports an async client that you can use for non-blocking requests.
-
-```ruby
-require "rcs"
-
-client = Pinnacle::AsyncClient.new(api_key: "YOUR_API_KEY")
-
-Sync do
-  company = client.company.register(
-    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?”\nOrder Status: “Provide your order number.”\nOpt-In: “You’re now subscribed!”\nOpt-Out: “You have unsubscribed.”\nEscalation: “Connecting to a live agent.”    \n",
-    },
-    point_of_contact: {
-      poc_name: "pocName",
-      poc_title: "pocTitle",
-      poc_email: "pocEmail",
-    },
-  )
-  puts company.to_json
-end
-```
-
-## Timeouts
-
-The SDK defaults to a 60 second timout. Use the `timeout_in_seconds` option to
-configure this behavior.
-
-```Ruby
-client.company.register(
-    ...,
-    request_options: RequestOptions.new(
-        timeout_in_seconds: 30
-    )
-)
-```
-
-## Retries
-
-The SDK is instrumented with automatic retries with exponential backoff. A request will be
-retried as long as the request is deemed retriable and the number of retry attempts has not grown larger
-than the configured retry limit (default: 2).
-
-A request is deemed retriable when any of the following HTTP status codes is returned:
-
-- [408](https://developer.mozilla.org/en-US/docs/Web/HTTP/Status/408) (Timeout)
-- [409](https://developer.mozilla.org/en-US/docs/Web/HTTP/Status/409) (Conflict)
-- [429](https://developer.mozilla.org/en-US/docs/Web/HTTP/Status/429) (Too Many Requests)
-- [5XX](https://developer.mozilla.org/en-US/docs/Web/HTTP/Status/500) (Internal Server Errors)
-
-Use the `max_retries` request option to configure this behavior.
-
-```Ruby
-client.company.register(
-    ...,
-    request_options: RequestOptions.new(
-        max_retries: 1
-    )
-)
-```
-
-## Beta status
-
-This SDK is in beta, and there may be breaking changes between versions without a major version update. Therefore,
-we recommend pinning the package version to a specific version in your package.json file. This way, you can install
-the same version each time without breaking changes unless you are intentionally looking for the latest version.

data/Rakefile

@@ -1,20 +0,0 @@
-# frozen_string_literal: true
-
-require "bundler/gem_tasks"
-require "minitest/test_task"
-
-Minitest::TestTask.create
-
-require "rubocop/rake_task"
-
-RuboCop::RakeTask.new
-
-task default: %i[test]
-
-task lint: %i[rubocop]
-
-# Run only the custom test file
-Minitest::TestTask.create(:customtest) do |t|
-  t.libs << "test"
-  t.test_globs = ["test/custom.test.rb"]
-end

data/custom.gemspec.rb

@@ -1,13 +0,0 @@
-# frozen_string_literal: true
-
-# Custom gemspec configuration file
-# This file is automatically loaded by the main gemspec file. The 'spec' variable is available
-# in this context from the main gemspec file. You can modify this file to add custom metadata,
-# dependencies, or other gemspec configurations. If you do make changes to this file, you will
-# need to add it to the .fernignore file to prevent your changes from being overwritten.
-
-def add_custom_gemspec_data(spec)
-  spec.name = "rcs"
-  spec.homepage = "https://github.com/pinnacle-dev/rcs-ruby"
-  spec.license = "MIT"
-end

data/lib/pinnacle/audiences/client.rb

@@ -1,183 +0,0 @@
-# frozen_string_literal: true
-
-module Pinnacle
-  module Audiences
-    class Client
-      # @param client [Pinnacle::Internal::Http::RawClient]
-      #
-      # @return [void]
-      def initialize(client:)
-        @client = client
-      end
-
-      # Retrieve an audience by ID with optional pagination.
-      #
-      # @param request_options [Hash]
-      # @param params [Hash]
-      # @option request_options [String] :base_url
-      # @option request_options [Hash{String => Object}] :additional_headers
-      # @option request_options [Hash{String => Object}] :additional_query_parameters
-      # @option request_options [Hash{String => Object}] :additional_body_parameters
-      # @option request_options [Integer] :timeout_in_seconds
-      # @option params [String] :id
-      # @option params [Integer, nil] :page
-      # @option params [Integer, nil] :limit
-      #
-      # @return [Pinnacle::Audiences::Types::AudiencesGetResponse]
-      def get(request_options: {}, **params)
-        params = Pinnacle::Internal::Types::Utils.normalize_keys(params)
-        query_param_names = %i[id page limit]
-        query_params = {}
-        query_params["id"] = params[:id] if params.key?(:id)
-        query_params["page"] = params[:page] if params.key?(:page)
-        query_params["limit"] = params[:limit] if params.key?(:limit)
-        params.except(*query_param_names)
-
-        request = Pinnacle::Internal::JSON::Request.new(
-          base_url: request_options[:base_url],
-          method: "GET",
-          path: "audiences",
-          query: query_params,
-          request_options: request_options
-        )
-        begin
-          response = @client.send(request)
-        rescue Net::HTTPRequestTimeout
-          raise Pinnacle::Errors::TimeoutError
-        end
-        code = response.code.to_i
-        if code.between?(200, 299)
-          Pinnacle::Audiences::Types::AudiencesGetResponse.load(response.body)
-        else
-          error_class = Pinnacle::Errors::ResponseError.subclass_for_code(code)
-          raise error_class.new(response.body, code: code)
-        end
-      end
-
-      # Create a new audience with optional initial contacts. Phone numbers that don't exist will be auto-created as
-      # contacts.
-      #
-      # @param request_options [Hash]
-      # @param params [Pinnacle::Audiences::Types::CreateAudienceParams]
-      # @option request_options [String] :base_url
-      # @option request_options [Hash{String => Object}] :additional_headers
-      # @option request_options [Hash{String => Object}] :additional_query_parameters
-      # @option request_options [Hash{String => Object}] :additional_body_parameters
-      # @option request_options [Integer] :timeout_in_seconds
-      #
-      # @return [Pinnacle::Types::AudienceCountOnly]
-      def create(request_options: {}, **params)
-        params = Pinnacle::Internal::Types::Utils.normalize_keys(params)
-        body_prop_names = %i[name description contacts]
-        body_bag = params.slice(*body_prop_names)
-
-        request = Pinnacle::Internal::JSON::Request.new(
-          base_url: request_options[:base_url],
-          method: "POST",
-          path: "audiences",
-          body: Pinnacle::Audiences::Types::CreateAudienceParams.new(body_bag).to_h,
-          request_options: request_options
-        )
-        begin
-          response = @client.send(request)
-        rescue Net::HTTPRequestTimeout
-          raise Pinnacle::Errors::TimeoutError
-        end
-        code = response.code.to_i
-        if code.between?(200, 299)
-          Pinnacle::Types::AudienceCountOnly.load(response.body)
-        else
-          error_class = Pinnacle::Errors::ResponseError.subclass_for_code(code)
-          raise error_class.new(response.body, code: code)
-        end
-      end
-
-      # Permanently delete an audience and all its contact associations.
-      #
-      # Note: This will NOT delete the contacts themselves, only the audience and its memberships.
-      #
-      # @param request_options [Hash]
-      # @param params [Hash]
-      # @option request_options [String] :base_url
-      # @option request_options [Hash{String => Object}] :additional_headers
-      # @option request_options [Hash{String => Object}] :additional_query_parameters
-      # @option request_options [Hash{String => Object}] :additional_body_parameters
-      # @option request_options [Integer] :timeout_in_seconds
-      # @option params [String] :id
-      #
-      # @return [Pinnacle::Types::DeleteAudienceResponse]
-      def delete(request_options: {}, **params)
-        params = Pinnacle::Internal::Types::Utils.normalize_keys(params)
-        query_param_names = %i[id]
-        query_params = {}
-        query_params["id"] = params[:id] if params.key?(:id)
-        params.except(*query_param_names)
-
-        request = Pinnacle::Internal::JSON::Request.new(
-          base_url: request_options[:base_url],
-          method: "DELETE",
-          path: "audiences",
-          query: query_params,
-          request_options: request_options
-        )
-        begin
-          response = @client.send(request)
-        rescue Net::HTTPRequestTimeout
-          raise Pinnacle::Errors::TimeoutError
-        end
-        code = response.code.to_i
-        if code.between?(200, 299)
-          Pinnacle::Types::DeleteAudienceResponse.load(response.body)
-        else
-          error_class = Pinnacle::Errors::ResponseError.subclass_for_code(code)
-          raise error_class.new(response.body, code: code)
-        end
-      end
-
-      # Update audience metadata. This endpoint does NOT modify contacts.
-      #
-      # To add or remove contacts, use the [Add Contacts](/api-reference/audiences/add-contacts) or [Remove
-      # Contacts](/api-reference/audiences/remove-contacts) endpoints.
-      #
-      # @param request_options [Hash]
-      # @param params [Pinnacle::Audiences::Types::UpdateAudienceParams]
-      # @option request_options [String] :base_url
-      # @option request_options [Hash{String => Object}] :additional_headers
-      # @option request_options [Hash{String => Object}] :additional_query_parameters
-      # @option request_options [Hash{String => Object}] :additional_body_parameters
-      # @option request_options [Integer] :timeout_in_seconds
-      #
-      # @return [Pinnacle::Types::AudienceCountOnly]
-      def update(request_options: {}, **params)
-        params = Pinnacle::Internal::Types::Utils.normalize_keys(params)
-        body_prop_names = %i[id name description]
-        body_bag = params.slice(*body_prop_names)
-
-        request = Pinnacle::Internal::JSON::Request.new(
-          base_url: request_options[:base_url],
-          method: "PATCH",
-          path: "audiences",
-          body: Pinnacle::Audiences::Types::UpdateAudienceParams.new(body_bag).to_h,
-          request_options: request_options
-        )
-        begin
-          response = @client.send(request)
-        rescue Net::HTTPRequestTimeout
-          raise Pinnacle::Errors::TimeoutError
-        end
-        code = response.code.to_i
-        if code.between?(200, 299)
-          Pinnacle::Types::AudienceCountOnly.load(response.body)
-        else
-          error_class = Pinnacle::Errors::ResponseError.subclass_for_code(code)
-          raise error_class.new(response.body, code: code)
-        end
-      end
-
-      # @return [Pinnacle::Contacts::Client]
-      def contacts
-        @contacts ||= Pinnacle::Audiences::Contacts::Client.new(client: @client)
-      end
-    end
-  end
-end

data/lib/pinnacle/audiences/contacts/client.rb

@@ -1,97 +0,0 @@
-# frozen_string_literal: true
-
-module Pinnacle
-  module Audiences
-    module Contacts
-      class Client
-        # @param client [Pinnacle::Internal::Http::RawClient]
-        #
-        # @return [void]
-        def initialize(client:)
-          @client = client
-        end
-
-        # Remove contacts from an existing audience. This operation is idempotent.
-        #
-        # - Only removes contacts that exist in the audience
-        # - Contacts not in the audience are ignored
-        #
-        # @param request_options [Hash]
-        # @param params [Pinnacle::Audiences::Contacts::Types::RemoveContactsParams]
-        # @option request_options [String] :base_url
-        # @option request_options [Hash{String => Object}] :additional_headers
-        # @option request_options [Hash{String => Object}] :additional_query_parameters
-        # @option request_options [Hash{String => Object}] :additional_body_parameters
-        # @option request_options [Integer] :timeout_in_seconds
-        #
-        # @return [Pinnacle::Types::AudienceCountOnly]
-        def remove(request_options: {}, **params)
-          params = Pinnacle::Internal::Types::Utils.normalize_keys(params)
-          body_prop_names = %i[id contacts]
-          body_bag = params.slice(*body_prop_names)
-
-          request = Pinnacle::Internal::JSON::Request.new(
-            base_url: request_options[:base_url],
-            method: "DELETE",
-            path: "audiences/contacts",
-            body: Pinnacle::Audiences::Contacts::Types::RemoveContactsParams.new(body_bag).to_h,
-            request_options: request_options
-          )
-          begin
-            response = @client.send(request)
-          rescue Net::HTTPRequestTimeout
-            raise Pinnacle::Errors::TimeoutError
-          end
-          code = response.code.to_i
-          if code.between?(200, 299)
-            Pinnacle::Types::AudienceCountOnly.load(response.body)
-          else
-            error_class = Pinnacle::Errors::ResponseError.subclass_for_code(code)
-            raise error_class.new(response.body, code: code)
-          end
-        end
-
-        # Add contacts to an existing audience. This operation is additive and idempotent.
-        #
-        # - Phone numbers that don't exist will be auto-created as contacts
-        # - Duplicate adds are ignored
-        # - Contacts already in the audience are ignored
-        #
-        # @param request_options [Hash]
-        # @param params [Pinnacle::Audiences::Contacts::Types::AddContactsParams]
-        # @option request_options [String] :base_url
-        # @option request_options [Hash{String => Object}] :additional_headers
-        # @option request_options [Hash{String => Object}] :additional_query_parameters
-        # @option request_options [Hash{String => Object}] :additional_body_parameters
-        # @option request_options [Integer] :timeout_in_seconds
-        #
-        # @return [Pinnacle::Types::AudienceCountOnly]
-        def add(request_options: {}, **params)
-          params = Pinnacle::Internal::Types::Utils.normalize_keys(params)
-          body_prop_names = %i[id contacts]
-          body_bag = params.slice(*body_prop_names)
-
-          request = Pinnacle::Internal::JSON::Request.new(
-            base_url: request_options[:base_url],
-            method: "PATCH",
-            path: "audiences/contacts",
-            body: Pinnacle::Audiences::Contacts::Types::AddContactsParams.new(body_bag).to_h,
-            request_options: request_options
-          )
-          begin
-            response = @client.send(request)
-          rescue Net::HTTPRequestTimeout
-            raise Pinnacle::Errors::TimeoutError
-          end
-          code = response.code.to_i
-          if code.between?(200, 299)
-            Pinnacle::Types::AudienceCountOnly.load(response.body)
-          else
-            error_class = Pinnacle::Errors::ResponseError.subclass_for_code(code)
-            raise error_class.new(response.body, code: code)
-          end
-        end
-      end
-    end
-  end
-end

data/lib/pinnacle/audiences/contacts/types/add_contacts_params.rb

@@ -1,14 +0,0 @@
-# frozen_string_literal: true
-
-module Pinnacle
-  module Audiences
-    module Contacts
-      module Types
-        class AddContactsParams < Internal::Types::Model
-          field :id, -> { String }, optional: false, nullable: false
-          field :contacts, -> { Internal::Types::Array[String] }, optional: false, nullable: false
-        end
-      end
-    end
-  end
-end

data/lib/pinnacle/audiences/contacts/types/remove_contacts_params.rb

@@ -1,14 +0,0 @@
-# frozen_string_literal: true
-
-module Pinnacle
-  module Audiences
-    module Contacts
-      module Types
-        class RemoveContactsParams < Internal::Types::Model
-          field :id, -> { String }, optional: false, nullable: false
-          field :contacts, -> { Internal::Types::Array[String] }, optional: false, nullable: false
-        end
-      end
-    end
-  end
-end

data/lib/pinnacle/audiences/types/audiences_delete_request.rb

@@ -1,11 +0,0 @@
-# frozen_string_literal: true
-
-module Pinnacle
-  module Audiences
-    module Types
-      class AudiencesDeleteRequest < Internal::Types::Model
-        field :id, -> { String }, optional: false, nullable: false
-      end
-    end
-  end
-end

data/lib/pinnacle/audiences/types/audiences_get_request.rb

@@ -1,13 +0,0 @@
-# frozen_string_literal: true
-
-module Pinnacle
-  module Audiences
-    module Types
-      class AudiencesGetRequest < Internal::Types::Model
-        field :id, -> { String }, optional: false, nullable: false
-        field :page, -> { Integer }, optional: true, nullable: false
-        field :limit, -> { Integer }, optional: true, nullable: false
-      end
-    end
-  end
-end

data/lib/pinnacle/audiences/types/audiences_get_response.rb

@@ -1,14 +0,0 @@
-# frozen_string_literal: true
-
-module Pinnacle
-  module Audiences
-    module Types
-      class AudiencesGetResponse < Internal::Types::Model
-        extend Pinnacle::Internal::Types::Union
-
-        member -> { Pinnacle::Types::AudienceWithPagination }
-        member -> { Pinnacle::Types::AudienceCountOnly }
-      end
-    end
-  end
-end

data/lib/pinnacle/audiences/types/create_audience_params.rb

@@ -1,13 +0,0 @@
-# frozen_string_literal: true
-
-module Pinnacle
-  module Audiences
-    module Types
-      class CreateAudienceParams < Internal::Types::Model
-        field :name, -> { String }, optional: false, nullable: false
-        field :description, -> { String }, optional: true, nullable: false
-        field :contacts, -> { Internal::Types::Array[String] }, optional: true, nullable: false
-      end
-    end
-  end
-end

data/lib/pinnacle/audiences/types/update_audience_params.rb

@@ -1,13 +0,0 @@
-# frozen_string_literal: true
-
-module Pinnacle
-  module Audiences
-    module Types
-      class UpdateAudienceParams < Internal::Types::Model
-        field :id, -> { String }, optional: false, nullable: false
-        field :name, -> { String }, optional: true, nullable: false
-        field :description, -> { String }, optional: true, nullable: false
-      end
-    end
-  end
-end