apps

package
v0.5.0 Latest Latest
Warning

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

Go to latest
Published: Apr 27, 2026 License: MIT Imports: 6 Imported by: 0

Documentation

Index

Constants

View Source
const (
	FieldName        = "name"
	FieldBundleId    = "bundleId"
	FieldWebsiteUrl  = "websiteUrl"
	FieldVersion     = "version"
	FieldSupportedOS = "supportedOS"
	FieldIsCustomApp = "isCustomApp"
	FieldAppStoreUrl = "appStoreUrl"
)

Field constants for fields[apps] query parameter.

View Source
const (
	SupportedOSiOS     = "SUPPORTED_OS_IOS"
	SupportedOSmacOS   = "SUPPORTED_OS_MACOS"
	SupportedOStvOS    = "SUPPORTED_OS_TVOS"
	SupportedOSwatchOS = "SUPPORTED_OS_WATCHOS"
)

SupportedOS constants for supportedOS field values.

Variables

This section is empty.

Functions

This section is empty.

Types

type App

type App struct {
	ID         string         `json:"id"`
	Type       string         `json:"type"`
	Attributes *AppAttributes `json:"attributes,omitempty"`
	Links      *ResourceLinks `json:"links,omitempty"`
}

App represents an app resource.

type AppAttributes

type AppAttributes struct {
	Name        string   `json:"name,omitempty"`
	BundleId    string   `json:"bundleId,omitempty"`
	WebsiteUrl  string   `json:"websiteUrl,omitempty"`
	Version     string   `json:"version,omitempty"`
	SupportedOS []string `json:"supportedOS,omitempty"`
	IsCustomApp bool     `json:"isCustomApp,omitempty"`
	AppStoreUrl string   `json:"appStoreUrl,omitempty"`
}

AppAttributes contains the attributes of an app.

type AppResponse

type AppResponse struct {
	Data  App    `json:"data"`
	Links *Links `json:"links,omitempty"`
}

AppResponse is the response for a single app.

type Apps

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

Apps handles communication with the apps related methods of the Apple Business Manager API.

Apple Business Manager API docs: https://developer.apple.com/documentation/applebusinessapi/get-apps

func NewService

func NewService(c client.Client) *Apps

NewService creates a new apps service.

func (*Apps) GetByAppIDV1

func (s *Apps) GetByAppIDV1(ctx context.Context, appID string, opts *RequestQueryOptions) (*AppResponse, *resty.Response, error)

GetByAppIDV1 retrieves information about a specific app in an organization. URL: GET https://api-business.apple.com/v1/apps/{id} https://developer.apple.com/documentation/applebusinessapi/get-app-information

func (*Apps) GetV1

GetV1 retrieves a list of licensed apps in an organization. URL: GET https://api-business.apple.com/v1/apps https://developer.apple.com/documentation/applebusinessapi/get-apps

type AppsResponse

type AppsResponse struct {
	Data  []App  `json:"data"`
	Links *Links `json:"links,omitempty"`
	Meta  *Meta  `json:"meta,omitempty"`
}

AppsResponse is the response for a list of apps.

type Links struct {
	Self  string `json:"self,omitempty"`
	First string `json:"first,omitempty"`
	Next  string `json:"next,omitempty"`
	Prev  string `json:"prev,omitempty"`
	Last  string `json:"last,omitempty"`
}

type Meta

type Meta struct {
	Paging *Paging `json:"paging,omitempty"`
}

type Paging

type Paging struct {
	Total      int    `json:"total,omitempty"`
	Limit      int    `json:"limit,omitempty"`
	NextCursor string `json:"nextCursor,omitempty"`
}

type RequestQueryOptions

type RequestQueryOptions struct {
	// Fields specifies which fields to return. Use Field* constants.
	Fields []string
	// Limit is the number of resources to return (max 1000).
	Limit int
}

RequestQueryOptions represents query parameters for app endpoints.

type ResourceLinks struct {
	Self string `json:"self,omitempty"`
}

Directories

Path Synopsis

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL