Skip to content

Latest commit

 

History

History
219 lines (147 loc) · 9.83 KB

README.md

File metadata and controls

219 lines (147 loc) · 9.83 KB
Raw

Github

(github)

Available Operations

github_check_access

Example Usage

import speakeasy
from speakeasy.models import operations, shared

s = speakeasy.Speakeasy(
    security=shared.Security(
        api_key="<YOUR_API_KEY_HERE>",
    ),
)


res = s.github.github_check_access(request=operations.GithubCheckAccessRequest(
    org='<value>',
    repo='<value>',
))

if res is not None:
    # handle response
    pass

Parameters

Parameter Type Required Description
request operations.GithubCheckAccessRequest ✔️ The request object to use for the request.

Response

operations.GithubCheckAccessResponse

Errors

Error Object Status Code Content Type
errors.SDKError 4xx-5xx /

github_check_publishing_secrets

Example Usage

import speakeasy
from speakeasy.models import operations, shared

s = speakeasy.Speakeasy(
    security=shared.Security(
        api_key="<YOUR_API_KEY_HERE>",
    ),
)


res = s.github.github_check_publishing_secrets(request=operations.GithubCheckPublishingSecretsRequest(
    generate_gen_lock_id='<value>',
))

if res.github_missing_publishing_secrets_response is not None:
    # handle response
    pass

Parameters

Parameter Type Required Description
request operations.GithubCheckPublishingSecretsRequest ✔️ The request object to use for the request.

Response

operations.GithubCheckPublishingSecretsResponse

Errors

Error Object Status Code Content Type
errors.SDKError 4xx-5xx /

github_configure_target

Example Usage

import speakeasy
from speakeasy.models import shared

s = speakeasy.Speakeasy(
    security=shared.Security(
        api_key="<YOUR_API_KEY_HERE>",
    ),
)


res = s.github.github_configure_target(request=shared.GithubConfigureTargetRequest(
    org='<value>',
    repo_name='<value>',
))

if res is not None:
    # handle response
    pass

Parameters

Parameter Type Required Description
request shared.GithubConfigureTargetRequest ✔️ The request object to use for the request.

Response

operations.GithubConfigureTargetResponse

Errors

Error Object Status Code Content Type
errors.SDKError 4xx-5xx /

github_store_publishing_secrets

Example Usage

import speakeasy
from speakeasy.models import shared

s = speakeasy.Speakeasy(
    security=shared.Security(
        api_key="<YOUR_API_KEY_HERE>",
    ),
)


res = s.github.github_store_publishing_secrets(request=shared.GithubStorePublishingSecretsRequest(
    generate_gen_lock_id='<value>',
))

if res is not None:
    # handle response
    pass

Parameters

Parameter Type Required Description
request shared.GithubStorePublishingSecretsRequest ✔️ The request object to use for the request.

Response

operations.GithubStorePublishingSecretsResponse

Errors

Error Object Status Code Content Type
errors.SDKError 4xx-5xx /

github_trigger_action

Example Usage

import speakeasy
from speakeasy.models import shared

s = speakeasy.Speakeasy(
    security=shared.Security(
        api_key="<YOUR_API_KEY_HERE>",
    ),
)


res = s.github.github_trigger_action(request=shared.GithubTriggerActionRequest(
    gen_lock_id='<value>',
    org='<value>',
    repo_name='<value>',
))

if res is not None:
    # handle response
    pass

Parameters

Parameter Type Required Description
request shared.GithubTriggerActionRequest ✔️ The request object to use for the request.

Response

operations.GithubTriggerActionResponse

Errors

Error Object Status Code Content Type
errors.SDKError 4xx-5xx /