Categorygithub.com/dashotv/tmdbopenapi
package
0.2.0
Repository: https://github.com/dashotv/tmdb.git
Documentation: pkg.go.dev
Overview
Versions
1
Dependencies
12
Dependents
1
Files
9.4k SLOC

# README

github.com/dashotv/tmdb/openapi

🏗 Welcome to your new SDK! 🏗

It has been generated successfully based on your OpenAPI spec. However, it is not yet ready for production use. Here are some next steps:

SDK Installation

go get github.com/dashotv/tmdb/openapi

SDK Example Usage

package main

import (
	"context"
	"github.com/dashotv/tmdb/openapi"
	"github.com/dashotv/tmdb/openapi/models/operations"
	"github.com/dashotv/tmdb/openapi/models/shared"
	"log"
)

func main() {
	s := openapi.New(
		openapi.WithSecurity(""),
	)

	var accountID int = 959345

	requestBody := &operations.AccountAddFavoriteRequestBody{
		RawBody: "{key: 16540, key1: null, key2: \"string\"}",
	}

	var sessionID *string = "string"

	ctx := context.Background()
	res, err := s.SDK.AccountAddFavorite(ctx, accountID, requestBody, sessionID)
	if err != nil {
		log.Fatal(err)
	}

	if res.AccountAddFavorite200ApplicationJSONObject != nil {
		// handle response
	}
}

Available Resources and Operations

SDK

Error Handling

Handling errors in your SDK should largely match your expectations. All operations return a response object or an error, they will never return both. When specified by the OpenAPI spec document, the SDK will return the appropriate subclass.

Server Selection

Select Server by Index

You can override the default server globally using the WithServerIndex option when initializing the SDK client instance. The selected server will then be used as the default on the operations that use it. This table lists the indexes associated with the available servers:

#ServerVariables
0https://api.themoviedb.orgNone

For example:

package main

import (
	"context"
	"github.com/dashotv/tmdb/openapi"
	"github.com/dashotv/tmdb/openapi/models/operations"
	"github.com/dashotv/tmdb/openapi/models/shared"
	"log"
)

func main() {
	s := openapi.New(
		openapi.WithSecurity(""),
		openapi.WithServerIndex(0),
	)

	var accountID int = 959345

	requestBody := &operations.AccountAddFavoriteRequestBody{
		RawBody: "{key: 16540, key1: null, key2: \"string\"}",
	}

	var sessionID *string = "string"

	ctx := context.Background()
	res, err := s.SDK.AccountAddFavorite(ctx, accountID, requestBody, sessionID)
	if err != nil {
		log.Fatal(err)
	}

	if res.AccountAddFavorite200ApplicationJSONObject != nil {
		// handle response
	}
}

Override Server URL Per-Client

The default server can also be overridden globally using the WithServerURL option when initializing the SDK client instance. For example:

package main

import (
	"context"
	"github.com/dashotv/tmdb/openapi"
	"github.com/dashotv/tmdb/openapi/models/operations"
	"github.com/dashotv/tmdb/openapi/models/shared"
	"log"
)

func main() {
	s := openapi.New(
		openapi.WithSecurity(""),
		openapi.WithServerURL("https://api.themoviedb.org"),
	)

	var accountID int = 959345

	requestBody := &operations.AccountAddFavoriteRequestBody{
		RawBody: "{key: 16540, key1: null, key2: \"string\"}",
	}

	var sessionID *string = "string"

	ctx := context.Background()
	res, err := s.SDK.AccountAddFavorite(ctx, accountID, requestBody, sessionID)
	if err != nil {
		log.Fatal(err)
	}

	if res.AccountAddFavorite200ApplicationJSONObject != nil {
		// handle response
	}
}

Custom HTTP Client

The Go SDK makes API calls that wrap an internal HTTP client. The requirements for the HTTP client are very simple. It must match this interface:

type HTTPClient interface {
	Do(req *http.Request) (*http.Response, error)
}

The built-in net/http client satisfies this interface and a default client based on the built-in is provided by default. To replace this default with a client of your own, you can implement this interface yourself or provide your own client configured as desired. Here's a simple example, which adds a client with a 30 second timeout.

import (
	"net/http"
	"time"
	"github.com/myorg/your-go-sdk"
)

var (
	httpClient = &http.Client{Timeout: 30 * time.Second}
	sdkClient  = sdk.New(sdk.WithClient(httpClient))
)

This can be a convenient way to configure timeouts, cookies, proxies, custom headers, and other low-level configuration.

Special Types

This SDK defines the following custom types to assist with marshalling and unmarshalling data.

Date

types.Date is a wrapper around time.Time that allows for JSON marshaling a date string formatted as "2006-01-02".

Usage

d1 := types.NewDate(time.Now()) // returns *types.Date

d2 := types.DateFromTime(time.Now()) // returns types.Date

d3, err := types.NewDateFromString("2019-01-01") // returns *types.Date, error

d4, err := types.DateFromString("2019-01-01") // returns types.Date, error

d5 := types.MustNewDateFromString("2019-01-01") // returns *types.Date and panics on error

d6 := types.MustDateFromString("2019-01-01") // returns types.Date and panics on error

Development

Maturity

This SDK is in beta, and there may be breaking changes between versions without a major version update. Therefore, we recommend pinning usage to a specific package version. This way, you can install the same version each time without breaking changes unless you are intentionally looking for the latest version.

Contributions

While we value open-source contributions to this SDK, this library is generated programmatically. Feel free to open a PR or a Github issue as a proof of concept and we'll do our best to include it in a future release!

SDK Created by Speakeasy

# Packages

No description provided by the author
No description provided by the author
No description provided by the author

# Functions

Bool provides a helper function to return a pointer to a bool.
Float32 provides a helper function to return a pointer to a float32.
Float64 provides a helper function to return a pointer to a float64.
Int provides a helper function to return a pointer to an int.
Int64 provides a helper function to return a pointer to an int64.
New creates a new instance of the SDK with the provided options.
String provides a helper function to return a pointer to a string.
WithClient allows the overriding of the default HTTP client used by the SDK.
No description provided by the author
No description provided by the author
WithServerIndex allows the overriding of the default server by index.
WithServerURL allows the overriding of the default server URL.
WithTemplatedServerURL allows the overriding of the default server URL with a templated URL populated with the provided parameters.

# Variables

ServerList contains the list of servers available to the SDK.

# Structs

No description provided by the author

# Interfaces

HTTPClient provides an interface for suplying the SDK with a custom HTTP client.

# Type aliases

No description provided by the author