base

package
v0.2.7 Latest Latest
Warning

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

 Go to latest Published: Apr 28, 2026 License: Apache-2.0 Imports: 9 Imported by: 0

Documentation

Index

Constants

This section is empty.

Variables

This section is empty.

Functions

func Createbiscuit 

func Createbiscuit(ctx context.Context, c *client.Client, tracer trace.Tracer, ownerId string, kvId string, requestBody *models.IAMUserBiscuitBody) client.Response[models.IAMBiscuit]

Createbiscuit

Create biscuit

Parameters:

  • ctx: context for the request
  • client: the Clever Cloud client
  • tracer: OpenTelemetry tracer for observability
  • ownerId:
  • kvId:
  • requestBody: the request payload

Returns the operation result or an error

Example: 

response := base.Createbiscuit(ctx, client, tracer, ownerId, kvId, requestBody)
if response.HasError() {
	// Handle error
}
result := response.Payload()

x-service: base operationId: createBiscuit

func Createemailaddress 

func Createemailaddress(ctx context.Context, c *client.Client, tracer trace.Tracer, requestBody *models.WannabeEmailAddress) client.Response[models.EmailAddress]

Createemailaddress

Create a new email address.

Parameters:

  • ctx: context for the request
  • client: the Clever Cloud client
  • tracer: OpenTelemetry tracer for observability
  • requestBody: the request payload

Returns the operation result or an error

Example: 

response := base.Createemailaddress(ctx, client, tracer, requestBody)
if response.HasError() {
	// Handle error
}
result := response.Payload()

x-service: base operationId: createEmailAddress

func Createpartialidentity 

func Createpartialidentity(ctx context.Context, c *client.Client, tracer trace.Tracer, requestBody *models.WannabeEmailAddress) client.Response[models.PartialIdentity]

Createpartialidentity

Creates a partial identity and sends an email to complete the identity.

Parameters:

  • ctx: context for the request
  • client: the Clever Cloud client
  • tracer: OpenTelemetry tracer for observability
  • requestBody: the request payload

Returns the operation result or an error

Example: 

response := base.Createpartialidentity(ctx, client, tracer, requestBody)
if response.HasError() {
	// Handle error
}
result := response.Payload()

x-service: base operationId: createPartialIdentity

func Createpasswordrecovery 

func Createpasswordrecovery(ctx context.Context, c *client.Client, tracer trace.Tracer, requestBody *models.WannabePasswordRecovery) client.Response[client.Nothing]

Createpasswordrecovery

Password recovery

Parameters:

  • ctx: context for the request
  • client: the Clever Cloud client
  • tracer: OpenTelemetry tracer for observability
  • requestBody: the request payload

Returns the operation result or an error

Example: 

response := base.Createpasswordrecovery(ctx, client, tracer, requestBody)
if response.HasError() {
	// Handle error
}
result := response.Payload()

x-service: base operationId: createPasswordRecovery

func Createproduct 

func Createproduct(ctx context.Context, c *client.Client, tracer trace.Tracer, tenantId string, requestBody *models.WannabeProduct) client.Response[models.Product]

Createproduct

Create a new product.

Parameters:

  • ctx: context for the request
  • client: the Clever Cloud client
  • tracer: OpenTelemetry tracer for observability
  • tenantId:
  • requestBody: the request payload

Returns the operation result or an error

Example: 

response := base.Createproduct(ctx, client, tracer, tenantId, requestBody)
if response.HasError() {
	// Handle error
}
result := response.Payload()

x-service: base operationId: createProduct

func Createresource 

func Createresource(ctx context.Context, c *client.Client, tracer trace.Tracer, tenantId string, productId string, requestBody *models.WannabeResource) client.Response[models.Resource]

Createresource

Create a new resource.

Parameters:

  • ctx: context for the request
  • client: the Clever Cloud client
  • tracer: OpenTelemetry tracer for observability
  • tenantId:
  • productId:
  • requestBody: the request payload

Returns the operation result or an error

Example: 

response := base.Createresource(ctx, client, tracer, tenantId, productId, requestBody)
if response.HasError() {
	// Handle error
}
result := response.Payload()

x-service: base operationId: createResource

func Createtenant 

func Createtenant(ctx context.Context, c *client.Client, tracer trace.Tracer, requestBody *models.WannabeTenant) client.Response[models.Tenant1]

Createtenant

Create tenant.

Parameters:

  • ctx: context for the request
  • client: the Clever Cloud client
  • tracer: OpenTelemetry tracer for observability
  • requestBody: the request payload

Returns the operation result or an error

Example: 

response := base.Createtenant(ctx, client, tracer, requestBody)
if response.HasError() {
	// Handle error
}
result := response.Payload()

x-service: base operationId: createTenant

func Deletebiscuit 

func Deletebiscuit(ctx context.Context, c *client.Client, tracer trace.Tracer, ownerId string, p1 string) client.Response[client.Nothing]

Deletebiscuit

Revoke IAM biscuit

Parameters:

  • ctx: context for the request
  • client: the Clever Cloud client
  • tracer: OpenTelemetry tracer for observability
  • ownerId:
  • p1:

Returns the operation result or an error

Example: 

response := base.Deletebiscuit(ctx, client, tracer, ownerId, p1)
if response.HasError() {
	// Handle error
}
result := response.Payload()

x-service: base operationId: deleteBiscuit

func Deleteemailaddress 

func Deleteemailaddress(ctx context.Context, c *client.Client, tracer trace.Tracer, emailAddressId string) client.Response[client.Nothing]

Deleteemailaddress

Delete an email address by identity ID.

Parameters:

  • ctx: context for the request
  • client: the Clever Cloud client
  • tracer: OpenTelemetry tracer for observability
  • emailAddressId:

Returns the operation result or an error

Example: 

response := base.Deleteemailaddress(ctx, client, tracer, emailAddressId)
if response.HasError() {
	// Handle error
}
result := response.Payload()

x-service: base operationId: deleteEmailAddress

func Deleteidentity 

func Deleteidentity(ctx context.Context, c *client.Client, tracer trace.Tracer, identityId string) client.Response[client.Nothing]

Deleteidentity

Delete identity.

Parameters:

  • ctx: context for the request
  • client: the Clever Cloud client
  • tracer: OpenTelemetry tracer for observability
  • identityId:

Returns the operation result or an error

Example: 

response := base.Deleteidentity(ctx, client, tracer, identityId)
if response.HasError() {
	// Handle error
}
result := response.Payload()

x-service: base operationId: deleteIdentity

func Deletememberfromtenant 

func Deletememberfromtenant(ctx context.Context, c *client.Client, tracer trace.Tracer, tenantId string, identityId string) client.Response[client.Nothing]

Deletememberfromtenant

Remove a member from a tenant.

Parameters:

  • ctx: context for the request
  • client: the Clever Cloud client
  • tracer: OpenTelemetry tracer for observability
  • tenantId:
  • identityId:

Returns the operation result or an error

Example: 

response := base.Deletememberfromtenant(ctx, client, tracer, tenantId, identityId)
if response.HasError() {
	// Handle error
}
result := response.Payload()

x-service: base operationId: deleteMemberFromTenant

func Deleteproduct 

func Deleteproduct(ctx context.Context, c *client.Client, tracer trace.Tracer, tenantId string, productId string) client.Response[client.Nothing]

Deleteproduct

Delete a product.

Parameters:

  • ctx: context for the request
  • client: the Clever Cloud client
  • tracer: OpenTelemetry tracer for observability
  • tenantId:
  • productId:

Returns the operation result or an error

Example: 

response := base.Deleteproduct(ctx, client, tracer, tenantId, productId)
if response.HasError() {
	// Handle error
}
result := response.Payload()

x-service: base operationId: deleteProduct

func Deleteresource 

func Deleteresource(ctx context.Context, c *client.Client, tracer trace.Tracer, tenantId string, productId string, resourceId string) client.Response[client.Nothing]

Deleteresource

Delete a resource.

Parameters:

  • ctx: context for the request
  • client: the Clever Cloud client
  • tracer: OpenTelemetry tracer for observability
  • tenantId:
  • productId:
  • resourceId:

Returns the operation result or an error

Example: 

response := base.Deleteresource(ctx, client, tracer, tenantId, productId, resourceId)
if response.HasError() {
	// Handle error
}
result := response.Payload()

x-service: base operationId: deleteResource

func Deletetenant 

func Deletetenant(ctx context.Context, c *client.Client, tracer trace.Tracer, tenantId string) client.Response[client.Nothing]

Deletetenant

Delete tenant.

Parameters:

  • ctx: context for the request
  • client: the Clever Cloud client
  • tracer: OpenTelemetry tracer for observability
  • tenantId:

Returns the operation result or an error

Example: 

response := base.Deletetenant(ctx, client, tracer, tenantId)
if response.HasError() {
	// Handle error
}
result := response.Payload()

x-service: base operationId: deleteTenant

func Getbiscuit 

func Getbiscuit(ctx context.Context, c *client.Client, tracer trace.Tracer, ownerId string, p1 string) client.Response[models.IAMBiscuit]

Getbiscuit

Get IAM biscuit

Parameters:

  • ctx: context for the request
  • client: the Clever Cloud client
  • tracer: OpenTelemetry tracer for observability
  • ownerId:
  • p1:

Returns the operation result or an error

Example: 

response := base.Getbiscuit(ctx, client, tracer, ownerId, p1)
if response.HasError() {
	// Handle error
}
result := response.Payload()

x-service: base operationId: getBiscuit

func Getemailaddress 

func Getemailaddress(ctx context.Context, c *client.Client, tracer trace.Tracer, emailAddressId string) client.Response[models.EmailAddress]

Getemailaddress

Get an email address by identity ID.

Parameters:

  • ctx: context for the request
  • client: the Clever Cloud client
  • tracer: OpenTelemetry tracer for observability
  • emailAddressId:

Returns the operation result or an error

Example: 

response := base.Getemailaddress(ctx, client, tracer, emailAddressId)
if response.HasError() {
	// Handle error
}
result := response.Payload()

x-service: base operationId: getEmailAddress

func Getidentity 

func Getidentity(ctx context.Context, c *client.Client, tracer trace.Tracer, identityId string) client.Response[models.Identity]

Getidentity

Get identity view.

Parameters:

  • ctx: context for the request
  • client: the Clever Cloud client
  • tracer: OpenTelemetry tracer for observability
  • identityId:

Returns the operation result or an error

Example: 

response := base.Getidentity(ctx, client, tracer, identityId)
if response.HasError() {
	// Handle error
}
result := response.Payload()

x-service: base operationId: getIdentity

func Getproduct 

func Getproduct(ctx context.Context, c *client.Client, tracer trace.Tracer, tenantId string, productId string) client.Response[models.Product]

Getproduct

Get a product by id.

Parameters:

  • ctx: context for the request
  • client: the Clever Cloud client
  • tracer: OpenTelemetry tracer for observability
  • tenantId:
  • productId:

Returns the operation result or an error

Example: 

response := base.Getproduct(ctx, client, tracer, tenantId, productId)
if response.HasError() {
	// Handle error
}
result := response.Payload()

x-service: base operationId: getProduct

func Getresource 

func Getresource(ctx context.Context, c *client.Client, tracer trace.Tracer, tenantId string, productId string, resourceId string) client.Response[models.Resource]

Getresource

Get a resource by id.

Parameters:

  • ctx: context for the request
  • client: the Clever Cloud client
  • tracer: OpenTelemetry tracer for observability
  • tenantId:
  • productId:
  • resourceId:

Returns the operation result or an error

Example: 

response := base.Getresource(ctx, client, tracer, tenantId, productId, resourceId)
if response.HasError() {
	// Handle error
}
result := response.Payload()

x-service: base operationId: getResource

func Gettenant 

func Gettenant(ctx context.Context, c *client.Client, tracer trace.Tracer, tenantId string) client.Response[models.Tenant1]

Gettenant

Get tenant view.

Parameters:

  • ctx: context for the request
  • client: the Clever Cloud client
  • tracer: OpenTelemetry tracer for observability
  • tenantId:

Returns the operation result or an error

Example: 

response := base.Gettenant(ctx, client, tracer, tenantId)
if response.HasError() {
	// Handle error
}
result := response.Payload()

x-service: base operationId: getTenant

func Listavailableproducts 

func Listavailableproducts(ctx context.Context, c *client.Client, tracer trace.Tracer, opts ...Option) client.Response[[]models.ProductOutput]

Listavailableproducts

List available products with optional authentication.

Parameters:

  • ctx: context for the request
  • client: the Clever Cloud client
  • tracer: OpenTelemetry tracer for observability
  • opts: optional query parameters

Returns the operation result or an error

Example: 

response := base.Listavailableproducts(ctx, client, tracer, opts...)
if response.HasError() {
	// Handle error
}
result := response.Payload()

x-service: base operationId: listAvailableProducts

func Listavailableresources 

func Listavailableresources(ctx context.Context, c *client.Client, tracer trace.Tracer, tenantId string) client.Response[[]models.Resource]

Listavailableresources

Get available resources for a tenant.

Parameters:

  • ctx: context for the request
  • client: the Clever Cloud client
  • tracer: OpenTelemetry tracer for observability
  • tenantId:

Returns the operation result or an error

Example: 

response := base.Listavailableresources(ctx, client, tracer, tenantId)
if response.HasError() {
	// Handle error
}
result := response.Payload()

x-service: base operationId: listAvailableResources

func Listbiscuits added in v0.2.3 

func Listbiscuits(ctx context.Context, c *client.Client, tracer trace.Tracer, ownerId string, opts ...Option) client.Response[[]models.IAMBiscuit]

Listbiscuits

Get IAM biscuits

Parameters:

  • ctx: context for the request
  • client: the Clever Cloud client
  • tracer: OpenTelemetry tracer for observability
  • ownerId:
  • opts: optional query parameters

Returns the operation result or an error

Example: 

response := base.Listbiscuits(ctx, client, tracer, ownerId, opts...)
if response.HasError() {
	// Handle error
}
result := response.Payload()

x-service: base operationId: listBiscuits

func Listiamrevocations added in v0.2.3 

func Listiamrevocations(ctx context.Context, c *client.Client, tracer trace.Tracer, opts ...Option) client.Response[client.Nothing]

Listiamrevocations

Get revocation list

Parameters:

  • ctx: context for the request
  • client: the Clever Cloud client
  • tracer: OpenTelemetry tracer for observability
  • opts: optional query parameters

Returns the operation result or an error

Example: 

response := base.Listiamrevocations(ctx, client, tracer, opts...)
if response.HasError() {
	// Handle error
}
result := response.Payload()

x-service: base operationId: listIAMRevocations

func Listproducts 

func Listproducts(ctx context.Context, c *client.Client, tracer trace.Tracer, tenantId string) client.Response[[]models.Product]

Listproducts

List products for a tenant.

Parameters:

  • ctx: context for the request
  • client: the Clever Cloud client
  • tracer: OpenTelemetry tracer for observability
  • tenantId:

Returns the operation result or an error

Example: 

response := base.Listproducts(ctx, client, tracer, tenantId)
if response.HasError() {
	// Handle error
}
result := response.Payload()

x-service: base operationId: listProducts

func Listresources 

func Listresources(ctx context.Context, c *client.Client, tracer trace.Tracer, tenantId string, productId string) client.Response[[]models.Resource]

Listresources

Get resources for a product.

Parameters:

  • ctx: context for the request
  • client: the Clever Cloud client
  • tracer: OpenTelemetry tracer for observability
  • tenantId:
  • productId:

Returns the operation result or an error

Example: 

response := base.Listresources(ctx, client, tracer, tenantId, productId)
if response.HasError() {
	// Handle error
}
result := response.Payload()

x-service: base operationId: listResources

func Listtenants 

func Listtenants(ctx context.Context, c *client.Client, tracer trace.Tracer) client.Response[[]models.Tenant1]

Listtenants

Get tenants views.

Parameters:

  • ctx: context for the request
  • client: the Clever Cloud client
  • tracer: OpenTelemetry tracer for observability

Returns the operation result or an error

Example: 

response := base.Listtenants(ctx, client, tracer)
if response.HasError() {
	// Handle error
}
result := response.Payload()

x-service: base operationId: listTenants

func Login 

func Login(ctx context.Context, c *client.Client, tracer trace.Tracer, requestBody *models.WannabeLogged) client.Response[models.Logged]

Login

Login using email address and password.

Parameters:

  • ctx: context for the request
  • client: the Clever Cloud client
  • tracer: OpenTelemetry tracer for observability
  • requestBody: the request payload

Returns the operation result or an error

Example: 

response := base.Login(ctx, client, tracer, requestBody)
if response.HasError() {
	// Handle error
}
result := response.Payload()

x-service: base operationId: login

func Publishproduct 

func Publishproduct(ctx context.Context, c *client.Client, tracer trace.Tracer, tenantId string, productId string) client.Response[models.Product]

Publishproduct

Publish a product (make it publicly visible).

Parameters:

  • ctx: context for the request
  • client: the Clever Cloud client
  • tracer: OpenTelemetry tracer for observability
  • tenantId:
  • productId:

Returns the operation result or an error

Example: 

response := base.Publishproduct(ctx, client, tracer, tenantId, productId)
if response.HasError() {
	// Handle error
}
result := response.Payload()

x-service: base operationId: publishProduct

func Updateemailaddress 

func Updateemailaddress(ctx context.Context, c *client.Client, tracer trace.Tracer, emailAddressId string, requestBody *models.EmailAddressPatch) client.Response[models.EmailAddress]

Updateemailaddress

Update an email address by identity ID.

Parameters:

  • ctx: context for the request
  • client: the Clever Cloud client
  • tracer: OpenTelemetry tracer for observability
  • emailAddressId:
  • requestBody: the request payload

Returns the operation result or an error

Example: 

response := base.Updateemailaddress(ctx, client, tracer, emailAddressId, requestBody)
if response.HasError() {
	// Handle error
}
result := response.Payload()

x-service: base operationId: updateEmailAddress

func Updatepartialidentity 

func Updatepartialidentity(ctx context.Context, c *client.Client, tracer trace.Tracer, identityId string, requestBody *models.WannabeIdentity) client.Response[models.Identity]

Updatepartialidentity

Completes identity registration with password.

Parameters:

  • ctx: context for the request
  • client: the Clever Cloud client
  • tracer: OpenTelemetry tracer for observability
  • identityId:
  • requestBody: the request payload

Returns the operation result or an error

Example: 

response := base.Updatepartialidentity(ctx, client, tracer, identityId, requestBody)
if response.HasError() {
	// Handle error
}
result := response.Payload()

x-service: base operationId: updatePartialIdentity

func Updatepasswordrecovery 

func Updatepasswordrecovery(ctx context.Context, c *client.Client, tracer trace.Tracer, requestBody *models.CompletePasswordRecovery) client.Response[client.Nothing]

Updatepasswordrecovery

Password recovery

Parameters:

  • ctx: context for the request
  • client: the Clever Cloud client
  • tracer: OpenTelemetry tracer for observability
  • requestBody: the request payload

Returns the operation result or an error

Example: 

response := base.Updatepasswordrecovery(ctx, client, tracer, requestBody)
if response.HasError() {
	// Handle error
}
result := response.Payload()

x-service: base operationId: updatePasswordRecovery

func Updateproduct 

func Updateproduct(ctx context.Context, c *client.Client, tracer trace.Tracer, tenantId string, productId string, requestBody *models.ProductPatch) client.Response[models.Product]

Updateproduct

Update an existing product (partial update, excluding visibility).

Parameters:

  • ctx: context for the request
  • client: the Clever Cloud client
  • tracer: OpenTelemetry tracer for observability
  • tenantId:
  • productId:
  • requestBody: the request payload

Returns the operation result or an error

Example: 

response := base.Updateproduct(ctx, client, tracer, tenantId, productId, requestBody)
if response.HasError() {
	// Handle error
}
result := response.Payload()

x-service: base operationId: updateProduct

func Updateresource 

func Updateresource(ctx context.Context, c *client.Client, tracer trace.Tracer, tenantId string, productId string, resourceId string, requestBody *models.ResourcePatch) client.Response[models.Resource]

Updateresource

Update an existing resource.

Parameters:

  • ctx: context for the request
  • client: the Clever Cloud client
  • tracer: OpenTelemetry tracer for observability
  • tenantId:
  • productId:
  • resourceId:
  • requestBody: the request payload

Returns the operation result or an error

Example: 

response := base.Updateresource(ctx, client, tracer, tenantId, productId, resourceId, requestBody)
if response.HasError() {
	// Handle error
}
result := response.Payload()

x-service: base operationId: updateResource

Types

type Option 

type Option func(*Options)

Option defines a functional option for base operations

func WithFrom 

func WithFrom(from int) Option

WithFrom sets the from query parameter

func WithLocationid 

func WithLocationid(locationId string) Option

WithLocationid sets the locationId query parameter

func WithSize 

func WithSize(size int) Option

WithSize sets the size query parameter

func WithTag 

func WithTag(tag []string) Option

WithTag sets the tag query parameter

func WithTenantid 

func WithTenantid(tenantId string) Option

WithTenantid sets the tenantId query parameter

type Options 

type Options struct {
	From       *int      `url:"from,omitempty"`
	Locationid *string   `url:"locationId,omitempty"`
	Size       *int      `url:"size,omitempty"`
	Tag        *[]string `url:"tag,omitempty"`
	Tenantid   *string   `url:"tenantId,omitempty"`
}

Options holds query parameters for base operations

Source Files

View all Source files

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.