Skip to content

Latest commit

 

History

History
327 lines (207 loc) · 8.32 KB

SignupApiAPI.md

File metadata and controls

327 lines (207 loc) · 8.32 KB

\SignupApiAPI

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

Method HTTP request Description
SignupApiChangePassword Post /2022-09-01-00/change-password ChangePassword signup-api
SignupApiRegenerateToken Post /2022-09-01-00/users/{id}/regenerate-token RegenerateToken signup-api
SignupApiResetPassword Post /2022-09-01-00/reset-password ResetPassword signup-api
SignupApiSignup Post /2022-09-01-00/signup Signup signup-api
SignupApiValidateToken Post /2022-09-01-00/validate-token ValidateToken signup-api

SignupApiChangePassword

SignupApiChangePassword(ctx).ChangePasswordRequest(changePasswordRequest).Execute()

ChangePassword signup-api

Example

package main

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

func main() {
	changePasswordRequest := *openapiclient.NewChangePasswordRequest("abc@gmail.com", "password", "fc7b8dea-a50b-4c9a-8864-fc3d845a2be6") // ChangePasswordRequest | 

	configuration := openapiclient.NewConfiguration()
	apiClient := openapiclient.NewAPIClient(configuration)
	r, err := apiClient.SignupApiAPI.SignupApiChangePassword(context.Background()).ChangePasswordRequest(changePasswordRequest).Execute()
	if err != nil {
		fmt.Fprintf(os.Stderr, "Error when calling `SignupApiAPI.SignupApiChangePassword``: %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 apiSignupApiChangePasswordRequest struct via the builder pattern

Name Type Description Notes
changePasswordRequest ChangePasswordRequest

Return type

(empty response body)

Authorization

No authorization required

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]

SignupApiRegenerateToken

SignupApiRegenerateToken(ctx, id).Execute()

RegenerateToken signup-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)
	r, err := apiClient.SignupApiAPI.SignupApiRegenerateToken(context.Background(), id).Execute()
	if err != nil {
		fmt.Fprintf(os.Stderr, "Error when calling `SignupApiAPI.SignupApiRegenerateToken``: %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.
id string

Other Parameters

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

Name Type Description Notes

Return type

(empty response body)

Authorization

No authorization required

HTTP request headers

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

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

SignupApiResetPassword

SignupApiResetPassword(ctx).ResetPasswordRequest(resetPasswordRequest).Execute()

ResetPassword signup-api

Example

package main

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

func main() {
	resetPasswordRequest := *openapiclient.NewResetPasswordRequest("abc@gmail.com") // ResetPasswordRequest | 

	configuration := openapiclient.NewConfiguration()
	apiClient := openapiclient.NewAPIClient(configuration)
	r, err := apiClient.SignupApiAPI.SignupApiResetPassword(context.Background()).ResetPasswordRequest(resetPasswordRequest).Execute()
	if err != nil {
		fmt.Fprintf(os.Stderr, "Error when calling `SignupApiAPI.SignupApiResetPassword``: %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 apiSignupApiResetPasswordRequest struct via the builder pattern

Name Type Description Notes
resetPasswordRequest ResetPasswordRequest

Return type

(empty response body)

Authorization

No authorization required

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]

SignupApiSignup

SignupApiSignup(ctx).SignupRequest(signupRequest).Execute()

Signup signup-api

Example

package main

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

func main() {
	signupRequest := *openapiclient.NewSignupRequest("abc@gmail.com", "John Doe", "password") // SignupRequest | 

	configuration := openapiclient.NewConfiguration()
	apiClient := openapiclient.NewAPIClient(configuration)
	r, err := apiClient.SignupApiAPI.SignupApiSignup(context.Background()).SignupRequest(signupRequest).Execute()
	if err != nil {
		fmt.Fprintf(os.Stderr, "Error when calling `SignupApiAPI.SignupApiSignup``: %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 apiSignupApiSignupRequest struct via the builder pattern

Name Type Description Notes
signupRequest SignupRequest

Return type

(empty response body)

Authorization

No authorization required

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]

SignupApiValidateToken

SignupApiValidateToken(ctx).ValidateTokenRequest(validateTokenRequest).Execute()

ValidateToken signup-api

Example

package main

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

func main() {
	validateTokenRequest := *openapiclient.NewValidateTokenRequest("abc@gmail.com", "fc7b8dea-a50b-4c9a-8864-fc3d845a2be6") // ValidateTokenRequest | 

	configuration := openapiclient.NewConfiguration()
	apiClient := openapiclient.NewAPIClient(configuration)
	r, err := apiClient.SignupApiAPI.SignupApiValidateToken(context.Background()).ValidateTokenRequest(validateTokenRequest).Execute()
	if err != nil {
		fmt.Fprintf(os.Stderr, "Error when calling `SignupApiAPI.SignupApiValidateToken``: %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 apiSignupApiValidateTokenRequest struct via the builder pattern

Name Type Description Notes
validateTokenRequest ValidateTokenRequest

Return type

(empty response body)

Authorization

No authorization required

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]