schedo

package module
v0.1.0-alpha.4 Latest Latest
Warning

This package is not in the latest version of its module.

 Go to latest Published: Mar 30, 2025 License: Apache-2.0 Imports: 12 Imported by: 1

README

Schedo Go API Library

Go Reference

The Schedo Go library provides convenient access to the Schedo REST API from applications written in Go. The full API of this library can be found in api.md.

It is generated with Stainless.

Installation

import (
	"github.com/useschedo/golang-sdk" // imported as schedo
)

Or to pin the version:

go get -u 'github.com/useschedo/golang-sdk@v0.1.0-alpha.4'

Requirements

This library requires Go 1.18+.

Usage

The full API of this library can be found in api.md.

package main

import (
	"context"
	"fmt"

	"github.com/useschedo/golang-sdk"
	"github.com/useschedo/golang-sdk/option"
)

func main() {
	client := schedo.NewClient(
		option.WithAPIKey("My API Key"), // defaults to os.LookupEnv("SCHEDO_API_KEY")
	)
	apiKey, err := client.Apikeys.New(context.TODO(), schedo.ApikeyNewParams{
		EnvironmentID: schedo.F(int64(1)),
		Name:          schedo.F("First ApiKey"),
	})
	if err != nil {
		panic(err.Error())
	}
	fmt.Printf("%+v\n", apiKey.ID)
}
Request fields

All request parameters are wrapped in a generic Field type, which we use to distinguish zero values from null or omitted fields.

This prevents accidentally sending a zero value if you forget a required parameter, and enables explicitly sending null, false, '', or 0 on optional parameters. Any field not specified is not sent.

To construct fields with values, use the helpers String(), Int(), Float(), or most commonly, the generic F[T](). To send a null, use Null[T](), and to send a nonconforming value, use Raw[T](any). For example:

params := FooParams{
	Name: schedo.F("hello"),

	// Explicitly send `"description": null`
	Description: schedo.Null[string](),

	Point: schedo.F(schedo.Point{
		X: schedo.Int(0),
		Y: schedo.Int(1),

		// In cases where the API specifies a given type,
		// but you want to send something else, use `Raw`:
		Z: schedo.Raw[int64](0.01), // sends a float
	}),
}
Response objects

All fields in response structs are value types (not pointers or wrappers).

If a given field is null, not present, or invalid, the corresponding field will simply be its zero value.

All response structs also include a special JSON field, containing more detailed information about each property, which you can use like so:

if res.Name == "" {
	// true if `"name"` is either not present or explicitly null
	res.JSON.Name.IsNull()

	// true if the `"name"` key was not present in the response JSON at all
	res.JSON.Name.IsMissing()

	// When the API returns data that cannot be coerced to the expected type:
	if res.JSON.Name.IsInvalid() {
		raw := res.JSON.Name.Raw()

		legacyName := struct{
			First string `json:"first"`
			Last  string `json:"last"`
		}{}
		json.Unmarshal([]byte(raw), &legacyName)
		name = legacyName.First + " " + legacyName.Last
	}
}

These .JSON structs also include an Extras map containing any properties in the json response that were not specified in the struct. This can be useful for API features not yet present in the SDK.

body := res.JSON.ExtraFields["my_unexpected_field"].Raw()
RequestOptions

This library uses the functional options pattern. Functions defined in the option package return a RequestOption, which is a closure that mutates a RequestConfig. These options can be supplied to the client or at individual requests. For example:

client := schedo.NewClient(
	// Adds a header to every request made by the client
	option.WithHeader("X-Some-Header", "custom_header_info"),
)

client.Apikeys.New(context.TODO(), ...,
	// Override the header
	option.WithHeader("X-Some-Header", "some_other_custom_header_info"),
	// Add an undocumented field to the request body, using sjson syntax
	option.WithJSONSet("some.json.path", map[string]string{"my": "object"}),
)

See the full list of request options.

Pagination

This library provides some conveniences for working with paginated list endpoints.

You can use .ListAutoPaging() methods to iterate through items across all pages:

Or you can use simple .List() methods to fetch a single page and receive a standard response object with additional helper methods like .GetNextPage(), e.g.:

Errors

When the API returns a non-success status code, we return an error with type *schedo.Error. This contains the StatusCode, *http.Request, and *http.Response values of the request, as well as the JSON of the error body (much like other response objects in the SDK).

To handle errors, we recommend that you use the errors.As pattern:

_, err := client.Apikeys.New(context.TODO(), schedo.ApikeyNewParams{
	EnvironmentID: schedo.F(int64(1)),
	Name:          schedo.F("First ApiKey"),
})
if err != nil {
	var apierr *schedo.Error
	if errors.As(err, &apierr) {
		println(string(apierr.DumpRequest(true)))  // Prints the serialized HTTP request
		println(string(apierr.DumpResponse(true))) // Prints the serialized HTTP response
	}
	panic(err.Error()) // GET "/apikeys": 400 Bad Request { ... }
}

When other errors occur, they are returned unwrapped; for example, if HTTP transport fails, you might receive *url.Error wrapping *net.OpError.

Timeouts

Requests do not time out by default; use context to configure a timeout for a request lifecycle.

Note that if a request is retried, the context timeout does not start over. To set a per-retry timeout, use option.WithRequestTimeout().

// This sets the timeout for the request, including all the retries.
ctx, cancel := context.WithTimeout(context.Background(), 5*time.Minute)
defer cancel()
client.Apikeys.New(
	ctx,
	schedo.ApikeyNewParams{
		EnvironmentID: schedo.F(int64(1)),
		Name:          schedo.F("First ApiKey"),
	},
	// This sets the per-retry timeout
	option.WithRequestTimeout(20*time.Second),
)
File uploads

Request parameters that correspond to file uploads in multipart requests are typed as param.Field[io.Reader]. The contents of the io.Reader will by default be sent as a multipart form part with the file name of "anonymous_file" and content-type of "application/octet-stream".

The file name and content-type can be customized by implementing Name() string or ContentType() string on the run-time type of io.Reader. Note that os.File implements Name() string, so a file returned by os.Open will be sent with the file name on disk.

We also provide a helper schedo.FileParam(reader io.Reader, filename string, contentType string) which can be used to wrap any io.Reader with the appropriate file name and content type.

Retries

Certain errors will be automatically retried 2 times by default, with a short exponential backoff. We retry by default all connection errors, 408 Request Timeout, 409 Conflict, 429 Rate Limit, and >=500 Internal errors.

You can use the WithMaxRetries option to configure or disable this:

// Configure the default for all requests:
client := schedo.NewClient(
	option.WithMaxRetries(0), // default is 2
)

// Override per-request:
client.Apikeys.New(
	context.TODO(),
	schedo.ApikeyNewParams{
		EnvironmentID: schedo.F(int64(1)),
		Name:          schedo.F("First ApiKey"),
	},
	option.WithMaxRetries(5),
)
Accessing raw response data (e.g. response headers)

You can access the raw HTTP response data by using the option.WithResponseInto() request option. This is useful when you need to examine response headers, status codes, or other details.

// Create a variable to store the HTTP response
var response *http.Response
apiKey, err := client.Apikeys.New(
	context.TODO(),
	schedo.ApikeyNewParams{
		EnvironmentID: schedo.F(int64(1)),
		Name:          schedo.F("First ApiKey"),
	},
	option.WithResponseInto(&response),
)
if err != nil {
	// handle error
}
fmt.Printf("%+v\n", apiKey)

fmt.Printf("Status Code: %d\n", response.StatusCode)
fmt.Printf("Headers: %+#v\n", response.Header)
Making custom/undocumented requests

This library is typed for convenient access to the documented API. If you need to access undocumented endpoints, params, or response properties, the library can still be used.

Undocumented endpoints

To make requests to undocumented endpoints, you can use client.Get, client.Post, and other HTTP verbs. RequestOptions on the client, such as retries, will be respected when making these requests.

var (
    // params can be an io.Reader, a []byte, an encoding/json serializable object,
    // or a "…Params" struct defined in this library.
    params map[string]interface{}

    // result can be an []byte, *http.Response, a encoding/json deserializable object,
    // or a model defined in this library.
    result *http.Response
)
err := client.Post(context.Background(), "/unspecified", params, &result)
if err != nil {
    …
}
Undocumented request params

To make requests using undocumented parameters, you may use either the option.WithQuerySet() or the option.WithJSONSet() methods.

params := FooNewParams{
    ID:   schedo.F("id_xxxx"),
    Data: schedo.F(FooNewParamsData{
        FirstName: schedo.F("John"),
    }),
}
client.Foo.New(context.Background(), params, option.WithJSONSet("data.last_name", "Doe"))
Undocumented response properties

To access undocumented response properties, you may either access the raw JSON of the response as a string with result.JSON.RawJSON(), or get the raw JSON of a particular field on the result with result.JSON.Foo.Raw().

Any fields that are not present on the response struct will be saved and can be accessed by result.JSON.ExtraFields() which returns the extra fields as a map[string]Field.

Middleware

We provide option.WithMiddleware which applies the given middleware to requests.

func Logger(req *http.Request, next option.MiddlewareNext) (res *http.Response, err error) {
	// Before the request
	start := time.Now()
	LogReq(req)

	// Forward the request to the next handler
	res, err = next(req)

	// Handle stuff after the request
	end := time.Now()
	LogRes(res, err, start - end)

    return res, err
}

client := schedo.NewClient(
	option.WithMiddleware(Logger),
)

When multiple middlewares are provided as variadic arguments, the middlewares are applied left to right. If option.WithMiddleware is given multiple times, for example first in the client then the method, the middleware in the client will run first and the middleware given in the method will run next.

You may also replace the default http.Client with option.WithHTTPClient(client). Only one http client is accepted (this overwrites any previous client) and receives requests after any middleware has been applied.

Semantic versioning

This package generally follows SemVer conventions, though certain backwards-incompatible changes may be released as minor versions:

  1. Changes to library internals which are technically public but not intended or documented for external use. (Please open a GitHub issue to let us know if you are relying on such internals.)
  2. Changes that we do not expect to impact the vast majority of users in practice.

We take backwards-compatibility seriously and work hard to ensure you can rely on a smooth upgrade experience.

We are keen for your feedback; please open an issue with questions, bugs, or suggestions.

Contributing

See the contributing documentation.

Documentation

Index

Constants

This section is empty.

Variables

This section is empty.

Functions

func Bool 

func Bool(value bool) param.Field[bool]

Bool is a param field helper which helps specify bools.

func DefaultClientOptions 

func DefaultClientOptions() []option.RequestOption

DefaultClientOptions read from the environment (SCHEDO_API_KEY). This should be used to initialize new clients.

func F 

func F[T any](value T) param.Field[T]

F is a param field helper used to initialize a param.Field generic struct. This helps specify null, zero values, and overrides, as well as normal values. You can read more about this in our README.

func FileParam 

func FileParam(reader io.Reader, filename string, contentType string) param.Field[io.Reader]

FileParam is a param field helper which helps files with a mime content-type.

func Float 

func Float(value float64) param.Field[float64]

Float is a param field helper which helps specify floats.

func Int 

func Int(value int64) param.Field[int64]

Int is a param field helper which helps specify integers. This is particularly helpful when specifying integer constants for fields.

func Null 

func Null[T any]() param.Field[T]

Null is a param field helper which explicitly sends null to the API.

func Raw 

func Raw[T any](value any) param.Field[T]

Raw is a param field helper for specifying values for fields when the type you are looking to send is different from the type that is specified in the SDK. For example, if the type of the field is an integer, but you want to send a float, you could do that by setting the corresponding field with Raw[int](0.5).

func String 

func String(value string) param.Field[string]

String is a param field helper which helps specify strings.

Types

type APIKey 

type APIKey struct {
	// ID of the ent.
	ID int64 `json:"id"`
	// CreatedAt holds the value of the "created_at" field.
	CreatedAt string `json:"created_at"`
	// Edges holds the relations/edges for other nodes in the graph. The values are
	// being populated by the ApiKeyQuery when eager-loading is set.
	Edges APIKeyEdges `json:"edges"`
	// EnvironmentID holds the value of the "environment_id" field.
	EnvironmentID int64 `json:"environment_id"`
	// Internal holds the value of the "internal" field.
	Internal bool `json:"internal"`
	// Key holds the value of the "key" field.
	Key string `json:"key"`
	// Name holds the value of the "name" field.
	Name string `json:"name"`
	// OrganizationID holds the value of the "organization_id" field.
	OrganizationID int64 `json:"organization_id"`
	// Revoked holds the value of the "revoked" field.
	Revoked bool       `json:"revoked"`
	JSON    apiKeyJSON `json:"-"`
}

func (*APIKey) UnmarshalJSON 

func (r *APIKey) UnmarshalJSON(data []byte) (err error)

type APIKeyEdges 

type APIKeyEdges = interface{}

type ApikeyNewParams 

type ApikeyNewParams struct {
	EnvironmentID param.Field[int64]  `json:"environment_id,required"`
	Name          param.Field[string] `json:"name,required"`
}

func (ApikeyNewParams) MarshalJSON 

func (r ApikeyNewParams) MarshalJSON() (data []byte, err error)

type ApikeyService 

type ApikeyService struct {
	Options []option.RequestOption
}

ApikeyService contains methods and other services that help with interacting with the Schedo 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 NewApikeyService method instead.

func NewApikeyService 

func NewApikeyService(opts ...option.RequestOption) (r *ApikeyService)

NewApikeyService 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 (*ApikeyService) List 

func (r *ApikeyService) List(ctx context.Context, opts ...option.RequestOption) (res *[][]APIKey, err error)

Returns a list of API Keys for the organization

func (*ApikeyService) New 

func (r *ApikeyService) New(ctx context.Context, body ApikeyNewParams, opts ...option.RequestOption) (res *APIKey, err error)

Generates a new API Key to access Schedo.dev API

func (*ApikeyService) Revoke 

func (r *ApikeyService) Revoke(ctx context.Context, id int64, opts ...option.RequestOption) (res *[][]APIKey, err error)

Revokes an API Key making it inactive

type Client 

type Client struct {
	Options      []option.RequestOption
	Apikeys      *ApikeyService
	Environments *EnvironmentService
	Jobs         *JobService
	JobExecution *JobExecutionService
	Org          *OrgService
}

Client creates a struct with services and top level methods that help with interacting with the Schedo API. You should not instantiate this client directly, and instead use the NewClient method instead.

func NewClient 

func NewClient(opts ...option.RequestOption) (r *Client)

NewClient generates a new client with the default option read from the environment (SCHEDO_API_KEY). The option passed in as arguments are applied after these default arguments, and all option will be passed down to the services and requests that this client makes.

func (*Client) Delete 

func (r *Client) Delete(ctx context.Context, path string, params interface{}, res interface{}, opts ...option.RequestOption) error

Delete makes a DELETE request with the given URL, params, and optionally deserializes to a response. See [Execute] documentation on the params and response.

func (*Client) Execute 

func (r *Client) Execute(ctx context.Context, method string, path string, params interface{}, res interface{}, opts ...option.RequestOption) error

Execute makes a request with the given context, method, URL, request params, response, and request options. This is useful for hitting undocumented endpoints while retaining the base URL, auth, retries, and other options from the client.

If a byte slice or an io.Reader is supplied to params, it will be used as-is for the request body.

The params is by default serialized into the body using encoding/json. If your type implements a MarshalJSON function, it will be used instead to serialize the request. If a URLQuery method is implemented, the returned url.Values will be used as query strings to the url.

If your params struct uses param.Field, you must provide either [MarshalJSON], [URLQuery], and/or [MarshalForm] functions. It is undefined behavior to use a struct uses param.Field without specifying how it is serialized.

Any "…Params" object defined in this library can be used as the request argument. Note that 'path' arguments will not be forwarded into the url.

The response body will be deserialized into the res variable, depending on its type:

  • A pointer to a *http.Response is populated by the raw response.
  • A pointer to a byte array will be populated with the contents of the request body.
  • A pointer to any other type uses this library's default JSON decoding, which respects UnmarshalJSON if it is defined on the type.
  • A nil value will not read the response body.

For even greater flexibility, see option.WithResponseInto and option.WithResponseBodyInto.

func (*Client) Get 

func (r *Client) Get(ctx context.Context, path string, params interface{}, res interface{}, opts ...option.RequestOption) error

Get makes a GET request with the given URL, params, and optionally deserializes to a response. See [Execute] documentation on the params and response.

func (*Client) Patch 

func (r *Client) Patch(ctx context.Context, path string, params interface{}, res interface{}, opts ...option.RequestOption) error

Patch makes a PATCH request with the given URL, params, and optionally deserializes to a response. See [Execute] documentation on the params and response.

func (*Client) Post 

func (r *Client) Post(ctx context.Context, path string, params interface{}, res interface{}, opts ...option.RequestOption) error

Post makes a POST request with the given URL, params, and optionally deserializes to a response. See [Execute] documentation on the params and response.

func (*Client) Put 

func (r *Client) Put(ctx context.Context, path string, params interface{}, res interface{}, opts ...option.RequestOption) error

Put makes a PUT request with the given URL, params, and optionally deserializes to a response. See [Execute] documentation on the params and response.

type Environment 

type Environment struct {
	// ID of the ent.
	ID int64 `json:"id"`
	// CreatedAt holds the value of the "created_at" field.
	CreatedAt string `json:"created_at"`
	// Edges holds the relations/edges for other nodes in the graph. The values are
	// being populated by the EnvironmentQuery when eager-loading is set.
	Edges EnvironmentEdges `json:"edges"`
	// Name holds the value of the "name" field.
	Name string `json:"name"`
	// OrganizationID holds the value of the "organization_id" field.
	OrganizationID int64           `json:"organization_id"`
	JSON           environmentJSON `json:"-"`
}

func (*Environment) UnmarshalJSON 

func (r *Environment) UnmarshalJSON(data []byte) (err error)

type EnvironmentEdges 

type EnvironmentEdges struct {
	// Organization that owns this environment
	Organization []Org                `json:"organization"`
	JSON         environmentEdgesJSON `json:"-"`
}

func (*EnvironmentEdges) UnmarshalJSON 

func (r *EnvironmentEdges) UnmarshalJSON(data []byte) (err error)

type EnvironmentNewParams 

type EnvironmentNewParams struct {
	Name param.Field[string] `json:"name,required"`
}

func (EnvironmentNewParams) MarshalJSON 

func (r EnvironmentNewParams) MarshalJSON() (data []byte, err error)

type EnvironmentService 

type EnvironmentService struct {
	Options []option.RequestOption
}

EnvironmentService contains methods and other services that help with interacting with the Schedo 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 NewEnvironmentService method instead.

func NewEnvironmentService 

func NewEnvironmentService(opts ...option.RequestOption) (r *EnvironmentService)

NewEnvironmentService 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 (*EnvironmentService) Delete 

func (r *EnvironmentService) Delete(ctx context.Context, id int64, opts ...option.RequestOption) (res *Environment, err error)

Deletes an org environment

func (*EnvironmentService) List 

func (r *EnvironmentService) List(ctx context.Context, opts ...option.RequestOption) (res *[]Environment, err error)

Retrieves a list of environments for the current org

func (*EnvironmentService) New 

func (r *EnvironmentService) New(ctx context.Context, body EnvironmentNewParams, opts ...option.RequestOption) (res *Environment, err error)

Creates a new org environment

type Error 

type Error = apierror.Error

type Job 

type Job struct {
	// ID of the ent.
	ID int64 `json:"id"`
	// Blocking holds the value of the "blocking" field.
	Blocking bool `json:"blocking"`
	// Command to execute
	Command string `json:"command"`
	// Time when the job was created
	CreatedAt string `json:"created_at"`
	// Cron expression for job scheduling
	CronExpression string `json:"cron_expression"`
	// ID of the user who owns this job
	EnvironmentID int64 `json:"environment_id"`
	// Key holds the value of the "key" field.
	Key string `json:"key"`
	// Time when the job was last executed
	LastRunAt string `json:"last_run_at"`
	// Maximum number of retry attempts
	MaxRetries int64 `json:"max_retries"`
	// Additional metadata for the job
	Metadata map[string]interface{} `json:"metadata"`
	// Name of the job
	Name string `json:"name"`
	// Scheduled time for next execution
	NextRunAt string `json:"next_run_at"`
	// Paused holds the value of the "paused" field.
	Paused bool `json:"paused"`
	// Number of retry attempts
	RetryCount int64 `json:"retry_count"`
	// Current job status (pending, running, completed, failed)
	Status string `json:"status"`
	// Maximum execution time before job is terminated
	Timeout string `json:"timeout"`
	// Maximum execution time before job is terminated
	TimeoutSeconds int64 `json:"timeout_seconds"`
	// Time when the job was last updated
	UpdatedAt string  `json:"updated_at"`
	JSON      jobJSON `json:"-"`
}

func (*Job) UnmarshalJSON 

func (r *Job) UnmarshalJSON(data []byte) (err error)

type JobDefineParams 

type JobDefineParams struct {
	Name           param.Field[string]                 `json:"name,required"`
	Schedule       param.Field[string]                 `json:"schedule,required"`
	Blocking       param.Field[bool]                   `json:"blocking"`
	Metadata       param.Field[map[string]interface{}] `json:"metadata"`
	TimeoutSeconds param.Field[int64]                  `json:"timeout_seconds"`
}

func (JobDefineParams) MarshalJSON 

func (r JobDefineParams) MarshalJSON() (data []byte, err error)

type JobDeleteParams 

type JobDeleteParams struct {
	XAPIEnvironment param.Field[int64] `header:"X-API-ENVIRONMENT,required"`
}

type JobExecution 

type JobExecution struct {
	// ID of the ent.
	ID int64 `json:"id"`
	// Duration holds the value of the "duration" field.
	Duration int64 `json:"duration"`
	// Time when execution completed
	EndTime string `json:"end_time"`
	// Error message if execution failed
	Error string `json:"error"`
	// Exit code of the executed command
	ExitCode int64 `json:"exit_code"`
	// JobCode holds the value of the "job_code" field.
	JobCode string `json:"job_code"`
	// Output of the executed command
	Output string `json:"output"`
	// Time when execution was picked up by a worker
	PickUpTime string `json:"pick_up_time"`
	// Time when execution started
	StartTime string `json:"start_time"`
	// Execution status (running, completed, failed, skipped, expired)
	Status string           `json:"status"`
	JSON   jobExecutionJSON `json:"-"`
}

func (*JobExecution) UnmarshalJSON 

func (r *JobExecution) UnmarshalJSON(data []byte) (err error)

type JobExecutionCompleteParams 

type JobExecutionCompleteParams struct {
	Success               param.Field[bool]   `json:"success,required"`
	CompleteServerTimeUtc param.Field[int64]  `json:"complete_server_time_utc"`
	Error                 param.Field[string] `json:"error"`
	Output                param.Field[string] `json:"output"`
	StartServerTimeUtc    param.Field[int64]  `json:"start_server_time_utc"`
}

func (JobExecutionCompleteParams) MarshalJSON 

func (r JobExecutionCompleteParams) MarshalJSON() (data []byte, err error)

type JobExecutionFrame 

type JobExecutionFrame struct {
	// ID of the ent.
	ID int64 `json:"id"`
	// Duration holds the value of the "duration" field.
	Duration int64 `json:"duration"`
	// Time when execution completed
	EndTime string `json:"end_time"`
	// Error message if execution failed
	Error string `json:"error"`
	// Exit code of the executed command
	ExitCode int64 `json:"exit_code"`
	// JobCode holds the value of the "job_code" field.
	JobCode  string                 `json:"job_code"`
	Metadata map[string]interface{} `json:"metadata"`
	// Output of the executed command
	Output string `json:"output"`
	// Time when execution was picked up by a worker
	PickUpTime string `json:"pick_up_time"`
	// Time when execution started
	StartTime string `json:"start_time"`
	// Execution status (running, completed, failed, skipped, expired)
	Status string                `json:"status"`
	JSON   jobExecutionFrameJSON `json:"-"`
}

func (*JobExecutionFrame) UnmarshalJSON 

func (r *JobExecutionFrame) UnmarshalJSON(data []byte) (err error)

type JobExecutionListParams 

type JobExecutionListParams struct {
	XAPIEnvironment param.Field[int64] `header:"X-API-ENVIRONMENT,required"`
	// 1
	Cursor param.Field[int64] `query:"cursor"`
	// 1
	Limit param.Field[int64] `query:"limit"`
}

func (JobExecutionListParams) URLQuery 

func (r JobExecutionListParams) URLQuery() (v url.Values)

URLQuery serializes JobExecutionListParams's query parameters as `url.Values`.

type JobExecutionService 

type JobExecutionService struct {
	Options []option.RequestOption
}

JobExecutionService contains methods and other services that help with interacting with the Schedo 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 NewJobExecutionService method instead.

func NewJobExecutionService 

func NewJobExecutionService(opts ...option.RequestOption) (r *JobExecutionService)

NewJobExecutionService 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 (*JobExecutionService) Complete 

func (r *JobExecutionService) Complete(ctx context.Context, executionID int64, body JobExecutionCompleteParams, opts ...option.RequestOption) (res *JobExecution, err error)

Marks pending job execution as complete

func (*JobExecutionService) List 

func (r *JobExecutionService) List(ctx context.Context, jobID int64, params JobExecutionListParams, opts ...option.RequestOption) (res *[]JobExecutionFrame, err error)

Returns a list of executions for a job

func (*JobExecutionService) Poll 

func (r *JobExecutionService) Poll(ctx context.Context, opts ...option.RequestOption) (res *[]JobExecution, err error)

Returns list of jobs that must be executed

type JobGetParams 

type JobGetParams struct {
	XAPIEnvironment param.Field[int64] `header:"X-API-ENVIRONMENT,required"`
}

type JobListParams 

type JobListParams struct {
	XAPIEnvironment param.Field[int64] `header:"X-API-ENVIRONMENT,required"`
}

type JobPauseParams 

type JobPauseParams struct {
	XAPIEnvironment param.Field[int64] `header:"X-API-ENVIRONMENT,required"`
}

type JobResumeParams 

type JobResumeParams struct {
	XAPIEnvironment param.Field[int64] `header:"X-API-ENVIRONMENT,required"`
}

type JobService 

type JobService struct {
	Options []option.RequestOption
}

JobService contains methods and other services that help with interacting with the Schedo 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 NewJobService method instead.

func NewJobService 

func NewJobService(opts ...option.RequestOption) (r *JobService)

NewJobService 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 (*JobService) Define 

func (r *JobService) Define(ctx context.Context, body JobDefineParams, opts ...option.RequestOption) (res *Job, err error)

Tries to create a new Job Definition

func (*JobService) Delete 

func (r *JobService) Delete(ctx context.Context, jobID int64, body JobDeleteParams, opts ...option.RequestOption) (res *string, err error)

After you delete a job, you can't recover it, but if you have services still running with that job reference, they will re-create and re-schedule a new job automatically.

func (*JobService) Get 

func (r *JobService) Get(ctx context.Context, jobID int64, query JobGetParams, opts ...option.RequestOption) (res *Output, err error)

Retrieve a job by its ID

func (*JobService) List 

func (r *JobService) List(ctx context.Context, query JobListParams, opts ...option.RequestOption) (res *Job, err error)

List all jobs

func (*JobService) Pause 

func (r *JobService) Pause(ctx context.Context, jobID int64, body JobPauseParams, opts ...option.RequestOption) (res *JobExecution, err error)

Temporary stops a job from running

func (*JobService) Resume 

func (r *JobService) Resume(ctx context.Context, jobID int64, body JobResumeParams, opts ...option.RequestOption) (res *JobExecution, err error)

Resumes job execution

func (*JobService) Trigger 

func (r *JobService) Trigger(ctx context.Context, jobID int64, body JobTriggerParams, opts ...option.RequestOption) (res *JobExecution, err error)

Immediately triggers a job

type JobTriggerParams 

type JobTriggerParams struct {
	XAPIEnvironment param.Field[int64] `header:"X-API-ENVIRONMENT,required"`
}

type Org 

type Org struct {
	// ID of the ent.
	ID int64 `json:"id"`
	// External Clerk organization ID
	ClerkID string `json:"clerk_id"`
	// Edges holds the relations/edges for other nodes in the graph. The values are
	// being populated by the OrgQuery when eager-loading is set.
	Edges OrgEdges `json:"edges"`
	// Organization name
	Name string `json:"name"`
	// SingleUserOrg holds the value of the "single_user_org" field.
	SingleUserOrg bool    `json:"single_user_org"`
	JSON          orgJSON `json:"-"`
}

func (*Org) UnmarshalJSON 

func (r *Org) UnmarshalJSON(data []byte) (err error)

type OrgEdges 

type OrgEdges struct {
	// APIKeys holds the value of the api_keys edge.
	APIKeys []APIKey     `json:"api_keys"`
	JSON    orgEdgesJSON `json:"-"`
}

func (*OrgEdges) UnmarshalJSON 

func (r *OrgEdges) UnmarshalJSON(data []byte) (err error)

type OrgService 

type OrgService struct {
	Options []option.RequestOption
}

OrgService contains methods and other services that help with interacting with the Schedo 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 NewOrgService method instead.

func NewOrgService 

func NewOrgService(opts ...option.RequestOption) (r *OrgService)

NewOrgService 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 (*OrgService) Get 

func (r *OrgService) Get(ctx context.Context, opts ...option.RequestOption) (res *Org, err error)

Retrieves information about current org

type Output 

type Output struct {
	Job     Job          `json:"job"`
	LastRun JobExecution `json:"last_run"`
	JSON    outputJSON   `json:"-"`
}

func (*Output) UnmarshalJSON 

func (r *Output) UnmarshalJSON(data []byte) (err error)

Source Files

View all Source files

Directories

Path Synopsis
apierror
apiform
apijson
apiquery
param
requestconfig
testutil

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL
go.dev uses cookies from Google to deliver and enhance the quality of its services and to analyze traffic. Learn more.