Adding custom code

Create a new file and add your custom logic

1
module YourGem
2
  class Helper
3
    def self.my_helper
4
      puts "Hello World!"
5
    end
6
  end
7
end

Add your file to .fernignore

1
# Specify files that shouldn't be modified by Fern
2
3
lib/<gem_name>/helper.rb

Consume the helper

Now your users can consume the helper function by importing it from the SDK.

1
require "your_gem"
2
3
YourGem::Helper.my_helper

Update generators.yml configuration

Name your Fern-generated client something like BaseClient to reflect that this client will be extended.

1
- name: fernapi/fern-ruby-sdk
2
  version: 1.12.1
3
  config:
4
    clientClassName: BaseClient

Import and extend the generated client

First, import the Fern generated base client and extend it. Then, add whatever methods you want.

1
require_relative "client"
2
3
module YourGem
4
  class MyClient < BaseClient
5
    def my_helper
6
      puts "Hello World!"
7
    end
8
  end
9
end

Update .fernignore

Add the my_client.rb to .fernignore.

1
+ lib/<gem_name>/my_client.rb

Consume the method

Instead of constructing the generated client, your users will want to construct the extended client.

1
require "your_gem"
2
3
client = YourGem::MyClient.new

Now your users can consume the helper function by importing it from the SDK.

1
client.my_helper