Categorygithub.com/speakeasy-sdks/logicgate-dev-sample-sdk

# README

github.com/speakeasy-sdks/logicgate-dev-sample-sdk

SDK Installation

go get github.com/speakeasy-sdks/logicgate-dev-sample-sdk

SDK Example Usage

package main

import (
	"context"
	logicgatedevsamplesdk "github.com/speakeasy-sdks/logicgate-dev-sample-sdk"
	"github.com/speakeasy-sdks/logicgate-dev-sample-sdk/pkg/models/shared"
	"log"
)

func main() {
	s := logicgatedevsamplesdk.New(
		logicgatedevsamplesdk.WithSecurity(shared.Security{
			Basic: &shared.SchemeBasic{
				Password: "",
				Username: "",
			},
		}),
	)

	applicationAPICreateIn := shared.ApplicationAPICreateIn{
		Color: logicgatedevsamplesdk.String("#00a3de"),
		Icon:  shared.ApplicationAPICreateInIconCubes.ToPointer(),
		Name:  "Cyber Risk Management Application",
		Type:  shared.ApplicationAPICreateInTypeControlsCompliance.ToPointer(),
	}

	ctx := context.Background()
	res, err := s.Application.Create(ctx, applicationAPICreateIn)
	if err != nil {
		log.Fatal(err)
	}

	if res.ApplicationAPIOut != nil {
		// handle response
	}
}

Available Resources and Operations

Application

  • Create - Create an application
  • Delete - Delete an application
  • Read - Retrieve an application
  • ReadAll - Retrieve applications
  • Update - Update an application

Authentication

Field

Record

Step

Workflow

WorkflowMap

  • Create - Create a workflow map
  • Delete - Delete a workflow map
  • Read - Retrieve a workflow map
  • ReadAll - Retrieve workflow maps
  • Update - Update a workflow map

Development

Maturity

This SDK is in beta, and there may be breaking changes between versions without a major version update. Therefore, we recommend pinning usage to a specific package version. This way, you can install the same version each time without breaking changes unless you are intentionally looking for the latest version.

Contributions

While we value open-source contributions to this SDK, this library is generated programmatically. Feel free to open a PR or a Github issue as a proof of concept and we'll do our best to include it in a future release!

SDK Created by Speakeasy

# Packages

No description provided by the author

# Functions

Bool provides a helper function to return a pointer to a bool.
Float32 provides a helper function to return a pointer to a float32.
Float64 provides a helper function to return a pointer to a float64.
Int provides a helper function to return a pointer to an int.
Int64 provides a helper function to return a pointer to an int64.
New creates a new instance of the SDK with the provided options.
String provides a helper function to return a pointer to a string.
WithClient allows the overriding of the default HTTP client used by the SDK.
No description provided by the author
No description provided by the author
WithSecuritySource configures the SDK to invoke the Security Source function on each method call to determine authentication.
WithServerIndex allows the overriding of the default server by index.
WithServerURL allows the overriding of the default server URL.
WithTemplatedServerURL allows the overriding of the default server URL with a templated URL populated with the provided parameters.

# Variables

ServerList contains the list of servers available to the SDK.

# Structs

RiskCloudAPI - Risk Cloud API: Welcome to the Risk Cloud API v2! This is a collection of new API-first and RESTful API endpoints to streamline the creation of custom integrations with the Risk Cloud.

# Interfaces

HTTPClient provides an interface for suplying the SDK with a custom HTTP client.

# Type aliases

No description provided by the author