Skip to content

Latest commit

 

History

History
378 lines (293 loc) · 13 KB

ToolsOzoneCommunicationApi.md

File metadata and controls

378 lines (293 loc) · 13 KB

BSky.Api.ToolsOzoneCommunicationApi

All URIs are relative to https://public.api.bsky.app/xrpc

Method HTTP request Description
ToolsOzoneCommunicationCreateTemplate POST /tools.ozone.communication.createTemplate
ToolsOzoneCommunicationDeleteTemplate POST /tools.ozone.communication.deleteTemplate
ToolsOzoneCommunicationListTemplates GET /tools.ozone.communication.listTemplates
ToolsOzoneCommunicationUpdateTemplate POST /tools.ozone.communication.updateTemplate

ToolsOzoneCommunicationCreateTemplate

ToolsOzoneCommunicationDefsTemplateView ToolsOzoneCommunicationCreateTemplate (ToolsOzoneCommunicationCreateTemplateRequest toolsOzoneCommunicationCreateTemplateRequest)

Administrative action to create a new, re-usable communication (email for now) template.

Example

using System.Collections.Generic;
using System.Diagnostics;
using BSky.Api;
using BSky.Client;
using BSky.Model;

namespace Example
{
    public class ToolsOzoneCommunicationCreateTemplateExample
    {
        public static void Main()
        {
            Configuration config = new Configuration();
            config.BasePath = "https://public.api.bsky.app/xrpc";
            // Configure Bearer token for authorization: Bearer
            config.AccessToken = "YOUR_BEARER_TOKEN";

            var apiInstance = new ToolsOzoneCommunicationApi(config);
            var toolsOzoneCommunicationCreateTemplateRequest = new ToolsOzoneCommunicationCreateTemplateRequest(); // ToolsOzoneCommunicationCreateTemplateRequest | 

            try
            {
                ToolsOzoneCommunicationDefsTemplateView result = apiInstance.ToolsOzoneCommunicationCreateTemplate(toolsOzoneCommunicationCreateTemplateRequest);
                Debug.WriteLine(result);
            }
            catch (ApiException  e)
            {
                Debug.Print("Exception when calling ToolsOzoneCommunicationApi.ToolsOzoneCommunicationCreateTemplate: " + e.Message);
                Debug.Print("Status Code: " + e.ErrorCode);
                Debug.Print(e.StackTrace);
            }
        }
    }
}

Using the ToolsOzoneCommunicationCreateTemplateWithHttpInfo variant

This returns an ApiResponse object which contains the response data, status code and headers.

try
{
    ApiResponse<ToolsOzoneCommunicationDefsTemplateView> response = apiInstance.ToolsOzoneCommunicationCreateTemplateWithHttpInfo(toolsOzoneCommunicationCreateTemplateRequest);
    Debug.Write("Status Code: " + response.StatusCode);
    Debug.Write("Response Headers: " + response.Headers);
    Debug.Write("Response Body: " + response.Data);
}
catch (ApiException e)
{
    Debug.Print("Exception when calling ToolsOzoneCommunicationApi.ToolsOzoneCommunicationCreateTemplateWithHttpInfo: " + e.Message);
    Debug.Print("Status Code: " + e.ErrorCode);
    Debug.Print(e.StackTrace);
}

Parameters

Name Type Description Notes
toolsOzoneCommunicationCreateTemplateRequest ToolsOzoneCommunicationCreateTemplateRequest

Return type

ToolsOzoneCommunicationDefsTemplateView

Authorization

Bearer

HTTP request headers

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

HTTP response details

Status code Description Response headers
200 OK -
400 Bad Request -
401 Unauthorized -

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

ToolsOzoneCommunicationDeleteTemplate

void ToolsOzoneCommunicationDeleteTemplate (ToolsOzoneCommunicationDeleteTemplateRequest toolsOzoneCommunicationDeleteTemplateRequest)

Delete a communication template.

Example

using System.Collections.Generic;
using System.Diagnostics;
using BSky.Api;
using BSky.Client;
using BSky.Model;

namespace Example
{
    public class ToolsOzoneCommunicationDeleteTemplateExample
    {
        public static void Main()
        {
            Configuration config = new Configuration();
            config.BasePath = "https://public.api.bsky.app/xrpc";
            // Configure Bearer token for authorization: Bearer
            config.AccessToken = "YOUR_BEARER_TOKEN";

            var apiInstance = new ToolsOzoneCommunicationApi(config);
            var toolsOzoneCommunicationDeleteTemplateRequest = new ToolsOzoneCommunicationDeleteTemplateRequest(); // ToolsOzoneCommunicationDeleteTemplateRequest | 

            try
            {
                apiInstance.ToolsOzoneCommunicationDeleteTemplate(toolsOzoneCommunicationDeleteTemplateRequest);
            }
            catch (ApiException  e)
            {
                Debug.Print("Exception when calling ToolsOzoneCommunicationApi.ToolsOzoneCommunicationDeleteTemplate: " + e.Message);
                Debug.Print("Status Code: " + e.ErrorCode);
                Debug.Print(e.StackTrace);
            }
        }
    }
}

Using the ToolsOzoneCommunicationDeleteTemplateWithHttpInfo variant

This returns an ApiResponse object which contains the response data, status code and headers.

try
{
    apiInstance.ToolsOzoneCommunicationDeleteTemplateWithHttpInfo(toolsOzoneCommunicationDeleteTemplateRequest);
}
catch (ApiException e)
{
    Debug.Print("Exception when calling ToolsOzoneCommunicationApi.ToolsOzoneCommunicationDeleteTemplateWithHttpInfo: " + e.Message);
    Debug.Print("Status Code: " + e.ErrorCode);
    Debug.Print(e.StackTrace);
}

Parameters

Name Type Description Notes
toolsOzoneCommunicationDeleteTemplateRequest ToolsOzoneCommunicationDeleteTemplateRequest

Return type

void (empty response body)

Authorization

Bearer

HTTP request headers

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

HTTP response details

Status code Description Response headers
200 OK -
400 Bad Request -
401 Unauthorized -

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

ToolsOzoneCommunicationListTemplates

ToolsOzoneCommunicationListTemplates200Response ToolsOzoneCommunicationListTemplates ()

Get list of all communication templates.

Example

using System.Collections.Generic;
using System.Diagnostics;
using BSky.Api;
using BSky.Client;
using BSky.Model;

namespace Example
{
    public class ToolsOzoneCommunicationListTemplatesExample
    {
        public static void Main()
        {
            Configuration config = new Configuration();
            config.BasePath = "https://public.api.bsky.app/xrpc";
            // Configure Bearer token for authorization: Bearer
            config.AccessToken = "YOUR_BEARER_TOKEN";

            var apiInstance = new ToolsOzoneCommunicationApi(config);

            try
            {
                ToolsOzoneCommunicationListTemplates200Response result = apiInstance.ToolsOzoneCommunicationListTemplates();
                Debug.WriteLine(result);
            }
            catch (ApiException  e)
            {
                Debug.Print("Exception when calling ToolsOzoneCommunicationApi.ToolsOzoneCommunicationListTemplates: " + e.Message);
                Debug.Print("Status Code: " + e.ErrorCode);
                Debug.Print(e.StackTrace);
            }
        }
    }
}

Using the ToolsOzoneCommunicationListTemplatesWithHttpInfo variant

This returns an ApiResponse object which contains the response data, status code and headers.

try
{
    ApiResponse<ToolsOzoneCommunicationListTemplates200Response> response = apiInstance.ToolsOzoneCommunicationListTemplatesWithHttpInfo();
    Debug.Write("Status Code: " + response.StatusCode);
    Debug.Write("Response Headers: " + response.Headers);
    Debug.Write("Response Body: " + response.Data);
}
catch (ApiException e)
{
    Debug.Print("Exception when calling ToolsOzoneCommunicationApi.ToolsOzoneCommunicationListTemplatesWithHttpInfo: " + e.Message);
    Debug.Print("Status Code: " + e.ErrorCode);
    Debug.Print(e.StackTrace);
}

Parameters

This endpoint does not need any parameter.

Return type

ToolsOzoneCommunicationListTemplates200Response

Authorization

Bearer

HTTP request headers

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

HTTP response details

Status code Description Response headers
200 OK -
400 Bad Request -
401 Unauthorized -

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

ToolsOzoneCommunicationUpdateTemplate

ToolsOzoneCommunicationDefsTemplateView ToolsOzoneCommunicationUpdateTemplate (ToolsOzoneCommunicationUpdateTemplateRequest toolsOzoneCommunicationUpdateTemplateRequest)

Administrative action to update an existing communication template. Allows passing partial fields to patch specific fields only.

Example

using System.Collections.Generic;
using System.Diagnostics;
using BSky.Api;
using BSky.Client;
using BSky.Model;

namespace Example
{
    public class ToolsOzoneCommunicationUpdateTemplateExample
    {
        public static void Main()
        {
            Configuration config = new Configuration();
            config.BasePath = "https://public.api.bsky.app/xrpc";
            // Configure Bearer token for authorization: Bearer
            config.AccessToken = "YOUR_BEARER_TOKEN";

            var apiInstance = new ToolsOzoneCommunicationApi(config);
            var toolsOzoneCommunicationUpdateTemplateRequest = new ToolsOzoneCommunicationUpdateTemplateRequest(); // ToolsOzoneCommunicationUpdateTemplateRequest | 

            try
            {
                ToolsOzoneCommunicationDefsTemplateView result = apiInstance.ToolsOzoneCommunicationUpdateTemplate(toolsOzoneCommunicationUpdateTemplateRequest);
                Debug.WriteLine(result);
            }
            catch (ApiException  e)
            {
                Debug.Print("Exception when calling ToolsOzoneCommunicationApi.ToolsOzoneCommunicationUpdateTemplate: " + e.Message);
                Debug.Print("Status Code: " + e.ErrorCode);
                Debug.Print(e.StackTrace);
            }
        }
    }
}

Using the ToolsOzoneCommunicationUpdateTemplateWithHttpInfo variant

This returns an ApiResponse object which contains the response data, status code and headers.

try
{
    ApiResponse<ToolsOzoneCommunicationDefsTemplateView> response = apiInstance.ToolsOzoneCommunicationUpdateTemplateWithHttpInfo(toolsOzoneCommunicationUpdateTemplateRequest);
    Debug.Write("Status Code: " + response.StatusCode);
    Debug.Write("Response Headers: " + response.Headers);
    Debug.Write("Response Body: " + response.Data);
}
catch (ApiException e)
{
    Debug.Print("Exception when calling ToolsOzoneCommunicationApi.ToolsOzoneCommunicationUpdateTemplateWithHttpInfo: " + e.Message);
    Debug.Print("Status Code: " + e.ErrorCode);
    Debug.Print(e.StackTrace);
}

Parameters

Name Type Description Notes
toolsOzoneCommunicationUpdateTemplateRequest ToolsOzoneCommunicationUpdateTemplateRequest

Return type

ToolsOzoneCommunicationDefsTemplateView

Authorization

Bearer

HTTP request headers

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

HTTP response details

Status code Description Response headers
200 OK -
400 Bad Request -
401 Unauthorized -

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