Skip to content

Latest commit

 

History

History
288 lines (186 loc) · 9.26 KB

SubscriptionInvitesAPI.md

File metadata and controls

288 lines (186 loc) · 9.26 KB
Raw

\SubscriptionInvitesAPI

All URIs are relative to http://localhost

Method HTTP request Description
SubscriptionInvitesAcceptInvite Get /api/manage/v1/Subscriptions/{subscriptionId}/invite/{accessToken}/accept Add a user to the subscription using invite, the added users will be displayed in the list of users of the subscription, and these users will also have an active subscription.
SubscriptionInvitesCreateInvite Post /api/manage/v1/Subscriptions/{subscriptionId}/invite Create invite to subscription
SubscriptionInvitesDeleteInvite Delete /api/manage/v1/Subscriptions/{subscriptionId}/invite/{accesstoken} Delete invite with specified token
SubscriptionInvitesGetInvites Get /api/manage/v1/Subscriptions/{subscriptionId}/invites Get list of invites in a subscription, the added users will be displayed in the list of users of the subscription, and these users will also have an active subscription.

SubscriptionInvitesAcceptInvite

SubscriptionInvitesAcceptInvite(ctx, subscriptionId, accessToken).Execute()

Add a user to the subscription using invite, the added users will be displayed in the list of users of the subscription, and these users will also have an active subscription.

Example

package main

import (
	"context"
	"fmt"
	"os"
	openapiclient "github.com/fastreports/gofrcloud"
)

func main() {
	subscriptionId := "subscriptionId_example" // string | Idenitifier of subscription
	accessToken := "accessToken_example" // string | access token of the subscription

	configuration := openapiclient.NewConfiguration()
	apiClient := openapiclient.NewAPIClient(configuration)
	r, err := apiClient.SubscriptionInvitesAPI.SubscriptionInvitesAcceptInvite(context.Background(), subscriptionId, accessToken).Execute()
	if err != nil {
		fmt.Fprintf(os.Stderr, "Error when calling `SubscriptionInvitesAPI.SubscriptionInvitesAcceptInvite``: %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 Idenitifier of subscription
accessToken string access token of the subscription

Other Parameters

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

Name Type Description Notes

Return type

(empty response body)

Authorization

ApiKey, JWT

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json

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

SubscriptionInvitesCreateInvite

SubscriptionInviteVM SubscriptionInvitesCreateInvite(ctx, subscriptionId).CreateSubscriptionInviteVM(createSubscriptionInviteVM).Execute()

Create invite to subscription

Example

package main

import (
	"context"
	"fmt"
	"os"
	openapiclient "github.com/fastreports/gofrcloud"
)

func main() {
	subscriptionId := "subscriptionId_example" // string | id
	createSubscriptionInviteVM := *openapiclient.NewCreateSubscriptionInviteVM("T_example") // CreateSubscriptionInviteVM | create VM (optional)

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

Path Parameters

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

Other Parameters

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

Name Type Description Notes

createSubscriptionInviteVM | CreateSubscriptionInviteVM | create VM |

Return type

SubscriptionInviteVM

Authorization

ApiKey, JWT

HTTP request headers

  • Content-Type: application/json, text/json, application/*+json
  • Accept: application/json

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

SubscriptionInvitesDeleteInvite

SubscriptionInvitesDeleteInvite(ctx, subscriptionId, accesstoken).Execute()

Delete invite with specified token

Example

package main

import (
	"context"
	"fmt"
	"os"
	openapiclient "github.com/fastreports/gofrcloud"
)

func main() {
	subscriptionId := "subscriptionId_example" // string | id
	accesstoken := "accesstoken_example" // string | invite's token

	configuration := openapiclient.NewConfiguration()
	apiClient := openapiclient.NewAPIClient(configuration)
	r, err := apiClient.SubscriptionInvitesAPI.SubscriptionInvitesDeleteInvite(context.Background(), subscriptionId, accesstoken).Execute()
	if err != nil {
		fmt.Fprintf(os.Stderr, "Error when calling `SubscriptionInvitesAPI.SubscriptionInvitesDeleteInvite``: %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 id
accesstoken string invite's token

Other Parameters

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

Name Type Description Notes

Return type

(empty response body)

Authorization

ApiKey, JWT

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json

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

SubscriptionInvitesGetInvites

SubscriptionInvitesVM SubscriptionInvitesGetInvites(ctx, subscriptionId).Execute()

Get list of invites in a subscription, the added users will be displayed in the list of users of the subscription, and these users will also have an active subscription.

Example

package main

import (
	"context"
	"fmt"
	"os"
	openapiclient "github.com/fastreports/gofrcloud"
)

func main() {
	subscriptionId := "subscriptionId_example" // string | Idenitifier of subscription

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

Path Parameters

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

Other Parameters

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

Name Type Description Notes

Return type

SubscriptionInvitesVM

Authorization

ApiKey, JWT

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json

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