Skip to content

Latest commit

 

History

History
409 lines (265 loc) · 13.2 KB

ConsumptionUserApiAPI.md

File metadata and controls

409 lines (265 loc) · 13.2 KB

\ConsumptionUserApiAPI

All URIs are relative to https://api.omnistrate.cloud

Method HTTP request Description
ConsumptionUserApiDescribeUserBillingDetails Get /2022-09-01-00/resource-instance/user/{id}/billing-details DescribeUserBillingDetails consumption-user-api
ConsumptionUserApiDescribeUsersBySubscription Get /2022-09-01-00/resource-instance/subscription/{subscriptionId}/subscription-users DescribeUsersBySubscription consumption-user-api
ConsumptionUserApiInviteUser Post /2022-09-01-00/resource-instance/subscription/{subscriptionId}/invite-user InviteUser consumption-user-api
ConsumptionUserApiListAllSubscriptionUsers Get /2022-09-01-00/resource-instance/subscription-users ListAllSubscriptionUsers consumption-user-api
ConsumptionUserApiRevokeUserRole Delete /2022-09-01-00/resource-instance/subscription/{subscriptionId}/revoke-user-role RevokeUserRole consumption-user-api
ConsumptionUserApiSignin Post /2022-09-01-00/resource-instance/user/signin Signin consumption-user-api

ConsumptionUserApiDescribeUserBillingDetails

DescribeUserBillingDetailsResult ConsumptionUserApiDescribeUserBillingDetails(ctx, id).Execute()

DescribeUserBillingDetails consumption-user-api

Example

package main

import (
	"context"
	"fmt"
	"os"
	openapiclient "github.com/omnistrate-oss/omnistrate-sdk-go/v1"
)

func main() {
	id := "user-abcd1234" // string | 

	configuration := openapiclient.NewConfiguration()
	apiClient := openapiclient.NewAPIClient(configuration)
	resp, r, err := apiClient.ConsumptionUserApiAPI.ConsumptionUserApiDescribeUserBillingDetails(context.Background(), id).Execute()
	if err != nil {
		fmt.Fprintf(os.Stderr, "Error when calling `ConsumptionUserApiAPI.ConsumptionUserApiDescribeUserBillingDetails``: %v\n", err)
		fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
	}
	// response from `ConsumptionUserApiDescribeUserBillingDetails`: DescribeUserBillingDetailsResult
	fmt.Fprintf(os.Stdout, "Response from `ConsumptionUserApiAPI.ConsumptionUserApiDescribeUserBillingDetails`: %v\n", resp)
}

Path Parameters

Name Type Description Notes
ctx context.Context context for authentication, logging, cancellation, deadlines, tracing, etc.
id string

Other Parameters

Other parameters are passed through a pointer to a apiConsumptionUserApiDescribeUserBillingDetailsRequest struct via the builder pattern

Name Type Description Notes

Return type

DescribeUserBillingDetailsResult

Authorization

api_key_header_Authorization

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json, application/vnd.goa.error

[Back to top] [Back to API list] [Back to Model list] [Back to README]

ConsumptionUserApiDescribeUsersBySubscription

DescribeUsersBySubscriptionResult ConsumptionUserApiDescribeUsersBySubscription(ctx, subscriptionId).Execute()

DescribeUsersBySubscription consumption-user-api

Example

package main

import (
	"context"
	"fmt"
	"os"
	openapiclient "github.com/omnistrate-oss/omnistrate-sdk-go/v1"
)

func main() {
	subscriptionId := "sub-abcd1234" // string | The subscription ID

	configuration := openapiclient.NewConfiguration()
	apiClient := openapiclient.NewAPIClient(configuration)
	resp, r, err := apiClient.ConsumptionUserApiAPI.ConsumptionUserApiDescribeUsersBySubscription(context.Background(), subscriptionId).Execute()
	if err != nil {
		fmt.Fprintf(os.Stderr, "Error when calling `ConsumptionUserApiAPI.ConsumptionUserApiDescribeUsersBySubscription``: %v\n", err)
		fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
	}
	// response from `ConsumptionUserApiDescribeUsersBySubscription`: DescribeUsersBySubscriptionResult
	fmt.Fprintf(os.Stdout, "Response from `ConsumptionUserApiAPI.ConsumptionUserApiDescribeUsersBySubscription`: %v\n", resp)
}

Path Parameters

Name Type Description Notes
ctx context.Context context for authentication, logging, cancellation, deadlines, tracing, etc.
subscriptionId string The subscription ID

Other Parameters

Other parameters are passed through a pointer to a apiConsumptionUserApiDescribeUsersBySubscriptionRequest struct via the builder pattern

Name Type Description Notes

Return type

DescribeUsersBySubscriptionResult

Authorization

api_key_header_Authorization

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json, application/vnd.goa.error

[Back to top] [Back to API list] [Back to Model list] [Back to README]

ConsumptionUserApiInviteUser

ConsumptionUserApiInviteUser(ctx, subscriptionId).InviteConsumptionUserRequest2(inviteConsumptionUserRequest2).Execute()

InviteUser consumption-user-api

Example

package main

import (
	"context"
	"fmt"
	"os"
	openapiclient "github.com/omnistrate-oss/omnistrate-sdk-go/v1"
)

func main() {
	subscriptionId := "sub-abcd1234" // string | The subscription ID
	inviteConsumptionUserRequest2 := *openapiclient.NewInviteConsumptionUserRequest2("abc@gmail.com", "reader") // InviteConsumptionUserRequest2 | 

	configuration := openapiclient.NewConfiguration()
	apiClient := openapiclient.NewAPIClient(configuration)
	r, err := apiClient.ConsumptionUserApiAPI.ConsumptionUserApiInviteUser(context.Background(), subscriptionId).InviteConsumptionUserRequest2(inviteConsumptionUserRequest2).Execute()
	if err != nil {
		fmt.Fprintf(os.Stderr, "Error when calling `ConsumptionUserApiAPI.ConsumptionUserApiInviteUser``: %v\n", err)
		fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
	}
}

Path Parameters

Name Type Description Notes
ctx context.Context context for authentication, logging, cancellation, deadlines, tracing, etc.
subscriptionId string The subscription ID

Other Parameters

Other parameters are passed through a pointer to a apiConsumptionUserApiInviteUserRequest struct via the builder pattern

Name Type Description Notes

inviteConsumptionUserRequest2 | InviteConsumptionUserRequest2 | |

Return type

(empty response body)

Authorization

api_key_header_Authorization

HTTP request headers

  • Content-Type: application/json
  • Accept: application/vnd.goa.error

[Back to top] [Back to API list] [Back to Model list] [Back to README]

ConsumptionUserApiListAllSubscriptionUsers

ListAllSubscriptionUsersResult ConsumptionUserApiListAllSubscriptionUsers(ctx).EnvironmentType(environmentType).Execute()

ListAllSubscriptionUsers consumption-user-api

Example

package main

import (
	"context"
	"fmt"
	"os"
	openapiclient "github.com/omnistrate-oss/omnistrate-sdk-go/v1"
)

func main() {
	environmentType := "DEV" // string | The environment type to filter by (optional)

	configuration := openapiclient.NewConfiguration()
	apiClient := openapiclient.NewAPIClient(configuration)
	resp, r, err := apiClient.ConsumptionUserApiAPI.ConsumptionUserApiListAllSubscriptionUsers(context.Background()).EnvironmentType(environmentType).Execute()
	if err != nil {
		fmt.Fprintf(os.Stderr, "Error when calling `ConsumptionUserApiAPI.ConsumptionUserApiListAllSubscriptionUsers``: %v\n", err)
		fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
	}
	// response from `ConsumptionUserApiListAllSubscriptionUsers`: ListAllSubscriptionUsersResult
	fmt.Fprintf(os.Stdout, "Response from `ConsumptionUserApiAPI.ConsumptionUserApiListAllSubscriptionUsers`: %v\n", resp)
}

Path Parameters

Other Parameters

Other parameters are passed through a pointer to a apiConsumptionUserApiListAllSubscriptionUsersRequest struct via the builder pattern

Name Type Description Notes
environmentType string The environment type to filter by

Return type

ListAllSubscriptionUsersResult

Authorization

api_key_header_Authorization

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json, application/vnd.goa.error

[Back to top] [Back to API list] [Back to Model list] [Back to README]

ConsumptionUserApiRevokeUserRole

ConsumptionUserApiRevokeUserRole(ctx, subscriptionId).RevokeConsumptionUserRoleRequest2(revokeConsumptionUserRoleRequest2).Execute()

RevokeUserRole consumption-user-api

Example

package main

import (
	"context"
	"fmt"
	"os"
	openapiclient "github.com/omnistrate-oss/omnistrate-sdk-go/v1"
)

func main() {
	subscriptionId := "sub-abcd1234" // string | The subscription ID
	revokeConsumptionUserRoleRequest2 := *openapiclient.NewRevokeConsumptionUserRoleRequest2("abc@gmail.com", "reader") // RevokeConsumptionUserRoleRequest2 | 

	configuration := openapiclient.NewConfiguration()
	apiClient := openapiclient.NewAPIClient(configuration)
	r, err := apiClient.ConsumptionUserApiAPI.ConsumptionUserApiRevokeUserRole(context.Background(), subscriptionId).RevokeConsumptionUserRoleRequest2(revokeConsumptionUserRoleRequest2).Execute()
	if err != nil {
		fmt.Fprintf(os.Stderr, "Error when calling `ConsumptionUserApiAPI.ConsumptionUserApiRevokeUserRole``: %v\n", err)
		fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
	}
}

Path Parameters

Name Type Description Notes
ctx context.Context context for authentication, logging, cancellation, deadlines, tracing, etc.
subscriptionId string The subscription ID

Other Parameters

Other parameters are passed through a pointer to a apiConsumptionUserApiRevokeUserRoleRequest struct via the builder pattern

Name Type Description Notes

revokeConsumptionUserRoleRequest2 | RevokeConsumptionUserRoleRequest2 | |

Return type

(empty response body)

Authorization

api_key_header_Authorization

HTTP request headers

  • Content-Type: application/json
  • Accept: application/vnd.goa.error

[Back to top] [Back to API list] [Back to Model list] [Back to README]

ConsumptionUserApiSignin

ConsumptionServiceAuthResult ConsumptionUserApiSignin(ctx).Execute()

Signin consumption-user-api

Example

package main

import (
	"context"
	"fmt"
	"os"
	openapiclient "github.com/omnistrate-oss/omnistrate-sdk-go/v1"
)

func main() {

	configuration := openapiclient.NewConfiguration()
	apiClient := openapiclient.NewAPIClient(configuration)
	resp, r, err := apiClient.ConsumptionUserApiAPI.ConsumptionUserApiSignin(context.Background()).Execute()
	if err != nil {
		fmt.Fprintf(os.Stderr, "Error when calling `ConsumptionUserApiAPI.ConsumptionUserApiSignin``: %v\n", err)
		fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
	}
	// response from `ConsumptionUserApiSignin`: ConsumptionServiceAuthResult
	fmt.Fprintf(os.Stdout, "Response from `ConsumptionUserApiAPI.ConsumptionUserApiSignin`: %v\n", resp)
}

Path Parameters

This endpoint does not need any parameter.

Other Parameters

Other parameters are passed through a pointer to a apiConsumptionUserApiSigninRequest struct via the builder pattern

Return type

ConsumptionServiceAuthResult

Authorization

basic_header_Authorization

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json, application/vnd.goa.error

[Back to top] [Back to API list] [Back to Model list] [Back to README]