readme

type APIErrorResponse struct {
	// Docs is a ReadMe Metrics log URL where more information about the request can be retrieved.
	// If metrics URLs are unavailable for the request, this URL will be a URL to the ReadMe API Reference.
	Docs string `json:"docs"`
	// Error is an error code unique to the error received.
	Error string `json:"error"`
	// Help is information on where additional assistance from the ReadMe support team can be obtained.
	Help string `json:"help"`
	// Message is the reason why the error occurred.
	Message string `json:"message"`
	// Poem is a short poem about the error.
	Poem []string `json:"poem"`
	// Suggestion is a helpful suggestion for how to alleviate the error.
	Suggestion string `json:"suggestion"`
}

type APIRegistryClient struct {
	// contains filtered or unexported fields
}

type APIRegistrySaved struct {
	Definition   map[string]interface{} `json:"definition"`
	RegistryUUID string                 `json:"registryUUID"`
}

type APIRegistryService interface {
	// Create a new API registry on ReadMe.
	//
	// The response returns the UUID and the specification definition.
	//
	// NOTE: This is an undocumented endpoint on ReadMe and was discovered by inspecting the ReadMe
	// CLI application. The registry UUID is required for retrieving the remote specification.
	// A typical workflow will be to create the registry with this method and follow-up with a call
	// to APISpecification.Create() with the UUID returned from this response.
	Create(definition string, version ...string) (APIRegistrySaved, *APIResponse, error)

	// Get retrieves an API definition from the ReadMe.com API registry with a provided UUID and
	// returns it as a string.
	//
	// API Reference: https://docs.readme.com/main/reference/getapiregistry
	Get(uuid string) (string, *APIResponse, error)
}

type APIRequest struct {
	// Endpoint is the API endpoint (after the base URL) for the request.
	Endpoint string

	// Headers lists HTTP headers to send in the request, in addition to the implicit headers.
	Headers []RequestHeader

	// Slice of HTTP status codes that are considered 'ok'.
	// Any other status code in the response results in an error.
	OkStatusCode []int

	// Method is the HTTP method to use for the request.
	Method string

	// An optional payload, in bytes, for the request.
	Payload []byte

	// Optional options for a request, including headers, version and pagination options.
	RequestOptions

	// Interface of a struct to map the response body to.
	Response interface{}

	// UseAuth toggles whether the request should use authentication or not.
	UseAuth bool

	// URL is a full URL string to use for the request as an alternative to Endpoint.
	URL string
}

type APIResponse struct {
	// APIErrorResponse is a structured error from the ReadMe API when a request results in error.
	APIErrorResponse APIErrorResponse
	// Body is the response body in bytes.
	Body []byte
	// HTTPResponse is the stdlib http.Response type.
	HTTPResponse *http.Response
	// Request is the APIRequest struct used to create the request.
	Request *APIRequest
}

type APISpecification struct {
	Category   CategorySummary `json:"category"`
	ID         string          `json:"id"`
	LastSynced string          `json:"lastSynced"`
	Source     string          `json:"source"`
	Title      string          `json:"title"`
	Type       string          `json:"type"`
	Version    string          `json:"version"`
}

type APISpecificationClient struct {
	// contains filtered or unexported fields
}

type APISpecificationSaved struct {
	ID    string `json:"_id"`
	Title string `json:"title"`
}

type APISpecificationService interface {
	// Create a new API specification on ReadMe by uploading a specification definition provided as
	// a JSON string or by associating an existing definition in the API registry by providing a
	// registry UUID as a parameter.
	//
	// The `definition` parameter can be a JSON string of the full definition or a string with the
	// UUID of an API registry in ReadMe prefixed with "uuid:". A UUID can be obtained from the
	// APIRegistry.Create() method's response.
	//
	// NOTE: specifying the definition as a UUID is an *undocumented* feature of the API.
	//
	// API Reference: https://docs.readme.com/reference/uploadapispecification
	Create(definition string, options ...RequestOptions) (APISpecificationSaved, *APIResponse, error)

	// Delete an API Specification by ID.
	// It returns true if it successfully deletes an API Specification.
	//
	// API Reference: https://docs.readme.com/reference/deleteapispecification
	Delete(specID string) (bool, *APIResponse, error)

	// Get a single API specification with a provided ID.
	//
	// Requesting a single API specification isn't included in the API. The client uses GetAll() to
	// retrieve the full list and matches the requested ID to the list.
	//
	// An error is returned if the specification wasn't found.
	//
	// API Reference: https://docs.readme.com/reference/getapispecification
	Get(specID string, options ...RequestOptions) (APISpecification, *APIResponse, error)

	// GetAll retrieves and returns all API specifications on ReadMe.com.
	//
	// API Reference: https://docs.readme.com/reference/getapispecification
	GetAll(...RequestOptions) ([]APISpecification, *APIResponse, error)

	// Update an existing API specification on ReadMe by uploading a specification definition
	// provided as a JSON string or by associating an existing definition in the API registry by
	// providing a registry UUID as a parameter.
	//
	// The `definition` parameter can be a JSON string of the full definition or a string with the
	// UUID of an API registry in ReadMe prefixed with "uuid:". A UUID can be obtained from the
	// APIRegistry.Create() method's response.
	//
	// NOTE: specifying the definition as a UUID is an *undocumented* feature of the API.
	//
	// API Reference: https://docs.readme.com/reference/updateapispecification
	Update(specID, definition string) (APISpecificationSaved, *APIResponse, error)

	// UploadDefinition uploads an API specification definition by making a request that submits
	// form data with the specification definition provided as a string.
	// APISpecification.Create() should be used in most cases instead of calling this directly.
	UploadDefinition(method, content, url, version string, response interface{}) (interface{}, *APIResponse, error)
}

type Application struct {
	// CoverLetter is additional information for the application.
	CoverLetter string `json:"coverLetter,omitempty"`
	// DontReallyApply toggles actually applying or just trying out the API. Set
	// this to 'true' to test without applying.
	// API default is `false`.
	DontReallyApply *bool `json:"dontReallyApply"`
	// Email is a valid email we can reach you at.
	// This is *required* when submitting an application.
	Email string `json:"email"`
	// GitHub is a URL for GitHub, Bitbucket, Gitlab or anywhere else your code is hosted!
	GitHub string `json:"github,omitempty"`
	// Job is the job you're looking to apply for.
	// This is *required* when submitting an application.
	Job string `json:"job"`
	// LinkedIn is a link to a LinkedIn profile.
	LinkedIn string `json:"linkedin,omitempty"`
	// Name is your full name.
	// This is *required* when submitting an application.
	Name string `json:"name"`
	// Pronouns is a list pronouns an applicant uses.
	Pronouns string `json:"pronouns,omitempty"`
}

type ApplyClient struct {
	// contains filtered or unexported fields
}

type ApplyResponse struct {
	Careers   string   `json:"careers"`
	Keyvalues string   `json:"keyvalues"`
	Message   string   `json:"message"`
	Poem      []string `json:"poem"`
	Questions string   `json:"questions?"`
}

type ApplyService interface {
	// Apply for an open role at ReadMe.
	//
	// API Reference: https://docs.readme.com/main/reference/applytoreadme
	Apply(application Application) (ApplyResponse, *APIResponse, error)

	// Get a list of open roles at ReadMe.
	//
	// API Reference: https://docs.readme.com/main/reference/getopenroles
	Get() ([]OpenRole, *APIResponse, error)
}

type Category struct {
	CategoryType string `json:"categoryType"`
	CreatedAt    string `json:"createdAt"`
	ID           string `json:"id"`
	Order        int    `json:"order"`
	Project      string `json:"project"`
	Reference    bool   `json:"reference"`
	Slug         string `json:"slug"`
	Title        string `json:"title"`
	Type         string `json:"type"`
	Version      string `json:"version"`
}

type CategoryClient struct {
	// contains filtered or unexported fields
}

type CategoryDocs struct {
	Children []CategoryDocsChildren `json:"children"`
	Hidden   bool                   `json:"hidden"`
	ID       string                 `json:"_id"`
	Order    int                    `json:"order"`
	Slug     string                 `json:"slug"`
	Title    string                 `json:"title"`
}

type CategoryDocsChildren struct {
	Hidden bool   `json:"hidden"`
	ID     string `json:"_id"`
	Order  int    `json:"order"`
	Slug   string `json:"slug"`
	Title  string `json:"title"`
}

type CategoryParams struct {
	// Title is a *required* short title for the category. This is what will show in the sidebar.
	Title string `json:"title"`
	// Type is tye type of category, which can be "reference" or "guide".
	Type string `json:"type"`
}

type CategorySaved struct {
	CreatedAt string  `json:"createdAt"`
	ID        string  `json:"id"`
	Order     int     `json:"order"`
	Project   string  `json:"project"`
	Reference bool    `json:"reference"`
	Slug      string  `json:"slug"`
	Title     string  `json:"title"`
	Type      string  `json:"type"`
	Version   Version `json:"version"`
}

type CategoryService interface {
	// Create a new category in ReadMe.
	//
	// The `response` parameter should be a to a `CategorySaved` or `CategoryVersionSaved`
	// interface. When specifying a `Version` in the `options` parameter, the API responds with
	// `CategoryVersionSaved`. When a version isn't specified, it responds with `CategorySaved`.
	//
	// Without a version:
	//
	//	category := &readme.CategorySaved{}
	//	apiResponse, err := rdme.Category.Create(category, {params...})
	//
	// With a version:
	//
	//	options := readme.RequestOptions{Version: "1.2.0"}
	//	category := &readme.CategoryVersionSaved{}
	//	apiResponse, err := rdme.Category.Create(category, {params...}, options)
	//
	// API Reference: https://docs.readme.com/main/reference/createcategory
	Create(response any, params CategoryParams, options ...RequestOptions) (*APIResponse, error)

	// Delete an existing category in ReadMe.
	//
	// API Reference: https://docs.readme.com/reference/deletecategory
	Delete(slug string, options ...RequestOptions) (bool, *APIResponse, error)

	// Get a single category on ReadMe.com.
	//
	// The `category` parameter may be a slug or category ID prefixed with "id:".
	// The slug is preferred, since it's a more direct request while the ID requires
	// iterating over the list of all categories for a matching ID.
	//
	// API Reference: https://docs.readme.com/reference/getcategory
	Get(category string, options ...RequestOptions) (Category, *APIResponse, error)

	// GetAll retrieves and returns all categories on ReadMe.com.
	//
	// API Reference: https://docs.readme.com/reference/getcategories
	GetAll(options ...RequestOptions) ([]Category, *APIResponse, error)

	// GetDocs a list of docs metadata for a category on ReadMe.
	//
	// API Reference: https://docs.readme.com/main/reference/getcategorydocs
	GetDocs(slug string, options ...RequestOptions) ([]CategoryDocs, *APIResponse, error)

	// Update an existing category in ReadMe.
	//
	// Note that Update() returns a Category struct type while Create() returns
	// CategorySaved or CategoryVersionSaved.
	//
	// API Reference: https://docs.readme.com/main/reference/updatecategory
	Update(slug string, params CategoryParams, options ...RequestOptions) (Category, *APIResponse, error)
}

type CategorySummary struct {
	ID    string `json:"id"`
	Order int    `json:"order"`
	Slug  string `json:"slug"`
	Title string `json:"title"`
	Type  string `json:"type"`
}

type CategoryVersion struct {
	Categories   []Category                `json:"categories"`
	Codename     string                    `json:"codename"`
	CreatedAt    string                    `json:"createdAt"`
	ForkedFrom   CategoryVersionForkedFrom `json:"forked_from"`
	ID           string                    `json:"id"`
	IsBeta       bool                      `json:"is_beta"`
	IsDeprecated bool                      `json:"is_deprecated"`
	IsHidden     bool                      `json:"is_hidden"`
	IsStable     bool                      `json:"is_stable"`
	Project      string                    `json:"project"`
	ReleaseDate  string                    `json:"releaseDate"`
	Version      string                    `json:"version"`
	VersionClean string                    `json:"version_clean"`
}

type CategoryVersionForkedFrom struct {
	ID      string `json:"_id"`
	Version string `json:"version"`
}

type CategoryVersionSaved struct {
	CreatedAt string          `json:"createdAt"`
	ID        string          `json:"id"`
	Order     int             `json:"order"`
	Project   string          `json:"project"`
	Reference bool            `json:"reference"`
	Slug      string          `json:"slug"`
	Title     string          `json:"title"`
	Type      string          `json:"type"`
	Version   CategoryVersion `json:"version"`
}

type Changelog struct {
	Algolia   DocAlgolia  `json:"algolia"`
	Body      string      `json:"body"`
	CreatedAt string      `json:"createdAt"`
	HTML      string      `json:"html"`
	Hidden    bool        `json:"hidden"`
	ID        string      `json:"_id"`
	Metadata  DocMetadata `json:"metadata"`
	Project   string      `json:"project,omitempty"`
	Revision  int         `json:"revision"`
	Slug      string      `json:"slug"`
	Title     string      `json:"title"`
	Type      string      `json:"type"`
	UpdatedAt string      `json:"updatedAt"`
	User      DocUser     `json:"user,omitempty"`
}

type ChangelogClient struct {
	// contains filtered or unexported fields
}

type ChangelogParams struct {
	// Body content of the changelog.
	// This is *required* when creating or updating a changelog.
	Body string `json:"body"`
	// Hidden toggles the visibility of the changelog.
	// API default is `true`.
	Hidden *bool `json:"hidden"`
	// Title of the changelog.
	// This is *required* when creating or updating a changelog.
	Title string `json:"title"`
	// Type of the changelog.
	Type string `json:"type,omitempty"`
}

type ChangelogService interface {
	// Create a new changelog in ReadMe.
	//
	// API Reference: https://docs.readme.com/main/reference/createchangelog
	Create(params ChangelogParams) (Changelog, *APIResponse, error)

	// Delete a changelog in ReadMe.
	//
	// API Reference: https://docs.readme.com/main/reference/deletechangelog
	Delete(slug string) (bool, *APIResponse, error)

	// Get a changelog from ReadMe.
	//
	// API Reference: https://docs.readme.com/main/reference/getchangelogs
	Get(slug string) (Changelog, *APIResponse, error)

	// GetAll retrieves a list of changelogs from ReadMe.
	//
	// API Reference: https://docs.readme.com/main/reference/getchangelogs
	GetAll(options ...RequestOptions) ([]Changelog, *APIResponse, error)

	// Update an existing changelog in ReadMe.
	//
	// API Reference: https://docs.readme.com/main/reference/updatechangelog
	Update(slug string, params ChangelogParams) (Changelog, *APIResponse, error)
}

type Client struct {
	// APIURL is the base URL for the ReadMe API.
	APIURL string
	// HTTPClient is the initialized HTTP client.
	HTTPClient *http.Client
	// Token is the API token for authenticating with ReadMe.
	Token string

	// APIRegistry implements the ReadMe API Registry API for managing API definitions.
	APIRegistry APIRegistryService
	// APISpecification implements the ReadMe API Specification API for managing API specifications.
	APISpecification APISpecificationService
	// Apply implements the ReadMe API Apply API for retrieving and applying for positions at ReadMe.
	Apply ApplyService
	// Category implements the ReadMe Category API for managing categories.
	Category CategoryService
	// Changelog implements the ReadMe Changelog API for managing changelogs.
	Changelog ChangelogService
	// CustomPage implements the ReadMe CustomPage API for managing custom pages.
	CustomPage CustomPageService
	// Doc implements the ReadMe Docs API for managing docs.
	Doc DocService
	// Image implements the ReadMe Image API for uploading images.
	Image ImageService
	// OutboundIP implements the ReadMe OutboundIP API for retrieving outbound IP addresses.
	OutboundIP OutboundIPService
	// Project implements the ReadMe Project API for retrieving metadata about the project.
	Project ProjectService
	// Version implements the ReadMe Version API for managing versions.
	Version VersionService
}

type CustomPage struct {
	Algolia    DocAlgolia  `json:"algolia"`
	Body       string      `json:"body"`
	CreatedAt  string      `json:"createdAt"`
	Fullscreen bool        `json:"fullscreen"`
	HTML       string      `json:"html"`
	Hidden     bool        `json:"hidden"`
	HTMLMode   bool        `json:"htmlmode"`
	ID         string      `json:"_id"`
	Metadata   DocMetadata `json:"metadata"`
	Revision   int         `json:"revision"`
	Slug       string      `json:"slug"`
	Title      string      `json:"title"`
	UpdatedAt  string      `json:"updatedAt"`
}

type CustomPageClient struct {
	// contains filtered or unexported fields
}

type CustomPageParams struct {
	// Body formatted in Markdown (displayed by default).
	Body string `json:"body,omitempty"`
	// Hidden toggles the visibility of the custom page.
	// API default is `true`.
	Hidden *bool `json:"hidden"`
	// Body formatted in HTML (sanitized, only displayed if HTMLMode is true).
	HTML string `json:"html,omitempty"`
	// HTMLMode toggles if html should be displayed. Body will be displayed if false.
	// API default is `false`.
	HTMLMode *bool `json:"htmlmode"`
	// Title of the custom page.
	// This is *required* when creating or updating a custom page.
	Title string `json:"title"`
}

type CustomPageService interface {
	// Create a new custom page in ReadMe.
	//
	// API Reference: https://docs.readme.com/main/reference/createcustompage
	Create(params CustomPageParams) (CustomPage, *APIResponse, error)

	// Delete a custom page in ReadMe.
	//
	// API Reference: https://docs.readme.com/reference/deletecustompages
	Delete(slug string) (bool, *APIResponse, error)

	// Get a single custom page's data from ReadMe.
	//
	// API Reference: https://docs.readme.com/main/reference/getcustompage
	Get(slug string) (CustomPage, *APIResponse, error)

	// GetAll retrieves a list of custom pages and their data from ReadMe.
	//
	// Pagination options may be specified with the `options` parameter.
	//
	// API Reference: https://docs.readme.com/main/reference/getcustompages
	GetAll(options ...RequestOptions) ([]CustomPage, *APIResponse, error)

	// Update an existing custom page in ReadMe.
	//
	// API Reference: https://docs.readme.com/main/reference/updatecustompage
	Update(slug string, params CustomPageParams) (CustomPage, *APIResponse, error)
}

type Doc struct {
	Algolia       DocAlgolia     `json:"algolia"`
	API           DocAPI         `json:"api"`
	Body          string         `json:"body"`
	BodyHTML      string         `json:"body_html,omitempty"`
	Category      string         `json:"category"`
	CreatedAt     string         `json:"createdAt"`
	Deprecated    bool           `json:"deprecated"`
	Error         DocErrorObject `json:"error"`
	Excerpt       string         `json:"excerpt"`
	Hidden        bool           `json:"hidden"`
	ID            string         `json:"_id"`
	Icon          string         `json:"icon"`
	IsAPI         bool           `json:"isApi"`
	IsReference   bool           `json:"isReference"`
	LinkExternal  bool           `json:"link_external"`
	LinkURL       string         `json:"link_url"`
	Metadata      DocMetadata    `json:"metadata"`
	Next          DocNext        `json:"next"`
	Order         int            `json:"order"`
	ParentDoc     string         `json:"parentDoc"`
	PreviousSlug  string         `json:"previousSlug"`
	Project       string         `json:"project,omitempty"`
	Revision      int            `json:"revision"`
	Slug          string         `json:"slug"`
	SlugUpdatedAt string         `json:"slugUpdatedAt"`
	Swagger       DocSwagger     `json:"swagger"`
	SyncUnique    string         `json:"sync_unique"`
	Title         string         `json:"title"`
	Type          string         `json:"type"`
	UpdatedAt     string         `json:"updatedAt"`
	// TODO: Verify the data structure and type.
	Updates []any  `json:"updates"`
	User    string `json:"user"`
	Version string `json:"version"`
}

type DocAPI struct {
	APISetting string         `json:"apiSetting"`
	Auth       string         `json:"auth"`
	Examples   DocAPIExamples `json:"examples"`
	Method     string         `json:"method"`
	Params     []DocAPIParams `json:"params"`
	Results    DocAPIResults  `json:"results"`
	URL        string         `json:"url"`
}

type DocAPIExamples struct {
	Codes []DocAPIExamplesCodes `json:"codes"`
}

type DocAPIExamplesCodes struct {
	Code     string `json:"code"`
	Language string `json:"language"`
}

type DocAPIParams struct {
	Default    string `json:"default"`
	Desc       string `json:"desc"`
	EnumValues string `json:"enumValues"`
	ID         string `json:"_id"`
	In         string `json:"in"`
	Name       string `json:"name"`
	Ref        string `json:"ref"`
	Required   bool   `json:"required"`
	Type       string `json:"type"`
}

type DocAPIResults struct {
	Codes []DocAPIResultsCodes `json:"codes"`
}

type DocAPIResultsCodes struct {
	Code     string `json:"code"`
	Language string `json:"language"`
	Name     string `json:"name"`
	Status   int    `json:"status"`
}

type DocAlgolia struct {
	PublishPending bool   `json:"publishPending"`
	RecordCount    int    `json:"recordCount"`
	UpdatedAt      string `json:"updatedAt"`
}

type DocClient struct {
	// contains filtered or unexported fields
}

type DocErrorObject struct {
	Code string `json:"code"`
}

type DocMetadata struct {
	Description string `json:"description"`
	Image       []any  `json:"image"`
	Title       string `json:"title"`
}

type DocNext struct {
	Description string         `json:"description"`
	Pages       []DocNextPages `json:"pages"`
}

type DocNextPages struct {
	Category   string `json:"category"`
	Deprecated bool   `json:"deprecated"`
	Icon       string `json:"icon"`
	Name       string `json:"name"`
	Slug       string `json:"slug"`
	Type       string `json:"type"`
}

type DocParams struct {
	// Body content of the page, formatted in ReadMe or GitHub flavored Markdown. Accepts long page
	// content, for example, greater than 100k characters.
	Body string `json:"body,omitempty"`
	// Category ID of the page.
	// This is or 'CategorySlug' is *required* when creating or updating a category.
	Category string `json:"category"`
	// Category Slug of the page.
	// This is or 'Category' is *required* when creating or updating a category.
	CategorySlug string `json:"categorySlug"`
	// Error is an error code for docs with the type set to "error".
	Error DocErrorObject `json:"error,omitempty"`
	// Hidden toggles visibility for the doc.
	// API default is true.
	Hidden *bool `json:"hidden"`
	// Order sets the position of the page in the project sidebar.
	// API default is 999.
	Order *int `json:"order"`
	// ParentDoc is the ID of the parent doc for subpages.
	ParentDoc string `json:"parentDoc,omitempty"`
	// ParentDocSlug is the slug of the parent doc for subpages.
	// This field is an alternative to the ParentDoc field.
	ParentDocSlug string `json:"parentDocSlug,omitempty"`
	// Title of the page.
	// This is *required* when creating or updating a category.
	Title string `json:"title"`
	// Type of the page. The available types all show up under the /docs/ URL path of your docs
	// project (also known as the "guides" section). Can be "basic" (most common), "error" (page
	// desribing an API error), or "link" (page that redirects to an external link).
	Type string `json:"type,omitempty"`
}

type DocSearchResult struct {
	HighlightResult DocSearchResultHighlight `json:"_highlightResult"`
	IndexName       string                   `json:"indexName"`
	InternalLink    string                   `json:"internalLink"`
	IsReference     bool                     `json:"isReference"`
	LinkURL         string                   `json:"link_url"`
	Method          string                   `json:"method"`
	ObjectID        string                   `json:"objectID"`
	Project         string                   `json:"project"`
	ReferenceID     string                   `json:"referenceId"`
	Slug            string                   `json:"slug"`
	SnippetResult   DocSearchResultSnippet   `json:"_snippetResult"`
	Subdomain       string                   `json:"subdomain"`
	Title           string                   `json:"title"`
	Type            string                   `json:"type"`
	URL             string                   `json:"url"`
	Version         string                   `json:"version"`
}

type DocSearchResultHighlight struct {
	Title   DocSearchResultHighlightValue `json:"title"`
	Excerpt DocSearchResultHighlightValue `json:"excerpt"`
	Body    DocSearchResultHighlightValue `json:"body"`
}

type DocSearchResultHighlightValue struct {
	Value        string   `json:"value"`
	MatchLevel   string   `json:"matchLevel"`
	MatchedWords []string `json:"matchedWords"`
}

type DocSearchResultSnippet struct {
	Title   DocSearchResultSnippetValue `json:"title"`
	Excerpt DocSearchResultSnippetValue `json:"excerpt"`
	Body    DocSearchResultSnippetValue `json:"body"`
}

type DocSearchResultSnippetValue struct {
	Value      string `json:"value"`
	MatchLevel string `json:"matchLevel"`
}

type DocSearchResults struct {
	Results []DocSearchResult `json:"results"`
}

type DocService interface {
	// Create a new doc in ReadMe.
	//
	// API Reference: https://docs.readme.com/main/reference/createdoc
	Create(params DocParams, options ...RequestOptions) (Doc, *APIResponse, error)

	// Delete a doc in ReadMe.
	//
	// API Reference: https://docs.readme.com/reference/deletedoc
	Delete(slug string, options ...RequestOptions) (bool, *APIResponse, error)

	// Get a doc from ReadMe.
	//
	// The `doc` parameter may be a slug or doc ID prefixed with "id:".
	// The slug is preferred, since it's a more direct request while the ID requires
	// iterating over the search results for the matching ID.
	//
	// Use the `options` parameter to set `RequestOptions.ProductionDoc` to retrieve a production doc.
	//
	// API References:
	//   - https://docs.readme.com/main/reference/getdoc
	//   - https://docs.readme.com/main/reference/getproductiondoc
	Get(doc string, options ...RequestOptions) (Doc, *APIResponse, error)

	// Search for docs that match the search query parameter.
	//
	// API Reference: https://docs.readme.com/main/reference/searchdocs
	Search(query string, options ...RequestOptions) ([]DocSearchResult, *APIResponse, error)

	// Update an existing doc in ReadMe.
	//
	// API Reference: https://docs.readme.com/main/reference/updatedoc
	Update(slug string, params DocParams, options ...RequestOptions) (Doc, *APIResponse, error)
}

type DocSwagger struct {
	Path string `json:"path"`
}

type DocUser struct {
	ID string `json:"_id"`
}

type Image struct {
	URL      string
	Filename string
	Width    int64
	Height   int64
	Color    string
}

type ImageClient struct {
	// contains filtered or unexported fields
}

type ImageService interface {
	// Upload an image to ReadMe.
	Upload(source []byte, filename ...string) (Image, *APIResponse, error)
}

type OpenRole struct {
	Department  string `json:"department"`
	Description string `json:"description"`
	Location    string `json:"location"`
	Pullquote   string `json:"pullquote"`
	Slug        string `json:"slug"`
	Title       string `json:"title"`
	URL         string `json:"url"`
}

type OutboundIP struct {
	IPAddress string `json:"ipAddress"`
}

type OutboundIPClient struct {
	// contains filtered or unexported fields
}

type OutboundIPService interface {
	// Get all of ReadMe’s IP addresses used for outbound webhook requests and the “Try It!” button on the API Explorer.
	//
	// Although ReadMe’s outbound IP addresses may change, the IPs in this API
	// response will be valid for at least 7 days. If you configure your API or
	// webhooks to limit access based on these IPs, you should refresh the IP list
	// from this endpoint weekly.
	//
	// API Reference: https://docs.readme.com/main/reference/getoutboundips
	Get() ([]OutboundIP, *APIResponse, error)
}

type Project struct {
	// BaseURL is the base URL for the project. If the project is not running under a custom domain,
	// it will be https://projectSubdomain.readme.io, otherwise it can either be https://example.com
	// or, in the case of an enterprise child project https://example.com/projectSubdomain.
	BaseURL string `json:"baseUrl"`
	// JWTSecret is the JSON Web Token used for the project.
	JWTSecret string `json:"jwtSecret"`
	// Name of the project.
	Name string `json:"name"`
	// Plan is the subscription plan of the project on ReadMe.
	Plan string `json:"plan"`
	// SubDomain for the project on ReadMe.com.
	SubDomain string `json:"subdomain"`
}

type ProjectClient struct {
	// contains filtered or unexported fields
}

type ProjectService interface {
	// Get retrieves project metadata from the ReadMe.com API.
	//
	// API Reference: https://docs.readme.com/main/reference/getproject
	Get() (Project, *APIResponse, error)
}

type RequestHeader map[string]string

type RequestOptions struct {
	// Headers is a list of additional headers to add to the request.
	Headers []RequestHeader
	// PerPage is the number of items to return in each request when using pagination.
	// The maximum and default is 100.
	PerPage int
	// Page is the page number to request when using pagination.
	Page int
	// ProductionDoc is used by readme.Docs.Get() to indicate whether the requested document is a
	// 'production' doc.
	ProductionDoc bool
	// Version number of a ReadMe project, for example, v3.0. By default the main project version is used.
	Version string
}

type Version struct {
	Categories   []string `json:"categories"`
	Codename     string   `json:"codename"`
	CreatedAt    string   `json:"createdAt"`
	ForkedFrom   string   `json:"forked_from"`
	ID           string   `json:"_id"`
	IsBeta       bool     `json:"is_beta"`
	IsDeprecated bool     `json:"is_deprecated"`
	IsHidden     bool     `json:"is_hidden"`
	IsStable     bool     `json:"is_stable"`
	Project      string   `json:"project"`
	ReleaseDate  string   `json:"releaseDate"`
	Version      string   `json:"version"`
	VersionClean string   `json:"version_clean"`
}

type VersionClient struct {
	// contains filtered or unexported fields
}

type VersionParams struct {
	// Codename is the dubbed name of version.
	Codename string `json:"codename,omitempty"`
	// From is the semantic Version to use as the base fork.
	// This is *required* when creating or updating a version.
	From string `json:"from"`
	// IsBeta toggles whether the version is a beta release.
	// API default is `false`.
	IsBeta *bool `json:"is_beta"`
	// IsDeprecated toggles whether the version is deprecated. Only allowed when updating.
	// API default is `false`.
	IsDeprecated *bool `json:"is_deprecated"`
	// IsHidden toggles public accessibility.
	// API default is `false`.
	IsHidden *bool `json:"is_hidden"`
	// IsStable toggles whether the version should be the project's main version.
	// API default is `false`.
	IsStable *bool `json:"is_stable"`
	// Version is the number.
	// This is *required* when creating or updating a version.
	Version string `json:"version"`
}

type VersionService interface {
	// Create a new version within a project.
	//
	// API Reference: https://docs.readme.com/main/reference/createversion
	Create(prams VersionParams) (Version, *APIResponse, error)

	// Delete a version.
	//
	// The version may be provided using either the semver identifier for the project version
	// ('1.0.0') or an API ID for the version prefixed with 'id' ('id:63ac899d11c4680047ec5970').
	//
	// When using the semantic version identifier, use the formatted VersionClean value listed in
	// the response from the GetAll() function for best results.
	//
	// API Reference: https://docs.readme.com/main/reference/deleteversion
	Delete(version string) (bool, *APIResponse, error)

	// Get a single version.
	//
	// The version may be provided using either the semver identifier for the project version
	// ('1.0.0') or an API ID for the version prefixed with 'id' ('id:63ac899d11c4680047ec5970').
	//
	// When using the semantic version identifier, use the formatted VersionClean value listed in
	// the response from the GetAll() function for best results.
	//
	// API Reference: https://docs.readme.com/main/reference/getversion
	Get(version string) (Version, *APIResponse, error)

	// GetAll retrieves a list of versions associated with an API key.
	//
	// API Reference: https://docs.readme.com/main/reference/getversions
	GetAll() ([]VersionSummary, *APIResponse, error)

	// Update an existing version.
	//
	// The version may be provided using either the semver identifier for the project version
	// ('1.0.0') or an API ID for the version prefixed with 'id' ('id:63ac899d11c4680047ec5970').
	//
	// When using the semantic version identifier, use the formatted VersionClean value listed in
	// the response from the GetAll() function for best results.
	//
	// API Reference: https://docs.readme.com/main/reference/updateversion
	Update(version string, params VersionParams) (Version, *APIResponse, error)

	// GetVersion parses a provided string to determine if it it's a semantic version identifier (1.0.0)
	// or an API version identifier (id:63ac899d11c4680047ec5970). If it's an API version identifier,
	// the value is compared with the results from GetAll() to return the semantic version that's used
	// for API requests. If the specified version is already a semantic version string, it will be
	// returned as-is.
	GetVersion(version string) (string, error)
}

type VersionSummary struct {
	Codename     string `json:"codename"`
	CreatedAt    string `json:"createdAt"`
	ForkedFrom   string `json:"forked_from"`
	ID           string `json:"_id"`
	IsBeta       bool   `json:"is_beta"`
	IsDeprecated bool   `json:"is_deprecated"`
	IsHidden     bool   `json:"is_hidden"`
	IsStable     bool   `json:"is_stable"`
	Version      string `json:"version"`
	VersionClean string `json:"version_clean"`
}