augno

package module
v0.1.0 Latest Latest
Warning

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

 Go to latest Published: Jun 10, 2026 License: Apache-2.0 Imports: 18 Imported by: 0

README

Augno Go API Library

Go Reference

The Augno Go library provides convenient access to the Augno REST API from applications written in Go.

Installation

import (
	"github.com/augno/augno-go" // imported as augno
)

Or to pin the version:

go get -u 'github.com/augno/augno-go@v0.1.0'

Requirements

This library requires Go 1.22+.

Usage

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

package main

import (
	"context"
	"fmt"

	"github.com/augno/augno-go"
	"github.com/augno/augno-go/option"
)

func main() {
	client := augno.NewClient(
		option.WithBearerToken("My Bearer Token"), // defaults to os.LookupEnv("AUGNO_API_KEY")
		option.WithEnvironmentLocal(),             // defaults to option.WithEnvironmentProduction()
	)
	listItem, err := client.Catalog.Items.List(context.TODO(), augno.CatalogItemListParams{})
	if err != nil {
		panic(err.Error())
	}
	fmt.Printf("%+v\n", listItem.Data)
}
Request fields

The augno library uses the omitzero semantics from the Go 1.24+ encoding/json release for request fields.

Required primitive fields (int64, string, etc.) feature the tag `api:"required"`. These fields are always serialized, even their zero values.

Optional primitive types are wrapped in a param.Opt[T]. These fields can be set with the provided constructors, augno.String(string), augno.Int(int64), etc.

Any param.Opt[T], map, slice, struct or string enum uses the tag `json:"...,omitzero"`. Its zero value is considered omitted.

The param.IsOmitted(any) function can confirm the presence of any omitzero field.

p := augno.ExampleParams{
	ID:   "id_xxx",            // required property
	Name: augno.String("..."), // optional property

	Point: augno.Point{
		X: 0,            // required field will serialize as 0
		Y: augno.Int(1), // optional field will serialize as 1
		// ... omitted non-required fields will not be serialized
	},

	Origin: augno.Origin{}, // the zero value of [Origin] is considered omitted
}

To send null instead of a param.Opt[T], use param.Null[T](). To send null instead of a struct T, use param.NullStruct[T]().

p.Name = param.Null[string]()       // 'null' instead of string
p.Point = param.NullStruct[Point]() // 'null' instead of struct

param.IsNull(p.Name)  // true
param.IsNull(p.Point) // true

Request structs contain a .SetExtraFields(map[string]any) method which can send non-conforming fields in the request body. Extra fields overwrite any struct fields with a matching key. For security reasons, only use SetExtraFields with trusted data.

To send a custom value instead of a struct, use param.Override[T](value).

// In cases where the API specifies a given type,
// but you want to send something else, use [SetExtraFields]:
p.SetExtraFields(map[string]any{
	"x": 0.01, // send "x" as a float instead of int
})

// Send a number instead of an object
custom := param.Override[augno.FooParams](12)
Request unions

Unions are represented as a struct with fields prefixed by "Of" for each of its variants, only one field can be non-zero. The non-zero field will be serialized.

Sub-properties of the union can be accessed via methods on the union struct. These methods return a mutable pointer to the underlying data, if present.

// Only one field can be non-zero, use param.IsOmitted() to check if a field is set
type AnimalUnionParam struct {
	OfCat *Cat `json:",omitzero,inline`
	OfDog *Dog `json:",omitzero,inline`
}

animal := AnimalUnionParam{
	OfCat: &Cat{
		Name: "Whiskers",
		Owner: PersonParam{
			Address: AddressParam{Street: "3333 Coyote Hill Rd", Zip: 0},
		},
	},
}

// Mutating a field
if address := animal.GetOwner().GetAddress(); address != nil {
	address.ZipCode = 94304
}
Response objects

All fields in response structs are ordinary value types (not pointers or wrappers). Response structs also include a special JSON field containing metadata about each property.

type Animal struct {
	Name   string `json:"name,nullable"`
	Owners int    `json:"owners"`
	Age    int    `json:"age"`
	JSON   struct {
		Name        respjson.Field
		Owner       respjson.Field
		Age         respjson.Field
		ExtraFields map[string]respjson.Field
	} `json:"-"`
}

To handle optional data, use the .Valid() method on the JSON field. .Valid() returns true if a field is not null, not present, or couldn't be marshaled.

If .Valid() is false, the corresponding field will simply be its zero value.

raw := `{"owners": 1, "name": null}`

var res Animal
json.Unmarshal([]byte(raw), &res)

// Accessing regular fields

res.Owners // 1
res.Name   // ""
res.Age    // 0

// Optional field checks

res.JSON.Owners.Valid() // true
res.JSON.Name.Valid()   // false
res.JSON.Age.Valid()    // false

// Raw JSON values

res.JSON.Owners.Raw()                  // "1"
res.JSON.Name.Raw() == "null"          // true
res.JSON.Name.Raw() == respjson.Null   // true
res.JSON.Age.Raw() == ""               // true
res.JSON.Age.Raw() == respjson.Omitted // true

These .JSON structs also include an ExtraFields 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()
Response Unions

In responses, unions are represented by a flattened struct containing all possible fields from each of the object variants. To convert it to a variant use the .AsFooVariant() method or the .AsAny() method if present.

If a response value union contains primitive values, primitive fields will be alongside the properties but prefixed with Of and feature the tag json:"...,inline".

type AnimalUnion struct {
	// From variants [Dog], [Cat]
	Owner Person `json:"owner"`
	// From variant [Dog]
	DogBreed string `json:"dog_breed"`
	// From variant [Cat]
	CatBreed string `json:"cat_breed"`
	// ...

	JSON struct {
		Owner respjson.Field
		// ...
	} `json:"-"`
}

// If animal variant
if animal.Owner.Address.ZipCode == "" {
	panic("missing zip code")
}

// Switch on the variant
switch variant := animal.AsAny().(type) {
case Dog:
case Cat:
default:
	panic("unexpected type")
}
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 := augno.NewClient(
	// Adds a header to every request made by the client
	option.WithHeader("X-Some-Header", "custom_header_info"),
)

client.Catalog.Items.List(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"}),
)

The request option option.WithDebugLog(nil) may be helpful while debugging.

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 *augno.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.Catalog.Items.List(context.TODO(), augno.CatalogItemListParams{})
if err != nil {
	var apierr *augno.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 "/v1/catalog/items": 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.Catalog.Items.List(
	ctx,
	augno.CatalogItemListParams{},
	// 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 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 augno.File(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 := augno.NewClient(
	option.WithMaxRetries(0), // default is 2
)

// Override per-request:
client.Catalog.Items.List(
	context.TODO(),
	augno.CatalogItemListParams{},
	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
listItem, err := client.Catalog.Items.List(
	context.TODO(),
	augno.CatalogItemListParams{},
	option.WithResponseInto(&response),
)
if err != nil {
	// handle error
}
fmt.Printf("%+v\n", listItem)

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]any

    // 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:   "id_xxxx",
    Data: FooNewParamsData{
        FirstName: augno.String("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 := augno.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(b bool) param.Opt[bool]

func BoolPtr 

func BoolPtr(v bool) *bool

func DefaultClientOptions 

func DefaultClientOptions() []option.RequestOption

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

func File 

func File(rdr io.Reader, filename string, contentType string) file

func Float 

func Float(f float64) param.Opt[float64]

func FloatPtr 

func FloatPtr(v float64) *float64

func Int 

func Int(i int64) param.Opt[int64]

func IntPtr 

func IntPtr(v int64) *int64

func Opt 

func Opt[T comparable](v T) param.Opt[T]

func Ptr 

func Ptr[T any](v T) *T

func String 

func String(s string) param.Opt[string]

func StringPtr 

func StringPtr(v string) *string

func Time 

func Time(t time.Time) param.Opt[time.Time]

func TimePtr 

func TimePtr(v time.Time) *time.Time

Types

type APIKey 

type APIKey struct {
	// API key ID.
	ID string `json:"id" api:"required"`
	// Creation timestamp.
	CreatedAt time.Time `json:"created_at" api:"required" format:"date-time"`
	// Expiration timestamp.
	ExpiresAt time.Time `json:"expires_at" api:"required" format:"date-time"`
	// Last used timestamp.
	LastUsedAt time.Time `json:"last_used_at" api:"required" format:"date-time"`
	// Human-readable name for the API key.
	Name string `json:"name" api:"required"`
	// Resource type identifier.
	//
	// Any of "api_key".
	Object APIKeyObject `json:"object" api:"required"`
	// Redacted key value safe for display.
	RedactedValue string `json:"redacted_value" api:"required"`
	// Revocation timestamp.
	RevokedAt time.Time `json:"revoked_at" api:"required" format:"date-time"`
	// Role resource.
	Role Role `json:"role" api:"required"`
	// Last updated timestamp.
	UpdatedAt time.Time `json:"updated_at" api:"required" format:"date-time"`
	// JSON contains metadata for fields, check presence with [respjson.Field.Valid].
	JSON struct {
		ID            respjson.Field
		CreatedAt     respjson.Field
		ExpiresAt     respjson.Field
		LastUsedAt    respjson.Field
		Name          respjson.Field
		Object        respjson.Field
		RedactedValue respjson.Field
		RevokedAt     respjson.Field
		Role          respjson.Field
		UpdatedAt     respjson.Field
		ExtraFields   map[string]respjson.Field
		// contains filtered or unexported fields
	} `json:"-"`
}

API key resource.

func (APIKey) RawJSON 

func (r APIKey) RawJSON() string

Returns the unmodified JSON received from the API

func (*APIKey) UnmarshalJSON 

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

type APIKeyObject 

type APIKeyObject string

Resource type identifier. 

const (
	APIKeyObjectAPIKey APIKeyObject = "api_key"
)

type Account 

type Account struct {
	// Account ID.
	ID string `json:"id" api:"required"`
	// Branding metadata for an account.
	Branding AccountBranding `json:"branding" api:"required"`
	// Creation timestamp.
	CreatedAt time.Time `json:"created_at" api:"required" format:"date-time"`
	// Address with associated geolocation.
	DefaultBillingAddress Address `json:"default_billing_address" api:"required"`
	// Address with associated geolocation.
	DefaultShippingAddress Address `json:"default_shipping_address" api:"required"`
	// Display name.
	Name string `json:"name" api:"required"`
	// Resource type identifier.
	//
	// Any of "account".
	Object AccountObject `json:"object" api:"required"`
	// Portal metadata for an account.
	Portal AccountPortal `json:"portal" api:"required"`
	// Last updated timestamp.
	UpdatedAt time.Time `json:"updated_at" api:"required" format:"date-time"`
	// JSON contains metadata for fields, check presence with [respjson.Field.Valid].
	JSON struct {
		ID                     respjson.Field
		Branding               respjson.Field
		CreatedAt              respjson.Field
		DefaultBillingAddress  respjson.Field
		DefaultShippingAddress respjson.Field
		Name                   respjson.Field
		Object                 respjson.Field
		Portal                 respjson.Field
		UpdatedAt              respjson.Field
		ExtraFields            map[string]respjson.Field
		// contains filtered or unexported fields
	} `json:"-"`
}

Account with optional branding and portal sub-resources.

func (Account) RawJSON 

func (r Account) RawJSON() string

Returns the unmodified JSON received from the API

func (*Account) UnmarshalJSON 

func (r *Account) UnmarshalJSON(data []byte) error

type AccountBranding 

type AccountBranding struct {
	// Branding ID.
	ID string `json:"id" api:"required"`
	// Creation timestamp.
	CreatedAt time.Time `json:"created_at" api:"required" format:"date-time"`
	// Facebook handle.
	FacebookHandle string `json:"facebook_handle" api:"required"`
	// Instagram handle.
	InstagramHandle string `json:"instagram_handle" api:"required"`
	// LinkedIn handle.
	LinkedinHandle string `json:"linkedin_handle" api:"required"`
	// Logo URL.
	LogoURL string `json:"logo_url" api:"required"`
	// Resource type identifier.
	//
	// Any of "account_branding".
	Object AccountBrandingObject `json:"object" api:"required"`
	// Support phone number.
	PhoneNumber string `json:"phone_number" api:"required"`
	// Support email address.
	SupportEmail string `json:"support_email" api:"required"`
	// Twitter handle.
	TwitterHandle string `json:"twitter_handle" api:"required"`
	// Last updated timestamp.
	UpdatedAt time.Time `json:"updated_at" api:"required" format:"date-time"`
	// Website URL.
	WebsiteURL string `json:"website_url" api:"required"`
	// JSON contains metadata for fields, check presence with [respjson.Field.Valid].
	JSON struct {
		ID              respjson.Field
		CreatedAt       respjson.Field
		FacebookHandle  respjson.Field
		InstagramHandle respjson.Field
		LinkedinHandle  respjson.Field
		LogoURL         respjson.Field
		Object          respjson.Field
		PhoneNumber     respjson.Field
		SupportEmail    respjson.Field
		TwitterHandle   respjson.Field
		UpdatedAt       respjson.Field
		WebsiteURL      respjson.Field
		ExtraFields     map[string]respjson.Field
		// contains filtered or unexported fields
	} `json:"-"`
}

Branding metadata for an account.

func (AccountBranding) RawJSON 

func (r AccountBranding) RawJSON() string

Returns the unmodified JSON received from the API

func (*AccountBranding) UnmarshalJSON 

func (r *AccountBranding) UnmarshalJSON(data []byte) error

type AccountBrandingObject 

type AccountBrandingObject string

Resource type identifier. 

const (
	AccountBrandingObjectAccountBranding AccountBrandingObject = "account_branding"
)

type AccountGroup 

type AccountGroup struct {
	// Account group ID.
	ID string `json:"id" api:"required"`
	// Commission policy.
	//
	//   - `commission_exempt`: no commission applies.
	//   - `commission_applied`: commission applies; if the account group is within a
	//     sales rep's territory, it will be assigned to that rep unless overridden.
	//
	// Any of "commission_applied", "commission_exempt".
	CommissionPolicy AccountGroupCommissionPolicy `json:"commission_policy" api:"required"`
	// Creation timestamp.
	CreatedAt time.Time `json:"created_at" api:"required" format:"date-time"`
	// Description.
	Description string `json:"description" api:"required"`
	// Freight policy.
	//
	//   - `free_freight`: customers within this group will not have to pay for freight.
	//   - `billed_freight`: freight will be applied to any order within this account
	//     group, unless overridden elsewhere.
	//
	// Any of "free_freight", "billed_freight".
	FreightPolicy AccountGroupFreightPolicy `json:"freight_policy" api:"required"`
	// Display name.
	Name string `json:"name" api:"required"`
	// Resource type identifier.
	//
	// Any of "account_group".
	Object AccountGroupObject `json:"object" api:"required"`
	// Account group type.
	//
	//   - `pricing_group`: used for pricing rules, such as a "Preferred" group that
	//     receives a special discount.
	//   - `type_group`: used to categorize accounts, such as "Consumers" or
	//     "Distributors".
	//
	// Any of "pricing_group", "type_group".
	Type AccountGroupType `json:"type" api:"required"`
	// Last updated timestamp.
	UpdatedAt time.Time `json:"updated_at" api:"required" format:"date-time"`
	// JSON contains metadata for fields, check presence with [respjson.Field.Valid].
	JSON struct {
		ID               respjson.Field
		CommissionPolicy respjson.Field
		CreatedAt        respjson.Field
		Description      respjson.Field
		FreightPolicy    respjson.Field
		Name             respjson.Field
		Object           respjson.Field
		Type             respjson.Field
		UpdatedAt        respjson.Field
		ExtraFields      map[string]respjson.Field
		// contains filtered or unexported fields
	} `json:"-"`
}

Account group resource.

func (AccountGroup) RawJSON 

func (r AccountGroup) RawJSON() string

Returns the unmodified JSON received from the API

func (*AccountGroup) UnmarshalJSON 

func (r *AccountGroup) UnmarshalJSON(data []byte) error

type AccountGroupCommissionPolicy 

type AccountGroupCommissionPolicy string

Commission policy.

  • `commission_exempt`: no commission applies.
  • `commission_applied`: commission applies; if the account group is within a sales rep's territory, it will be assigned to that rep unless overridden.
const (
	AccountGroupCommissionPolicyCommissionApplied AccountGroupCommissionPolicy = "commission_applied"
	AccountGroupCommissionPolicyCommissionExempt  AccountGroupCommissionPolicy = "commission_exempt"
)

type AccountGroupFreightPolicy 

type AccountGroupFreightPolicy string

Freight policy.

  • `free_freight`: customers within this group will not have to pay for freight.
  • `billed_freight`: freight will be applied to any order within this account group, unless overridden elsewhere.
const (
	AccountGroupFreightPolicyFreeFreight   AccountGroupFreightPolicy = "free_freight"
	AccountGroupFreightPolicyBilledFreight AccountGroupFreightPolicy = "billed_freight"
)

type AccountGroupObject 

type AccountGroupObject string

Resource type identifier. 

const (
	AccountGroupObjectAccountGroup AccountGroupObject = "account_group"
)

type AccountGroupType 

type AccountGroupType string

Account group type.

  • `pricing_group`: used for pricing rules, such as a "Preferred" group that receives a special discount.
  • `type_group`: used to categorize accounts, such as "Consumers" or "Distributors".
const (
	AccountGroupTypePricingGroup AccountGroupType = "pricing_group"
	AccountGroupTypeTypeGroup    AccountGroupType = "type_group"
)

type AccountObject 

type AccountObject string

Resource type identifier. 

const (
	AccountObjectAccount AccountObject = "account"
)

type AccountPortal 

type AccountPortal struct {
	// Portal ID.
	ID string `json:"id" api:"required"`
	// Creation timestamp.
	CreatedAt time.Time `json:"created_at" api:"required" format:"date-time"`
	// Resource type identifier.
	//
	// Any of "account_portal".
	Object AccountPortalObject `json:"object" api:"required"`
	// Portal slug.
	Slug string `json:"slug" api:"required"`
	// Last updated timestamp.
	UpdatedAt time.Time `json:"updated_at" api:"required" format:"date-time"`
	// JSON contains metadata for fields, check presence with [respjson.Field.Valid].
	JSON struct {
		ID          respjson.Field
		CreatedAt   respjson.Field
		Object      respjson.Field
		Slug        respjson.Field
		UpdatedAt   respjson.Field
		ExtraFields map[string]respjson.Field
		// contains filtered or unexported fields
	} `json:"-"`
}

Portal metadata for an account.

func (AccountPortal) RawJSON 

func (r AccountPortal) RawJSON() string

Returns the unmodified JSON received from the API

func (*AccountPortal) UnmarshalJSON 

func (r *AccountPortal) UnmarshalJSON(data []byte) error

type AccountPortalObject 

type AccountPortalObject string

Resource type identifier. 

const (
	AccountPortalObjectAccountPortal AccountPortalObject = "account_portal"
)

type AccountStatus 

type AccountStatus struct {
	// Account status ID.
	ID string `json:"id" api:"required"`
	// Machine-readable status code.
	//
	// Any of "normal", "preferred", "hold_shipment", "hold_all".
	Code AccountStatusCode `json:"code" api:"required"`
	// Creation timestamp.
	CreatedAt time.Time `json:"created_at" api:"required" format:"date-time"`
	// Display name.
	Name string `json:"name" api:"required"`
	// Resource type identifier.
	//
	// Any of "account_status".
	Object AccountStatusObject `json:"object" api:"required"`
	// Owner describes the provenance of a resource.
	Owner Owner `json:"owner" api:"required"`
	// Last updated timestamp.
	UpdatedAt time.Time `json:"updated_at" api:"required" format:"date-time"`
	// JSON contains metadata for fields, check presence with [respjson.Field.Valid].
	JSON struct {
		ID          respjson.Field
		Code        respjson.Field
		CreatedAt   respjson.Field
		Name        respjson.Field
		Object      respjson.Field
		Owner       respjson.Field
		UpdatedAt   respjson.Field
		ExtraFields map[string]respjson.Field
		// contains filtered or unexported fields
	} `json:"-"`
}

AccountStatus is an account status lookup value.

func (AccountStatus) RawJSON 

func (r AccountStatus) RawJSON() string

Returns the unmodified JSON received from the API

func (*AccountStatus) UnmarshalJSON 

func (r *AccountStatus) UnmarshalJSON(data []byte) error

type AccountStatusCode 

type AccountStatusCode string

Machine-readable status code. 

const (
	AccountStatusCodeNormal       AccountStatusCode = "normal"
	AccountStatusCodePreferred    AccountStatusCode = "preferred"
	AccountStatusCodeHoldShipment AccountStatusCode = "hold_shipment"
	AccountStatusCodeHoldAll      AccountStatusCode = "hold_all"
)

type AccountStatusObject 

type AccountStatusObject string

Resource type identifier. 

const (
	AccountStatusObjectAccountStatus AccountStatusObject = "account_status"
)

type AccountUser 

type AccountUser struct {
	// Account user ID.
	ID string `json:"id" api:"required"`
	// When the account user was created.
	CreatedAt time.Time `json:"created_at" api:"required" format:"date-time"`
	// Department resource.
	Department Department `json:"department" api:"required"`
	// When the user last used this account.
	LastUsedAt time.Time `json:"last_used_at" api:"required" format:"date-time"`
	// Resource type identifier.
	//
	// Any of "account_user".
	Object AccountUserObject `json:"object" api:"required"`
	// Role resource.
	Role Role `json:"role" api:"required"`
	// Account user status.
	//
	// Any of "active", "disabled", "removed".
	Status AccountUserStatus `json:"status" api:"required"`
	// When the account user was last updated.
	UpdatedAt time.Time `json:"updated_at" api:"required" format:"date-time"`
	// User resource.
	User AccountUserUser `json:"user" api:"required"`
	// JSON contains metadata for fields, check presence with [respjson.Field.Valid].
	JSON struct {
		ID          respjson.Field
		CreatedAt   respjson.Field
		Department  respjson.Field
		LastUsedAt  respjson.Field
		Object      respjson.Field
		Role        respjson.Field
		Status      respjson.Field
		UpdatedAt   respjson.Field
		User        respjson.Field
		ExtraFields map[string]respjson.Field
		// contains filtered or unexported fields
	} `json:"-"`
}

Account user with role and department. Profile fields (name, email, username, image URL) live on the expandable user sub-resource.

func (AccountUser) RawJSON 

func (r AccountUser) RawJSON() string

Returns the unmodified JSON received from the API

func (*AccountUser) UnmarshalJSON 

func (r *AccountUser) UnmarshalJSON(data []byte) error

type AccountUserObject 

type AccountUserObject string

Resource type identifier. 

const (
	AccountUserObjectAccountUser AccountUserObject = "account_user"
)

type AccountUserStatus 

type AccountUserStatus string

Account user status. 

const (
	AccountUserStatusActive   AccountUserStatus = "active"
	AccountUserStatusDisabled AccountUserStatus = "disabled"
	AccountUserStatusRemoved  AccountUserStatus = "removed"
)

type AccountUserUser 

type AccountUserUser struct {
	// User ID.
	ID string `json:"id" api:"required"`
	// Creation timestamp.
	CreatedAt time.Time `json:"created_at" api:"required" format:"date-time"`
	// Email address.
	Email string `json:"email" api:"required"`
	// Email verified timestamp, null if unverified.
	EmailVerifiedAt time.Time `json:"email_verified_at" api:"required" format:"date-time"`
	// Profile image URL.
	ImageURL string `json:"image_url" api:"required"`
	// Display name.
	Name string `json:"name" api:"required"`
	// Resource type identifier.
	//
	// Any of "user".
	Object string `json:"object" api:"required"`
	// Last updated timestamp.
	UpdatedAt time.Time `json:"updated_at" api:"required" format:"date-time"`
	// Username.
	Username string `json:"username" api:"required"`
	// JSON contains metadata for fields, check presence with [respjson.Field.Valid].
	JSON struct {
		ID              respjson.Field
		CreatedAt       respjson.Field
		Email           respjson.Field
		EmailVerifiedAt respjson.Field
		ImageURL        respjson.Field
		Name            respjson.Field
		Object          respjson.Field
		UpdatedAt       respjson.Field
		Username        respjson.Field
		ExtraFields     map[string]respjson.Field
		// contains filtered or unexported fields
	} `json:"-"`
}

User resource.

func (AccountUserUser) RawJSON 

func (r AccountUserUser) RawJSON() string

Returns the unmodified JSON received from the API

func (*AccountUserUser) UnmarshalJSON 

func (r *AccountUserUser) UnmarshalJSON(data []byte) error

type Actor 

type Actor struct {
	// Actor ID.
	ID string `json:"id" api:"required"`
	// Human-readable handle (`email` for users, `redacted_value` for API keys, `slug`
	// for agents).
	Handle string `json:"handle" api:"required"`
	// Display name.
	Name string `json:"name" api:"required"`
	// Resource type identifier.
	//
	// Any of "actor".
	Object ActorObject `json:"object" api:"required"`
	// Role resource.
	Role Role `json:"role" api:"required"`
	// Actor type.
	//
	// Any of "user", "api_key", "agent".
	Type ActorType `json:"type" api:"required"`
	// JSON contains metadata for fields, check presence with [respjson.Field.Valid].
	JSON struct {
		ID          respjson.Field
		Handle      respjson.Field
		Name        respjson.Field
		Object      respjson.Field
		Role        respjson.Field
		Type        respjson.Field
		ExtraFields map[string]respjson.Field
		// contains filtered or unexported fields
	} `json:"-"`
}

Reference to an actor (user, API key, or agent).

func (Actor) RawJSON 

func (r Actor) RawJSON() string

Returns the unmodified JSON received from the API

func (*Actor) UnmarshalJSON 

func (r *Actor) UnmarshalJSON(data []byte) error

type ActorObject 

type ActorObject string

Resource type identifier. 

const (
	ActorObjectActor ActorObject = "actor"
)

type ActorType 

type ActorType string

Actor type. 

const (
	ActorTypeUser   ActorType = "user"
	ActorTypeAPIKey ActorType = "api_key"
	ActorTypeAgent  ActorType = "agent"
)

type Address 

type Address struct {
	// Address ID.
	ID string `json:"id" api:"required"`
	// Creation timestamp.
	CreatedAt time.Time `json:"created_at" api:"required" format:"date-time"`
	// Email address associated with the address.
	Email string `json:"email" api:"required"`
	// Geolocation sub-resource.
	Geolocation Geolocation `json:"geolocation" api:"required"`
	// Display name of the address.
	Name string `json:"name" api:"required"`
	// Resource type identifier.
	//
	// Any of "address".
	Object AddressObject `json:"object" api:"required"`
	// Phone number associated with the address.
	Phone string `json:"phone" api:"required"`
	// Address type.
	//
	// Any of "standard", "drop_ship".
	Type AddressType `json:"type" api:"required"`
	// Last updated timestamp.
	UpdatedAt time.Time `json:"updated_at" api:"required" format:"date-time"`
	// JSON contains metadata for fields, check presence with [respjson.Field.Valid].
	JSON struct {
		ID          respjson.Field
		CreatedAt   respjson.Field
		Email       respjson.Field
		Geolocation respjson.Field
		Name        respjson.Field
		Object      respjson.Field
		Phone       respjson.Field
		Type        respjson.Field
		UpdatedAt   respjson.Field
		ExtraFields map[string]respjson.Field
		// contains filtered or unexported fields
	} `json:"-"`
}

Address with associated geolocation.

func (Address) RawJSON 

func (r Address) RawJSON() string

Returns the unmodified JSON received from the API

func (*Address) UnmarshalJSON 

func (r *Address) UnmarshalJSON(data []byte) error

type AddressComponents 

type AddressComponents struct {
	// First line of the street address.
	AddressLine1 string `json:"address_line_1" api:"required"`
	// Second line of the street address.
	AddressLine2 string `json:"address_line_2" api:"required"`
	// City or locality.
	City string `json:"city" api:"required"`
	// Country name or code.
	Country string `json:"country" api:"required"`
	// Two-letter country code.
	CountryCode string `json:"country_code" api:"required"`
	// Resource type identifier.
	//
	// Any of "address_components".
	Object AddressComponentsObject `json:"object" api:"required"`
	// Postal or ZIP code.
	PostalCode string `json:"postal_code" api:"required"`
	// State or administrative area.
	State string `json:"state" api:"required"`
	// JSON contains metadata for fields, check presence with [respjson.Field.Valid].
	JSON struct {
		AddressLine1 respjson.Field
		AddressLine2 respjson.Field
		City         respjson.Field
		Country      respjson.Field
		CountryCode  respjson.Field
		Object       respjson.Field
		PostalCode   respjson.Field
		State        respjson.Field
		ExtraFields  map[string]respjson.Field
		// contains filtered or unexported fields
	} `json:"-"`
}

Parsed address components.

func (AddressComponents) RawJSON 

func (r AddressComponents) RawJSON() string

Returns the unmodified JSON received from the API

func (*AddressComponents) UnmarshalJSON 

func (r *AddressComponents) UnmarshalJSON(data []byte) error

type AddressComponentsObject 

type AddressComponentsObject string

Resource type identifier. 

const (
	AddressComponentsObjectAddressComponents AddressComponentsObject = "address_components"
)

type AddressInputParam 

type AddressInputParam struct {
	// Two-letter country code.
	Country string `json:"country" api:"required"`
	// Display name of the address.
	Name string `json:"name" api:"required"`
	// Email address associated with the address.
	Email param.Opt[string] `json:"email,omitzero"`
	// City or locality.
	Locality param.Opt[string] `json:"locality,omitzero"`
	// Phone number associated with the address.
	Phone param.Opt[string] `json:"phone,omitzero"`
	// Postal or ZIP code.
	PostalCode param.Opt[string] `json:"postal_code,omitzero"`
	// State or administrative area.
	State param.Opt[string] `json:"state,omitzero"`
	// First line of the street address.
	StreetLine1 param.Opt[string] `json:"street_line_1,omitzero"`
	// Second line of the street address.
	StreetLine2 param.Opt[string] `json:"street_line_2,omitzero"`
	// Address type.
	//
	// Any of "standard", "drop_ship".
	Type AddressInputType `json:"type,omitzero"`
	// contains filtered or unexported fields
}

Request to create an address.

The properties Country, Name are required.

func (AddressInputParam) MarshalJSON 

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

func (*AddressInputParam) UnmarshalJSON 

func (r *AddressInputParam) UnmarshalJSON(data []byte) error

type AddressInputType 

type AddressInputType string

Address type. 

const (
	AddressInputTypeStandard AddressInputType = "standard"
	AddressInputTypeDropShip AddressInputType = "drop_ship"
)

type AddressObject 

type AddressObject string

Resource type identifier. 

const (
	AddressObjectAddress AddressObject = "address"
)

type AddressSuggestion 

type AddressSuggestion struct {
	// Address suggestion ID.
	ID string `json:"id" api:"required"`
	// Full description of the address.
	Description string `json:"description" api:"required"`
	// Main text (typically the street address).
	MainText string `json:"main_text" api:"required"`
	// Resource type identifier.
	//
	// Any of "address_suggestion".
	Object AddressSuggestionObject `json:"object" api:"required"`
	// Secondary text (typically city, state, country).
	SecondaryText string `json:"secondary_text" api:"required"`
	// JSON contains metadata for fields, check presence with [respjson.Field.Valid].
	JSON struct {
		ID            respjson.Field
		Description   respjson.Field
		MainText      respjson.Field
		Object        respjson.Field
		SecondaryText respjson.Field
		ExtraFields   map[string]respjson.Field
		// contains filtered or unexported fields
	} `json:"-"`
}

Autocomplete address suggestion.

func (AddressSuggestion) RawJSON 

func (r AddressSuggestion) RawJSON() string

Returns the unmodified JSON received from the API

func (*AddressSuggestion) UnmarshalJSON 

func (r *AddressSuggestion) UnmarshalJSON(data []byte) error

type AddressSuggestionObject 

type AddressSuggestionObject string

Resource type identifier. 

const (
	AddressSuggestionObjectAddressSuggestion AddressSuggestionObject = "address_suggestion"
)

type AddressType 

type AddressType string

Address type. 

const (
	AddressTypeStandard AddressType = "standard"
	AddressTypeDropShip AddressType = "drop_ship"
)

type AdjustmentType 

type AdjustmentType struct {
	// Adjustment ID.
	ID string `json:"id" api:"required"`
	// Machine-readable code.
	//
	// Any of "discount", "shipping_discrepancy", "short_payment", "write_off", "fee",
	// "refund".
	Code AdjustmentTypeCode `json:"code" api:"required"`
	// Creation timestamp.
	CreatedAt time.Time `json:"created_at" api:"required" format:"date-time"`
	// Display name.
	Name string `json:"name" api:"required"`
	// Resource type identifier.
	//
	// Any of "adjustment_type".
	Object AdjustmentTypeObject `json:"object" api:"required"`
	// Owner describes the provenance of a resource.
	Owner Owner `json:"owner" api:"required"`
	// Last updated timestamp.
	UpdatedAt time.Time `json:"updated_at" api:"required" format:"date-time"`
	// JSON contains metadata for fields, check presence with [respjson.Field.Valid].
	JSON struct {
		ID          respjson.Field
		Code        respjson.Field
		CreatedAt   respjson.Field
		Name        respjson.Field
		Object      respjson.Field
		Owner       respjson.Field
		UpdatedAt   respjson.Field
		ExtraFields map[string]respjson.Field
		// contains filtered or unexported fields
	} `json:"-"`
}

Adjustment type resource.

func (AdjustmentType) RawJSON 

func (r AdjustmentType) RawJSON() string

Returns the unmodified JSON received from the API

func (*AdjustmentType) UnmarshalJSON 

func (r *AdjustmentType) UnmarshalJSON(data []byte) error

type AdjustmentTypeCode 

type AdjustmentTypeCode string

Machine-readable code. 

const (
	AdjustmentTypeCodeDiscount            AdjustmentTypeCode = "discount"
	AdjustmentTypeCodeShippingDiscrepancy AdjustmentTypeCode = "shipping_discrepancy"
	AdjustmentTypeCodeShortPayment        AdjustmentTypeCode = "short_payment"
	AdjustmentTypeCodeWriteOff            AdjustmentTypeCode = "write_off"
	AdjustmentTypeCodeFee                 AdjustmentTypeCode = "fee"
	AdjustmentTypeCodeRefund              AdjustmentTypeCode = "refund"
)

type AdjustmentTypeObject 

type AdjustmentTypeObject string

Resource type identifier. 

const (
	AdjustmentTypeObjectAdjustmentType AdjustmentTypeObject = "adjustment_type"
)

type Attribute 

type Attribute struct {
	// Attribute ID.
	ID string `json:"id" api:"required"`
	// Color code.
	//
	// Any of "blue", "brown", "default", "gray", "green", "orange", "pink", "purple",
	// "red", "yellow".
	Color AttributeColor `json:"color" api:"required"`
	// Creation timestamp.
	CreatedAt time.Time `json:"created_at" api:"required" format:"date-time"`
	// Resource type identifier.
	//
	// Any of "attribute".
	Object AttributeObject `json:"object" api:"required"`
	// Property that groups attributes.
	Property *Property `json:"property" api:"required"`
	// Display order.
	SortOrder int64 `json:"sort_order" api:"required"`
	// Last update timestamp.
	UpdatedAt time.Time `json:"updated_at" api:"required" format:"date-time"`
	// Attribute value.
	Value string `json:"value" api:"required"`
	// JSON contains metadata for fields, check presence with [respjson.Field.Valid].
	JSON struct {
		ID          respjson.Field
		Color       respjson.Field
		CreatedAt   respjson.Field
		Object      respjson.Field
		Property    respjson.Field
		SortOrder   respjson.Field
		UpdatedAt   respjson.Field
		Value       respjson.Field
		ExtraFields map[string]respjson.Field
		// contains filtered or unexported fields
	} `json:"-"`
}

Value option within a property.

func (Attribute) RawJSON 

func (r Attribute) RawJSON() string

Returns the unmodified JSON received from the API

func (*Attribute) UnmarshalJSON 

func (r *Attribute) UnmarshalJSON(data []byte) error

type AttributeColor 

type AttributeColor string

Color code. 

const (
	AttributeColorBlue    AttributeColor = "blue"
	AttributeColorBrown   AttributeColor = "brown"
	AttributeColorDefault AttributeColor = "default"
	AttributeColorGray    AttributeColor = "gray"
	AttributeColorGreen   AttributeColor = "green"
	AttributeColorOrange  AttributeColor = "orange"
	AttributeColorPink    AttributeColor = "pink"
	AttributeColorPurple  AttributeColor = "purple"
	AttributeColorRed     AttributeColor = "red"
	AttributeColorYellow  AttributeColor = "yellow"
)

type AttributeObject 

type AttributeObject string

Resource type identifier. 

const (
	AttributeObjectAttribute AttributeObject = "attribute"
)

type AuditEvent 

type AuditEvent struct {
	// Audit event ID.
	ID string `json:"id" api:"required"`
	// Mutation type.
	//
	// Any of "create", "update", "delete", "restore", "archive".
	Action AuditEventAction `json:"action" api:"required"`
	// Reference to an actor (user, API key, or agent).
	Actor Actor `json:"actor" api:"required"`
	// List represents a paginated list of resources.
	Changes ListAuditFieldChange `json:"changes" api:"required"`
	// When the audit event record was created.
	CreatedAt time.Time `json:"created_at" api:"required" format:"date-time"`
	// Idempotency key of the originating request.
	IdempotencyKey string `json:"idempotency_key" api:"required"`
	// Arbitrary JSON metadata for the mutation (e.g. reason, source, tags). Encoded as
	// a JSON value (object, array, string, number, boolean, or null), not a
	// JSON-encoded string.
	Metadata any `json:"metadata" api:"required"`
	// Resource type identifier.
	//
	// Any of "audit_event".
	Object AuditEventObject `json:"object" api:"required"`
	// When the audited mutation occurred.
	OccurredAt time.Time `json:"occurred_at" api:"required" format:"date-time"`
	// RequestLog is an API request log entry.
	Request RequestLog `json:"request" api:"required"`
	// Audited resource ID.
	ResourceID string `json:"resource_id" api:"required"`
	// Resource type of the audited entity.
	//
	// Any of "account", "actor", "entity", "record", "freight", "sales_order_totals",
	// "sales_order_related", "user", "address", "api_key", "created_api_key",
	// "refresh_token", "list", "sandbox", "registration_session", "pricing_plan",
	// "account_plan", "plan_change", "enterprise_inquiry", "request_log",
	// "audit_event", "audit_field_change", "role", "unit", "account_affiliation",
	// "agent_definition", "available_tool", "agent_definition_tool",
	// "agent_account_status", "agent_run", "agent_action", "agent_run_step",
	// "agent_token_usage", "agent_memory", "agent_alert", "tool_group",
	// "payment_term", "shipping_term", "quantity", "account_group", "account_status",
	// "geolocation", "account_user", "department", "account_integration",
	// "account_price", "product_line", "item_category", "attribute", "rate",
	// "account_group_product_line_access", "sales_target", "adjustment_type",
	// "account_branding", "account_portal", "account_logo_url", "public_account",
	// "property", "carrier", "service_level", "item", "item_inventory", "product",
	// "batch", "batch_flow_node", "scanning_consumption", "open_batch_summary",
	// "scanning_production_step_info", "scanning_station", "production_step",
	// "production_run", "machine", "child_account", "unit_group", "unit_group_unit",
	// "consumption", "customer_product_line_access", "customer",
	// "frequently_ordered_product", "priority", "delivery", "delivery_line",
	// "sales_order", "location", "location_type", "lot", "email_log",
	// "inventory_change_log", "invoice", "invoice_summary", "invoice_line",
	// "invoice_allocation", "invoice_for_payment", "shipment", "shipment_summary",
	// "shipment_line", "shipping_case", "shipping_case_label_url", "settlement",
	// "settlement_summary", "role_permission", "registration_flow",
	// "registration_flow_option", "transaction", "transaction_summary",
	// "transaction_method", "transaction_type", "transaction_allocation",
	// "usage_item", "agent_token_detail", "account_usage_response",
	// "subscription_info", "billing_portal_session_response", "switch_plan_response",
	// "ensure_billing_customer_response", "spending_cap_response", "agent_spend_info",
	// "webhook_response", "address_suggestion", "address_components",
	// "address_details_result", "validated_address", "plan_limit",
	// "plan_change_proration", "plan_change_line_item", "setup_billing_response",
	// "confirm_payment_response", "oauth_response", "oauth_status_response",
	// "stripe_publishable_key", "stripe_status", "healthcheck",
	// "agent_definition_config", "trigger_config", "customer_contact_info",
	// "customer_freight_preferences", "customer_defaults",
	// "customer_notification_preferences", "order_discount", "sales_order_line",
	// "sales_order_type", "sales_order_status", "material", "supplier_material",
	// "part", "permission_group", "permission", "pick", "pick_line", "product_type",
	// "production", "production_flow", "map", "purchase_order", "purchase_order_line",
	// "supplier", "supplier_summary", "receivable_entry", "receiving_order",
	// "receiving_order_line", "email_contact", "allocation_entry",
	// "open_credit_entry", "volume_discount", "volume_discount_tier",
	// "analyze_deliveries_response", "analyze_manufacturing_response",
	// "analyze_manufacturing_batch_response", "analyze_quarterly_orders_response",
	// "analyze_new_customers_response", "analyze_oee_response",
	// "catalog_product_line", "catalog_category", "catalog_product",
	// "catalog_property", "catalog_attribute", "dc_location", "edi_run",
	// "inventory_item", "analyze_weeks_of_sales_response",
	// "bulk_reconcile_items_response", "sys_property", "sys_property_type",
	// "sys_property_value", "territory", "tenancy", "checkout_session",
	// "estimate_rate_result", "rate_shop_option", "rate_shop_result", "owner",
	// "message", "account_photo_upload_result", "user_photo_upload_result",
	// "user_photo_url", "batch_lot", "check_duplicate_result", "item_trend_point",
	// "pack_pick_response", "pick_shipments_response", "tenancy_pending_registration",
	// "invoice_allocation_entry", "allocation_customer",
	// "checkout_sales_order_response", "create_production_run_response".
	ResourceType AuditEventResourceType `json:"resource_type" api:"required"`
	// Originating client IP address.
	SourceIP string `json:"source_ip" api:"required"`
	// JSON contains metadata for fields, check presence with [respjson.Field.Valid].
	JSON struct {
		ID             respjson.Field
		Action         respjson.Field
		Actor          respjson.Field
		Changes        respjson.Field
		CreatedAt      respjson.Field
		IdempotencyKey respjson.Field
		Metadata       respjson.Field
		Object         respjson.Field
		OccurredAt     respjson.Field
		Request        respjson.Field
		ResourceID     respjson.Field
		ResourceType   respjson.Field
		SourceIP       respjson.Field
		ExtraFields    map[string]respjson.Field
		// contains filtered or unexported fields
	} `json:"-"`
}

Immutable audit event record. Captures the actor, changed resource, and timestamp.

func (AuditEvent) RawJSON 

func (r AuditEvent) RawJSON() string

Returns the unmodified JSON received from the API

func (*AuditEvent) UnmarshalJSON 

func (r *AuditEvent) UnmarshalJSON(data []byte) error

type AuditEventAction 

type AuditEventAction string

Mutation type. 

const (
	AuditEventActionCreate  AuditEventAction = "create"
	AuditEventActionUpdate  AuditEventAction = "update"
	AuditEventActionDelete  AuditEventAction = "delete"
	AuditEventActionRestore AuditEventAction = "restore"
	AuditEventActionArchive AuditEventAction = "archive"
)

type AuditEventObject 

type AuditEventObject string

Resource type identifier. 

const (
	AuditEventObjectAuditEvent AuditEventObject = "audit_event"
)

type AuditEventResourceType 

type AuditEventResourceType string

Resource type of the audited entity. 

const (
	AuditEventResourceTypeAccount                           AuditEventResourceType = "account"
	AuditEventResourceTypeActor                             AuditEventResourceType = "actor"
	AuditEventResourceTypeEntity                            AuditEventResourceType = "entity"
	AuditEventResourceTypeRecord                            AuditEventResourceType = "record"
	AuditEventResourceTypeFreight                           AuditEventResourceType = "freight"
	AuditEventResourceTypeSalesOrderTotals                  AuditEventResourceType = "sales_order_totals"
	AuditEventResourceTypeSalesOrderRelated                 AuditEventResourceType = "sales_order_related"
	AuditEventResourceTypeUser                              AuditEventResourceType = "user"
	AuditEventResourceTypeAddress                           AuditEventResourceType = "address"
	AuditEventResourceTypeAPIKey                            AuditEventResourceType = "api_key"
	AuditEventResourceTypeCreatedAPIKey                     AuditEventResourceType = "created_api_key"
	AuditEventResourceTypeRefreshToken                      AuditEventResourceType = "refresh_token"
	AuditEventResourceTypeList                              AuditEventResourceType = "list"
	AuditEventResourceTypeSandbox                           AuditEventResourceType = "sandbox"
	AuditEventResourceTypeRegistrationSession               AuditEventResourceType = "registration_session"
	AuditEventResourceTypePricingPlan                       AuditEventResourceType = "pricing_plan"
	AuditEventResourceTypeAccountPlan                       AuditEventResourceType = "account_plan"
	AuditEventResourceTypePlanChange                        AuditEventResourceType = "plan_change"
	AuditEventResourceTypeEnterpriseInquiry                 AuditEventResourceType = "enterprise_inquiry"
	AuditEventResourceTypeRequestLog                        AuditEventResourceType = "request_log"
	AuditEventResourceTypeAuditEvent                        AuditEventResourceType = "audit_event"
	AuditEventResourceTypeAuditFieldChange                  AuditEventResourceType = "audit_field_change"
	AuditEventResourceTypeRole                              AuditEventResourceType = "role"
	AuditEventResourceTypeUnit                              AuditEventResourceType = "unit"
	AuditEventResourceTypeAccountAffiliation                AuditEventResourceType = "account_affiliation"
	AuditEventResourceTypeAgentDefinition                   AuditEventResourceType = "agent_definition"
	AuditEventResourceTypeAvailableTool                     AuditEventResourceType = "available_tool"
	AuditEventResourceTypeAgentDefinitionTool               AuditEventResourceType = "agent_definition_tool"
	AuditEventResourceTypeAgentAccountStatus                AuditEventResourceType = "agent_account_status"
	AuditEventResourceTypeAgentRun                          AuditEventResourceType = "agent_run"
	AuditEventResourceTypeAgentAction                       AuditEventResourceType = "agent_action"
	AuditEventResourceTypeAgentRunStep                      AuditEventResourceType = "agent_run_step"
	AuditEventResourceTypeAgentTokenUsage                   AuditEventResourceType = "agent_token_usage"
	AuditEventResourceTypeAgentMemory                       AuditEventResourceType = "agent_memory"
	AuditEventResourceTypeAgentAlert                        AuditEventResourceType = "agent_alert"
	AuditEventResourceTypeToolGroup                         AuditEventResourceType = "tool_group"
	AuditEventResourceTypePaymentTerm                       AuditEventResourceType = "payment_term"
	AuditEventResourceTypeShippingTerm                      AuditEventResourceType = "shipping_term"
	AuditEventResourceTypeQuantity                          AuditEventResourceType = "quantity"
	AuditEventResourceTypeAccountGroup                      AuditEventResourceType = "account_group"
	AuditEventResourceTypeAccountStatus                     AuditEventResourceType = "account_status"
	AuditEventResourceTypeGeolocation                       AuditEventResourceType = "geolocation"
	AuditEventResourceTypeAccountUser                       AuditEventResourceType = "account_user"
	AuditEventResourceTypeDepartment                        AuditEventResourceType = "department"
	AuditEventResourceTypeAccountIntegration                AuditEventResourceType = "account_integration"
	AuditEventResourceTypeAccountPrice                      AuditEventResourceType = "account_price"
	AuditEventResourceTypeProductLine                       AuditEventResourceType = "product_line"
	AuditEventResourceTypeItemCategory                      AuditEventResourceType = "item_category"
	AuditEventResourceTypeAttribute                         AuditEventResourceType = "attribute"
	AuditEventResourceTypeRate                              AuditEventResourceType = "rate"
	AuditEventResourceTypeAccountGroupProductLineAccess     AuditEventResourceType = "account_group_product_line_access"
	AuditEventResourceTypeSalesTarget                       AuditEventResourceType = "sales_target"
	AuditEventResourceTypeAdjustmentType                    AuditEventResourceType = "adjustment_type"
	AuditEventResourceTypeAccountBranding                   AuditEventResourceType = "account_branding"
	AuditEventResourceTypeAccountPortal                     AuditEventResourceType = "account_portal"
	AuditEventResourceTypeAccountLogoURL                    AuditEventResourceType = "account_logo_url"
	AuditEventResourceTypePublicAccount                     AuditEventResourceType = "public_account"
	AuditEventResourceTypeProperty                          AuditEventResourceType = "property"
	AuditEventResourceTypeCarrier                           AuditEventResourceType = "carrier"
	AuditEventResourceTypeServiceLevel                      AuditEventResourceType = "service_level"
	AuditEventResourceTypeItem                              AuditEventResourceType = "item"
	AuditEventResourceTypeItemInventory                     AuditEventResourceType = "item_inventory"
	AuditEventResourceTypeProduct                           AuditEventResourceType = "product"
	AuditEventResourceTypeBatch                             AuditEventResourceType = "batch"
	AuditEventResourceTypeBatchFlowNode                     AuditEventResourceType = "batch_flow_node"
	AuditEventResourceTypeScanningConsumption               AuditEventResourceType = "scanning_consumption"
	AuditEventResourceTypeOpenBatchSummary                  AuditEventResourceType = "open_batch_summary"
	AuditEventResourceTypeScanningProductionStepInfo        AuditEventResourceType = "scanning_production_step_info"
	AuditEventResourceTypeScanningStation                   AuditEventResourceType = "scanning_station"
	AuditEventResourceTypeProductionStep                    AuditEventResourceType = "production_step"
	AuditEventResourceTypeProductionRun                     AuditEventResourceType = "production_run"
	AuditEventResourceTypeMachine                           AuditEventResourceType = "machine"
	AuditEventResourceTypeChildAccount                      AuditEventResourceType = "child_account"
	AuditEventResourceTypeUnitGroup                         AuditEventResourceType = "unit_group"
	AuditEventResourceTypeUnitGroupUnit                     AuditEventResourceType = "unit_group_unit"
	AuditEventResourceTypeConsumption                       AuditEventResourceType = "consumption"
	AuditEventResourceTypeCustomerProductLineAccess         AuditEventResourceType = "customer_product_line_access"
	AuditEventResourceTypeCustomer                          AuditEventResourceType = "customer"
	AuditEventResourceTypeFrequentlyOrderedProduct          AuditEventResourceType = "frequently_ordered_product"
	AuditEventResourceTypePriority                          AuditEventResourceType = "priority"
	AuditEventResourceTypeDelivery                          AuditEventResourceType = "delivery"
	AuditEventResourceTypeDeliveryLine                      AuditEventResourceType = "delivery_line"
	AuditEventResourceTypeSalesOrder                        AuditEventResourceType = "sales_order"
	AuditEventResourceTypeLocation                          AuditEventResourceType = "location"
	AuditEventResourceTypeLocationType                      AuditEventResourceType = "location_type"
	AuditEventResourceTypeLot                               AuditEventResourceType = "lot"
	AuditEventResourceTypeEmailLog                          AuditEventResourceType = "email_log"
	AuditEventResourceTypeInventoryChangeLog                AuditEventResourceType = "inventory_change_log"
	AuditEventResourceTypeInvoice                           AuditEventResourceType = "invoice"
	AuditEventResourceTypeInvoiceSummary                    AuditEventResourceType = "invoice_summary"
	AuditEventResourceTypeInvoiceLine                       AuditEventResourceType = "invoice_line"
	AuditEventResourceTypeInvoiceAllocation                 AuditEventResourceType = "invoice_allocation"
	AuditEventResourceTypeInvoiceForPayment                 AuditEventResourceType = "invoice_for_payment"
	AuditEventResourceTypeShipment                          AuditEventResourceType = "shipment"
	AuditEventResourceTypeShipmentSummary                   AuditEventResourceType = "shipment_summary"
	AuditEventResourceTypeShipmentLine                      AuditEventResourceType = "shipment_line"
	AuditEventResourceTypeShippingCase                      AuditEventResourceType = "shipping_case"
	AuditEventResourceTypeShippingCaseLabelURL              AuditEventResourceType = "shipping_case_label_url"
	AuditEventResourceTypeSettlement                        AuditEventResourceType = "settlement"
	AuditEventResourceTypeSettlementSummary                 AuditEventResourceType = "settlement_summary"
	AuditEventResourceTypeRolePermission                    AuditEventResourceType = "role_permission"
	AuditEventResourceTypeRegistrationFlow                  AuditEventResourceType = "registration_flow"
	AuditEventResourceTypeRegistrationFlowOption            AuditEventResourceType = "registration_flow_option"
	AuditEventResourceTypeTransaction                       AuditEventResourceType = "transaction"
	AuditEventResourceTypeTransactionSummary                AuditEventResourceType = "transaction_summary"
	AuditEventResourceTypeTransactionMethod                 AuditEventResourceType = "transaction_method"
	AuditEventResourceTypeTransactionType                   AuditEventResourceType = "transaction_type"
	AuditEventResourceTypeTransactionAllocation             AuditEventResourceType = "transaction_allocation"
	AuditEventResourceTypeUsageItem                         AuditEventResourceType = "usage_item"
	AuditEventResourceTypeAgentTokenDetail                  AuditEventResourceType = "agent_token_detail"
	AuditEventResourceTypeAccountUsageResponse              AuditEventResourceType = "account_usage_response"
	AuditEventResourceTypeSubscriptionInfo                  AuditEventResourceType = "subscription_info"
	AuditEventResourceTypeBillingPortalSessionResponse      AuditEventResourceType = "billing_portal_session_response"
	AuditEventResourceTypeSwitchPlanResponse                AuditEventResourceType = "switch_plan_response"
	AuditEventResourceTypeEnsureBillingCustomerResponse     AuditEventResourceType = "ensure_billing_customer_response"
	AuditEventResourceTypeSpendingCapResponse               AuditEventResourceType = "spending_cap_response"
	AuditEventResourceTypeAgentSpendInfo                    AuditEventResourceType = "agent_spend_info"
	AuditEventResourceTypeWebhookResponse                   AuditEventResourceType = "webhook_response"
	AuditEventResourceTypeAddressSuggestion                 AuditEventResourceType = "address_suggestion"
	AuditEventResourceTypeAddressComponents                 AuditEventResourceType = "address_components"
	AuditEventResourceTypeAddressDetailsResult              AuditEventResourceType = "address_details_result"
	AuditEventResourceTypeValidatedAddress                  AuditEventResourceType = "validated_address"
	AuditEventResourceTypePlanLimit                         AuditEventResourceType = "plan_limit"
	AuditEventResourceTypePlanChangeProration               AuditEventResourceType = "plan_change_proration"
	AuditEventResourceTypePlanChangeLineItem                AuditEventResourceType = "plan_change_line_item"
	AuditEventResourceTypeSetupBillingResponse              AuditEventResourceType = "setup_billing_response"
	AuditEventResourceTypeConfirmPaymentResponse            AuditEventResourceType = "confirm_payment_response"
	AuditEventResourceTypeOAuthResponse                     AuditEventResourceType = "oauth_response"
	AuditEventResourceTypeOAuthStatusResponse               AuditEventResourceType = "oauth_status_response"
	AuditEventResourceTypeStripePublishableKey              AuditEventResourceType = "stripe_publishable_key"
	AuditEventResourceTypeStripeStatus                      AuditEventResourceType = "stripe_status"
	AuditEventResourceTypeHealthcheck                       AuditEventResourceType = "healthcheck"
	AuditEventResourceTypeAgentDefinitionConfig             AuditEventResourceType = "agent_definition_config"
	AuditEventResourceTypeTriggerConfig                     AuditEventResourceType = "trigger_config"
	AuditEventResourceTypeCustomerContactInfo               AuditEventResourceType = "customer_contact_info"
	AuditEventResourceTypeCustomerFreightPreferences        AuditEventResourceType = "customer_freight_preferences"
	AuditEventResourceTypeCustomerDefaults                  AuditEventResourceType = "customer_defaults"
	AuditEventResourceTypeCustomerNotificationPreferences   AuditEventResourceType = "customer_notification_preferences"
	AuditEventResourceTypeOrderDiscount                     AuditEventResourceType = "order_discount"
	AuditEventResourceTypeSalesOrderLine                    AuditEventResourceType = "sales_order_line"
	AuditEventResourceTypeSalesOrderType                    AuditEventResourceType = "sales_order_type"
	AuditEventResourceTypeSalesOrderStatus                  AuditEventResourceType = "sales_order_status"
	AuditEventResourceTypeMaterial                          AuditEventResourceType = "material"
	AuditEventResourceTypeSupplierMaterial                  AuditEventResourceType = "supplier_material"
	AuditEventResourceTypePart                              AuditEventResourceType = "part"
	AuditEventResourceTypePermissionGroup                   AuditEventResourceType = "permission_group"
	AuditEventResourceTypePermission                        AuditEventResourceType = "permission"
	AuditEventResourceTypePick                              AuditEventResourceType = "pick"
	AuditEventResourceTypePickLine                          AuditEventResourceType = "pick_line"
	AuditEventResourceTypeProductType                       AuditEventResourceType = "product_type"
	AuditEventResourceTypeProduction                        AuditEventResourceType = "production"
	AuditEventResourceTypeProductionFlow                    AuditEventResourceType = "production_flow"
	AuditEventResourceTypeMap                               AuditEventResourceType = "map"
	AuditEventResourceTypePurchaseOrder                     AuditEventResourceType = "purchase_order"
	AuditEventResourceTypePurchaseOrderLine                 AuditEventResourceType = "purchase_order_line"
	AuditEventResourceTypeSupplier                          AuditEventResourceType = "supplier"
	AuditEventResourceTypeSupplierSummary                   AuditEventResourceType = "supplier_summary"
	AuditEventResourceTypeReceivableEntry                   AuditEventResourceType = "receivable_entry"
	AuditEventResourceTypeReceivingOrder                    AuditEventResourceType = "receiving_order"
	AuditEventResourceTypeReceivingOrderLine                AuditEventResourceType = "receiving_order_line"
	AuditEventResourceTypeEmailContact                      AuditEventResourceType = "email_contact"
	AuditEventResourceTypeAllocationEntry                   AuditEventResourceType = "allocation_entry"
	AuditEventResourceTypeOpenCreditEntry                   AuditEventResourceType = "open_credit_entry"
	AuditEventResourceTypeVolumeDiscount                    AuditEventResourceType = "volume_discount"
	AuditEventResourceTypeVolumeDiscountTier                AuditEventResourceType = "volume_discount_tier"
	AuditEventResourceTypeAnalyzeDeliveriesResponse         AuditEventResourceType = "analyze_deliveries_response"
	AuditEventResourceTypeAnalyzeManufacturingResponse      AuditEventResourceType = "analyze_manufacturing_response"
	AuditEventResourceTypeAnalyzeManufacturingBatchResponse AuditEventResourceType = "analyze_manufacturing_batch_response"
	AuditEventResourceTypeAnalyzeQuarterlyOrdersResponse    AuditEventResourceType = "analyze_quarterly_orders_response"
	AuditEventResourceTypeAnalyzeNewCustomersResponse       AuditEventResourceType = "analyze_new_customers_response"
	AuditEventResourceTypeAnalyzeOeeResponse                AuditEventResourceType = "analyze_oee_response"
	AuditEventResourceTypeCatalogProductLine                AuditEventResourceType = "catalog_product_line"
	AuditEventResourceTypeCatalogCategory                   AuditEventResourceType = "catalog_category"
	AuditEventResourceTypeCatalogProduct                    AuditEventResourceType = "catalog_product"
	AuditEventResourceTypeCatalogProperty                   AuditEventResourceType = "catalog_property"
	AuditEventResourceTypeCatalogAttribute                  AuditEventResourceType = "catalog_attribute"
	AuditEventResourceTypeDcLocation                        AuditEventResourceType = "dc_location"
	AuditEventResourceTypeEdiRun                            AuditEventResourceType = "edi_run"
	AuditEventResourceTypeInventoryItem                     AuditEventResourceType = "inventory_item"
	AuditEventResourceTypeAnalyzeWeeksOfSalesResponse       AuditEventResourceType = "analyze_weeks_of_sales_response"
	AuditEventResourceTypeBulkReconcileItemsResponse        AuditEventResourceType = "bulk_reconcile_items_response"
	AuditEventResourceTypeSysProperty                       AuditEventResourceType = "sys_property"
	AuditEventResourceTypeSysPropertyType                   AuditEventResourceType = "sys_property_type"
	AuditEventResourceTypeSysPropertyValue                  AuditEventResourceType = "sys_property_value"
	AuditEventResourceTypeTerritory                         AuditEventResourceType = "territory"
	AuditEventResourceTypeTenancy                           AuditEventResourceType = "tenancy"
	AuditEventResourceTypeCheckoutSession                   AuditEventResourceType = "checkout_session"
	AuditEventResourceTypeEstimateRateResult                AuditEventResourceType = "estimate_rate_result"
	AuditEventResourceTypeRateShopOption                    AuditEventResourceType = "rate_shop_option"
	AuditEventResourceTypeRateShopResult                    AuditEventResourceType = "rate_shop_result"
	AuditEventResourceTypeOwner                             AuditEventResourceType = "owner"
	AuditEventResourceTypeMessage                           AuditEventResourceType = "message"
	AuditEventResourceTypeAccountPhotoUploadResult          AuditEventResourceType = "account_photo_upload_result"
	AuditEventResourceTypeUserPhotoUploadResult             AuditEventResourceType = "user_photo_upload_result"
	AuditEventResourceTypeUserPhotoURL                      AuditEventResourceType = "user_photo_url"
	AuditEventResourceTypeBatchLot                          AuditEventResourceType = "batch_lot"
	AuditEventResourceTypeCheckDuplicateResult              AuditEventResourceType = "check_duplicate_result"
	AuditEventResourceTypeItemTrendPoint                    AuditEventResourceType = "item_trend_point"
	AuditEventResourceTypePackPickResponse                  AuditEventResourceType = "pack_pick_response"
	AuditEventResourceTypePickShipmentsResponse             AuditEventResourceType = "pick_shipments_response"
	AuditEventResourceTypeTenancyPendingRegistration        AuditEventResourceType = "tenancy_pending_registration"
	AuditEventResourceTypeInvoiceAllocationEntry            AuditEventResourceType = "invoice_allocation_entry"
	AuditEventResourceTypeAllocationCustomer                AuditEventResourceType = "allocation_customer"
	AuditEventResourceTypeCheckoutSalesOrderResponse        AuditEventResourceType = "checkout_sales_order_response"
	AuditEventResourceTypeCreateProductionRunResponse       AuditEventResourceType = "create_production_run_response"
)

type AuditFieldChange 

type AuditFieldChange struct {
	// Name of the changed field.
	Field string `json:"field" api:"required"`
	// New value as a JSON fragment. Null for deletion events. Encoded as a JSON value
	// (object, array, string, number, boolean, or null), not a JSON-encoded string.
	NewValue any `json:"new_value" api:"required"`
	// Resource type identifier.
	//
	// Any of "audit_field_change".
	Object AuditFieldChangeObject `json:"object" api:"required"`
	// Previous value as a JSON fragment. Null for creation events. Encoded as a JSON
	// value (object, array, string, number, boolean, or null), not a JSON-encoded
	// string.
	OldValue any `json:"old_value" api:"required"`
	// JSON contains metadata for fields, check presence with [respjson.Field.Valid].
	JSON struct {
		Field       respjson.Field
		NewValue    respjson.Field
		Object      respjson.Field
		OldValue    respjson.Field
		ExtraFields map[string]respjson.Field
		// contains filtered or unexported fields
	} `json:"-"`
}

Field-level before/after transition recorded during a mutation.

func (AuditFieldChange) RawJSON 

func (r AuditFieldChange) RawJSON() string

Returns the unmodified JSON received from the API

func (*AuditFieldChange) UnmarshalJSON 

func (r *AuditFieldChange) UnmarshalJSON(data []byte) error

type AuditFieldChangeObject 

type AuditFieldChangeObject string

Resource type identifier. 

const (
	AuditFieldChangeObjectAuditFieldChange AuditFieldChangeObject = "audit_field_change"
)

type AuthAPIKeyActionRotateParams 

type AuthAPIKeyActionRotateParams struct {
	// Sub-objects to expand in the response. When omitted, sub-objects are returned as
	// `null`.
	//
	// Any of "role", "role.permissions".
	Include []string `query:"include,omitzero" json:"-"`
	// Request to rotate an API key.
	RotateAPIKeyRequest RotateAPIKeyRequestParam
	// contains filtered or unexported fields
}

func (AuthAPIKeyActionRotateParams) MarshalJSON 

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

func (AuthAPIKeyActionRotateParams) URLQuery 

func (r AuthAPIKeyActionRotateParams) URLQuery() (v url.Values, err error)

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

func (*AuthAPIKeyActionRotateParams) UnmarshalJSON 

func (r *AuthAPIKeyActionRotateParams) UnmarshalJSON(data []byte) error

type AuthAPIKeyActionService 

type AuthAPIKeyActionService struct {
	// contains filtered or unexported fields
}

Create and manage API keys for programmatic access.

AuthAPIKeyActionService contains methods and other services that help with interacting with the augno 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 NewAuthAPIKeyActionService method instead.

func NewAuthAPIKeyActionService 

func NewAuthAPIKeyActionService(opts ...option.RequestOption) (r AuthAPIKeyActionService)

NewAuthAPIKeyActionService 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 (*AuthAPIKeyActionService) Rotate 

func (r *AuthAPIKeyActionService) Rotate(ctx context.Context, id string, params AuthAPIKeyActionRotateParams, opts ...option.RequestOption) (res *CreatedAPIKey, err error)

Rotates an [API key](https://docs.augno.com/api/api-keys) by revoking the existing key and issuing a replacement with the same name, role, and expiration (unless overridden).

The secret key is returned once and cannot be retrieved later, so you should store it securely. We provide some [recommendations](https://docs.augno.com/api/managing-api-keys) on how you can manage your API keys.

type AuthAPIKeyDeleteResponse 

type AuthAPIKeyDeleteResponse struct {
	// JSON contains metadata for fields, check presence with [respjson.Field.Valid].
	JSON struct {
		ExtraFields map[string]respjson.Field
		// contains filtered or unexported fields
	} `json:"-"`
}

func (AuthAPIKeyDeleteResponse) RawJSON 

func (r AuthAPIKeyDeleteResponse) RawJSON() string

Returns the unmodified JSON received from the API

func (*AuthAPIKeyDeleteResponse) UnmarshalJSON 

func (r *AuthAPIKeyDeleteResponse) UnmarshalJSON(data []byte) error

type AuthAPIKeyGetParams 

type AuthAPIKeyGetParams struct {
	// Sub-objects to expand in the response. When omitted, sub-objects are returned as
	// `null`.
	//
	// Any of "role", "role.permissions".
	Include []string `query:"include,omitzero" json:"-"`
	// contains filtered or unexported fields
}

func (AuthAPIKeyGetParams) URLQuery 

func (r AuthAPIKeyGetParams) URLQuery() (v url.Values, err error)

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

type AuthAPIKeyListParams 

type AuthAPIKeyListParams struct {
	// Cursor token used to retrieve the next or previous page of results.
	Cursor param.Opt[string] `query:"cursor,omitzero" json:"-"`
	// Maximum number of results per page (default: 100, max: 1000).
	Limit param.Opt[int64] `query:"limit,omitzero" json:"-"`
	// Search query used to filter results.
	Q param.Opt[string] `query:"q,omitzero" json:"-"`
	// Sub-objects to expand in the response. When omitted, sub-objects are returned as
	// `null`.
	//
	// Any of "role", "role.permissions".
	Include []string `query:"include,omitzero" json:"-"`
	// API key statuses to filter by.
	//
	// Any of "active", "expired", "revoked".
	Statuses []string `query:"statuses,omitzero" json:"-"`
	// contains filtered or unexported fields
}

func (AuthAPIKeyListParams) URLQuery 

func (r AuthAPIKeyListParams) URLQuery() (v url.Values, err error)

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

type AuthAPIKeyNewParams 

type AuthAPIKeyNewParams struct {
	// Request to create an API key.
	CreateAPIKeyRequest CreateAPIKeyRequestParam
	// Sub-objects to expand in the response. When omitted, sub-objects are returned as
	// `null`.
	//
	// Any of "role", "role.permissions".
	Include []string `query:"include,omitzero" json:"-"`
	// contains filtered or unexported fields
}

func (AuthAPIKeyNewParams) MarshalJSON 

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

func (AuthAPIKeyNewParams) URLQuery 

func (r AuthAPIKeyNewParams) URLQuery() (v url.Values, err error)

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

func (*AuthAPIKeyNewParams) UnmarshalJSON 

func (r *AuthAPIKeyNewParams) UnmarshalJSON(data []byte) error

type AuthAPIKeyService 

type AuthAPIKeyService struct {

	// Create and manage API keys for programmatic access.
	Actions AuthAPIKeyActionService
	// contains filtered or unexported fields
}

Create and manage API keys for programmatic access.

AuthAPIKeyService contains methods and other services that help with interacting with the augno 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 NewAuthAPIKeyService method instead.

func NewAuthAPIKeyService 

func NewAuthAPIKeyService(opts ...option.RequestOption) (r AuthAPIKeyService)

NewAuthAPIKeyService 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 (*AuthAPIKeyService) Delete 

func (r *AuthAPIKeyService) Delete(ctx context.Context, id string, opts ...option.RequestOption) (res *AuthAPIKeyDeleteResponse, err error)

Revokes an [API key](https://docs.augno.com/api/api-keys).

Revoked API keys will be unable to be used to authenticate requests.

func (*AuthAPIKeyService) Get 

func (r *AuthAPIKeyService) Get(ctx context.Context, id string, query AuthAPIKeyGetParams, opts ...option.RequestOption) (res *APIKey, err error)

Returns [API key](https://docs.augno.com/api/api-keys) metadata by ID.

func (*AuthAPIKeyService) List 

func (r *AuthAPIKeyService) List(ctx context.Context, query AuthAPIKeyListParams, opts ...option.RequestOption) (res *ListAPIKey, err error)

Returns a paginated list of [API keys](https://docs.augno.com/api/api-keys).

func (*AuthAPIKeyService) New 

func (r *AuthAPIKeyService) New(ctx context.Context, params AuthAPIKeyNewParams, opts ...option.RequestOption) (res *CreatedAPIKey, err error)

Creates an [API key](https://docs.augno.com/api/api-keys) to authenticate API requests.

The secret key is returned once and cannot be retrieved later, so you should store it securely. We provide some [recommendations](https://docs.augno.com/api/managing-api-keys) on how you can manage your API keys.

type AuthService 

type AuthService struct {

	// Create and manage API keys for programmatic access.
	APIKeys AuthAPIKeyService
	// contains filtered or unexported fields
}

AuthService contains methods and other services that help with interacting with the augno 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 NewAuthService method instead.

func NewAuthService 

func NewAuthService(opts ...option.RequestOption) (r AuthService)

NewAuthService 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.

type Carrier 

type Carrier struct {
	// Carrier ID.
	ID string `json:"id" api:"required"`
	// Account number.
	AccountNumber string `json:"account_number" api:"required"`
	// Carrier code.
	//
	// Any of "fedex", "ups", "usps", "will_call", "delivery", "ltl", "ltl1",
	// "freight_collect".
	Code CarrierCode `json:"code" api:"required"`
	// Creation timestamp.
	CreatedAt time.Time `json:"created_at" api:"required" format:"date-time"`
	// Customer portal visibility.
	//
	// Any of "visible", "hidden".
	CustomerPortalVisibility CarrierCustomerPortalVisibility `json:"customer_portal_visibility" api:"required"`
	// Soft-delete timestamp.
	DeletedAt time.Time `json:"deleted_at" api:"required" format:"date-time"`
	// Display name.
	Name string `json:"name" api:"required"`
	// Resource type identifier.
	//
	// Any of "carrier".
	Object CarrierObject `json:"object" api:"required"`
	// Owner describes the provenance of a resource.
	Owner Owner `json:"owner" api:"required"`
	// List represents a paginated list of resources.
	ServiceLevels ListServiceLevel `json:"service_levels" api:"required"`
	// Last updated timestamp.
	UpdatedAt time.Time `json:"updated_at" api:"required" format:"date-time"`
	// JSON contains metadata for fields, check presence with [respjson.Field.Valid].
	JSON struct {
		ID                       respjson.Field
		AccountNumber            respjson.Field
		Code                     respjson.Field
		CreatedAt                respjson.Field
		CustomerPortalVisibility respjson.Field
		DeletedAt                respjson.Field
		Name                     respjson.Field
		Object                   respjson.Field
		Owner                    respjson.Field
		ServiceLevels            respjson.Field
		UpdatedAt                respjson.Field
		ExtraFields              map[string]respjson.Field
		// contains filtered or unexported fields
	} `json:"-"`
}

Carrier resource.

func (Carrier) RawJSON 

func (r Carrier) RawJSON() string

Returns the unmodified JSON received from the API

func (*Carrier) UnmarshalJSON 

func (r *Carrier) UnmarshalJSON(data []byte) error

type CarrierCode 

type CarrierCode string

Carrier code. 

const (
	CarrierCodeFedex          CarrierCode = "fedex"
	CarrierCodeUps            CarrierCode = "ups"
	CarrierCodeUsps           CarrierCode = "usps"
	CarrierCodeWillCall       CarrierCode = "will_call"
	CarrierCodeDelivery       CarrierCode = "delivery"
	CarrierCodeLtl            CarrierCode = "ltl"
	CarrierCodeLtl1           CarrierCode = "ltl1"
	CarrierCodeFreightCollect CarrierCode = "freight_collect"
)

type CarrierCustomerPortalVisibility 

type CarrierCustomerPortalVisibility string

Customer portal visibility. 

const (
	CarrierCustomerPortalVisibilityVisible CarrierCustomerPortalVisibility = "visible"
	CarrierCustomerPortalVisibilityHidden  CarrierCustomerPortalVisibility = "hidden"
)

type CarrierObject 

type CarrierObject string

Resource type identifier. 

const (
	CarrierObjectCarrier CarrierObject = "carrier"
)

type CatalogItemAttributeDeleteParams 

type CatalogItemAttributeDeleteParams struct {
	ID string `path:"id" api:"required" json:"-"`
	// Sub-objects to expand in the response. When omitted, sub-objects are returned as
	// `null`.
	//
	// Any of "category", "unit_value", "unit_cost", "burn_rate", "attributes",
	// "category.unit_group", "category.properties", "category.unit_group.base_unit",
	// "category.unit_group.associated_units",
	// "category.unit_group.associated_units.unit".
	Include []string `query:"include,omitzero" json:"-"`
	// contains filtered or unexported fields
}

func (CatalogItemAttributeDeleteParams) URLQuery 

func (r CatalogItemAttributeDeleteParams) URLQuery() (v url.Values, err error)

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

type CatalogItemAttributeService 

type CatalogItemAttributeService struct {
	// contains filtered or unexported fields
}

List and manage inventory items.

CatalogItemAttributeService contains methods and other services that help with interacting with the augno 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 NewCatalogItemAttributeService method instead.

func NewCatalogItemAttributeService 

func NewCatalogItemAttributeService(opts ...option.RequestOption) (r CatalogItemAttributeService)

NewCatalogItemAttributeService 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 (*CatalogItemAttributeService) Delete 

func (r *CatalogItemAttributeService) Delete(ctx context.Context, attributeID string, params CatalogItemAttributeDeleteParams, opts ...option.RequestOption) (res *Item, err error)

Removes an attribute from an item.

func (*CatalogItemAttributeService) Update 

func (r *CatalogItemAttributeService) Update(ctx context.Context, attributeID string, params CatalogItemAttributeUpdateParams, opts ...option.RequestOption) (res *Item, err error)

Adds an attribute to an item. If the attribute is already associated with the item, this is a no-op.

type CatalogItemAttributeUpdateParams 

type CatalogItemAttributeUpdateParams struct {
	ID string `path:"id" api:"required" json:"-"`
	// Sub-objects to expand in the response. When omitted, sub-objects are returned as
	// `null`.
	//
	// Any of "category", "unit_value", "unit_cost", "burn_rate", "attributes",
	// "category.unit_group", "category.properties", "category.unit_group.base_unit",
	// "category.unit_group.associated_units",
	// "category.unit_group.associated_units.unit".
	Include []string `query:"include,omitzero" json:"-"`
	// contains filtered or unexported fields
}

func (CatalogItemAttributeUpdateParams) URLQuery 

func (r CatalogItemAttributeUpdateParams) URLQuery() (v url.Values, err error)

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

type CatalogItemCategoryChangeUnitGroupParams 

type CatalogItemCategoryChangeUnitGroupParams struct {
	ID string `path:"id" api:"required" json:"-"`
	// contains filtered or unexported fields
}

type CatalogItemCategoryChangeUnitGroupResponse 

type CatalogItemCategoryChangeUnitGroupResponse struct {
	// JSON contains metadata for fields, check presence with [respjson.Field.Valid].
	JSON struct {
		ExtraFields map[string]respjson.Field
		// contains filtered or unexported fields
	} `json:"-"`
}

func (CatalogItemCategoryChangeUnitGroupResponse) RawJSON 

func (r CatalogItemCategoryChangeUnitGroupResponse) RawJSON() string

Returns the unmodified JSON received from the API

func (*CatalogItemCategoryChangeUnitGroupResponse) UnmarshalJSON 

func (r *CatalogItemCategoryChangeUnitGroupResponse) UnmarshalJSON(data []byte) error

type CatalogItemCategoryDeleteResponse 

type CatalogItemCategoryDeleteResponse struct {
	// JSON contains metadata for fields, check presence with [respjson.Field.Valid].
	JSON struct {
		ExtraFields map[string]respjson.Field
		// contains filtered or unexported fields
	} `json:"-"`
}

func (CatalogItemCategoryDeleteResponse) RawJSON 

func (r CatalogItemCategoryDeleteResponse) RawJSON() string

Returns the unmodified JSON received from the API

func (*CatalogItemCategoryDeleteResponse) UnmarshalJSON 

func (r *CatalogItemCategoryDeleteResponse) UnmarshalJSON(data []byte) error

type CatalogItemCategoryGetParams 

type CatalogItemCategoryGetParams struct {
	// Sub-objects to expand in the response. When omitted, sub-objects are returned as
	// `null`.
	//
	// Any of "owner", "owner.account", "properties", "unit_group",
	// "unit_group.base_unit", "unit_group.associated_units",
	// "unit_group.associated_units.unit".
	Include []string `query:"include,omitzero" json:"-"`
	// contains filtered or unexported fields
}

func (CatalogItemCategoryGetParams) URLQuery 

func (r CatalogItemCategoryGetParams) URLQuery() (v url.Values, err error)

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

type CatalogItemCategoryListParams 

type CatalogItemCategoryListParams struct {
	// Cursor token used to retrieve the next or previous page of results.
	Cursor param.Opt[string] `query:"cursor,omitzero" json:"-"`
	// Maximum number of results per page (default: 100, max: 1000).
	Limit param.Opt[int64] `query:"limit,omitzero" json:"-"`
	// Search query used to filter results.
	Q param.Opt[string] `query:"q,omitzero" json:"-"`
	// Sub-objects to expand in the response. When omitted, sub-objects are returned as
	// `null`.
	//
	// Any of "owner", "owner.account", "properties", "unit_group",
	// "unit_group.base_unit", "unit_group.associated_units",
	// "unit_group.associated_units.unit".
	Include []string `query:"include,omitzero" json:"-"`
	// Filter by item category type.
	//
	// Any of "material_category", "product_category".
	Type CatalogItemCategoryListParamsType `query:"type,omitzero" json:"-"`
	// contains filtered or unexported fields
}

func (CatalogItemCategoryListParams) URLQuery 

func (r CatalogItemCategoryListParams) URLQuery() (v url.Values, err error)

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

type CatalogItemCategoryListParamsType 

type CatalogItemCategoryListParamsType string

Filter by item category type. 

const (
	CatalogItemCategoryListParamsTypeMaterialCategory CatalogItemCategoryListParamsType = "material_category"
	CatalogItemCategoryListParamsTypeProductCategory  CatalogItemCategoryListParamsType = "product_category"
)

type CatalogItemCategoryNewParams 

type CatalogItemCategoryNewParams struct {
	// Request to create an item category.
	CreateItemCategoryRequest CreateItemCategoryRequestParam
	// Sub-objects to expand in the response. When omitted, sub-objects are returned as
	// `null`.
	//
	// Any of "owner", "owner.account", "properties", "unit_group",
	// "unit_group.base_unit", "unit_group.associated_units",
	// "unit_group.associated_units.unit".
	Include []string `query:"include,omitzero" json:"-"`
	// contains filtered or unexported fields
}

func (CatalogItemCategoryNewParams) MarshalJSON 

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

func (CatalogItemCategoryNewParams) URLQuery 

func (r CatalogItemCategoryNewParams) URLQuery() (v url.Values, err error)

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

func (*CatalogItemCategoryNewParams) UnmarshalJSON 

func (r *CatalogItemCategoryNewParams) UnmarshalJSON(data []byte) error

type CatalogItemCategoryPropertyDeleteParams 

type CatalogItemCategoryPropertyDeleteParams struct {
	ID string `path:"id" api:"required" json:"-"`
	// contains filtered or unexported fields
}

type CatalogItemCategoryPropertyDeleteResponse 

type CatalogItemCategoryPropertyDeleteResponse struct {
	// JSON contains metadata for fields, check presence with [respjson.Field.Valid].
	JSON struct {
		ExtraFields map[string]respjson.Field
		// contains filtered or unexported fields
	} `json:"-"`
}

func (CatalogItemCategoryPropertyDeleteResponse) RawJSON 

func (r CatalogItemCategoryPropertyDeleteResponse) RawJSON() string

Returns the unmodified JSON received from the API

func (*CatalogItemCategoryPropertyDeleteResponse) UnmarshalJSON 

func (r *CatalogItemCategoryPropertyDeleteResponse) UnmarshalJSON(data []byte) error

type CatalogItemCategoryPropertyService 

type CatalogItemCategoryPropertyService struct {
	// contains filtered or unexported fields
}

List and manage item categories.

CatalogItemCategoryPropertyService contains methods and other services that help with interacting with the augno 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 NewCatalogItemCategoryPropertyService method instead.

func NewCatalogItemCategoryPropertyService 

func NewCatalogItemCategoryPropertyService(opts ...option.RequestOption) (r CatalogItemCategoryPropertyService)

NewCatalogItemCategoryPropertyService 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 (*CatalogItemCategoryPropertyService) Delete 

func (r *CatalogItemCategoryPropertyService) Delete(ctx context.Context, propertyID string, body CatalogItemCategoryPropertyDeleteParams, opts ...option.RequestOption) (res *CatalogItemCategoryPropertyDeleteResponse, err error)

Removes a property from an item category. Default system categories cannot be modified.

func (*CatalogItemCategoryPropertyService) Update 

func (r *CatalogItemCategoryPropertyService) Update(ctx context.Context, propertyID string, body CatalogItemCategoryPropertyUpdateParams, opts ...option.RequestOption) (res *CatalogItemCategoryPropertyUpdateResponse, err error)

Adds a property to an item category. Default system categories cannot be modified.

type CatalogItemCategoryPropertyUpdateParams 

type CatalogItemCategoryPropertyUpdateParams struct {
	ID string `path:"id" api:"required" json:"-"`
	// contains filtered or unexported fields
}

type CatalogItemCategoryPropertyUpdateResponse 

type CatalogItemCategoryPropertyUpdateResponse struct {
	// JSON contains metadata for fields, check presence with [respjson.Field.Valid].
	JSON struct {
		ExtraFields map[string]respjson.Field
		// contains filtered or unexported fields
	} `json:"-"`
}

func (CatalogItemCategoryPropertyUpdateResponse) RawJSON 

func (r CatalogItemCategoryPropertyUpdateResponse) RawJSON() string

Returns the unmodified JSON received from the API

func (*CatalogItemCategoryPropertyUpdateResponse) UnmarshalJSON 

func (r *CatalogItemCategoryPropertyUpdateResponse) UnmarshalJSON(data []byte) error

type CatalogItemCategoryService 

type CatalogItemCategoryService struct {

	// List and manage item categories.
	Properties CatalogItemCategoryPropertyService
	// contains filtered or unexported fields
}

List and manage item categories.

CatalogItemCategoryService contains methods and other services that help with interacting with the augno 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 NewCatalogItemCategoryService method instead.

func NewCatalogItemCategoryService 

func NewCatalogItemCategoryService(opts ...option.RequestOption) (r CatalogItemCategoryService)

NewCatalogItemCategoryService 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 (*CatalogItemCategoryService) ChangeUnitGroup 

func (r *CatalogItemCategoryService) ChangeUnitGroup(ctx context.Context, unitGroupID string, body CatalogItemCategoryChangeUnitGroupParams, opts ...option.RequestOption) (res *CatalogItemCategoryChangeUnitGroupResponse, err error)

Changes the unit group associated with an item category. All items in the category are updated to use the new base unit asynchronously.

func (*CatalogItemCategoryService) Delete 

func (r *CatalogItemCategoryService) Delete(ctx context.Context, id string, opts ...option.RequestOption) (res *CatalogItemCategoryDeleteResponse, err error)

Deletes an account-owned item category. Default system categories cannot be deleted.

func (*CatalogItemCategoryService) Get 

func (r *CatalogItemCategoryService) Get(ctx context.Context, id string, query CatalogItemCategoryGetParams, opts ...option.RequestOption) (res *ItemCategory, err error)

Returns an item category by ID. Includes account-specific and global system categories.

func (*CatalogItemCategoryService) List 

func (r *CatalogItemCategoryService) List(ctx context.Context, query CatalogItemCategoryListParams, opts ...option.RequestOption) (res *ListItemCategory, err error)

Returns a paginated list of item categories for the current account, including account-specific and global system categories.

func (*CatalogItemCategoryService) New 

func (r *CatalogItemCategoryService) New(ctx context.Context, params CatalogItemCategoryNewParams, opts ...option.RequestOption) (res *ItemCategory, err error)

Creates an account-owned item category.

func (*CatalogItemCategoryService) Update 

func (r *CatalogItemCategoryService) Update(ctx context.Context, id string, params CatalogItemCategoryUpdateParams, opts ...option.RequestOption) (res *ItemCategory, err error)

Partially updates an account-owned item category. Default system categories cannot be updated.

type CatalogItemCategoryUpdateParams 

type CatalogItemCategoryUpdateParams struct {
	// Sub-objects to expand in the response. When omitted, sub-objects are returned as
	// `null`.
	//
	// Any of "owner", "owner.account", "properties", "unit_group",
	// "unit_group.base_unit", "unit_group.associated_units",
	// "unit_group.associated_units.unit".
	Include []string `query:"include,omitzero" json:"-"`
	// Request to partially update an item category.
	UpdateItemCategoryRequest UpdateItemCategoryRequestParam
	// contains filtered or unexported fields
}

func (CatalogItemCategoryUpdateParams) MarshalJSON 

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

func (CatalogItemCategoryUpdateParams) URLQuery 

func (r CatalogItemCategoryUpdateParams) URLQuery() (v url.Values, err error)

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

func (*CatalogItemCategoryUpdateParams) UnmarshalJSON 

func (r *CatalogItemCategoryUpdateParams) UnmarshalJSON(data []byte) error

type CatalogItemChangeCategoryParams 

type CatalogItemChangeCategoryParams struct {
	ID string `path:"id" api:"required" json:"-"`
	// Sub-objects to expand in the response. When omitted, sub-objects are returned as
	// `null`.
	//
	// Any of "category", "unit_value", "unit_cost", "burn_rate", "attributes",
	// "category.unit_group", "category.properties", "category.unit_group.base_unit",
	// "category.unit_group.associated_units",
	// "category.unit_group.associated_units.unit".
	Include []string `query:"include,omitzero" json:"-"`
	// contains filtered or unexported fields
}

func (CatalogItemChangeCategoryParams) URLQuery 

func (r CatalogItemChangeCategoryParams) URLQuery() (v url.Values, err error)

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

type CatalogItemGetInventoryParams 

type CatalogItemGetInventoryParams struct {
	// Sub-objects to expand in the response. When omitted, sub-objects are returned as
	// `null`.
	//
	// Any of "on_hand", "reserved", "available_to_promise", "short".
	Include []string `query:"include,omitzero" json:"-"`
	// contains filtered or unexported fields
}

func (CatalogItemGetInventoryParams) URLQuery 

func (r CatalogItemGetInventoryParams) URLQuery() (v url.Values, err error)

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

type CatalogItemGetParams 

type CatalogItemGetParams struct {
	// Sub-objects to expand in the response. When omitted, sub-objects are returned as
	// `null`.
	//
	// Any of "category", "unit_value", "unit_cost", "burn_rate", "attributes",
	// "category.unit_group", "category.properties", "category.unit_group.base_unit",
	// "category.unit_group.associated_units",
	// "category.unit_group.associated_units.unit".
	Include []string `query:"include,omitzero" json:"-"`
	// contains filtered or unexported fields
}

func (CatalogItemGetParams) URLQuery 

func (r CatalogItemGetParams) URLQuery() (v url.Values, err error)

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

type CatalogItemListParams 

type CatalogItemListParams struct {
	// Cursor token used to retrieve the next or previous page of results.
	Cursor param.Opt[string] `query:"cursor,omitzero" json:"-"`
	// Filter items created on or before this date.
	EndDate param.Opt[time.Time] `query:"end_date,omitzero" format:"date-time" json:"-"`
	// Maximum number of results per page (default: 100, max: 1000).
	Limit param.Opt[int64] `query:"limit,omitzero" json:"-"`
	// Search query used to filter results.
	Q param.Opt[string] `query:"q,omitzero" json:"-"`
	// Filter items created on or after this date.
	StartDate param.Opt[time.Time] `query:"start_date,omitzero" format:"date-time" json:"-"`
	// Filter by supplier ID.
	SupplierID param.Opt[string] `query:"supplier_id,omitzero" json:"-"`
	// Filter by attribute IDs.
	AttributeIDs []string `query:"attribute_ids,omitzero" json:"-"`
	// Filter by category IDs.
	CategoryIDs []string `query:"category_ids,omitzero" json:"-"`
	// Filter by customer account IDs (only items whose product line is accessible to
	// any of these customers).
	CustomerIDs []string `query:"customer_ids,omitzero" json:"-"`
	// Sub-objects to expand in the response. When omitted, sub-objects are returned as
	// `null`.
	//
	// Any of "category", "unit_value", "unit_cost", "burn_rate", "attributes",
	// "category.unit_group", "category.properties", "category.unit_group.base_unit",
	// "category.unit_group.associated_units",
	// "category.unit_group.associated_units.unit".
	Include []string `query:"include,omitzero" json:"-"`
	// Filter by product line IDs (only items whose product belongs to one of these
	// lines).
	ProductLineIDs []string `query:"product_line_ids,omitzero" json:"-"`
	// Which subassemblies to include when listing (default: all).
	//
	// Any of "all", "initial_only".
	SubassemblyFilter CatalogItemListParamsSubassemblyFilter `query:"subassembly_filter,omitzero" json:"-"`
	// Filter by item type codes.
	Types []string `query:"types,omitzero" json:"-"`
	// contains filtered or unexported fields
}

func (CatalogItemListParams) URLQuery 

func (r CatalogItemListParams) URLQuery() (v url.Values, err error)

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

type CatalogItemListParamsSubassemblyFilter 

type CatalogItemListParamsSubassemblyFilter string

Which subassemblies to include when listing (default: all). 

const (
	CatalogItemListParamsSubassemblyFilterAll         CatalogItemListParamsSubassemblyFilter = "all"
	CatalogItemListParamsSubassemblyFilterInitialOnly CatalogItemListParamsSubassemblyFilter = "initial_only"
)

type CatalogItemService 

type CatalogItemService struct {

	// List and manage inventory items.
	Attributes CatalogItemAttributeService
	// contains filtered or unexported fields
}

List and manage inventory items.

CatalogItemService contains methods and other services that help with interacting with the augno 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 NewCatalogItemService method instead.

func NewCatalogItemService 

func NewCatalogItemService(opts ...option.RequestOption) (r CatalogItemService)

NewCatalogItemService 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 (*CatalogItemService) ChangeCategory 

func (r *CatalogItemService) ChangeCategory(ctx context.Context, categoryID string, params CatalogItemChangeCategoryParams, opts ...option.RequestOption) (res *Item, err error)

Changes the category of an item. When the category changes, the item's rate units are updated to the new category's base unit.

func (*CatalogItemService) Get 

func (r *CatalogItemService) Get(ctx context.Context, id string, query CatalogItemGetParams, opts ...option.RequestOption) (res *Item, err error)

Returns an item by ID.

func (*CatalogItemService) GetInventory 

func (r *CatalogItemService) GetInventory(ctx context.Context, id string, query CatalogItemGetInventoryParams, opts ...option.RequestOption) (res *ItemInventory, err error)

Returns inventory quantities for an item, including on-hand, reserved, available-to-promise, and short amounts.

func (*CatalogItemService) List 

func (r *CatalogItemService) List(ctx context.Context, query CatalogItemListParams, opts ...option.RequestOption) (res *ListItem, err error)

Returns a paginated list of items.

type CatalogMaterialGetParams 

type CatalogMaterialGetParams struct {
	// Sub-objects to expand in the response. When omitted, sub-objects are returned as
	// `null`.
	//
	// Any of "item", "item.category", "item.category.properties",
	// "item.category.unit_group", "item.unit_value", "item.unit_cost",
	// "item.burn_rate", "item.attributes".
	Include []string `query:"include,omitzero" json:"-"`
	// contains filtered or unexported fields
}

func (CatalogMaterialGetParams) URLQuery 

func (r CatalogMaterialGetParams) URLQuery() (v url.Values, err error)

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

type CatalogMaterialListParams 

type CatalogMaterialListParams struct {
	// Cursor token used to retrieve the next or previous page of results.
	Cursor param.Opt[string] `query:"cursor,omitzero" json:"-"`
	// Filter to materials created on or before this date.
	EndDate param.Opt[time.Time] `query:"end_date,omitzero" format:"date-time" json:"-"`
	// Maximum number of results per page (default: 100, max: 1000).
	Limit param.Opt[int64] `query:"limit,omitzero" json:"-"`
	// Search query used to filter results.
	Q param.Opt[string] `query:"q,omitzero" json:"-"`
	// Filter to materials created on or after this date.
	StartDate param.Opt[time.Time] `query:"start_date,omitzero" format:"date-time" json:"-"`
	// Filter by attribute IDs.
	AttributeIDs []string `query:"attribute_ids,omitzero" json:"-"`
	// Filter by category IDs.
	CategoryIDs []string `query:"category_ids,omitzero" json:"-"`
	// Sub-objects to expand in the response. When omitted, sub-objects are returned as
	// `null`.
	//
	// Any of "item", "item.category", "item.category.properties",
	// "item.category.unit_group", "item.unit_value", "item.unit_cost",
	// "item.burn_rate", "item.attributes".
	Include []string `query:"include,omitzero" json:"-"`
	// contains filtered or unexported fields
}

func (CatalogMaterialListParams) URLQuery 

func (r CatalogMaterialListParams) URLQuery() (v url.Values, err error)

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

type CatalogMaterialNewParams 

type CatalogMaterialNewParams struct {
	// Request to create a material.
	CreateMaterialRequest CreateMaterialRequestParam
	// Sub-objects to expand in the response. When omitted, sub-objects are returned as
	// `null`.
	//
	// Any of "item", "item.category", "item.category.properties",
	// "item.category.unit_group", "item.unit_value", "item.unit_cost",
	// "item.burn_rate", "item.attributes".
	Include []string `query:"include,omitzero" json:"-"`
	// contains filtered or unexported fields
}

func (CatalogMaterialNewParams) MarshalJSON 

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

func (CatalogMaterialNewParams) URLQuery 

func (r CatalogMaterialNewParams) URLQuery() (v url.Values, err error)

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

func (*CatalogMaterialNewParams) UnmarshalJSON 

func (r *CatalogMaterialNewParams) UnmarshalJSON(data []byte) error

type CatalogMaterialService 

type CatalogMaterialService struct {
	// contains filtered or unexported fields
}

List and manage materials.

CatalogMaterialService contains methods and other services that help with interacting with the augno 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 NewCatalogMaterialService method instead.

func NewCatalogMaterialService 

func NewCatalogMaterialService(opts ...option.RequestOption) (r CatalogMaterialService)

NewCatalogMaterialService 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 (*CatalogMaterialService) Delete 

func (r *CatalogMaterialService) Delete(ctx context.Context, id string, opts ...option.RequestOption) (res *Material, err error)

Deletes a material by ID.

func (*CatalogMaterialService) Get 

func (r *CatalogMaterialService) Get(ctx context.Context, id string, query CatalogMaterialGetParams, opts ...option.RequestOption) (res *Material, err error)

Returns a material by ID.

func (*CatalogMaterialService) List 

func (r *CatalogMaterialService) List(ctx context.Context, query CatalogMaterialListParams, opts ...option.RequestOption) (res *ListMaterial, err error)

Returns a paginated list of materials.

func (*CatalogMaterialService) New 

func (r *CatalogMaterialService) New(ctx context.Context, params CatalogMaterialNewParams, opts ...option.RequestOption) (res *Material, err error)

Creates a material.

func (*CatalogMaterialService) Update 

func (r *CatalogMaterialService) Update(ctx context.Context, id string, params CatalogMaterialUpdateParams, opts ...option.RequestOption) (res *Material, err error)

Partially updates a material.

type CatalogMaterialUpdateParams 

type CatalogMaterialUpdateParams struct {
	// Sub-objects to expand in the response. When omitted, sub-objects are returned as
	// `null`.
	//
	// Any of "item", "item.category", "item.category.properties",
	// "item.category.unit_group", "item.unit_value", "item.unit_cost",
	// "item.burn_rate", "item.attributes".
	Include []string `query:"include,omitzero" json:"-"`
	// Request to update a material.
	UpdateMaterialRequest UpdateMaterialRequestParam
	// contains filtered or unexported fields
}

func (CatalogMaterialUpdateParams) MarshalJSON 

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

func (CatalogMaterialUpdateParams) URLQuery 

func (r CatalogMaterialUpdateParams) URLQuery() (v url.Values, err error)

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

func (*CatalogMaterialUpdateParams) UnmarshalJSON 

func (r *CatalogMaterialUpdateParams) UnmarshalJSON(data []byte) error

type CatalogPartGetParams 

type CatalogPartGetParams struct {
	// Sub-objects to expand in the response. When omitted, sub-objects are returned as
	// `null`.
	//
	// Any of "item", "item.category", "item.category.properties",
	// "item.category.unit_group", "item.unit_value", "item.unit_cost",
	// "item.burn_rate", "item.attributes".
	Include []string `query:"include,omitzero" json:"-"`
	// contains filtered or unexported fields
}

func (CatalogPartGetParams) URLQuery 

func (r CatalogPartGetParams) URLQuery() (v url.Values, err error)

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

type CatalogPartListParams 

type CatalogPartListParams struct {
	// Cursor token used to retrieve the next or previous page of results.
	Cursor param.Opt[string] `query:"cursor,omitzero" json:"-"`
	// Filter parts created on or before this date.
	EndDate param.Opt[time.Time] `query:"end_date,omitzero" format:"date-time" json:"-"`
	// Maximum number of results per page (default: 100, max: 1000).
	Limit param.Opt[int64] `query:"limit,omitzero" json:"-"`
	// Search query used to filter results.
	Q param.Opt[string] `query:"q,omitzero" json:"-"`
	// Filter parts created on or after this date.
	StartDate param.Opt[time.Time] `query:"start_date,omitzero" format:"date-time" json:"-"`
	// Filter by attribute IDs.
	AttributeIDs []string `query:"attribute_ids,omitzero" json:"-"`
	// Filter by category IDs.
	CategoryIDs []string `query:"category_ids,omitzero" json:"-"`
	// Sub-objects to expand in the response. When omitted, sub-objects are returned as
	// `null`.
	//
	// Any of "item", "item.category", "item.category.properties",
	// "item.category.unit_group", "item.unit_value", "item.unit_cost",
	// "item.burn_rate", "item.attributes".
	Include []string `query:"include,omitzero" json:"-"`
	// contains filtered or unexported fields
}

func (CatalogPartListParams) URLQuery 

func (r CatalogPartListParams) URLQuery() (v url.Values, err error)

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

type CatalogPartNewParams 

type CatalogPartNewParams struct {
	// Request to create a part.
	CreatePartRequest CreatePartRequestParam
	// Sub-objects to expand in the response. When omitted, sub-objects are returned as
	// `null`.
	//
	// Any of "item", "item.category", "item.unit_value", "item.unit_cost",
	// "item.burn_rate", "item.attributes".
	Include []string `query:"include,omitzero" json:"-"`
	// contains filtered or unexported fields
}

func (CatalogPartNewParams) MarshalJSON 

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

func (CatalogPartNewParams) URLQuery 

func (r CatalogPartNewParams) URLQuery() (v url.Values, err error)

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

func (*CatalogPartNewParams) UnmarshalJSON 

func (r *CatalogPartNewParams) UnmarshalJSON(data []byte) error

type CatalogPartService 

type CatalogPartService struct {
	// contains filtered or unexported fields
}

List and manage parts.

CatalogPartService contains methods and other services that help with interacting with the augno 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 NewCatalogPartService method instead.

func NewCatalogPartService 

func NewCatalogPartService(opts ...option.RequestOption) (r CatalogPartService)

NewCatalogPartService 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 (*CatalogPartService) Delete 

func (r *CatalogPartService) Delete(ctx context.Context, id string, opts ...option.RequestOption) (res *Part, err error)

Deletes a part. Sets the deleted_at timestamp rather than removing the record.

func (*CatalogPartService) Get 

func (r *CatalogPartService) Get(ctx context.Context, id string, query CatalogPartGetParams, opts ...option.RequestOption) (res *Part, err error)

Returns a part by ID.

func (*CatalogPartService) List 

func (r *CatalogPartService) List(ctx context.Context, query CatalogPartListParams, opts ...option.RequestOption) (res *ListPart, err error)

Returns a paginated list of parts for the current account.

func (*CatalogPartService) New 

func (r *CatalogPartService) New(ctx context.Context, params CatalogPartNewParams, opts ...option.RequestOption) (res *Part, err error)

Creates a part with the specified SKU and category.

func (*CatalogPartService) Update 

func (r *CatalogPartService) Update(ctx context.Context, id string, params CatalogPartUpdateParams, opts ...option.RequestOption) (res *Part, err error)

Partially updates a part. Fields not provided retain their current values.

type CatalogPartUpdateParams 

type CatalogPartUpdateParams struct {
	// Sub-objects to expand in the response. When omitted, sub-objects are returned as
	// `null`.
	//
	// Any of "item", "item.category", "item.unit_value", "item.unit_cost",
	// "item.burn_rate", "item.attributes".
	Include []string `query:"include,omitzero" json:"-"`
	// Request to partially update a part.
	UpdatePartRequest UpdatePartRequestParam
	// contains filtered or unexported fields
}

func (CatalogPartUpdateParams) MarshalJSON 

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

func (CatalogPartUpdateParams) URLQuery 

func (r CatalogPartUpdateParams) URLQuery() (v url.Values, err error)

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

func (*CatalogPartUpdateParams) UnmarshalJSON 

func (r *CatalogPartUpdateParams) UnmarshalJSON(data []byte) error

type CatalogProductChangeProductLineParams 

type CatalogProductChangeProductLineParams struct {
	ID string `path:"id" api:"required" json:"-"`
	// Sub-objects to expand in the response. When omitted, sub-objects are returned as
	// `null`.
	//
	// Any of "product_line", "product_line.unit_group",
	// "product_line.unit_group.base_unit", "product_line.unit_group.associated_units",
	// "product_line.unit_group.associated_units.unit", "item", "item.category",
	// "item.category.properties", "item.category.unit_group",
	// "item.category.unit_group.base_unit",
	// "item.category.unit_group.associated_units",
	// "item.category.unit_group.associated_units.unit", "item.unit_value",
	// "item.unit_cost", "item.burn_rate", "item.attributes".
	Include []string `query:"include,omitzero" json:"-"`
	// contains filtered or unexported fields
}

func (CatalogProductChangeProductLineParams) URLQuery 

func (r CatalogProductChangeProductLineParams) URLQuery() (v url.Values, err error)

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

type CatalogProductDeleteParams 

type CatalogProductDeleteParams struct {
	// Sub-objects to expand in the response. When omitted, sub-objects are returned as
	// `null`.
	//
	// Any of "product_line", "product_line.unit_group",
	// "product_line.unit_group.base_unit", "product_line.unit_group.associated_units",
	// "product_line.unit_group.associated_units.unit", "item", "item.category",
	// "item.category.properties", "item.category.unit_group",
	// "item.category.unit_group.base_unit",
	// "item.category.unit_group.associated_units",
	// "item.category.unit_group.associated_units.unit", "item.unit_value",
	// "item.unit_cost", "item.burn_rate", "item.attributes".
	Include []string `query:"include,omitzero" json:"-"`
	// contains filtered or unexported fields
}

func (CatalogProductDeleteParams) URLQuery 

func (r CatalogProductDeleteParams) URLQuery() (v url.Values, err error)

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

type CatalogProductGetParams 

type CatalogProductGetParams struct {
	// Sub-objects to expand in the response. When omitted, sub-objects are returned as
	// `null`.
	//
	// Any of "product_line", "product_line.unit_group",
	// "product_line.unit_group.base_unit", "product_line.unit_group.associated_units",
	// "product_line.unit_group.associated_units.unit", "item", "item.category",
	// "item.category.properties", "item.category.unit_group",
	// "item.category.unit_group.base_unit",
	// "item.category.unit_group.associated_units",
	// "item.category.unit_group.associated_units.unit", "item.unit_value",
	// "item.unit_cost", "item.burn_rate", "item.attributes".
	Include []string `query:"include,omitzero" json:"-"`
	// contains filtered or unexported fields
}

func (CatalogProductGetParams) URLQuery 

func (r CatalogProductGetParams) URLQuery() (v url.Values, err error)

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

type CatalogProductLineDeleteResponse 

type CatalogProductLineDeleteResponse struct {
	// JSON contains metadata for fields, check presence with [respjson.Field.Valid].
	JSON struct {
		ExtraFields map[string]respjson.Field
		// contains filtered or unexported fields
	} `json:"-"`
}

func (CatalogProductLineDeleteResponse) RawJSON 

func (r CatalogProductLineDeleteResponse) RawJSON() string

Returns the unmodified JSON received from the API

func (*CatalogProductLineDeleteResponse) UnmarshalJSON 

func (r *CatalogProductLineDeleteResponse) UnmarshalJSON(data []byte) error

type CatalogProductLineGetParams 

type CatalogProductLineGetParams struct {
	// Sub-objects to expand in the response. When omitted, sub-objects are returned as
	// `null`.
	//
	// Any of "owner", "owner.account", "unit_group".
	Include []string `query:"include,omitzero" json:"-"`
	// contains filtered or unexported fields
}

func (CatalogProductLineGetParams) URLQuery 

func (r CatalogProductLineGetParams) URLQuery() (v url.Values, err error)

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

type CatalogProductLineListParams 

type CatalogProductLineListParams struct {
	// Cursor token used to retrieve the next or previous page of results.
	Cursor param.Opt[string] `query:"cursor,omitzero" json:"-"`
	// Maximum number of results per page (default: 100, max: 1000).
	Limit param.Opt[int64] `query:"limit,omitzero" json:"-"`
	// Search query used to filter results.
	Q param.Opt[string] `query:"q,omitzero" json:"-"`
	// Sub-objects to expand in the response. When omitted, sub-objects are returned as
	// `null`.
	//
	// Any of "owner", "owner.account", "unit_group".
	Include []string `query:"include,omitzero" json:"-"`
	// contains filtered or unexported fields
}

func (CatalogProductLineListParams) URLQuery 

func (r CatalogProductLineListParams) URLQuery() (v url.Values, err error)

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

type CatalogProductLineNewParams 

type CatalogProductLineNewParams struct {
	// Request to create a product line.
	CreateProductLineRequest CreateProductLineRequestParam
	// Sub-objects to expand in the response. When omitted, sub-objects are returned as
	// `null`.
	//
	// Any of "owner", "owner.account", "unit_group".
	Include []string `query:"include,omitzero" json:"-"`
	// contains filtered or unexported fields
}

func (CatalogProductLineNewParams) MarshalJSON 

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

func (CatalogProductLineNewParams) URLQuery 

func (r CatalogProductLineNewParams) URLQuery() (v url.Values, err error)

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

func (*CatalogProductLineNewParams) UnmarshalJSON 

func (r *CatalogProductLineNewParams) UnmarshalJSON(data []byte) error

type CatalogProductLineService 

type CatalogProductLineService struct {
	// contains filtered or unexported fields
}

List and manage product lines.

CatalogProductLineService contains methods and other services that help with interacting with the augno 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 NewCatalogProductLineService method instead.

func NewCatalogProductLineService 

func NewCatalogProductLineService(opts ...option.RequestOption) (r CatalogProductLineService)

NewCatalogProductLineService 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 (*CatalogProductLineService) Delete 

func (r *CatalogProductLineService) Delete(ctx context.Context, id string, opts ...option.RequestOption) (res *CatalogProductLineDeleteResponse, err error)

Deletes an account-owned product line. Default system product lines cannot be deleted.

func (*CatalogProductLineService) Get 

func (r *CatalogProductLineService) Get(ctx context.Context, id string, query CatalogProductLineGetParams, opts ...option.RequestOption) (res *ProductLine, err error)

Returns a product line by ID, including system-owned product lines accessible to the account.

func (*CatalogProductLineService) List 

func (r *CatalogProductLineService) List(ctx context.Context, query CatalogProductLineListParams, opts ...option.RequestOption) (res *ListProductLine, err error)

Returns a paginated list of product lines, including account-owned and system product lines.

func (*CatalogProductLineService) New 

func (r *CatalogProductLineService) New(ctx context.Context, params CatalogProductLineNewParams, opts ...option.RequestOption) (res *ProductLine, err error)

Creates an account-owned product line.

func (*CatalogProductLineService) Update 

func (r *CatalogProductLineService) Update(ctx context.Context, id string, params CatalogProductLineUpdateParams, opts ...option.RequestOption) (res *ProductLine, err error)

Partially updates an account-owned product line. Default system product lines cannot be updated.

type CatalogProductLineUpdateParams 

type CatalogProductLineUpdateParams struct {
	// Sub-objects to expand in the response. When omitted, sub-objects are returned as
	// `null`.
	//
	// Any of "owner", "owner.account", "unit_group".
	Include []string `query:"include,omitzero" json:"-"`
	// Request to partially update a product line.
	UpdateProductLineRequest UpdateProductLineRequestParam
	// contains filtered or unexported fields
}

func (CatalogProductLineUpdateParams) MarshalJSON 

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

func (CatalogProductLineUpdateParams) URLQuery 

func (r CatalogProductLineUpdateParams) URLQuery() (v url.Values, err error)

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

func (*CatalogProductLineUpdateParams) UnmarshalJSON 

func (r *CatalogProductLineUpdateParams) UnmarshalJSON(data []byte) error

type CatalogProductListParams 

type CatalogProductListParams struct {
	// Cursor token used to retrieve the next or previous page of results.
	Cursor param.Opt[string] `query:"cursor,omitzero" json:"-"`
	// End of creation date range.
	EndDate param.Opt[time.Time] `query:"end_date,omitzero" format:"date-time" json:"-"`
	// Maximum number of results per page (default: 100, max: 1000).
	Limit param.Opt[int64] `query:"limit,omitzero" json:"-"`
	// Search query used to filter results.
	Q param.Opt[string] `query:"q,omitzero" json:"-"`
	// Start of creation date range.
	StartDate param.Opt[time.Time] `query:"start_date,omitzero" format:"date-time" json:"-"`
	// Filter by attribute IDs.
	AttributeIDs []string `query:"attribute_ids,omitzero" json:"-"`
	// Filter by category IDs.
	CategoryIDs []string `query:"category_ids,omitzero" json:"-"`
	// Filter by customer IDs.
	CustomerIDs []string `query:"customer_ids,omitzero" json:"-"`
	// Sub-objects to expand in the response. When omitted, sub-objects are returned as
	// `null`.
	//
	// Any of "product_line", "product_line.unit_group",
	// "product_line.unit_group.base_unit", "product_line.unit_group.associated_units",
	// "product_line.unit_group.associated_units.unit", "item", "item.category",
	// "item.category.properties", "item.category.unit_group",
	// "item.category.unit_group.base_unit",
	// "item.category.unit_group.associated_units",
	// "item.category.unit_group.associated_units.unit", "item.unit_value",
	// "item.unit_cost", "item.burn_rate", "item.attributes".
	Include []string `query:"include,omitzero" json:"-"`
	// Filter by customer portal visibility.
	//
	// Any of "visible", "hidden".
	PortalVisibility CatalogProductListParamsPortalVisibility `query:"portal_visibility,omitzero" json:"-"`
	// Filter by product line IDs.
	ProductLineIDs []string `query:"product_line_ids,omitzero" json:"-"`
	// contains filtered or unexported fields
}

func (CatalogProductListParams) URLQuery 

func (r CatalogProductListParams) URLQuery() (v url.Values, err error)

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

type CatalogProductListParamsPortalVisibility 

type CatalogProductListParamsPortalVisibility string

Filter by customer portal visibility. 

const (
	CatalogProductListParamsPortalVisibilityVisible CatalogProductListParamsPortalVisibility = "visible"
	CatalogProductListParamsPortalVisibilityHidden  CatalogProductListParamsPortalVisibility = "hidden"
)

type CatalogProductNewParams 

type CatalogProductNewParams struct {
	// CreateProductRequest is the request to create a product.
	CreateProductRequest CreateProductRequestParam
	// Sub-objects to expand in the response. When omitted, sub-objects are returned as
	// `null`.
	//
	// Any of "product_line", "product_line.unit_group",
	// "product_line.unit_group.base_unit", "product_line.unit_group.associated_units",
	// "product_line.unit_group.associated_units.unit", "item", "item.category",
	// "item.category.properties", "item.category.unit_group",
	// "item.category.unit_group.base_unit",
	// "item.category.unit_group.associated_units",
	// "item.category.unit_group.associated_units.unit", "item.unit_value",
	// "item.unit_cost", "item.burn_rate", "item.attributes".
	Include []string `query:"include,omitzero" json:"-"`
	// contains filtered or unexported fields
}

func (CatalogProductNewParams) MarshalJSON 

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

func (CatalogProductNewParams) URLQuery 

func (r CatalogProductNewParams) URLQuery() (v url.Values, err error)

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

func (*CatalogProductNewParams) UnmarshalJSON 

func (r *CatalogProductNewParams) UnmarshalJSON(data []byte) error

type CatalogProductService 

type CatalogProductService struct {
	// contains filtered or unexported fields
}

List and manage products.

CatalogProductService contains methods and other services that help with interacting with the augno 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 NewCatalogProductService method instead.

func NewCatalogProductService 

func NewCatalogProductService(opts ...option.RequestOption) (r CatalogProductService)

NewCatalogProductService 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 (*CatalogProductService) ChangeProductLine 

func (r *CatalogProductService) ChangeProductLine(ctx context.Context, productLineID string, params CatalogProductChangeProductLineParams, opts ...option.RequestOption) (res *Product, err error)

Changes the product line assignment for a product.

func (*CatalogProductService) Delete 

func (r *CatalogProductService) Delete(ctx context.Context, id string, body CatalogProductDeleteParams, opts ...option.RequestOption) (res *Product, err error)

Soft-deletes a product and returns the deleted product.

func (*CatalogProductService) Get 

func (r *CatalogProductService) Get(ctx context.Context, id string, query CatalogProductGetParams, opts ...option.RequestOption) (res *Product, err error)

Returns a product by ID.

func (*CatalogProductService) List 

func (r *CatalogProductService) List(ctx context.Context, query CatalogProductListParams, opts ...option.RequestOption) (res *ListProduct, err error)

Returns a paginated list of products for the target account.

func (*CatalogProductService) New 

func (r *CatalogProductService) New(ctx context.Context, params CatalogProductNewParams, opts ...option.RequestOption) (res *Product, err error)

Creates a product.

func (*CatalogProductService) Update 

func (r *CatalogProductService) Update(ctx context.Context, id string, params CatalogProductUpdateParams, opts ...option.RequestOption) (res *Product, err error)

Partially updates a product.

type CatalogProductUpdateParams 

type CatalogProductUpdateParams struct {
	// Sub-objects to expand in the response. When omitted, sub-objects are returned as
	// `null`.
	//
	// Any of "product_line", "product_line.unit_group",
	// "product_line.unit_group.base_unit", "product_line.unit_group.associated_units",
	// "product_line.unit_group.associated_units.unit", "item", "item.category",
	// "item.category.properties", "item.category.unit_group",
	// "item.category.unit_group.base_unit",
	// "item.category.unit_group.associated_units",
	// "item.category.unit_group.associated_units.unit", "item.unit_value",
	// "item.unit_cost", "item.burn_rate", "item.attributes".
	Include []string `query:"include,omitzero" json:"-"`
	// UpdateProductRequest is the request to partially update a product.
	UpdateProductRequest UpdateProductRequestParam
	// contains filtered or unexported fields
}

func (CatalogProductUpdateParams) MarshalJSON 

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

func (CatalogProductUpdateParams) URLQuery 

func (r CatalogProductUpdateParams) URLQuery() (v url.Values, err error)

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

func (*CatalogProductUpdateParams) UnmarshalJSON 

func (r *CatalogProductUpdateParams) UnmarshalJSON(data []byte) error

type CatalogPropertyAttributeDeleteParams 

type CatalogPropertyAttributeDeleteParams struct {
	PropertyID string `path:"property_id" api:"required" json:"-"`
	// contains filtered or unexported fields
}

type CatalogPropertyAttributeDeleteResponse 

type CatalogPropertyAttributeDeleteResponse struct {
	// JSON contains metadata for fields, check presence with [respjson.Field.Valid].
	JSON struct {
		ExtraFields map[string]respjson.Field
		// contains filtered or unexported fields
	} `json:"-"`
}

func (CatalogPropertyAttributeDeleteResponse) RawJSON 

func (r CatalogPropertyAttributeDeleteResponse) RawJSON() string

Returns the unmodified JSON received from the API

func (*CatalogPropertyAttributeDeleteResponse) UnmarshalJSON 

func (r *CatalogPropertyAttributeDeleteResponse) UnmarshalJSON(data []byte) error

type CatalogPropertyAttributeGetParams 

type CatalogPropertyAttributeGetParams struct {
	PropertyID string `path:"property_id" api:"required" json:"-"`
	// contains filtered or unexported fields
}

type CatalogPropertyAttributeListParams 

type CatalogPropertyAttributeListParams struct {
	// Cursor token used to retrieve the next or previous page of results.
	Cursor param.Opt[string] `query:"cursor,omitzero" json:"-"`
	// Maximum number of results per page (default: 100, max: 1000).
	Limit param.Opt[int64] `query:"limit,omitzero" json:"-"`
	// Search query used to filter results.
	Q param.Opt[string] `query:"q,omitzero" json:"-"`
	// contains filtered or unexported fields
}

func (CatalogPropertyAttributeListParams) URLQuery 

func (r CatalogPropertyAttributeListParams) URLQuery() (v url.Values, err error)

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

type CatalogPropertyAttributeNewParams 

type CatalogPropertyAttributeNewParams struct {
	// Request to create an attribute.
	CreateAttributeRequest CreateAttributeRequestParam
	// contains filtered or unexported fields
}

func (CatalogPropertyAttributeNewParams) MarshalJSON 

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

func (*CatalogPropertyAttributeNewParams) UnmarshalJSON 

func (r *CatalogPropertyAttributeNewParams) UnmarshalJSON(data []byte) error

type CatalogPropertyAttributeService 

type CatalogPropertyAttributeService struct {
	// contains filtered or unexported fields
}

List and manage properties and their attributes.

CatalogPropertyAttributeService contains methods and other services that help with interacting with the augno 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 NewCatalogPropertyAttributeService method instead.

func NewCatalogPropertyAttributeService 

func NewCatalogPropertyAttributeService(opts ...option.RequestOption) (r CatalogPropertyAttributeService)

NewCatalogPropertyAttributeService 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 (*CatalogPropertyAttributeService) Delete 

func (r *CatalogPropertyAttributeService) Delete(ctx context.Context, id string, body CatalogPropertyAttributeDeleteParams, opts ...option.RequestOption) (res *CatalogPropertyAttributeDeleteResponse, err error)

Deletes an attribute from a property.

func (*CatalogPropertyAttributeService) Get 

func (r *CatalogPropertyAttributeService) Get(ctx context.Context, id string, query CatalogPropertyAttributeGetParams, opts ...option.RequestOption) (res *Attribute, err error)

Returns an attribute by ID within a property.

func (*CatalogPropertyAttributeService) List 

func (r *CatalogPropertyAttributeService) List(ctx context.Context, propertyID string, query CatalogPropertyAttributeListParams, opts ...option.RequestOption) (res *ListAttribute, err error)

Returns a paginated list of attributes for a property.

func (*CatalogPropertyAttributeService) New 

func (r *CatalogPropertyAttributeService) New(ctx context.Context, propertyID string, body CatalogPropertyAttributeNewParams, opts ...option.RequestOption) (res *Attribute, err error)

Creates an attribute under a property.

func (*CatalogPropertyAttributeService) Update 

func (r *CatalogPropertyAttributeService) Update(ctx context.Context, id string, params CatalogPropertyAttributeUpdateParams, opts ...option.RequestOption) (res *Attribute, err error)

Partially updates an attribute.

type CatalogPropertyAttributeUpdateParams 

type CatalogPropertyAttributeUpdateParams struct {
	PropertyID string `path:"property_id" api:"required" json:"-"`
	// Request to update an attribute.
	UpdateAttributeRequest UpdateAttributeRequestParam
	// contains filtered or unexported fields
}

func (CatalogPropertyAttributeUpdateParams) MarshalJSON 

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

func (*CatalogPropertyAttributeUpdateParams) UnmarshalJSON 

func (r *CatalogPropertyAttributeUpdateParams) UnmarshalJSON(data []byte) error

type CatalogPropertyDeleteResponse 

type CatalogPropertyDeleteResponse struct {
	// JSON contains metadata for fields, check presence with [respjson.Field.Valid].
	JSON struct {
		ExtraFields map[string]respjson.Field
		// contains filtered or unexported fields
	} `json:"-"`
}

func (CatalogPropertyDeleteResponse) RawJSON 

func (r CatalogPropertyDeleteResponse) RawJSON() string

Returns the unmodified JSON received from the API

func (*CatalogPropertyDeleteResponse) UnmarshalJSON 

func (r *CatalogPropertyDeleteResponse) UnmarshalJSON(data []byte) error

type CatalogPropertyGetParams 

type CatalogPropertyGetParams struct {
	// Sub-objects to expand in the response. When omitted, sub-objects are returned as
	// `null`.
	//
	// Any of "attributes".
	Include []string `query:"include,omitzero" json:"-"`
	// contains filtered or unexported fields
}

func (CatalogPropertyGetParams) URLQuery 

func (r CatalogPropertyGetParams) URLQuery() (v url.Values, err error)

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

type CatalogPropertyListParams 

type CatalogPropertyListParams struct {
	// Cursor token used to retrieve the next or previous page of results.
	Cursor param.Opt[string] `query:"cursor,omitzero" json:"-"`
	// Maximum number of results per page (default: 100, max: 1000).
	Limit param.Opt[int64] `query:"limit,omitzero" json:"-"`
	// Search query used to filter results.
	Q param.Opt[string] `query:"q,omitzero" json:"-"`
	// Sub-objects to expand in the response. When omitted, sub-objects are returned as
	// `null`.
	//
	// Any of "attributes".
	Include []string `query:"include,omitzero" json:"-"`
	// contains filtered or unexported fields
}

func (CatalogPropertyListParams) URLQuery 

func (r CatalogPropertyListParams) URLQuery() (v url.Values, err error)

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

type CatalogPropertyNewParams 

type CatalogPropertyNewParams struct {
	// Request to create a property.
	CreatePropertyRequest CreatePropertyRequestParam
	// Sub-objects to expand in the response. When omitted, sub-objects are returned as
	// `null`.
	//
	// Any of "attributes".
	Include []string `query:"include,omitzero" json:"-"`
	// contains filtered or unexported fields
}

func (CatalogPropertyNewParams) MarshalJSON 

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

func (CatalogPropertyNewParams) URLQuery 

func (r CatalogPropertyNewParams) URLQuery() (v url.Values, err error)

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

func (*CatalogPropertyNewParams) UnmarshalJSON 

func (r *CatalogPropertyNewParams) UnmarshalJSON(data []byte) error

type CatalogPropertyService 

type CatalogPropertyService struct {

	// List and manage properties and their attributes.
	Attributes CatalogPropertyAttributeService
	// contains filtered or unexported fields
}

List and manage properties and their attributes.

CatalogPropertyService contains methods and other services that help with interacting with the augno 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 NewCatalogPropertyService method instead.

func NewCatalogPropertyService 

func NewCatalogPropertyService(opts ...option.RequestOption) (r CatalogPropertyService)

NewCatalogPropertyService 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 (*CatalogPropertyService) Delete 

func (r *CatalogPropertyService) Delete(ctx context.Context, id string, opts ...option.RequestOption) (res *CatalogPropertyDeleteResponse, err error)

Deletes a property and all associated attributes.

func (*CatalogPropertyService) Get 

func (r *CatalogPropertyService) Get(ctx context.Context, id string, query CatalogPropertyGetParams, opts ...option.RequestOption) (res *Property, err error)

Returns a property by ID.

func (*CatalogPropertyService) List 

func (r *CatalogPropertyService) List(ctx context.Context, query CatalogPropertyListParams, opts ...option.RequestOption) (res *ListProperty, err error)

Returns a paginated list of properties for the target account.

func (*CatalogPropertyService) New 

func (r *CatalogPropertyService) New(ctx context.Context, params CatalogPropertyNewParams, opts ...option.RequestOption) (res *Property, err error)

Creates a property.

func (*CatalogPropertyService) Update 

func (r *CatalogPropertyService) Update(ctx context.Context, id string, params CatalogPropertyUpdateParams, opts ...option.RequestOption) (res *Property, err error)

Partially updates a property.

type CatalogPropertyUpdateParams 

type CatalogPropertyUpdateParams struct {
	// Sub-objects to expand in the response. When omitted, sub-objects are returned as
	// `null`.
	//
	// Any of "attributes".
	Include []string `query:"include,omitzero" json:"-"`
	// Request to update a property.
	UpdatePropertyRequest UpdatePropertyRequestParam
	// contains filtered or unexported fields
}

func (CatalogPropertyUpdateParams) MarshalJSON 

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

func (CatalogPropertyUpdateParams) URLQuery 

func (r CatalogPropertyUpdateParams) URLQuery() (v url.Values, err error)

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

func (*CatalogPropertyUpdateParams) UnmarshalJSON 

func (r *CatalogPropertyUpdateParams) UnmarshalJSON(data []byte) error

type CatalogService 

type CatalogService struct {

	// List and manage units.
	Units CatalogUnitService
	// List and manage unit groups and their associated units.
	UnitGroups CatalogUnitGroupService
	// List and manage properties and their attributes.
	Properties CatalogPropertyService
	// List and manage inventory items.
	Items CatalogItemService
	// List and manage item categories.
	ItemCategories CatalogItemCategoryService
	// List and manage materials.
	Materials CatalogMaterialService
	// List and manage parts.
	Parts CatalogPartService
	// List and manage product lines.
	ProductLines CatalogProductLineService
	// List and manage products.
	Products CatalogProductService
	// contains filtered or unexported fields
}

CatalogService contains methods and other services that help with interacting with the augno 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 NewCatalogService method instead.

func NewCatalogService 

func NewCatalogService(opts ...option.RequestOption) (r CatalogService)

NewCatalogService 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.

type CatalogUnitDeleteResponse 

type CatalogUnitDeleteResponse struct {
	// JSON contains metadata for fields, check presence with [respjson.Field.Valid].
	JSON struct {
		ExtraFields map[string]respjson.Field
		// contains filtered or unexported fields
	} `json:"-"`
}

func (CatalogUnitDeleteResponse) RawJSON 

func (r CatalogUnitDeleteResponse) RawJSON() string

Returns the unmodified JSON received from the API

func (*CatalogUnitDeleteResponse) UnmarshalJSON 

func (r *CatalogUnitDeleteResponse) UnmarshalJSON(data []byte) error

type CatalogUnitGetParams 

type CatalogUnitGetParams struct {
	// Sub-objects to expand in the response. When omitted, sub-objects are returned as
	// `null`.
	//
	// Any of "owner", "owner.account".
	Include []string `query:"include,omitzero" json:"-"`
	// contains filtered or unexported fields
}

func (CatalogUnitGetParams) URLQuery 

func (r CatalogUnitGetParams) URLQuery() (v url.Values, err error)

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

type CatalogUnitGroupDeleteResponse 

type CatalogUnitGroupDeleteResponse struct {
	// JSON contains metadata for fields, check presence with [respjson.Field.Valid].
	JSON struct {
		ExtraFields map[string]respjson.Field
		// contains filtered or unexported fields
	} `json:"-"`
}

func (CatalogUnitGroupDeleteResponse) RawJSON 

func (r CatalogUnitGroupDeleteResponse) RawJSON() string

Returns the unmodified JSON received from the API

func (*CatalogUnitGroupDeleteResponse) UnmarshalJSON 

func (r *CatalogUnitGroupDeleteResponse) UnmarshalJSON(data []byte) error

type CatalogUnitGroupGetParams 

type CatalogUnitGroupGetParams struct {
	// Sub-objects to expand in the response. When omitted, sub-objects are returned as
	// `null`.
	//
	// Any of "owner", "owner.account", "base_unit", "associated_units".
	Include []string `query:"include,omitzero" json:"-"`
	// contains filtered or unexported fields
}

func (CatalogUnitGroupGetParams) URLQuery 

func (r CatalogUnitGroupGetParams) URLQuery() (v url.Values, err error)

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

type CatalogUnitGroupListParams 

type CatalogUnitGroupListParams struct {
	// Cursor token used to retrieve the next or previous page of results.
	Cursor param.Opt[string] `query:"cursor,omitzero" json:"-"`
	// Maximum number of results per page (default: 100, max: 1000).
	Limit param.Opt[int64] `query:"limit,omitzero" json:"-"`
	// Search query used to filter results.
	Q param.Opt[string] `query:"q,omitzero" json:"-"`
	// Sub-objects to expand in the response. When omitted, sub-objects are returned as
	// `null`.
	//
	// Any of "owner", "owner.account", "base_unit", "associated_units".
	Include []string `query:"include,omitzero" json:"-"`
	// Filter by the unit type.
	//
	// Any of "currency", "quantity", "time", "mass", "volume", "length",
	// "temperature", "area".
	Type CatalogUnitGroupListParamsType `query:"type,omitzero" json:"-"`
	// contains filtered or unexported fields
}

func (CatalogUnitGroupListParams) URLQuery 

func (r CatalogUnitGroupListParams) URLQuery() (v url.Values, err error)

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

type CatalogUnitGroupListParamsType 

type CatalogUnitGroupListParamsType string

Filter by the unit type. 

const (
	CatalogUnitGroupListParamsTypeCurrency    CatalogUnitGroupListParamsType = "currency"
	CatalogUnitGroupListParamsTypeQuantity    CatalogUnitGroupListParamsType = "quantity"
	CatalogUnitGroupListParamsTypeTime        CatalogUnitGroupListParamsType = "time"
	CatalogUnitGroupListParamsTypeMass        CatalogUnitGroupListParamsType = "mass"
	CatalogUnitGroupListParamsTypeVolume      CatalogUnitGroupListParamsType = "volume"
	CatalogUnitGroupListParamsTypeLength      CatalogUnitGroupListParamsType = "length"
	CatalogUnitGroupListParamsTypeTemperature CatalogUnitGroupListParamsType = "temperature"
	CatalogUnitGroupListParamsTypeArea        CatalogUnitGroupListParamsType = "area"
)

type CatalogUnitGroupNewParams 

type CatalogUnitGroupNewParams struct {
	// CreateUnitGroupRequest is a request to create a unit group.
	CreateUnitGroupRequest CreateUnitGroupRequestParam
	// Sub-objects to expand in the response. When omitted, sub-objects are returned as
	// `null`.
	//
	// Any of "owner", "owner.account", "base_unit", "associated_units".
	Include []string `query:"include,omitzero" json:"-"`
	// contains filtered or unexported fields
}

func (CatalogUnitGroupNewParams) MarshalJSON 

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

func (CatalogUnitGroupNewParams) URLQuery 

func (r CatalogUnitGroupNewParams) URLQuery() (v url.Values, err error)

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

func (*CatalogUnitGroupNewParams) UnmarshalJSON 

func (r *CatalogUnitGroupNewParams) UnmarshalJSON(data []byte) error

type CatalogUnitGroupService 

type CatalogUnitGroupService struct {

	// List and manage unit groups and their associated units.
	Units CatalogUnitGroupUnitService
	// contains filtered or unexported fields
}

List and manage unit groups and their associated units.

CatalogUnitGroupService contains methods and other services that help with interacting with the augno 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 NewCatalogUnitGroupService method instead.

func NewCatalogUnitGroupService 

func NewCatalogUnitGroupService(opts ...option.RequestOption) (r CatalogUnitGroupService)

NewCatalogUnitGroupService 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 (*CatalogUnitGroupService) Delete 

func (r *CatalogUnitGroupService) Delete(ctx context.Context, id string, opts ...option.RequestOption) (res *CatalogUnitGroupDeleteResponse, err error)

Deletes a unit group and all associated unit conversions. System unit groups cannot be deleted.

func (*CatalogUnitGroupService) Get 

func (r *CatalogUnitGroupService) Get(ctx context.Context, id string, query CatalogUnitGroupGetParams, opts ...option.RequestOption) (res *UnitGroup, err error)

Returns a unit group by ID.

func (*CatalogUnitGroupService) List 

func (r *CatalogUnitGroupService) List(ctx context.Context, query CatalogUnitGroupListParams, opts ...option.RequestOption) (res *ListUnitGroup, err error)

Returns a paginated list of unit groups, including system unit groups.

func (*CatalogUnitGroupService) New 

func (r *CatalogUnitGroupService) New(ctx context.Context, params CatalogUnitGroupNewParams, opts ...option.RequestOption) (res *UnitGroup, err error)

Creates a unit group with optional associated units.

func (*CatalogUnitGroupService) Update 

func (r *CatalogUnitGroupService) Update(ctx context.Context, id string, params CatalogUnitGroupUpdateParams, opts ...option.RequestOption) (res *UnitGroup, err error)

Partially updates a unit group. System unit groups cannot be updated.

type CatalogUnitGroupUnitDeleteParams 

type CatalogUnitGroupUnitDeleteParams struct {
	UnitGroupID string `path:"unit_group_id" api:"required" json:"-"`
	// contains filtered or unexported fields
}

type CatalogUnitGroupUnitDeleteResponse 

type CatalogUnitGroupUnitDeleteResponse struct {
	// JSON contains metadata for fields, check presence with [respjson.Field.Valid].
	JSON struct {
		ExtraFields map[string]respjson.Field
		// contains filtered or unexported fields
	} `json:"-"`
}

func (CatalogUnitGroupUnitDeleteResponse) RawJSON 

func (r CatalogUnitGroupUnitDeleteResponse) RawJSON() string

Returns the unmodified JSON received from the API

func (*CatalogUnitGroupUnitDeleteResponse) UnmarshalJSON 

func (r *CatalogUnitGroupUnitDeleteResponse) UnmarshalJSON(data []byte) error

type CatalogUnitGroupUnitGetParams 

type CatalogUnitGroupUnitGetParams struct {
	UnitGroupID string `path:"unit_group_id" api:"required" json:"-"`
	// Sub-objects to expand in the response. When omitted, sub-objects are returned as
	// `null`.
	//
	// Any of "unit".
	Include []string `query:"include,omitzero" json:"-"`
	// contains filtered or unexported fields
}

func (CatalogUnitGroupUnitGetParams) URLQuery 

func (r CatalogUnitGroupUnitGetParams) URLQuery() (v url.Values, err error)

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

type CatalogUnitGroupUnitListParams 

type CatalogUnitGroupUnitListParams struct {
	// Sub-objects to expand in the response. When omitted, sub-objects are returned as
	// `null`.
	//
	// Any of "unit".
	Include []string `query:"include,omitzero" json:"-"`
	// contains filtered or unexported fields
}

func (CatalogUnitGroupUnitListParams) URLQuery 

func (r CatalogUnitGroupUnitListParams) URLQuery() (v url.Values, err error)

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

type CatalogUnitGroupUnitNewParams 

type CatalogUnitGroupUnitNewParams struct {
	// CreateUnitGroupUnitRequest is a request to create an associated unit within a
	// unit group.
	CreateUnitGroupUnitRequest CreateUnitGroupUnitRequestParam
	// Sub-objects to expand in the response. When omitted, sub-objects are returned as
	// `null`.
	//
	// Any of "unit".
	Include []string `query:"include,omitzero" json:"-"`
	// contains filtered or unexported fields
}

func (CatalogUnitGroupUnitNewParams) MarshalJSON 

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

func (CatalogUnitGroupUnitNewParams) URLQuery 

func (r CatalogUnitGroupUnitNewParams) URLQuery() (v url.Values, err error)

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

func (*CatalogUnitGroupUnitNewParams) UnmarshalJSON 

func (r *CatalogUnitGroupUnitNewParams) UnmarshalJSON(data []byte) error

type CatalogUnitGroupUnitService 

type CatalogUnitGroupUnitService struct {
	// contains filtered or unexported fields
}

List and manage unit groups and their associated units.

CatalogUnitGroupUnitService contains methods and other services that help with interacting with the augno 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 NewCatalogUnitGroupUnitService method instead.

func NewCatalogUnitGroupUnitService 

func NewCatalogUnitGroupUnitService(opts ...option.RequestOption) (r CatalogUnitGroupUnitService)

NewCatalogUnitGroupUnitService 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 (*CatalogUnitGroupUnitService) Delete 

func (r *CatalogUnitGroupUnitService) Delete(ctx context.Context, id string, body CatalogUnitGroupUnitDeleteParams, opts ...option.RequestOption) (res *CatalogUnitGroupUnitDeleteResponse, err error)

Deletes an associated unit from a unit group.

func (*CatalogUnitGroupUnitService) Get 

func (r *CatalogUnitGroupUnitService) Get(ctx context.Context, id string, params CatalogUnitGroupUnitGetParams, opts ...option.RequestOption) (res *UnitGroupUnit, err error)

Returns an associated unit within a unit group by ID.

func (*CatalogUnitGroupUnitService) List 

func (r *CatalogUnitGroupUnitService) List(ctx context.Context, unitGroupID string, query CatalogUnitGroupUnitListParams, opts ...option.RequestOption) (res *ListUnitGroupUnit, err error)

Returns a list of associated units within a unit group.

func (*CatalogUnitGroupUnitService) New 

func (r *CatalogUnitGroupUnitService) New(ctx context.Context, unitGroupID string, params CatalogUnitGroupUnitNewParams, opts ...option.RequestOption) (res *UnitGroupUnit, err error)

Creates an associated unit within a unit group.

func (*CatalogUnitGroupUnitService) Update 

func (r *CatalogUnitGroupUnitService) Update(ctx context.Context, id string, params CatalogUnitGroupUnitUpdateParams, opts ...option.RequestOption) (res *UnitGroupUnit, err error)

Partially updates an associated unit within a unit group.

type CatalogUnitGroupUnitUpdateParams 

type CatalogUnitGroupUnitUpdateParams struct {
	UnitGroupID string `path:"unit_group_id" api:"required" json:"-"`
	// Sub-objects to expand in the response. When omitted, sub-objects are returned as
	// `null`.
	//
	// Any of "unit".
	Include []string `query:"include,omitzero" json:"-"`
	// UpdateUnitGroupUnitRequest is a request to update an associated unit.
	UpdateUnitGroupUnitRequest UpdateUnitGroupUnitRequestParam
	// contains filtered or unexported fields
}

func (CatalogUnitGroupUnitUpdateParams) MarshalJSON 

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

func (CatalogUnitGroupUnitUpdateParams) URLQuery 

func (r CatalogUnitGroupUnitUpdateParams) URLQuery() (v url.Values, err error)

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

func (*CatalogUnitGroupUnitUpdateParams) UnmarshalJSON 

func (r *CatalogUnitGroupUnitUpdateParams) UnmarshalJSON(data []byte) error

type CatalogUnitGroupUpdateParams 

type CatalogUnitGroupUpdateParams struct {
	// Sub-objects to expand in the response. When omitted, sub-objects are returned as
	// `null`.
	//
	// Any of "owner", "owner.account", "base_unit", "associated_units".
	Include []string `query:"include,omitzero" json:"-"`
	// UpdateUnitGroupRequest is a request to partially update a unit group.
	UpdateUnitGroupRequest UpdateUnitGroupRequestParam
	// contains filtered or unexported fields
}

func (CatalogUnitGroupUpdateParams) MarshalJSON 

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

func (CatalogUnitGroupUpdateParams) URLQuery 

func (r CatalogUnitGroupUpdateParams) URLQuery() (v url.Values, err error)

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

func (*CatalogUnitGroupUpdateParams) UnmarshalJSON 

func (r *CatalogUnitGroupUpdateParams) UnmarshalJSON(data []byte) error

type CatalogUnitListParams 

type CatalogUnitListParams struct {
	// Cursor token used to retrieve the next or previous page of results.
	Cursor param.Opt[string] `query:"cursor,omitzero" json:"-"`
	// Maximum number of results per page (default: 100, max: 1000).
	Limit param.Opt[int64] `query:"limit,omitzero" json:"-"`
	// Search query used to filter results.
	Q param.Opt[string] `query:"q,omitzero" json:"-"`
	// Sub-objects to expand in the response. When omitted, sub-objects are returned as
	// `null`.
	//
	// Any of "owner", "owner.account".
	Include []string `query:"include,omitzero" json:"-"`
	// Filter by unit dimension code.
	//
	// Any of "currency", "quantity", "time", "mass", "volume", "length",
	// "temperature", "area".
	Type CatalogUnitListParamsType `query:"type,omitzero" json:"-"`
	// Filter by unit group membership.
	UnitGroupIDs []string `query:"unit_group_ids,omitzero" json:"-"`
	// contains filtered or unexported fields
}

func (CatalogUnitListParams) URLQuery 

func (r CatalogUnitListParams) URLQuery() (v url.Values, err error)

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

type CatalogUnitListParamsType 

type CatalogUnitListParamsType string

Filter by unit dimension code. 

const (
	CatalogUnitListParamsTypeCurrency    CatalogUnitListParamsType = "currency"
	CatalogUnitListParamsTypeQuantity    CatalogUnitListParamsType = "quantity"
	CatalogUnitListParamsTypeTime        CatalogUnitListParamsType = "time"
	CatalogUnitListParamsTypeMass        CatalogUnitListParamsType = "mass"
	CatalogUnitListParamsTypeVolume      CatalogUnitListParamsType = "volume"
	CatalogUnitListParamsTypeLength      CatalogUnitListParamsType = "length"
	CatalogUnitListParamsTypeTemperature CatalogUnitListParamsType = "temperature"
	CatalogUnitListParamsTypeArea        CatalogUnitListParamsType = "area"
)

type CatalogUnitNewParams 

type CatalogUnitNewParams struct {
	// Request to create a unit.
	CreateUnitRequest CreateUnitRequestParam
	// Sub-objects to expand in the response. When omitted, sub-objects are returned as
	// `null`.
	//
	// Any of "owner", "owner.account".
	Include []string `query:"include,omitzero" json:"-"`
	// contains filtered or unexported fields
}

func (CatalogUnitNewParams) MarshalJSON 

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

func (CatalogUnitNewParams) URLQuery 

func (r CatalogUnitNewParams) URLQuery() (v url.Values, err error)

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

func (*CatalogUnitNewParams) UnmarshalJSON 

func (r *CatalogUnitNewParams) UnmarshalJSON(data []byte) error

type CatalogUnitService 

type CatalogUnitService struct {
	// contains filtered or unexported fields
}

List and manage units.

CatalogUnitService contains methods and other services that help with interacting with the augno 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 NewCatalogUnitService method instead.

func NewCatalogUnitService 

func NewCatalogUnitService(opts ...option.RequestOption) (r CatalogUnitService)

NewCatalogUnitService 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 (*CatalogUnitService) Delete 

func (r *CatalogUnitService) Delete(ctx context.Context, id string, opts ...option.RequestOption) (res *CatalogUnitDeleteResponse, err error)

Deletes an account-owned unit. Associated unit group memberships are also removed, and system units cannot be deleted.

func (*CatalogUnitService) Get 

func (r *CatalogUnitService) Get(ctx context.Context, id string, query CatalogUnitGetParams, opts ...option.RequestOption) (res *Unit, err error)

Returns a unit by ID, including both account-owned and global system units.

func (*CatalogUnitService) List 

func (r *CatalogUnitService) List(ctx context.Context, query CatalogUnitListParams, opts ...option.RequestOption) (res *ListUnit, err error)

Returns a paginated list of units for the current account, including both account-owned and global system units.

func (*CatalogUnitService) New 

func (r *CatalogUnitService) New(ctx context.Context, params CatalogUnitNewParams, opts ...option.RequestOption) (res *Unit, err error)

Creates an account-owned unit.

func (*CatalogUnitService) Update 

func (r *CatalogUnitService) Update(ctx context.Context, id string, params CatalogUnitUpdateParams, opts ...option.RequestOption) (res *Unit, err error)

Partially updates an account-owned unit; system units cannot be updated.

type CatalogUnitUpdateParams 

type CatalogUnitUpdateParams struct {
	// Sub-objects to expand in the response. When omitted, sub-objects are returned as
	// `null`.
	//
	// Any of "owner", "owner.account".
	Include []string `query:"include,omitzero" json:"-"`
	// Request to partially update a unit.
	UpdateUnitRequest UpdateUnitRequestParam
	// contains filtered or unexported fields
}

func (CatalogUnitUpdateParams) MarshalJSON 

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

func (CatalogUnitUpdateParams) URLQuery 

func (r CatalogUnitUpdateParams) URLQuery() (v url.Values, err error)

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

func (*CatalogUnitUpdateParams) UnmarshalJSON 

func (r *CatalogUnitUpdateParams) UnmarshalJSON(data []byte) error

type Client 

type Client struct {
	Auth    AuthService
	Core    CoreService
	Catalog CatalogService
	Sales   SaleService
	// Create, view, update, and delete transactions.
	Finance    FinanceService
	Operations OperationService
	Identity   IdentityService
	// contains filtered or unexported fields
}

Client creates a struct with services and top level methods that help with interacting with the augno 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 (AUGNO_API_KEY, AUGNO_BASE_URL). 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 any, res any, 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 any, res any, 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 any, res any, 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 any, res any, 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 any, res any, 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 any, res any, 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 Consumption 

type Consumption struct {
	// Consumption ID.
	ID string `json:"id" api:"required"`
	// Item is an inventory item (product, material, or part).
	ConsumedItem Item `json:"consumed_item" api:"required"`
	// Creation timestamp.
	CreatedAt time.Time `json:"created_at" api:"required" format:"date-time"`
	// Instructions for how this material is consumed.
	Instructions string `json:"instructions" api:"required"`
	// Resource type identifier.
	//
	// Any of "consumption".
	Object ConsumptionObject `json:"object" api:"required"`
	// Value with an associated unit.
	Quantity Quantity `json:"quantity" api:"required"`
	// Last updated timestamp.
	UpdatedAt time.Time `json:"updated_at" api:"required" format:"date-time"`
	// Value with an associated unit.
	WasteQuantity Quantity `json:"waste_quantity" api:"required"`
	// JSON contains metadata for fields, check presence with [respjson.Field.Valid].
	JSON struct {
		ID            respjson.Field
		ConsumedItem  respjson.Field
		CreatedAt     respjson.Field
		Instructions  respjson.Field
		Object        respjson.Field
		Quantity      respjson.Field
		UpdatedAt     respjson.Field
		WasteQuantity respjson.Field
		ExtraFields   map[string]respjson.Field
		// contains filtered or unexported fields
	} `json:"-"`
}

Material consumed by a production step.

func (Consumption) RawJSON 

func (r Consumption) RawJSON() string

Returns the unmodified JSON received from the API

func (*Consumption) UnmarshalJSON 

func (r *Consumption) UnmarshalJSON(data []byte) error

type ConsumptionObject 

type ConsumptionObject string

Resource type identifier. 

const (
	ConsumptionObjectConsumption ConsumptionObject = "consumption"
)

type CoreAddressActionService 

type CoreAddressActionService struct {
	// contains filtered or unexported fields
}

Autocomplete, look up details, and validate addresses.

CoreAddressActionService contains methods and other services that help with interacting with the augno 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 NewCoreAddressActionService method instead.

func NewCoreAddressActionService 

func NewCoreAddressActionService(opts ...option.RequestOption) (r CoreAddressActionService)

NewCoreAddressActionService 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 (*CoreAddressActionService) Validate 

func (r *CoreAddressActionService) Validate(ctx context.Context, body CoreAddressActionValidateParams, opts ...option.RequestOption) (res *ValidatedAddress, err error)

Validates an address and returns whether it is valid, a formatted version, and any validation messages.

type CoreAddressActionValidateParams 

type CoreAddressActionValidateParams struct {
	// Request to validate an address.
	ValidateAddressRequest ValidateAddressRequestParam
	// contains filtered or unexported fields
}

func (CoreAddressActionValidateParams) MarshalJSON 

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

func (*CoreAddressActionValidateParams) UnmarshalJSON 

func (r *CoreAddressActionValidateParams) UnmarshalJSON(data []byte) error

type CoreAddressGetSuggestionsParams 

type CoreAddressGetSuggestionsParams struct {
	// Autocomplete input text.
	Input string `query:"input" api:"required" json:"-"`
	// Session token for grouping autocomplete requests.
	SessionToken param.Opt[string] `query:"session_token,omitzero" json:"-"`
	// contains filtered or unexported fields
}

func (CoreAddressGetSuggestionsParams) URLQuery 

func (r CoreAddressGetSuggestionsParams) URLQuery() (v url.Values, err error)

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

type CoreAddressService 

type CoreAddressService struct {

	// Autocomplete, look up details, and validate addresses.
	Actions CoreAddressActionService
	// contains filtered or unexported fields
}

Autocomplete, look up details, and validate addresses.

CoreAddressService contains methods and other services that help with interacting with the augno 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 NewCoreAddressService method instead.

func NewCoreAddressService 

func NewCoreAddressService(opts ...option.RequestOption) (r CoreAddressService)

NewCoreAddressService 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 (*CoreAddressService) GetSuggestions 

func (r *CoreAddressService) GetSuggestions(ctx context.Context, query CoreAddressGetSuggestionsParams, opts ...option.RequestOption) (res *ListAddressSuggestion, err error)

Returns address suggestions based on input text.

type CoreAuditEventGetParams 

type CoreAuditEventGetParams struct {
	// Sub-objects to expand in the response. When omitted, sub-objects are returned as
	// `null`.
	//
	// Any of "actor", "changes", "metadata", "request".
	Include []string `query:"include,omitzero" json:"-"`
	// contains filtered or unexported fields
}

func (CoreAuditEventGetParams) URLQuery 

func (r CoreAuditEventGetParams) URLQuery() (v url.Values, err error)

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

type CoreAuditEventListParams 

type CoreAuditEventListParams struct {
	// Cursor token used to retrieve the next or previous page of results.
	Cursor param.Opt[string] `query:"cursor,omitzero" json:"-"`
	// Restricts results to audit events on or before this timestamp.
	EndDate param.Opt[time.Time] `query:"end_date,omitzero" format:"date-time" json:"-"`
	// Maximum number of results per page (default: 100, max: 1000).
	Limit param.Opt[int64] `query:"limit,omitzero" json:"-"`
	// Search query used to filter results.
	Q param.Opt[string] `query:"q,omitzero" json:"-"`
	// Restricts results to audit events on or after this timestamp.
	StartDate param.Opt[time.Time] `query:"start_date,omitzero" format:"date-time" json:"-"`
	// Filter by the audit actions.
	//
	// Any of "create", "update", "delete", "restore", "archive".
	Actions []string `query:"actions,omitzero" json:"-"`
	// Filter by the actor identifier.
	//
	// Will be `user.id` when `identity_type`=`user` or an `api_key.id` when
	// `identity_type`=`api_key`.
	ActorIDs []string `query:"actor_ids,omitzero" json:"-"`
	// Sub-objects to expand in the response. When omitted, sub-objects are returned as
	// `null`.
	//
	// Any of "actor", "changes", "metadata", "request".
	Include []string `query:"include,omitzero" json:"-"`
	// Filter by the audited resource IDs.
	ResourceIDs []string `query:"resource_ids,omitzero" json:"-"`
	// Filter by the resource type of the audited entity.
	//
	// Any of "account", "actor", "entity", "record", "freight", "sales_order_totals",
	// "sales_order_related", "user", "address", "api_key", "created_api_key",
	// "refresh_token", "list", "sandbox", "registration_session", "pricing_plan",
	// "account_plan", "plan_change", "enterprise_inquiry", "request_log",
	// "audit_event", "audit_field_change", "role", "unit", "account_affiliation",
	// "agent_definition", "available_tool", "agent_definition_tool",
	// "agent_account_status", "agent_run", "agent_action", "agent_run_step",
	// "agent_token_usage", "agent_memory", "agent_alert", "tool_group",
	// "payment_term", "shipping_term", "quantity", "account_group", "account_status",
	// "geolocation", "account_user", "department", "account_integration",
	// "account_price", "product_line", "item_category", "attribute", "rate",
	// "account_group_product_line_access", "sales_target", "adjustment_type",
	// "account_branding", "account_portal", "account_logo_url", "public_account",
	// "property", "carrier", "service_level", "item", "item_inventory", "product",
	// "batch", "batch_flow_node", "scanning_consumption", "open_batch_summary",
	// "scanning_production_step_info", "scanning_station", "production_step",
	// "production_run", "machine", "child_account", "unit_group", "unit_group_unit",
	// "consumption", "customer_product_line_access", "customer",
	// "frequently_ordered_product", "priority", "delivery", "delivery_line",
	// "sales_order", "location", "location_type", "lot", "email_log",
	// "inventory_change_log", "invoice", "invoice_summary", "invoice_line",
	// "invoice_allocation", "invoice_for_payment", "shipment", "shipment_summary",
	// "shipment_line", "shipping_case", "shipping_case_label_url", "settlement",
	// "settlement_summary", "role_permission", "registration_flow",
	// "registration_flow_option", "transaction", "transaction_summary",
	// "transaction_method", "transaction_type", "transaction_allocation",
	// "usage_item", "agent_token_detail", "account_usage_response",
	// "subscription_info", "billing_portal_session_response", "switch_plan_response",
	// "ensure_billing_customer_response", "spending_cap_response", "agent_spend_info",
	// "webhook_response", "address_suggestion", "address_components",
	// "address_details_result", "validated_address", "plan_limit",
	// "plan_change_proration", "plan_change_line_item", "setup_billing_response",
	// "confirm_payment_response", "oauth_response", "oauth_status_response",
	// "stripe_publishable_key", "stripe_status", "healthcheck",
	// "agent_definition_config", "trigger_config", "customer_contact_info",
	// "customer_freight_preferences", "customer_defaults",
	// "customer_notification_preferences", "order_discount", "sales_order_line",
	// "sales_order_type", "sales_order_status", "material", "supplier_material",
	// "part", "permission_group", "permission", "pick", "pick_line", "product_type",
	// "production", "production_flow", "map", "purchase_order", "purchase_order_line",
	// "supplier", "supplier_summary", "receivable_entry", "receiving_order",
	// "receiving_order_line", "email_contact", "allocation_entry",
	// "open_credit_entry", "volume_discount", "volume_discount_tier",
	// "analyze_deliveries_response", "analyze_manufacturing_response",
	// "analyze_manufacturing_batch_response", "analyze_quarterly_orders_response",
	// "analyze_new_customers_response", "analyze_oee_response",
	// "catalog_product_line", "catalog_category", "catalog_product",
	// "catalog_property", "catalog_attribute", "dc_location", "edi_run",
	// "inventory_item", "analyze_weeks_of_sales_response",
	// "bulk_reconcile_items_response", "sys_property", "sys_property_type",
	// "sys_property_value", "territory", "tenancy", "checkout_session",
	// "estimate_rate_result", "rate_shop_option", "rate_shop_result", "owner",
	// "message", "account_photo_upload_result", "user_photo_upload_result",
	// "user_photo_url", "batch_lot", "check_duplicate_result", "item_trend_point",
	// "pack_pick_response", "pick_shipments_response", "tenancy_pending_registration",
	// "invoice_allocation_entry", "allocation_customer",
	// "checkout_sales_order_response", "create_production_run_response".
	ResourceTypes []string `query:"resource_types,omitzero" json:"-"`
	// contains filtered or unexported fields
}

func (CoreAuditEventListParams) URLQuery 

func (r CoreAuditEventListParams) URLQuery() (v url.Values, err error)

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

type CoreAuditEventService 

type CoreAuditEventService struct {
	// contains filtered or unexported fields
}

List and retrieve audit events.

CoreAuditEventService contains methods and other services that help with interacting with the augno 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 NewCoreAuditEventService method instead.

func NewCoreAuditEventService 

func NewCoreAuditEventService(opts ...option.RequestOption) (r CoreAuditEventService)

NewCoreAuditEventService 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 (*CoreAuditEventService) Get 

func (r *CoreAuditEventService) Get(ctx context.Context, id string, query CoreAuditEventGetParams, opts ...option.RequestOption) (res *AuditEvent, err error)

Returns an audit event by ID.

func (*CoreAuditEventService) GetResourceTypes 

func (r *CoreAuditEventService) GetResourceTypes(ctx context.Context, opts ...option.RequestOption) (res *ListObjectType, err error)

Returns the full set of resource types that may appear on audit events.

func (*CoreAuditEventService) List 

func (r *CoreAuditEventService) List(ctx context.Context, query CoreAuditEventListParams, opts ...option.RequestOption) (res *ListAuditEvent, err error)

Returns a paginated list of audit events for the current account.

type CoreEmailLogGetParams 

type CoreEmailLogGetParams struct {
	// Sub-objects to expand in the response. When omitted, sub-objects are returned as
	// `null`.
	//
	// Any of "sent_by".
	Include []string `query:"include,omitzero" json:"-"`
	// contains filtered or unexported fields
}

func (CoreEmailLogGetParams) URLQuery 

func (r CoreEmailLogGetParams) URLQuery() (v url.Values, err error)

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

type CoreEmailLogListParams 

type CoreEmailLogListParams struct {
	// Cursor token used to retrieve the next or previous page of results.
	Cursor param.Opt[string] `query:"cursor,omitzero" json:"-"`
	// Maximum number of results per page (default: 100, max: 1000).
	Limit param.Opt[int64] `query:"limit,omitzero" json:"-"`
	// Search query used to filter results.
	Q param.Opt[string] `query:"q,omitzero" json:"-"`
	// Sub-objects to expand in the response. When omitted, sub-objects are returned as
	// `null`.
	//
	// Any of "sent_by".
	Include []string `query:"include,omitzero" json:"-"`
	// contains filtered or unexported fields
}

func (CoreEmailLogListParams) URLQuery 

func (r CoreEmailLogListParams) URLQuery() (v url.Values, err error)

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

type CoreEmailLogService 

type CoreEmailLogService struct {
	// contains filtered or unexported fields
}

View email logs for accounts.

CoreEmailLogService contains methods and other services that help with interacting with the augno 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 NewCoreEmailLogService method instead.

func NewCoreEmailLogService 

func NewCoreEmailLogService(opts ...option.RequestOption) (r CoreEmailLogService)

NewCoreEmailLogService 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 (*CoreEmailLogService) Get 

func (r *CoreEmailLogService) Get(ctx context.Context, id string, query CoreEmailLogGetParams, opts ...option.RequestOption) (res *EmailLog, err error)

Returns an email log by ID.

func (*CoreEmailLogService) List 

func (r *CoreEmailLogService) List(ctx context.Context, query CoreEmailLogListParams, opts ...option.RequestOption) (res *ListEmailLog, err error)

Returns a paginated list of email logs for the current account.

type CoreRequestLogGetParams 

type CoreRequestLogGetParams struct {
	// Sub-objects to expand in the response. When omitted, sub-objects are returned as
	// `null`.
	//
	// Any of "account", "actor", "actor.role", "actor.role.permissions",
	// "query_params", "request_body", "response_body".
	Include []string `query:"include,omitzero" json:"-"`
	// contains filtered or unexported fields
}

func (CoreRequestLogGetParams) URLQuery 

func (r CoreRequestLogGetParams) URLQuery() (v url.Values, err error)

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

type CoreRequestLogListParams 

type CoreRequestLogListParams struct {
	// Cursor token used to retrieve the next or previous page of results.
	Cursor param.Opt[string] `query:"cursor,omitzero" json:"-"`
	// Restricts results to request logs on or before this timestamp.
	EndDate param.Opt[time.Time] `query:"end_date,omitzero" format:"date-time" json:"-"`
	// Filter by the user-provided idempotency key.
	IdempotencyKey param.Opt[string] `query:"idempotency_key,omitzero" json:"-"`
	// Maximum number of results per page (default: 100, max: 1000).
	Limit param.Opt[int64] `query:"limit,omitzero" json:"-"`
	// Filter by the minimum latency in microseconds.
	MinLatencyUs param.Opt[int64] `query:"min_latency_us,omitzero" json:"-"`
	// Search query used to filter results.
	Q param.Opt[string] `query:"q,omitzero" json:"-"`
	// Restricts results to request logs on or after this timestamp.
	StartDate param.Opt[time.Time] `query:"start_date,omitzero" format:"date-time" json:"-"`
	// Filter by the _acting_ account: the account the actor belongs to, not the
	// account targeted by the request.
	//
	// This is usually your own account, but differs when another account acts on yours
	// — for example a customer using a customer-portal API key, whose acting account
	// is the customer's account. The request's target account is always your own
	// account (the only account you are authorized to view request logs for), so this
	// filter narrows by _who acted_, not by which account was acted upon.
	AccountIDs []string `query:"account_ids,omitzero" json:"-"`
	// Filter by the actor identifier.
	//
	// This is the `user.id` when `identity_type`=`user` and an `api_key.id` when
	// `identity_type`=`api_key`.
	ActorIDs []string `query:"actor_ids,omitzero" json:"-"`
	// Filter by the actor type.
	//
	// Any of "user", "api_key", "agent".
	ActorTypes []string `query:"actor_types,omitzero" json:"-"`
	// Filter by API error code.
	//
	// Any of "expired_token", "api_key_expired", "api_key_revoked",
	// "invalid_credentials", "insufficient_permissions", "payment_required",
	// "validation_failed", "missing_field", "invalid_format", "method_not_allowed",
	// "resource_not_found", "resource_exists", "resource_conflict", "resource_gone",
	// "idempotency_in_progress", "limit_exceeded", "registration_closed",
	// "rate_limit_exceeded", "parameter_missing", "parameter_invalid",
	// "parameter_unknown", "parameters_exclusive", "internal_error",
	// "service_unavailable", "external_service_error", "timeout", "connection_error",
	// "request_timeout", "client_closed_request", "api_version_required",
	// "api_version_invalid", "api_version_too_old".
	ErrorCodes []string `query:"error_codes,omitzero" json:"-"`
	// Filter by the request host. Typically, `api.augno.com`.
	Hosts []string `query:"hosts,omitzero" json:"-"`
	// Sub-objects to expand in the response. When omitted, sub-objects are returned as
	// `null`.
	//
	// Any of "account", "actor", "actor.role".
	Include []string `query:"include,omitzero" json:"-"`
	// Filter by the HTTP method.
	//
	// Any of "GET", "POST", "PUT", "PATCH", "DELETE", "HEAD", "OPTIONS".
	Methods []string `query:"methods,omitzero" json:"-"`
	// Filter by the _normalized_ route template.
	//
	// For example `PATCH /v1/sales/customers/{id}` is the normalized route for a
	// request route `PUT /v1/sales/customers/ac_...`.
	NormalizedRoutes []string `query:"normalized_routes,omitzero" json:"-"`
	// Filter by the HTTP status class: 1–5 for 1xx–5xx. Combined with `status_codes`
	// using OR — e.g. status_codes=401 and status_code_classes=5 matches 401 and any
	// 5xx.
	StatusCodeClasses []int64 `query:"status_code_classes,omitzero" json:"-"`
	// Filter by the HTTP status code.
	StatusCodes []int64 `query:"status_codes,omitzero" json:"-"`
	// contains filtered or unexported fields
}

func (CoreRequestLogListParams) URLQuery 

func (r CoreRequestLogListParams) URLQuery() (v url.Values, err error)

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

type CoreRequestLogService 

type CoreRequestLogService struct {
	// contains filtered or unexported fields
}

List and retrieve request logs.

CoreRequestLogService contains methods and other services that help with interacting with the augno 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 NewCoreRequestLogService method instead.

func NewCoreRequestLogService 

func NewCoreRequestLogService(opts ...option.RequestOption) (r CoreRequestLogService)

NewCoreRequestLogService 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 (*CoreRequestLogService) Get 

func (r *CoreRequestLogService) Get(ctx context.Context, id string, query CoreRequestLogGetParams, opts ...option.RequestOption) (res *RequestLog, err error)

Returns a request log by ID.

func (*CoreRequestLogService) List 

func (r *CoreRequestLogService) List(ctx context.Context, query CoreRequestLogListParams, opts ...option.RequestOption) (res *ListRequestLog, err error)

Returns a paginated list of request logs.

type CoreSandboxDeleteResponse 

type CoreSandboxDeleteResponse struct {
	// JSON contains metadata for fields, check presence with [respjson.Field.Valid].
	JSON struct {
		ExtraFields map[string]respjson.Field
		// contains filtered or unexported fields
	} `json:"-"`
}

func (CoreSandboxDeleteResponse) RawJSON 

func (r CoreSandboxDeleteResponse) RawJSON() string

Returns the unmodified JSON received from the API

func (*CoreSandboxDeleteResponse) UnmarshalJSON 

func (r *CoreSandboxDeleteResponse) UnmarshalJSON(data []byte) error

type CoreSandboxGetParams 

type CoreSandboxGetParams struct {
	// Sub-objects to expand in the response. When omitted, sub-objects are returned as
	// `null`.
	//
	// Any of "owner_account".
	Include []string `query:"include,omitzero" json:"-"`
	// contains filtered or unexported fields
}

func (CoreSandboxGetParams) URLQuery 

func (r CoreSandboxGetParams) URLQuery() (v url.Values, err error)

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

type CoreSandboxListParams 

type CoreSandboxListParams struct {
	// Cursor token used to retrieve the next or previous page of results.
	Cursor param.Opt[string] `query:"cursor,omitzero" json:"-"`
	// Maximum number of results per page (default: 100, max: 1000).
	Limit param.Opt[int64] `query:"limit,omitzero" json:"-"`
	// Search query used to filter results.
	Q param.Opt[string] `query:"q,omitzero" json:"-"`
	// Sub-objects to expand in the response. When omitted, sub-objects are returned as
	// `null`.
	//
	// Any of "owner_account".
	Include []string `query:"include,omitzero" json:"-"`
	// contains filtered or unexported fields
}

func (CoreSandboxListParams) URLQuery 

func (r CoreSandboxListParams) URLQuery() (v url.Values, err error)

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

type CoreSandboxNewParams 

type CoreSandboxNewParams struct {
	// Request to create a sandbox.
	CreateSandboxRequest CreateSandboxRequestParam
	// Sub-objects to expand in the response. When omitted, sub-objects are returned as
	// `null`.
	//
	// Any of "owner_account".
	Include []string `query:"include,omitzero" json:"-"`
	// contains filtered or unexported fields
}

func (CoreSandboxNewParams) MarshalJSON 

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

func (CoreSandboxNewParams) URLQuery 

func (r CoreSandboxNewParams) URLQuery() (v url.Values, err error)

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

func (*CoreSandboxNewParams) UnmarshalJSON 

func (r *CoreSandboxNewParams) UnmarshalJSON(data []byte) error

type CoreSandboxService 

type CoreSandboxService struct {
	// contains filtered or unexported fields
}

List and manage sandbox environments.

CoreSandboxService contains methods and other services that help with interacting with the augno 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 NewCoreSandboxService method instead.

func NewCoreSandboxService 

func NewCoreSandboxService(opts ...option.RequestOption) (r CoreSandboxService)

NewCoreSandboxService 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 (*CoreSandboxService) Delete 

func (r *CoreSandboxService) Delete(ctx context.Context, id string, opts ...option.RequestOption) (res *CoreSandboxDeleteResponse, err error)

Deletes a sandbox account. Account-scoped data is purged asynchronously.

func (*CoreSandboxService) Get 

func (r *CoreSandboxService) Get(ctx context.Context, id string, query CoreSandboxGetParams, opts ...option.RequestOption) (res *Sandbox, err error)

Returns a sandbox by ID.

func (*CoreSandboxService) List 

func (r *CoreSandboxService) List(ctx context.Context, query CoreSandboxListParams, opts ...option.RequestOption) (res *ListSandbox, err error)

Returns a paginated list of sandboxes.

func (*CoreSandboxService) New 

func (r *CoreSandboxService) New(ctx context.Context, params CoreSandboxNewParams, opts ...option.RequestOption) (res *Sandbox, err error)

Creates a sandbox account.

type CoreService 

type CoreService struct {

	// List and manage sandbox environments.
	Sandboxes CoreSandboxService
	// List and retrieve request logs.
	RequestLogs CoreRequestLogService
	// List and retrieve audit events.
	AuditEvents CoreAuditEventService
	// Autocomplete, look up details, and validate addresses.
	Addresses CoreAddressService
	// View email logs for accounts.
	EmailLogs CoreEmailLogService
	// contains filtered or unexported fields
}

CoreService contains methods and other services that help with interacting with the augno 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 NewCoreService method instead.

func NewCoreService 

func NewCoreService(opts ...option.RequestOption) (r CoreService)

NewCoreService 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.

type CreateAPIKeyRequestParam 

type CreateAPIKeyRequestParam struct {
	// Human-readable name for the API key.
	Name string `json:"name" api:"required"`
	// Role ID assigned to the API key.
	RoleID string `json:"role_id" api:"required"`
	// Expiration timestamp. If not set, the key does not expire.
	ExpiresAt param.Opt[time.Time] `json:"expires_at,omitzero" format:"date-time"`
	// contains filtered or unexported fields
}

Request to create an API key.

The properties Name, RoleID are required.

func (CreateAPIKeyRequestParam) MarshalJSON 

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

func (*CreateAPIKeyRequestParam) UnmarshalJSON 

func (r *CreateAPIKeyRequestParam) UnmarshalJSON(data []byte) error

type CreateAccountGroupRequestCommissionPolicy 

type CreateAccountGroupRequestCommissionPolicy string

Commission policy. Defaults to `commission_exempt`.

  • `commission_exempt`: no commission applies.
  • `commission_applied`: commission applies; if the account group is within a sales rep's territory, it will be assigned to that rep unless overridden.
const (
	CreateAccountGroupRequestCommissionPolicyCommissionApplied CreateAccountGroupRequestCommissionPolicy = "commission_applied"
	CreateAccountGroupRequestCommissionPolicyCommissionExempt  CreateAccountGroupRequestCommissionPolicy = "commission_exempt"
)

type CreateAccountGroupRequestFreightPolicy 

type CreateAccountGroupRequestFreightPolicy string

Freight policy. Defaults to `billed_freight`.

  • `free_freight`: customers within this group will not have to pay for freight.
  • `billed_freight`: freight will be applied to any order within this account group, unless overridden elsewhere.
const (
	CreateAccountGroupRequestFreightPolicyFreeFreight   CreateAccountGroupRequestFreightPolicy = "free_freight"
	CreateAccountGroupRequestFreightPolicyBilledFreight CreateAccountGroupRequestFreightPolicy = "billed_freight"
)

type CreateAccountGroupRequestParam 

type CreateAccountGroupRequestParam struct {
	// Display name.
	Name string `json:"name" api:"required"`
	// Account group type.
	//
	// Cannot be changed after creation.
	//
	//   - `pricing_group`: used for pricing rules, such as a "Preferred" group that
	//     receives a special discount.
	//   - `type_group`: used to categorize accounts, such as "Consumers" or
	//     "Distributors".
	//
	// Any of "pricing_group", "type_group".
	Type CreateAccountGroupRequestType `json:"type,omitzero" api:"required"`
	// Description.
	Description param.Opt[string] `json:"description,omitzero"`
	// Commission policy. Defaults to `commission_exempt`.
	//
	//   - `commission_exempt`: no commission applies.
	//   - `commission_applied`: commission applies; if the account group is within a
	//     sales rep's territory, it will be assigned to that rep unless overridden.
	//
	// Any of "commission_applied", "commission_exempt".
	CommissionPolicy CreateAccountGroupRequestCommissionPolicy `json:"commission_policy,omitzero"`
	// Freight policy. Defaults to `billed_freight`.
	//
	//   - `free_freight`: customers within this group will not have to pay for freight.
	//   - `billed_freight`: freight will be applied to any order within this account
	//     group, unless overridden elsewhere.
	//
	// Any of "free_freight", "billed_freight".
	FreightPolicy CreateAccountGroupRequestFreightPolicy `json:"freight_policy,omitzero"`
	// contains filtered or unexported fields
}

Request to create an account group.

The properties Name, Type are required.

func (CreateAccountGroupRequestParam) MarshalJSON 

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

func (*CreateAccountGroupRequestParam) UnmarshalJSON 

func (r *CreateAccountGroupRequestParam) UnmarshalJSON(data []byte) error

type CreateAccountGroupRequestType 

type CreateAccountGroupRequestType string

Account group type.

Cannot be changed after creation.

  • `pricing_group`: used for pricing rules, such as a "Preferred" group that receives a special discount.
  • `type_group`: used to categorize accounts, such as "Consumers" or "Distributors".
const (
	CreateAccountGroupRequestTypePricingGroup CreateAccountGroupRequestType = "pricing_group"
	CreateAccountGroupRequestTypeTypeGroup    CreateAccountGroupRequestType = "type_group"
)

type CreateAccountUserRequestParam 

type CreateAccountUserRequestParam struct {
	// Department assigned to the user.
	DepartmentID param.Opt[string] `json:"department_id,omitzero"`
	// User email address.
	Email param.Opt[string] `json:"email,omitzero"`
	// User display name.
	Name param.Opt[string] `json:"name,omitzero"`
	// Password. Only used for scanner-role users (scanning stations). Must be 8–72
	// chars and include upper, lower, number, and special character.
	Password param.Opt[string] `json:"password,omitzero"`
	// Role assigned to the user.
	RoleID param.Opt[string] `json:"role_id,omitzero"`
	// Unique username (3–255 chars; letters, numbers, underscores, hyphens).
	Username param.Opt[string] `json:"username,omitzero"`
	// Notification preferences for the user (external targets only).
	Preferences []NotificationPreferenceItemParam `json:"preferences,omitzero"`
	// contains filtered or unexported fields
}

Request to create an account user.

func (CreateAccountUserRequestParam) MarshalJSON 

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

func (*CreateAccountUserRequestParam) UnmarshalJSON 

func (r *CreateAccountUserRequestParam) UnmarshalJSON(data []byte) error

type CreateAttributeRequestColor 

type CreateAttributeRequestColor string

Color code. Randomly assigned if not provided. 

const (
	CreateAttributeRequestColorBlue    CreateAttributeRequestColor = "blue"
	CreateAttributeRequestColorBrown   CreateAttributeRequestColor = "brown"
	CreateAttributeRequestColorDefault CreateAttributeRequestColor = "default"
	CreateAttributeRequestColorGray    CreateAttributeRequestColor = "gray"
	CreateAttributeRequestColorGreen   CreateAttributeRequestColor = "green"
	CreateAttributeRequestColorOrange  CreateAttributeRequestColor = "orange"
	CreateAttributeRequestColorPink    CreateAttributeRequestColor = "pink"
	CreateAttributeRequestColorPurple  CreateAttributeRequestColor = "purple"
	CreateAttributeRequestColorRed     CreateAttributeRequestColor = "red"
	CreateAttributeRequestColorYellow  CreateAttributeRequestColor = "yellow"
)

type CreateAttributeRequestParam 

type CreateAttributeRequestParam struct {
	// Attribute value.
	Value string `json:"value" api:"required"`
	// Display order. Defaults to last position if not provided.
	SortOrder param.Opt[int64] `json:"sort_order,omitzero"`
	// Color code. Randomly assigned if not provided.
	//
	// Any of "blue", "brown", "default", "gray", "green", "orange", "pink", "purple",
	// "red", "yellow".
	Color CreateAttributeRequestColor `json:"color,omitzero"`
	// contains filtered or unexported fields
}

Request to create an attribute.

The property Value is required.

func (CreateAttributeRequestParam) MarshalJSON 

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

func (*CreateAttributeRequestParam) UnmarshalJSON 

func (r *CreateAttributeRequestParam) UnmarshalJSON(data []byte) error

type CreateCarrierRequestCode 

type CreateCarrierRequestCode string

Carrier code. 

const (
	CreateCarrierRequestCodeFedex          CreateCarrierRequestCode = "fedex"
	CreateCarrierRequestCodeUps            CreateCarrierRequestCode = "ups"
	CreateCarrierRequestCodeUsps           CreateCarrierRequestCode = "usps"
	CreateCarrierRequestCodeWillCall       CreateCarrierRequestCode = "will_call"
	CreateCarrierRequestCodeDelivery       CreateCarrierRequestCode = "delivery"
	CreateCarrierRequestCodeLtl            CreateCarrierRequestCode = "ltl"
	CreateCarrierRequestCodeLtl1           CreateCarrierRequestCode = "ltl1"
	CreateCarrierRequestCodeFreightCollect CreateCarrierRequestCode = "freight_collect"
)

type CreateCarrierRequestCustomerPortalVisibility 

type CreateCarrierRequestCustomerPortalVisibility string

Carrier visibility in the customer portal.

If `visible`, this carrier will be available for your customers to utilize when they go to checkout. If `hidden`, this carrier will not be an option on checkout. 

const (
	CreateCarrierRequestCustomerPortalVisibilityVisible CreateCarrierRequestCustomerPortalVisibility = "visible"
	CreateCarrierRequestCustomerPortalVisibilityHidden  CreateCarrierRequestCustomerPortalVisibility = "hidden"
)

type CreateCarrierRequestParam 

type CreateCarrierRequestParam struct {
	// Display name.
	Name string `json:"name" api:"required"`
	// Carrier account number. Required for UPS and USPS carriers.
	AccountNumber param.Opt[string] `json:"account_number,omitzero"`
	// Carrier code.
	//
	// Any of "fedex", "ups", "usps", "will_call", "delivery", "ltl", "ltl1",
	// "freight_collect".
	Code CreateCarrierRequestCode `json:"code,omitzero"`
	// Carrier visibility in the customer portal.
	//
	// If `visible`, this carrier will be available for your customers to utilize when
	// they go to checkout. If `hidden`, this carrier will not be an option on
	// checkout.
	//
	// Any of "visible", "hidden".
	CustomerPortalVisibility CreateCarrierRequestCustomerPortalVisibility `json:"customer_portal_visibility,omitzero"`
	// contains filtered or unexported fields
}

Request to create a carrier.

The property Name is required.

func (CreateCarrierRequestParam) MarshalJSON 

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

func (*CreateCarrierRequestParam) UnmarshalJSON 

func (r *CreateCarrierRequestParam) UnmarshalJSON(data []byte) error

type CreateCustomerRequestCarrierBillingType 

type CreateCustomerRequestCarrierBillingType string

Carrier billing type. 

const (
	CreateCustomerRequestCarrierBillingTypeSender     CreateCustomerRequestCarrierBillingType = "sender"
	CreateCustomerRequestCarrierBillingTypeThirdParty CreateCustomerRequestCarrierBillingType = "third_party"
)

type CreateCustomerRequestCommissionPolicy 

type CreateCustomerRequestCommissionPolicy string

Commission policy. 

const (
	CreateCustomerRequestCommissionPolicyCommissionApplied CreateCustomerRequestCommissionPolicy = "commission_applied"
	CreateCustomerRequestCommissionPolicyCommissionExempt  CreateCustomerRequestCommissionPolicy = "commission_exempt"
)

type CreateCustomerRequestDefaultPriority 

type CreateCustomerRequestDefaultPriority string

Default priority code. 

const (
	CreateCustomerRequestDefaultPriorityLow    CreateCustomerRequestDefaultPriority = "low"
	CreateCustomerRequestDefaultPriorityNormal CreateCustomerRequestDefaultPriority = "normal"
	CreateCustomerRequestDefaultPriorityHigh   CreateCustomerRequestDefaultPriority = "high"
)

type CreateCustomerRequestEdiStatus 

type CreateCustomerRequestEdiStatus string

EDI status. 

const (
	CreateCustomerRequestEdiStatusEnabled  CreateCustomerRequestEdiStatus = "enabled"
	CreateCustomerRequestEdiStatusDisabled CreateCustomerRequestEdiStatus = "disabled"
)

type CreateCustomerRequestFreightPolicy 

type CreateCustomerRequestFreightPolicy string

Freight policy. 

const (
	CreateCustomerRequestFreightPolicyFreeFreight   CreateCustomerRequestFreightPolicy = "free_freight"
	CreateCustomerRequestFreightPolicyBilledFreight CreateCustomerRequestFreightPolicy = "billed_freight"
)

type CreateCustomerRequestParam 

type CreateCustomerRequestParam struct {
	// Request to create an address.
	BillToAddress AddressInputParam `json:"bill_to_address,omitzero" api:"required"`
	// Customer type group ID.
	CustomerTypeGroupID string `json:"customer_type_group_id" api:"required"`
	// Default carrier ID.
	DefaultCarrierID string `json:"default_carrier_id" api:"required"`
	// Default payment term ID.
	DefaultPaymentTermID string `json:"default_payment_term_id" api:"required"`
	// Default shipping term ID.
	DefaultShippingTermID string `json:"default_shipping_term_id" api:"required"`
	// Display name.
	Name string `json:"name" api:"required"`
	// Request to create an address.
	ShipToAddress AddressInputParam `json:"ship_to_address,omitzero" api:"required"`
	// Carrier billing account number.
	CarrierBillingAccount param.Opt[string] `json:"carrier_billing_account,omitzero"`
	// The ID of the account user to assign as the default sales rep.
	DefaultSalesRepID param.Opt[string] `json:"default_sales_rep_id,omitzero"`
	// Default service level ID.
	DefaultServiceLevelID param.Opt[string] `json:"default_service_level_id,omitzero"`
	// Email address.
	Email param.Opt[string] `json:"email,omitzero"`
	// Note.
	Note param.Opt[string] `json:"note,omitzero"`
	// Customer number. Auto-generated if omitted.
	Number param.Opt[string] `json:"number,omitzero"`
	// Phone number.
	Phone param.Opt[string] `json:"phone,omitzero"`
	// Website URL.
	URL param.Opt[string] `json:"url,omitzero"`
	// Carrier billing type.
	//
	// Any of "sender", "third_party".
	CarrierBillingType CreateCustomerRequestCarrierBillingType `json:"carrier_billing_type,omitzero"`
	// Commission policy.
	//
	// Any of "commission_applied", "commission_exempt".
	CommissionPolicy CreateCustomerRequestCommissionPolicy `json:"commission_policy,omitzero"`
	// QuantityInput represents a value with an associated unit for create/update
	// requests.
	CreditLimit QuantityInputParam `json:"credit_limit,omitzero"`
	// Price group IDs.
	CustomerPriceGroupIDs []string `json:"customer_price_group_ids,omitzero"`
	// Default priority code.
	//
	// Any of "low", "normal", "high".
	DefaultPriority CreateCustomerRequestDefaultPriority `json:"default_priority,omitzero"`
	// EDI status.
	//
	// Any of "enabled", "disabled".
	EdiStatus CreateCustomerRequestEdiStatus `json:"edi_status,omitzero"`
	// Freight policy.
	//
	// Any of "free_freight", "billed_freight".
	FreightPolicy CreateCustomerRequestFreightPolicy `json:"freight_policy,omitzero"`
	// Account status code.
	//
	// Any of "normal", "preferred", "hold_shipment", "hold_all".
	Status CreateCustomerRequestStatus `json:"status,omitzero"`
	// contains filtered or unexported fields
}

Request to create a customer.

The properties BillToAddress, CustomerTypeGroupID, DefaultCarrierID, DefaultPaymentTermID, DefaultShippingTermID, Name, ShipToAddress are required.

func (CreateCustomerRequestParam) MarshalJSON 

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

func (*CreateCustomerRequestParam) UnmarshalJSON 

func (r *CreateCustomerRequestParam) UnmarshalJSON(data []byte) error

type CreateCustomerRequestStatus 

type CreateCustomerRequestStatus string

Account status code. 

const (
	CreateCustomerRequestStatusNormal       CreateCustomerRequestStatus = "normal"
	CreateCustomerRequestStatusPreferred    CreateCustomerRequestStatus = "preferred"
	CreateCustomerRequestStatusHoldShipment CreateCustomerRequestStatus = "hold_shipment"
	CreateCustomerRequestStatusHoldAll      CreateCustomerRequestStatus = "hold_all"
)

type CreateItemCategoryRequestParam 

type CreateItemCategoryRequestParam struct {
	// Display name.
	Name string `json:"name" api:"required"`
	// Item category type. Material categories are used to group materials, while
	// product categories are used to group products and parts.
	//
	// Any of "material_category", "product_category".
	Type CreateItemCategoryRequestType `json:"type,omitzero" api:"required"`
	// Unit group ID.
	UnitGroupID string `json:"unit_group_id" api:"required"`
	// contains filtered or unexported fields
}

Request to create an item category.

The properties Name, Type, UnitGroupID are required.

func (CreateItemCategoryRequestParam) MarshalJSON 

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

func (*CreateItemCategoryRequestParam) UnmarshalJSON 

func (r *CreateItemCategoryRequestParam) UnmarshalJSON(data []byte) error

type CreateItemCategoryRequestType 

type CreateItemCategoryRequestType string

Item category type. Material categories are used to group materials, while product categories are used to group products and parts. 

const (
	CreateItemCategoryRequestTypeMaterialCategory CreateItemCategoryRequestType = "material_category"
	CreateItemCategoryRequestTypeProductCategory  CreateItemCategoryRequestType = "product_category"
)

type CreateLocationRequestParam 

type CreateLocationRequestParam struct {
	// Display name.
	Name string `json:"name" api:"required"`
	// Location type code.
	//
	// Any of "building", "section", "aisle", "rack", "shelf", "bin".
	Type LocationTypeCode `json:"type,omitzero" api:"required"`
	// Parent location ID. Null for top-level locations.
	ParentID param.Opt[string] `json:"parent_id,omitzero"`
	// IDs of child locations to attach.
	ChildIDs []string `json:"child_ids,omitzero"`
	// contains filtered or unexported fields
}

Request to create a location.

The properties Name, Type are required.

func (CreateLocationRequestParam) MarshalJSON 

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

func (*CreateLocationRequestParam) UnmarshalJSON 

func (r *CreateLocationRequestParam) UnmarshalJSON(data []byte) error

type CreateMaterialRequestParam 

type CreateMaterialRequestParam struct {
	// Category ID.
	CategoryID string `json:"category_id" api:"required"`
	// SKU code.
	SKU string `json:"sku" api:"required"`
	// Description.
	Description param.Opt[string] `json:"description,omitzero"`
	// Notes.
	Notes param.Opt[string] `json:"notes,omitzero"`
	// Attribute IDs to connect to the material at creation time.
	AttributeIDs []string `json:"attribute_ids,omitzero"`
	// QuantityInputRequest is a quantity value and unit.
	LeadTime QuantityInputRequestParam `json:"lead_time,omitzero"`
	// QuantityInputRequest is a quantity value and unit.
	OrderPoint QuantityInputRequestParam `json:"order_point,omitzero"`
	// RateInput represents the input for creating or updating a rate.
	UnitCost RateInputParam `json:"unit_cost,omitzero"`
	// RateInput represents the input for creating or updating a rate.
	UnitPrice RateInputParam `json:"unit_price,omitzero"`
	// contains filtered or unexported fields
}

Request to create a material.

The properties CategoryID, SKU are required.

func (CreateMaterialRequestParam) MarshalJSON 

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

func (*CreateMaterialRequestParam) UnmarshalJSON 

func (r *CreateMaterialRequestParam) UnmarshalJSON(data []byte) error

type CreatePartRequestParam 

type CreatePartRequestParam struct {
	// Category ID.
	CategoryID string `json:"category_id" api:"required"`
	// SKU.
	SKU string `json:"sku" api:"required"`
	// Description.
	Description param.Opt[string] `json:"description,omitzero"`
	// Notes.
	Notes param.Opt[string] `json:"notes,omitzero"`
	// Attribute IDs to connect to the part at creation time.
	AttributeIDs []string `json:"attribute_ids,omitzero"`
	// RateInput represents the input for creating or updating a rate.
	UnitCost RateInputParam `json:"unit_cost,omitzero"`
	// RateInput represents the input for creating or updating a rate.
	UnitPrice RateInputParam `json:"unit_price,omitzero"`
	// contains filtered or unexported fields
}

Request to create a part.

The properties CategoryID, SKU are required.

func (CreatePartRequestParam) MarshalJSON 

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

func (*CreatePartRequestParam) UnmarshalJSON 

func (r *CreatePartRequestParam) UnmarshalJSON(data []byte) error

type CreatePaymentTermRequestParam 

type CreatePaymentTermRequestParam struct {
	// Display name (e.g. "Net 30").
	Name string `json:"name" api:"required"`
	// contains filtered or unexported fields
}

Request to create a payment term.

The property Name is required.

func (CreatePaymentTermRequestParam) MarshalJSON 

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

func (*CreatePaymentTermRequestParam) UnmarshalJSON 

func (r *CreatePaymentTermRequestParam) UnmarshalJSON(data []byte) error

type CreateProductLineRequestCommissionPolicy 

type CreateProductLineRequestCommissionPolicy string

Commission policy of products in this product line. 

const (
	CreateProductLineRequestCommissionPolicyCommissionApplied CreateProductLineRequestCommissionPolicy = "commission_applied"
	CreateProductLineRequestCommissionPolicyCommissionExempt  CreateProductLineRequestCommissionPolicy = "commission_exempt"
)

type CreateProductLineRequestFreightPolicy 

type CreateProductLineRequestFreightPolicy string

Freight policy for all items in this product line. 

const (
	CreateProductLineRequestFreightPolicyFreeFreight   CreateProductLineRequestFreightPolicy = "free_freight"
	CreateProductLineRequestFreightPolicyBilledFreight CreateProductLineRequestFreightPolicy = "billed_freight"
)

type CreateProductLineRequestParam 

type CreateProductLineRequestParam struct {
	// Commission policy of products in this product line.
	//
	// Any of "commission_applied", "commission_exempt".
	CommissionPolicy CreateProductLineRequestCommissionPolicy `json:"commission_policy,omitzero" api:"required"`
	// Freight policy for all items in this product line.
	//
	// Any of "free_freight", "billed_freight".
	FreightPolicy CreateProductLineRequestFreightPolicy `json:"freight_policy,omitzero" api:"required"`
	// Display name.
	Name string `json:"name" api:"required"`
	// Unit group ID associated with this product line. This unit group dictates the
	// units that products in this product line may be purchased in.
	UnitGroupID string `json:"unit_group_id" api:"required"`
	// contains filtered or unexported fields
}

Request to create a product line.

The properties CommissionPolicy, FreightPolicy, Name, UnitGroupID are required.

func (CreateProductLineRequestParam) MarshalJSON 

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

func (*CreateProductLineRequestParam) UnmarshalJSON 

func (r *CreateProductLineRequestParam) UnmarshalJSON(data []byte) error

type CreateProductRequestParam 

type CreateProductRequestParam struct {
	// Category ID.
	CategoryID string `json:"category_id" api:"required"`
	// SKU.
	SKU string `json:"sku" api:"required"`
	// Product type code.
	//
	// Any of "sale", "service", "shipping", "credit", "return", "tax".
	Type CreateProductRequestType `json:"type,omitzero" api:"required"`
	// Description.
	Description param.Opt[string] `json:"description,omitzero"`
	// Notes.
	Notes param.Opt[string] `json:"notes,omitzero"`
	// Product line ID.
	ProductLineID param.Opt[string] `json:"product_line_id,omitzero"`
	// Attribute IDs to connect to the product at creation time.
	AttributeIDs []string `json:"attribute_ids,omitzero"`
	// Whether visible in the customer portal.
	//
	// Any of "visible", "hidden".
	PortalVisibility CreateProductRequestPortalVisibility `json:"portal_visibility,omitzero"`
	// RateInput represents the input for creating or updating a rate.
	UnitCost RateInputParam `json:"unit_cost,omitzero"`
	// RateInput represents the input for creating or updating a rate.
	UnitPrice RateInputParam `json:"unit_price,omitzero"`
	// contains filtered or unexported fields
}

CreateProductRequest is the request to create a product.

The properties CategoryID, SKU, Type are required.

func (CreateProductRequestParam) MarshalJSON 

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

func (*CreateProductRequestParam) UnmarshalJSON 

func (r *CreateProductRequestParam) UnmarshalJSON(data []byte) error

type CreateProductRequestPortalVisibility 

type CreateProductRequestPortalVisibility string

Whether visible in the customer portal. 

const (
	CreateProductRequestPortalVisibilityVisible CreateProductRequestPortalVisibility = "visible"
	CreateProductRequestPortalVisibilityHidden  CreateProductRequestPortalVisibility = "hidden"
)

type CreateProductRequestType 

type CreateProductRequestType string

Product type code. 

const (
	CreateProductRequestTypeSale     CreateProductRequestType = "sale"
	CreateProductRequestTypeService  CreateProductRequestType = "service"
	CreateProductRequestTypeShipping CreateProductRequestType = "shipping"
	CreateProductRequestTypeCredit   CreateProductRequestType = "credit"
	CreateProductRequestTypeReturn   CreateProductRequestType = "return"
	CreateProductRequestTypeTax      CreateProductRequestType = "tax"
)

type CreatePropertyRequestParam 

type CreatePropertyRequestParam struct {
	// Name.
	Name string `json:"name" api:"required"`
	// contains filtered or unexported fields
}

Request to create a property.

The property Name is required.

func (CreatePropertyRequestParam) MarshalJSON 

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

func (*CreatePropertyRequestParam) UnmarshalJSON 

func (r *CreatePropertyRequestParam) UnmarshalJSON(data []byte) error

type CreateRoleRequestParam 

type CreateRoleRequestParam struct {
	// Display name.
	Name string `json:"name" api:"required"`
	// Permissions to attach in `<domain>:<action>` format.
	Permissions []string `json:"permissions,omitzero" api:"required"`
	// contains filtered or unexported fields
}

CreateRoleRequest is a request to create a role.

The properties Name, Permissions are required.

func (CreateRoleRequestParam) MarshalJSON 

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

func (*CreateRoleRequestParam) UnmarshalJSON 

func (r *CreateRoleRequestParam) UnmarshalJSON(data []byte) error

type CreateSandboxRequestMode 

type CreateSandboxRequestMode string

Controls whether the sandbox is blank or seeded with sample data. 

const (
	CreateSandboxRequestModeBlank  CreateSandboxRequestMode = "blank"
	CreateSandboxRequestModeSeeded CreateSandboxRequestMode = "seeded"
)

type CreateSandboxRequestParam 

type CreateSandboxRequestParam struct {
	// Display name.
	Name string `json:"name" api:"required"`
	// Controls whether the sandbox is blank or seeded with sample data.
	//
	// Any of "blank", "seeded".
	Mode CreateSandboxRequestMode `json:"mode,omitzero"`
	// contains filtered or unexported fields
}

Request to create a sandbox.

The property Name is required.

func (CreateSandboxRequestParam) MarshalJSON 

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

func (*CreateSandboxRequestParam) UnmarshalJSON 

func (r *CreateSandboxRequestParam) UnmarshalJSON(data []byte) error

type CreateScanningStationRequestLabelSize 

type CreateScanningStationRequestLabelSize string

Label size code. 

const (
	CreateScanningStationRequestLabelSize1x1 CreateScanningStationRequestLabelSize = "1x1"
	CreateScanningStationRequestLabelSize1x3 CreateScanningStationRequestLabelSize = "1x3"
	CreateScanningStationRequestLabelSize1x4 CreateScanningStationRequestLabelSize = "1x4"
	CreateScanningStationRequestLabelSize2x4 CreateScanningStationRequestLabelSize = "2x4"
)

type CreateScanningStationRequestLabelType 

type CreateScanningStationRequestLabelType string

Label type code. 

const (
	CreateScanningStationRequestLabelTypeTag      CreateScanningStationRequestLabelType = "tag"
	CreateScanningStationRequestLabelTypeTraveler CreateScanningStationRequestLabelType = "traveler"
)

type CreateScanningStationRequestOperatorRequirement 

type CreateScanningStationRequestOperatorRequirement string

Operator requirement behavior for this station. 

const (
	CreateScanningStationRequestOperatorRequirementNone          CreateScanningStationRequestOperatorRequirement = "none"
	CreateScanningStationRequestOperatorRequirementMaterialCheck CreateScanningStationRequestOperatorRequirement = "material_check"
)

type CreateScanningStationRequestParam 

type CreateScanningStationRequestParam struct {
	// Department ID.
	DepartmentID string `json:"department_id" api:"required"`
	// Display name.
	Name string `json:"name" api:"required"`
	// Operator requirement behavior for this station.
	//
	// Any of "none", "material_check".
	OperatorRequirement CreateScanningStationRequestOperatorRequirement `json:"operator_requirement,omitzero" api:"required"`
	// Scanning station type.
	//
	// Any of "init_batch", "merge_batch", "move_batch", "split_batch".
	Type CreateScanningStationRequestType `json:"type,omitzero" api:"required"`
	// Notes.
	Notes param.Opt[string] `json:"notes,omitzero"`
	// Label size code.
	//
	// Any of "1x1", "1x3", "1x4", "2x4".
	LabelSize CreateScanningStationRequestLabelSize `json:"label_size,omitzero"`
	// Label type code.
	//
	// Any of "tag", "traveler".
	LabelType CreateScanningStationRequestLabelType `json:"label_type,omitzero"`
	// contains filtered or unexported fields
}

Request to create a scanning station.

The properties DepartmentID, Name, OperatorRequirement, Type are required.

func (CreateScanningStationRequestParam) MarshalJSON 

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

func (*CreateScanningStationRequestParam) UnmarshalJSON 

func (r *CreateScanningStationRequestParam) UnmarshalJSON(data []byte) error

type CreateScanningStationRequestType 

type CreateScanningStationRequestType string

Scanning station type. 

const (
	CreateScanningStationRequestTypeInitBatch  CreateScanningStationRequestType = "init_batch"
	CreateScanningStationRequestTypeMergeBatch CreateScanningStationRequestType = "merge_batch"
	CreateScanningStationRequestTypeMoveBatch  CreateScanningStationRequestType = "move_batch"
	CreateScanningStationRequestTypeSplitBatch CreateScanningStationRequestType = "split_batch"
)

type CreateServiceLevelRequestCustomerPortalVisibility 

type CreateServiceLevelRequestCustomerPortalVisibility string

Whether this service level will be available for customers to select in the customer portal. 

const (
	CreateServiceLevelRequestCustomerPortalVisibilityVisible CreateServiceLevelRequestCustomerPortalVisibility = "visible"
	CreateServiceLevelRequestCustomerPortalVisibilityHidden  CreateServiceLevelRequestCustomerPortalVisibility = "hidden"
)

type CreateServiceLevelRequestParam 

type CreateServiceLevelRequestParam struct {
	// Service level code.
	Code string `json:"code" api:"required"`
	// Default service levels are the default-selected service level for that carrier.
	IsDefault bool `json:"is_default" api:"required"`
	// Display name.
	Name string `json:"name" api:"required"`
	// Whether this service level will be available for customers to select in the
	// customer portal.
	//
	// Any of "visible", "hidden".
	CustomerPortalVisibility CreateServiceLevelRequestCustomerPortalVisibility `json:"customer_portal_visibility,omitzero"`
	// contains filtered or unexported fields
}

Request to create a service level.

The properties Code, IsDefault, Name are required.

func (CreateServiceLevelRequestParam) MarshalJSON 

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

func (*CreateServiceLevelRequestParam) UnmarshalJSON 

func (r *CreateServiceLevelRequestParam) UnmarshalJSON(data []byte) error

type CreateShippingTermRequestParam 

type CreateShippingTermRequestParam struct {
	// Display name.
	Name string `json:"name" api:"required"`
	// Shipping term type.
	//
	// Any of "free_freight", "flat_rate_freight", "carrier_rate_freight".
	Type CreateShippingTermRequestType `json:"type,omitzero" api:"required"`
	// QuantityInput represents a value with an associated unit for create/update
	// requests.
	FlatRate QuantityInputParam `json:"flat_rate,omitzero"`
	// Service level IDs that qualify for free shipping.
	FreeShippingServiceLevelIDs []string `json:"free_shipping_service_level_ids,omitzero"`
	// QuantityInput represents a value with an associated unit for create/update
	// requests.
	MinimumOrderValue QuantityInputParam `json:"minimum_order_value,omitzero"`
	// contains filtered or unexported fields
}

Request to create a shipping term.

The properties Name, Type are required.

func (CreateShippingTermRequestParam) MarshalJSON 

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

func (*CreateShippingTermRequestParam) UnmarshalJSON 

func (r *CreateShippingTermRequestParam) UnmarshalJSON(data []byte) error

type CreateShippingTermRequestType 

type CreateShippingTermRequestType string

Shipping term type. 

const (
	CreateShippingTermRequestTypeFreeFreight        CreateShippingTermRequestType = "free_freight"
	CreateShippingTermRequestTypeFlatRateFreight    CreateShippingTermRequestType = "flat_rate_freight"
	CreateShippingTermRequestTypeCarrierRateFreight CreateShippingTermRequestType = "carrier_rate_freight"
)

type CreateUnitGroupRequestParam 

type CreateUnitGroupRequestParam struct {
	// Base unit ID.
	BaseUnitID string `json:"base_unit_id" api:"required"`
	// Display name.
	Name string `json:"name" api:"required"`
	// Unit type.
	//
	// Any of "currency", "quantity", "time", "mass", "volume", "length",
	// "temperature", "area".
	Type CreateUnitGroupRequestType `json:"type,omitzero" api:"required"`
	// Notes.
	Notes param.Opt[string] `json:"notes,omitzero"`
	// Associated units to create with the group.
	AssociatedUnits []CreateUnitGroupUnitParam `json:"associated_units,omitzero"`
	// contains filtered or unexported fields
}

CreateUnitGroupRequest is a request to create a unit group.

The properties BaseUnitID, Name, Type are required.

func (CreateUnitGroupRequestParam) MarshalJSON 

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

func (*CreateUnitGroupRequestParam) UnmarshalJSON 

func (r *CreateUnitGroupRequestParam) UnmarshalJSON(data []byte) error

type CreateUnitGroupRequestType 

type CreateUnitGroupRequestType string

Unit type. 

const (
	CreateUnitGroupRequestTypeCurrency    CreateUnitGroupRequestType = "currency"
	CreateUnitGroupRequestTypeQuantity    CreateUnitGroupRequestType = "quantity"
	CreateUnitGroupRequestTypeTime        CreateUnitGroupRequestType = "time"
	CreateUnitGroupRequestTypeMass        CreateUnitGroupRequestType = "mass"
	CreateUnitGroupRequestTypeVolume      CreateUnitGroupRequestType = "volume"
	CreateUnitGroupRequestTypeLength      CreateUnitGroupRequestType = "length"
	CreateUnitGroupRequestTypeTemperature CreateUnitGroupRequestType = "temperature"
	CreateUnitGroupRequestTypeArea        CreateUnitGroupRequestType = "area"
)

type CreateUnitGroupUnitParam 

type CreateUnitGroupUnitParam struct {
	// Unit ID.
	UnitID string `json:"unit_id" api:"required"`
	// Fixed discount amount.
	DiscountFixed param.Opt[float64] `json:"discount_fixed,omitzero"`
	// Discount percentage.
	DiscountPercentage param.Opt[float64] `json:"discount_percentage,omitzero"`
	// Customer portal visibility.
	//
	// Any of "visible", "hidden".
	CustomerPortalVisibility CreateUnitGroupUnitParamCustomerPortalVisibility `json:"customer_portal_visibility,omitzero"`
	// contains filtered or unexported fields
}

CreateUnitGroupUnitParam contains parameters for an associated unit.

The property UnitID is required.

func (CreateUnitGroupUnitParam) MarshalJSON 

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

func (*CreateUnitGroupUnitParam) UnmarshalJSON 

func (r *CreateUnitGroupUnitParam) UnmarshalJSON(data []byte) error

type CreateUnitGroupUnitParamCustomerPortalVisibility 

type CreateUnitGroupUnitParamCustomerPortalVisibility string

Customer portal visibility. 

const (
	CreateUnitGroupUnitParamCustomerPortalVisibilityVisible CreateUnitGroupUnitParamCustomerPortalVisibility = "visible"
	CreateUnitGroupUnitParamCustomerPortalVisibilityHidden  CreateUnitGroupUnitParamCustomerPortalVisibility = "hidden"
)

type CreateUnitGroupUnitRequestCustomerPortalVisibility 

type CreateUnitGroupUnitRequestCustomerPortalVisibility string

Customer portal visibility. 

const (
	CreateUnitGroupUnitRequestCustomerPortalVisibilityVisible CreateUnitGroupUnitRequestCustomerPortalVisibility = "visible"
	CreateUnitGroupUnitRequestCustomerPortalVisibilityHidden  CreateUnitGroupUnitRequestCustomerPortalVisibility = "hidden"
)

type CreateUnitGroupUnitRequestParam 

type CreateUnitGroupUnitRequestParam struct {
	// Unit ID.
	UnitID string `json:"unit_id" api:"required"`
	// Fixed discount amount.
	DiscountFixed param.Opt[float64] `json:"discount_fixed,omitzero"`
	// Discount percentage.
	DiscountPercentage param.Opt[float64] `json:"discount_percentage,omitzero"`
	// Customer portal visibility.
	//
	// Any of "visible", "hidden".
	CustomerPortalVisibility CreateUnitGroupUnitRequestCustomerPortalVisibility `json:"customer_portal_visibility,omitzero"`
	// contains filtered or unexported fields
}

CreateUnitGroupUnitRequest is a request to create an associated unit within a unit group.

The property UnitID is required.

func (CreateUnitGroupUnitRequestParam) MarshalJSON 

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

func (*CreateUnitGroupUnitRequestParam) UnmarshalJSON 

func (r *CreateUnitGroupUnitRequestParam) UnmarshalJSON(data []byte) error

type CreateUnitRequestParam 

type CreateUnitRequestParam struct {
	// Short abbreviation for the unit (e.g. "g").
	Abbreviation string `json:"abbreviation" api:"required"`
	// Display name of the unit (e.g. "Gram").
	Name string `json:"name" api:"required"`
	// Conversion offset denominator, as a decimal string. Must not be zero.
	OffsetDenominator string `json:"offset_denominator" api:"required" format:"decimal"`
	// Conversion offset numerator, as a decimal string.
	OffsetNumerator string `json:"offset_numerator" api:"required" format:"decimal"`
	// Conversion ratio denominator relative to the base unit, as a decimal string.
	// Must not be zero.
	RatioDenominator string `json:"ratio_denominator" api:"required" format:"decimal"`
	// Conversion ratio numerator relative to the base unit, as a decimal string.
	RatioNumerator string `json:"ratio_numerator" api:"required" format:"decimal"`
	// Unit dimension code.
	//
	// Any of "currency", "quantity", "time", "mass", "volume", "length",
	// "temperature", "area".
	Type CreateUnitRequestType `json:"type,omitzero" api:"required"`
	// contains filtered or unexported fields
}

Request to create a unit.

The properties Abbreviation, Name, OffsetDenominator, OffsetNumerator, RatioDenominator, RatioNumerator, Type are required.

func (CreateUnitRequestParam) MarshalJSON 

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

func (*CreateUnitRequestParam) UnmarshalJSON 

func (r *CreateUnitRequestParam) UnmarshalJSON(data []byte) error

type CreateUnitRequestType 

type CreateUnitRequestType string

Unit dimension code. 

const (
	CreateUnitRequestTypeCurrency    CreateUnitRequestType = "currency"
	CreateUnitRequestTypeQuantity    CreateUnitRequestType = "quantity"
	CreateUnitRequestTypeTime        CreateUnitRequestType = "time"
	CreateUnitRequestTypeMass        CreateUnitRequestType = "mass"
	CreateUnitRequestTypeVolume      CreateUnitRequestType = "volume"
	CreateUnitRequestTypeLength      CreateUnitRequestType = "length"
	CreateUnitRequestTypeTemperature CreateUnitRequestType = "temperature"
	CreateUnitRequestTypeArea        CreateUnitRequestType = "area"
)

type CreatedAPIKey 

type CreatedAPIKey struct {
	// API key resource.
	APIKeyInfo APIKey `json:"api_key_info" api:"required"`
	// Full secret value. Returned once and cannot be retrieved later. Learn more about
	// [managing your API keys](https://docs.augno.com/api/managing-api-keys).
	APIKeySecret string `json:"api_key_secret" api:"required"`
	// Resource type identifier.
	//
	// Any of "created_api_key".
	Object CreatedAPIKeyObject `json:"object" api:"required"`
	// JSON contains metadata for fields, check presence with [respjson.Field.Valid].
	JSON struct {
		APIKeyInfo   respjson.Field
		APIKeySecret respjson.Field
		Object       respjson.Field
		ExtraFields  map[string]respjson.Field
		// contains filtered or unexported fields
	} `json:"-"`
}

Result of creating an API key, with the full secret value.

func (CreatedAPIKey) RawJSON 

func (r CreatedAPIKey) RawJSON() string

Returns the unmodified JSON received from the API

func (*CreatedAPIKey) UnmarshalJSON 

func (r *CreatedAPIKey) UnmarshalJSON(data []byte) error

type CreatedAPIKeyObject 

type CreatedAPIKeyObject string

Resource type identifier. 

const (
	CreatedAPIKeyObjectCreatedAPIKey CreatedAPIKeyObject = "created_api_key"
)

type Customer 

type Customer struct {
	// Customer ID.
	ID string `json:"id" api:"required"`
	// Address with associated geolocation.
	BillToAddress Address `json:"bill_to_address" api:"required"`
	// List represents a paginated list of resources.
	ChildAccounts *ListCustomer `json:"child_accounts" api:"required"`
	// Commission policy.
	//
	// Any of "commission_applied", "commission_exempt".
	CommissionPolicy CustomerCommissionPolicy `json:"commission_policy" api:"required"`
	// Customer contact information.
	ContactInfo CustomerContactInfo `json:"contact_info" api:"required"`
	// Creation timestamp.
	CreatedAt time.Time `json:"created_at" api:"required" format:"date-time"`
	// Value with an associated unit.
	CreditLimit Quantity `json:"credit_limit" api:"required"`
	// Customer default configuration.
	Defaults CustomerDefaults `json:"defaults" api:"required"`
	// EDI status.
	//
	// Any of "enabled", "disabled".
	EdiStatus CustomerEdiStatus `json:"edi_status" api:"required"`
	// Customer freight and carrier settings.
	FreightPreferences CustomerFreightPreferences `json:"freight_preferences" api:"required"`
	// Display name.
	Name string `json:"name" api:"required"`
	// Note.
	Note string `json:"note" api:"required"`
	// Customer notification settings.
	NotificationPreferences CustomerNotificationPreferences `json:"notification_preferences" api:"required"`
	// Customer number.
	Number string `json:"number" api:"required"`
	// Resource type identifier.
	//
	// Any of "customer".
	Object CustomerObject `json:"object" api:"required"`
	// Customer account.
	ParentAccount *Customer `json:"parent_account" api:"required"`
	// List represents a paginated list of resources.
	PriceGroups ListAccountGroup `json:"price_groups" api:"required"`
	// Customer relationship type.
	//
	// Any of "standalone", "parent", "child".
	RelationshipType CustomerRelationshipType `json:"relationship_type" api:"required"`
	// Address with associated geolocation.
	ShipToAddress Address `json:"ship_to_address" api:"required"`
	// Account status code.
	//
	// Any of "normal", "preferred", "hold_shipment", "hold_all".
	Status CustomerStatus `json:"status" api:"required"`
	// Account group resource.
	Type AccountGroup `json:"type" api:"required"`
	// Last updated timestamp.
	UpdatedAt time.Time `json:"updated_at" api:"required" format:"date-time"`
	// JSON contains metadata for fields, check presence with [respjson.Field.Valid].
	JSON struct {
		ID                      respjson.Field
		BillToAddress           respjson.Field
		ChildAccounts           respjson.Field
		CommissionPolicy        respjson.Field
		ContactInfo             respjson.Field
		CreatedAt               respjson.Field
		CreditLimit             respjson.Field
		Defaults                respjson.Field
		EdiStatus               respjson.Field
		FreightPreferences      respjson.Field
		Name                    respjson.Field
		Note                    respjson.Field
		NotificationPreferences respjson.Field
		Number                  respjson.Field
		Object                  respjson.Field
		ParentAccount           respjson.Field
		PriceGroups             respjson.Field
		RelationshipType        respjson.Field
		ShipToAddress           respjson.Field
		Status                  respjson.Field
		Type                    respjson.Field
		UpdatedAt               respjson.Field
		ExtraFields             map[string]respjson.Field
		// contains filtered or unexported fields
	} `json:"-"`
}

Customer account.

func (Customer) RawJSON 

func (r Customer) RawJSON() string

Returns the unmodified JSON received from the API

func (*Customer) UnmarshalJSON 

func (r *Customer) UnmarshalJSON(data []byte) error

type CustomerCommissionPolicy 

type CustomerCommissionPolicy string

Commission policy. 

const (
	CustomerCommissionPolicyCommissionApplied CustomerCommissionPolicy = "commission_applied"
	CustomerCommissionPolicyCommissionExempt  CustomerCommissionPolicy = "commission_exempt"
)

type CustomerContactInfo 

type CustomerContactInfo struct {
	// Email address.
	Email string `json:"email" api:"required"`
	// Resource type identifier.
	//
	// Any of "customer_contact_info".
	Object CustomerContactInfoObject `json:"object" api:"required"`
	// Phone number.
	Phone string `json:"phone" api:"required"`
	// Website URL.
	URL string `json:"url" api:"required"`
	// JSON contains metadata for fields, check presence with [respjson.Field.Valid].
	JSON struct {
		Email       respjson.Field
		Object      respjson.Field
		Phone       respjson.Field
		URL         respjson.Field
		ExtraFields map[string]respjson.Field
		// contains filtered or unexported fields
	} `json:"-"`
}

Customer contact information.

func (CustomerContactInfo) RawJSON 

func (r CustomerContactInfo) RawJSON() string

Returns the unmodified JSON received from the API

func (*CustomerContactInfo) UnmarshalJSON 

func (r *CustomerContactInfo) UnmarshalJSON(data []byte) error

type CustomerContactInfoObject 

type CustomerContactInfoObject string

Resource type identifier. 

const (
	CustomerContactInfoObjectCustomerContactInfo CustomerContactInfoObject = "customer_contact_info"
)

type CustomerDefaults 

type CustomerDefaults struct {
	// Resource type identifier.
	//
	// Any of "customer_defaults".
	Object CustomerDefaultsObject `json:"object" api:"required"`
	// Payment term resource.
	PaymentTerm PaymentTerm `json:"payment_term" api:"required"`
	// Priority level used by sales orders and picks.
	Priority Priority `json:"priority" api:"required"`
	// Account user with role and department. Profile fields (name, email, username,
	// image URL) live on the expandable user sub-resource.
	SalesRep AccountUser `json:"sales_rep" api:"required"`
	// ShippingTerm resource.
	ShippingTerm ShippingTerm `json:"shipping_term" api:"required"`
	// JSON contains metadata for fields, check presence with [respjson.Field.Valid].
	JSON struct {
		Object       respjson.Field
		PaymentTerm  respjson.Field
		Priority     respjson.Field
		SalesRep     respjson.Field
		ShippingTerm respjson.Field
		ExtraFields  map[string]respjson.Field
		// contains filtered or unexported fields
	} `json:"-"`
}

Customer default configuration.

func (CustomerDefaults) RawJSON 

func (r CustomerDefaults) RawJSON() string

Returns the unmodified JSON received from the API

func (*CustomerDefaults) UnmarshalJSON 

func (r *CustomerDefaults) UnmarshalJSON(data []byte) error

type CustomerDefaultsObject 

type CustomerDefaultsObject string

Resource type identifier. 

const (
	CustomerDefaultsObjectCustomerDefaults CustomerDefaultsObject = "customer_defaults"
)

type CustomerEdiStatus 

type CustomerEdiStatus string

EDI status. 

const (
	CustomerEdiStatusEnabled  CustomerEdiStatus = "enabled"
	CustomerEdiStatusDisabled CustomerEdiStatus = "disabled"
)

type CustomerFreightPreferences 

type CustomerFreightPreferences struct {
	// Carrier billing account number.
	BillingAccount string `json:"billing_account" api:"required"`
	// Carrier billing type.
	//
	// Any of "sender", "third_party".
	BillingType CustomerFreightPreferencesBillingType `json:"billing_type" api:"required"`
	// Carrier resource.
	Carrier Carrier `json:"carrier" api:"required"`
	// Resource type identifier.
	//
	// Any of "customer_freight_preferences".
	Object CustomerFreightPreferencesObject `json:"object" api:"required"`
	// Shipping service level for a carrier.
	ServiceLevel ServiceLevel `json:"service_level" api:"required"`
	// Freight policy.
	//
	// Any of "free_freight", "billed_freight".
	Status CustomerFreightPreferencesStatus `json:"status" api:"required"`
	// JSON contains metadata for fields, check presence with [respjson.Field.Valid].
	JSON struct {
		BillingAccount respjson.Field
		BillingType    respjson.Field
		Carrier        respjson.Field
		Object         respjson.Field
		ServiceLevel   respjson.Field
		Status         respjson.Field
		ExtraFields    map[string]respjson.Field
		// contains filtered or unexported fields
	} `json:"-"`
}

Customer freight and carrier settings.

func (CustomerFreightPreferences) RawJSON 

func (r CustomerFreightPreferences) RawJSON() string

Returns the unmodified JSON received from the API

func (*CustomerFreightPreferences) UnmarshalJSON 

func (r *CustomerFreightPreferences) UnmarshalJSON(data []byte) error

type CustomerFreightPreferencesBillingType 

type CustomerFreightPreferencesBillingType string

Carrier billing type. 

const (
	CustomerFreightPreferencesBillingTypeSender     CustomerFreightPreferencesBillingType = "sender"
	CustomerFreightPreferencesBillingTypeThirdParty CustomerFreightPreferencesBillingType = "third_party"
)

type CustomerFreightPreferencesObject 

type CustomerFreightPreferencesObject string

Resource type identifier. 

const (
	CustomerFreightPreferencesObjectCustomerFreightPreferences CustomerFreightPreferencesObject = "customer_freight_preferences"
)

type CustomerFreightPreferencesStatus 

type CustomerFreightPreferencesStatus string

Freight policy. 

const (
	CustomerFreightPreferencesStatusFreeFreight   CustomerFreightPreferencesStatus = "free_freight"
	CustomerFreightPreferencesStatusBilledFreight CustomerFreightPreferencesStatus = "billed_freight"
)

type CustomerNotificationPreferences 

type CustomerNotificationPreferences struct {
	// Whether invoice emails are accepted.
	AcceptsInvoiceEmails bool `json:"accepts_invoice_emails" api:"required"`
	// Resource type identifier.
	//
	// Any of "customer_notification_preferences".
	Object CustomerNotificationPreferencesObject `json:"object" api:"required"`
	// JSON contains metadata for fields, check presence with [respjson.Field.Valid].
	JSON struct {
		AcceptsInvoiceEmails respjson.Field
		Object               respjson.Field
		ExtraFields          map[string]respjson.Field
		// contains filtered or unexported fields
	} `json:"-"`
}

Customer notification settings.

func (CustomerNotificationPreferences) RawJSON 

func (r CustomerNotificationPreferences) RawJSON() string

Returns the unmodified JSON received from the API

func (*CustomerNotificationPreferences) UnmarshalJSON 

func (r *CustomerNotificationPreferences) UnmarshalJSON(data []byte) error

type CustomerNotificationPreferencesObject 

type CustomerNotificationPreferencesObject string

Resource type identifier. 

const (
	CustomerNotificationPreferencesObjectCustomerNotificationPreferences CustomerNotificationPreferencesObject = "customer_notification_preferences"
)

type CustomerObject 

type CustomerObject string

Resource type identifier. 

const (
	CustomerObjectCustomer CustomerObject = "customer"
)

type CustomerRelationshipType 

type CustomerRelationshipType string

Customer relationship type. 

const (
	CustomerRelationshipTypeStandalone CustomerRelationshipType = "standalone"
	CustomerRelationshipTypeParent     CustomerRelationshipType = "parent"
	CustomerRelationshipTypeChild      CustomerRelationshipType = "child"
)

type CustomerStatus 

type CustomerStatus string

Account status code. 

const (
	CustomerStatusNormal       CustomerStatus = "normal"
	CustomerStatusPreferred    CustomerStatus = "preferred"
	CustomerStatusHoldShipment CustomerStatus = "hold_shipment"
	CustomerStatusHoldAll      CustomerStatus = "hold_all"
)

type Department 

type Department struct {
	// Department ID.
	ID string `json:"id" api:"required"`
	// Creation timestamp.
	CreatedAt time.Time `json:"created_at" api:"required" format:"date-time"`
	// Location resource.
	Location Location `json:"location" api:"required"`
	// List represents a paginated list of resources.
	Machines *ListMachine `json:"machines" api:"required"`
	// Display name.
	Name string `json:"name" api:"required"`
	// Notes about the department.
	Notes string `json:"notes" api:"required"`
	// Resource type identifier.
	//
	// Any of "department".
	Object DepartmentObject `json:"object" api:"required"`
	// List represents a paginated list of resources.
	ScanningStations *ListScanningStation `json:"scanning_stations" api:"required"`
	// Last update timestamp.
	UpdatedAt time.Time `json:"updated_at" api:"required" format:"date-time"`
	// JSON contains metadata for fields, check presence with [respjson.Field.Valid].
	JSON struct {
		ID               respjson.Field
		CreatedAt        respjson.Field
		Location         respjson.Field
		Machines         respjson.Field
		Name             respjson.Field
		Notes            respjson.Field
		Object           respjson.Field
		ScanningStations respjson.Field
		UpdatedAt        respjson.Field
		ExtraFields      map[string]respjson.Field
		// contains filtered or unexported fields
	} `json:"-"`
}

Department resource.

func (Department) RawJSON 

func (r Department) RawJSON() string

Returns the unmodified JSON received from the API

func (*Department) UnmarshalJSON 

func (r *Department) UnmarshalJSON(data []byte) error

type DepartmentObject 

type DepartmentObject string

Resource type identifier. 

const (
	DepartmentObjectDepartment DepartmentObject = "department"
)

type EmailLog 

type EmailLog struct {
	// Email log ID.
	ID string `json:"id" api:"required"`
	// Creation timestamp.
	CreatedAt time.Time `json:"created_at" api:"required" format:"date-time"`
	// Filename of any attachment.
	Filename string `json:"filename" api:"required"`
	// Resource type identifier.
	//
	// Any of "email_log".
	Object EmailLogObject `json:"object" api:"required"`
	// Recipient email addresses.
	Recipients []string `json:"recipients" api:"required"`
	// Email send status.
	//
	// Any of "sent", "pending".
	SendStatus EmailLogSendStatus `json:"send_status" api:"required"`
	// Reference to an actor (user, API key, or agent).
	SentBy Actor `json:"sent_by" api:"required"`
	// Email subject line.
	Subject string `json:"subject" api:"required"`
	// Last updated timestamp.
	UpdatedAt time.Time `json:"updated_at" api:"required" format:"date-time"`
	// JSON contains metadata for fields, check presence with [respjson.Field.Valid].
	JSON struct {
		ID          respjson.Field
		CreatedAt   respjson.Field
		Filename    respjson.Field
		Object      respjson.Field
		Recipients  respjson.Field
		SendStatus  respjson.Field
		SentBy      respjson.Field
		Subject     respjson.Field
		UpdatedAt   respjson.Field
		ExtraFields map[string]respjson.Field
		// contains filtered or unexported fields
	} `json:"-"`
}

Email log entry.

func (EmailLog) RawJSON 

func (r EmailLog) RawJSON() string

Returns the unmodified JSON received from the API

func (*EmailLog) UnmarshalJSON 

func (r *EmailLog) UnmarshalJSON(data []byte) error

type EmailLogObject 

type EmailLogObject string

Resource type identifier. 

const (
	EmailLogObjectEmailLog EmailLogObject = "email_log"
)

type EmailLogSendStatus 

type EmailLogSendStatus string

Email send status. 

const (
	EmailLogSendStatusSent    EmailLogSendStatus = "sent"
	EmailLogSendStatusPending EmailLogSendStatus = "pending"
)

type Error 

type Error = apierror.Error

type FinanceGetAdjustmentTypesParams 

type FinanceGetAdjustmentTypesParams struct {
	// Cursor token used to retrieve the next or previous page of results.
	Cursor param.Opt[string] `query:"cursor,omitzero" json:"-"`
	// Maximum number of results per page (default: 100, max: 1000).
	Limit param.Opt[int64] `query:"limit,omitzero" json:"-"`
	// Search query used to filter results.
	Q param.Opt[string] `query:"q,omitzero" json:"-"`
	// Sub-objects to expand in the response. When omitted, sub-objects are returned as
	// `null`.
	//
	// Any of "owner".
	Include []string `query:"include,omitzero" json:"-"`
	// contains filtered or unexported fields
}

func (FinanceGetAdjustmentTypesParams) URLQuery 

func (r FinanceGetAdjustmentTypesParams) URLQuery() (v url.Values, err error)

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

type FinanceGetTransactionMethodsParams 

type FinanceGetTransactionMethodsParams struct {
	// Cursor token used to retrieve the next or previous page of results.
	Cursor param.Opt[string] `query:"cursor,omitzero" json:"-"`
	// Maximum number of results per page (default: 100, max: 1000).
	Limit param.Opt[int64] `query:"limit,omitzero" json:"-"`
	// Search query used to filter results.
	Q param.Opt[string] `query:"q,omitzero" json:"-"`
	// contains filtered or unexported fields
}

func (FinanceGetTransactionMethodsParams) URLQuery 

func (r FinanceGetTransactionMethodsParams) URLQuery() (v url.Values, err error)

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

type FinanceGetTransactionTypesParams 

type FinanceGetTransactionTypesParams struct {
	// Cursor token used to retrieve the next or previous page of results.
	Cursor param.Opt[string] `query:"cursor,omitzero" json:"-"`
	// Maximum number of results per page (default: 100, max: 1000).
	Limit param.Opt[int64] `query:"limit,omitzero" json:"-"`
	// Search query used to filter results.
	Q param.Opt[string] `query:"q,omitzero" json:"-"`
	// contains filtered or unexported fields
}

func (FinanceGetTransactionTypesParams) URLQuery 

func (r FinanceGetTransactionTypesParams) URLQuery() (v url.Values, err error)

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

type FinancePaymentTermDeleteResponse 

type FinancePaymentTermDeleteResponse struct {
	// JSON contains metadata for fields, check presence with [respjson.Field.Valid].
	JSON struct {
		ExtraFields map[string]respjson.Field
		// contains filtered or unexported fields
	} `json:"-"`
}

func (FinancePaymentTermDeleteResponse) RawJSON 

func (r FinancePaymentTermDeleteResponse) RawJSON() string

Returns the unmodified JSON received from the API

func (*FinancePaymentTermDeleteResponse) UnmarshalJSON 

func (r *FinancePaymentTermDeleteResponse) UnmarshalJSON(data []byte) error

type FinancePaymentTermGetParams 

type FinancePaymentTermGetParams struct {
	// Sub-objects to expand in the response. When omitted, sub-objects are returned as
	// `null`.
	//
	// Any of "owner", "owner.account".
	Include []string `query:"include,omitzero" json:"-"`
	// contains filtered or unexported fields
}

func (FinancePaymentTermGetParams) URLQuery 

func (r FinancePaymentTermGetParams) URLQuery() (v url.Values, err error)

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

type FinancePaymentTermListParams 

type FinancePaymentTermListParams struct {
	// Cursor token used to retrieve the next or previous page of results.
	Cursor param.Opt[string] `query:"cursor,omitzero" json:"-"`
	// Maximum number of results per page (default: 100, max: 1000).
	Limit param.Opt[int64] `query:"limit,omitzero" json:"-"`
	// Search query used to filter results.
	Q param.Opt[string] `query:"q,omitzero" json:"-"`
	// Sub-objects to expand in the response. When omitted, sub-objects are returned as
	// `null`.
	//
	// Any of "owner", "owner.account".
	Include []string `query:"include,omitzero" json:"-"`
	// contains filtered or unexported fields
}

func (FinancePaymentTermListParams) URLQuery 

func (r FinancePaymentTermListParams) URLQuery() (v url.Values, err error)

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

type FinancePaymentTermNewParams 

type FinancePaymentTermNewParams struct {
	// Request to create a payment term.
	CreatePaymentTermRequest CreatePaymentTermRequestParam
	// Sub-objects to expand in the response. When omitted, sub-objects are returned as
	// `null`.
	//
	// Any of "owner", "owner.account".
	Include []string `query:"include,omitzero" json:"-"`
	// contains filtered or unexported fields
}

func (FinancePaymentTermNewParams) MarshalJSON 

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

func (FinancePaymentTermNewParams) URLQuery 

func (r FinancePaymentTermNewParams) URLQuery() (v url.Values, err error)

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

func (*FinancePaymentTermNewParams) UnmarshalJSON 

func (r *FinancePaymentTermNewParams) UnmarshalJSON(data []byte) error

type FinancePaymentTermService 

type FinancePaymentTermService struct {
	// contains filtered or unexported fields
}

List and manage payment terms.

FinancePaymentTermService contains methods and other services that help with interacting with the augno 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 NewFinancePaymentTermService method instead.

func NewFinancePaymentTermService 

func NewFinancePaymentTermService(opts ...option.RequestOption) (r FinancePaymentTermService)

NewFinancePaymentTermService 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 (*FinancePaymentTermService) Delete 

func (r *FinancePaymentTermService) Delete(ctx context.Context, id string, opts ...option.RequestOption) (res *FinancePaymentTermDeleteResponse, err error)

Deletes a payment term. Default payment terms cannot be deleted.

func (*FinancePaymentTermService) Get 

func (r *FinancePaymentTermService) Get(ctx context.Context, id string, query FinancePaymentTermGetParams, opts ...option.RequestOption) (res *PaymentTerm, err error)

Returns a payment term by ID.

func (*FinancePaymentTermService) List 

func (r *FinancePaymentTermService) List(ctx context.Context, query FinancePaymentTermListParams, opts ...option.RequestOption) (res *ListPaymentTerm, err error)

Returns a paginated list of payment terms. Includes both account-specific and system default payment terms.

func (*FinancePaymentTermService) New 

func (r *FinancePaymentTermService) New(ctx context.Context, params FinancePaymentTermNewParams, opts ...option.RequestOption) (res *PaymentTerm, err error)

Creates a payment term.

func (*FinancePaymentTermService) Update 

func (r *FinancePaymentTermService) Update(ctx context.Context, id string, params FinancePaymentTermUpdateParams, opts ...option.RequestOption) (res *PaymentTerm, err error)

Partially updates a payment term. Default payment terms cannot be updated.

type FinancePaymentTermUpdateParams 

type FinancePaymentTermUpdateParams struct {
	// Sub-objects to expand in the response. When omitted, sub-objects are returned as
	// `null`.
	//
	// Any of "owner", "owner.account".
	Include []string `query:"include,omitzero" json:"-"`
	// Request to partially update a payment term.
	UpdatePaymentTermRequest UpdatePaymentTermRequestParam
	// contains filtered or unexported fields
}

func (FinancePaymentTermUpdateParams) MarshalJSON 

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

func (FinancePaymentTermUpdateParams) URLQuery 

func (r FinancePaymentTermUpdateParams) URLQuery() (v url.Values, err error)

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

func (*FinancePaymentTermUpdateParams) UnmarshalJSON 

func (r *FinancePaymentTermUpdateParams) UnmarshalJSON(data []byte) error

type FinanceService 

type FinanceService struct {

	// List and manage payment terms.
	PaymentTerms FinancePaymentTermService
	// contains filtered or unexported fields
}

Create, view, update, and delete transactions.

FinanceService contains methods and other services that help with interacting with the augno 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 NewFinanceService method instead.

func NewFinanceService 

func NewFinanceService(opts ...option.RequestOption) (r FinanceService)

NewFinanceService 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 (*FinanceService) GetAdjustmentTypes 

func (r *FinanceService) GetAdjustmentTypes(ctx context.Context, query FinanceGetAdjustmentTypesParams, opts ...option.RequestOption) (res *ListAdjustmentType, err error)

Returns a paginated list of adjustment types.

func (*FinanceService) GetTransactionMethods 

func (r *FinanceService) GetTransactionMethods(ctx context.Context, query FinanceGetTransactionMethodsParams, opts ...option.RequestOption) (res *ListTransactionMethod, err error)

Returns a paginated list of transaction methods.

func (*FinanceService) GetTransactionTypes 

func (r *FinanceService) GetTransactionTypes(ctx context.Context, query FinanceGetTransactionTypesParams, opts ...option.RequestOption) (res *ListTransactionType, err error)

Returns a paginated list of transaction types.

type Geolocation 

type Geolocation struct {
	// Geolocation ID.
	ID string `json:"id" api:"required"`
	// Two-letter country code.
	Country string `json:"country" api:"required"`
	// City or locality.
	Locality string `json:"locality" api:"required"`
	// Resource type identifier.
	//
	// Any of "geolocation".
	Object GeolocationObject `json:"object" api:"required"`
	// Postal or ZIP code.
	PostalCode string `json:"postal_code" api:"required"`
	// State or administrative area.
	State string `json:"state" api:"required"`
	// First line of the street address.
	StreetLine1 string `json:"street_line_1" api:"required"`
	// Second line of the street address.
	StreetLine2 string `json:"street_line_2" api:"required"`
	// JSON contains metadata for fields, check presence with [respjson.Field.Valid].
	JSON struct {
		ID          respjson.Field
		Country     respjson.Field
		Locality    respjson.Field
		Object      respjson.Field
		PostalCode  respjson.Field
		State       respjson.Field
		StreetLine1 respjson.Field
		StreetLine2 respjson.Field
		ExtraFields map[string]respjson.Field
		// contains filtered or unexported fields
	} `json:"-"`
}

Geolocation sub-resource.

func (Geolocation) RawJSON 

func (r Geolocation) RawJSON() string

Returns the unmodified JSON received from the API

func (*Geolocation) UnmarshalJSON 

func (r *Geolocation) UnmarshalJSON(data []byte) error

type GeolocationObject 

type GeolocationObject string

Resource type identifier. 

const (
	GeolocationObjectGeolocation GeolocationObject = "geolocation"
)

type IdentityAccountUserActionActivateResponse 

type IdentityAccountUserActionActivateResponse struct {
	// JSON contains metadata for fields, check presence with [respjson.Field.Valid].
	JSON struct {
		ExtraFields map[string]respjson.Field
		// contains filtered or unexported fields
	} `json:"-"`
}

func (IdentityAccountUserActionActivateResponse) RawJSON 

func (r IdentityAccountUserActionActivateResponse) RawJSON() string

Returns the unmodified JSON received from the API

func (*IdentityAccountUserActionActivateResponse) UnmarshalJSON 

func (r *IdentityAccountUserActionActivateResponse) UnmarshalJSON(data []byte) error

type IdentityAccountUserActionDisableResponse 

type IdentityAccountUserActionDisableResponse struct {
	// JSON contains metadata for fields, check presence with [respjson.Field.Valid].
	JSON struct {
		ExtraFields map[string]respjson.Field
		// contains filtered or unexported fields
	} `json:"-"`
}

func (IdentityAccountUserActionDisableResponse) RawJSON 

func (r IdentityAccountUserActionDisableResponse) RawJSON() string

Returns the unmodified JSON received from the API

func (*IdentityAccountUserActionDisableResponse) UnmarshalJSON 

func (r *IdentityAccountUserActionDisableResponse) UnmarshalJSON(data []byte) error

type IdentityAccountUserActionRemoveResponse 

type IdentityAccountUserActionRemoveResponse struct {
	// JSON contains metadata for fields, check presence with [respjson.Field.Valid].
	JSON struct {
		ExtraFields map[string]respjson.Field
		// contains filtered or unexported fields
	} `json:"-"`
}

func (IdentityAccountUserActionRemoveResponse) RawJSON 

func (r IdentityAccountUserActionRemoveResponse) RawJSON() string

Returns the unmodified JSON received from the API

func (*IdentityAccountUserActionRemoveResponse) UnmarshalJSON 

func (r *IdentityAccountUserActionRemoveResponse) UnmarshalJSON(data []byte) error

type IdentityAccountUserActionService 

type IdentityAccountUserActionService struct {
	// contains filtered or unexported fields
}

List and manage account users.

IdentityAccountUserActionService contains methods and other services that help with interacting with the augno 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 NewIdentityAccountUserActionService method instead.

func NewIdentityAccountUserActionService 

func NewIdentityAccountUserActionService(opts ...option.RequestOption) (r IdentityAccountUserActionService)

NewIdentityAccountUserActionService 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 (*IdentityAccountUserActionService) Activate 

func (r *IdentityAccountUserActionService) Activate(ctx context.Context, id string, opts ...option.RequestOption) (res *IdentityAccountUserActionActivateResponse, err error)

Activates a disabled or removed account user.

func (*IdentityAccountUserActionService) Disable 

func (r *IdentityAccountUserActionService) Disable(ctx context.Context, id string, opts ...option.RequestOption) (res *IdentityAccountUserActionDisableResponse, err error)

Disables an account user. Disabled users will not be able to access the target account.

func (*IdentityAccountUserActionService) Remove 

func (r *IdentityAccountUserActionService) Remove(ctx context.Context, id string, opts ...option.RequestOption) (res *IdentityAccountUserActionRemoveResponse, err error)

Removes a user from the target account.

type IdentityAccountUserGetParams 

type IdentityAccountUserGetParams struct {
	// Sub-objects to expand in the response. When omitted, sub-objects are returned as
	// `null`.
	//
	// Any of "user", "role", "department".
	Include []string `query:"include,omitzero" json:"-"`
	// contains filtered or unexported fields
}

func (IdentityAccountUserGetParams) URLQuery 

func (r IdentityAccountUserGetParams) URLQuery() (v url.Values, err error)

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

type IdentityAccountUserListParams 

type IdentityAccountUserListParams struct {
	// Cursor token used to retrieve the next or previous page of results.
	Cursor param.Opt[string] `query:"cursor,omitzero" json:"-"`
	// Maximum number of results per page (default: 100, max: 1000).
	Limit param.Opt[int64] `query:"limit,omitzero" json:"-"`
	// Search query used to filter results.
	Q param.Opt[string] `query:"q,omitzero" json:"-"`
	// Sub-objects to expand in the response. When omitted, sub-objects are returned as
	// `null`.
	//
	// Any of "user", "role", "department".
	Include []string `query:"include,omitzero" json:"-"`
	// Controls whether removed account users are included.
	//
	// Any of "excluded", "included".
	RemovedScope IdentityAccountUserListParamsRemovedScope `query:"removed_scope,omitzero" json:"-"`
	// Filter by role type code.
	//
	// Any of "admin", "user", "scanner", "sales_rep", "agent".
	RoleType IdentityAccountUserListParamsRoleType `query:"role_type,omitzero" json:"-"`
	// contains filtered or unexported fields
}

func (IdentityAccountUserListParams) URLQuery 

func (r IdentityAccountUserListParams) URLQuery() (v url.Values, err error)

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

type IdentityAccountUserListParamsRemovedScope 

type IdentityAccountUserListParamsRemovedScope string

Controls whether removed account users are included. 

const (
	IdentityAccountUserListParamsRemovedScopeExcluded IdentityAccountUserListParamsRemovedScope = "excluded"
	IdentityAccountUserListParamsRemovedScopeIncluded IdentityAccountUserListParamsRemovedScope = "included"
)

type IdentityAccountUserListParamsRoleType 

type IdentityAccountUserListParamsRoleType string

Filter by role type code. 

const (
	IdentityAccountUserListParamsRoleTypeAdmin    IdentityAccountUserListParamsRoleType = "admin"
	IdentityAccountUserListParamsRoleTypeUser     IdentityAccountUserListParamsRoleType = "user"
	IdentityAccountUserListParamsRoleTypeScanner  IdentityAccountUserListParamsRoleType = "scanner"
	IdentityAccountUserListParamsRoleTypeSalesRep IdentityAccountUserListParamsRoleType = "sales_rep"
	IdentityAccountUserListParamsRoleTypeAgent    IdentityAccountUserListParamsRoleType = "agent"
)

type IdentityAccountUserNewParams 

type IdentityAccountUserNewParams struct {
	// Sub-objects to expand in the response. When omitted, sub-objects are returned as
	// `null`.
	//
	// Any of "user", "role", "department".
	Include []string `query:"include,omitzero" json:"-"`
	// Request to create an account user.
	CreateAccountUserRequest CreateAccountUserRequestParam
	// contains filtered or unexported fields
}

func (IdentityAccountUserNewParams) MarshalJSON 

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

func (IdentityAccountUserNewParams) URLQuery 

func (r IdentityAccountUserNewParams) URLQuery() (v url.Values, err error)

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

func (*IdentityAccountUserNewParams) UnmarshalJSON 

func (r *IdentityAccountUserNewParams) UnmarshalJSON(data []byte) error

type IdentityAccountUserService 

type IdentityAccountUserService struct {

	// List and manage account users.
	Actions IdentityAccountUserActionService
	// contains filtered or unexported fields
}

List and manage account users.

IdentityAccountUserService contains methods and other services that help with interacting with the augno 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 NewIdentityAccountUserService method instead.

func NewIdentityAccountUserService 

func NewIdentityAccountUserService(opts ...option.RequestOption) (r IdentityAccountUserService)

NewIdentityAccountUserService 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 (*IdentityAccountUserService) Get 

func (r *IdentityAccountUserService) Get(ctx context.Context, id string, query IdentityAccountUserGetParams, opts ...option.RequestOption) (res *AccountUser, err error)

Returns an account user by ID.

func (*IdentityAccountUserService) List 

func (r *IdentityAccountUserService) List(ctx context.Context, query IdentityAccountUserListParams, opts ...option.RequestOption) (res *ListAccountUser, err error)

Returns a paginated list of account users for the current account.

func (*IdentityAccountUserService) New 

func (r *IdentityAccountUserService) New(ctx context.Context, params IdentityAccountUserNewParams, opts ...option.RequestOption) (res *AccountUser, err error)

Creates a new account user and invites them to the target account.

func (*IdentityAccountUserService) Update 

func (r *IdentityAccountUserService) Update(ctx context.Context, id string, params IdentityAccountUserUpdateParams, opts ...option.RequestOption) (res *AccountUser, err error)

Partially updates an account user.

type IdentityAccountUserUpdateParams 

type IdentityAccountUserUpdateParams struct {
	// Sub-objects to expand in the response. When omitted, sub-objects are returned as
	// `null`.
	//
	// Any of "user", "role", "department".
	Include []string `query:"include,omitzero" json:"-"`
	// Request to partially update an account user.
	UpdateAccountUserRequest UpdateAccountUserRequestParam
	// contains filtered or unexported fields
}

func (IdentityAccountUserUpdateParams) MarshalJSON 

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

func (IdentityAccountUserUpdateParams) URLQuery 

func (r IdentityAccountUserUpdateParams) URLQuery() (v url.Values, err error)

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

func (*IdentityAccountUserUpdateParams) UnmarshalJSON 

func (r *IdentityAccountUserUpdateParams) UnmarshalJSON(data []byte) error

type IdentityRoleDeleteResponse 

type IdentityRoleDeleteResponse struct {
	// JSON contains metadata for fields, check presence with [respjson.Field.Valid].
	JSON struct {
		ExtraFields map[string]respjson.Field
		// contains filtered or unexported fields
	} `json:"-"`
}

func (IdentityRoleDeleteResponse) RawJSON 

func (r IdentityRoleDeleteResponse) RawJSON() string

Returns the unmodified JSON received from the API

func (*IdentityRoleDeleteResponse) UnmarshalJSON 

func (r *IdentityRoleDeleteResponse) UnmarshalJSON(data []byte) error

type IdentityRoleGetParams 

type IdentityRoleGetParams struct {
	// Sub-objects to expand in the response. When omitted, sub-objects are returned as
	// `null`.
	//
	// Any of "owner", "owner.account", "permissions".
	Include []string `query:"include,omitzero" json:"-"`
	// contains filtered or unexported fields
}

func (IdentityRoleGetParams) URLQuery 

func (r IdentityRoleGetParams) URLQuery() (v url.Values, err error)

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

type IdentityRoleListParams 

type IdentityRoleListParams struct {
	// Cursor token used to retrieve the next or previous page of results.
	Cursor param.Opt[string] `query:"cursor,omitzero" json:"-"`
	// Maximum number of results per page (default: 100, max: 1000).
	Limit param.Opt[int64] `query:"limit,omitzero" json:"-"`
	// Search query used to filter results.
	Q param.Opt[string] `query:"q,omitzero" json:"-"`
	// Sub-objects to expand in the response. When omitted, sub-objects are returned as
	// `null`.
	//
	// Any of "owner", "owner.account", "permissions".
	Include []string `query:"include,omitzero" json:"-"`
	// Filter by role types.
	//
	// Any of "admin", "user", "scanner", "sales_rep", "agent".
	Types []string `query:"types,omitzero" json:"-"`
	// contains filtered or unexported fields
}

func (IdentityRoleListParams) URLQuery 

func (r IdentityRoleListParams) URLQuery() (v url.Values, err error)

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

type IdentityRoleNewParams 

type IdentityRoleNewParams struct {
	// CreateRoleRequest is a request to create a role.
	CreateRoleRequest CreateRoleRequestParam
	// Sub-objects to expand in the response. When omitted, sub-objects are returned as
	// `null`.
	//
	// Any of "owner", "owner.account", "permissions".
	Include []string `query:"include,omitzero" json:"-"`
	// contains filtered or unexported fields
}

func (IdentityRoleNewParams) MarshalJSON 

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

func (IdentityRoleNewParams) URLQuery 

func (r IdentityRoleNewParams) URLQuery() (v url.Values, err error)

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

func (*IdentityRoleNewParams) UnmarshalJSON 

func (r *IdentityRoleNewParams) UnmarshalJSON(data []byte) error

type IdentityRoleService 

type IdentityRoleService struct {
	// contains filtered or unexported fields
}

List and manage roles.

IdentityRoleService contains methods and other services that help with interacting with the augno 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 NewIdentityRoleService method instead.

func NewIdentityRoleService 

func NewIdentityRoleService(opts ...option.RequestOption) (r IdentityRoleService)

NewIdentityRoleService 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 (*IdentityRoleService) Delete 

func (r *IdentityRoleService) Delete(ctx context.Context, id string, opts ...option.RequestOption) (res *IdentityRoleDeleteResponse, err error)

Deletes a role and its associated permissions. Global roles cannot be deleted.

func (*IdentityRoleService) Get 

func (r *IdentityRoleService) Get(ctx context.Context, id string, query IdentityRoleGetParams, opts ...option.RequestOption) (res *Role, err error)

Returns a role by ID, including its structured permissions.

func (*IdentityRoleService) List 

func (r *IdentityRoleService) List(ctx context.Context, query IdentityRoleListParams, opts ...option.RequestOption) (res *ListRole, err error)

Returns a paginated list of roles for the target account, including global roles.

func (*IdentityRoleService) New 

func (r *IdentityRoleService) New(ctx context.Context, params IdentityRoleNewParams, opts ...option.RequestOption) (res *Role, err error)

Creates a new role with the specified permissions.

func (*IdentityRoleService) Update 

func (r *IdentityRoleService) Update(ctx context.Context, id string, params IdentityRoleUpdateParams, opts ...option.RequestOption) (res *Role, err error)

Partially updates a custom role's name or permissions. Provided permissions replace all existing ones; global roles cannot be modified.

type IdentityRoleUpdateParams 

type IdentityRoleUpdateParams struct {
	// Sub-objects to expand in the response. When omitted, sub-objects are returned as
	// `null`.
	//
	// Any of "owner", "owner.account", "permissions".
	Include []string `query:"include,omitzero" json:"-"`
	// UpdateRoleRequest is a request to update a role.
	UpdateRoleRequest UpdateRoleRequestParam
	// contains filtered or unexported fields
}

func (IdentityRoleUpdateParams) MarshalJSON 

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

func (IdentityRoleUpdateParams) URLQuery 

func (r IdentityRoleUpdateParams) URLQuery() (v url.Values, err error)

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

func (*IdentityRoleUpdateParams) UnmarshalJSON 

func (r *IdentityRoleUpdateParams) UnmarshalJSON(data []byte) error

type IdentityService 

type IdentityService struct {

	// List and manage account users.
	AccountUsers IdentityAccountUserService
	// List and manage roles.
	Roles IdentityRoleService
	// contains filtered or unexported fields
}

IdentityService contains methods and other services that help with interacting with the augno 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 NewIdentityService method instead.

func NewIdentityService 

func NewIdentityService(opts ...option.RequestOption) (r IdentityService)

NewIdentityService 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.

type Item 

type Item struct {
	// Item ID.
	ID string `json:"id" api:"required"`
	// List represents a paginated list of resources.
	Attributes ListAttribute `json:"attributes" api:"required"`
	// Rate resource.
	BurnRate Rate `json:"burn_rate" api:"required"`
	// ItemCategory resource.
	Category ItemCategory `json:"category" api:"required"`
	// Creation timestamp.
	CreatedAt time.Time `json:"created_at" api:"required" format:"date-time"`
	// Item description.
	Description string `json:"description" api:"required"`
	// Notes.
	Notes string `json:"notes" api:"required"`
	// Resource type identifier.
	//
	// Any of "item".
	Object ItemObject `json:"object" api:"required"`
	// Stock keeping unit code.
	SKU string `json:"sku" api:"required"`
	// Item type code.
	//
	// Any of "product", "material", "part".
	Type ItemType `json:"type" api:"required"`
	// Rate resource.
	UnitCost Rate `json:"unit_cost" api:"required"`
	// Rate resource.
	UnitValue Rate `json:"unit_value" api:"required"`
	// Last updated timestamp.
	UpdatedAt time.Time `json:"updated_at" api:"required" format:"date-time"`
	// JSON contains metadata for fields, check presence with [respjson.Field.Valid].
	JSON struct {
		ID          respjson.Field
		Attributes  respjson.Field
		BurnRate    respjson.Field
		Category    respjson.Field
		CreatedAt   respjson.Field
		Description respjson.Field
		Notes       respjson.Field
		Object      respjson.Field
		SKU         respjson.Field
		Type        respjson.Field
		UnitCost    respjson.Field
		UnitValue   respjson.Field
		UpdatedAt   respjson.Field
		ExtraFields map[string]respjson.Field
		// contains filtered or unexported fields
	} `json:"-"`
}

Item is an inventory item (product, material, or part).

func (Item) RawJSON 

func (r Item) RawJSON() string

Returns the unmodified JSON received from the API

func (*Item) UnmarshalJSON 

func (r *Item) UnmarshalJSON(data []byte) error

type ItemCategory 

type ItemCategory struct {
	// Item category ID.
	ID string `json:"id" api:"required"`
	// Creation timestamp.
	CreatedAt time.Time `json:"created_at" api:"required" format:"date-time"`
	// Display name.
	Name string `json:"name" api:"required"`
	// Notes.
	Notes string `json:"notes" api:"required"`
	// Resource type identifier.
	//
	// Any of "item_category".
	Object ItemCategoryObject `json:"object" api:"required"`
	// Owner describes the provenance of a resource.
	Owner Owner `json:"owner" api:"required"`
	// List represents a paginated list of resources.
	Properties ListProperty `json:"properties" api:"required"`
	// Item category type.
	//
	// Any of "material_category", "product_category".
	Type ItemCategoryType `json:"type" api:"required"`
	// UnitGroup is a unit group resource.
	UnitGroup UnitGroup `json:"unit_group" api:"required"`
	// Last updated timestamp.
	UpdatedAt time.Time `json:"updated_at" api:"required" format:"date-time"`
	// JSON contains metadata for fields, check presence with [respjson.Field.Valid].
	JSON struct {
		ID          respjson.Field
		CreatedAt   respjson.Field
		Name        respjson.Field
		Notes       respjson.Field
		Object      respjson.Field
		Owner       respjson.Field
		Properties  respjson.Field
		Type        respjson.Field
		UnitGroup   respjson.Field
		UpdatedAt   respjson.Field
		ExtraFields map[string]respjson.Field
		// contains filtered or unexported fields
	} `json:"-"`
}

ItemCategory resource.

func (ItemCategory) RawJSON 

func (r ItemCategory) RawJSON() string

Returns the unmodified JSON received from the API

func (*ItemCategory) UnmarshalJSON 

func (r *ItemCategory) UnmarshalJSON(data []byte) error

type ItemCategoryObject 

type ItemCategoryObject string

Resource type identifier. 

const (
	ItemCategoryObjectItemCategory ItemCategoryObject = "item_category"
)

type ItemCategoryType 

type ItemCategoryType string

Item category type. 

const (
	ItemCategoryTypeMaterialCategory ItemCategoryType = "material_category"
	ItemCategoryTypeProductCategory  ItemCategoryType = "product_category"
)

type ItemInventory 

type ItemInventory struct {
	// Value with an associated unit.
	AvailableToPromise Quantity `json:"available_to_promise" api:"required"`
	// Resource type identifier.
	//
	// Any of "item_inventory".
	Object ItemInventoryObject `json:"object" api:"required"`
	// Value with an associated unit.
	OnHand Quantity `json:"on_hand" api:"required"`
	// Value with an associated unit.
	Reserved Quantity `json:"reserved" api:"required"`
	// Value with an associated unit.
	Short Quantity `json:"short" api:"required"`
	// JSON contains metadata for fields, check presence with [respjson.Field.Valid].
	JSON struct {
		AvailableToPromise respjson.Field
		Object             respjson.Field
		OnHand             respjson.Field
		Reserved           respjson.Field
		Short              respjson.Field
		ExtraFields        map[string]respjson.Field
		// contains filtered or unexported fields
	} `json:"-"`
}

ItemInventory contains inventory quantities for an item.

func (ItemInventory) RawJSON 

func (r ItemInventory) RawJSON() string

Returns the unmodified JSON received from the API

func (*ItemInventory) UnmarshalJSON 

func (r *ItemInventory) UnmarshalJSON(data []byte) error

type ItemInventoryObject 

type ItemInventoryObject string

Resource type identifier. 

const (
	ItemInventoryObjectItemInventory ItemInventoryObject = "item_inventory"
)

type ItemObject 

type ItemObject string

Resource type identifier. 

const (
	ItemObjectItem ItemObject = "item"
)

type ItemType 

type ItemType string

Item type code. 

const (
	ItemTypeProduct  ItemType = "product"
	ItemTypeMaterial ItemType = "material"
	ItemTypePart     ItemType = "part"
)

type ListAPIKey 

type ListAPIKey struct {
	// Resources in this page.
	Data []APIKey `json:"data" api:"required"`
	// Resource type identifier.
	//
	// Any of "list".
	Object ListAPIKeyObject `json:"object" api:"required"`
	// PageInfo contains URL-based pagination metadata.
	PageInfo PageInfo `json:"page_info" api:"required"`
	// JSON contains metadata for fields, check presence with [respjson.Field.Valid].
	JSON struct {
		Data        respjson.Field
		Object      respjson.Field
		PageInfo    respjson.Field
		ExtraFields map[string]respjson.Field
		// contains filtered or unexported fields
	} `json:"-"`
}

List represents a paginated list of resources.

func (ListAPIKey) RawJSON 

func (r ListAPIKey) RawJSON() string

Returns the unmodified JSON received from the API

func (*ListAPIKey) UnmarshalJSON 

func (r *ListAPIKey) UnmarshalJSON(data []byte) error

type ListAPIKeyObject 

type ListAPIKeyObject string

Resource type identifier. 

const (
	ListAPIKeyObjectList ListAPIKeyObject = "list"
)

type ListAccountGroup 

type ListAccountGroup struct {
	// Resources in this page.
	Data []AccountGroup `json:"data" api:"required"`
	// Resource type identifier.
	//
	// Any of "list".
	Object ListAccountGroupObject `json:"object" api:"required"`
	// PageInfo contains URL-based pagination metadata.
	PageInfo PageInfo `json:"page_info" api:"required"`
	// JSON contains metadata for fields, check presence with [respjson.Field.Valid].
	JSON struct {
		Data        respjson.Field
		Object      respjson.Field
		PageInfo    respjson.Field
		ExtraFields map[string]respjson.Field
		// contains filtered or unexported fields
	} `json:"-"`
}

List represents a paginated list of resources.

func (ListAccountGroup) RawJSON 

func (r ListAccountGroup) RawJSON() string

Returns the unmodified JSON received from the API

func (*ListAccountGroup) UnmarshalJSON 

func (r *ListAccountGroup) UnmarshalJSON(data []byte) error

type ListAccountGroupObject 

type ListAccountGroupObject string

Resource type identifier. 

const (
	ListAccountGroupObjectList ListAccountGroupObject = "list"
)

type ListAccountStatus 

type ListAccountStatus struct {
	// Resources in this page.
	Data []AccountStatus `json:"data" api:"required"`
	// Resource type identifier.
	//
	// Any of "list".
	Object ListAccountStatusObject `json:"object" api:"required"`
	// PageInfo contains URL-based pagination metadata.
	PageInfo PageInfo `json:"page_info" api:"required"`
	// JSON contains metadata for fields, check presence with [respjson.Field.Valid].
	JSON struct {
		Data        respjson.Field
		Object      respjson.Field
		PageInfo    respjson.Field
		ExtraFields map[string]respjson.Field
		// contains filtered or unexported fields
	} `json:"-"`
}

List represents a paginated list of resources.

func (ListAccountStatus) RawJSON 

func (r ListAccountStatus) RawJSON() string

Returns the unmodified JSON received from the API

func (*ListAccountStatus) UnmarshalJSON 

func (r *ListAccountStatus) UnmarshalJSON(data []byte) error

type ListAccountStatusObject 

type ListAccountStatusObject string

Resource type identifier. 

const (
	ListAccountStatusObjectList ListAccountStatusObject = "list"
)

type ListAccountUser 

type ListAccountUser struct {
	// Resources in this page.
	Data []AccountUser `json:"data" api:"required"`
	// Resource type identifier.
	//
	// Any of "list".
	Object ListAccountUserObject `json:"object" api:"required"`
	// PageInfo contains URL-based pagination metadata.
	PageInfo PageInfo `json:"page_info" api:"required"`
	// JSON contains metadata for fields, check presence with [respjson.Field.Valid].
	JSON struct {
		Data        respjson.Field
		Object      respjson.Field
		PageInfo    respjson.Field
		ExtraFields map[string]respjson.Field
		// contains filtered or unexported fields
	} `json:"-"`
}

List represents a paginated list of resources.

func (ListAccountUser) RawJSON 

func (r ListAccountUser) RawJSON() string

Returns the unmodified JSON received from the API

func (*ListAccountUser) UnmarshalJSON 

func (r *ListAccountUser) UnmarshalJSON(data []byte) error

type ListAccountUserObject 

type ListAccountUserObject string

Resource type identifier. 

const (
	ListAccountUserObjectList ListAccountUserObject = "list"
)

type ListAddress 

type ListAddress struct {
	// Resources in this page.
	Data []Address `json:"data" api:"required"`
	// Resource type identifier.
	//
	// Any of "list".
	Object ListAddressObject `json:"object" api:"required"`
	// PageInfo contains URL-based pagination metadata.
	PageInfo PageInfo `json:"page_info" api:"required"`
	// JSON contains metadata for fields, check presence with [respjson.Field.Valid].
	JSON struct {
		Data        respjson.Field
		Object      respjson.Field
		PageInfo    respjson.Field
		ExtraFields map[string]respjson.Field
		// contains filtered or unexported fields
	} `json:"-"`
}

List represents a paginated list of resources.

func (ListAddress) RawJSON 

func (r ListAddress) RawJSON() string

Returns the unmodified JSON received from the API

func (*ListAddress) UnmarshalJSON 

func (r *ListAddress) UnmarshalJSON(data []byte) error

type ListAddressObject 

type ListAddressObject string

Resource type identifier. 

const (
	ListAddressObjectList ListAddressObject = "list"
)

type ListAddressSuggestion 

type ListAddressSuggestion struct {
	// Resources in this page.
	Data []AddressSuggestion `json:"data" api:"required"`
	// Resource type identifier.
	//
	// Any of "list".
	Object ListAddressSuggestionObject `json:"object" api:"required"`
	// PageInfo contains URL-based pagination metadata.
	PageInfo PageInfo `json:"page_info" api:"required"`
	// JSON contains metadata for fields, check presence with [respjson.Field.Valid].
	JSON struct {
		Data        respjson.Field
		Object      respjson.Field
		PageInfo    respjson.Field
		ExtraFields map[string]respjson.Field
		// contains filtered or unexported fields
	} `json:"-"`
}

List represents a paginated list of resources.

func (ListAddressSuggestion) RawJSON 

func (r ListAddressSuggestion) RawJSON() string

Returns the unmodified JSON received from the API

func (*ListAddressSuggestion) UnmarshalJSON 

func (r *ListAddressSuggestion) UnmarshalJSON(data []byte) error

type ListAddressSuggestionObject 

type ListAddressSuggestionObject string

Resource type identifier. 

const (
	ListAddressSuggestionObjectList ListAddressSuggestionObject = "list"
)

type ListAdjustmentType 

type ListAdjustmentType struct {
	// Resources in this page.
	Data []AdjustmentType `json:"data" api:"required"`
	// Resource type identifier.
	//
	// Any of "list".
	Object ListAdjustmentTypeObject `json:"object" api:"required"`
	// PageInfo contains URL-based pagination metadata.
	PageInfo PageInfo `json:"page_info" api:"required"`
	// JSON contains metadata for fields, check presence with [respjson.Field.Valid].
	JSON struct {
		Data        respjson.Field
		Object      respjson.Field
		PageInfo    respjson.Field
		ExtraFields map[string]respjson.Field
		// contains filtered or unexported fields
	} `json:"-"`
}

List represents a paginated list of resources.

func (ListAdjustmentType) RawJSON 

func (r ListAdjustmentType) RawJSON() string

Returns the unmodified JSON received from the API

func (*ListAdjustmentType) UnmarshalJSON 

func (r *ListAdjustmentType) UnmarshalJSON(data []byte) error

type ListAdjustmentTypeObject 

type ListAdjustmentTypeObject string

Resource type identifier. 

const (
	ListAdjustmentTypeObjectList ListAdjustmentTypeObject = "list"
)

type ListAttribute 

type ListAttribute struct {
	// Resources in this page.
	Data []Attribute `json:"data" api:"required"`
	// Resource type identifier.
	//
	// Any of "list".
	Object ListAttributeObject `json:"object" api:"required"`
	// PageInfo contains URL-based pagination metadata.
	PageInfo PageInfo `json:"page_info" api:"required"`
	// JSON contains metadata for fields, check presence with [respjson.Field.Valid].
	JSON struct {
		Data        respjson.Field
		Object      respjson.Field
		PageInfo    respjson.Field
		ExtraFields map[string]respjson.Field
		// contains filtered or unexported fields
	} `json:"-"`
}

List represents a paginated list of resources.

func (ListAttribute) RawJSON 

func (r ListAttribute) RawJSON() string

Returns the unmodified JSON received from the API

func (*ListAttribute) UnmarshalJSON 

func (r *ListAttribute) UnmarshalJSON(data []byte) error

type ListAttributeObject 

type ListAttributeObject string

Resource type identifier. 

const (
	ListAttributeObjectList ListAttributeObject = "list"
)

type ListAuditEvent 

type ListAuditEvent struct {
	// Resources in this page.
	Data []AuditEvent `json:"data" api:"required"`
	// Resource type identifier.
	//
	// Any of "list".
	Object ListAuditEventObject `json:"object" api:"required"`
	// PageInfo contains URL-based pagination metadata.
	PageInfo PageInfo `json:"page_info" api:"required"`
	// JSON contains metadata for fields, check presence with [respjson.Field.Valid].
	JSON struct {
		Data        respjson.Field
		Object      respjson.Field
		PageInfo    respjson.Field
		ExtraFields map[string]respjson.Field
		// contains filtered or unexported fields
	} `json:"-"`
}

List represents a paginated list of resources.

func (ListAuditEvent) RawJSON 

func (r ListAuditEvent) RawJSON() string

Returns the unmodified JSON received from the API

func (*ListAuditEvent) UnmarshalJSON 

func (r *ListAuditEvent) UnmarshalJSON(data []byte) error

type ListAuditEventObject 

type ListAuditEventObject string

Resource type identifier. 

const (
	ListAuditEventObjectList ListAuditEventObject = "list"
)

type ListAuditFieldChange 

type ListAuditFieldChange struct {
	// Resources in this page.
	Data []AuditFieldChange `json:"data" api:"required"`
	// Resource type identifier.
	//
	// Any of "list".
	Object ListAuditFieldChangeObject `json:"object" api:"required"`
	// PageInfo contains URL-based pagination metadata.
	PageInfo PageInfo `json:"page_info" api:"required"`
	// JSON contains metadata for fields, check presence with [respjson.Field.Valid].
	JSON struct {
		Data        respjson.Field
		Object      respjson.Field
		PageInfo    respjson.Field
		ExtraFields map[string]respjson.Field
		// contains filtered or unexported fields
	} `json:"-"`
}

List represents a paginated list of resources.

func (ListAuditFieldChange) RawJSON 

func (r ListAuditFieldChange) RawJSON() string

Returns the unmodified JSON received from the API

func (*ListAuditFieldChange) UnmarshalJSON 

func (r *ListAuditFieldChange) UnmarshalJSON(data []byte) error

type ListAuditFieldChangeObject 

type ListAuditFieldChangeObject string

Resource type identifier. 

const (
	ListAuditFieldChangeObjectList ListAuditFieldChangeObject = "list"
)

type ListCarrier 

type ListCarrier struct {
	// Resources in this page.
	Data []Carrier `json:"data" api:"required"`
	// Resource type identifier.
	//
	// Any of "list".
	Object ListCarrierObject `json:"object" api:"required"`
	// PageInfo contains URL-based pagination metadata.
	PageInfo PageInfo `json:"page_info" api:"required"`
	// JSON contains metadata for fields, check presence with [respjson.Field.Valid].
	JSON struct {
		Data        respjson.Field
		Object      respjson.Field
		PageInfo    respjson.Field
		ExtraFields map[string]respjson.Field
		// contains filtered or unexported fields
	} `json:"-"`
}

List represents a paginated list of resources.

func (ListCarrier) RawJSON 

func (r ListCarrier) RawJSON() string

Returns the unmodified JSON received from the API

func (*ListCarrier) UnmarshalJSON 

func (r *ListCarrier) UnmarshalJSON(data []byte) error

type ListCarrierObject 

type ListCarrierObject string

Resource type identifier. 

const (
	ListCarrierObjectList ListCarrierObject = "list"
)

type ListConsumption 

type ListConsumption struct {
	// Resources in this page.
	Data []Consumption `json:"data" api:"required"`
	// Resource type identifier.
	//
	// Any of "list".
	Object ListConsumptionObject `json:"object" api:"required"`
	// PageInfo contains URL-based pagination metadata.
	PageInfo PageInfo `json:"page_info" api:"required"`
	// JSON contains metadata for fields, check presence with [respjson.Field.Valid].
	JSON struct {
		Data        respjson.Field
		Object      respjson.Field
		PageInfo    respjson.Field
		ExtraFields map[string]respjson.Field
		// contains filtered or unexported fields
	} `json:"-"`
}

List represents a paginated list of resources.

func (ListConsumption) RawJSON 

func (r ListConsumption) RawJSON() string

Returns the unmodified JSON received from the API

func (*ListConsumption) UnmarshalJSON 

func (r *ListConsumption) UnmarshalJSON(data []byte) error

type ListConsumptionObject 

type ListConsumptionObject string

Resource type identifier. 

const (
	ListConsumptionObjectList ListConsumptionObject = "list"
)

type ListCustomer 

type ListCustomer struct {
	// Resources in this page.
	Data []Customer `json:"data" api:"required"`
	// Resource type identifier.
	//
	// Any of "list".
	Object ListCustomerObject `json:"object" api:"required"`
	// PageInfo contains URL-based pagination metadata.
	PageInfo PageInfo `json:"page_info" api:"required"`
	// JSON contains metadata for fields, check presence with [respjson.Field.Valid].
	JSON struct {
		Data        respjson.Field
		Object      respjson.Field
		PageInfo    respjson.Field
		ExtraFields map[string]respjson.Field
		// contains filtered or unexported fields
	} `json:"-"`
}

List represents a paginated list of resources.

func (ListCustomer) RawJSON 

func (r ListCustomer) RawJSON() string

Returns the unmodified JSON received from the API

func (*ListCustomer) UnmarshalJSON 

func (r *ListCustomer) UnmarshalJSON(data []byte) error

type ListCustomerObject 

type ListCustomerObject string

Resource type identifier. 

const (
	ListCustomerObjectList ListCustomerObject = "list"
)

type ListEmailLog 

type ListEmailLog struct {
	// Resources in this page.
	Data []EmailLog `json:"data" api:"required"`
	// Resource type identifier.
	//
	// Any of "list".
	Object ListEmailLogObject `json:"object" api:"required"`
	// PageInfo contains URL-based pagination metadata.
	PageInfo PageInfo `json:"page_info" api:"required"`
	// JSON contains metadata for fields, check presence with [respjson.Field.Valid].
	JSON struct {
		Data        respjson.Field
		Object      respjson.Field
		PageInfo    respjson.Field
		ExtraFields map[string]respjson.Field
		// contains filtered or unexported fields
	} `json:"-"`
}

List represents a paginated list of resources.

func (ListEmailLog) RawJSON 

func (r ListEmailLog) RawJSON() string

Returns the unmodified JSON received from the API

func (*ListEmailLog) UnmarshalJSON 

func (r *ListEmailLog) UnmarshalJSON(data []byte) error

type ListEmailLogObject 

type ListEmailLogObject string

Resource type identifier. 

const (
	ListEmailLogObjectList ListEmailLogObject = "list"
)

type ListItem 

type ListItem struct {
	// Resources in this page.
	Data []Item `json:"data" api:"required"`
	// Resource type identifier.
	//
	// Any of "list".
	Object ListItemObject `json:"object" api:"required"`
	// PageInfo contains URL-based pagination metadata.
	PageInfo PageInfo `json:"page_info" api:"required"`
	// JSON contains metadata for fields, check presence with [respjson.Field.Valid].
	JSON struct {
		Data        respjson.Field
		Object      respjson.Field
		PageInfo    respjson.Field
		ExtraFields map[string]respjson.Field
		// contains filtered or unexported fields
	} `json:"-"`
}

List represents a paginated list of resources.

func (ListItem) RawJSON 

func (r ListItem) RawJSON() string

Returns the unmodified JSON received from the API

func (*ListItem) UnmarshalJSON 

func (r *ListItem) UnmarshalJSON(data []byte) error

type ListItemCategory 

type ListItemCategory struct {
	// Resources in this page.
	Data []ItemCategory `json:"data" api:"required"`
	// Resource type identifier.
	//
	// Any of "list".
	Object ListItemCategoryObject `json:"object" api:"required"`
	// PageInfo contains URL-based pagination metadata.
	PageInfo PageInfo `json:"page_info" api:"required"`
	// JSON contains metadata for fields, check presence with [respjson.Field.Valid].
	JSON struct {
		Data        respjson.Field
		Object      respjson.Field
		PageInfo    respjson.Field
		ExtraFields map[string]respjson.Field
		// contains filtered or unexported fields
	} `json:"-"`
}

List represents a paginated list of resources.

func (ListItemCategory) RawJSON 

func (r ListItemCategory) RawJSON() string

Returns the unmodified JSON received from the API

func (*ListItemCategory) UnmarshalJSON 

func (r *ListItemCategory) UnmarshalJSON(data []byte) error

type ListItemCategoryObject 

type ListItemCategoryObject string

Resource type identifier. 

const (
	ListItemCategoryObjectList ListItemCategoryObject = "list"
)

type ListItemObject 

type ListItemObject string

Resource type identifier. 

const (
	ListItemObjectList ListItemObject = "list"
)

type ListLocation 

type ListLocation struct {
	// Resources in this page.
	Data []Location `json:"data" api:"required"`
	// Resource type identifier.
	//
	// Any of "list".
	Object ListLocationObject `json:"object" api:"required"`
	// PageInfo contains URL-based pagination metadata.
	PageInfo PageInfo `json:"page_info" api:"required"`
	// JSON contains metadata for fields, check presence with [respjson.Field.Valid].
	JSON struct {
		Data        respjson.Field
		Object      respjson.Field
		PageInfo    respjson.Field
		ExtraFields map[string]respjson.Field
		// contains filtered or unexported fields
	} `json:"-"`
}

List represents a paginated list of resources.

func (ListLocation) RawJSON 

func (r ListLocation) RawJSON() string

Returns the unmodified JSON received from the API

func (*ListLocation) UnmarshalJSON 

func (r *ListLocation) UnmarshalJSON(data []byte) error

type ListLocationObject 

type ListLocationObject string

Resource type identifier. 

const (
	ListLocationObjectList ListLocationObject = "list"
)

type ListLocationType 

type ListLocationType struct {
	// Resources in this page.
	Data []LocationType `json:"data" api:"required"`
	// Resource type identifier.
	//
	// Any of "list".
	Object ListLocationTypeObject `json:"object" api:"required"`
	// PageInfo contains URL-based pagination metadata.
	PageInfo PageInfo `json:"page_info" api:"required"`
	// JSON contains metadata for fields, check presence with [respjson.Field.Valid].
	JSON struct {
		Data        respjson.Field
		Object      respjson.Field
		PageInfo    respjson.Field
		ExtraFields map[string]respjson.Field
		// contains filtered or unexported fields
	} `json:"-"`
}

List represents a paginated list of resources.

func (ListLocationType) RawJSON 

func (r ListLocationType) RawJSON() string

Returns the unmodified JSON received from the API

func (*ListLocationType) UnmarshalJSON 

func (r *ListLocationType) UnmarshalJSON(data []byte) error

type ListLocationTypeObject 

type ListLocationTypeObject string

Resource type identifier. 

const (
	ListLocationTypeObjectList ListLocationTypeObject = "list"
)

type ListMachine 

type ListMachine struct {
	// Resources in this page.
	Data []Machine `json:"data" api:"required"`
	// Resource type identifier.
	//
	// Any of "list".
	Object ListMachineObject `json:"object" api:"required"`
	// PageInfo contains URL-based pagination metadata.
	PageInfo PageInfo `json:"page_info" api:"required"`
	// JSON contains metadata for fields, check presence with [respjson.Field.Valid].
	JSON struct {
		Data        respjson.Field
		Object      respjson.Field
		PageInfo    respjson.Field
		ExtraFields map[string]respjson.Field
		// contains filtered or unexported fields
	} `json:"-"`
}

List represents a paginated list of resources.

func (ListMachine) RawJSON 

func (r ListMachine) RawJSON() string

Returns the unmodified JSON received from the API

func (*ListMachine) UnmarshalJSON 

func (r *ListMachine) UnmarshalJSON(data []byte) error

type ListMachineObject 

type ListMachineObject string

Resource type identifier. 

const (
	ListMachineObjectList ListMachineObject = "list"
)

type ListMaterial 

type ListMaterial struct {
	// Resources in this page.
	Data []Material `json:"data" api:"required"`
	// Resource type identifier.
	//
	// Any of "list".
	Object ListMaterialObject `json:"object" api:"required"`
	// PageInfo contains URL-based pagination metadata.
	PageInfo PageInfo `json:"page_info" api:"required"`
	// JSON contains metadata for fields, check presence with [respjson.Field.Valid].
	JSON struct {
		Data        respjson.Field
		Object      respjson.Field
		PageInfo    respjson.Field
		ExtraFields map[string]respjson.Field
		// contains filtered or unexported fields
	} `json:"-"`
}

List represents a paginated list of resources.

func (ListMaterial) RawJSON 

func (r ListMaterial) RawJSON() string

Returns the unmodified JSON received from the API

func (*ListMaterial) UnmarshalJSON 

func (r *ListMaterial) UnmarshalJSON(data []byte) error

type ListMaterialObject 

type ListMaterialObject string

Resource type identifier. 

const (
	ListMaterialObjectList ListMaterialObject = "list"
)

type ListObjectType 

type ListObjectType struct {
	// Resources in this page.
	//
	// Any of "account", "actor", "entity", "record", "freight", "sales_order_totals",
	// "sales_order_related", "user", "address", "api_key", "created_api_key",
	// "refresh_token", "list", "sandbox", "registration_session", "pricing_plan",
	// "account_plan", "plan_change", "enterprise_inquiry", "request_log",
	// "audit_event", "audit_field_change", "role", "unit", "account_affiliation",
	// "agent_definition", "available_tool", "agent_definition_tool",
	// "agent_account_status", "agent_run", "agent_action", "agent_run_step",
	// "agent_token_usage", "agent_memory", "agent_alert", "tool_group",
	// "payment_term", "shipping_term", "quantity", "account_group", "account_status",
	// "geolocation", "account_user", "department", "account_integration",
	// "account_price", "product_line", "item_category", "attribute", "rate",
	// "account_group_product_line_access", "sales_target", "adjustment_type",
	// "account_branding", "account_portal", "account_logo_url", "public_account",
	// "property", "carrier", "service_level", "item", "item_inventory", "product",
	// "batch", "batch_flow_node", "scanning_consumption", "open_batch_summary",
	// "scanning_production_step_info", "scanning_station", "production_step",
	// "production_run", "machine", "child_account", "unit_group", "unit_group_unit",
	// "consumption", "customer_product_line_access", "customer",
	// "frequently_ordered_product", "priority", "delivery", "delivery_line",
	// "sales_order", "location", "location_type", "lot", "email_log",
	// "inventory_change_log", "invoice", "invoice_summary", "invoice_line",
	// "invoice_allocation", "invoice_for_payment", "shipment", "shipment_summary",
	// "shipment_line", "shipping_case", "shipping_case_label_url", "settlement",
	// "settlement_summary", "role_permission", "registration_flow",
	// "registration_flow_option", "transaction", "transaction_summary",
	// "transaction_method", "transaction_type", "transaction_allocation",
	// "usage_item", "agent_token_detail", "account_usage_response",
	// "subscription_info", "billing_portal_session_response", "switch_plan_response",
	// "ensure_billing_customer_response", "spending_cap_response", "agent_spend_info",
	// "webhook_response", "address_suggestion", "address_components",
	// "address_details_result", "validated_address", "plan_limit",
	// "plan_change_proration", "plan_change_line_item", "setup_billing_response",
	// "confirm_payment_response", "oauth_response", "oauth_status_response",
	// "stripe_publishable_key", "stripe_status", "healthcheck",
	// "agent_definition_config", "trigger_config", "customer_contact_info",
	// "customer_freight_preferences", "customer_defaults",
	// "customer_notification_preferences", "order_discount", "sales_order_line",
	// "sales_order_type", "sales_order_status", "material", "supplier_material",
	// "part", "permission_group", "permission", "pick", "pick_line", "product_type",
	// "production", "production_flow", "map", "purchase_order", "purchase_order_line",
	// "supplier", "supplier_summary", "receivable_entry", "receiving_order",
	// "receiving_order_line", "email_contact", "allocation_entry",
	// "open_credit_entry", "volume_discount", "volume_discount_tier",
	// "analyze_deliveries_response", "analyze_manufacturing_response",
	// "analyze_manufacturing_batch_response", "analyze_quarterly_orders_response",
	// "analyze_new_customers_response", "analyze_oee_response",
	// "catalog_product_line", "catalog_category", "catalog_product",
	// "catalog_property", "catalog_attribute", "dc_location", "edi_run",
	// "inventory_item", "analyze_weeks_of_sales_response",
	// "bulk_reconcile_items_response", "sys_property", "sys_property_type",
	// "sys_property_value", "territory", "tenancy", "checkout_session",
	// "estimate_rate_result", "rate_shop_option", "rate_shop_result", "owner",
	// "message", "account_photo_upload_result", "user_photo_upload_result",
	// "user_photo_url", "batch_lot", "check_duplicate_result", "item_trend_point",
	// "pack_pick_response", "pick_shipments_response", "tenancy_pending_registration",
	// "invoice_allocation_entry", "allocation_customer",
	// "checkout_sales_order_response", "create_production_run_response".
	Data []string `json:"data" api:"required"`
	// Resource type identifier.
	//
	// Any of "list".
	Object ListObjectTypeObject `json:"object" api:"required"`
	// PageInfo contains URL-based pagination metadata.
	PageInfo PageInfo `json:"page_info" api:"required"`
	// JSON contains metadata for fields, check presence with [respjson.Field.Valid].
	JSON struct {
		Data        respjson.Field
		Object      respjson.Field
		PageInfo    respjson.Field
		ExtraFields map[string]respjson.Field
		// contains filtered or unexported fields
	} `json:"-"`
}

List represents a paginated list of resources.

func (ListObjectType) RawJSON 

func (r ListObjectType) RawJSON() string

Returns the unmodified JSON received from the API

func (*ListObjectType) UnmarshalJSON 

func (r *ListObjectType) UnmarshalJSON(data []byte) error

type ListObjectTypeObject 

type ListObjectTypeObject string

Resource type identifier. 

const (
	ListObjectTypeObjectList ListObjectTypeObject = "list"
)

type ListPart 

type ListPart struct {
	// Resources in this page.
	Data []Part `json:"data" api:"required"`
	// Resource type identifier.
	//
	// Any of "list".
	Object ListPartObject `json:"object" api:"required"`
	// PageInfo contains URL-based pagination metadata.
	PageInfo PageInfo `json:"page_info" api:"required"`
	// JSON contains metadata for fields, check presence with [respjson.Field.Valid].
	JSON struct {
		Data        respjson.Field
		Object      respjson.Field
		PageInfo    respjson.Field
		ExtraFields map[string]respjson.Field
		// contains filtered or unexported fields
	} `json:"-"`
}

List represents a paginated list of resources.

func (ListPart) RawJSON 

func (r ListPart) RawJSON() string

Returns the unmodified JSON received from the API

func (*ListPart) UnmarshalJSON 

func (r *ListPart) UnmarshalJSON(data []byte) error

type ListPartObject 

type ListPartObject string

Resource type identifier. 

const (
	ListPartObjectList ListPartObject = "list"
)

type ListPaymentTerm 

type ListPaymentTerm struct {
	// Resources in this page.
	Data []PaymentTerm `json:"data" api:"required"`
	// Resource type identifier.
	//
	// Any of "list".
	Object ListPaymentTermObject `json:"object" api:"required"`
	// PageInfo contains URL-based pagination metadata.
	PageInfo PageInfo `json:"page_info" api:"required"`
	// JSON contains metadata for fields, check presence with [respjson.Field.Valid].
	JSON struct {
		Data        respjson.Field
		Object      respjson.Field
		PageInfo    respjson.Field
		ExtraFields map[string]respjson.Field
		// contains filtered or unexported fields
	} `json:"-"`
}

List represents a paginated list of resources.

func (ListPaymentTerm) RawJSON 

func (r ListPaymentTerm) RawJSON() string

Returns the unmodified JSON received from the API

func (*ListPaymentTerm) UnmarshalJSON 

func (r *ListPaymentTerm) UnmarshalJSON(data []byte) error

type ListPaymentTermObject 

type ListPaymentTermObject string

Resource type identifier. 

const (
	ListPaymentTermObjectList ListPaymentTermObject = "list"
)

type ListPriority 

type ListPriority struct {
	// Resources in this page.
	Data []Priority `json:"data" api:"required"`
	// Resource type identifier.
	//
	// Any of "list".
	Object ListPriorityObject `json:"object" api:"required"`
	// PageInfo contains URL-based pagination metadata.
	PageInfo PageInfo `json:"page_info" api:"required"`
	// JSON contains metadata for fields, check presence with [respjson.Field.Valid].
	JSON struct {
		Data        respjson.Field
		Object      respjson.Field
		PageInfo    respjson.Field
		ExtraFields map[string]respjson.Field
		// contains filtered or unexported fields
	} `json:"-"`
}

List represents a paginated list of resources.

func (ListPriority) RawJSON 

func (r ListPriority) RawJSON() string

Returns the unmodified JSON received from the API

func (*ListPriority) UnmarshalJSON 

func (r *ListPriority) UnmarshalJSON(data []byte) error

type ListPriorityObject 

type ListPriorityObject string

Resource type identifier. 

const (
	ListPriorityObjectList ListPriorityObject = "list"
)

type ListProduct 

type ListProduct struct {
	// Resources in this page.
	Data []Product `json:"data" api:"required"`
	// Resource type identifier.
	//
	// Any of "list".
	Object ListProductObject `json:"object" api:"required"`
	// PageInfo contains URL-based pagination metadata.
	PageInfo PageInfo `json:"page_info" api:"required"`
	// JSON contains metadata for fields, check presence with [respjson.Field.Valid].
	JSON struct {
		Data        respjson.Field
		Object      respjson.Field
		PageInfo    respjson.Field
		ExtraFields map[string]respjson.Field
		// contains filtered or unexported fields
	} `json:"-"`
}

List represents a paginated list of resources.

func (ListProduct) RawJSON 

func (r ListProduct) RawJSON() string

Returns the unmodified JSON received from the API

func (*ListProduct) UnmarshalJSON 

func (r *ListProduct) UnmarshalJSON(data []byte) error

type ListProductLine 

type ListProductLine struct {
	// Resources in this page.
	Data []ProductLine `json:"data" api:"required"`
	// Resource type identifier.
	//
	// Any of "list".
	Object ListProductLineObject `json:"object" api:"required"`
	// PageInfo contains URL-based pagination metadata.
	PageInfo PageInfo `json:"page_info" api:"required"`
	// JSON contains metadata for fields, check presence with [respjson.Field.Valid].
	JSON struct {
		Data        respjson.Field
		Object      respjson.Field
		PageInfo    respjson.Field
		ExtraFields map[string]respjson.Field
		// contains filtered or unexported fields
	} `json:"-"`
}

List represents a paginated list of resources.

func (ListProductLine) RawJSON 

func (r ListProductLine) RawJSON() string

Returns the unmodified JSON received from the API

func (*ListProductLine) UnmarshalJSON 

func (r *ListProductLine) UnmarshalJSON(data []byte) error

type ListProductLineObject 

type ListProductLineObject string

Resource type identifier. 

const (
	ListProductLineObjectList ListProductLineObject = "list"
)

type ListProductObject 

type ListProductObject string

Resource type identifier. 

const (
	ListProductObjectList ListProductObject = "list"
)

type ListProductionStep 

type ListProductionStep struct {
	// Resources in this page.
	Data []ProductionStep `json:"data" api:"required"`
	// Resource type identifier.
	//
	// Any of "list".
	Object ListProductionStepObject `json:"object" api:"required"`
	// PageInfo contains URL-based pagination metadata.
	PageInfo PageInfo `json:"page_info" api:"required"`
	// JSON contains metadata for fields, check presence with [respjson.Field.Valid].
	JSON struct {
		Data        respjson.Field
		Object      respjson.Field
		PageInfo    respjson.Field
		ExtraFields map[string]respjson.Field
		// contains filtered or unexported fields
	} `json:"-"`
}

List represents a paginated list of resources.

func (ListProductionStep) RawJSON 

func (r ListProductionStep) RawJSON() string

Returns the unmodified JSON received from the API

func (*ListProductionStep) UnmarshalJSON 

func (r *ListProductionStep) UnmarshalJSON(data []byte) error

type ListProductionStepObject 

type ListProductionStepObject string

Resource type identifier. 

const (
	ListProductionStepObjectList ListProductionStepObject = "list"
)

type ListProperty 

type ListProperty struct {
	// Resources in this page.
	Data []Property `json:"data" api:"required"`
	// Resource type identifier.
	//
	// Any of "list".
	Object ListPropertyObject `json:"object" api:"required"`
	// PageInfo contains URL-based pagination metadata.
	PageInfo PageInfo `json:"page_info" api:"required"`
	// JSON contains metadata for fields, check presence with [respjson.Field.Valid].
	JSON struct {
		Data        respjson.Field
		Object      respjson.Field
		PageInfo    respjson.Field
		ExtraFields map[string]respjson.Field
		// contains filtered or unexported fields
	} `json:"-"`
}

List represents a paginated list of resources.

func (ListProperty) RawJSON 

func (r ListProperty) RawJSON() string

Returns the unmodified JSON received from the API

func (*ListProperty) UnmarshalJSON 

func (r *ListProperty) UnmarshalJSON(data []byte) error

type ListPropertyObject 

type ListPropertyObject string

Resource type identifier. 

const (
	ListPropertyObjectList ListPropertyObject = "list"
)

type ListRequestLog 

type ListRequestLog struct {
	// Resources in this page.
	Data []RequestLog `json:"data" api:"required"`
	// Resource type identifier.
	//
	// Any of "list".
	Object ListRequestLogObject `json:"object" api:"required"`
	// PageInfo contains URL-based pagination metadata.
	PageInfo PageInfo `json:"page_info" api:"required"`
	// JSON contains metadata for fields, check presence with [respjson.Field.Valid].
	JSON struct {
		Data        respjson.Field
		Object      respjson.Field
		PageInfo    respjson.Field
		ExtraFields map[string]respjson.Field
		// contains filtered or unexported fields
	} `json:"-"`
}

List represents a paginated list of resources.

func (ListRequestLog) RawJSON 

func (r ListRequestLog) RawJSON() string

Returns the unmodified JSON received from the API

func (*ListRequestLog) UnmarshalJSON 

func (r *ListRequestLog) UnmarshalJSON(data []byte) error

type ListRequestLogObject 

type ListRequestLogObject string

Resource type identifier. 

const (
	ListRequestLogObjectList ListRequestLogObject = "list"
)

type ListRole 

type ListRole struct {
	// Resources in this page.
	Data []Role `json:"data" api:"required"`
	// Resource type identifier.
	//
	// Any of "list".
	Object ListRoleObject `json:"object" api:"required"`
	// PageInfo contains URL-based pagination metadata.
	PageInfo PageInfo `json:"page_info" api:"required"`
	// JSON contains metadata for fields, check presence with [respjson.Field.Valid].
	JSON struct {
		Data        respjson.Field
		Object      respjson.Field
		PageInfo    respjson.Field
		ExtraFields map[string]respjson.Field
		// contains filtered or unexported fields
	} `json:"-"`
}

List represents a paginated list of resources.

func (ListRole) RawJSON 

func (r ListRole) RawJSON() string

Returns the unmodified JSON received from the API

func (*ListRole) UnmarshalJSON 

func (r *ListRole) UnmarshalJSON(data []byte) error

type ListRoleObject 

type ListRoleObject string

Resource type identifier. 

const (
	ListRoleObjectList ListRoleObject = "list"
)

type ListSalesOrderStatus 

type ListSalesOrderStatus struct {
	// Resources in this page.
	Data []SalesOrderStatus `json:"data" api:"required"`
	// Resource type identifier.
	//
	// Any of "list".
	Object ListSalesOrderStatusObject `json:"object" api:"required"`
	// PageInfo contains URL-based pagination metadata.
	PageInfo PageInfo `json:"page_info" api:"required"`
	// JSON contains metadata for fields, check presence with [respjson.Field.Valid].
	JSON struct {
		Data        respjson.Field
		Object      respjson.Field
		PageInfo    respjson.Field
		ExtraFields map[string]respjson.Field
		// contains filtered or unexported fields
	} `json:"-"`
}

List represents a paginated list of resources.

func (ListSalesOrderStatus) RawJSON 

func (r ListSalesOrderStatus) RawJSON() string

Returns the unmodified JSON received from the API

func (*ListSalesOrderStatus) UnmarshalJSON 

func (r *ListSalesOrderStatus) UnmarshalJSON(data []byte) error

type ListSalesOrderStatusObject 

type ListSalesOrderStatusObject string

Resource type identifier. 

const (
	ListSalesOrderStatusObjectList ListSalesOrderStatusObject = "list"
)

type ListSandbox 

type ListSandbox struct {
	// Resources in this page.
	Data []Sandbox `json:"data" api:"required"`
	// Resource type identifier.
	//
	// Any of "list".
	Object ListSandboxObject `json:"object" api:"required"`
	// PageInfo contains URL-based pagination metadata.
	PageInfo PageInfo `json:"page_info" api:"required"`
	// JSON contains metadata for fields, check presence with [respjson.Field.Valid].
	JSON struct {
		Data        respjson.Field
		Object      respjson.Field
		PageInfo    respjson.Field
		ExtraFields map[string]respjson.Field
		// contains filtered or unexported fields
	} `json:"-"`
}

List represents a paginated list of resources.

func (ListSandbox) RawJSON 

func (r ListSandbox) RawJSON() string

Returns the unmodified JSON received from the API

func (*ListSandbox) UnmarshalJSON 

func (r *ListSandbox) UnmarshalJSON(data []byte) error

type ListSandboxObject 

type ListSandboxObject string

Resource type identifier. 

const (
	ListSandboxObjectList ListSandboxObject = "list"
)

type ListScanningStation 

type ListScanningStation struct {
	// Resources in this page.
	Data []ScanningStation `json:"data" api:"required"`
	// Resource type identifier.
	//
	// Any of "list".
	Object ListScanningStationObject `json:"object" api:"required"`
	// PageInfo contains URL-based pagination metadata.
	PageInfo PageInfo `json:"page_info" api:"required"`
	// JSON contains metadata for fields, check presence with [respjson.Field.Valid].
	JSON struct {
		Data        respjson.Field
		Object      respjson.Field
		PageInfo    respjson.Field
		ExtraFields map[string]respjson.Field
		// contains filtered or unexported fields
	} `json:"-"`
}

List represents a paginated list of resources.

func (ListScanningStation) RawJSON 

func (r ListScanningStation) RawJSON() string

Returns the unmodified JSON received from the API

func (*ListScanningStation) UnmarshalJSON 

func (r *ListScanningStation) UnmarshalJSON(data []byte) error

type ListScanningStationObject 

type ListScanningStationObject string

Resource type identifier. 

const (
	ListScanningStationObjectList ListScanningStationObject = "list"
)

type ListServiceLevel 

type ListServiceLevel struct {
	// Resources in this page.
	Data []ServiceLevel `json:"data" api:"required"`
	// Resource type identifier.
	//
	// Any of "list".
	Object ListServiceLevelObject `json:"object" api:"required"`
	// PageInfo contains URL-based pagination metadata.
	PageInfo PageInfo `json:"page_info" api:"required"`
	// JSON contains metadata for fields, check presence with [respjson.Field.Valid].
	JSON struct {
		Data        respjson.Field
		Object      respjson.Field
		PageInfo    respjson.Field
		ExtraFields map[string]respjson.Field
		// contains filtered or unexported fields
	} `json:"-"`
}

List represents a paginated list of resources.

func (ListServiceLevel) RawJSON 

func (r ListServiceLevel) RawJSON() string

Returns the unmodified JSON received from the API

func (*ListServiceLevel) UnmarshalJSON 

func (r *ListServiceLevel) UnmarshalJSON(data []byte) error

type ListServiceLevelObject 

type ListServiceLevelObject string

Resource type identifier. 

const (
	ListServiceLevelObjectList ListServiceLevelObject = "list"
)

type ListShippingTerm 

type ListShippingTerm struct {
	// Resources in this page.
	Data []ShippingTerm `json:"data" api:"required"`
	// Resource type identifier.
	//
	// Any of "list".
	Object ListShippingTermObject `json:"object" api:"required"`
	// PageInfo contains URL-based pagination metadata.
	PageInfo PageInfo `json:"page_info" api:"required"`
	// JSON contains metadata for fields, check presence with [respjson.Field.Valid].
	JSON struct {
		Data        respjson.Field
		Object      respjson.Field
		PageInfo    respjson.Field
		ExtraFields map[string]respjson.Field
		// contains filtered or unexported fields
	} `json:"-"`
}

List represents a paginated list of resources.

func (ListShippingTerm) RawJSON 

func (r ListShippingTerm) RawJSON() string

Returns the unmodified JSON received from the API

func (*ListShippingTerm) UnmarshalJSON 

func (r *ListShippingTerm) UnmarshalJSON(data []byte) error

type ListShippingTermObject 

type ListShippingTermObject string

Resource type identifier. 

const (
	ListShippingTermObjectList ListShippingTermObject = "list"
)

type ListTransactionMethod 

type ListTransactionMethod struct {
	// Resources in this page.
	Data []TransactionMethod `json:"data" api:"required"`
	// Resource type identifier.
	//
	// Any of "list".
	Object ListTransactionMethodObject `json:"object" api:"required"`
	// PageInfo contains URL-based pagination metadata.
	PageInfo PageInfo `json:"page_info" api:"required"`
	// JSON contains metadata for fields, check presence with [respjson.Field.Valid].
	JSON struct {
		Data        respjson.Field
		Object      respjson.Field
		PageInfo    respjson.Field
		ExtraFields map[string]respjson.Field
		// contains filtered or unexported fields
	} `json:"-"`
}

List represents a paginated list of resources.

func (ListTransactionMethod) RawJSON 

func (r ListTransactionMethod) RawJSON() string

Returns the unmodified JSON received from the API

func (*ListTransactionMethod) UnmarshalJSON 

func (r *ListTransactionMethod) UnmarshalJSON(data []byte) error

type ListTransactionMethodObject 

type ListTransactionMethodObject string

Resource type identifier. 

const (
	ListTransactionMethodObjectList ListTransactionMethodObject = "list"
)

type ListTransactionType 

type ListTransactionType struct {
	// Resources in this page.
	Data []TransactionType `json:"data" api:"required"`
	// Resource type identifier.
	//
	// Any of "list".
	Object ListTransactionTypeObject `json:"object" api:"required"`
	// PageInfo contains URL-based pagination metadata.
	PageInfo PageInfo `json:"page_info" api:"required"`
	// JSON contains metadata for fields, check presence with [respjson.Field.Valid].
	JSON struct {
		Data        respjson.Field
		Object      respjson.Field
		PageInfo    respjson.Field
		ExtraFields map[string]respjson.Field
		// contains filtered or unexported fields
	} `json:"-"`
}

List represents a paginated list of resources.

func (ListTransactionType) RawJSON 

func (r ListTransactionType) RawJSON() string

Returns the unmodified JSON received from the API

func (*ListTransactionType) UnmarshalJSON 

func (r *ListTransactionType) UnmarshalJSON(data []byte) error

type ListTransactionTypeObject 

type ListTransactionTypeObject string

Resource type identifier. 

const (
	ListTransactionTypeObjectList ListTransactionTypeObject = "list"
)

type ListUnit 

type ListUnit struct {
	// Resources in this page.
	Data []Unit `json:"data" api:"required"`
	// Resource type identifier.
	//
	// Any of "list".
	Object ListUnitObject `json:"object" api:"required"`
	// PageInfo contains URL-based pagination metadata.
	PageInfo PageInfo `json:"page_info" api:"required"`
	// JSON contains metadata for fields, check presence with [respjson.Field.Valid].
	JSON struct {
		Data        respjson.Field
		Object      respjson.Field
		PageInfo    respjson.Field
		ExtraFields map[string]respjson.Field
		// contains filtered or unexported fields
	} `json:"-"`
}

List represents a paginated list of resources.

func (ListUnit) RawJSON 

func (r ListUnit) RawJSON() string

Returns the unmodified JSON received from the API

func (*ListUnit) UnmarshalJSON 

func (r *ListUnit) UnmarshalJSON(data []byte) error

type ListUnitGroup 

type ListUnitGroup struct {
	// Resources in this page.
	Data []UnitGroup `json:"data" api:"required"`
	// Resource type identifier.
	//
	// Any of "list".
	Object ListUnitGroupObject `json:"object" api:"required"`
	// PageInfo contains URL-based pagination metadata.
	PageInfo PageInfo `json:"page_info" api:"required"`
	// JSON contains metadata for fields, check presence with [respjson.Field.Valid].
	JSON struct {
		Data        respjson.Field
		Object      respjson.Field
		PageInfo    respjson.Field
		ExtraFields map[string]respjson.Field
		// contains filtered or unexported fields
	} `json:"-"`
}

List represents a paginated list of resources.

func (ListUnitGroup) RawJSON 

func (r ListUnitGroup) RawJSON() string

Returns the unmodified JSON received from the API

func (*ListUnitGroup) UnmarshalJSON 

func (r *ListUnitGroup) UnmarshalJSON(data []byte) error

type ListUnitGroupObject 

type ListUnitGroupObject string

Resource type identifier. 

const (
	ListUnitGroupObjectList ListUnitGroupObject = "list"
)

type ListUnitGroupUnit 

type ListUnitGroupUnit struct {
	// Resources in this page.
	Data []UnitGroupUnit `json:"data" api:"required"`
	// Resource type identifier.
	//
	// Any of "list".
	Object ListUnitGroupUnitObject `json:"object" api:"required"`
	// PageInfo contains URL-based pagination metadata.
	PageInfo PageInfo `json:"page_info" api:"required"`
	// JSON contains metadata for fields, check presence with [respjson.Field.Valid].
	JSON struct {
		Data        respjson.Field
		Object      respjson.Field
		PageInfo    respjson.Field
		ExtraFields map[string]respjson.Field
		// contains filtered or unexported fields
	} `json:"-"`
}

List represents a paginated list of resources.

func (ListUnitGroupUnit) RawJSON 

func (r ListUnitGroupUnit) RawJSON() string

Returns the unmodified JSON received from the API

func (*ListUnitGroupUnit) UnmarshalJSON 

func (r *ListUnitGroupUnit) UnmarshalJSON(data []byte) error

type ListUnitGroupUnitObject 

type ListUnitGroupUnitObject string

Resource type identifier. 

const (
	ListUnitGroupUnitObjectList ListUnitGroupUnitObject = "list"
)

type ListUnitObject 

type ListUnitObject string

Resource type identifier. 

const (
	ListUnitObjectList ListUnitObject = "list"
)

type Location 

type Location struct {
	// Location ID.
	ID string `json:"id" api:"required"`
	// List represents a paginated list of resources.
	Children *ListLocation `json:"children" api:"required"`
	// Creation timestamp.
	CreatedAt time.Time `json:"created_at" api:"required" format:"date-time"`
	// Display name.
	Name string `json:"name" api:"required"`
	// Resource type identifier.
	//
	// Any of "location".
	Object LocationObject `json:"object" api:"required"`
	// Location resource.
	Parent *Location `json:"parent" api:"required"`
	// Location type code.
	//
	// Any of "building", "section", "aisle", "rack", "shelf", "bin".
	Type LocationTypeCode `json:"type" api:"required"`
	// Last-updated timestamp.
	UpdatedAt time.Time `json:"updated_at" api:"required" format:"date-time"`
	// JSON contains metadata for fields, check presence with [respjson.Field.Valid].
	JSON struct {
		ID          respjson.Field
		Children    respjson.Field
		CreatedAt   respjson.Field
		Name        respjson.Field
		Object      respjson.Field
		Parent      respjson.Field
		Type        respjson.Field
		UpdatedAt   respjson.Field
		ExtraFields map[string]respjson.Field
		// contains filtered or unexported fields
	} `json:"-"`
}

Location resource.

func (Location) RawJSON 

func (r Location) RawJSON() string

Returns the unmodified JSON received from the API

func (*Location) UnmarshalJSON 

func (r *Location) UnmarshalJSON(data []byte) error

type LocationObject 

type LocationObject string

Resource type identifier. 

const (
	LocationObjectLocation LocationObject = "location"
)

type LocationType 

type LocationType struct {
	// Location ID.
	ID string `json:"id" api:"required"`
	// Location type code.
	//
	// Any of "building", "section", "aisle", "rack", "shelf", "bin".
	Code LocationTypeCode `json:"code" api:"required"`
	// Creation timestamp.
	CreatedAt time.Time `json:"created_at" api:"required" format:"date-time"`
	// Display name.
	Name string `json:"name" api:"required"`
	// Resource type identifier.
	//
	// Any of "location_type".
	Object LocationTypeObject `json:"object" api:"required"`
	// Last-updated timestamp.
	UpdatedAt time.Time `json:"updated_at" api:"required" format:"date-time"`
	// JSON contains metadata for fields, check presence with [respjson.Field.Valid].
	JSON struct {
		ID          respjson.Field
		Code        respjson.Field
		CreatedAt   respjson.Field
		Name        respjson.Field
		Object      respjson.Field
		UpdatedAt   respjson.Field
		ExtraFields map[string]respjson.Field
		// contains filtered or unexported fields
	} `json:"-"`
}

LocationType resource.

func (LocationType) RawJSON 

func (r LocationType) RawJSON() string

Returns the unmodified JSON received from the API

func (*LocationType) UnmarshalJSON 

func (r *LocationType) UnmarshalJSON(data []byte) error

type LocationTypeCode 

type LocationTypeCode string
const (
	LocationTypeCodeBuilding LocationTypeCode = "building"
	LocationTypeCodeSection  LocationTypeCode = "section"
	LocationTypeCodeAisle    LocationTypeCode = "aisle"
	LocationTypeCodeRack     LocationTypeCode = "rack"
	LocationTypeCodeShelf    LocationTypeCode = "shelf"
	LocationTypeCodeBin      LocationTypeCode = "bin"
)

type LocationTypeObject 

type LocationTypeObject string

Resource type identifier. 

const (
	LocationTypeObjectLocationType LocationTypeObject = "location_type"
)

type Machine 

type Machine struct {
	// Machine ID.
	ID string `json:"id" api:"required"`
	// Creation timestamp.
	CreatedAt time.Time `json:"created_at" api:"required" format:"date-time"`
	// Department resource.
	Department *Department `json:"department" api:"required"`
	// Display name.
	Name string `json:"name" api:"required"`
	// Notes.
	Notes string `json:"notes" api:"required"`
	// Resource type identifier.
	//
	// Any of "machine".
	Object MachineObject `json:"object" api:"required"`
	// Serial number.
	SerialNumber string `json:"serial_number" api:"required"`
	// Last updated timestamp.
	UpdatedAt time.Time `json:"updated_at" api:"required" format:"date-time"`
	// JSON contains metadata for fields, check presence with [respjson.Field.Valid].
	JSON struct {
		ID           respjson.Field
		CreatedAt    respjson.Field
		Department   respjson.Field
		Name         respjson.Field
		Notes        respjson.Field
		Object       respjson.Field
		SerialNumber respjson.Field
		UpdatedAt    respjson.Field
		ExtraFields  map[string]respjson.Field
		// contains filtered or unexported fields
	} `json:"-"`
}

Machine within an account.

func (Machine) RawJSON 

func (r Machine) RawJSON() string

Returns the unmodified JSON received from the API

func (*Machine) UnmarshalJSON 

func (r *Machine) UnmarshalJSON(data []byte) error

type MachineObject 

type MachineObject string

Resource type identifier. 

const (
	MachineObjectMachine MachineObject = "machine"
)

type Material 

type Material struct {
	// Material ID.
	ID string `json:"id" api:"required"`
	// Creation timestamp.
	CreatedAt time.Time `json:"created_at" api:"required" format:"date-time"`
	// Item is an inventory item (product, material, or part).
	Item Item `json:"item" api:"required"`
	// Value with an associated unit.
	LeadTime Quantity `json:"lead_time" api:"required"`
	// Resource type identifier.
	//
	// Any of "material".
	Object MaterialObject `json:"object" api:"required"`
	// Value with an associated unit.
	OrderPoint Quantity `json:"order_point" api:"required"`
	// Last updated timestamp.
	UpdatedAt time.Time `json:"updated_at" api:"required" format:"date-time"`
	// JSON contains metadata for fields, check presence with [respjson.Field.Valid].
	JSON struct {
		ID          respjson.Field
		CreatedAt   respjson.Field
		Item        respjson.Field
		LeadTime    respjson.Field
		Object      respjson.Field
		OrderPoint  respjson.Field
		UpdatedAt   respjson.Field
		ExtraFields map[string]respjson.Field
		// contains filtered or unexported fields
	} `json:"-"`
}

Material with order point and lead time.

func (Material) RawJSON 

func (r Material) RawJSON() string

Returns the unmodified JSON received from the API

func (*Material) UnmarshalJSON 

func (r *Material) UnmarshalJSON(data []byte) error

type MaterialObject 

type MaterialObject string

Resource type identifier. 

const (
	MaterialObjectMaterial MaterialObject = "material"
)

type MergeCustomersRequestParam 

type MergeCustomersRequestParam struct {
	// Source customer IDs.
	SourceCustomerIDs []string `json:"source_customer_ids,omitzero" api:"required"`
	// contains filtered or unexported fields
}

Request to merge source customers into a target customer.

The property SourceCustomerIDs is required.

func (MergeCustomersRequestParam) MarshalJSON 

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

func (*MergeCustomersRequestParam) UnmarshalJSON 

func (r *MergeCustomersRequestParam) UnmarshalJSON(data []byte) error

type NotificationPreferenceItemNotificationType 

type NotificationPreferenceItemNotificationType string

Notification type. 

const (
	NotificationPreferenceItemNotificationTypeInvoice                 NotificationPreferenceItemNotificationType = "invoice"
	NotificationPreferenceItemNotificationTypeOrderAcknowledgement    NotificationPreferenceItemNotificationType = "order_acknowledgement"
	NotificationPreferenceItemNotificationTypePurchaseOrderSubmission NotificationPreferenceItemNotificationType = "purchase_order_submission"
)

type NotificationPreferenceItemParam 

type NotificationPreferenceItemParam struct {
	// Whether this notification type is enabled for the account user.
	Enabled bool `json:"enabled" api:"required"`
	// Notification type.
	//
	// Any of "invoice", "order_acknowledgement", "purchase_order_submission".
	NotificationType NotificationPreferenceItemNotificationType `json:"notification_type,omitzero" api:"required"`
	// contains filtered or unexported fields
}

NotificationPreferenceItem toggles a single account-relation notification type.

The properties Enabled, NotificationType are required.

func (NotificationPreferenceItemParam) MarshalJSON 

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

func (*NotificationPreferenceItemParam) UnmarshalJSON 

func (r *NotificationPreferenceItemParam) UnmarshalJSON(data []byte) error

type OperationCarrierDeleteResponse 

type OperationCarrierDeleteResponse struct {
	// JSON contains metadata for fields, check presence with [respjson.Field.Valid].
	JSON struct {
		ExtraFields map[string]respjson.Field
		// contains filtered or unexported fields
	} `json:"-"`
}

func (OperationCarrierDeleteResponse) RawJSON 

func (r OperationCarrierDeleteResponse) RawJSON() string

Returns the unmodified JSON received from the API

func (*OperationCarrierDeleteResponse) UnmarshalJSON 

func (r *OperationCarrierDeleteResponse) UnmarshalJSON(data []byte) error

type OperationCarrierGetParams 

type OperationCarrierGetParams struct {
	// Sub-objects to expand in the response. When omitted, sub-objects are returned as
	// `null`.
	//
	// Any of "owner", "owner.account", "service_levels".
	Include []string `query:"include,omitzero" json:"-"`
	// contains filtered or unexported fields
}

func (OperationCarrierGetParams) URLQuery 

func (r OperationCarrierGetParams) URLQuery() (v url.Values, err error)

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

type OperationCarrierListParams 

type OperationCarrierListParams struct {
	// Cursor token used to retrieve the next or previous page of results.
	Cursor param.Opt[string] `query:"cursor,omitzero" json:"-"`
	// Maximum number of results per page (default: 100, max: 1000).
	Limit param.Opt[int64] `query:"limit,omitzero" json:"-"`
	// Search query used to filter results.
	Q param.Opt[string] `query:"q,omitzero" json:"-"`
	// Sub-objects to expand in the response. When omitted, sub-objects are returned as
	// `null`.
	//
	// Any of "owner", "owner.account", "service_levels".
	Include []string `query:"include,omitzero" json:"-"`
	// contains filtered or unexported fields
}

func (OperationCarrierListParams) URLQuery 

func (r OperationCarrierListParams) URLQuery() (v url.Values, err error)

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

type OperationCarrierNewParams 

type OperationCarrierNewParams struct {
	// Request to create a carrier.
	CreateCarrierRequest CreateCarrierRequestParam
	// Sub-objects to expand in the response. When omitted, sub-objects are returned as
	// `null`.
	//
	// Any of "owner", "owner.account", "service_levels".
	Include []string `query:"include,omitzero" json:"-"`
	// contains filtered or unexported fields
}

func (OperationCarrierNewParams) MarshalJSON 

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

func (OperationCarrierNewParams) URLQuery 

func (r OperationCarrierNewParams) URLQuery() (v url.Values, err error)

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

func (*OperationCarrierNewParams) UnmarshalJSON 

func (r *OperationCarrierNewParams) UnmarshalJSON(data []byte) error

type OperationCarrierService 

type OperationCarrierService struct {

	// List and manage service levels (shipping service levels).
	ServiceLevels OperationCarrierServiceLevelService
	// contains filtered or unexported fields
}

List and manage carriers and their Shippo integrations.

OperationCarrierService contains methods and other services that help with interacting with the augno 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 NewOperationCarrierService method instead.

func NewOperationCarrierService 

func NewOperationCarrierService(opts ...option.RequestOption) (r OperationCarrierService)

NewOperationCarrierService 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 (*OperationCarrierService) Delete 

func (r *OperationCarrierService) Delete(ctx context.Context, id string, opts ...option.RequestOption) (res *OperationCarrierDeleteResponse, err error)

Deletes a carrier and cascades to remove all options. If the carrier is managed by Shippo, the Shippo account is deactivated.

func (*OperationCarrierService) Get 

func (r *OperationCarrierService) Get(ctx context.Context, id string, query OperationCarrierGetParams, opts ...option.RequestOption) (res *Carrier, err error)

Returns a carrier by ID.

func (*OperationCarrierService) List 

func (r *OperationCarrierService) List(ctx context.Context, query OperationCarrierListParams, opts ...option.RequestOption) (res *ListCarrier, err error)

Returns a paginated list of carriers for the current account.

func (*OperationCarrierService) New 

func (r *OperationCarrierService) New(ctx context.Context, params OperationCarrierNewParams, opts ...option.RequestOption) (res *Carrier, err error)

Creates a carrier. If a Shippo-supported carrier code is provided, the carrier will be registered with Shippo and service levels will be auto-synced as options.

func (*OperationCarrierService) Update 

func (r *OperationCarrierService) Update(ctx context.Context, id string, params OperationCarrierUpdateParams, opts ...option.RequestOption) (res *Carrier, err error)

Partially updates a carrier's name and portal visibility.

type OperationCarrierServiceLevelDeleteParams 

type OperationCarrierServiceLevelDeleteParams struct {
	CarrierID string `path:"carrier_id" api:"required" json:"-"`
	// contains filtered or unexported fields
}

type OperationCarrierServiceLevelDeleteResponse 

type OperationCarrierServiceLevelDeleteResponse struct {
	// JSON contains metadata for fields, check presence with [respjson.Field.Valid].
	JSON struct {
		ExtraFields map[string]respjson.Field
		// contains filtered or unexported fields
	} `json:"-"`
}

func (OperationCarrierServiceLevelDeleteResponse) RawJSON 

func (r OperationCarrierServiceLevelDeleteResponse) RawJSON() string

Returns the unmodified JSON received from the API

func (*OperationCarrierServiceLevelDeleteResponse) UnmarshalJSON 

func (r *OperationCarrierServiceLevelDeleteResponse) UnmarshalJSON(data []byte) error

type OperationCarrierServiceLevelGetParams 

type OperationCarrierServiceLevelGetParams struct {
	CarrierID string `path:"carrier_id" api:"required" json:"-"`
	// Sub-objects to expand in the response. When omitted, sub-objects are returned as
	// `null`.
	//
	// Any of "owner", "owner.account".
	Include []string `query:"include,omitzero" json:"-"`
	// contains filtered or unexported fields
}

func (OperationCarrierServiceLevelGetParams) URLQuery 

func (r OperationCarrierServiceLevelGetParams) URLQuery() (v url.Values, err error)

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

type OperationCarrierServiceLevelListParams 

type OperationCarrierServiceLevelListParams struct {
	// Cursor token used to retrieve the next or previous page of results.
	Cursor param.Opt[string] `query:"cursor,omitzero" json:"-"`
	// Maximum number of results per page (default: 100, max: 1000).
	Limit param.Opt[int64] `query:"limit,omitzero" json:"-"`
	// Search query used to filter results.
	Q param.Opt[string] `query:"q,omitzero" json:"-"`
	// Sub-objects to expand in the response. When omitted, sub-objects are returned as
	// `null`.
	//
	// Any of "owner", "owner.account".
	Include []string `query:"include,omitzero" json:"-"`
	// contains filtered or unexported fields
}

func (OperationCarrierServiceLevelListParams) URLQuery 

func (r OperationCarrierServiceLevelListParams) URLQuery() (v url.Values, err error)

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

type OperationCarrierServiceLevelNewParams 

type OperationCarrierServiceLevelNewParams struct {
	// Request to create a service level.
	CreateServiceLevelRequest CreateServiceLevelRequestParam
	// Sub-objects to expand in the response. When omitted, sub-objects are returned as
	// `null`.
	//
	// Any of "owner", "owner.account".
	Include []string `query:"include,omitzero" json:"-"`
	// contains filtered or unexported fields
}

func (OperationCarrierServiceLevelNewParams) MarshalJSON 

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

func (OperationCarrierServiceLevelNewParams) URLQuery 

func (r OperationCarrierServiceLevelNewParams) URLQuery() (v url.Values, err error)

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

func (*OperationCarrierServiceLevelNewParams) UnmarshalJSON 

func (r *OperationCarrierServiceLevelNewParams) UnmarshalJSON(data []byte) error

type OperationCarrierServiceLevelService 

type OperationCarrierServiceLevelService struct {
	// contains filtered or unexported fields
}

List and manage service levels (shipping service levels).

OperationCarrierServiceLevelService contains methods and other services that help with interacting with the augno 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 NewOperationCarrierServiceLevelService method instead.

func NewOperationCarrierServiceLevelService 

func NewOperationCarrierServiceLevelService(opts ...option.RequestOption) (r OperationCarrierServiceLevelService)

NewOperationCarrierServiceLevelService 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 (*OperationCarrierServiceLevelService) Delete 

func (r *OperationCarrierServiceLevelService) Delete(ctx context.Context, id string, body OperationCarrierServiceLevelDeleteParams, opts ...option.RequestOption) (res *OperationCarrierServiceLevelDeleteResponse, err error)

Permanently deletes a service level. Fails if the service level is a default (system-synced) level.

func (*OperationCarrierServiceLevelService) Get 

func (r *OperationCarrierServiceLevelService) Get(ctx context.Context, id string, params OperationCarrierServiceLevelGetParams, opts ...option.RequestOption) (res *ServiceLevel, err error)

Returns a service level by ID.

func (*OperationCarrierServiceLevelService) List 

func (r *OperationCarrierServiceLevelService) List(ctx context.Context, carrierID string, query OperationCarrierServiceLevelListParams, opts ...option.RequestOption) (res *ListServiceLevel, err error)

Returns a paginated list of service levels for a carrier.

func (*OperationCarrierServiceLevelService) New 

func (r *OperationCarrierServiceLevelService) New(ctx context.Context, carrierID string, params OperationCarrierServiceLevelNewParams, opts ...option.RequestOption) (res *ServiceLevel, err error)

Creates a service level for a carrier.

func (*OperationCarrierServiceLevelService) Update 

func (r *OperationCarrierServiceLevelService) Update(ctx context.Context, id string, params OperationCarrierServiceLevelUpdateParams, opts ...option.RequestOption) (res *ServiceLevel, err error)

Partially updates a service level.

type OperationCarrierServiceLevelUpdateParams 

type OperationCarrierServiceLevelUpdateParams struct {
	CarrierID string `path:"carrier_id" api:"required" json:"-"`
	// Sub-objects to expand in the response. When omitted, sub-objects are returned as
	// `null`.
	//
	// Any of "owner", "owner.account".
	Include []string `query:"include,omitzero" json:"-"`
	// Request to update a service level.
	UpdateServiceLevelRequest UpdateServiceLevelRequestParam
	// contains filtered or unexported fields
}

func (OperationCarrierServiceLevelUpdateParams) MarshalJSON 

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

func (OperationCarrierServiceLevelUpdateParams) URLQuery 

func (r OperationCarrierServiceLevelUpdateParams) URLQuery() (v url.Values, err error)

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

func (*OperationCarrierServiceLevelUpdateParams) UnmarshalJSON 

func (r *OperationCarrierServiceLevelUpdateParams) UnmarshalJSON(data []byte) error

type OperationCarrierUpdateParams 

type OperationCarrierUpdateParams struct {
	// Sub-objects to expand in the response. When omitted, sub-objects are returned as
	// `null`.
	//
	// Any of "owner", "owner.account", "service_levels".
	Include []string `query:"include,omitzero" json:"-"`
	// Request to update a carrier.
	UpdateCarrierRequest UpdateCarrierRequestParam
	// contains filtered or unexported fields
}

func (OperationCarrierUpdateParams) MarshalJSON 

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

func (OperationCarrierUpdateParams) URLQuery 

func (r OperationCarrierUpdateParams) URLQuery() (v url.Values, err error)

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

func (*OperationCarrierUpdateParams) UnmarshalJSON 

func (r *OperationCarrierUpdateParams) UnmarshalJSON(data []byte) error

type OperationLocationDeleteResponse 

type OperationLocationDeleteResponse struct {
	// JSON contains metadata for fields, check presence with [respjson.Field.Valid].
	JSON struct {
		ExtraFields map[string]respjson.Field
		// contains filtered or unexported fields
	} `json:"-"`
}

func (OperationLocationDeleteResponse) RawJSON 

func (r OperationLocationDeleteResponse) RawJSON() string

Returns the unmodified JSON received from the API

func (*OperationLocationDeleteResponse) UnmarshalJSON 

func (r *OperationLocationDeleteResponse) UnmarshalJSON(data []byte) error

type OperationLocationGetParams 

type OperationLocationGetParams struct {
	// Sub-objects to expand in the response. When omitted, sub-objects are returned as
	// `null`.
	//
	// Any of "parent", "children".
	Include []string `query:"include,omitzero" json:"-"`
	// contains filtered or unexported fields
}

func (OperationLocationGetParams) URLQuery 

func (r OperationLocationGetParams) URLQuery() (v url.Values, err error)

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

type OperationLocationListParams 

type OperationLocationListParams struct {
	// Cursor token used to retrieve the next or previous page of results.
	Cursor param.Opt[string] `query:"cursor,omitzero" json:"-"`
	// Maximum number of results per page (default: 100, max: 1000).
	Limit param.Opt[int64] `query:"limit,omitzero" json:"-"`
	// Search query used to filter results.
	Q param.Opt[string] `query:"q,omitzero" json:"-"`
	// Sub-objects to expand in the response. When omitted, sub-objects are returned as
	// `null`.
	//
	// Any of "parent", "children".
	Include []string `query:"include,omitzero" json:"-"`
	// contains filtered or unexported fields
}

func (OperationLocationListParams) URLQuery 

func (r OperationLocationListParams) URLQuery() (v url.Values, err error)

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

type OperationLocationNewParams 

type OperationLocationNewParams struct {
	// Request to create a location.
	CreateLocationRequest CreateLocationRequestParam
	// Sub-objects to expand in the response. When omitted, sub-objects are returned as
	// `null`.
	//
	// Any of "parent", "children".
	Include []string `query:"include,omitzero" json:"-"`
	// contains filtered or unexported fields
}

func (OperationLocationNewParams) MarshalJSON 

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

func (OperationLocationNewParams) URLQuery 

func (r OperationLocationNewParams) URLQuery() (v url.Values, err error)

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

func (*OperationLocationNewParams) UnmarshalJSON 

func (r *OperationLocationNewParams) UnmarshalJSON(data []byte) error

type OperationLocationService 

type OperationLocationService struct {
	// contains filtered or unexported fields
}

List and manage locations.

OperationLocationService contains methods and other services that help with interacting with the augno 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 NewOperationLocationService method instead.

func NewOperationLocationService 

func NewOperationLocationService(opts ...option.RequestOption) (r OperationLocationService)

NewOperationLocationService 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 (*OperationLocationService) Delete 

func (r *OperationLocationService) Delete(ctx context.Context, id string, opts ...option.RequestOption) (res *OperationLocationDeleteResponse, err error)

Deletes a location. Fails if the location has child locations.

func (*OperationLocationService) Get 

func (r *OperationLocationService) Get(ctx context.Context, id string, query OperationLocationGetParams, opts ...option.RequestOption) (res *Location, err error)

Returns a location by ID.

func (*OperationLocationService) List 

func (r *OperationLocationService) List(ctx context.Context, query OperationLocationListParams, opts ...option.RequestOption) (res *ListLocation, err error)

Returns a paginated list of locations for the caller's account.

func (*OperationLocationService) New 

func (r *OperationLocationService) New(ctx context.Context, params OperationLocationNewParams, opts ...option.RequestOption) (res *Location, err error)

Creates a location for the caller's account.

func (*OperationLocationService) Update 

func (r *OperationLocationService) Update(ctx context.Context, id string, params OperationLocationUpdateParams, opts ...option.RequestOption) (res *Location, err error)

Partially updates a location.

type OperationLocationTypeListParams 

type OperationLocationTypeListParams struct {
	// Cursor token used to retrieve the next or previous page of results.
	Cursor param.Opt[string] `query:"cursor,omitzero" json:"-"`
	// Maximum number of results per page (default: 100, max: 1000).
	Limit param.Opt[int64] `query:"limit,omitzero" json:"-"`
	// Search query used to filter results.
	Q param.Opt[string] `query:"q,omitzero" json:"-"`
	// contains filtered or unexported fields
}

func (OperationLocationTypeListParams) URLQuery 

func (r OperationLocationTypeListParams) URLQuery() (v url.Values, err error)

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

type OperationLocationTypeService 

type OperationLocationTypeService struct {
	// contains filtered or unexported fields
}

List and manage locations.

OperationLocationTypeService contains methods and other services that help with interacting with the augno 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 NewOperationLocationTypeService method instead.

func NewOperationLocationTypeService 

func NewOperationLocationTypeService(opts ...option.RequestOption) (r OperationLocationTypeService)

NewOperationLocationTypeService 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 (*OperationLocationTypeService) Get 

func (r *OperationLocationTypeService) Get(ctx context.Context, id string, opts ...option.RequestOption) (res *LocationType, err error)

Returns a location type by ID or code.

func (*OperationLocationTypeService) List 

func (r *OperationLocationTypeService) List(ctx context.Context, query OperationLocationTypeListParams, opts ...option.RequestOption) (res *ListLocationType, err error)

Returns a paginated list of location types.

type OperationLocationUpdateParams 

type OperationLocationUpdateParams struct {
	// Sub-objects to expand in the response. When omitted, sub-objects are returned as
	// `null`.
	//
	// Any of "parent", "children".
	Include []string `query:"include,omitzero" json:"-"`
	// Request to partially update a location.
	UpdateLocationRequest UpdateLocationRequestParam
	// contains filtered or unexported fields
}

func (OperationLocationUpdateParams) MarshalJSON 

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

func (OperationLocationUpdateParams) URLQuery 

func (r OperationLocationUpdateParams) URLQuery() (v url.Values, err error)

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

func (*OperationLocationUpdateParams) UnmarshalJSON 

func (r *OperationLocationUpdateParams) UnmarshalJSON(data []byte) error

type OperationScanningStationDeleteResponse 

type OperationScanningStationDeleteResponse struct {
	// JSON contains metadata for fields, check presence with [respjson.Field.Valid].
	JSON struct {
		ExtraFields map[string]respjson.Field
		// contains filtered or unexported fields
	} `json:"-"`
}

func (OperationScanningStationDeleteResponse) RawJSON 

func (r OperationScanningStationDeleteResponse) RawJSON() string

Returns the unmodified JSON received from the API

func (*OperationScanningStationDeleteResponse) UnmarshalJSON 

func (r *OperationScanningStationDeleteResponse) UnmarshalJSON(data []byte) error

type OperationScanningStationGetParams 

type OperationScanningStationGetParams struct {
	// Sub-objects to expand in the response. When omitted, sub-objects are returned as
	// `null`.
	//
	// Any of "department", "production_steps".
	Include []string `query:"include,omitzero" json:"-"`
	// contains filtered or unexported fields
}

func (OperationScanningStationGetParams) URLQuery 

func (r OperationScanningStationGetParams) URLQuery() (v url.Values, err error)

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

type OperationScanningStationListParams 

type OperationScanningStationListParams struct {
	// Cursor token used to retrieve the next or previous page of results.
	Cursor param.Opt[string] `query:"cursor,omitzero" json:"-"`
	// Maximum number of results per page (default: 100, max: 1000).
	Limit param.Opt[int64] `query:"limit,omitzero" json:"-"`
	// Search query used to filter results.
	Q param.Opt[string] `query:"q,omitzero" json:"-"`
	// Sub-objects to expand in the response. When omitted, sub-objects are returned as
	// `null`.
	//
	// Any of "department", "production_steps".
	Include []string `query:"include,omitzero" json:"-"`
	// contains filtered or unexported fields
}

func (OperationScanningStationListParams) URLQuery 

func (r OperationScanningStationListParams) URLQuery() (v url.Values, err error)

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

type OperationScanningStationNewParams 

type OperationScanningStationNewParams struct {
	// Request to create a scanning station.
	CreateScanningStationRequest CreateScanningStationRequestParam
	// Sub-objects to expand in the response. When omitted, sub-objects are returned as
	// `null`.
	//
	// Any of "department", "production_steps".
	Include []string `query:"include,omitzero" json:"-"`
	// contains filtered or unexported fields
}

func (OperationScanningStationNewParams) MarshalJSON 

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

func (OperationScanningStationNewParams) URLQuery 

func (r OperationScanningStationNewParams) URLQuery() (v url.Values, err error)

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

func (*OperationScanningStationNewParams) UnmarshalJSON 

func (r *OperationScanningStationNewParams) UnmarshalJSON(data []byte) error

type OperationScanningStationService 

type OperationScanningStationService struct {
	// contains filtered or unexported fields
}

List and manage scanning stations.

OperationScanningStationService contains methods and other services that help with interacting with the augno 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 NewOperationScanningStationService method instead.

func NewOperationScanningStationService 

func NewOperationScanningStationService(opts ...option.RequestOption) (r OperationScanningStationService)

NewOperationScanningStationService 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 (*OperationScanningStationService) Delete 

func (r *OperationScanningStationService) Delete(ctx context.Context, id string, opts ...option.RequestOption) (res *OperationScanningStationDeleteResponse, err error)

Deletes a scanning station.

func (*OperationScanningStationService) Get 

func (r *OperationScanningStationService) Get(ctx context.Context, id string, query OperationScanningStationGetParams, opts ...option.RequestOption) (res *ScanningStation, err error)

Returns a scanning station by ID.

func (*OperationScanningStationService) List 

func (r *OperationScanningStationService) List(ctx context.Context, query OperationScanningStationListParams, opts ...option.RequestOption) (res *ListScanningStation, err error)

Returns a paginated list of scanning stations for the current account.

func (*OperationScanningStationService) New 

func (r *OperationScanningStationService) New(ctx context.Context, params OperationScanningStationNewParams, opts ...option.RequestOption) (res *ScanningStation, err error)

Creates a scanning station associated with a department.

func (*OperationScanningStationService) Update 

func (r *OperationScanningStationService) Update(ctx context.Context, id string, params OperationScanningStationUpdateParams, opts ...option.RequestOption) (res *ScanningStation, err error)

Partially updates a scanning station.

type OperationScanningStationUpdateParams 

type OperationScanningStationUpdateParams struct {
	// Sub-objects to expand in the response. When omitted, sub-objects are returned as
	// `null`.
	//
	// Any of "department", "production_steps".
	Include []string `query:"include,omitzero" json:"-"`
	// Request to partially update a scanning station.
	UpdateScanningStationRequest UpdateScanningStationRequestParam
	// contains filtered or unexported fields
}

func (OperationScanningStationUpdateParams) MarshalJSON 

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

func (OperationScanningStationUpdateParams) URLQuery 

func (r OperationScanningStationUpdateParams) URLQuery() (v url.Values, err error)

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

func (*OperationScanningStationUpdateParams) UnmarshalJSON 

func (r *OperationScanningStationUpdateParams) UnmarshalJSON(data []byte) error

type OperationService 

type OperationService struct {

	// List and manage shipping terms.
	ShippingTerms OperationShippingTermService
	// List and manage carriers and their Shippo integrations.
	Carriers OperationCarrierService
	// List and manage locations.
	Locations OperationLocationService
	// List and manage locations.
	LocationTypes OperationLocationTypeService
	// List and manage scanning stations.
	ScanningStations OperationScanningStationService
	// contains filtered or unexported fields
}

OperationService contains methods and other services that help with interacting with the augno 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 NewOperationService method instead.

func NewOperationService 

func NewOperationService(opts ...option.RequestOption) (r OperationService)

NewOperationService 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.

type OperationShippingTermDeleteResponse 

type OperationShippingTermDeleteResponse struct {
	// JSON contains metadata for fields, check presence with [respjson.Field.Valid].
	JSON struct {
		ExtraFields map[string]respjson.Field
		// contains filtered or unexported fields
	} `json:"-"`
}

func (OperationShippingTermDeleteResponse) RawJSON 

func (r OperationShippingTermDeleteResponse) RawJSON() string

Returns the unmodified JSON received from the API

func (*OperationShippingTermDeleteResponse) UnmarshalJSON 

func (r *OperationShippingTermDeleteResponse) UnmarshalJSON(data []byte) error

type OperationShippingTermGetParams 

type OperationShippingTermGetParams struct {
	// Sub-objects to expand in the response. When omitted, sub-objects are returned as
	// `null`.
	//
	// Any of "owner", "owner.account", "flat_rate.unit", "minimum_order_value.unit",
	// "free_shipping_service_levels".
	Include []string `query:"include,omitzero" json:"-"`
	// contains filtered or unexported fields
}

func (OperationShippingTermGetParams) URLQuery 

func (r OperationShippingTermGetParams) URLQuery() (v url.Values, err error)

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

type OperationShippingTermListParams 

type OperationShippingTermListParams struct {
	// Cursor token used to retrieve the next or previous page of results.
	Cursor param.Opt[string] `query:"cursor,omitzero" json:"-"`
	// Maximum number of results per page (default: 100, max: 1000).
	Limit param.Opt[int64] `query:"limit,omitzero" json:"-"`
	// Search query used to filter results.
	Q param.Opt[string] `query:"q,omitzero" json:"-"`
	// Sub-objects to expand in the response. When omitted, sub-objects are returned as
	// `null`.
	//
	// Any of "owner", "owner.account", "flat_rate.unit", "minimum_order_value.unit",
	// "free_shipping_service_levels".
	Include []string `query:"include,omitzero" json:"-"`
	// contains filtered or unexported fields
}

func (OperationShippingTermListParams) URLQuery 

func (r OperationShippingTermListParams) URLQuery() (v url.Values, err error)

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

type OperationShippingTermNewParams 

type OperationShippingTermNewParams struct {
	// Request to create a shipping term.
	CreateShippingTermRequest CreateShippingTermRequestParam
	// Sub-objects to expand in the response. When omitted, sub-objects are returned as
	// `null`.
	//
	// Any of "owner", "owner.account", "flat_rate.unit", "minimum_order_value.unit",
	// "free_shipping_service_levels".
	Include []string `query:"include,omitzero" json:"-"`
	// contains filtered or unexported fields
}

func (OperationShippingTermNewParams) MarshalJSON 

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

func (OperationShippingTermNewParams) URLQuery 

func (r OperationShippingTermNewParams) URLQuery() (v url.Values, err error)

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

func (*OperationShippingTermNewParams) UnmarshalJSON 

func (r *OperationShippingTermNewParams) UnmarshalJSON(data []byte) error

type OperationShippingTermService 

type OperationShippingTermService struct {
	// contains filtered or unexported fields
}

List and manage shipping terms.

OperationShippingTermService contains methods and other services that help with interacting with the augno 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 NewOperationShippingTermService method instead.

func NewOperationShippingTermService 

func NewOperationShippingTermService(opts ...option.RequestOption) (r OperationShippingTermService)

NewOperationShippingTermService 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 (*OperationShippingTermService) Delete 

func (r *OperationShippingTermService) Delete(ctx context.Context, id string, opts ...option.RequestOption) (res *OperationShippingTermDeleteResponse, err error)

Deletes an account-owned shipping term. Default shipping terms cannot be deleted.

func (*OperationShippingTermService) Get 

func (r *OperationShippingTermService) Get(ctx context.Context, id string, query OperationShippingTermGetParams, opts ...option.RequestOption) (res *ShippingTerm, err error)

Returns a shipping term by ID.

func (*OperationShippingTermService) List 

func (r *OperationShippingTermService) List(ctx context.Context, query OperationShippingTermListParams, opts ...option.RequestOption) (res *ListShippingTerm, err error)

Returns a paginated list of shipping terms for the account, including default system shipping terms.

func (*OperationShippingTermService) New 

func (r *OperationShippingTermService) New(ctx context.Context, params OperationShippingTermNewParams, opts ...option.RequestOption) (res *ShippingTerm, err error)

Creates an account-owned shipping term.

func (*OperationShippingTermService) Update 

func (r *OperationShippingTermService) Update(ctx context.Context, id string, params OperationShippingTermUpdateParams, opts ...option.RequestOption) (res *ShippingTerm, err error)

Partially updates an account-owned shipping term. Default shipping terms cannot be updated.

type OperationShippingTermUpdateParams 

type OperationShippingTermUpdateParams struct {
	// Sub-objects to expand in the response. When omitted, sub-objects are returned as
	// `null`.
	//
	// Any of "owner", "owner.account", "flat_rate.unit", "minimum_order_value.unit",
	// "free_shipping_service_levels".
	Include []string `query:"include,omitzero" json:"-"`
	// Request to partially update a shipping term. All fields are optional. Absent
	// fields are left unchanged. Send an explicit JSON null for flat_rate,
	// minimum_order_value, or free_shipping_service_level_ids to clear the existing
	// value.
	UpdateShippingTermRequest UpdateShippingTermRequestParam
	// contains filtered or unexported fields
}

func (OperationShippingTermUpdateParams) MarshalJSON 

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

func (OperationShippingTermUpdateParams) URLQuery 

func (r OperationShippingTermUpdateParams) URLQuery() (v url.Values, err error)

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

func (*OperationShippingTermUpdateParams) UnmarshalJSON 

func (r *OperationShippingTermUpdateParams) UnmarshalJSON(data []byte) error

type Owner 

type Owner struct {
	// Account with optional branding and portal sub-resources.
	Account Account `json:"account" api:"required"`
	// Resource type identifier.
	//
	// Any of "owner".
	Object OwnerObject `json:"object" api:"required"`
	// The owner type: "system" for platform defaults, "account" for account-owned
	// resources.
	//
	// Any of "system", "account".
	Type OwnerType `json:"type" api:"required"`
	// JSON contains metadata for fields, check presence with [respjson.Field.Valid].
	JSON struct {
		Account     respjson.Field
		Object      respjson.Field
		Type        respjson.Field
		ExtraFields map[string]respjson.Field
		// contains filtered or unexported fields
	} `json:"-"`
}

Owner describes the provenance of a resource.

func (Owner) RawJSON 

func (r Owner) RawJSON() string

Returns the unmodified JSON received from the API

func (*Owner) UnmarshalJSON 

func (r *Owner) UnmarshalJSON(data []byte) error

type OwnerObject 

type OwnerObject string

Resource type identifier. 

const (
	OwnerObjectOwner OwnerObject = "owner"
)

type OwnerType 

type OwnerType string

The owner type: "system" for platform defaults, "account" for account-owned resources. 

const (
	OwnerTypeSystem  OwnerType = "system"
	OwnerTypeAccount OwnerType = "account"
)

type PageInfo 

type PageInfo struct {
	// Whether more results exist after this page.
	HasNextPage bool `json:"has_next_page" api:"required"`
	// Whether results exist before this page.
	HasPrevPage bool `json:"has_prev_page" api:"required"`
	// URL to fetch the next page, `null` if no more pages.
	NextPageURL string `json:"next_page_url" api:"required"`
	// URL to fetch the previous page, `null` if on the first page.
	PreviousPageURL string `json:"previous_page_url" api:"required"`
	// JSON contains metadata for fields, check presence with [respjson.Field.Valid].
	JSON struct {
		HasNextPage     respjson.Field
		HasPrevPage     respjson.Field
		NextPageURL     respjson.Field
		PreviousPageURL respjson.Field
		ExtraFields     map[string]respjson.Field
		// contains filtered or unexported fields
	} `json:"-"`
}

PageInfo contains URL-based pagination metadata.

func (PageInfo) RawJSON 

func (r PageInfo) RawJSON() string

Returns the unmodified JSON received from the API

func (*PageInfo) UnmarshalJSON 

func (r *PageInfo) UnmarshalJSON(data []byte) error

type Part 

type Part struct {
	// Part ID.
	ID string `json:"id" api:"required"`
	// Creation timestamp.
	CreatedAt time.Time `json:"created_at" api:"required" format:"date-time"`
	// Item is an inventory item (product, material, or part).
	Item Item `json:"item" api:"required"`
	// Resource type identifier.
	//
	// Any of "part".
	Object PartObject `json:"object" api:"required"`
	// Last updated timestamp.
	UpdatedAt time.Time `json:"updated_at" api:"required" format:"date-time"`
	// JSON contains metadata for fields, check presence with [respjson.Field.Valid].
	JSON struct {
		ID          respjson.Field
		CreatedAt   respjson.Field
		Item        respjson.Field
		Object      respjson.Field
		UpdatedAt   respjson.Field
		ExtraFields map[string]respjson.Field
		// contains filtered or unexported fields
	} `json:"-"`
}

Part resource.

func (Part) RawJSON 

func (r Part) RawJSON() string

Returns the unmodified JSON received from the API

func (*Part) UnmarshalJSON 

func (r *Part) UnmarshalJSON(data []byte) error

type PartObject 

type PartObject string

Resource type identifier. 

const (
	PartObjectPart PartObject = "part"
)

type PaymentTerm 

type PaymentTerm struct {
	// Payment term ID.
	ID string `json:"id" api:"required"`
	// Creation timestamp.
	CreatedAt time.Time `json:"created_at" api:"required" format:"date-time"`
	// Display name.
	Name string `json:"name" api:"required"`
	// Resource type identifier.
	//
	// Any of "payment_term".
	Object PaymentTermObject `json:"object" api:"required"`
	// Owner describes the provenance of a resource.
	Owner Owner `json:"owner" api:"required"`
	// Payment term status.
	//
	// Any of "active", "inactive".
	Status PaymentTermStatus `json:"status" api:"required"`
	// Last-updated timestamp.
	UpdatedAt time.Time `json:"updated_at" api:"required" format:"date-time"`
	// JSON contains metadata for fields, check presence with [respjson.Field.Valid].
	JSON struct {
		ID          respjson.Field
		CreatedAt   respjson.Field
		Name        respjson.Field
		Object      respjson.Field
		Owner       respjson.Field
		Status      respjson.Field
		UpdatedAt   respjson.Field
		ExtraFields map[string]respjson.Field
		// contains filtered or unexported fields
	} `json:"-"`
}

Payment term resource.

func (PaymentTerm) RawJSON 

func (r PaymentTerm) RawJSON() string

Returns the unmodified JSON received from the API

func (*PaymentTerm) UnmarshalJSON 

func (r *PaymentTerm) UnmarshalJSON(data []byte) error

type PaymentTermObject 

type PaymentTermObject string

Resource type identifier. 

const (
	PaymentTermObjectPaymentTerm PaymentTermObject = "payment_term"
)

type PaymentTermStatus 

type PaymentTermStatus string

Payment term status. 

const (
	PaymentTermStatusActive   PaymentTermStatus = "active"
	PaymentTermStatusInactive PaymentTermStatus = "inactive"
)

type Priority 

type Priority struct {
	// Priority ID.
	ID string `json:"id" api:"required"`
	// Machine-readable code.
	//
	// Any of "low", "normal", "high".
	Code PriorityCode `json:"code" api:"required"`
	// Creation timestamp.
	CreatedAt time.Time `json:"created_at" api:"required" format:"date-time"`
	// Display name.
	Name string `json:"name" api:"required"`
	// Resource type identifier.
	//
	// Any of "priority".
	Object PriorityObject `json:"object" api:"required"`
	// Owner describes the provenance of a resource.
	Owner Owner `json:"owner" api:"required"`
	// Last updated timestamp.
	UpdatedAt time.Time `json:"updated_at" api:"required" format:"date-time"`
	// JSON contains metadata for fields, check presence with [respjson.Field.Valid].
	JSON struct {
		ID          respjson.Field
		Code        respjson.Field
		CreatedAt   respjson.Field
		Name        respjson.Field
		Object      respjson.Field
		Owner       respjson.Field
		UpdatedAt   respjson.Field
		ExtraFields map[string]respjson.Field
		// contains filtered or unexported fields
	} `json:"-"`
}

Priority level used by sales orders and picks.

func (Priority) RawJSON 

func (r Priority) RawJSON() string

Returns the unmodified JSON received from the API

func (*Priority) UnmarshalJSON 

func (r *Priority) UnmarshalJSON(data []byte) error

type PriorityCode 

type PriorityCode string

Machine-readable code. 

const (
	PriorityCodeLow    PriorityCode = "low"
	PriorityCodeNormal PriorityCode = "normal"
	PriorityCodeHigh   PriorityCode = "high"
)

type PriorityObject 

type PriorityObject string

Resource type identifier. 

const (
	PriorityObjectPriority PriorityObject = "priority"
)

type Product 

type Product struct {
	// Product ID.
	ID string `json:"id" api:"required"`
	// Creation timestamp.
	CreatedAt time.Time `json:"created_at" api:"required" format:"date-time"`
	// Item is an inventory item (product, material, or part).
	Item Item `json:"item" api:"required"`
	// Resource type identifier.
	//
	// Any of "product".
	Object ProductObject `json:"object" api:"required"`
	// Product portal visibility.
	//
	// Any of "visible", "hidden".
	PortalVisibility ProductPortalVisibility `json:"portal_visibility" api:"required"`
	// Product line resource.
	ProductLine ProductLine `json:"product_line" api:"required"`
	// Product type code.
	//
	// Any of "sale", "service", "shipping", "credit", "return", "tax".
	Type ProductType `json:"type" api:"required"`
	// Last updated timestamp.
	UpdatedAt time.Time `json:"updated_at" api:"required" format:"date-time"`
	// JSON contains metadata for fields, check presence with [respjson.Field.Valid].
	JSON struct {
		ID               respjson.Field
		CreatedAt        respjson.Field
		Item             respjson.Field
		Object           respjson.Field
		PortalVisibility respjson.Field
		ProductLine      respjson.Field
		Type             respjson.Field
		UpdatedAt        respjson.Field
		ExtraFields      map[string]respjson.Field
		// contains filtered or unexported fields
	} `json:"-"`
}

Product with expandable item, product line, and product type.

func (Product) RawJSON 

func (r Product) RawJSON() string

Returns the unmodified JSON received from the API

func (*Product) UnmarshalJSON 

func (r *Product) UnmarshalJSON(data []byte) error

type ProductLine 

type ProductLine struct {
	// Product line ID.
	ID string `json:"id" api:"required"`
	// Commission policy of products in this product line.
	//
	// Any of "commission_applied", "commission_exempt".
	CommissionPolicy ProductLineCommissionPolicy `json:"commission_policy" api:"required"`
	// Creation timestamp.
	CreatedAt time.Time `json:"created_at" api:"required" format:"date-time"`
	// Description.
	Description string `json:"description" api:"required"`
	// Freight policy for all items in this product line.
	//
	// Any of "free_freight", "billed_freight".
	FreightPolicy ProductLineFreightPolicy `json:"freight_policy" api:"required"`
	// Display name.
	Name string `json:"name" api:"required"`
	// Notes.
	Notes string `json:"notes" api:"required"`
	// Resource type identifier.
	//
	// Any of "product_line".
	Object ProductLineObject `json:"object" api:"required"`
	// Owner describes the provenance of a resource.
	Owner Owner `json:"owner" api:"required"`
	// UnitGroup is a unit group resource.
	UnitGroup UnitGroup `json:"unit_group" api:"required"`
	// Last-updated timestamp.
	UpdatedAt time.Time `json:"updated_at" api:"required" format:"date-time"`
	// JSON contains metadata for fields, check presence with [respjson.Field.Valid].
	JSON struct {
		ID               respjson.Field
		CommissionPolicy respjson.Field
		CreatedAt        respjson.Field
		Description      respjson.Field
		FreightPolicy    respjson.Field
		Name             respjson.Field
		Notes            respjson.Field
		Object           respjson.Field
		Owner            respjson.Field
		UnitGroup        respjson.Field
		UpdatedAt        respjson.Field
		ExtraFields      map[string]respjson.Field
		// contains filtered or unexported fields
	} `json:"-"`
}

Product line resource.

func (ProductLine) RawJSON 

func (r ProductLine) RawJSON() string

Returns the unmodified JSON received from the API

func (*ProductLine) UnmarshalJSON 

func (r *ProductLine) UnmarshalJSON(data []byte) error

type ProductLineCommissionPolicy 

type ProductLineCommissionPolicy string

Commission policy of products in this product line. 

const (
	ProductLineCommissionPolicyCommissionApplied ProductLineCommissionPolicy = "commission_applied"
	ProductLineCommissionPolicyCommissionExempt  ProductLineCommissionPolicy = "commission_exempt"
)

type ProductLineFreightPolicy 

type ProductLineFreightPolicy string

Freight policy for all items in this product line. 

const (
	ProductLineFreightPolicyFreeFreight   ProductLineFreightPolicy = "free_freight"
	ProductLineFreightPolicyBilledFreight ProductLineFreightPolicy = "billed_freight"
)

type ProductLineObject 

type ProductLineObject string

Resource type identifier. 

const (
	ProductLineObjectProductLine ProductLineObject = "product_line"
)

type ProductObject 

type ProductObject string

Resource type identifier. 

const (
	ProductObjectProduct ProductObject = "product"
)

type ProductPortalVisibility 

type ProductPortalVisibility string

Product portal visibility. 

const (
	ProductPortalVisibilityVisible ProductPortalVisibility = "visible"
	ProductPortalVisibilityHidden  ProductPortalVisibility = "hidden"
)

type ProductType 

type ProductType string

Product type code. 

const (
	ProductTypeSale     ProductType = "sale"
	ProductTypeService  ProductType = "service"
	ProductTypeShipping ProductType = "shipping"
	ProductTypeCredit   ProductType = "credit"
	ProductTypeReturn   ProductType = "return"
	ProductTypeTax      ProductType = "tax"
)

type ProductionOutput 

type ProductionOutput struct {
	// Production ID.
	ID string `json:"id" api:"required"`
	// Creation timestamp.
	CreatedAt time.Time `json:"created_at" api:"required" format:"date-time"`
	// Resource type identifier.
	//
	// Any of "production".
	Object ProductionOutputObject `json:"object" api:"required"`
	// Item is an inventory item (product, material, or part).
	ProducedItem Item `json:"produced_item" api:"required"`
	// Value with an associated unit.
	Quantity Quantity `json:"quantity" api:"required"`
	// Last updated timestamp.
	UpdatedAt time.Time `json:"updated_at" api:"required" format:"date-time"`
	// JSON contains metadata for fields, check presence with [respjson.Field.Valid].
	JSON struct {
		ID           respjson.Field
		CreatedAt    respjson.Field
		Object       respjson.Field
		ProducedItem respjson.Field
		Quantity     respjson.Field
		UpdatedAt    respjson.Field
		ExtraFields  map[string]respjson.Field
		// contains filtered or unexported fields
	} `json:"-"`
}

Production output of a production step.

func (ProductionOutput) RawJSON 

func (r ProductionOutput) RawJSON() string

Returns the unmodified JSON received from the API

func (*ProductionOutput) UnmarshalJSON 

func (r *ProductionOutput) UnmarshalJSON(data []byte) error

type ProductionOutputObject 

type ProductionOutputObject string

Resource type identifier. 

const (
	ProductionOutputObjectProduction ProductionOutputObject = "production"
)

type ProductionStep 

type ProductionStep struct {
	// Production step ID.
	ID string `json:"id" api:"required"`
	// Allowances as a decimal string.
	Allowances string `json:"allowances" api:"required" format:"decimal"`
	// List represents a paginated list of resources.
	Consumptions ListConsumption `json:"consumptions" api:"required"`
	// Creation timestamp.
	CreatedAt time.Time `json:"created_at" api:"required" format:"date-time"`
	// Department resource.
	Department *Department `json:"department" api:"required"`
	// List represents a paginated list of resources.
	InSteps *ListProductionStep `json:"in_steps" api:"required"`
	// Rate resource.
	LaborRate Rate `json:"labor_rate" api:"required"`
	// Rate resource.
	LaborTime Rate `json:"labor_time" api:"required"`
	// Leveling factor as a decimal string.
	LevelingFactor string `json:"leveling_factor" api:"required" format:"decimal"`
	// List represents a paginated list of resources.
	Machines *ListMachine `json:"machines" api:"required"`
	// Display name.
	Name string `json:"name" api:"required"`
	// Notes.
	Notes string `json:"notes" api:"required"`
	// Resource type identifier.
	//
	// Any of "production_step".
	Object ProductionStepObject `json:"object" api:"required"`
	// List represents a paginated list of resources.
	OutSteps *ListProductionStep `json:"out_steps" api:"required"`
	// Rate resource.
	OverheadRate Rate `json:"overhead_rate" api:"required"`
	// Production output of a production step.
	Production ProductionOutput `json:"production" api:"required"`
	// Scanning station resource.
	ScanningStation *ScanningStation `json:"scanning_station" api:"required"`
	// Last updated timestamp.
	UpdatedAt time.Time `json:"updated_at" api:"required" format:"date-time"`
	// JSON contains metadata for fields, check presence with [respjson.Field.Valid].
	JSON struct {
		ID              respjson.Field
		Allowances      respjson.Field
		Consumptions    respjson.Field
		CreatedAt       respjson.Field
		Department      respjson.Field
		InSteps         respjson.Field
		LaborRate       respjson.Field
		LaborTime       respjson.Field
		LevelingFactor  respjson.Field
		Machines        respjson.Field
		Name            respjson.Field
		Notes           respjson.Field
		Object          respjson.Field
		OutSteps        respjson.Field
		OverheadRate    respjson.Field
		Production      respjson.Field
		ScanningStation respjson.Field
		UpdatedAt       respjson.Field
		ExtraFields     map[string]respjson.Field
		// contains filtered or unexported fields
	} `json:"-"`
}

Production step with all nested data.

func (ProductionStep) RawJSON 

func (r ProductionStep) RawJSON() string

Returns the unmodified JSON received from the API

func (*ProductionStep) UnmarshalJSON 

func (r *ProductionStep) UnmarshalJSON(data []byte) error

type ProductionStepObject 

type ProductionStepObject string

Resource type identifier. 

const (
	ProductionStepObjectProductionStep ProductionStepObject = "production_step"
)

type Property 

type Property struct {
	// Property ID.
	ID string `json:"id" api:"required"`
	// List represents a paginated list of resources.
	Attributes *ListAttribute `json:"attributes" api:"required"`
	// Creation timestamp.
	CreatedAt time.Time `json:"created_at" api:"required" format:"date-time"`
	// Display name.
	Name string `json:"name" api:"required"`
	// Resource type identifier.
	//
	// Any of "property".
	Object PropertyObject `json:"object" api:"required"`
	// Last update timestamp.
	UpdatedAt time.Time `json:"updated_at" api:"required" format:"date-time"`
	// JSON contains metadata for fields, check presence with [respjson.Field.Valid].
	JSON struct {
		ID          respjson.Field
		Attributes  respjson.Field
		CreatedAt   respjson.Field
		Name        respjson.Field
		Object      respjson.Field
		UpdatedAt   respjson.Field
		ExtraFields map[string]respjson.Field
		// contains filtered or unexported fields
	} `json:"-"`
}

Property that groups attributes.

func (Property) RawJSON 

func (r Property) RawJSON() string

Returns the unmodified JSON received from the API

func (*Property) UnmarshalJSON 

func (r *Property) UnmarshalJSON(data []byte) error

type PropertyObject 

type PropertyObject string

Resource type identifier. 

const (
	PropertyObjectProperty PropertyObject = "property"
)

type Quantity 

type Quantity struct {
	// Quantity ID.
	ID string `json:"id" api:"required"`
	// Formatted value with unit abbreviation (e.g. "$1,234.56" or "100 kg").
	DisplayValue string `json:"display_value" api:"required"`
	// Resource type identifier.
	//
	// Any of "quantity".
	Object QuantityObject `json:"object" api:"required"`
	// Unit of measurement used for conversions and product quantities.
	Unit Unit `json:"unit" api:"required"`
	// Decimal value.
	Value string `json:"value" api:"required" format:"decimal"`
	// JSON contains metadata for fields, check presence with [respjson.Field.Valid].
	JSON struct {
		ID           respjson.Field
		DisplayValue respjson.Field
		Object       respjson.Field
		Unit         respjson.Field
		Value        respjson.Field
		ExtraFields  map[string]respjson.Field
		// contains filtered or unexported fields
	} `json:"-"`
}

Value with an associated unit.

func (Quantity) RawJSON 

func (r Quantity) RawJSON() string

Returns the unmodified JSON received from the API

func (*Quantity) UnmarshalJSON 

func (r *Quantity) UnmarshalJSON(data []byte) error

type QuantityInputParam 

type QuantityInputParam struct {
	// The unit ID for the value.
	UnitID string `json:"unit_id" api:"required"`
	// The decimal value.
	Value string `json:"value" api:"required" format:"decimal"`
	// contains filtered or unexported fields
}

QuantityInput represents a value with an associated unit for create/update requests.

The properties UnitID, Value are required.

func (QuantityInputParam) MarshalJSON 

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

func (*QuantityInputParam) UnmarshalJSON 

func (r *QuantityInputParam) UnmarshalJSON(data []byte) error

type QuantityInputRequestParam 

type QuantityInputRequestParam struct {
	// Unit ID.
	UnitID string `json:"unit_id" api:"required"`
	// Quantity value.
	Value string `json:"value" api:"required"`
	// contains filtered or unexported fields
}

QuantityInputRequest is a quantity value and unit.

The properties UnitID, Value are required.

func (QuantityInputRequestParam) MarshalJSON 

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

func (*QuantityInputRequestParam) UnmarshalJSON 

func (r *QuantityInputRequestParam) UnmarshalJSON(data []byte) error

type QuantityObject 

type QuantityObject string

Resource type identifier. 

const (
	QuantityObjectQuantity QuantityObject = "quantity"
)

type Rate 

type Rate struct {
	// Rate ID.
	ID string `json:"id" api:"required"`
	// Creation timestamp.
	CreatedAt time.Time `json:"created_at" api:"required" format:"date-time"`
	// Unit of measurement used for conversions and product quantities.
	DenominatorUnit Unit `json:"denominator_unit" api:"required"`
	// Human-readable formatted value (e.g. "$25.50 / kg" or "100 kg / hr").
	DisplayValue string `json:"display_value" api:"required"`
	// Unit of measurement used for conversions and product quantities.
	NumeratorUnit Unit `json:"numerator_unit" api:"required"`
	// Resource type identifier.
	//
	// Any of "rate".
	Object RateObject `json:"object" api:"required"`
	// Last updated timestamp.
	UpdatedAt time.Time `json:"updated_at" api:"required" format:"date-time"`
	// Rate value as a decimal string.
	Value string `json:"value" api:"required" format:"decimal"`
	// JSON contains metadata for fields, check presence with [respjson.Field.Valid].
	JSON struct {
		ID              respjson.Field
		CreatedAt       respjson.Field
		DenominatorUnit respjson.Field
		DisplayValue    respjson.Field
		NumeratorUnit   respjson.Field
		Object          respjson.Field
		UpdatedAt       respjson.Field
		Value           respjson.Field
		ExtraFields     map[string]respjson.Field
		// contains filtered or unexported fields
	} `json:"-"`
}

Rate resource.

func (Rate) RawJSON 

func (r Rate) RawJSON() string

Returns the unmodified JSON received from the API

func (*Rate) UnmarshalJSON 

func (r *Rate) UnmarshalJSON(data []byte) error

type RateInputParam 

type RateInputParam struct {
	// Denominator unit ID.
	DenominatorUnitID string `json:"denominator_unit_id" api:"required"`
	// Numerator unit ID.
	NumeratorUnitID string `json:"numerator_unit_id" api:"required"`
	// Decimal value of the rate.
	Value string `json:"value" api:"required" format:"decimal"`
	// contains filtered or unexported fields
}

RateInput represents the input for creating or updating a rate.

The properties DenominatorUnitID, NumeratorUnitID, Value are required.

func (RateInputParam) MarshalJSON 

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

func (*RateInputParam) UnmarshalJSON 

func (r *RateInputParam) UnmarshalJSON(data []byte) error

type RateObject 

type RateObject string

Resource type identifier. 

const (
	RateObjectRate RateObject = "rate"
)

type RequestLog 

type RequestLog struct {
	// Request log ID.
	ID string `json:"id" api:"required"`
	// Account with optional branding and portal sub-resources.
	Account Account `json:"account" api:"required"`
	// Reference to an actor (user, API key, or agent).
	Actor Actor `json:"actor" api:"required"`
	// API version used.
	APIVersion string `json:"api_version" api:"required"`
	// Client IP address.
	ClientIP string `json:"client_ip" api:"required"`
	// When the log entry was created.
	CreatedAt time.Time `json:"created_at" api:"required" format:"date-time"`
	// API error code.
	ErrorCode string `json:"error_code" api:"required"`
	// Error message.
	ErrorMessage string `json:"error_message" api:"required"`
	// Request host. Usually `api.augno.com`.
	Host string `json:"host" api:"required"`
	// User-provided idempotency key.
	IdempotencyKey string `json:"idempotency_key" api:"required"`
	// Request latency in microseconds.
	LatencyUs int64 `json:"latency_us" api:"required"`
	// HTTP method.
	Method string `json:"method" api:"required"`
	// _Normalized_ route template. For example `PATCH /v1/sales/customers/{id}` is the
	// normalized route for a request route `PUT /v1/sales/customers/ac_...`.
	NormalizedRoute string `json:"normalized_route" api:"required"`
	// Resource type identifier.
	//
	// Any of "request_log".
	Object RequestLogObject `json:"object" api:"required"`
	// When the request occurred.
	OccurredAt time.Time `json:"occurred_at" api:"required" format:"date-time"`
	// Non-normalized request path.
	Path string `json:"path" api:"required"`
	// Query parameters. Encoded as a JSON value (object, array, string, number,
	// boolean, or null), not a JSON-encoded string.
	QueryParams any `json:"query_params" api:"required"`
	// Referrer header.
	Referrer string `json:"referrer" api:"required"`
	// Request body. Encoded as a JSON value (object, array, string, number, boolean,
	// or null), not a JSON-encoded string.
	RequestBody any `json:"request_body" api:"required"`
	// Response body. Encoded as a JSON value (object, array, string, number, boolean,
	// or null), not a JSON-encoded string.
	ResponseBody any `json:"response_body" api:"required"`
	// HTTP status code. Exception to the `status` naming convention: this is a numeric
	// HTTP response code (200/404/…), not a domain lifecycle status enum, so the
	// `_code` suffix is meaningful.
	StatusCode int64 `json:"status_code" api:"required"`
	// User agent.
	UserAgent string `json:"user_agent" api:"required"`
	// JSON contains metadata for fields, check presence with [respjson.Field.Valid].
	JSON struct {
		ID              respjson.Field
		Account         respjson.Field
		Actor           respjson.Field
		APIVersion      respjson.Field
		ClientIP        respjson.Field
		CreatedAt       respjson.Field
		ErrorCode       respjson.Field
		ErrorMessage    respjson.Field
		Host            respjson.Field
		IdempotencyKey  respjson.Field
		LatencyUs       respjson.Field
		Method          respjson.Field
		NormalizedRoute respjson.Field
		Object          respjson.Field
		OccurredAt      respjson.Field
		Path            respjson.Field
		QueryParams     respjson.Field
		Referrer        respjson.Field
		RequestBody     respjson.Field
		ResponseBody    respjson.Field
		StatusCode      respjson.Field
		UserAgent       respjson.Field
		ExtraFields     map[string]respjson.Field
		// contains filtered or unexported fields
	} `json:"-"`
}

RequestLog is an API request log entry.

func (RequestLog) RawJSON 

func (r RequestLog) RawJSON() string

Returns the unmodified JSON received from the API

func (*RequestLog) UnmarshalJSON 

func (r *RequestLog) UnmarshalJSON(data []byte) error

type RequestLogObject 

type RequestLogObject string

Resource type identifier. 

const (
	RequestLogObjectRequestLog RequestLogObject = "request_log"
)

type Role 

type Role struct {
	// Role ID.
	ID string `json:"id" api:"required"`
	// Creation timestamp.
	CreatedAt time.Time `json:"created_at" api:"required" format:"date-time"`
	// Display name.
	Name string `json:"name" api:"required"`
	// Resource type identifier.
	//
	// Any of "role".
	Object RoleObject `json:"object" api:"required"`
	// Owner describes the provenance of a resource.
	Owner Owner `json:"owner" api:"required"`
	// Permissions in `{domain}:{action}` format.
	Permissions []string `json:"permissions" api:"required"`
	// Role type code.
	//
	// The role's type is sometimes used to gate special behaviors in the frontend and
	// to restrict some actions to only certain types of roles. For example, only roles
	// with the type `admin` can create and manage API keys.
	//
	// Any of "admin", "user", "scanner", "sales_rep", "agent".
	Type RoleType `json:"type" api:"required"`
	// Last updated timestamp.
	UpdatedAt time.Time `json:"updated_at" api:"required" format:"date-time"`
	// JSON contains metadata for fields, check presence with [respjson.Field.Valid].
	JSON struct {
		ID          respjson.Field
		CreatedAt   respjson.Field
		Name        respjson.Field
		Object      respjson.Field
		Owner       respjson.Field
		Permissions respjson.Field
		Type        respjson.Field
		UpdatedAt   respjson.Field
		ExtraFields map[string]respjson.Field
		// contains filtered or unexported fields
	} `json:"-"`
}

Role resource.

func (Role) RawJSON 

func (r Role) RawJSON() string

Returns the unmodified JSON received from the API

func (*Role) UnmarshalJSON 

func (r *Role) UnmarshalJSON(data []byte) error

type RoleObject 

type RoleObject string

Resource type identifier. 

const (
	RoleObjectRole RoleObject = "role"
)

type RoleType 

type RoleType string

Role type code.

The role's type is sometimes used to gate special behaviors in the frontend and to restrict some actions to only certain types of roles. For example, only roles with the type `admin` can create and manage API keys. 

const (
	RoleTypeAdmin    RoleType = "admin"
	RoleTypeUser     RoleType = "user"
	RoleTypeScanner  RoleType = "scanner"
	RoleTypeSalesRep RoleType = "sales_rep"
	RoleTypeAgent    RoleType = "agent"
)

type RotateAPIKeyRequestParam 

type RotateAPIKeyRequestParam struct {
	// Expiration timestamp override for the new key.
	//
	// If omitted, the previous key's expiration is used.
	ExpiresAt param.Opt[time.Time] `json:"expires_at,omitzero" format:"date-time"`
	// When to revoke the old key.
	//
	// If omitted, the old key is revoked immediately. A future timestamp schedules
	// revocation (keeping the old key valid until then) up to a maximum of 30 days
	// out.
	RevokeAt param.Opt[time.Time] `json:"revoke_at,omitzero" format:"date-time"`
	// contains filtered or unexported fields
}

Request to rotate an API key.

func (RotateAPIKeyRequestParam) MarshalJSON 

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

func (*RotateAPIKeyRequestParam) UnmarshalJSON 

func (r *RotateAPIKeyRequestParam) UnmarshalJSON(data []byte) error

type SaleAccountGroupDeleteResponse 

type SaleAccountGroupDeleteResponse struct {
	// JSON contains metadata for fields, check presence with [respjson.Field.Valid].
	JSON struct {
		ExtraFields map[string]respjson.Field
		// contains filtered or unexported fields
	} `json:"-"`
}

func (SaleAccountGroupDeleteResponse) RawJSON 

func (r SaleAccountGroupDeleteResponse) RawJSON() string

Returns the unmodified JSON received from the API

func (*SaleAccountGroupDeleteResponse) UnmarshalJSON 

func (r *SaleAccountGroupDeleteResponse) UnmarshalJSON(data []byte) error

type SaleAccountGroupListParams 

type SaleAccountGroupListParams struct {
	// Cursor token used to retrieve the next or previous page of results.
	Cursor param.Opt[string] `query:"cursor,omitzero" json:"-"`
	// Maximum number of results per page (default: 100, max: 1000).
	Limit param.Opt[int64] `query:"limit,omitzero" json:"-"`
	// Search query used to filter results.
	Q param.Opt[string] `query:"q,omitzero" json:"-"`
	// Account group type filter.
	//
	// Any of "pricing_group", "type_group".
	Type SaleAccountGroupListParamsType `query:"type,omitzero" json:"-"`
	// contains filtered or unexported fields
}

func (SaleAccountGroupListParams) URLQuery 

func (r SaleAccountGroupListParams) URLQuery() (v url.Values, err error)

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

type SaleAccountGroupListParamsType 

type SaleAccountGroupListParamsType string

Account group type filter. 

const (
	SaleAccountGroupListParamsTypePricingGroup SaleAccountGroupListParamsType = "pricing_group"
	SaleAccountGroupListParamsTypeTypeGroup    SaleAccountGroupListParamsType = "type_group"
)

type SaleAccountGroupNewParams 

type SaleAccountGroupNewParams struct {
	// Request to create an account group.
	CreateAccountGroupRequest CreateAccountGroupRequestParam
	// contains filtered or unexported fields
}

func (SaleAccountGroupNewParams) MarshalJSON 

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

func (*SaleAccountGroupNewParams) UnmarshalJSON 

func (r *SaleAccountGroupNewParams) UnmarshalJSON(data []byte) error

type SaleAccountGroupService 

type SaleAccountGroupService struct {
	// contains filtered or unexported fields
}

List and manage account groups.

SaleAccountGroupService contains methods and other services that help with interacting with the augno 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 NewSaleAccountGroupService method instead.

func NewSaleAccountGroupService 

func NewSaleAccountGroupService(opts ...option.RequestOption) (r SaleAccountGroupService)

NewSaleAccountGroupService 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 (*SaleAccountGroupService) Delete 

func (r *SaleAccountGroupService) Delete(ctx context.Context, id string, opts ...option.RequestOption) (res *SaleAccountGroupDeleteResponse, err error)

Deletes an account group. Fails if the account group is actively used in production.

func (*SaleAccountGroupService) Get 

func (r *SaleAccountGroupService) Get(ctx context.Context, id string, opts ...option.RequestOption) (res *AccountGroup, err error)

Returns an account group by ID.

func (*SaleAccountGroupService) List 

func (r *SaleAccountGroupService) List(ctx context.Context, query SaleAccountGroupListParams, opts ...option.RequestOption) (res *ListAccountGroup, err error)

Returns a paginated list of account groups.

func (*SaleAccountGroupService) New 

func (r *SaleAccountGroupService) New(ctx context.Context, body SaleAccountGroupNewParams, opts ...option.RequestOption) (res *AccountGroup, err error)

Creates an account group.

func (*SaleAccountGroupService) Update 

func (r *SaleAccountGroupService) Update(ctx context.Context, id string, body SaleAccountGroupUpdateParams, opts ...option.RequestOption) (res *AccountGroup, err error)

Partially updates an account group.

type SaleAccountGroupUpdateParams 

type SaleAccountGroupUpdateParams struct {
	// Request to partially update an account group.
	UpdateAccountGroupRequest UpdateAccountGroupRequestParam
	// contains filtered or unexported fields
}

func (SaleAccountGroupUpdateParams) MarshalJSON 

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

func (*SaleAccountGroupUpdateParams) UnmarshalJSON 

func (r *SaleAccountGroupUpdateParams) UnmarshalJSON(data []byte) error

type SaleAccountStatusGetParams 

type SaleAccountStatusGetParams struct {
	// Sub-objects to expand in the response. When omitted, sub-objects are returned as
	// `null`.
	//
	// Any of "owner".
	Include []string `query:"include,omitzero" json:"-"`
	// contains filtered or unexported fields
}

func (SaleAccountStatusGetParams) URLQuery 

func (r SaleAccountStatusGetParams) URLQuery() (v url.Values, err error)

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

type SaleAccountStatusListParams 

type SaleAccountStatusListParams struct {
	// Cursor token used to retrieve the next or previous page of results.
	Cursor param.Opt[string] `query:"cursor,omitzero" json:"-"`
	// Maximum number of results per page (default: 100, max: 1000).
	Limit param.Opt[int64] `query:"limit,omitzero" json:"-"`
	// Search query used to filter results.
	Q param.Opt[string] `query:"q,omitzero" json:"-"`
	// Sub-objects to expand in the response. When omitted, sub-objects are returned as
	// `null`.
	//
	// Any of "owner".
	Include []string `query:"include,omitzero" json:"-"`
	// contains filtered or unexported fields
}

func (SaleAccountStatusListParams) URLQuery 

func (r SaleAccountStatusListParams) URLQuery() (v url.Values, err error)

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

type SaleAccountStatusService 

type SaleAccountStatusService struct {
	// contains filtered or unexported fields
}

List and retrieve account statuses.

SaleAccountStatusService contains methods and other services that help with interacting with the augno 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 NewSaleAccountStatusService method instead.

func NewSaleAccountStatusService 

func NewSaleAccountStatusService(opts ...option.RequestOption) (r SaleAccountStatusService)

NewSaleAccountStatusService 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 (*SaleAccountStatusService) Get 

func (r *SaleAccountStatusService) Get(ctx context.Context, id string, query SaleAccountStatusGetParams, opts ...option.RequestOption) (res *AccountStatus, err error)

Returns an account status by ID or code.

func (*SaleAccountStatusService) List 

func (r *SaleAccountStatusService) List(ctx context.Context, query SaleAccountStatusListParams, opts ...option.RequestOption) (res *ListAccountStatus, err error)

Returns a paginated list of account statuses. Global lookup values for setting account relationship statuses.

type SaleAddressDeleteResponse 

type SaleAddressDeleteResponse struct {
	// JSON contains metadata for fields, check presence with [respjson.Field.Valid].
	JSON struct {
		ExtraFields map[string]respjson.Field
		// contains filtered or unexported fields
	} `json:"-"`
}

func (SaleAddressDeleteResponse) RawJSON 

func (r SaleAddressDeleteResponse) RawJSON() string

Returns the unmodified JSON received from the API

func (*SaleAddressDeleteResponse) UnmarshalJSON 

func (r *SaleAddressDeleteResponse) UnmarshalJSON(data []byte) error

type SaleAddressListParams 

type SaleAddressListParams struct {
	// Cursor token used to retrieve the next or previous page of results.
	Cursor param.Opt[string] `query:"cursor,omitzero" json:"-"`
	// Maximum number of results per page (default: 100, max: 1000).
	Limit param.Opt[int64] `query:"limit,omitzero" json:"-"`
	// Search query used to filter results.
	Q param.Opt[string] `query:"q,omitzero" json:"-"`
	// Filter by address type.
	//
	// Any of "standard", "drop_ship".
	Type SaleAddressListParamsType `query:"type,omitzero" json:"-"`
	// contains filtered or unexported fields
}

func (SaleAddressListParams) URLQuery 

func (r SaleAddressListParams) URLQuery() (v url.Values, err error)

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

type SaleAddressListParamsType 

type SaleAddressListParamsType string

Filter by address type. 

const (
	SaleAddressListParamsTypeStandard SaleAddressListParamsType = "standard"
	SaleAddressListParamsTypeDropShip SaleAddressListParamsType = "drop_ship"
)

type SaleAddressNewParams 

type SaleAddressNewParams struct {
	// Request to create an address.
	AddressInput AddressInputParam
	// contains filtered or unexported fields
}

func (SaleAddressNewParams) MarshalJSON 

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

func (*SaleAddressNewParams) UnmarshalJSON 

func (r *SaleAddressNewParams) UnmarshalJSON(data []byte) error

type SaleAddressService 

type SaleAddressService struct {
	// contains filtered or unexported fields
}

List and manage addresses for accounts.

SaleAddressService contains methods and other services that help with interacting with the augno 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 NewSaleAddressService method instead.

func NewSaleAddressService 

func NewSaleAddressService(opts ...option.RequestOption) (r SaleAddressService)

NewSaleAddressService 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 (*SaleAddressService) Delete 

func (r *SaleAddressService) Delete(ctx context.Context, id string, opts ...option.RequestOption) (res *SaleAddressDeleteResponse, err error)

Deletes an address. Fails if the address is in use as a billing or shipping address on a sales order, invoice, or shipment, or as a default account address.

func (*SaleAddressService) Get 

func (r *SaleAddressService) Get(ctx context.Context, id string, opts ...option.RequestOption) (res *Address, err error)

Retrieves an address by ID.

func (*SaleAddressService) List 

func (r *SaleAddressService) List(ctx context.Context, query SaleAddressListParams, opts ...option.RequestOption) (res *ListAddress, err error)

Returns a paginated list of addresses.

func (*SaleAddressService) New 

func (r *SaleAddressService) New(ctx context.Context, body SaleAddressNewParams, opts ...option.RequestOption) (res *Address, err error)

Creates an address for the targeted account.

func (*SaleAddressService) Update 

func (r *SaleAddressService) Update(ctx context.Context, id string, body SaleAddressUpdateParams, opts ...option.RequestOption) (res *Address, err error)

Partially updates an address.

type SaleAddressUpdateParams 

type SaleAddressUpdateParams struct {
	// Request to partially update an address.
	UpdateAddressRequest UpdateAddressRequestParam
	// contains filtered or unexported fields
}

func (SaleAddressUpdateParams) MarshalJSON 

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

func (*SaleAddressUpdateParams) UnmarshalJSON 

func (r *SaleAddressUpdateParams) UnmarshalJSON(data []byte) error

type SaleCustomerActionMergeParams 

type SaleCustomerActionMergeParams struct {
	// Request to merge source customers into a target customer.
	MergeCustomersRequest MergeCustomersRequestParam
	// Sub-objects to expand in the response. When omitted, sub-objects are returned as
	// `null`.
	//
	// Any of "bill_to_address", "ship_to_address", "type", "parent_account",
	// "freight_preferences.carrier", "freight_preferences.service_level",
	// "defaults.payment_term", "defaults.shipping_term", "defaults.sales_rep",
	// "defaults.sales_rep.user", "defaults.priority", "contact_info",
	// "freight_preferences", "defaults", "notification_preferences", "price_groups",
	// "child_accounts", "credit_limit".
	Include []string `query:"include,omitzero" json:"-"`
	// contains filtered or unexported fields
}

func (SaleCustomerActionMergeParams) MarshalJSON 

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

func (SaleCustomerActionMergeParams) URLQuery 

func (r SaleCustomerActionMergeParams) URLQuery() (v url.Values, err error)

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

func (*SaleCustomerActionMergeParams) UnmarshalJSON 

func (r *SaleCustomerActionMergeParams) UnmarshalJSON(data []byte) error

type SaleCustomerActionService 

type SaleCustomerActionService struct {
	// contains filtered or unexported fields
}

Manage customer accounts.

SaleCustomerActionService contains methods and other services that help with interacting with the augno 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 NewSaleCustomerActionService method instead.

func NewSaleCustomerActionService 

func NewSaleCustomerActionService(opts ...option.RequestOption) (r SaleCustomerActionService)

NewSaleCustomerActionService 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 (*SaleCustomerActionService) Merge 

func (r *SaleCustomerActionService) Merge(ctx context.Context, id string, params SaleCustomerActionMergeParams, opts ...option.RequestOption) (res *Customer, err error)

Merges one or more source customers into a target customer, reassigning all associated records and deleting the source accounts.

type SaleCustomerDeleteResponse 

type SaleCustomerDeleteResponse struct {
	// JSON contains metadata for fields, check presence with [respjson.Field.Valid].
	JSON struct {
		ExtraFields map[string]respjson.Field
		// contains filtered or unexported fields
	} `json:"-"`
}

func (SaleCustomerDeleteResponse) RawJSON 

func (r SaleCustomerDeleteResponse) RawJSON() string

Returns the unmodified JSON received from the API

func (*SaleCustomerDeleteResponse) UnmarshalJSON 

func (r *SaleCustomerDeleteResponse) UnmarshalJSON(data []byte) error

type SaleCustomerGetParams 

type SaleCustomerGetParams struct {
	// Sub-objects to expand in the response. When omitted, sub-objects are returned as
	// `null`.
	//
	// Any of "bill_to_address", "ship_to_address", "type", "parent_account",
	// "freight_preferences.carrier", "freight_preferences.service_level",
	// "defaults.payment_term", "defaults.shipping_term", "defaults.sales_rep",
	// "defaults.sales_rep.user", "defaults.priority", "contact_info",
	// "freight_preferences", "defaults", "notification_preferences", "price_groups",
	// "child_accounts", "credit_limit".
	Include []string `query:"include,omitzero" json:"-"`
	// contains filtered or unexported fields
}

func (SaleCustomerGetParams) URLQuery 

func (r SaleCustomerGetParams) URLQuery() (v url.Values, err error)

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

type SaleCustomerListParams 

type SaleCustomerListParams struct {
	// Filter by city.
	City param.Opt[string] `query:"city,omitzero" json:"-"`
	// Cursor token used to retrieve the next or previous page of results.
	Cursor param.Opt[string] `query:"cursor,omitzero" json:"-"`
	// Filter by end date (created before).
	EndDate param.Opt[time.Time] `query:"end_date,omitzero" format:"date-time" json:"-"`
	// Maximum number of results per page (default: 100, max: 1000).
	Limit param.Opt[int64] `query:"limit,omitzero" json:"-"`
	// Filter by postal code.
	PostalCode param.Opt[string] `query:"postal_code,omitzero" json:"-"`
	// Search query used to filter results.
	Q param.Opt[string] `query:"q,omitzero" json:"-"`
	// Filter by start date (created after).
	StartDate param.Opt[time.Time] `query:"start_date,omitzero" format:"date-time" json:"-"`
	// Filter by state.
	State param.Opt[string] `query:"state,omitzero" json:"-"`
	// Filter by carrier IDs.
	CarrierIDs []string `query:"carrier_ids,omitzero" json:"-"`
	// Filter by commission status codes.
	//
	// Any of "commission_applied", "commission_exempt".
	CommissionStatusCodes []string `query:"commission_status_codes,omitzero" json:"-"`
	// Filter by customer group IDs.
	CustomerGroupIDs []string `query:"customer_group_ids,omitzero" json:"-"`
	// Filter by freight status codes.
	//
	// Any of "free_freight", "billed_freight".
	FreightStatusCodes []string `query:"freight_status_codes,omitzero" json:"-"`
	// Sub-objects to expand in the response. When omitted, sub-objects are returned as
	// `null`.
	//
	// Any of "bill_to_address", "ship_to_address", "type", "parent_account",
	// "freight_preferences.carrier", "freight_preferences.service_level",
	// "defaults.payment_term", "defaults.shipping_term", "defaults.sales_rep",
	// "defaults.sales_rep.user", "defaults.priority", "contact_info",
	// "freight_preferences", "defaults", "notification_preferences", "price_groups",
	// "child_accounts", "credit_limit".
	Include []string `query:"include,omitzero" json:"-"`
	// Filter by whether the customer has child accounts.
	//
	// Any of "parent", "non_parent".
	ParentAccountStatus SaleCustomerListParamsParentAccountStatus `query:"parent_account_status,omitzero" json:"-"`
	// Filter by payment term IDs.
	PaymentTermIDs []string `query:"payment_term_ids,omitzero" json:"-"`
	// Filter by pricing group IDs.
	PricingGroupIDs []string `query:"pricing_group_ids,omitzero" json:"-"`
	// Filter by sales rep IDs.
	SalesRepIDs []string `query:"sales_rep_ids,omitzero" json:"-"`
	// Filter by service level IDs.
	ServiceLevelIDs []string `query:"service_level_ids,omitzero" json:"-"`
	// Filter by shipping term IDs.
	ShippingTermIDs []string `query:"shipping_term_ids,omitzero" json:"-"`
	// Filter by status codes.
	//
	// Any of "normal", "preferred", "hold_shipment", "hold_all".
	StatusCodes []string `query:"status_codes,omitzero" json:"-"`
	// contains filtered or unexported fields
}

func (SaleCustomerListParams) URLQuery 

func (r SaleCustomerListParams) URLQuery() (v url.Values, err error)

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

type SaleCustomerListParamsParentAccountStatus 

type SaleCustomerListParamsParentAccountStatus string

Filter by whether the customer has child accounts. 

const (
	SaleCustomerListParamsParentAccountStatusParent    SaleCustomerListParamsParentAccountStatus = "parent"
	SaleCustomerListParamsParentAccountStatusNonParent SaleCustomerListParamsParentAccountStatus = "non_parent"
)

type SaleCustomerNewParams 

type SaleCustomerNewParams struct {
	// Request to create a customer.
	CreateCustomerRequest CreateCustomerRequestParam
	// Sub-objects to expand in the response. When omitted, sub-objects are returned as
	// `null`.
	//
	// Any of "bill_to_address", "ship_to_address", "type", "parent_account",
	// "freight_preferences.carrier", "freight_preferences.service_level",
	// "defaults.payment_term", "defaults.shipping_term", "defaults.sales_rep",
	// "defaults.sales_rep.user", "defaults.priority", "contact_info",
	// "freight_preferences", "defaults", "notification_preferences", "price_groups",
	// "child_accounts", "credit_limit".
	Include []string `query:"include,omitzero" json:"-"`
	// contains filtered or unexported fields
}

func (SaleCustomerNewParams) MarshalJSON 

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

func (SaleCustomerNewParams) URLQuery 

func (r SaleCustomerNewParams) URLQuery() (v url.Values, err error)

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

func (*SaleCustomerNewParams) UnmarshalJSON 

func (r *SaleCustomerNewParams) UnmarshalJSON(data []byte) error

type SaleCustomerService 

type SaleCustomerService struct {

	// Manage customer accounts.
	Actions SaleCustomerActionService
	// contains filtered or unexported fields
}

Manage customer accounts.

SaleCustomerService contains methods and other services that help with interacting with the augno 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 NewSaleCustomerService method instead.

func NewSaleCustomerService 

func NewSaleCustomerService(opts ...option.RequestOption) (r SaleCustomerService)

NewSaleCustomerService 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 (*SaleCustomerService) Delete 

func (r *SaleCustomerService) Delete(ctx context.Context, id string, opts ...option.RequestOption) (res *SaleCustomerDeleteResponse, err error)

Deletes a customer and associated account relations, addresses, and account users.

func (*SaleCustomerService) Get 

func (r *SaleCustomerService) Get(ctx context.Context, id string, query SaleCustomerGetParams, opts ...option.RequestOption) (res *Customer, err error)

Returns a customer by ID.

func (*SaleCustomerService) List 

func (r *SaleCustomerService) List(ctx context.Context, query SaleCustomerListParams, opts ...option.RequestOption) (res *ListCustomer, err error)

Returns a paginated list of customers for the current account.

func (*SaleCustomerService) New 

func (r *SaleCustomerService) New(ctx context.Context, params SaleCustomerNewParams, opts ...option.RequestOption) (res *Customer, err error)

Creates a customer account. Auto-generates a customer number if one is not provided.

func (*SaleCustomerService) Update 

func (r *SaleCustomerService) Update(ctx context.Context, id string, params SaleCustomerUpdateParams, opts ...option.RequestOption) (res *Customer, err error)

Partially updates a customer account. When a Stripe integration is active, customer changes are synced to Stripe.

type SaleCustomerUpdateParams 

type SaleCustomerUpdateParams struct {
	// Sub-objects to expand in the response. When omitted, sub-objects are returned as
	// `null`.
	//
	// Any of "bill_to_address", "ship_to_address", "type", "parent_account",
	// "freight_preferences.carrier", "freight_preferences.service_level",
	// "defaults.payment_term", "defaults.shipping_term", "defaults.sales_rep",
	// "defaults.sales_rep.user", "defaults.priority", "contact_info",
	// "freight_preferences", "defaults", "notification_preferences", "price_groups",
	// "child_accounts", "credit_limit".
	Include []string `query:"include,omitzero" json:"-"`
	// Request to partially update a customer.
	UpdateCustomerRequest UpdateCustomerRequestParam
	// contains filtered or unexported fields
}

func (SaleCustomerUpdateParams) MarshalJSON 

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

func (SaleCustomerUpdateParams) URLQuery 

func (r SaleCustomerUpdateParams) URLQuery() (v url.Values, err error)

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

func (*SaleCustomerUpdateParams) UnmarshalJSON 

func (r *SaleCustomerUpdateParams) UnmarshalJSON(data []byte) error

type SalePriorityGetParams 

type SalePriorityGetParams struct {
	// Sub-objects to expand in the response. When omitted, sub-objects are returned as
	// `null`.
	//
	// Any of "owner".
	Include []string `query:"include,omitzero" json:"-"`
	// contains filtered or unexported fields
}

func (SalePriorityGetParams) URLQuery 

func (r SalePriorityGetParams) URLQuery() (v url.Values, err error)

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

type SalePriorityListParams 

type SalePriorityListParams struct {
	// Cursor token used to retrieve the next or previous page of results.
	Cursor param.Opt[string] `query:"cursor,omitzero" json:"-"`
	// Maximum number of results per page (default: 100, max: 1000).
	Limit param.Opt[int64] `query:"limit,omitzero" json:"-"`
	// Search query used to filter results.
	Q param.Opt[string] `query:"q,omitzero" json:"-"`
	// Sub-objects to expand in the response. When omitted, sub-objects are returned as
	// `null`.
	//
	// Any of "owner".
	Include []string `query:"include,omitzero" json:"-"`
	// contains filtered or unexported fields
}

func (SalePriorityListParams) URLQuery 

func (r SalePriorityListParams) URLQuery() (v url.Values, err error)

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

type SalePriorityService 

type SalePriorityService struct {
	// contains filtered or unexported fields
}

List and retrieve priorities.

SalePriorityService contains methods and other services that help with interacting with the augno 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 NewSalePriorityService method instead.

func NewSalePriorityService 

func NewSalePriorityService(opts ...option.RequestOption) (r SalePriorityService)

NewSalePriorityService 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 (*SalePriorityService) Get 

func (r *SalePriorityService) Get(ctx context.Context, id string, query SalePriorityGetParams, opts ...option.RequestOption) (res *Priority, err error)

Returns a priority by ID or code.

func (*SalePriorityService) List 

func (r *SalePriorityService) List(ctx context.Context, query SalePriorityListParams, opts ...option.RequestOption) (res *ListPriority, err error)

Returns a paginated list of priorities.

type SaleSalesOrderGetStatusesParams 

type SaleSalesOrderGetStatusesParams struct {
	// Cursor token used to retrieve the next or previous page of results.
	Cursor param.Opt[string] `query:"cursor,omitzero" json:"-"`
	// Maximum number of results per page (default: 100, max: 1000).
	Limit param.Opt[int64] `query:"limit,omitzero" json:"-"`
	// Search query used to filter results.
	Q param.Opt[string] `query:"q,omitzero" json:"-"`
	// Sub-objects to expand in the response. When omitted, sub-objects are returned as
	// `null`.
	//
	// Any of "owner".
	Include []string `query:"include,omitzero" json:"-"`
	// contains filtered or unexported fields
}

func (SaleSalesOrderGetStatusesParams) URLQuery 

func (r SaleSalesOrderGetStatusesParams) URLQuery() (v url.Values, err error)

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

type SaleSalesOrderService 

type SaleSalesOrderService struct {
	// contains filtered or unexported fields
}

List sales order statuses.

SaleSalesOrderService contains methods and other services that help with interacting with the augno 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 NewSaleSalesOrderService method instead.

func NewSaleSalesOrderService 

func NewSaleSalesOrderService(opts ...option.RequestOption) (r SaleSalesOrderService)

NewSaleSalesOrderService 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 (*SaleSalesOrderService) GetStatuses 

func (r *SaleSalesOrderService) GetStatuses(ctx context.Context, query SaleSalesOrderGetStatusesParams, opts ...option.RequestOption) (res *ListSalesOrderStatus, err error)

Returns a paginated list of sales order statuses.

type SaleService 

type SaleService struct {

	// List and manage account groups.
	AccountGroups SaleAccountGroupService
	// List and manage addresses for accounts.
	Addresses SaleAddressService
	// List and retrieve account statuses.
	AccountStatuses SaleAccountStatusService
	// List and retrieve priorities.
	Priorities SalePriorityService
	// Manage customer accounts.
	Customers SaleCustomerService
	// List sales order statuses.
	SalesOrders SaleSalesOrderService
	// contains filtered or unexported fields
}

SaleService contains methods and other services that help with interacting with the augno 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 NewSaleService method instead.

func NewSaleService 

func NewSaleService(opts ...option.RequestOption) (r SaleService)

NewSaleService 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.

type SalesOrderStatus 

type SalesOrderStatus struct {
	// Sales order status ID.
	ID string `json:"id" api:"required"`
	// Machine-readable status code.
	//
	// Any of "estimate", "issued", "fulfilled".
	Code SalesOrderStatusCode `json:"code" api:"required"`
	// Creation timestamp.
	CreatedAt time.Time `json:"created_at" api:"required" format:"date-time"`
	// Display name.
	Name string `json:"name" api:"required"`
	// Resource type identifier.
	//
	// Any of "sales_order_status".
	Object SalesOrderStatusObject `json:"object" api:"required"`
	// Owner describes the provenance of a resource.
	Owner Owner `json:"owner" api:"required"`
	// Last updated timestamp.
	UpdatedAt time.Time `json:"updated_at" api:"required" format:"date-time"`
	// JSON contains metadata for fields, check presence with [respjson.Field.Valid].
	JSON struct {
		ID          respjson.Field
		Code        respjson.Field
		CreatedAt   respjson.Field
		Name        respjson.Field
		Object      respjson.Field
		Owner       respjson.Field
		UpdatedAt   respjson.Field
		ExtraFields map[string]respjson.Field
		// contains filtered or unexported fields
	} `json:"-"`
}

Sales order status lookup value.

func (SalesOrderStatus) RawJSON 

func (r SalesOrderStatus) RawJSON() string

Returns the unmodified JSON received from the API

func (*SalesOrderStatus) UnmarshalJSON 

func (r *SalesOrderStatus) UnmarshalJSON(data []byte) error

type SalesOrderStatusCode 

type SalesOrderStatusCode string

Machine-readable status code. 

const (
	SalesOrderStatusCodeEstimate  SalesOrderStatusCode = "estimate"
	SalesOrderStatusCodeIssued    SalesOrderStatusCode = "issued"
	SalesOrderStatusCodeFulfilled SalesOrderStatusCode = "fulfilled"
)

type SalesOrderStatusObject 

type SalesOrderStatusObject string

Resource type identifier. 

const (
	SalesOrderStatusObjectSalesOrderStatus SalesOrderStatusObject = "sales_order_status"
)

type Sandbox 

type Sandbox struct {
	// Sandbox ID.
	ID string `json:"id" api:"required"`
	// When this sandbox was created.
	CreatedAt time.Time `json:"created_at" api:"required" format:"date-time"`
	// Display name.
	Name string `json:"name" api:"required"`
	// Resource type identifier.
	//
	// Any of "sandbox".
	Object SandboxObject `json:"object" api:"required"`
	// Account with optional branding and portal sub-resources.
	OwnerAccount Account `json:"owner_account" api:"required"`
	// When this sandbox was last updated.
	UpdatedAt time.Time `json:"updated_at" api:"required" format:"date-time"`
	// JSON contains metadata for fields, check presence with [respjson.Field.Valid].
	JSON struct {
		ID           respjson.Field
		CreatedAt    respjson.Field
		Name         respjson.Field
		Object       respjson.Field
		OwnerAccount respjson.Field
		UpdatedAt    respjson.Field
		ExtraFields  map[string]respjson.Field
		// contains filtered or unexported fields
	} `json:"-"`
}

Sandbox account for isolated testing.

func (Sandbox) RawJSON 

func (r Sandbox) RawJSON() string

Returns the unmodified JSON received from the API

func (*Sandbox) UnmarshalJSON 

func (r *Sandbox) UnmarshalJSON(data []byte) error

type SandboxObject 

type SandboxObject string

Resource type identifier. 

const (
	SandboxObjectSandbox SandboxObject = "sandbox"
)

type ScanningStation 

type ScanningStation struct {
	// Scanning station ID.
	ID string `json:"id" api:"required"`
	// Creation timestamp.
	CreatedAt time.Time `json:"created_at" api:"required" format:"date-time"`
	// Department resource.
	Department *Department `json:"department" api:"required"`
	// Label size code.
	//
	// Any of "1x1", "1x3", "1x4", "2x4".
	LabelSize ScanningStationLabelSize `json:"label_size" api:"required"`
	// Label type code.
	//
	// Any of "tag", "traveler".
	LabelType ScanningStationLabelType `json:"label_type" api:"required"`
	// Display name.
	Name string `json:"name" api:"required"`
	// Notes.
	Notes string `json:"notes" api:"required"`
	// Resource type identifier.
	//
	// Any of "scanning_station".
	Object ScanningStationObject `json:"object" api:"required"`
	// Operator requirement behavior for this station.
	//
	// Any of "none", "material_check".
	OperatorRequirement ScanningStationOperatorRequirement `json:"operator_requirement" api:"required"`
	// List represents a paginated list of resources.
	ProductionSteps *ListProductionStep `json:"production_steps" api:"required"`
	// Scanning station type.
	//
	// Any of "init_batch", "merge_batch", "move_batch", "split_batch".
	Type ScanningStationType `json:"type" api:"required"`
	// Last updated timestamp.
	UpdatedAt time.Time `json:"updated_at" api:"required" format:"date-time"`
	// JSON contains metadata for fields, check presence with [respjson.Field.Valid].
	JSON struct {
		ID                  respjson.Field
		CreatedAt           respjson.Field
		Department          respjson.Field
		LabelSize           respjson.Field
		LabelType           respjson.Field
		Name                respjson.Field
		Notes               respjson.Field
		Object              respjson.Field
		OperatorRequirement respjson.Field
		ProductionSteps     respjson.Field
		Type                respjson.Field
		UpdatedAt           respjson.Field
		ExtraFields         map[string]respjson.Field
		// contains filtered or unexported fields
	} `json:"-"`
}

Scanning station resource.

func (ScanningStation) RawJSON 

func (r ScanningStation) RawJSON() string

Returns the unmodified JSON received from the API

func (*ScanningStation) UnmarshalJSON 

func (r *ScanningStation) UnmarshalJSON(data []byte) error

type ScanningStationLabelSize 

type ScanningStationLabelSize string

Label size code. 

const (
	ScanningStationLabelSize1x1 ScanningStationLabelSize = "1x1"
	ScanningStationLabelSize1x3 ScanningStationLabelSize = "1x3"
	ScanningStationLabelSize1x4 ScanningStationLabelSize = "1x4"
	ScanningStationLabelSize2x4 ScanningStationLabelSize = "2x4"
)

type ScanningStationLabelType 

type ScanningStationLabelType string

Label type code. 

const (
	ScanningStationLabelTypeTag      ScanningStationLabelType = "tag"
	ScanningStationLabelTypeTraveler ScanningStationLabelType = "traveler"
)

type ScanningStationObject 

type ScanningStationObject string

Resource type identifier. 

const (
	ScanningStationObjectScanningStation ScanningStationObject = "scanning_station"
)

type ScanningStationOperatorRequirement 

type ScanningStationOperatorRequirement string

Operator requirement behavior for this station. 

const (
	ScanningStationOperatorRequirementNone          ScanningStationOperatorRequirement = "none"
	ScanningStationOperatorRequirementMaterialCheck ScanningStationOperatorRequirement = "material_check"
)

type ScanningStationType 

type ScanningStationType string

Scanning station type. 

const (
	ScanningStationTypeInitBatch  ScanningStationType = "init_batch"
	ScanningStationTypeMergeBatch ScanningStationType = "merge_batch"
	ScanningStationTypeMoveBatch  ScanningStationType = "move_batch"
	ScanningStationTypeSplitBatch ScanningStationType = "split_batch"
)

type ServiceLevel 

type ServiceLevel struct {
	// Service level ID.
	ID string `json:"id" api:"required"`
	// Creation timestamp.
	CreatedAt time.Time `json:"created_at" api:"required" format:"date-time"`
	// Customer portal visibility.
	//
	// Any of "visible", "hidden".
	CustomerPortalVisibility ServiceLevelCustomerPortalVisibility `json:"customer_portal_visibility" api:"required"`
	// Default service level for the carrier.
	IsDefault bool `json:"is_default" api:"required"`
	// Display name.
	Name string `json:"name" api:"required"`
	// Resource type identifier.
	//
	// Any of "service_level".
	Object ServiceLevelObject `json:"object" api:"required"`
	// Owner describes the provenance of a resource.
	Owner Owner `json:"owner" api:"required"`
	// Service level token.
	ServiceLevelToken string `json:"service_level_token" api:"required"`
	// Last updated timestamp.
	UpdatedAt time.Time `json:"updated_at" api:"required" format:"date-time"`
	// JSON contains metadata for fields, check presence with [respjson.Field.Valid].
	JSON struct {
		ID                       respjson.Field
		CreatedAt                respjson.Field
		CustomerPortalVisibility respjson.Field
		IsDefault                respjson.Field
		Name                     respjson.Field
		Object                   respjson.Field
		Owner                    respjson.Field
		ServiceLevelToken        respjson.Field
		UpdatedAt                respjson.Field
		ExtraFields              map[string]respjson.Field
		// contains filtered or unexported fields
	} `json:"-"`
}

Shipping service level for a carrier.

func (ServiceLevel) RawJSON 

func (r ServiceLevel) RawJSON() string

Returns the unmodified JSON received from the API

func (*ServiceLevel) UnmarshalJSON 

func (r *ServiceLevel) UnmarshalJSON(data []byte) error

type ServiceLevelCustomerPortalVisibility 

type ServiceLevelCustomerPortalVisibility string

Customer portal visibility. 

const (
	ServiceLevelCustomerPortalVisibilityVisible ServiceLevelCustomerPortalVisibility = "visible"
	ServiceLevelCustomerPortalVisibilityHidden  ServiceLevelCustomerPortalVisibility = "hidden"
)

type ServiceLevelObject 

type ServiceLevelObject string

Resource type identifier. 

const (
	ServiceLevelObjectServiceLevel ServiceLevelObject = "service_level"
)

type ShippingTerm 

type ShippingTerm struct {
	// Shipping term ID.
	ID string `json:"id" api:"required"`
	// When this shipping term was created.
	CreatedAt time.Time `json:"created_at" api:"required" format:"date-time"`
	// Value with an associated unit.
	FlatRate Quantity `json:"flat_rate" api:"required"`
	// List represents a paginated list of resources.
	FreeShippingServiceLevels ListServiceLevel `json:"free_shipping_service_levels" api:"required"`
	// Value with an associated unit.
	MinimumOrderValue Quantity `json:"minimum_order_value" api:"required"`
	// Display name.
	Name string `json:"name" api:"required"`
	// Resource type identifier.
	//
	// Any of "shipping_term".
	Object ShippingTermObject `json:"object" api:"required"`
	// Owner describes the provenance of a resource.
	Owner Owner `json:"owner" api:"required"`
	// Shipping term type.
	//
	// Any of "free_freight", "flat_rate_freight", "carrier_rate_freight".
	Type ShippingTermType `json:"type" api:"required"`
	// When this shipping term was last updated.
	UpdatedAt time.Time `json:"updated_at" api:"required" format:"date-time"`
	// JSON contains metadata for fields, check presence with [respjson.Field.Valid].
	JSON struct {
		ID                        respjson.Field
		CreatedAt                 respjson.Field
		FlatRate                  respjson.Field
		FreeShippingServiceLevels respjson.Field
		MinimumOrderValue         respjson.Field
		Name                      respjson.Field
		Object                    respjson.Field
		Owner                     respjson.Field
		Type                      respjson.Field
		UpdatedAt                 respjson.Field
		ExtraFields               map[string]respjson.Field
		// contains filtered or unexported fields
	} `json:"-"`
}

ShippingTerm resource.

func (ShippingTerm) RawJSON 

func (r ShippingTerm) RawJSON() string

Returns the unmodified JSON received from the API

func (*ShippingTerm) UnmarshalJSON 

func (r *ShippingTerm) UnmarshalJSON(data []byte) error

type ShippingTermObject 

type ShippingTermObject string

Resource type identifier. 

const (
	ShippingTermObjectShippingTerm ShippingTermObject = "shipping_term"
)

type ShippingTermType 

type ShippingTermType string

Shipping term type. 

const (
	ShippingTermTypeFreeFreight        ShippingTermType = "free_freight"
	ShippingTermTypeFlatRateFreight    ShippingTermType = "flat_rate_freight"
	ShippingTermTypeCarrierRateFreight ShippingTermType = "carrier_rate_freight"
)

type TransactionMethod 

type TransactionMethod struct {
	// Transaction method ID.
	ID string `json:"id" api:"required"`
	// Machine-readable code.
	//
	// Any of "cash", "check", "credit_card", "gift_card", "ach".
	Code TransactionMethodCode `json:"code" api:"required"`
	// Display name.
	Name string `json:"name" api:"required"`
	// Resource type identifier.
	//
	// Any of "transaction_method".
	Object TransactionMethodObject `json:"object" api:"required"`
	// JSON contains metadata for fields, check presence with [respjson.Field.Valid].
	JSON struct {
		ID          respjson.Field
		Code        respjson.Field
		Name        respjson.Field
		Object      respjson.Field
		ExtraFields map[string]respjson.Field
		// contains filtered or unexported fields
	} `json:"-"`
}

Transaction method resource.

func (TransactionMethod) RawJSON 

func (r TransactionMethod) RawJSON() string

Returns the unmodified JSON received from the API

func (*TransactionMethod) UnmarshalJSON 

func (r *TransactionMethod) UnmarshalJSON(data []byte) error

type TransactionMethodCode 

type TransactionMethodCode string

Machine-readable code. 

const (
	TransactionMethodCodeCash       TransactionMethodCode = "cash"
	TransactionMethodCodeCheck      TransactionMethodCode = "check"
	TransactionMethodCodeCreditCard TransactionMethodCode = "credit_card"
	TransactionMethodCodeGiftCard   TransactionMethodCode = "gift_card"
	TransactionMethodCodeACH        TransactionMethodCode = "ach"
)

type TransactionMethodObject 

type TransactionMethodObject string

Resource type identifier. 

const (
	TransactionMethodObjectTransactionMethod TransactionMethodObject = "transaction_method"
)

type TransactionType 

type TransactionType struct {
	// Transaction ID.
	ID string `json:"id" api:"required"`
	// Machine-readable code.
	//
	// Any of "payment", "credit_memo", "adjustment", "rebate".
	Code TransactionTypeCode `json:"code" api:"required"`
	// Display name.
	Name string `json:"name" api:"required"`
	// Resource type identifier.
	//
	// Any of "transaction_type".
	Object TransactionTypeObject `json:"object" api:"required"`
	// JSON contains metadata for fields, check presence with [respjson.Field.Valid].
	JSON struct {
		ID          respjson.Field
		Code        respjson.Field
		Name        respjson.Field
		Object      respjson.Field
		ExtraFields map[string]respjson.Field
		// contains filtered or unexported fields
	} `json:"-"`
}

Transaction type resource.

func (TransactionType) RawJSON 

func (r TransactionType) RawJSON() string

Returns the unmodified JSON received from the API

func (*TransactionType) UnmarshalJSON 

func (r *TransactionType) UnmarshalJSON(data []byte) error

type TransactionTypeCode 

type TransactionTypeCode string

Machine-readable code. 

const (
	TransactionTypeCodePayment    TransactionTypeCode = "payment"
	TransactionTypeCodeCreditMemo TransactionTypeCode = "credit_memo"
	TransactionTypeCodeAdjustment TransactionTypeCode = "adjustment"
	TransactionTypeCodeRebate     TransactionTypeCode = "rebate"
)

type TransactionTypeObject 

type TransactionTypeObject string

Resource type identifier. 

const (
	TransactionTypeObjectTransactionType TransactionTypeObject = "transaction_type"
)

type Unit 

type Unit struct {
	// Unit ID.
	ID string `json:"id" api:"required"`
	// Short abbreviation for the unit (e.g. "g", "kg").
	Abbreviation string `json:"abbreviation" api:"required"`
	// When this unit was created.
	CreatedAt time.Time `json:"created_at" api:"required" format:"date-time"`
	// Whether this is the base unit for its dimension. Conversion ratios are relative
	// to this unit.
	IsBaseUnit bool `json:"is_base_unit" api:"required"`
	// Display name of the unit (e.g. "Gram", "Kilogram").
	Name string `json:"name" api:"required"`
	// Resource type identifier.
	//
	// Any of "unit".
	Object UnitObject `json:"object" api:"required"`
	// Conversion offset denominator. Typically 1. Cannot be zero.
	OffsetDenominator string `json:"offset_denominator" api:"required" format:"decimal"`
	// Conversion offset numerator, used for temperature-like conversions. Zero for
	// most unit types.
	OffsetNumerator string `json:"offset_numerator" api:"required" format:"decimal"`
	// Owner describes the provenance of a resource.
	Owner Owner `json:"owner" api:"required"`
	// Conversion ratio denominator relative to the base unit in the same dimension.
	// Cannot be zero.
	RatioDenominator string `json:"ratio_denominator" api:"required" format:"decimal"`
	// Conversion ratio numerator relative to the base unit in the same dimension.
	RatioNumerator string `json:"ratio_numerator" api:"required" format:"decimal"`
	// Unit dimension.
	//
	// Any of "currency", "quantity", "time", "mass", "volume", "length",
	// "temperature", "area".
	Type UnitType `json:"type" api:"required"`
	// When this unit was last updated.
	UpdatedAt time.Time `json:"updated_at" api:"required" format:"date-time"`
	// JSON contains metadata for fields, check presence with [respjson.Field.Valid].
	JSON struct {
		ID                respjson.Field
		Abbreviation      respjson.Field
		CreatedAt         respjson.Field
		IsBaseUnit        respjson.Field
		Name              respjson.Field
		Object            respjson.Field
		OffsetDenominator respjson.Field
		OffsetNumerator   respjson.Field
		Owner             respjson.Field
		RatioDenominator  respjson.Field
		RatioNumerator    respjson.Field
		Type              respjson.Field
		UpdatedAt         respjson.Field
		ExtraFields       map[string]respjson.Field
		// contains filtered or unexported fields
	} `json:"-"`
}

Unit of measurement used for conversions and product quantities.

func (Unit) RawJSON 

func (r Unit) RawJSON() string

Returns the unmodified JSON received from the API

func (*Unit) UnmarshalJSON 

func (r *Unit) UnmarshalJSON(data []byte) error

type UnitGroup 

type UnitGroup struct {
	// Unit group ID.
	ID string `json:"id" api:"required"`
	// List represents a paginated list of resources.
	AssociatedUnits ListUnitGroupUnit `json:"associated_units" api:"required"`
	// Unit of measurement used for conversions and product quantities.
	BaseUnit Unit `json:"base_unit" api:"required"`
	// Creation timestamp.
	CreatedAt time.Time `json:"created_at" api:"required" format:"date-time"`
	// Display name.
	Name string `json:"name" api:"required"`
	// Notes.
	Notes string `json:"notes" api:"required"`
	// Resource type identifier.
	//
	// Any of "unit_group".
	Object UnitGroupObject `json:"object" api:"required"`
	// Owner describes the provenance of a resource.
	Owner Owner `json:"owner" api:"required"`
	// Unit type.
	//
	// Any of "currency", "quantity", "time", "mass", "volume", "length",
	// "temperature", "area".
	Type UnitGroupType `json:"type" api:"required"`
	// Last updated timestamp.
	UpdatedAt time.Time `json:"updated_at" api:"required" format:"date-time"`
	// JSON contains metadata for fields, check presence with [respjson.Field.Valid].
	JSON struct {
		ID              respjson.Field
		AssociatedUnits respjson.Field
		BaseUnit        respjson.Field
		CreatedAt       respjson.Field
		Name            respjson.Field
		Notes           respjson.Field
		Object          respjson.Field
		Owner           respjson.Field
		Type            respjson.Field
		UpdatedAt       respjson.Field
		ExtraFields     map[string]respjson.Field
		// contains filtered or unexported fields
	} `json:"-"`
}

UnitGroup is a unit group resource.

func (UnitGroup) RawJSON 

func (r UnitGroup) RawJSON() string

Returns the unmodified JSON received from the API

func (*UnitGroup) UnmarshalJSON 

func (r *UnitGroup) UnmarshalJSON(data []byte) error

type UnitGroupObject 

type UnitGroupObject string

Resource type identifier. 

const (
	UnitGroupObjectUnitGroup UnitGroupObject = "unit_group"
)

type UnitGroupType 

type UnitGroupType string

Unit type. 

const (
	UnitGroupTypeCurrency    UnitGroupType = "currency"
	UnitGroupTypeQuantity    UnitGroupType = "quantity"
	UnitGroupTypeTime        UnitGroupType = "time"
	UnitGroupTypeMass        UnitGroupType = "mass"
	UnitGroupTypeVolume      UnitGroupType = "volume"
	UnitGroupTypeLength      UnitGroupType = "length"
	UnitGroupTypeTemperature UnitGroupType = "temperature"
	UnitGroupTypeArea        UnitGroupType = "area"
)

type UnitGroupUnit 

type UnitGroupUnit struct {
	// Unit group unit ID.
	ID string `json:"id" api:"required"`
	// Creation timestamp.
	CreatedAt time.Time `json:"created_at" api:"required" format:"date-time"`
	// Customer portal visibility.
	//
	// Any of "visible", "hidden".
	CustomerPortalVisibility UnitGroupUnitCustomerPortalVisibility `json:"customer_portal_visibility" api:"required"`
	// Fixed discount amount.
	DiscountFixed float64 `json:"discount_fixed" api:"required"`
	// Discount percentage.
	DiscountPercentage float64 `json:"discount_percentage" api:"required"`
	// Resource type identifier.
	//
	// Any of "unit_group_unit".
	Object UnitGroupUnitObject `json:"object" api:"required"`
	// Unit of measurement used for conversions and product quantities.
	Unit Unit `json:"unit" api:"required"`
	// Last updated timestamp.
	UpdatedAt time.Time `json:"updated_at" api:"required" format:"date-time"`
	// JSON contains metadata for fields, check presence with [respjson.Field.Valid].
	JSON struct {
		ID                       respjson.Field
		CreatedAt                respjson.Field
		CustomerPortalVisibility respjson.Field
		DiscountFixed            respjson.Field
		DiscountPercentage       respjson.Field
		Object                   respjson.Field
		Unit                     respjson.Field
		UpdatedAt                respjson.Field
		ExtraFields              map[string]respjson.Field
		// contains filtered or unexported fields
	} `json:"-"`
}

UnitGroupUnit is an associated unit within a unit group.

func (UnitGroupUnit) RawJSON 

func (r UnitGroupUnit) RawJSON() string

Returns the unmodified JSON received from the API

func (*UnitGroupUnit) UnmarshalJSON 

func (r *UnitGroupUnit) UnmarshalJSON(data []byte) error

type UnitGroupUnitCustomerPortalVisibility 

type UnitGroupUnitCustomerPortalVisibility string

Customer portal visibility. 

const (
	UnitGroupUnitCustomerPortalVisibilityVisible UnitGroupUnitCustomerPortalVisibility = "visible"
	UnitGroupUnitCustomerPortalVisibilityHidden  UnitGroupUnitCustomerPortalVisibility = "hidden"
)

type UnitGroupUnitObject 

type UnitGroupUnitObject string

Resource type identifier. 

const (
	UnitGroupUnitObjectUnitGroupUnit UnitGroupUnitObject = "unit_group_unit"
)

type UnitObject 

type UnitObject string

Resource type identifier. 

const (
	UnitObjectUnit UnitObject = "unit"
)

type UnitType 

type UnitType string

Unit dimension. 

const (
	UnitTypeCurrency    UnitType = "currency"
	UnitTypeQuantity    UnitType = "quantity"
	UnitTypeTime        UnitType = "time"
	UnitTypeMass        UnitType = "mass"
	UnitTypeVolume      UnitType = "volume"
	UnitTypeLength      UnitType = "length"
	UnitTypeTemperature UnitType = "temperature"
	UnitTypeArea        UnitType = "area"
)

type UpdateAccountGroupRequestCommissionPolicy 

type UpdateAccountGroupRequestCommissionPolicy string

Commission policy.

  • `commission_exempt`: no commission applies.
  • `commission_applied`: commission applies; if the account group is within a sales rep's territory, it will be assigned to that rep unless overridden.
const (
	UpdateAccountGroupRequestCommissionPolicyCommissionApplied UpdateAccountGroupRequestCommissionPolicy = "commission_applied"
	UpdateAccountGroupRequestCommissionPolicyCommissionExempt  UpdateAccountGroupRequestCommissionPolicy = "commission_exempt"
)

type UpdateAccountGroupRequestFreightPolicy 

type UpdateAccountGroupRequestFreightPolicy string

Freight policy.

  • `free_freight`: customers within this group will not have to pay for freight.
  • `billed_freight`: freight will be applied to any order within this account group, unless overridden elsewhere.
const (
	UpdateAccountGroupRequestFreightPolicyFreeFreight   UpdateAccountGroupRequestFreightPolicy = "free_freight"
	UpdateAccountGroupRequestFreightPolicyBilledFreight UpdateAccountGroupRequestFreightPolicy = "billed_freight"
)

type UpdateAccountGroupRequestParam 

type UpdateAccountGroupRequestParam struct {
	// Description.
	Description param.Opt[string] `json:"description,omitzero"`
	// Display name.
	Name param.Opt[string] `json:"name,omitzero"`
	// Commission policy.
	//
	//   - `commission_exempt`: no commission applies.
	//   - `commission_applied`: commission applies; if the account group is within a
	//     sales rep's territory, it will be assigned to that rep unless overridden.
	//
	// Any of "commission_applied", "commission_exempt".
	CommissionPolicy UpdateAccountGroupRequestCommissionPolicy `json:"commission_policy,omitzero"`
	// Freight policy.
	//
	//   - `free_freight`: customers within this group will not have to pay for freight.
	//   - `billed_freight`: freight will be applied to any order within this account
	//     group, unless overridden elsewhere.
	//
	// Any of "free_freight", "billed_freight".
	FreightPolicy UpdateAccountGroupRequestFreightPolicy `json:"freight_policy,omitzero"`
	// contains filtered or unexported fields
}

Request to partially update an account group.

func (UpdateAccountGroupRequestParam) MarshalJSON 

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

func (*UpdateAccountGroupRequestParam) UnmarshalJSON 

func (r *UpdateAccountGroupRequestParam) UnmarshalJSON(data []byte) error

type UpdateAccountUserRequestParam 

type UpdateAccountUserRequestParam struct {
	// Department assigned to the user.
	DepartmentID param.Opt[string] `json:"department_id,omitzero"`
	// Role assigned to the user.
	RoleID param.Opt[string] `json:"role_id,omitzero"`
	// User email address.
	Email param.Opt[string] `json:"email,omitzero"`
	// User display name.
	Name param.Opt[string] `json:"name,omitzero"`
	// Unique username (3–255 chars; letters, numbers, underscores, hyphens).
	Username param.Opt[string] `json:"username,omitzero"`
	// Notification preferences to update (external targets only).
	Preferences []NotificationPreferenceItemParam `json:"preferences,omitzero"`
	// contains filtered or unexported fields
}

Request to partially update an account user.

func (UpdateAccountUserRequestParam) MarshalJSON 

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

func (*UpdateAccountUserRequestParam) UnmarshalJSON 

func (r *UpdateAccountUserRequestParam) UnmarshalJSON(data []byte) error

type UpdateAddressRequestParam 

type UpdateAddressRequestParam struct {
	// Email address associated with the address.
	Email param.Opt[string] `json:"email,omitzero"`
	// Phone number associated with the address.
	Phone param.Opt[string] `json:"phone,omitzero"`
	// Second line of the street address.
	StreetLine2 param.Opt[string] `json:"street_line_2,omitzero"`
	// Two-letter country code.
	Country param.Opt[string] `json:"country,omitzero"`
	// City or locality.
	Locality param.Opt[string] `json:"locality,omitzero"`
	// Display name of the address.
	Name param.Opt[string] `json:"name,omitzero"`
	// Postal or ZIP code.
	PostalCode param.Opt[string] `json:"postal_code,omitzero"`
	// State or administrative area.
	State param.Opt[string] `json:"state,omitzero"`
	// First line of the street address.
	StreetLine1 param.Opt[string] `json:"street_line_1,omitzero"`
	// Address type.
	//
	// Any of "standard", "drop_ship".
	Type UpdateAddressRequestType `json:"type,omitzero"`
	// contains filtered or unexported fields
}

Request to partially update an address.

func (UpdateAddressRequestParam) MarshalJSON 

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

func (*UpdateAddressRequestParam) UnmarshalJSON 

func (r *UpdateAddressRequestParam) UnmarshalJSON(data []byte) error

type UpdateAddressRequestType 

type UpdateAddressRequestType string

Address type. 

const (
	UpdateAddressRequestTypeStandard UpdateAddressRequestType = "standard"
	UpdateAddressRequestTypeDropShip UpdateAddressRequestType = "drop_ship"
)

type UpdateAttributeRequestColor 

type UpdateAttributeRequestColor string

Color code. 

const (
	UpdateAttributeRequestColorBlue    UpdateAttributeRequestColor = "blue"
	UpdateAttributeRequestColorBrown   UpdateAttributeRequestColor = "brown"
	UpdateAttributeRequestColorDefault UpdateAttributeRequestColor = "default"
	UpdateAttributeRequestColorGray    UpdateAttributeRequestColor = "gray"
	UpdateAttributeRequestColorGreen   UpdateAttributeRequestColor = "green"
	UpdateAttributeRequestColorOrange  UpdateAttributeRequestColor = "orange"
	UpdateAttributeRequestColorPink    UpdateAttributeRequestColor = "pink"
	UpdateAttributeRequestColorPurple  UpdateAttributeRequestColor = "purple"
	UpdateAttributeRequestColorRed     UpdateAttributeRequestColor = "red"
	UpdateAttributeRequestColorYellow  UpdateAttributeRequestColor = "yellow"
)

type UpdateAttributeRequestParam 

type UpdateAttributeRequestParam struct {
	// Display order. Must be a positive integer.
	SortOrder param.Opt[int64] `json:"sort_order,omitzero"`
	// Attribute value.
	Value param.Opt[string] `json:"value,omitzero"`
	// Color code.
	//
	// Any of "blue", "brown", "default", "gray", "green", "orange", "pink", "purple",
	// "red", "yellow".
	Color UpdateAttributeRequestColor `json:"color,omitzero"`
	// contains filtered or unexported fields
}

Request to update an attribute.

func (UpdateAttributeRequestParam) MarshalJSON 

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

func (*UpdateAttributeRequestParam) UnmarshalJSON 

func (r *UpdateAttributeRequestParam) UnmarshalJSON(data []byte) error

type UpdateCarrierRequestCustomerPortalVisibility 

type UpdateCarrierRequestCustomerPortalVisibility string

Carrier visibility in the customer portal.

If `visible`, this carrier will be available for your customers to utilize when they go to checkout. If `hidden`, this carrier will not be an option on checkout. 

const (
	UpdateCarrierRequestCustomerPortalVisibilityVisible UpdateCarrierRequestCustomerPortalVisibility = "visible"
	UpdateCarrierRequestCustomerPortalVisibilityHidden  UpdateCarrierRequestCustomerPortalVisibility = "hidden"
)

type UpdateCarrierRequestParam 

type UpdateCarrierRequestParam struct {
	// Display name.
	Name param.Opt[string] `json:"name,omitzero"`
	// Carrier visibility in the customer portal.
	//
	// If `visible`, this carrier will be available for your customers to utilize when
	// they go to checkout. If `hidden`, this carrier will not be an option on
	// checkout.
	//
	// Any of "visible", "hidden".
	CustomerPortalVisibility UpdateCarrierRequestCustomerPortalVisibility `json:"customer_portal_visibility,omitzero"`
	// contains filtered or unexported fields
}

Request to update a carrier.

func (UpdateCarrierRequestParam) MarshalJSON 

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

func (*UpdateCarrierRequestParam) UnmarshalJSON 

func (r *UpdateCarrierRequestParam) UnmarshalJSON(data []byte) error

type UpdateCustomerRequestCarrierBillingType 

type UpdateCustomerRequestCarrierBillingType string

Carrier billing type. 

const (
	UpdateCustomerRequestCarrierBillingTypeSender     UpdateCustomerRequestCarrierBillingType = "sender"
	UpdateCustomerRequestCarrierBillingTypeThirdParty UpdateCustomerRequestCarrierBillingType = "third_party"
)

type UpdateCustomerRequestCommissionPolicy 

type UpdateCustomerRequestCommissionPolicy string

Commission policy. 

const (
	UpdateCustomerRequestCommissionPolicyCommissionApplied UpdateCustomerRequestCommissionPolicy = "commission_applied"
	UpdateCustomerRequestCommissionPolicyCommissionExempt  UpdateCustomerRequestCommissionPolicy = "commission_exempt"
)

type UpdateCustomerRequestDefaultPriority 

type UpdateCustomerRequestDefaultPriority string

Default priority code. 

const (
	UpdateCustomerRequestDefaultPriorityLow    UpdateCustomerRequestDefaultPriority = "low"
	UpdateCustomerRequestDefaultPriorityNormal UpdateCustomerRequestDefaultPriority = "normal"
	UpdateCustomerRequestDefaultPriorityHigh   UpdateCustomerRequestDefaultPriority = "high"
)

type UpdateCustomerRequestEdiStatus 

type UpdateCustomerRequestEdiStatus string

EDI status. 

const (
	UpdateCustomerRequestEdiStatusEnabled  UpdateCustomerRequestEdiStatus = "enabled"
	UpdateCustomerRequestEdiStatusDisabled UpdateCustomerRequestEdiStatus = "disabled"
)

type UpdateCustomerRequestFreightPolicy 

type UpdateCustomerRequestFreightPolicy string

Freight policy. 

const (
	UpdateCustomerRequestFreightPolicyFreeFreight   UpdateCustomerRequestFreightPolicy = "free_freight"
	UpdateCustomerRequestFreightPolicyBilledFreight UpdateCustomerRequestFreightPolicy = "billed_freight"
)

type UpdateCustomerRequestParam 

type UpdateCustomerRequestParam struct {
	// Bill-to address ID.
	BillToAddressID param.Opt[string] `json:"bill_to_address_id,omitzero"`
	// Carrier billing account number.
	CarrierBillingAccount param.Opt[string] `json:"carrier_billing_account,omitzero"`
	// The ID of the account user to assign as the default sales rep.
	DefaultSalesRepID param.Opt[string] `json:"default_sales_rep_id,omitzero"`
	// Default service level ID.
	DefaultServiceLevelID param.Opt[string] `json:"default_service_level_id,omitzero"`
	// Email address. Send null to clear.
	Email param.Opt[string] `json:"email,omitzero"`
	// Note.
	Note param.Opt[string] `json:"note,omitzero"`
	// Phone number. Send null to clear.
	Phone param.Opt[string] `json:"phone,omitzero"`
	// Ship-to address ID.
	ShipToAddressID param.Opt[string] `json:"ship_to_address_id,omitzero"`
	// Website URL. Send null to clear.
	URL param.Opt[string] `json:"url,omitzero"`
	// Customer type group ID.
	CustomerTypeGroupID param.Opt[string] `json:"customer_type_group_id,omitzero"`
	// Default carrier ID.
	DefaultCarrierID param.Opt[string] `json:"default_carrier_id,omitzero"`
	// Default payment term ID.
	DefaultPaymentTermID param.Opt[string] `json:"default_payment_term_id,omitzero"`
	// Default shipping term ID.
	DefaultShippingTermID param.Opt[string] `json:"default_shipping_term_id,omitzero"`
	// Customer name.
	Name param.Opt[string] `json:"name,omitzero"`
	// Customer number.
	Number param.Opt[string] `json:"number,omitzero"`
	// Carrier billing type.
	//
	// Any of "sender", "third_party".
	CarrierBillingType UpdateCustomerRequestCarrierBillingType `json:"carrier_billing_type,omitzero"`
	// Commission policy.
	//
	// Any of "commission_applied", "commission_exempt".
	CommissionPolicy UpdateCustomerRequestCommissionPolicy `json:"commission_policy,omitzero"`
	// QuantityInput represents a value with an associated unit for create/update
	// requests.
	CreditLimit QuantityInputParam `json:"credit_limit,omitzero"`
	// Price group IDs. Replaces all existing price groups when provided.
	CustomerPriceGroupIDs []string `json:"customer_price_group_ids,omitzero"`
	// Default priority code.
	//
	// Any of "low", "normal", "high".
	DefaultPriority UpdateCustomerRequestDefaultPriority `json:"default_priority,omitzero"`
	// EDI status.
	//
	// Any of "enabled", "disabled".
	EdiStatus UpdateCustomerRequestEdiStatus `json:"edi_status,omitzero"`
	// Freight policy.
	//
	// Any of "free_freight", "billed_freight".
	FreightPolicy UpdateCustomerRequestFreightPolicy `json:"freight_policy,omitzero"`
	// Account status code.
	//
	// Any of "normal", "preferred", "hold_shipment", "hold_all".
	Status UpdateCustomerRequestStatus `json:"status,omitzero"`
	// contains filtered or unexported fields
}

Request to partially update a customer.

func (UpdateCustomerRequestParam) MarshalJSON 

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

func (*UpdateCustomerRequestParam) UnmarshalJSON 

func (r *UpdateCustomerRequestParam) UnmarshalJSON(data []byte) error

type UpdateCustomerRequestStatus 

type UpdateCustomerRequestStatus string

Account status code. 

const (
	UpdateCustomerRequestStatusNormal       UpdateCustomerRequestStatus = "normal"
	UpdateCustomerRequestStatusPreferred    UpdateCustomerRequestStatus = "preferred"
	UpdateCustomerRequestStatusHoldShipment UpdateCustomerRequestStatus = "hold_shipment"
	UpdateCustomerRequestStatusHoldAll      UpdateCustomerRequestStatus = "hold_all"
)

type UpdateItemCategoryRequestParam 

type UpdateItemCategoryRequestParam struct {
	// Display name.
	Name param.Opt[string] `json:"name,omitzero"`
	// Notes.
	Notes param.Opt[string] `json:"notes,omitzero"`
	// contains filtered or unexported fields
}

Request to partially update an item category.

func (UpdateItemCategoryRequestParam) MarshalJSON 

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

func (*UpdateItemCategoryRequestParam) UnmarshalJSON 

func (r *UpdateItemCategoryRequestParam) UnmarshalJSON(data []byte) error

type UpdateLocationRequestParam 

type UpdateLocationRequestParam struct {
	// Parent location ID. Send null to clear.
	ParentID param.Opt[string] `json:"parent_id,omitzero"`
	// Display name.
	Name param.Opt[string] `json:"name,omitzero"`
	// Child location IDs. Replaces all current children when provided. Send null to
	// clear.
	ChildIDs []string `json:"child_ids,omitzero"`
	// Location type code.
	//
	// Any of "building", "section", "aisle", "rack", "shelf", "bin".
	Type LocationTypeCode `json:"type,omitzero"`
	// contains filtered or unexported fields
}

Request to partially update a location.

func (UpdateLocationRequestParam) MarshalJSON 

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

func (*UpdateLocationRequestParam) UnmarshalJSON 

func (r *UpdateLocationRequestParam) UnmarshalJSON(data []byte) error

type UpdateMaterialRequestParam 

type UpdateMaterialRequestParam struct {
	// Description.
	Description param.Opt[string] `json:"description,omitzero"`
	// Notes.
	Notes param.Opt[string] `json:"notes,omitzero"`
	// SKU code.
	SKU param.Opt[string] `json:"sku,omitzero"`
	// QuantityInputRequest is a quantity value and unit.
	LeadTime QuantityInputRequestParam `json:"lead_time,omitzero"`
	// QuantityInputRequest is a quantity value and unit.
	OrderPoint QuantityInputRequestParam `json:"order_point,omitzero"`
	// RateInput represents the input for creating or updating a rate.
	UnitCost RateInputParam `json:"unit_cost,omitzero"`
	// contains filtered or unexported fields
}

Request to update a material.

func (UpdateMaterialRequestParam) MarshalJSON 

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

func (*UpdateMaterialRequestParam) UnmarshalJSON 

func (r *UpdateMaterialRequestParam) UnmarshalJSON(data []byte) error

type UpdatePartRequestParam 

type UpdatePartRequestParam struct {
	// Description.
	Description param.Opt[string] `json:"description,omitzero"`
	// Notes.
	Notes param.Opt[string] `json:"notes,omitzero"`
	// SKU.
	SKU param.Opt[string] `json:"sku,omitzero"`
	// contains filtered or unexported fields
}

Request to partially update a part.

func (UpdatePartRequestParam) MarshalJSON 

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

func (*UpdatePartRequestParam) UnmarshalJSON 

func (r *UpdatePartRequestParam) UnmarshalJSON(data []byte) error

type UpdatePaymentTermRequestParam 

type UpdatePaymentTermRequestParam struct {
	// Display name.
	Name param.Opt[string] `json:"name,omitzero"`
	// contains filtered or unexported fields
}

Request to partially update a payment term.

func (UpdatePaymentTermRequestParam) MarshalJSON 

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

func (*UpdatePaymentTermRequestParam) UnmarshalJSON 

func (r *UpdatePaymentTermRequestParam) UnmarshalJSON(data []byte) error

type UpdateProductLineRequestCommissionPolicy 

type UpdateProductLineRequestCommissionPolicy string

Commission policy of products in this product line. 

const (
	UpdateProductLineRequestCommissionPolicyCommissionApplied UpdateProductLineRequestCommissionPolicy = "commission_applied"
	UpdateProductLineRequestCommissionPolicyCommissionExempt  UpdateProductLineRequestCommissionPolicy = "commission_exempt"
)

type UpdateProductLineRequestFreightPolicy 

type UpdateProductLineRequestFreightPolicy string

Freight policy for all items in this product line. 

const (
	UpdateProductLineRequestFreightPolicyFreeFreight   UpdateProductLineRequestFreightPolicy = "free_freight"
	UpdateProductLineRequestFreightPolicyBilledFreight UpdateProductLineRequestFreightPolicy = "billed_freight"
)

type UpdateProductLineRequestParam 

type UpdateProductLineRequestParam struct {
	// Display name.
	Name param.Opt[string] `json:"name,omitzero"`
	// Unit group ID associated with this product line. This unit group dictates the
	// units that products in this product line may be purchased in.
	UnitGroupID param.Opt[string] `json:"unit_group_id,omitzero"`
	// Commission policy of products in this product line.
	//
	// Any of "commission_applied", "commission_exempt".
	CommissionPolicy UpdateProductLineRequestCommissionPolicy `json:"commission_policy,omitzero"`
	// Freight policy for all items in this product line.
	//
	// Any of "free_freight", "billed_freight".
	FreightPolicy UpdateProductLineRequestFreightPolicy `json:"freight_policy,omitzero"`
	// contains filtered or unexported fields
}

Request to partially update a product line.

func (UpdateProductLineRequestParam) MarshalJSON 

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

func (*UpdateProductLineRequestParam) UnmarshalJSON 

func (r *UpdateProductLineRequestParam) UnmarshalJSON(data []byte) error

type UpdateProductRequestParam 

type UpdateProductRequestParam struct {
	// Description.
	Description param.Opt[string] `json:"description,omitzero"`
	// Notes.
	Notes param.Opt[string] `json:"notes,omitzero"`
	// SKU.
	SKU param.Opt[string] `json:"sku,omitzero"`
	// Whether visible in the customer portal.
	//
	// Any of "visible", "hidden".
	PortalVisibility UpdateProductRequestPortalVisibility `json:"portal_visibility,omitzero"`
	// RateInput represents the input for creating or updating a rate.
	UnitPrice RateInputParam `json:"unit_price,omitzero"`
	// contains filtered or unexported fields
}

UpdateProductRequest is the request to partially update a product.

func (UpdateProductRequestParam) MarshalJSON 

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

func (*UpdateProductRequestParam) UnmarshalJSON 

func (r *UpdateProductRequestParam) UnmarshalJSON(data []byte) error

type UpdateProductRequestPortalVisibility 

type UpdateProductRequestPortalVisibility string

Whether visible in the customer portal. 

const (
	UpdateProductRequestPortalVisibilityVisible UpdateProductRequestPortalVisibility = "visible"
	UpdateProductRequestPortalVisibilityHidden  UpdateProductRequestPortalVisibility = "hidden"
)

type UpdatePropertyRequestParam 

type UpdatePropertyRequestParam struct {
	// Name.
	Name param.Opt[string] `json:"name,omitzero"`
	// contains filtered or unexported fields
}

Request to update a property.

func (UpdatePropertyRequestParam) MarshalJSON 

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

func (*UpdatePropertyRequestParam) UnmarshalJSON 

func (r *UpdatePropertyRequestParam) UnmarshalJSON(data []byte) error

type UpdateRoleRequestParam 

type UpdateRoleRequestParam struct {
	// Display name.
	Name param.Opt[string] `json:"name,omitzero"`
	// Permissions in `<domain>:<action>` format. Replaces all existing permissions;
	// omit to leave unchanged.
	Permissions []string `json:"permissions,omitzero"`
	// contains filtered or unexported fields
}

UpdateRoleRequest is a request to update a role.

func (UpdateRoleRequestParam) MarshalJSON 

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

func (*UpdateRoleRequestParam) UnmarshalJSON 

func (r *UpdateRoleRequestParam) UnmarshalJSON(data []byte) error

type UpdateScanningStationRequestLabelSize 

type UpdateScanningStationRequestLabelSize string

Label size code. 

const (
	UpdateScanningStationRequestLabelSize1x1 UpdateScanningStationRequestLabelSize = "1x1"
	UpdateScanningStationRequestLabelSize1x3 UpdateScanningStationRequestLabelSize = "1x3"
	UpdateScanningStationRequestLabelSize1x4 UpdateScanningStationRequestLabelSize = "1x4"
	UpdateScanningStationRequestLabelSize2x4 UpdateScanningStationRequestLabelSize = "2x4"
)

type UpdateScanningStationRequestLabelType 

type UpdateScanningStationRequestLabelType string

Label type code. 

const (
	UpdateScanningStationRequestLabelTypeTag      UpdateScanningStationRequestLabelType = "tag"
	UpdateScanningStationRequestLabelTypeTraveler UpdateScanningStationRequestLabelType = "traveler"
)

type UpdateScanningStationRequestOperatorRequirement 

type UpdateScanningStationRequestOperatorRequirement string

Operator requirement behavior for this station. 

const (
	UpdateScanningStationRequestOperatorRequirementNone          UpdateScanningStationRequestOperatorRequirement = "none"
	UpdateScanningStationRequestOperatorRequirementMaterialCheck UpdateScanningStationRequestOperatorRequirement = "material_check"
)

type UpdateScanningStationRequestParam 

type UpdateScanningStationRequestParam struct {
	// Notes.
	Notes param.Opt[string] `json:"notes,omitzero"`
	// Display name.
	Name param.Opt[string] `json:"name,omitzero"`
	// Label size code.
	//
	// Any of "1x1", "1x3", "1x4", "2x4".
	LabelSize UpdateScanningStationRequestLabelSize `json:"label_size,omitzero"`
	// Label type code.
	//
	// Any of "tag", "traveler".
	LabelType UpdateScanningStationRequestLabelType `json:"label_type,omitzero"`
	// Operator requirement behavior for this station.
	//
	// Any of "none", "material_check".
	OperatorRequirement UpdateScanningStationRequestOperatorRequirement `json:"operator_requirement,omitzero"`
	// contains filtered or unexported fields
}

Request to partially update a scanning station.

func (UpdateScanningStationRequestParam) MarshalJSON 

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

func (*UpdateScanningStationRequestParam) UnmarshalJSON 

func (r *UpdateScanningStationRequestParam) UnmarshalJSON(data []byte) error

type UpdateServiceLevelRequestCustomerPortalVisibility 

type UpdateServiceLevelRequestCustomerPortalVisibility string

Whether this service level will be available for customers to select in the customer portal. 

const (
	UpdateServiceLevelRequestCustomerPortalVisibilityVisible UpdateServiceLevelRequestCustomerPortalVisibility = "visible"
	UpdateServiceLevelRequestCustomerPortalVisibilityHidden  UpdateServiceLevelRequestCustomerPortalVisibility = "hidden"
)

type UpdateServiceLevelRequestParam 

type UpdateServiceLevelRequestParam struct {
	// Service level code.
	Code param.Opt[string] `json:"code,omitzero"`
	// Default service levels are the default-selected service level for that carrier.
	IsDefault param.Opt[bool] `json:"is_default,omitzero"`
	// Display name.
	Name param.Opt[string] `json:"name,omitzero"`
	// Whether this service level will be available for customers to select in the
	// customer portal.
	//
	// Any of "visible", "hidden".
	CustomerPortalVisibility UpdateServiceLevelRequestCustomerPortalVisibility `json:"customer_portal_visibility,omitzero"`
	// contains filtered or unexported fields
}

Request to update a service level.

func (UpdateServiceLevelRequestParam) MarshalJSON 

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

func (*UpdateServiceLevelRequestParam) UnmarshalJSON 

func (r *UpdateServiceLevelRequestParam) UnmarshalJSON(data []byte) error

type UpdateShippingTermRequestParam 

type UpdateShippingTermRequestParam struct {
	// Display name.
	Name param.Opt[string] `json:"name,omitzero"`
	// Service level IDs that qualify for free shipping. Send null to clear.
	FreeShippingServiceLevelIDs []string `json:"free_shipping_service_level_ids,omitzero"`
	// QuantityInput represents a value with an associated unit for create/update
	// requests.
	FlatRate QuantityInputParam `json:"flat_rate,omitzero"`
	// QuantityInput represents a value with an associated unit for create/update
	// requests.
	MinimumOrderValue QuantityInputParam `json:"minimum_order_value,omitzero"`
	// Shipping term type.
	//
	// Any of "free_freight", "flat_rate_freight", "carrier_rate_freight".
	Type UpdateShippingTermRequestType `json:"type,omitzero"`
	// contains filtered or unexported fields
}

Request to partially update a shipping term. All fields are optional. Absent fields are left unchanged. Send an explicit JSON null for flat_rate, minimum_order_value, or free_shipping_service_level_ids to clear the existing value.

func (UpdateShippingTermRequestParam) MarshalJSON 

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

func (*UpdateShippingTermRequestParam) UnmarshalJSON 

func (r *UpdateShippingTermRequestParam) UnmarshalJSON(data []byte) error

type UpdateShippingTermRequestType 

type UpdateShippingTermRequestType string

Shipping term type. 

const (
	UpdateShippingTermRequestTypeFreeFreight        UpdateShippingTermRequestType = "free_freight"
	UpdateShippingTermRequestTypeFlatRateFreight    UpdateShippingTermRequestType = "flat_rate_freight"
	UpdateShippingTermRequestTypeCarrierRateFreight UpdateShippingTermRequestType = "carrier_rate_freight"
)

type UpdateUnitGroupRequestParam 

type UpdateUnitGroupRequestParam struct {
	// Notes. Set to null to clear.
	Notes param.Opt[string] `json:"notes,omitzero"`
	// Base unit ID.
	BaseUnitID param.Opt[string] `json:"base_unit_id,omitzero"`
	// Display name.
	Name param.Opt[string] `json:"name,omitzero"`
	// Upserts associated units when provided. Existing units not in the list are
	// preserved.
	AssociatedUnits []CreateUnitGroupUnitParam `json:"associated_units,omitzero"`
	// contains filtered or unexported fields
}

UpdateUnitGroupRequest is a request to partially update a unit group.

func (UpdateUnitGroupRequestParam) MarshalJSON 

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

func (*UpdateUnitGroupRequestParam) UnmarshalJSON 

func (r *UpdateUnitGroupRequestParam) UnmarshalJSON(data []byte) error

type UpdateUnitGroupUnitRequestCustomerPortalVisibility 

type UpdateUnitGroupUnitRequestCustomerPortalVisibility string

Customer portal visibility. 

const (
	UpdateUnitGroupUnitRequestCustomerPortalVisibilityVisible UpdateUnitGroupUnitRequestCustomerPortalVisibility = "visible"
	UpdateUnitGroupUnitRequestCustomerPortalVisibilityHidden  UpdateUnitGroupUnitRequestCustomerPortalVisibility = "hidden"
)

type UpdateUnitGroupUnitRequestParam 

type UpdateUnitGroupUnitRequestParam struct {
	// Fixed discount amount.
	DiscountFixed param.Opt[float64] `json:"discount_fixed,omitzero"`
	// Discount percentage.
	DiscountPercentage param.Opt[float64] `json:"discount_percentage,omitzero"`
	// Unit ID.
	UnitID param.Opt[string] `json:"unit_id,omitzero"`
	// Customer portal visibility.
	//
	// Any of "visible", "hidden".
	CustomerPortalVisibility UpdateUnitGroupUnitRequestCustomerPortalVisibility `json:"customer_portal_visibility,omitzero"`
	// contains filtered or unexported fields
}

UpdateUnitGroupUnitRequest is a request to update an associated unit.

func (UpdateUnitGroupUnitRequestParam) MarshalJSON 

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

func (*UpdateUnitGroupUnitRequestParam) UnmarshalJSON 

func (r *UpdateUnitGroupUnitRequestParam) UnmarshalJSON(data []byte) error

type UpdateUnitRequestParam 

type UpdateUnitRequestParam struct {
	// Short abbreviation for the unit.
	Abbreviation param.Opt[string] `json:"abbreviation,omitzero"`
	// Display name of the unit.
	Name param.Opt[string] `json:"name,omitzero"`
	// Conversion offset denominator, as a decimal string. Must not be zero.
	OffsetDenominator param.Opt[string] `json:"offset_denominator,omitzero" format:"decimal"`
	// Conversion offset numerator, as a decimal string.
	OffsetNumerator param.Opt[string] `json:"offset_numerator,omitzero" format:"decimal"`
	// Conversion ratio denominator, as a decimal string. Must not be zero.
	RatioDenominator param.Opt[string] `json:"ratio_denominator,omitzero" format:"decimal"`
	// Conversion ratio numerator, as a decimal string.
	RatioNumerator param.Opt[string] `json:"ratio_numerator,omitzero" format:"decimal"`
	// contains filtered or unexported fields
}

Request to partially update a unit.

func (UpdateUnitRequestParam) MarshalJSON 

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

func (*UpdateUnitRequestParam) UnmarshalJSON 

func (r *UpdateUnitRequestParam) UnmarshalJSON(data []byte) error

type ValidateAddressRequestParam 

type ValidateAddressRequestParam struct {
	// First line of the street address.
	AddressLine1 string `json:"address_line_1" api:"required"`
	// City or locality.
	City string `json:"city" api:"required"`
	// Country name or code.
	Country string `json:"country" api:"required"`
	// Postal or ZIP code.
	PostalCode string `json:"postal_code" api:"required"`
	// State or administrative area.
	State string `json:"state" api:"required"`
	// Second line of the street address.
	AddressLine2 param.Opt[string] `json:"address_line_2,omitzero"`
	// contains filtered or unexported fields
}

Request to validate an address.

The properties AddressLine1, City, Country, PostalCode, State are required.

func (ValidateAddressRequestParam) MarshalJSON 

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

func (*ValidateAddressRequestParam) UnmarshalJSON 

func (r *ValidateAddressRequestParam) UnmarshalJSON(data []byte) error

type ValidatedAddress 

type ValidatedAddress struct {
	// Parsed address components.
	Components AddressComponents `json:"components" api:"required"`
	// Formatted address from the validation service.
	FormattedAddress string `json:"formatted_address" api:"required"`
	// Resource type identifier.
	//
	// Any of "validated_address".
	Object ValidatedAddressObject `json:"object" api:"required"`
	// Address validation status.
	//
	// Any of "valid", "invalid".
	Status ValidatedAddressStatus `json:"status" api:"required"`
	// Validation messages for issues found.
	ValidationMessages []string `json:"validation_messages" api:"required"`
	// JSON contains metadata for fields, check presence with [respjson.Field.Valid].
	JSON struct {
		Components         respjson.Field
		FormattedAddress   respjson.Field
		Object             respjson.Field
		Status             respjson.Field
		ValidationMessages respjson.Field
		ExtraFields        map[string]respjson.Field
		// contains filtered or unexported fields
	} `json:"-"`
}

Result of address validation.

func (ValidatedAddress) RawJSON 

func (r ValidatedAddress) RawJSON() string

Returns the unmodified JSON received from the API

func (*ValidatedAddress) UnmarshalJSON 

func (r *ValidatedAddress) UnmarshalJSON(data []byte) error

type ValidatedAddressObject 

type ValidatedAddressObject string

Resource type identifier. 

const (
	ValidatedAddressObjectValidatedAddress ValidatedAddressObject = "validated_address"
)

type ValidatedAddressStatus 

type ValidatedAddressStatus string

Address validation status. 

const (
	ValidatedAddressStatusValid   ValidatedAddressStatus = "valid"
	ValidatedAddressStatusInvalid ValidatedAddressStatus = "invalid"
)

Source Files

View all Source files

Directories

Path Synopsis
apierror
apiform
apijson
apiquery
encoding/json
Package json implements encoding and decoding of JSON as defined in RFC 7159.
 Package json implements encoding and decoding of JSON as defined in RFC 7159.
encoding/json/sentinel
encoding/json/shims
This package provides shims over Go 1.2{2,3} APIs which are missing from Go 1.22, and used by the Go 1.24 encoding/json package.
 This package provides shims over Go 1.2{2,3} APIs which are missing from Go 1.22, and used by the Go 1.24 encoding/json package.
paramutil
requestconfig
testutil
packages
param
respjson
shared
constant

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.