xapiscraper.go

// Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.

package xapiscraper

// Generated from OpenAPI doc version 1.0.0 and generator version 2.932.9

import (
	"context"
	"fmt"
	"github.com/twexapi-dev/x-api-scraper-go/internal/config"
	"github.com/twexapi-dev/x-api-scraper-go/internal/hooks"
	"github.com/twexapi-dev/x-api-scraper-go/internal/utils"
	"github.com/twexapi-dev/x-api-scraper-go/models/components"
	"github.com/twexapi-dev/x-api-scraper-go/retry"
	"net/http"
	"time"
)

const (
	// TwexAPI production API
	ServerProduction string = "production"
)

// ServerList contains the list of servers available to the SDK
var ServerList = map[string]string{
	ServerProduction: "https://api.twexapi.io",
}

// HTTPClient provides an interface for supplying the SDK with a custom HTTP client
type HTTPClient interface {
	Do(req *http.Request) (*http.Response, error)
}

// String provides a helper function to return a pointer to a string
func String(s string) *string { return &s }

// Bool provides a helper function to return a pointer to a bool
func Bool(b bool) *bool { return &b }

// Int provides a helper function to return a pointer to an int
func Int(i int) *int { return &i }

// Int64 provides a helper function to return a pointer to an int64
func Int64(i int64) *int64 { return &i }

// Float32 provides a helper function to return a pointer to a float32
func Float32(f float32) *float32 { return &f }

// Float64 provides a helper function to return a pointer to a float64
func Float64(f float64) *float64 { return &f }

// Pointer provides a helper function to return a pointer to a type
func Pointer[T any](v T) *T { return &v }

// XapiScraper - X API Scraper: Speakeasy-ready OpenAPI document for the x-api-scraper TypeScript SDK.
//
// The SDK wraps TwexAPI's X/Twitter API surface with bearer-token authentication.
// Cookie/proxy based endpoints are excluded except tweet actions, follow/unfollow, and v3 DM operations.
// Profile mutation, legacy-only operations, and non-v3 follower/following endpoints remain excluded.
//
// Not affiliated with X Corp.
type XapiScraper struct {
	SDKVersion  string
	Search      *Search
	Tweets      *Tweets
	Users       *Users
	Analysis    *Analysis
	Dm          *Dm
	Articles    *Articles
	Communities *Communities
	Lists       *Lists
	Trending    *Trending
	Timelines   *Timelines
	Account     *Account

	sdkConfiguration config.SDKConfiguration
	hooks            *hooks.Hooks
}

type SDKOption func(*XapiScraper)

// WithServerURL allows providing an alternative server URL
func WithServerURL(serverURL string) SDKOption {
	return func(sdk *XapiScraper) {
		sdk.sdkConfiguration.ServerURL = serverURL
	}
}

// WithTemplatedServerURL allows the overriding of the default server URL with a templated URL populated with the provided parameters
func WithTemplatedServerURL(serverURL string, params map[string]string) SDKOption {
	return func(sdk *XapiScraper) {
		if params != nil {
			serverURL = utils.ReplaceParameters(serverURL, params)
		}

		sdk.sdkConfiguration.ServerURL = serverURL
	}
}

// WithServer allows the overriding of the default server by name
func WithServer(server string) SDKOption {
	return func(sdk *XapiScraper) {
		_, ok := ServerList[server]
		if !ok {
			panic(fmt.Errorf("server %s not found", server))
		}

		sdk.sdkConfiguration.Server = server
	}
}

// WithClient allows the overriding of the default HTTP client used by the SDK
func WithClient(client HTTPClient) SDKOption {
	return func(sdk *XapiScraper) {
		sdk.sdkConfiguration.Client = client
	}
}

// WithSecurity configures the SDK to use the provided security details
func WithSecurity(bearerAuth string) SDKOption {
	return func(sdk *XapiScraper) {
		security := components.Security{BearerAuth: &bearerAuth}
		sdk.sdkConfiguration.Security = utils.AsSecuritySource(&security)
	}
}

// WithSecuritySource configures the SDK to invoke the Security Source function on each method call to determine authentication
func WithSecuritySource(security func(context.Context) (components.Security, error)) SDKOption {
	return func(sdk *XapiScraper) {
		sdk.sdkConfiguration.Security = func(ctx context.Context) (interface{}, error) {
			return security(ctx)
		}
	}
}

func WithRetryConfig(retryConfig retry.Config) SDKOption {
	return func(sdk *XapiScraper) {
		sdk.sdkConfiguration.RetryConfig = &retryConfig
	}
}

// WithTimeout Optional request timeout applied to each operation
func WithTimeout(timeout time.Duration) SDKOption {
	return func(sdk *XapiScraper) {
		sdk.sdkConfiguration.Timeout = &timeout
	}
}

// New creates a new instance of the SDK with the provided options
func New(opts ...SDKOption) *XapiScraper {
	sdk := &XapiScraper{
		SDKVersion: "0.1.0",
		sdkConfiguration: config.SDKConfiguration{
			UserAgent:  "speakeasy-sdk/go 0.1.0 2.932.9 1.0.0 github.com/twexapi-dev/x-api-scraper-go",
			ServerList: ServerList,
		},
		hooks: hooks.New(),
	}
	for _, opt := range opts {
		opt(sdk)
	}

	if sdk.sdkConfiguration.Security == nil {
		var envVarSecurity components.Security
		if utils.PopulateSecurityFromEnv(&envVarSecurity) {
			sdk.sdkConfiguration.Security = utils.AsSecuritySource(envVarSecurity)
		}
	}

	// Use WithClient to override the default client if you would like to customize the timeout
	if sdk.sdkConfiguration.Client == nil {
		sdk.sdkConfiguration.Client = &http.Client{Timeout: 60 * time.Second}
	}

	sdk.sdkConfiguration = sdk.hooks.SDKInit(sdk.sdkConfiguration)

	sdk.Search = newSearch(sdk, sdk.sdkConfiguration, sdk.hooks)
	sdk.Tweets = newTweets(sdk, sdk.sdkConfiguration, sdk.hooks)
	sdk.Users = newUsers(sdk, sdk.sdkConfiguration, sdk.hooks)
	sdk.Analysis = newAnalysis(sdk, sdk.sdkConfiguration, sdk.hooks)
	sdk.Dm = newDm(sdk, sdk.sdkConfiguration, sdk.hooks)
	sdk.Articles = newArticles(sdk, sdk.sdkConfiguration, sdk.hooks)
	sdk.Communities = newCommunities(sdk, sdk.sdkConfiguration, sdk.hooks)
	sdk.Lists = newLists(sdk, sdk.sdkConfiguration, sdk.hooks)
	sdk.Trending = newTrending(sdk, sdk.sdkConfiguration, sdk.hooks)
	sdk.Timelines = newTimelines(sdk, sdk.sdkConfiguration, sdk.hooks)
	sdk.Account = newAccount(sdk, sdk.sdkConfiguration, sdk.hooks)

	return sdk
}