Skip to content

Latest commit

 

History

History
407 lines (258 loc) · 11 KB

ChannelsAPI.md

File metadata and controls

407 lines (258 loc) · 11 KB
Raw

\ChannelsAPI

All URIs are relative to http://localhost

Method HTTP request Description
DeletePolicyChannelsDelete Delete /channels/{id}
GetPolicyChannelsGet Get /channels/{id}
GetPolicyChannelsGetAll Get /channels
PostPolicyChannelsPost Post /channels
PostPolicyChannelsTest Post /channels/test
PutPolicyChannelsPut Put /channels/{id}

DeletePolicyChannelsDelete

PolicyChannelSchema DeletePolicyChannelsDelete(ctx, id).Execute()

Example

package main

import (
    "context"
    "fmt"
    "os"
    openapiclient "github.com/GIT_USER_ID/GIT_REPO_ID"
)

func main() {
    id := "id_example" // string | 

    configuration := openapiclient.NewConfiguration()
    apiClient := openapiclient.NewAPIClient(configuration)
    resp, r, err := apiClient.ChannelsAPI.DeletePolicyChannelsDelete(context.Background(), id).Execute()
    if err != nil {
        fmt.Fprintf(os.Stderr, "Error when calling `ChannelsAPI.DeletePolicyChannelsDelete``: %v\n", err)
        fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
    }
    // response from `DeletePolicyChannelsDelete`: PolicyChannelSchema
    fmt.Fprintf(os.Stdout, "Response from `ChannelsAPI.DeletePolicyChannelsDelete`: %v\n", resp)
}

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 apiDeletePolicyChannelsDeleteRequest struct via the builder pattern

Name Type Description Notes

Return type

PolicyChannelSchema

Authorization

auth_token

HTTP request headers

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

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

GetPolicyChannelsGet

PolicyChannelSchema GetPolicyChannelsGet(ctx, id).Execute()

Example

package main

import (
    "context"
    "fmt"
    "os"
    openapiclient "github.com/GIT_USER_ID/GIT_REPO_ID"
)

func main() {
    id := "id_example" // string | 

    configuration := openapiclient.NewConfiguration()
    apiClient := openapiclient.NewAPIClient(configuration)
    resp, r, err := apiClient.ChannelsAPI.GetPolicyChannelsGet(context.Background(), id).Execute()
    if err != nil {
        fmt.Fprintf(os.Stderr, "Error when calling `ChannelsAPI.GetPolicyChannelsGet``: %v\n", err)
        fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
    }
    // response from `GetPolicyChannelsGet`: PolicyChannelSchema
    fmt.Fprintf(os.Stdout, "Response from `ChannelsAPI.GetPolicyChannelsGet`: %v\n", resp)
}

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 apiGetPolicyChannelsGetRequest struct via the builder pattern

Name Type Description Notes

Return type

PolicyChannelSchema

Authorization

auth_token

HTTP request headers

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

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

GetPolicyChannelsGetAll

PaginationSchema GetPolicyChannelsGetAll(ctx).Execute()

Example

package main

import (
    "context"
    "fmt"
    "os"
    openapiclient "github.com/GIT_USER_ID/GIT_REPO_ID"
)

func main() {

    configuration := openapiclient.NewConfiguration()
    apiClient := openapiclient.NewAPIClient(configuration)
    resp, r, err := apiClient.ChannelsAPI.GetPolicyChannelsGetAll(context.Background()).Execute()
    if err != nil {
        fmt.Fprintf(os.Stderr, "Error when calling `ChannelsAPI.GetPolicyChannelsGetAll``: %v\n", err)
        fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
    }
    // response from `GetPolicyChannelsGetAll`: PaginationSchema
    fmt.Fprintf(os.Stdout, "Response from `ChannelsAPI.GetPolicyChannelsGetAll`: %v\n", resp)
}

Path Parameters

This endpoint does not need any parameter.

Other Parameters

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

Return type

PaginationSchema

Authorization

auth_token

HTTP request headers

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

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

PostPolicyChannelsPost

PolicyChannelSchema PostPolicyChannelsPost(ctx).RequestBody(requestBody).Execute()

Example

package main

import (
    "context"
    "fmt"
    "os"
    openapiclient "github.com/GIT_USER_ID/GIT_REPO_ID"
)

func main() {
    requestBody := *openapiclient.NewPolicyChannelSchema("ClientUuid_example", map[string]interface{}(123), false, false, "Id_example", "Name_example", "Type_example") // PolicyChannelSchema |  (optional)

    configuration := openapiclient.NewConfiguration()
    apiClient := openapiclient.NewAPIClient(configuration)
    resp, r, err := apiClient.ChannelsAPI.PostPolicyChannelsPost(context.Background()).RequestBody(requestBody).Execute()
    if err != nil {
        fmt.Fprintf(os.Stderr, "Error when calling `ChannelsAPI.PostPolicyChannelsPost``: %v\n", err)
        fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
    }
    // response from `PostPolicyChannelsPost`: PolicyChannelSchema
    fmt.Fprintf(os.Stdout, "Response from `ChannelsAPI.PostPolicyChannelsPost`: %v\n", resp)
}

Path Parameters

Other Parameters

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

Name Type Description Notes
requestBody PolicyChannelSchema

Return type

PolicyChannelSchema

Authorization

auth_token

HTTP request headers

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

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

PostPolicyChannelsTest

PolicyChannelSchema PostPolicyChannelsTest(ctx).RequestBody(requestBody).Execute()

Example

package main

import (
    "context"
    "fmt"
    "os"
    openapiclient "github.com/GIT_USER_ID/GIT_REPO_ID"
)

func main() {
    requestBody := *openapiclient.NewPolicyChannelSchema("ClientUuid_example", map[string]interface{}(123), false, false, "Id_example", "Name_example", "Type_example") // PolicyChannelSchema |  (optional)

    configuration := openapiclient.NewConfiguration()
    apiClient := openapiclient.NewAPIClient(configuration)
    resp, r, err := apiClient.ChannelsAPI.PostPolicyChannelsTest(context.Background()).RequestBody(requestBody).Execute()
    if err != nil {
        fmt.Fprintf(os.Stderr, "Error when calling `ChannelsAPI.PostPolicyChannelsTest``: %v\n", err)
        fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
    }
    // response from `PostPolicyChannelsTest`: PolicyChannelSchema
    fmt.Fprintf(os.Stdout, "Response from `ChannelsAPI.PostPolicyChannelsTest`: %v\n", resp)
}

Path Parameters

Other Parameters

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

Name Type Description Notes
requestBody PolicyChannelSchema

Return type

PolicyChannelSchema

Authorization

auth_token

HTTP request headers

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

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

PutPolicyChannelsPut

PolicyChannelSchema PutPolicyChannelsPut(ctx, id).RequestBody(requestBody).Execute()

Example

package main

import (
    "context"
    "fmt"
    "os"
    openapiclient "github.com/GIT_USER_ID/GIT_REPO_ID"
)

func main() {
    id := "id_example" // string | 
    requestBody := *openapiclient.NewPolicyChannelSchema("ClientUuid_example", map[string]interface{}(123), false, false, "Id_example", "Name_example", "Type_example") // PolicyChannelSchema |  (optional)

    configuration := openapiclient.NewConfiguration()
    apiClient := openapiclient.NewAPIClient(configuration)
    resp, r, err := apiClient.ChannelsAPI.PutPolicyChannelsPut(context.Background(), id).RequestBody(requestBody).Execute()
    if err != nil {
        fmt.Fprintf(os.Stderr, "Error when calling `ChannelsAPI.PutPolicyChannelsPut``: %v\n", err)
        fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
    }
    // response from `PutPolicyChannelsPut`: PolicyChannelSchema
    fmt.Fprintf(os.Stdout, "Response from `ChannelsAPI.PutPolicyChannelsPut`: %v\n", resp)
}

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 apiPutPolicyChannelsPutRequest struct via the builder pattern

Name Type Description Notes

requestBody | PolicyChannelSchema | |

Return type

PolicyChannelSchema

Authorization

auth_token

HTTP request headers

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

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