Skip to content

WebhooksApi.md

Latest commit

 

History

History
326 lines (242 loc) · 10.6 KB

WebhooksApi.md

File metadata and controls

326 lines (242 loc) · 10.6 KB

cloudsmith_api.WebhooksApi

All URIs are relative to https://api.cloudsmith.io

Method HTTP request Description
webhooks_create POST /webhooks/{owner}/{repo}/ Create a specific webhook in a repository.
webhooks_delete DELETE /webhooks/{owner}/{repo}/{identifier}/ Delete a specific webhook in a repository.
webhooks_list GET /webhooks/{owner}/{repo}/ Get a list of all webhooks in a repository.
webhooks_partial_update PATCH /webhooks/{owner}/{repo}/{identifier}/ Update a specific webhook in a repository.
webhooks_read GET /webhooks/{owner}/{repo}/{identifier}/ Views for working with repository webhooks.

webhooks_create

RepositoryWebhook webhooks_create(owner, repo, data=data)

Create a specific webhook in a repository.

Create a specific webhook in a repository.

Example

from __future__ import print_function
import time
import cloudsmith_api
from cloudsmith_api.rest import ApiException
from pprint import pprint

# Configure API key authorization: apikey
configuration = cloudsmith_api.Configuration()
configuration.api_key['X-Api-Key'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['X-Api-Key'] = 'Bearer'
# Configure HTTP basic authorization: basic
configuration = cloudsmith_api.Configuration()
configuration.username = 'YOUR_USERNAME'
configuration.password = 'YOUR_PASSWORD'

# create an instance of the API class
api_instance = cloudsmith_api.WebhooksApi(cloudsmith_api.ApiClient(configuration))
owner = 'owner_example' # str | 
repo = 'repo_example' # str | 
data = cloudsmith_api.RepositoryWebhookRequest() # RepositoryWebhookRequest |  (optional)

try:
    # Create a specific webhook in a repository.
    api_response = api_instance.webhooks_create(owner, repo, data=data)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling WebhooksApi->webhooks_create: %s\n" % e)

Parameters

Name Type Description Notes
owner str
repo str
data RepositoryWebhookRequest [optional]

Return type

RepositoryWebhook

Authorization

apikey, basic

HTTP request headers

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

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

webhooks_delete

webhooks_delete(owner, repo, identifier)

Delete a specific webhook in a repository.

Delete a specific webhook in a repository.

Example

from __future__ import print_function
import time
import cloudsmith_api
from cloudsmith_api.rest import ApiException
from pprint import pprint

# Configure API key authorization: apikey
configuration = cloudsmith_api.Configuration()
configuration.api_key['X-Api-Key'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['X-Api-Key'] = 'Bearer'
# Configure HTTP basic authorization: basic
configuration = cloudsmith_api.Configuration()
configuration.username = 'YOUR_USERNAME'
configuration.password = 'YOUR_PASSWORD'

# create an instance of the API class
api_instance = cloudsmith_api.WebhooksApi(cloudsmith_api.ApiClient(configuration))
owner = 'owner_example' # str | 
repo = 'repo_example' # str | 
identifier = 'identifier_example' # str | 

try:
    # Delete a specific webhook in a repository.
    api_instance.webhooks_delete(owner, repo, identifier)
except ApiException as e:
    print("Exception when calling WebhooksApi->webhooks_delete: %s\n" % e)

Parameters

Name Type Description Notes
owner str
repo str
identifier str

Return type

void (empty response body)

Authorization

apikey, basic

HTTP request headers

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

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

webhooks_list

list[RepositoryWebhook] webhooks_list(owner, repo, page=page, page_size=page_size)

Get a list of all webhooks in a repository.

Get a list of all webhooks in a repository.

Example

from __future__ import print_function
import time
import cloudsmith_api
from cloudsmith_api.rest import ApiException
from pprint import pprint

# Configure API key authorization: apikey
configuration = cloudsmith_api.Configuration()
configuration.api_key['X-Api-Key'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['X-Api-Key'] = 'Bearer'
# Configure HTTP basic authorization: basic
configuration = cloudsmith_api.Configuration()
configuration.username = 'YOUR_USERNAME'
configuration.password = 'YOUR_PASSWORD'

# create an instance of the API class
api_instance = cloudsmith_api.WebhooksApi(cloudsmith_api.ApiClient(configuration))
owner = 'owner_example' # str | 
repo = 'repo_example' # str | 
page = 56 # int | A page number within the paginated result set. (optional)
page_size = 56 # int | Number of results to return per page. (optional)

try:
    # Get a list of all webhooks in a repository.
    api_response = api_instance.webhooks_list(owner, repo, page=page, page_size=page_size)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling WebhooksApi->webhooks_list: %s\n" % e)

Parameters

Name Type Description Notes
owner str
repo str
page int A page number within the paginated result set. [optional]
page_size int Number of results to return per page. [optional]

Return type

list[RepositoryWebhook]

Authorization

apikey, basic

HTTP request headers

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

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

webhooks_partial_update

RepositoryWebhook webhooks_partial_update(owner, repo, identifier, data=data)

Update a specific webhook in a repository.

Update a specific webhook in a repository.

Example

from __future__ import print_function
import time
import cloudsmith_api
from cloudsmith_api.rest import ApiException
from pprint import pprint

# Configure API key authorization: apikey
configuration = cloudsmith_api.Configuration()
configuration.api_key['X-Api-Key'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['X-Api-Key'] = 'Bearer'
# Configure HTTP basic authorization: basic
configuration = cloudsmith_api.Configuration()
configuration.username = 'YOUR_USERNAME'
configuration.password = 'YOUR_PASSWORD'

# create an instance of the API class
api_instance = cloudsmith_api.WebhooksApi(cloudsmith_api.ApiClient(configuration))
owner = 'owner_example' # str | 
repo = 'repo_example' # str | 
identifier = 'identifier_example' # str | 
data = cloudsmith_api.RepositoryWebhookRequestPatch() # RepositoryWebhookRequestPatch |  (optional)

try:
    # Update a specific webhook in a repository.
    api_response = api_instance.webhooks_partial_update(owner, repo, identifier, data=data)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling WebhooksApi->webhooks_partial_update: %s\n" % e)

Parameters

Name Type Description Notes
owner str
repo str
identifier str
data RepositoryWebhookRequestPatch [optional]

Return type

RepositoryWebhook

Authorization

apikey, basic

HTTP request headers

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

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

webhooks_read

RepositoryWebhook webhooks_read(owner, repo, identifier)

Views for working with repository webhooks.

Views for working with repository webhooks.

Example

from __future__ import print_function
import time
import cloudsmith_api
from cloudsmith_api.rest import ApiException
from pprint import pprint

# Configure API key authorization: apikey
configuration = cloudsmith_api.Configuration()
configuration.api_key['X-Api-Key'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['X-Api-Key'] = 'Bearer'
# Configure HTTP basic authorization: basic
configuration = cloudsmith_api.Configuration()
configuration.username = 'YOUR_USERNAME'
configuration.password = 'YOUR_PASSWORD'

# create an instance of the API class
api_instance = cloudsmith_api.WebhooksApi(cloudsmith_api.ApiClient(configuration))
owner = 'owner_example' # str | 
repo = 'repo_example' # str | 
identifier = 'identifier_example' # str | 

try:
    # Views for working with repository webhooks.
    api_response = api_instance.webhooks_read(owner, repo, identifier)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling WebhooksApi->webhooks_read: %s\n" % e)

Parameters

Name Type Description Notes
owner str
repo str
identifier str

Return type

RepositoryWebhook

Authorization

apikey, basic

HTTP request headers

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

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