rcs 2.0.18 → 2.0.20.pre.rc.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: f874ee23601bb2c3f443f9f2898056a34737781aeb7f0952dbe6779827c8b4ea
-  data.tar.gz: 4adfe0457def754cfbe34b9a86c4d6fab4ad1b808bb831728e1419d734c235f6
+  metadata.gz: 707234356d07787fe0f7f144369c4992c305f20cf2b441614bacae5be1e359ca
+  data.tar.gz: 052f00f33d7b3a9c549450dc1df576187468e93067aae0eaff59f0fff7391085
 SHA512:
-  metadata.gz: 582d83c143f38308e5d604e3f98b1f22277af222ab23b0679314f94657dab456c5f82b05021124dd892f39a8c5c301c431690ed2f66c2d203ce9e41efdb8c9ed
-  data.tar.gz: bda0f0a5de23ba36e424e40393a41072fcf79350dfd0f65cd810ad1839d7974fc2ba77dac064ebbf4fbb5ae5208090190c1f6a0eb374a367a14b767c0ff66698
+  metadata.gz: a4f1d05255213bf07f6a6edff5bf9b023617a3d2d52819a189b065dc63c3573e7a5cc7acc7a74c7e8c456f88a2a7676e4bcc7e4c78f25a797b64aaf74381122d
+  data.tar.gz: 2845f1d4104b24c44a7f8d335f3de9821548a8669795ce40c3781875a2e8486e66836b160b24629dadd0e4c75f2ca61cb1d8b3600a0851650bca5c9e05b57658

data/.fern/metadata.json

@@ -1,13 +1,15 @@
 {
   "cliVersion": "5.5.0",
   "generatorName": "fernapi/fern-ruby-sdk",
-  "generatorVersion": "1.1.13",
+  "generatorVersion": "1.12.1",
   "generatorConfig": {
     "clientModuleName": "PinnacleBaseClient",
     "flattenModuleStructure": true,
     "useProvidedDefaults": true,
     "rubocopVariableNumberStyle": "snake_case"
   },
-  "originGitCommit": "f122bb662724c091cfa98880738a845e4c8769c9",
-  "sdkVersion": "2.0.18"
-}
+  "originGitCommit": "4107f10ce57b97cf22a650949d197352235c1567",
+  "originGitCommitIsDirty": true,
+  "invokedBy": "manual",
+  "sdkVersion": "2.0.20.pre.rc.1"
+}

data/.rubocop.yml

@@ -46,6 +46,7 @@ Layout/LineLength:
 
 Naming/VariableNumber:
   EnforcedStyle: snake_case
+  Severity: warning
 
 Style/Documentation:
   Enabled: false
@@ -64,6 +65,39 @@ Style/FrozenStringLiteralComment:
   Exclude:
     - "dynamic-snippets/**/*"
 
+# Indent hash elements 2 spaces from the start of the enclosing line rather than
+# aligning with the preceding paren or bracket. Generated code nests hashes inside
+# arrays and method calls; the "consistent" style is more readable there.
 Layout/FirstHashElementIndentation:
+  EnforcedStyle: consistent
   Exclude:
     - "dynamic-snippets/**/*"
+
+# Match Layout/FirstHashElementIndentation: indent the first argument 2 spaces
+# from the start of the method call's line, regardless of parenthesis position.
+# Dynamic snippets are code samples, not standalone Ruby files; exclude them to
+# keep this config symmetric with Layout/FirstHashElementIndentation above.
+Layout/FirstArgumentIndentation:
+  EnforcedStyle: consistent
+  Exclude:
+    - "dynamic-snippets/**/*"
+
+# The generator emits non-idiomatic class names (e.g. Get_With_Query, JSON_)
+# derived from IR type names whose wire form contains underscores or digits.
+# Rubocop never auto-corrected these (naming cops have no autocorrecter), so
+# disabling the cop keeps CI green without changing customer output. Fixing at
+# source would rename public types across every existing SDK and therefore
+# requires a ruby-v2 major-version bump with a generator migration.
+Naming/ClassAndModuleCamelCase:
+  Enabled: false
+
+# Integer literals are emitted unformatted (e.g. 1000000, not 1_000_000).
+# Rubocop has an autocorrecter for this cop, but the only caller of integer
+# emission is the dynamic-snippets path, which feeds customer-facing surfaces:
+# (1) snippet markdown in reference docs, (2) dynamic-snippets/*.rb sample
+# files. Neither is rubocop-gated (markdown isn't Ruby, dynamic-snippets/**/*
+# is excluded above), so formatting integers there would change docs/dashboard
+# output without any rubocop benefit. Disabling the cop keeps integers raw
+# everywhere and avoids customer-visible diffs.
+Style/NumericLiterals:
+  Enabled: false

data/CONTRIBUTING.md

@@ -0,0 +1,120 @@
+# Contributing
+
+Thanks for your interest in contributing to this SDK! This document provides guidelines for contributing to the project.
+
+## Getting Started
+
+### Prerequisites
+
+- Ruby 3.0+
+- Bundler
+
+### Installation
+
+Install the project dependencies:
+
+```bash
+bundle install
+```
+
+### Building
+
+Build the gem:
+
+```bash
+gem build *.gemspec
+```
+
+### Testing
+
+Run the test suite:
+
+```bash
+bundle exec rspec
+```
+
+### Linting and Formatting
+
+Check code style:
+
+```bash
+bundle exec rubocop
+```
+
+Fix code style issues:
+
+```bash
+bundle exec rubocop -a
+```
+
+## About Generated Code
+
+**Important**: Most files in this SDK are automatically generated by [Fern](https://buildwithfern.com) from the API definition. Direct modifications to generated files will be overwritten the next time the SDK is generated.
+
+### Generated Files
+
+The following directories contain generated code:
+- `lib/` - API client classes and types
+- Most Ruby files in the project
+
+### How to Customize
+
+If you need to customize the SDK, you have two options:
+
+#### Option 1: Use `.fernignore`
+
+For custom code that should persist across SDK regenerations:
+
+1. Create a `.fernignore` file in the project root
+2. Add file patterns for files you want to preserve (similar to `.gitignore` syntax)
+3. Add your custom code to those files
+
+Files listed in `.fernignore` will not be overwritten when the SDK is regenerated.
+
+For more information, see the [Fern documentation on custom code](https://buildwithfern.com/learn/sdks/overview/custom-code).
+
+#### Option 2: Contribute to the Generator
+
+If you want to change how code is generated for all users of this SDK:
+
+1. The Ruby SDK generator lives in the [Fern repository](https://github.com/fern-api/fern)
+2. Generator code is located at `generators/ruby-v2/`
+3. Follow the [Fern contributing guidelines](https://github.com/fern-api/fern/blob/main/CONTRIBUTING.md)
+4. Submit a pull request with your changes to the generator
+
+This approach is best for:
+- Bug fixes in generated code
+- New features that would benefit all users
+- Improvements to code generation patterns
+
+## Making Changes
+
+### Workflow
+
+1. Create a new branch for your changes
+2. Make your modifications
+3. Run tests to ensure nothing breaks: `bundle exec rspec`
+4. Run linting: `bundle exec rubocop`
+5. Build the gem: `gem build *.gemspec`
+6. Commit your changes with a clear commit message
+7. Push your branch and create a pull request
+
+### Commit Messages
+
+Write clear, descriptive commit messages that explain what changed and why.
+
+### Code Style
+
+This project uses RuboCop for code formatting. Run `bundle exec rubocop` before committing to ensure your code meets the project's style guidelines.
+
+## Questions or Issues?
+
+If you have questions or run into issues:
+
+1. Check the [Fern documentation](https://buildwithfern.com)
+2. Search existing [GitHub issues](https://github.com/fern-api/fern/issues)
+3. Open a new issue if your question hasn't been addressed
+
+## License
+
+By contributing to this project, you agree that your contributions will be licensed under the same license as the project.

data/lib/pinnacle/audiences/client.rb

@@ -26,12 +26,10 @@ module Pinnacle
       # @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],
@@ -105,10 +103,8 @@ module Pinnacle
       # @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],

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

@@ -6,6 +6,7 @@ module Pinnacle
       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

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

@@ -6,6 +6,7 @@ module Pinnacle
       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

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

@@ -5,7 +5,9 @@ module Pinnacle
     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

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

@@ -7,6 +7,7 @@ module Pinnacle
         extend Pinnacle::Internal::Types::Union
 
         member -> { Pinnacle::Types::AudienceWithPagination }
+
         member -> { Pinnacle::Types::AudienceCountOnly }
       end
     end

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

@@ -5,7 +5,9 @@ module Pinnacle
     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

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

@@ -5,7 +5,9 @@ module Pinnacle
     module Types
       class ListAudiencesParams < Internal::Types::Model
         field :page_index, -> { Integer }, optional: true, nullable: false, api_name: "pageIndex"
+
         field :page_size, -> { Integer }, optional: true, nullable: false, api_name: "pageSize"
+
         field :name, -> { String }, optional: true, nullable: false
       end
     end

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

@@ -5,7 +5,9 @@ module Pinnacle
     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

data/lib/pinnacle/brands/client.rb

@@ -100,10 +100,8 @@ module Pinnacle
       # @return [Pinnacle::Types::ExtendedBrandWithVetting]
       def get(request_options: {}, **params)
         params = Pinnacle::Internal::Types::Utils.normalize_keys(params)
-        query_param_names = %i[hide_ein]
         query_params = {}
         query_params["hideEIN"] = params[:hide_ein] if params.key?(:hide_ein)
-        params = params.except(*query_param_names)
 
         request = Pinnacle::Internal::JSON::Request.new(
           base_url: request_options[:base_url],
@@ -210,7 +208,7 @@ module Pinnacle
       def vet(request_options: {}, **params)
         params = Pinnacle::Internal::Types::Utils.normalize_keys(params)
         request_data = Pinnacle::Brands::Types::VetBrandParams.new(params).to_h
-        non_body_param_names = ["brandId"]
+        non_body_param_names = %w[brandId]
         body = request_data.except(*non_body_param_names)
 
         request = Pinnacle::Internal::JSON::Request.new(

data/lib/pinnacle/brands/types/autofill_brand_params.rb

@@ -5,8 +5,11 @@ module Pinnacle
     module Types
       class AutofillBrandParams < Internal::Types::Model
         field :additional_info, -> { String }, optional: true, nullable: false
+
         field :name, -> { String }, optional: true, nullable: false
+
         field :options, -> { Pinnacle::Brands::Types::AutofillBrandOptions }, optional: true, nullable: false
+
         field :website, -> { String }, optional: true, nullable: false
       end
     end

data/lib/pinnacle/brands/types/brands_get_request.rb

@@ -5,6 +5,7 @@ module Pinnacle
     module Types
       class BrandsGetRequest < Internal::Types::Model
         field :id, -> { String }, optional: false, nullable: false
+
         field :hide_ein, -> { Internal::Types::Boolean }, optional: true, nullable: false, api_name: "hideEIN"
       end
     end

data/lib/pinnacle/brands/types/list_brands_params.rb

@@ -5,9 +5,13 @@ module Pinnacle
     module Types
       class ListBrandsParams < Internal::Types::Model
         field :page_index, -> { Integer }, optional: true, nullable: false, api_name: "pageIndex"
+
         field :page_size, -> { Integer }, optional: true, nullable: false, api_name: "pageSize"
+
         field :status, -> { Pinnacle::Brands::Types::ListBrandsRequestStatus }, optional: true, nullable: false
+
         field :is_archived, -> { Internal::Types::Boolean }, optional: true, nullable: false, api_name: "isArchived"
+
         field :name, -> { String }, optional: true, nullable: false
       end
     end

data/lib/pinnacle/brands/types/upsert_brand_params.rb

@@ -5,16 +5,27 @@ module Pinnacle
     module Types
       class UpsertBrandParams < Internal::Types::Model
         field :address, -> { String }, optional: true, nullable: false
+
         field :contact, -> { Pinnacle::Brands::Types::UpsertBrandSchemaContact }, optional: true, nullable: false
+
         field :dba, -> { String }, optional: true, nullable: false
+
         field :description, -> { String }, optional: true, nullable: false
+
         field :ein, -> { String }, optional: true, nullable: false
+
         field :email, -> { String }, optional: true, nullable: false
+
         field :id, -> { String }, optional: true, nullable: false
+
         field :name, -> { String }, optional: true, nullable: false
+
         field :sector, -> { Pinnacle::Brands::Types::UpsertBrandSchemaSector }, optional: true, nullable: false
+
         field :type, -> { Pinnacle::Brands::Types::UpsertBrandSchemaType }, optional: true, nullable: false
+
         field :entity_type, -> { Pinnacle::Brands::Types::UpsertBrandSchemaEntityType }, optional: true, nullable: false, api_name: "entityType"
+
         field :website, -> { String }, optional: true, nullable: false
       end
     end

data/lib/pinnacle/brands/types/upsert_brand_schema_contact.rb

@@ -6,8 +6,11 @@ module Pinnacle
       # Contact information for the brand.
       class UpsertBrandSchemaContact < Internal::Types::Model
         field :email, -> { String }, optional: true, nullable: false
+
         field :name, -> { String }, optional: true, nullable: false
+
         field :phone, -> { String }, optional: true, nullable: false
+
         field :title, -> { String }, optional: true, nullable: false
       end
     end

data/lib/pinnacle/brands/types/vet_brand_params.rb

@@ -5,8 +5,11 @@ module Pinnacle
     module Types
       class VetBrandParams < Internal::Types::Model
         field :brand_id, -> { String }, optional: false, nullable: false, api_name: "brandId"
+
         field :type, -> { String }, optional: false, nullable: false
+
         field :provider, -> { String }, optional: false, nullable: false
+
         field :vetting_class, -> { String }, optional: false, nullable: false, api_name: "vettingClass"
       end
     end