Skip to content

Latest commit

 

History

History
257 lines (192 loc) · 6.49 KB

UtilitiesApi.md

File metadata and controls

257 lines (192 loc) · 6.49 KB

IO.Swagger.Api.UtilitiesApi

All URIs are relative to https://api.bombbomb.com/v2

Method HTTP request Description
CreateOAuthClient POST /oauthclient Create an OAuth Client
DeleteOAuthClient DELETE /oauthclient/{id} Delete an OAuth Client
GetOAuthClients GET /oauthclient Lists OAuth Clients
GetSpec GET /spec Describes this api

CreateOAuthClient

OAuthClient CreateOAuthClient (string name, string redirectUri)

Create an OAuth Client

Creates an OAuth Client managed by the user

Example

using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class CreateOAuthClientExample
    {
        public void main()
        {
            // Configure OAuth2 access token for authorization: BBOAuth2
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";

            var apiInstance = new UtilitiesApi();
            var name = name_example;  // string | The name of the OAuth client. e.g. MyCrm DEV, or MyCrm PROD
            var redirectUri = redirectUri_example;  // string | The URI to direct the client to after logging in.

            try
            {
                // Create an OAuth Client
                OAuthClient result = apiInstance.CreateOAuthClient(name, redirectUri);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling UtilitiesApi.CreateOAuthClient: " + e.Message );
            }
        }
    }
}

Parameters

Name Type Description Notes
name string The name of the OAuth client. e.g. MyCrm DEV, or MyCrm PROD
redirectUri string The URI to direct the client to after logging in.

Return type

OAuthClient

Authorization

BBOAuth2

HTTP request headers

  • Content-Type: application/x-www-form-urlencoded
  • Accept: application/json

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

DeleteOAuthClient

void DeleteOAuthClient (string id)

Delete an OAuth Client

Deletes an OAuth Client managed by the user

Example

using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class DeleteOAuthClientExample
    {
        public void main()
        {
            // Configure OAuth2 access token for authorization: BBOAuth2
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";

            var apiInstance = new UtilitiesApi();
            var id = id_example;  // string | The id of the OAuth Client

            try
            {
                // Delete an OAuth Client
                apiInstance.DeleteOAuthClient(id);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling UtilitiesApi.DeleteOAuthClient: " + e.Message );
            }
        }
    }
}

Parameters

Name Type Description Notes
id string The id of the OAuth Client

Return type

void (empty response body)

Authorization

BBOAuth2

HTTP request headers

  • Content-Type: application/x-www-form-urlencoded
  • Accept: application/json

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

GetOAuthClients

List GetOAuthClients ()

Lists OAuth Clients

Enumerates OAuth Clients managed by the user

Example

using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class GetOAuthClientsExample
    {
        public void main()
        {
            // Configure OAuth2 access token for authorization: BBOAuth2
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";

            var apiInstance = new UtilitiesApi();

            try
            {
                // Lists OAuth Clients
                List<OAuthClient> result = apiInstance.GetOAuthClients();
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling UtilitiesApi.GetOAuthClients: " + e.Message );
            }
        }
    }
}

Parameters

This endpoint does not need any parameter.

Return type

List

Authorization

BBOAuth2

HTTP request headers

  • Content-Type: application/x-www-form-urlencoded
  • Accept: application/json

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

GetSpec

void GetSpec ()

Describes this api

Describes methods available through the API.

Example

using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class GetSpecExample
    {
        public void main()
        {
            var apiInstance = new UtilitiesApi();

            try
            {
                // Describes this api
                apiInstance.GetSpec();
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling UtilitiesApi.GetSpec: " + e.Message );
            }
        }
    }
}

Parameters

This endpoint does not need any parameter.

Return type

void (empty response body)

Authorization

No authorization required

HTTP request headers

  • Content-Type: application/x-www-form-urlencoded
  • Accept: application/json

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