apps_client.go

// Code generated by go-swagger; DO NOT EDIT.

package apps

// This file was generated by the swagger tool.
// Editing this file might prove futile when you re-run the swagger generate command

import (
	"github.com/go-openapi/runtime"

	strfmt "github.com/go-openapi/strfmt"
)

// New creates a new apps API client.
func New(transport runtime.ClientTransport, formats strfmt.Registry) *Client {
	return &Client{transport: transport, formats: formats}
}

/*
Client for apps API
*/
type Client struct {
	transport runtime.ClientTransport
	formats   strfmt.Registry
}

/*
CreateClusterApp installs an app

Install an app on a tenant cluster by posting to this endpoint.

The spec field represents the app we'll be installing, and so spec.name refers to
the name of the chart that installs this app in the catalog.

The response you get on a succesful create includes the status of the app. However
since the App is still initialising and this is an asynchronous operation, it is
likely that the fields in this status object will be all empty values.

To check on the status of your app, perform a GET to /v4/clusters/{cluster_id}/apps/,
and check the status field of the app.

### Example PUT request
```json
  {
    "spec": {
      "catalog": "sample-catalog",
      "name": "prometheus-chart",
      "namespace": "prometheus",
      "version": "0.2.0",
    }
  }
```

### About the user_config field in the response
This field is not editable by you, but is set automatically by the API
if a configmap named `{app_name}-user-values` exists in the tenant cluster
namespace on the control plane.

The `/v4/clusters/{cluster_id}/apps/{app_name}/config/` endpoints allows
you to create such a configmap using this API.

It is recommended to create your config before creating your app. This
will result in a faster deploy.

However, you can create your config after creating the app if you wish,
this API will take care of setting the `user_config` field of the app
correctly for you.

### Why can't I just set the `user_config` value myself?
It simplifies usage while also being a security measure.

Furthermore it is also a security measure and ensures that users of this
API can't access arbitrary configmaps of the control plane.

This API will only allow you to edit or access configmaps that adhere
to a strict naming convention.

*/
func (a *Client) CreateClusterApp(params *CreateClusterAppParams, authInfo runtime.ClientAuthInfoWriter) (*CreateClusterAppOK, error) {
	// TODO: Validate the params before sending
	if params == nil {
		params = NewCreateClusterAppParams()
	}

	result, err := a.transport.Submit(&runtime.ClientOperation{
		ID:                 "createClusterApp",
		Method:             "PUT",
		PathPattern:        "/v4/clusters/{cluster_id}/apps/{app_name}/",
		ProducesMediaTypes: []string{"application/json"},
		ConsumesMediaTypes: []string{"application/json"},
		Schemes:            []string{"https"},
		Params:             params,
		Reader:             &CreateClusterAppReader{formats: a.formats},
		AuthInfo:           authInfo,
		Context:            params.Context,
		Client:             params.HTTPClient,
	})
	if err != nil {
		return nil, err
	}
	return result.(*CreateClusterAppOK), nil

}

/*
DeleteClusterApp deletes an app

This operation allows a user to delete an app.

*/
func (a *Client) DeleteClusterApp(params *DeleteClusterAppParams, authInfo runtime.ClientAuthInfoWriter) (*DeleteClusterAppOK, error) {
	// TODO: Validate the params before sending
	if params == nil {
		params = NewDeleteClusterAppParams()
	}

	result, err := a.transport.Submit(&runtime.ClientOperation{
		ID:                 "deleteClusterApp",
		Method:             "DELETE",
		PathPattern:        "/v4/clusters/{cluster_id}/apps/{app_name}/",
		ProducesMediaTypes: []string{"application/json"},
		ConsumesMediaTypes: []string{"application/json"},
		Schemes:            []string{"https"},
		Params:             params,
		Reader:             &DeleteClusterAppReader{formats: a.formats},
		AuthInfo:           authInfo,
		Context:            params.Context,
		Client:             params.HTTPClient,
	})
	if err != nil {
		return nil, err
	}
	return result.(*DeleteClusterAppOK), nil

}

/*
GetAppCatalogs gets a list of app catalogs configured on your installation

Returns an array of app catalog objects, which contains further metadata,
including a URL to fetch the full index of each catalog.


#### About the Labels

- `application.giantswarm.io/catalog-type`
  Describes the type of catalog.

  - `managed` - Apps in this catalog are managed by Giant Swarm.
  - `incubator` - Apps in this catalog are a work in progress. They're
                  made with your Giant Swarm cluster in mind though, so
                  they should work. Feedback is appreciated on these apps.
  - `test` - Apps in this catalog will soon graduate to incubator status,
             you most likely will not see any `test` catalogs on your
             installations.
  - `community` - Apps in this catalog are provided by the kubernetes
                  community. They will most likely not work without making
                  some changes to the security settings of your cluster.

  App Catalogs can also be labeled as `internal`, however these catalogs
  contain apps that run on our control planes. These `internal` app catalogs
  will be filtered out and never shown when calling this endpoint.

  For more details on app catalogs visit: https://docs.giantswarm.io/basics/app-catalog/


### Example
```json
  [
    {
      "metadata": {
        "name": "sample-catalog",
        "labels": {
          "application.giantswarm.io/catalog-type": "test",
          "app-operator.giantswarm.io/version": "1.0.0",
        },
      },

      "spec": {
        "description": "Giant Swarm's Sample Catalog with a few apps to test things out.",
        "logoURL": "https://s.giantswarm.io/app-catalog/1/images/sample-catalog.png",

        "storage": {
          "URL": "https://giantswarm.github.com/sample-catalog/",
          "type": "helm"
        },
        "title": "Sample Catalog"
      }
    }
  ]
```

*/
func (a *Client) GetAppCatalogs(params *GetAppCatalogsParams, authInfo runtime.ClientAuthInfoWriter) (*GetAppCatalogsOK, error) {
	// TODO: Validate the params before sending
	if params == nil {
		params = NewGetAppCatalogsParams()
	}

	result, err := a.transport.Submit(&runtime.ClientOperation{
		ID:                 "getAppCatalogs",
		Method:             "GET",
		PathPattern:        "/v4/appcatalogs/",
		ProducesMediaTypes: []string{"application/json"},
		ConsumesMediaTypes: []string{"application/json"},
		Schemes:            []string{"https"},
		Params:             params,
		Reader:             &GetAppCatalogsReader{formats: a.formats},
		AuthInfo:           authInfo,
		Context:            params.Context,
		Client:             params.HTTPClient,
	})
	if err != nil {
		return nil, err
	}
	return result.(*GetAppCatalogsOK), nil

}

/*
GetClusterApps gets cluster apps

Returns an array of apps installed on a given cluster.

### Example
```json
  [
    {
      "metadata": {
        "name": "my-awesome-prometheus",
      },

      "spec": {
        "catalog": "sample-catalog"
        "name": "prometheus-chart",
        "namespace": "giantswarm",
        "version": "0.2.0",
        "user_config": {
          "configmap": {
            "name": "prometheus-user-values",
            "namespace": "123ab"
          }
        }
      },

      "status": {
        "app_version": "1.0.0",
        "release": {
          "last_deployed": "2019-04-08T12:34:00Z",
          "status": "DEPLOYED"
        },
        "version": "0.2.0",
      }
    }
  ]
```

*/
func (a *Client) GetClusterApps(params *GetClusterAppsParams, authInfo runtime.ClientAuthInfoWriter) (*GetClusterAppsOK, error) {
	// TODO: Validate the params before sending
	if params == nil {
		params = NewGetClusterAppsParams()
	}

	result, err := a.transport.Submit(&runtime.ClientOperation{
		ID:                 "getClusterApps",
		Method:             "GET",
		PathPattern:        "/v4/clusters/{cluster_id}/apps/",
		ProducesMediaTypes: []string{"application/json"},
		ConsumesMediaTypes: []string{"application/json"},
		Schemes:            []string{"https"},
		Params:             params,
		Reader:             &GetClusterAppsReader{formats: a.formats},
		AuthInfo:           authInfo,
		Context:            params.Context,
		Client:             params.HTTPClient,
	})
	if err != nil {
		return nil, err
	}
	return result.(*GetClusterAppsOK), nil

}

/*
ModifyClusterApp modifies an app

This operation allows you to modify an existing app.

The following attributes can be modified:

- `version`: Changing this field lets you upgrade or downgrade an app.

`catalog`, `name`, `namespace`, and `user_config` are not editable. If you need to move or rename an app, you should instead delete the app and make it again.

The request body must conform with the [JSON Patch Merge (RFC 7386)](https://tools.ietf.org/html/rfc7386) standard.
Requests have to be sent with the `Content-Type: application/merge-patch+json` header.

*/
func (a *Client) ModifyClusterApp(params *ModifyClusterAppParams, authInfo runtime.ClientAuthInfoWriter) (*ModifyClusterAppOK, error) {
	// TODO: Validate the params before sending
	if params == nil {
		params = NewModifyClusterAppParams()
	}

	result, err := a.transport.Submit(&runtime.ClientOperation{
		ID:                 "modifyClusterApp",
		Method:             "PATCH",
		PathPattern:        "/v4/clusters/{cluster_id}/apps/{app_name}/",
		ProducesMediaTypes: []string{"application/json"},
		ConsumesMediaTypes: []string{"application/json"},
		Schemes:            []string{"https"},
		Params:             params,
		Reader:             &ModifyClusterAppReader{formats: a.formats},
		AuthInfo:           authInfo,
		Context:            params.Context,
		Client:             params.HTTPClient,
	})
	if err != nil {
		return nil, err
	}
	return result.(*ModifyClusterAppOK), nil

}

// SetTransport changes the transport on the client
func (a *Client) SetTransport(transport runtime.ClientTransport) {
	a.transport = transport
}