project

Documentation

Overview

Package project provides a client for the Doppler API's project endpoints.

API-Docs: https://docs.doppler.com/reference/project-object

Example:

// Fetch a list of projects.
list, _, err := project.List(context.Background(), nil)
if err != nil {
	log.Fatal(err)
}

// Print the list of projects.
fmt.Printf("%+v", list)

Index

• func Create(ctx context.Context, opts *doppler.ProjectCreateOptions) (*doppler.Project, doppler.APIResponse, error)
• func Delete(ctx context.Context, opts *doppler.ProjectDeleteOptions) (doppler.APIResponse, error)
• func Get(ctx context.Context, opts *doppler.ProjectGetOptions) (*doppler.Project, doppler.APIResponse, error)
• func List(ctx context.Context, opts *doppler.ProjectListOptions) ([]*doppler.Project, doppler.APIResponse, error)
• func Update(ctx context.Context, project *doppler.ProjectUpdateOptions) (*doppler.Project, doppler.APIResponse, error)
• type Client
  • func Default() *Client
  • func (c Client) Create(ctx context.Context, opts *doppler.ProjectCreateOptions) (*doppler.Project, doppler.APIResponse, error)
  • func (c Client) Delete(ctx context.Context, opts *doppler.ProjectDeleteOptions) (doppler.APIResponse, error)
  • func (c Client) Get(ctx context.Context, opts *doppler.ProjectGetOptions) (*doppler.Project, doppler.APIResponse, error)
  • func (c Client) List(ctx context.Context, opts *doppler.ProjectListOptions) ([]*doppler.Project, doppler.APIResponse, error)
  • func (c Client) Update(ctx context.Context, project *doppler.ProjectUpdateOptions) (*doppler.Project, doppler.APIResponse, error)

Functions

func Create

func Create(ctx context.Context, opts *doppler.ProjectCreateOptions) (*doppler.Project, doppler.APIResponse, error)

Create creates a new project using the default client.

func Delete

func Delete(ctx context.Context, opts *doppler.ProjectDeleteOptions) (doppler.APIResponse, error)

Delete deletes an existing project using the default client.

func Get

func Get(ctx context.Context, opts *doppler.ProjectGetOptions) (*doppler.Project, doppler.APIResponse, error)

Get returns a project and its respective info using the default client.

func List

func List(ctx context.Context, opts *doppler.ProjectListOptions) ([]*doppler.Project, doppler.APIResponse, error)

List returns a list of projects using the default client.

func Update

func Update(ctx context.Context, project *doppler.ProjectUpdateOptions) (*doppler.Project, doppler.APIResponse, error)

Update updates an existing project using the default client.

Types

type Client

type Client struct {
	Backend doppler.Backend
	Key     string
}

Client is the client used to invoke /v3/projects APIs.

func Default

func Default() *Client

Default returns a new client based on the SDK's default backend and API key.

func (Client) Create

func (c Client) Create(ctx context.Context, opts *doppler.ProjectCreateOptions) (*doppler.Project, doppler.APIResponse, error)

Create creates a new project.

func (Client) Delete

func (c Client) Delete(ctx context.Context, opts *doppler.ProjectDeleteOptions) (doppler.APIResponse, error)

Delete deletes an existing project.

func (Client) Get

func (c Client) Get(ctx context.Context, opts *doppler.ProjectGetOptions) (*doppler.Project, doppler.APIResponse, error)

Get returns a project and its respective info.

func (Client) List

func (c Client) List(ctx context.Context, opts *doppler.ProjectListOptions) ([]*doppler.Project, doppler.APIResponse, error)

List returns a list of projects.

func (Client) Update

func (c Client) Update(ctx context.Context, project *doppler.ProjectUpdateOptions) (*doppler.Project, doppler.APIResponse, error)

Update updates an existing project.