runtime_keygen_openapi 1.0.0 copy "runtime_keygen_openapi: ^1.0.0" to clipboard
runtime_keygen_openapi: ^1.0.0 copied to clipboard

Published 45 days ago • verified publisherruntime.devDart 3 compatible
SDKDartFlutter
PlatformAndroidiOSLinuxmacOSWindows
→

Metadata

A Dart package for Keygen (keygen.sh) OpenAPI bindings

More...

runtime_keygen_openapi #

The Keygen API is organized around REST principles. All requests must be made over TLS/SSL. We only support TLS 1.2, for security reasons. All API request and response bodies, including errors, are encoded in JSON format.

The API has predictable, resource-oriented URLs, and uses standard HTTP response codes to indicate API errors. We use built-in HTTP features, like authentication and HTTP verbs, which are understood by off-the-shelf HTTP clients. We support cross-origin resource sharing, allowing you to interact securely with our API from any client-facing software application.

This Dart package is automatically generated by the OpenAPI Generator project:

  • API version: 1.0.0
  • Build package: org.openapitools.codegen.languages.DartClientCodegen For more information, please visit https://keygen.sh

Requirements #

Dart 2.12 or later

Installation & Usage #

Github #

If this Dart package is published to Github, add the following dependency to your pubspec.yaml

dependencies:
  runtime_keygen_openapi:
    git: https://github.com/GIT_USER_ID/GIT_REPO_ID.git

Local #

To use the package in your local drive, add the following dependency to your pubspec.yaml

dependencies:
  runtime_keygen_openapi:
    path: /path/to/runtime_keygen_openapi

Tests #

TODO

Getting Started #

Please follow the installation procedure and then run the following:

import 'package:runtime_keygen_openapi/api.dart';

// TODO Configure HTTP Bearer authorization: BearerToken
// Case 1. Use String Token
//defaultApiClient.getAuthentication<HttpBearerAuth>('BearerToken').setAccessToken('YOUR_ACCESS_TOKEN');
// Case 2. Use Function which generate token.
// String yourTokenGeneratorFunction() { ... }
//defaultApiClient.getAuthentication<HttpBearerAuth>('BearerToken').setAccessToken(yourTokenGeneratorFunction);

final api_instance = EntitlementsApi();
final account = account_example; // String | The identifier (UUID) or slug of your Keygen account.
final createEntitlementRequest = CreateEntitlementRequest(); // CreateEntitlementRequest | 

try {
    final result = api_instance.createEntitlement(account, createEntitlementRequest);
    print(result);
} catch (e) {
    print('Exception when calling EntitlementsApi->createEntitlement: $e\n');
}

Documentation for API Endpoints #

All URIs are relative to https://api.keygen.sh/v1

Class Method HTTP request Description
EntitlementsApi createEntitlement POST /accounts/{account}/entitlements Create an entitlement
EntitlementsApi deleteEntitlement DELETE /accounts/{account}/entitlements/{entitlement} Delete an entitlement
EntitlementsApi listEntitlements GET /accounts/{account}/entitlements List all entitlements
EntitlementsApi retrieveEntitlement GET /accounts/{account}/entitlements/{entitlement} Retrieve an entitlement
EntitlementsApi updateEntitlement PATCH /accounts/{account}/entitlements/{entitlement} Update an entitlement
GroupsApi createGroup POST /accounts/{account}/groups Create a group
GroupsApi deleteGroup DELETE /accounts/{account}/groups/{group} Delete a group
GroupsApi listGroups GET /accounts/{account}/groups List all groups
GroupsApi retrieveGroup GET /accounts/{account}/groups/{group} Retrieve a group
GroupsApi updateGroup PATCH /accounts/{account}/groups/{group} Update a group
LicensesApi attachLicenseEntitlements POST /accounts/{account}/licenses/{license}/entitlements Attach license entitlements
LicensesApi changeLicenseGroup PUT /accounts/{account}/licenses/{license}/group Change group
LicensesApi changeLicensePolicy PUT /accounts/{account}/licenses/{license}/policy Change policy
LicensesApi changeLicenseUser PUT /accounts/{account}/licenses/{license}/user Change user
LicensesApi checkInLicense POST /accounts/{account}/licenses/{license}/actions/check-in Check-in a license
LicensesApi checkOutLicense POST /accounts/{account}/licenses/{license}/actions/check-out Check-out license
LicensesApi createLicense POST /accounts/{account}/licenses Create a license
LicensesApi createLicenseToken POST /accounts/{account}/licenses/{license}/tokens Generate a license token
LicensesApi decrementLicenseUsage POST /accounts/{account}/licenses/{license}/actions/decrement-usage Decrement license usage
LicensesApi deleteLicense DELETE /accounts/{account}/licenses/{license} Delete a license
LicensesApi detachLicenseEntitlements DELETE /accounts/{account}/licenses/{license}/entitlements Detach license entitlements
LicensesApi incrementLicenseUsage POST /accounts/{account}/licenses/{license}/actions/increment-usage Increment license usage
LicensesApi listLicenseEntitlements GET /accounts/{account}/licenses/{license}/entitlements List license entitlements
LicensesApi listLicenses GET /accounts/{account}/licenses List all licenses
LicensesApi reinstateLicense POST /accounts/{account}/licenses/{license}/actions/reinstate Reinstate a license
LicensesApi renewLicense POST /accounts/{account}/licenses/{license}/actions/renew Renew a license
LicensesApi resetLicenseUsage POST /accounts/{account}/licenses/{license}/actions/reset-usage Reset license usage
LicensesApi retrieveLicense GET /accounts/{account}/licenses/{license} Retrieve a license
LicensesApi revokeLicense POST /accounts/{account}/licenses/{license}/actions/revoke Revoke a license
LicensesApi suspendLicense POST /accounts/{account}/licenses/{license}/actions/suspend Suspend a license
LicensesApi updateLicense PATCH /accounts/{account}/licenses/{license} Update a license
LicensesApi validateLicense POST /accounts/{account}/licenses/{license}/actions/validate Validate by license ID
LicensesApi validateLicenseKey POST /accounts/{account}/licenses/actions/validate-key Validate by license key
MachinesApi activateMachine POST /accounts/{account}/machines Activate a machine
MachinesApi changeMachineGroup PUT /accounts/{account}/machines/{machine}/group Change group
MachinesApi checkOutMachine POST /accounts/{account}/machines/{machine}/actions/check-out Check-out machine
MachinesApi deactivateMachine DELETE /accounts/{account}/machines/{machine} Deactivate a machine
MachinesApi listMachines GET /accounts/{account}/machines List all machines
MachinesApi pingMachine POST /accounts/{account}/machines/{machine}/actions/ping Ping heartbeat
MachinesApi resetMachine POST /accounts/{account}/machines/{machine}/actions/reset Reset heartbeat
MachinesApi retrieveMachine GET /accounts/{account}/machines/{machine} Retrieve a machine
MachinesApi updateMachine PATCH /accounts/{account}/machines/{machine} Update a machine
PasswordsApi forgotPassword POST /accounts/{account}/passwords Forgot password
PoliciesApi attachPolicyEntitlements POST /accounts/{account}/policies/{policy}/entitlements Attach policy entitlements
PoliciesApi createPolicy POST /accounts/{account}/policies Create a policy
PoliciesApi deletePolicy DELETE /accounts/{account}/policies/{policy} Delete a policy
PoliciesApi detachPolicyEntitlements DELETE /accounts/{account}/policies/{policy}/entitlements Detach policy entitlements
PoliciesApi listPolicies GET /accounts/{account}/policies List all policies
PoliciesApi listPolicyEntitlements GET /accounts/{account}/policies/{policy}/entitlements List policy entitlements
PoliciesApi popKeyFromPolicyPool DELETE /accounts/{account}/policies/{policy}/pool Pop key from pool
PoliciesApi retrievePolicy GET /accounts/{account}/policies/{policy} Retrieve a policy
PoliciesApi updatePolicy PATCH /accounts/{account}/policies/{policy} Update a policy
ProcessesApi killProcess DELETE /accounts/{account}/processes/{process} Kill a process
ProcessesApi listProcesses GET /accounts/{account}/processes List all processes
ProcessesApi pingProcess POST /accounts/{account}/processes/{process}/actions/ping Ping
ProcessesApi retrieveProcess GET /accounts/{account}/processes/{process} Retrieve a process
ProcessesApi spawnProcess POST /accounts/{account}/processes Spawn a process
ProcessesApi updateProcess PATCH /accounts/{account}/processes/{process} Update a process
ProductsApi createProduct POST /accounts/{account}/products Create a product
ProductsApi deleteProduct DELETE /accounts/{account}/products/{product} Delete a product
ProductsApi generateProductToken POST /accounts/{account}/products/{product}/tokens Generate a product token
ProductsApi listProducts GET /accounts/{account}/products List all products
ProductsApi retrieveProduct GET /accounts/{account}/products/{product} Retrieve a product
ProductsApi updateProduct PATCH /accounts/{account}/products/{product} Update a product
ProfilesApi retrieveProfile GET /accounts/{account}/me Who Am I?
SecondFactorsApi addSecondFactor POST /accounts/{account}/users/{user}/second-factors Add a second factor
SecondFactorsApi deleteSecondFactor DELETE /accounts/{account}/users/{user}/second-factors/{second-factor} Delete a second factor
SecondFactorsApi listSecondFactors GET /accounts/{account}/users/{user}/second-factors List second factors
SecondFactorsApi retrieveSecondFactor GET /accounts/{account}/users/{user}/second-factors/{second-factor} Retrieve a second factor
SecondFactorsApi updateSecondFactor PATCH /accounts/{account}/users/{user}/second-factors/{second-factor} Update a second factor
TokensApi generateToken POST /accounts/{account}/tokens Generate a token
TokensApi listTokens GET /accounts/{account}/tokens List all tokens
TokensApi regenerateToken PUT /accounts/{account}/tokens/{token} Regenerate a token
TokensApi retrieveToken GET /accounts/{account}/tokens/{token} Retrieve a token
TokensApi revokeToken DELETE /accounts/{account}/tokens/{token} Revoke a token
UsersApi banUser POST /accounts/{account}/users/{user}/actions/ban Ban user
UsersApi changeUserGroup PUT /accounts/{account}/users/{user}/group Change group
UsersApi createUser POST /accounts/{account}/users Create a user
UsersApi deleteUser DELETE /accounts/{account}/users/{user} Delete a user
UsersApi generateUserToken POST /accounts/{account}/users/{user}/tokens Generate a user token
UsersApi listUsers GET /accounts/{account}/users List all users
UsersApi resetUserPassword POST /accounts/{account}/users/{user}/actions/reset-password Reset password
UsersApi retrieveUser GET /accounts/{account}/users/{user} Retrieve a user
UsersApi unbanUser POST /accounts/{account}/users/{user}/actions/unban Unban user
UsersApi updateUser PATCH /accounts/{account}/users/{user} Update a user
UsersApi updateUserPassword POST /accounts/{account}/users/{user}/actions/update-password Update password

Documentation For Models #

Documentation For Authorization #

Authentication schemes defined for the API:

BasicAuth #

  • Type: HTTP Basic authentication

BearerToken #

  • Type: HTTP Bearer authentication

Author #

support@keygen.sh

← Metadata

0
likes
120
pub points
0%
popularity

Publisher

verified publisherruntime.dev

Metadata

A Dart package for Keygen (keygen.sh) OpenAPI bindings

Repository (GitHub)
View/report issues

Documentation

API reference

License

Apache-2.0 (license)

Dependencies

collection, http, intl, meta

More

Packages that depend on runtime_keygen_openapi

Back