Release v0.0.271

Author: fern-api[bot]

client/client.go

@@ -5,11 +5,13 @@ package client
 import (
 	core "github.com/fern-api/generator-exec-go/core"
 	logging "github.com/fern-api/generator-exec-go/logging"
+	readme "github.com/fern-api/generator-exec-go/readme"
 	http "net/http"
 )
 
 type Client interface {
 	Logging() logging.Client
+	Readme() readme.Client
 }
 
 func NewClient(opts ...core.ClientOption) Client {
@@ -22,6 +24,7 @@ func NewClient(opts ...core.ClientOption) Client {
 		httpClient:    options.HTTPClient,
 		header:        options.ToHeader(),
 		loggingClient: logging.NewClient(opts...),
+		readmeClient:  readme.NewClient(opts...),
 	}
 }
 
@@ -30,8 +33,13 @@ type client struct {
 	httpClient    core.HTTPClient
 	header        http.Header
 	loggingClient logging.Client
+	readmeClient  readme.Client
 }
 
 func (c *client) Logging() logging.Client {
 	return c.loggingClient
 }
+
+func (c *client) Readme() readme.Client {
+	return c.readmeClient
+}

core/client_option.go

@@ -36,6 +36,6 @@ func (c *ClientOptions) cloneHeader() http.Header {
 	headers := c.HTTPHeader.Clone()
 	headers.Set("X-Fern-Language", "Go")
 	headers.Set("X-Fern-SDK-Name", "github.com/fern-api/generator-exec-go")
-	headers.Set("X-Fern-SDK-Version", "0.0.263")
+	headers.Set("X-Fern-SDK-Version", "0.0.271")
 	return headers
 }

readme.go

@@ -2,24 +2,133 @@
 
 package generatorexec
 
+import (
+	json "encoding/json"
+	fmt "fmt"
+	strconv "strconv"
+)
+
+type BadgeType uint
+
+const (
+	BadgeTypeNpm BadgeType = iota + 1
+	BadgeTypeMaven
+	BadgeTypePypi
+	BadgeTypeGo
+)
+
+func (b BadgeType) String() string {
+	switch b {
+	default:
+		return strconv.Itoa(int(b))
+	case BadgeTypeNpm:
+		return "NPM"
+	case BadgeTypeMaven:
+		return "MAVEN"
+	case BadgeTypePypi:
+		return "PYPI"
+	case BadgeTypeGo:
+		return "GO"
+	}
+}
+
+func (b BadgeType) MarshalJSON() ([]byte, error) {
+	return []byte(fmt.Sprintf("%q", b.String())), nil
+}
+
+func (b *BadgeType) UnmarshalJSON(data []byte) error {
+	var raw string
+	if err := json.Unmarshal(data, &raw); err != nil {
+		return err
+	}
+	switch raw {
+	case "NPM":
+		value := BadgeTypeNpm
+		*b = value
+	case "MAVEN":
+		value := BadgeTypeMaven
+		*b = value
+	case "PYPI":
+		value := BadgeTypePypi
+		*b = value
+	case "GO":
+		value := BadgeTypeGo
+		*b = value
+	}
+	return nil
+}
+
 // The standard sections included in every generated README.md
-type Readme struct {
+//
+// # {{title}}
+// {{badge}} [Fern Badge]
+//
+// {{summary}}
+//
+// ## API Documentation
+//
+// API Reference Documentation is available {{here}}.
+//
+// ## Installation
+//
+// {{installation}}
+//
+// ## Usage
+//
+// {{usage}}
+//
+// ## Async Client
+//
+// {{asyncUsage}}
+//
+// ## Environments
+//
+// {{environments}}
+//
+// ## Custom URL
+//
+// {{customUrl}}
+//
+// ## Handling Errors
+//
+// {{errors}}
+//
+// ## Advanced: Setting Timeouts
+//
+// {{timeouts}}
+//
+// ## Advanced: Request Options
+//
+// {{requestOptions}}}
+//
+// ## Beta Status
+//
+// Some info about beta status.
+//
+// ## Contributing
+//
+// Some info about contributing.
+type GenerateReadmeRequest struct {
 	// The title (e.g. Acme Python Library ...)
 	Title string `json:"title"`
 	// Badges rendered alongside the standard Fern badge
-	Badges string `json:"badges"`
+	Badge *BadgeType `json:"badge,omitempty"`
 	// The summary included below the badges (e.g. The Acme Python library provides ...)
 	Summary string `json:"summary"`
-	// General requirements to use the SDK
-	Requirements *string `json:"requirements,omitempty"`
+	// Each requirement is rendered as a bulleted list
+	Requirements []string `json:"requirements,omitempty"`
 	// The installation steps
-	Installation string `json:"installation"`
-	// Describes how to instantiate the client (i.e. a code snippet)
-	Instantiation string `json:"instantiation"`
-	// Usage guide, extensible with Fern definition example annotations
+	Installation *string `json:"installation,omitempty"`
+	// Section describing how to instantiate the client (i.e. a code snippet)
 	Usage string `json:"usage"`
-	// The status of the SDK (e.g. beta)
-	Status string `json:"status"`
-	// The contributing guide; if not specified uses the default contributing notes
-	Contributing *string `json:"contributing,omitempty"`
+	// Section describing how to instantiate an async client
+	AsyncUsage *string `json:"asyncUsage,omitempty"`
+	// Section describing how to set timeouts
+	Timeouts *string `json:"timeouts,omitempty"`
+	// If multiple environments, a section for how to specify multiple environments
+	Environments *string `json:"environments,omitempty"`
+	// Section describing how to set a custom url
+	CustomUrl *string `json:"customUrl,omitempty"`
+	// Section describing how to set request options
+	RequestOptions *string `json:"requestOptions,omitempty"`
 }

readme/client.go

@@ -0,0 +1,56 @@
+// This file was auto-generated by Fern from our API Definition.
+
+package readme
+
+import (
+	context "context"
+	fmt "fmt"
+	generatorexecgo "github.com/fern-api/generator-exec-go"
+	core "github.com/fern-api/generator-exec-go/core"
+	http "net/http"
+)
+
+type Client interface {
+	GenerateReadme(ctx context.Context, taskId generatorexecgo.TaskId, request *generatorexecgo.GenerateReadmeRequest) error
+}
+
+func NewClient(opts ...core.ClientOption) Client {
+	options := core.NewClientOptions()
+	for _, opt := range opts {
+		opt(options)
+	}
+	return &client{
+		baseURL:    options.BaseURL,
+		httpClient: options.HTTPClient,
+		header:     options.ToHeader(),
+	}
+}
+
+type client struct {
+	baseURL    string
+	httpClient core.HTTPClient
+	header     http.Header
+}
+
+func (c *client) GenerateReadme(ctx context.Context, taskId generatorexecgo.TaskId, request *generatorexecgo.GenerateReadmeRequest) error {
+	baseURL := ""
+	if c.baseURL != "" {
+		baseURL = c.baseURL
+	}
+	endpointURL := fmt.Sprintf(baseURL+"/"+"api/readme/%v", taskId)
+
+	if err := core.DoRequest(
+		ctx,
+		c.httpClient,
+		endpointURL,
+		http.MethodPost,
+		request,
+		nil,
+		false,
+		c.header,
+		nil,
+	); err != nil {
+		return err
+	}
+	return nil
+}