externalapikey.go

// File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.

package lilypadsdk

import (
	"context"
	"errors"
	"fmt"
	"net/http"

	"github.com/stainless-sdks/lilypad-sdk-go/internal/apijson"
	"github.com/stainless-sdks/lilypad-sdk-go/internal/requestconfig"
	"github.com/stainless-sdks/lilypad-sdk-go/option"
	"github.com/stainless-sdks/lilypad-sdk-go/packages/param"
	"github.com/stainless-sdks/lilypad-sdk-go/packages/resp"
)

// ExternalAPIKeyService contains methods and other services that help with
// interacting with the lilypad API.
//
// Note, unlike clients, this service does not read variables from the environment
// automatically. You should not instantiate this service directly, and instead use
// the [NewExternalAPIKeyService] method instead.
type ExternalAPIKeyService struct {
	Options []option.RequestOption
}

// NewExternalAPIKeyService generates a new service that applies the given options
// to each request. These options are applied after the parent client's options (if
// there is one), and before any request-specific options.
func NewExternalAPIKeyService(opts ...option.RequestOption) (r ExternalAPIKeyService) {
	r = ExternalAPIKeyService{}
	r.Options = opts
	return
}

// Store an external API key for a given service.
func (r *ExternalAPIKeyService) New(ctx context.Context, body ExternalAPIKeyNewParams, opts ...option.RequestOption) (res *ExternalAPIKeyPublic, err error) {
	opts = append(r.Options[:], opts...)
	path := "external-api-keys"
	err = requestconfig.ExecuteNewRequest(ctx, http.MethodPost, path, body, &res, opts...)
	return
}

// Retrieve an external API key for a given service.
func (r *ExternalAPIKeyService) Get(ctx context.Context, serviceName string, opts ...option.RequestOption) (res *ExternalAPIKeyPublic, err error) {
	opts = append(r.Options[:], opts...)
	if serviceName == "" {
		err = errors.New("missing required service_name parameter")
		return
	}
	path := fmt.Sprintf("external-api-keys/%s", serviceName)
	err = requestconfig.ExecuteNewRequest(ctx, http.MethodGet, path, nil, &res, opts...)
	return
}

// Update users keys.
func (r *ExternalAPIKeyService) Update(ctx context.Context, serviceName string, body ExternalAPIKeyUpdateParams, opts ...option.RequestOption) (res *ExternalAPIKeyPublic, err error) {
	opts = append(r.Options[:], opts...)
	if serviceName == "" {
		err = errors.New("missing required service_name parameter")
		return
	}
	path := fmt.Sprintf("external-api-keys/%s", serviceName)
	err = requestconfig.ExecuteNewRequest(ctx, http.MethodPatch, path, body, &res, opts...)
	return
}

// List all external API keys for the user with masked values.
func (r *ExternalAPIKeyService) List(ctx context.Context, opts ...option.RequestOption) (res *[]ExternalAPIKeyPublic, err error) {
	opts = append(r.Options[:], opts...)
	path := "external-api-keys"
	err = requestconfig.ExecuteNewRequest(ctx, http.MethodGet, path, nil, &res, opts...)
	return
}

// Delete an external API key for a given service.
func (r *ExternalAPIKeyService) Delete(ctx context.Context, serviceName string, opts ...option.RequestOption) (res *bool, err error) {
	opts = append(r.Options[:], opts...)
	if serviceName == "" {
		err = errors.New("missing required service_name parameter")
		return
	}
	path := fmt.Sprintf("external-api-keys/%s", serviceName)
	err = requestconfig.ExecuteNewRequest(ctx, http.MethodDelete, path, nil, &res, opts...)
	return
}

// Response model for a secret.
type ExternalAPIKeyPublic struct {
	// Partially masked API key
	MaskedAPIKey string `json:"masked_api_key,required"`
	ServiceName  string `json:"service_name,required"`
	// Metadata for the response, check the presence of optional fields with the
	// [resp.Field.IsPresent] method.
	JSON struct {
		MaskedAPIKey resp.Field
		ServiceName  resp.Field
		ExtraFields  map[string]resp.Field
		raw          string
	} `json:"-"`
}

// Returns the unmodified JSON received from the API
func (r ExternalAPIKeyPublic) RawJSON() string { return r.JSON.raw }
func (r *ExternalAPIKeyPublic) UnmarshalJSON(data []byte) error {
	return apijson.UnmarshalRoot(data, r)
}

type ExternalAPIKeyNewParams struct {
	// New API key
	APIKey      string `json:"api_key,required"`
	ServiceName string `json:"service_name,required"`
	paramObj
}

// IsPresent returns true if the field's value is not omitted and not the JSON
// "null". To check if this field is omitted, use [param.IsOmitted].
func (f ExternalAPIKeyNewParams) IsPresent() bool { return !param.IsOmitted(f) && !f.IsNull() }

func (r ExternalAPIKeyNewParams) MarshalJSON() (data []byte, err error) {
	type shadow ExternalAPIKeyNewParams
	return param.MarshalObject(r, (*shadow)(&r))
}

type ExternalAPIKeyUpdateParams struct {
	// New API key
	APIKey string `json:"api_key,required"`
	paramObj
}

// IsPresent returns true if the field's value is not omitted and not the JSON
// "null". To check if this field is omitted, use [param.IsOmitted].
func (f ExternalAPIKeyUpdateParams) IsPresent() bool { return !param.IsOmitted(f) && !f.IsNull() }

func (r ExternalAPIKeyUpdateParams) MarshalJSON() (data []byte, err error) {
	type shadow ExternalAPIKeyUpdateParams
	return param.MarshalObject(r, (*shadow)(&r))
}