Skip to content

Latest commit

 

History

History
131 lines (83 loc) · 3.28 KB

PlanApiAPI.md

File metadata and controls

131 lines (83 loc) · 3.28 KB

\PlanApiAPI

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

Method HTTP request Description
PlanApiChangePlan Post /2022-09-01-00/plan ChangePlan plan-api
PlanApiDescribePlan Get /2022-09-01-00/plan DescribePlan plan-api

PlanApiChangePlan

PlanApiChangePlan(ctx).ChangePlanRequestBody(changePlanRequestBody).Execute()

ChangePlan plan-api

Example

package main

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

func main() {
	changePlanRequestBody := *openapiclient.NewChangePlanRequestBody("STARTER") // ChangePlanRequestBody | 

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

Path Parameters

Other Parameters

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

Name Type Description Notes
changePlanRequestBody ChangePlanRequestBody

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]

PlanApiDescribePlan

DescribePlanResult PlanApiDescribePlan(ctx).Execute()

DescribePlan plan-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.PlanApiAPI.PlanApiDescribePlan(context.Background()).Execute()
	if err != nil {
		fmt.Fprintf(os.Stderr, "Error when calling `PlanApiAPI.PlanApiDescribePlan``: %v\n", err)
		fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
	}
	// response from `PlanApiDescribePlan`: DescribePlanResult
	fmt.Fprintf(os.Stdout, "Response from `PlanApiAPI.PlanApiDescribePlan`: %v\n", resp)
}

Path Parameters

This endpoint does not need any parameter.

Other Parameters

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

Return type

DescribePlanResult

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]