README.md

Github

(github)

Available Operations

• check_access
• configure_code_samples
• configure_mintlify_repo
• configure_target
• fetch_publishing_p_rs
• get_action
• github_check_publishing_secrets
• github_store_publishing_secrets
• trigger_action

check_access

Example Usage

from speakeasy_client_sdk_python import Speakeasy
from speakeasy_client_sdk_python.models import shared

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


res = s.github.check_access(request={
    "org": "<value>",
    "repo": "<value>",
})

if res is not None:
    # handle response
    pass

Parameters

Parameter	Type	Required	Description
request	operations.CheckAccessRequest	✔️	The request object to use for the request.
retries	Optional[utils.RetryConfig]	➖	Configuration to override the default retry behavior of the client.

Response

operations.CheckAccessResponse

Errors

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

configure_code_samples

Example Usage

from speakeasy_client_sdk_python import Speakeasy
from speakeasy_client_sdk_python.models import shared

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


res = s.github.configure_code_samples(request={
    "org": "<value>",
    "repo": "<value>",
    "target_name": "<value>",
})

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

Parameters

Parameter	Type	Required	Description
request	shared.GithubConfigureCodeSamplesRequest	✔️	The request object to use for the request.
retries	Optional[utils.RetryConfig]	➖	Configuration to override the default retry behavior of the client.

Response

operations.ConfigureCodeSamplesResponse

Errors

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

configure_mintlify_repo

Example Usage

from speakeasy_client_sdk_python import Speakeasy
from speakeasy_client_sdk_python.models import shared

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


res = s.github.configure_mintlify_repo(request={
    "input": "<value>",
    "org": "<value>",
    "overlays": [
        "<value>",
    ],
    "repo": "<value>",
})

if res is not None:
    # handle response
    pass

Parameters

Parameter	Type	Required	Description
request	shared.GithubConfigureMintlifyRepoRequest	✔️	The request object to use for the request.
retries	Optional[utils.RetryConfig]	➖	Configuration to override the default retry behavior of the client.

Response

operations.ConfigureMintlifyRepoResponse

Errors

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

configure_target

Example Usage

from speakeasy_client_sdk_python import Speakeasy
from speakeasy_client_sdk_python.models import shared

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


res = s.github.configure_target(request={
    "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.
retries	Optional[utils.RetryConfig]	➖	Configuration to override the default retry behavior of the client.

Response

operations.ConfigureTargetResponse

Errors

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

fetch_publishing_p_rs

Example Usage

from speakeasy_client_sdk_python import Speakeasy
from speakeasy_client_sdk_python.models import shared

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


res = s.github.fetch_publishing_p_rs(request={
    "generate_gen_lock_id": "<value>",
    "org": "<value>",
    "repo": "<value>",
})

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

Parameters

Parameter	Type	Required	Description
request	operations.FetchPublishingPRsRequest	✔️	The request object to use for the request.
retries	Optional[utils.RetryConfig]	➖	Configuration to override the default retry behavior of the client.

Response

operations.FetchPublishingPRsResponse

Errors

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

get_action

Example Usage

from speakeasy_client_sdk_python import Speakeasy
from speakeasy_client_sdk_python.models import shared

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


res = s.github.get_action(request={
    "org": "<value>",
    "repo": "<value>",
})

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

Parameters

Parameter	Type	Required	Description
request	operations.GetActionRequest	✔️	The request object to use for the request.
retries	Optional[utils.RetryConfig]	➖	Configuration to override the default retry behavior of the client.

Response

operations.GetActionResponse

Errors

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

github_check_publishing_secrets

Example Usage

from speakeasy_client_sdk_python import Speakeasy
from speakeasy_client_sdk_python.models import shared

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


res = s.github.github_check_publishing_secrets(request={
    "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.
retries	Optional[utils.RetryConfig]	➖	Configuration to override the default retry behavior of the client.

Response

operations.GithubCheckPublishingSecretsResponse

Errors

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

github_store_publishing_secrets

Example Usage

from speakeasy_client_sdk_python import Speakeasy
from speakeasy_client_sdk_python.models import shared

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


res = s.github.github_store_publishing_secrets(request={
    "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.
retries	Optional[utils.RetryConfig]	➖	Configuration to override the default retry behavior of the client.

Response

operations.GithubStorePublishingSecretsResponse

Errors

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

trigger_action

Example Usage

from speakeasy_client_sdk_python import Speakeasy
from speakeasy_client_sdk_python.models import shared

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


res = s.github.trigger_action(request={
    "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.
retries	Optional[utils.RetryConfig]	➖	Configuration to override the default retry behavior of the client.

Response

operations.TriggerActionResponse

Errors

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