appregistry

type AppMetadataInternal struct {
	// OAuth 2.0 Client ID.
	ClientId string `json:"clientId"`
	// The date that the app was created.
	CreatedAt string `json:"createdAt"`
	// The principal who created this app.
	CreatedBy string `json:"createdBy"`
}

type AppMetadataPrivate struct {
	// Array of URLs that can be used for redirect after logging into the app.
	RedirectUrls []string `json:"redirectUrls,omitempty"`
	// URL to redirect to after a subscription is created.
	SetupUrl *string `json:"setupUrl,omitempty"`
	// URL that webhook events are sent to.
	WebhookUrl *string `json:"webhookUrl,omitempty"`
}

type AppMetadataPublic struct {
	// Human-readable title for the app.
	Title string `json:"title"`
	// Array of permission templates that are used to grant permission to the app principal when a tenant subscribes.
	AppPrincipalPermissions []string `json:"appPrincipalPermissions,omitempty"`
	// Short paragraph describing the app.
	Description *string `json:"description,omitempty"`
	// The URL used to log in to the app.
	LoginUrl *string `json:"loginUrl,omitempty"`
	// The URL used to display the app's logo.
	LogoUrl *string `json:"logoUrl,omitempty"`
	// Array of permission filter templates that are used to intersect with a user's permissions when using the app.
	UserPermissionsFilter []string `json:"userPermissionsFilter,omitempty"`
}

type AppMetadataSecret struct {
	// OAuth 2.0 Client Secret string (used for confidential clients).
	ClientSecret string `json:"clientSecret"`
}

type AppName struct {
	AppName string `json:"appName"`
}

type AppResource struct {
	Kind AppResourceKind `json:"kind"`
	// App name that is unique within Splunk Cloud Platform.
	Name string `json:"name"`
}

type AppResourceKind string

type AppResponseCreateUpdate struct {
	// OAuth 2.0 Client ID.
	ClientId string `json:"clientId"`
	// OAuth 2.0 Client Secret string (used for confidential clients).
	ClientSecret string `json:"clientSecret"`
	// The date that the app was created.
	CreatedAt string `json:"createdAt"`
	// The principal who created this app.
	CreatedBy string          `json:"createdBy"`
	Kind      AppResourceKind `json:"kind"`
	// App name that is unique within Splunk Cloud Platform.
	Name string `json:"name"`
	// Human-readable title for the app.
	Title string `json:"title"`
	// Array of permission templates that are used to grant permission to the app principal when a tenant subscribes.
	AppPrincipalPermissions []string `json:"appPrincipalPermissions,omitempty"`
	// Short paragraph describing the app.
	Description *string `json:"description,omitempty"`
	// The URL used to log in to the app.
	LoginUrl *string `json:"loginUrl,omitempty"`
	// The URL used to display the app's logo.
	LogoUrl *string `json:"logoUrl,omitempty"`
	// Array of URLs that can be used for redirect after logging into the app.
	RedirectUrls []string `json:"redirectUrls,omitempty"`
	// URL to redirect to after a subscription is created.
	SetupUrl *string `json:"setupUrl,omitempty"`
	// Array of permission filter templates that are used to intersect with a user's permissions when using the app.
	UserPermissionsFilter []string `json:"userPermissionsFilter,omitempty"`
	// URL that webhook events are sent to.
	WebhookUrl *string `json:"webhookUrl,omitempty"`
}

type AppResponseGetList struct {
	// OAuth 2.0 Client ID.
	ClientId string `json:"clientId"`
	// The date that the app was created.
	CreatedAt string `json:"createdAt"`
	// The principal who created this app.
	CreatedBy string          `json:"createdBy"`
	Kind      AppResourceKind `json:"kind"`
	// App name that is unique within Splunk Cloud Platform.
	Name string `json:"name"`
	// Human-readable title for the app.
	Title string `json:"title"`
	// Array of permission templates that are used to grant permission to the app principal when a tenant subscribes.
	AppPrincipalPermissions []string `json:"appPrincipalPermissions,omitempty"`
	// Short paragraph describing the app.
	Description *string `json:"description,omitempty"`
	// The URL used to log in to the app.
	LoginUrl *string `json:"loginUrl,omitempty"`
	// The URL used to display the app's logo.
	LogoUrl *string `json:"logoUrl,omitempty"`
	// Array of URLs that can be used for redirect after logging into the app.
	RedirectUrls []string `json:"redirectUrls,omitempty"`
	// URL to redirect to after a subscription is created.
	SetupUrl *string `json:"setupUrl,omitempty"`
	// Array of permission filter templates that are used to intersect with a user's permissions when using the app.
	UserPermissionsFilter []string `json:"userPermissionsFilter,omitempty"`
	// URL that webhook events are sent to.
	WebhookUrl *string `json:"webhookUrl,omitempty"`
}

type CreateAppRequest struct {
	Kind AppResourceKind `json:"kind"`
	// App name that is unique within Splunk Cloud Platform.
	Name string `json:"name"`
	// Human-readable title for the app.
	Title string `json:"title"`
	// Array of permission templates that are used to grant permission to the app principal when a tenant subscribes.
	AppPrincipalPermissions []string `json:"appPrincipalPermissions,omitempty"`
	// Short paragraph describing the app.
	Description *string `json:"description,omitempty"`
	// The URL used to log in to the app.
	LoginUrl *string `json:"loginUrl,omitempty"`
	// The URL used to display the app's logo.
	LogoUrl *string `json:"logoUrl,omitempty"`
	// Array of URLs that can be used for redirect after logging into the app.
	RedirectUrls []string `json:"redirectUrls,omitempty"`
	// URL to redirect to after a subscription is created.
	SetupUrl *string `json:"setupUrl,omitempty"`
	// Array of permission filter templates that are used to intersect with a user's permissions when using the app.
	UserPermissionsFilter []string `json:"userPermissionsFilter,omitempty"`
	// URL that webhook events are sent to.
	WebhookUrl *string `json:"webhookUrl,omitempty"`
}

type Error struct {
	Code    string `json:"code"`
	Message string `json:"message"`
}

type Key struct {
	// Public key used for verifying signed webhook requests.
	Key *string `json:"key,omitempty"`
}

type ListSubscriptionsQueryParams struct {
	// Kind : The kind of application.
	Kind *AppResourceKind `key:"kind"`
}

type Service services.BaseService

type Servicer interface {
	/*
		CreateApp - appregistry service endpoint
		Creates an app.
		Parameters:
			createAppRequest: Creates a new app.
			resp: an optional pointer to a http.Response to be populated by this method. NOTE: only the first resp pointer will be used if multiple are provided
	*/
	CreateApp(createAppRequest CreateAppRequest, resp ...*http.Response) (*AppResponseCreateUpdate, error)
	/*
		CreateSubscription - appregistry service endpoint
		Creates a subscription.
		Parameters:
			appName: Creates a subscription between a tenant and an app.
			resp: an optional pointer to a http.Response to be populated by this method. NOTE: only the first resp pointer will be used if multiple are provided
	*/
	CreateSubscription(appName AppName, resp ...*http.Response) error
	/*
		DeleteApp - appregistry service endpoint
		Removes an app.
		Parameters:
			appName: App name.
			resp: an optional pointer to a http.Response to be populated by this method. NOTE: only the first resp pointer will be used if multiple are provided
	*/
	DeleteApp(appName string, resp ...*http.Response) error
	/*
		DeleteSubscription - appregistry service endpoint
		Removes a subscription.
		Parameters:
			appName: App name.
			resp: an optional pointer to a http.Response to be populated by this method. NOTE: only the first resp pointer will be used if multiple are provided
	*/
	DeleteSubscription(appName string, resp ...*http.Response) error
	/*
		GetApp - appregistry service endpoint
		Returns the metadata of an app.
		Parameters:
			appName: App name.
			resp: an optional pointer to a http.Response to be populated by this method. NOTE: only the first resp pointer will be used if multiple are provided
	*/
	GetApp(appName string, resp ...*http.Response) (*AppResponseGetList, error)
	/*
		GetKeys - appregistry service endpoint
		Returns a list of the public keys used for verifying signed webhook requests.
		Parameters:
			resp: an optional pointer to a http.Response to be populated by this method. NOTE: only the first resp pointer will be used if multiple are provided
	*/
	GetKeys(resp ...*http.Response) ([]Key, error)
	/*
		GetSubscription - appregistry service endpoint
		Returns or validates a subscription.
		Parameters:
			appName: App name.
			resp: an optional pointer to a http.Response to be populated by this method. NOTE: only the first resp pointer will be used if multiple are provided
	*/
	GetSubscription(appName string, resp ...*http.Response) (*Subscription, error)
	/*
		ListAppSubscriptions - appregistry service endpoint
		Returns the collection of subscriptions to an app.
		Parameters:
			appName: App name.
			resp: an optional pointer to a http.Response to be populated by this method. NOTE: only the first resp pointer will be used if multiple are provided
	*/
	ListAppSubscriptions(appName string, resp ...*http.Response) ([]Subscription, error)
	/*
		ListApps - appregistry service endpoint
		Returns a list of apps.
		Parameters:
			resp: an optional pointer to a http.Response to be populated by this method. NOTE: only the first resp pointer will be used if multiple are provided
	*/
	ListApps(resp ...*http.Response) ([]AppResponseGetList, error)
	/*
		ListSubscriptions - appregistry service endpoint
		Returns the tenant subscriptions.
		Parameters:
			query: a struct pointer of valid query parameters for the endpoint, nil to send no query parameters
			resp: an optional pointer to a http.Response to be populated by this method. NOTE: only the first resp pointer will be used if multiple are provided
	*/
	ListSubscriptions(query *ListSubscriptionsQueryParams, resp ...*http.Response) ([]Subscription, error)
	/*
		RotateSecret - appregistry service endpoint
		Rotates the client secret for an app.
		Parameters:
			appName: App name.
			resp: an optional pointer to a http.Response to be populated by this method. NOTE: only the first resp pointer will be used if multiple are provided
	*/
	RotateSecret(appName string, resp ...*http.Response) (*AppResponseCreateUpdate, error)
	/*
		UpdateApp - appregistry service endpoint
		Updates an app.
		Parameters:
			appName: App name.
			updateAppRequest: Updates app contents.
			resp: an optional pointer to a http.Response to be populated by this method. NOTE: only the first resp pointer will be used if multiple are provided
	*/
	UpdateApp(appName string, updateAppRequest UpdateAppRequest, resp ...*http.Response) (*AppResponseCreateUpdate, error)
}

type Subscription struct {
	// App name.
	AppName string `json:"appName"`
	// Time of subscription creation (UTC).
	CreatedAt string `json:"createdAt"`
	// The user who created the subscription.
	CreatedBy string `json:"createdBy"`
	// Short paragraph describing the app.
	Description string `json:"description"`
	// URL used to login to the app.
	LoginUrl string `json:"loginUrl"`
	// The URL used to display the app's logo.
	LogoUrl string `json:"logoUrl"`
	// Human-readable name for the application.
	Title string `json:"title"`
	// The tenant that is subscribed to the app.
	Tenant *string `json:"tenant,omitempty"`
}

type UpdateAppRequest struct {
	// Human-readable title for the app.
	Title string `json:"title"`
	// Array of permission templates that are used to grant permission to the app principal when a tenant subscribes.
	AppPrincipalPermissions []string `json:"appPrincipalPermissions,omitempty"`
	// Short paragraph describing the app.
	Description *string `json:"description,omitempty"`
	// The URL used to log in to the app.
	LoginUrl *string `json:"loginUrl,omitempty"`
	// The URL used to display the app's logo.
	LogoUrl *string `json:"logoUrl,omitempty"`
	// Array of URLs that can be used for redirect after logging into the app.
	RedirectUrls []string `json:"redirectUrls,omitempty"`
	// URL to redirect to after a subscription is created.
	SetupUrl *string `json:"setupUrl,omitempty"`
	// Array of permission filter templates that are used to intersect with a user's permissions when using the app.
	UserPermissionsFilter []string `json:"userPermissionsFilter,omitempty"`
	// URL that webhook events are sent to.
	WebhookUrl *string `json:"webhookUrl,omitempty"`
}