Skip to content

Latest commit

 

History

History
340 lines (205 loc) · 8.32 KB

SubscriptionsApi.md

File metadata and controls

340 lines (205 loc) · 8.32 KB
Raw

\SubscriptionsApi

All URIs are relative to http://localhost

Method HTTP request Description
ApiV3SubscriptionsGet Get /api/v3/subscriptions
ApiV3SubscriptionsIdentDelete Delete /api/v3/subscriptions/{ident}
ApiV3SubscriptionsIdentGet Get /api/v3/subscriptions/{ident}
ApiV3SubscriptionsIdentPatch Patch /api/v3/subscriptions/{ident}
ApiV3SubscriptionsPost Post /api/v3/subscriptions

ApiV3SubscriptionsGet

ApiV3SubscriptionsGet(ctx).Execute()

Example

package main

import (
    "context"
    "fmt"
    "os"
    openapiclient "./openapi"
)

func main() {

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

Path Parameters

This endpoint does not need any parameter.

Other Parameters

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

Return type

(empty response body)

Authorization

api_key, basic_auth

HTTP request headers

  • Content-Type: Not defined
  • Accept: Not defined

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

ApiV3SubscriptionsIdentDelete

ApiV3SubscriptionsIdentDelete(ctx, ident).Execute()

Example

package main

import (
    "context"
    "fmt"
    "os"
    openapiclient "./openapi"
)

func main() {
    ident := "ident_example" // string | ID of system object (assets, locations, ...)

    configuration := openapiclient.NewConfiguration()
    apiClient := openapiclient.NewAPIClient(configuration)
    resp, r, err := apiClient.SubscriptionsApi.ApiV3SubscriptionsIdentDelete(context.Background(), ident).Execute()
    if err != nil {
        fmt.Fprintf(os.Stderr, "Error when calling `SubscriptionsApi.ApiV3SubscriptionsIdentDelete``: %v\n", err)
        fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
    }
}

Path Parameters

Name Type Description Notes
ctx context.Context context for authentication, logging, cancellation, deadlines, tracing, etc.
ident string ID of system object (assets, locations, ...)

Other Parameters

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

Name Type Description Notes

Return type

(empty response body)

Authorization

api_key, basic_auth

HTTP request headers

  • Content-Type: Not defined
  • Accept: Not defined

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

ApiV3SubscriptionsIdentGet

ApiV3SubscriptionsIdentGet(ctx, ident).Execute()

Example

package main

import (
    "context"
    "fmt"
    "os"
    openapiclient "./openapi"
)

func main() {
    ident := "ident_example" // string | ID of system object (assets, locations, ...)

    configuration := openapiclient.NewConfiguration()
    apiClient := openapiclient.NewAPIClient(configuration)
    resp, r, err := apiClient.SubscriptionsApi.ApiV3SubscriptionsIdentGet(context.Background(), ident).Execute()
    if err != nil {
        fmt.Fprintf(os.Stderr, "Error when calling `SubscriptionsApi.ApiV3SubscriptionsIdentGet``: %v\n", err)
        fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
    }
}

Path Parameters

Name Type Description Notes
ctx context.Context context for authentication, logging, cancellation, deadlines, tracing, etc.
ident string ID of system object (assets, locations, ...)

Other Parameters

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

Name Type Description Notes

Return type

(empty response body)

Authorization

api_key, basic_auth

HTTP request headers

  • Content-Type: Not defined
  • Accept: Not defined

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

ApiV3SubscriptionsIdentPatch

ApiV3SubscriptionsIdentPatch(ctx, ident).Execute()

Example

package main

import (
    "context"
    "fmt"
    "os"
    openapiclient "./openapi"
)

func main() {
    ident := "ident_example" // string | ID of system object (assets, locations, ...)

    configuration := openapiclient.NewConfiguration()
    apiClient := openapiclient.NewAPIClient(configuration)
    resp, r, err := apiClient.SubscriptionsApi.ApiV3SubscriptionsIdentPatch(context.Background(), ident).Execute()
    if err != nil {
        fmt.Fprintf(os.Stderr, "Error when calling `SubscriptionsApi.ApiV3SubscriptionsIdentPatch``: %v\n", err)
        fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
    }
}

Path Parameters

Name Type Description Notes
ctx context.Context context for authentication, logging, cancellation, deadlines, tracing, etc.
ident string ID of system object (assets, locations, ...)

Other Parameters

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

Name Type Description Notes

Return type

(empty response body)

Authorization

api_key, basic_auth

HTTP request headers

  • Content-Type: Not defined
  • Accept: Not defined

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

ApiV3SubscriptionsPost

ApiV3SubscriptionsPost(ctx).AlternativeId(alternativeId).Execute()

Example

package main

import (
    "context"
    "fmt"
    "os"
    openapiclient "./openapi"
)

func main() {
    alternativeId := "alternativeId_example" // string | The name of the alternative unique field (optional)

    configuration := openapiclient.NewConfiguration()
    apiClient := openapiclient.NewAPIClient(configuration)
    resp, r, err := apiClient.SubscriptionsApi.ApiV3SubscriptionsPost(context.Background()).AlternativeId(alternativeId).Execute()
    if err != nil {
        fmt.Fprintf(os.Stderr, "Error when calling `SubscriptionsApi.ApiV3SubscriptionsPost``: %v\n", err)
        fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
    }
}

Path Parameters

Other Parameters

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

Name Type Description Notes
alternativeId string The name of the alternative unique field

Return type

(empty response body)

Authorization

api_key, basic_auth

HTTP request headers

  • Content-Type: Not defined
  • Accept: Not defined

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