Skip to content

Commit 3636c4a

Browse files
authored
Merge pull request #47 from SchematicHQ/fern-bot/2026-08-24_10-14-17_916
SDK regeneration
2 parents ae2a1b3 + 3ac8e1c commit 3636c4a

880 files changed

Lines changed: 7704 additions & 693 deletions

File tree

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

.fern/metadata.json

Lines changed: 7 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
{
22
"cliVersion": "5.50.0",
33
"generatorName": "fernapi/fern-ruby-sdk",
4-
"generatorVersion": "1.1.13",
4+
"generatorVersion": "1.23.2",
55
"generatorConfig": {
66
"module": "SchematicHQ",
77
"rubocopVariableNumberStyle": "disabled",
@@ -13,6 +13,10 @@
1313
"webrick": ">= 1.0"
1414
}
1515
},
16-
"originGitCommit": "1ab5d36abb4de887dde605f8b82a71dce464a26b",
17-
"sdkVersion": "1.4.14"
16+
"originGitCommit": "008b7147a27272499bf4b17fa96d4357ca3b62e9",
17+
"originGitCommitIsDirty": false,
18+
"invokedBy": "ci",
19+
"requestedVersion": "1.4.15",
20+
"ciProvider": "github",
21+
"sdkVersion": "1.4.15"
1822
}

.fern/replay.lock

Lines changed: 9 additions & 3 deletions
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

.rubocop.yml

Lines changed: 33 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -64,6 +64,39 @@ Style/FrozenStringLiteralComment:
6464
Exclude:
6565
- "dynamic-snippets/**/*"
6666

67+
# Indent hash elements 2 spaces from the start of the enclosing line rather than
68+
# aligning with the preceding paren or bracket. Generated code nests hashes inside
69+
# arrays and method calls; the "consistent" style is more readable there.
6770
Layout/FirstHashElementIndentation:
71+
EnforcedStyle: consistent
6872
Exclude:
6973
- "dynamic-snippets/**/*"
74+
75+
# Match Layout/FirstHashElementIndentation: indent the first argument 2 spaces
76+
# from the start of the method call's line, regardless of parenthesis position.
77+
# Dynamic snippets are code samples, not standalone Ruby files; exclude them to
78+
# keep this config symmetric with Layout/FirstHashElementIndentation above.
79+
Layout/FirstArgumentIndentation:
80+
EnforcedStyle: consistent
81+
Exclude:
82+
- "dynamic-snippets/**/*"
83+
84+
# The generator emits non-idiomatic class names (e.g. Get_With_Query, JSON_)
85+
# derived from IR type names whose wire form contains underscores or digits.
86+
# Rubocop never auto-corrected these (naming cops have no autocorrecter), so
87+
# disabling the cop keeps CI green without changing customer output. Fixing at
88+
# source would rename public types across every existing SDK and therefore
89+
# requires a ruby-v2 major-version bump with a generator migration.
90+
Naming/ClassAndModuleCamelCase:
91+
Enabled: false
92+
93+
# Integer literals are emitted unformatted (e.g. 1000000, not 1_000_000).
94+
# Rubocop has an autocorrecter for this cop, but the only caller of integer
95+
# emission is the dynamic-snippets path, which feeds customer-facing surfaces:
96+
# (1) snippet markdown in reference docs, (2) dynamic-snippets/*.rb sample
97+
# files. Neither is rubocop-gated (markdown isn't Ruby, dynamic-snippets/**/*
98+
# is excluded above), so formatting integers there would change docs/dashboard
99+
# output without any rubocop benefit. Disabling the cop keeps integers raw
100+
# everywhere and avoids customer-visible diffs.
101+
Style/NumericLiterals:
102+
Enabled: false

CONTRIBUTING.md

Lines changed: 120 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,120 @@
1+
# Contributing
2+
3+
Thanks for your interest in contributing to this SDK! This document provides guidelines for contributing to the project.
4+
5+
## Getting Started
6+
7+
### Prerequisites
8+
9+
- Ruby 3.0+
10+
- Bundler
11+
12+
### Installation
13+
14+
Install the project dependencies:
15+
16+
```bash
17+
bundle install
18+
```
19+
20+
### Building
21+
22+
Build the gem:
23+
24+
```bash
25+
gem build *.gemspec
26+
```
27+
28+
### Testing
29+
30+
Run the test suite:
31+
32+
```bash
33+
bundle exec rspec
34+
```
35+
36+
### Linting and Formatting
37+
38+
Check code style:
39+
40+
```bash
41+
bundle exec rubocop
42+
```
43+
44+
Fix code style issues:
45+
46+
```bash
47+
bundle exec rubocop -a
48+
```
49+
50+
## About Generated Code
51+
52+
**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.
53+
54+
### Generated Files
55+
56+
The following directories contain generated code:
57+
- `lib/` - API client classes and types
58+
- Most Ruby files in the project
59+
60+
### How to Customize
61+
62+
If you need to customize the SDK, you have two options:
63+
64+
#### Option 1: Use `.fernignore`
65+
66+
For custom code that should persist across SDK regenerations:
67+
68+
1. Create a `.fernignore` file in the project root
69+
2. Add file patterns for files you want to preserve (similar to `.gitignore` syntax)
70+
3. Add your custom code to those files
71+
72+
Files listed in `.fernignore` will not be overwritten when the SDK is regenerated.
73+
74+
For more information, see the [Fern documentation on custom code](https://buildwithfern.com/learn/sdks/overview/custom-code).
75+
76+
#### Option 2: Contribute to the Generator
77+
78+
If you want to change how code is generated for all users of this SDK:
79+
80+
1. The Ruby SDK generator lives in the [Fern repository](https://github.com/fern-api/fern)
81+
2. Generator code is located at `generators/ruby-v2/`
82+
3. Follow the [Fern contributing guidelines](https://github.com/fern-api/fern/blob/main/CONTRIBUTING.md)
83+
4. Submit a pull request with your changes to the generator
84+
85+
This approach is best for:
86+
- Bug fixes in generated code
87+
- New features that would benefit all users
88+
- Improvements to code generation patterns
89+
90+
## Making Changes
91+
92+
### Workflow
93+
94+
1. Create a new branch for your changes
95+
2. Make your modifications
96+
3. Run tests to ensure nothing breaks: `bundle exec rspec`
97+
4. Run linting: `bundle exec rubocop`
98+
5. Build the gem: `gem build *.gemspec`
99+
6. Commit your changes with a clear commit message
100+
7. Push your branch and create a pull request
101+
102+
### Commit Messages
103+
104+
Write clear, descriptive commit messages that explain what changed and why.
105+
106+
### Code Style
107+
108+
This project uses RuboCop for code formatting. Run `bundle exec rubocop` before committing to ensure your code meets the project's style guidelines.
109+
110+
## Questions or Issues?
111+
112+
If you have questions or run into issues:
113+
114+
1. Check the [Fern documentation](https://buildwithfern.com)
115+
2. Search existing [GitHub issues](https://github.com/fern-api/fern/issues)
116+
3. Open a new issue if your question hasn't been addressed
117+
118+
## License
119+
120+
By contributing to this project, you agree that your contributions will be licensed under the same license as the project.

Gemfile

Lines changed: 2 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -5,18 +5,13 @@ source "https://rubygems.org"
55
gemspec
66

77
group :test, :development do
8-
gem "rake", "~> 13.0"
9-
108
gem "minitest", "~> 5.16"
119
gem "minitest-rg"
12-
10+
gem "pry"
11+
gem "rake", "~> 13.0"
1312
gem "rubocop", "~> 1.21"
1413
gem "rubocop-minitest"
15-
16-
gem "pry"
17-
1814
gem "webmock"
19-
2015
gem "webrick", ">= 1.0"
2116
end
2217

Gemfile.custom

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -11,4 +11,4 @@
1111
# gem 'custom-gem', '~> 2.0'
1212
# end
1313

14-
# Add your custom gem dependencies here
14+
# Add your custom gem dependencies here

Gemfile.lock

Lines changed: 0 additions & 100 deletions
This file was deleted.

lib/schematic.rb

Lines changed: 8 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -395,6 +395,7 @@
395395
require_relative "schematic/types/plan_snapshot_view"
396396
require_relative "schematic/types/plan_version_snapshot_view"
397397
require_relative "schematic/types/subscription_trait_update"
398+
require_relative "schematic/types/trial_status"
398399
require_relative "schematic/types/plan_change_response_data"
399400
require_relative "schematic/companies/types/list_plan_changes_response"
400401
require_relative "schematic/companies/types/get_plan_change_response"
@@ -436,6 +437,9 @@
436437
require_relative "schematic/entitlements/types/list_feature_usage_params"
437438
require_relative "schematic/entitlements/types/list_feature_usage_response"
438439
require_relative "schematic/types/time_series_granularity"
440+
require_relative "schematic/entitlements/types/list_feature_usage_history_params"
441+
require_relative "schematic/types/feature_usage_history_response_data"
442+
require_relative "schematic/entitlements/types/list_feature_usage_history_response"
439443
require_relative "schematic/entitlements/types/get_feature_usage_time_series_params"
440444
require_relative "schematic/types/limit_time_series_point_response_data"
441445
require_relative "schematic/types/usage_time_series_point_response_data"
@@ -532,6 +536,7 @@
532536
require_relative "schematic/types/credit_transfer_view"
533537
require_relative "schematic/types/credit_company_grant_view"
534538
require_relative "schematic/types/stripe_embed_info"
539+
require_relative "schematic/types/upcoming_invoice_response_data"
535540
require_relative "schematic/types/component_preview_response_data"
536541
require_relative "schematic/components/types/preview_component_data_response"
537542
require_relative "schematic/types/plan_bundle_response_data"
@@ -588,7 +593,6 @@
588593
require_relative "schematic/types/check_flag_response_data"
589594
require_relative "schematic/features/types/check_flag_response"
590595
require_relative "schematic/types/company_credit_balance"
591-
require_relative "schematic/types/trial_status"
592596
require_relative "schematic/types/datastream_company_plan"
593597
require_relative "schematic/types/check_flags_response_data"
594598
require_relative "schematic/features/types/check_flags_response"
@@ -736,6 +740,8 @@
736740
require_relative "schematic/types/update_pay_in_advance_request_body"
737741
require_relative "schematic/types/change_subscription_internal_request_body"
738742
require_relative "schematic/types/change_subscription_request_body"
743+
require_relative "schematic/types/preflight_event_usage_request_body"
744+
require_relative "schematic/types/preflight_request_body"
739745
require_relative "schematic/types/check_flag_request_body"
740746
require_relative "schematic/types/checkout_field_input"
741747
require_relative "schematic/types/company_billing_details_view"
@@ -945,6 +951,7 @@
945951
require_relative "schematic/entitlements/types/list_feature_companies_request"
946952
require_relative "schematic/entitlements/types/count_feature_companies_request"
947953
require_relative "schematic/entitlements/types/list_feature_usage_request"
954+
require_relative "schematic/entitlements/types/list_feature_usage_history_request"
948955
require_relative "schematic/entitlements/types/get_feature_usage_time_series_request"
949956
require_relative "schematic/entitlements/types/count_feature_usage_request"
950957
require_relative "schematic/entitlements/types/list_feature_users_request"

0 commit comments

Comments
 (0)