package
0.0.0-20240829140824-9f8fcee2ba9d
Repository: https://github.com/firehydrant/api-client-go.git
Documentation: pkg.go.dev

# Functions

New creates a new runbooks API client.
NewDeleteV1RunbooksExecutionsExecutionIDNoContent creates a DeleteV1RunbooksExecutionsExecutionIDNoContent with default headers values.
NewDeleteV1RunbooksExecutionsExecutionIDParams creates a new DeleteV1RunbooksExecutionsExecutionIDParams object, with the default timeout for this client.
NewDeleteV1RunbooksExecutionsExecutionIDParamsWithContext creates a new DeleteV1RunbooksExecutionsExecutionIDParams object with the ability to set a context for a request.
NewDeleteV1RunbooksExecutionsExecutionIDParamsWithHTTPClient creates a new DeleteV1RunbooksExecutionsExecutionIDParams object with the ability to set a custom HTTPClient for a request.
NewDeleteV1RunbooksExecutionsExecutionIDParamsWithTimeout creates a new DeleteV1RunbooksExecutionsExecutionIDParams object with the ability to set a timeout on a request.
NewDeleteV1RunbooksRunbookIDOK creates a DeleteV1RunbooksRunbookIDOK with default headers values.
NewDeleteV1RunbooksRunbookIDParams creates a new DeleteV1RunbooksRunbookIDParams object, with the default timeout for this client.
NewDeleteV1RunbooksRunbookIDParamsWithContext creates a new DeleteV1RunbooksRunbookIDParams object with the ability to set a context for a request.
NewDeleteV1RunbooksRunbookIDParamsWithHTTPClient creates a new DeleteV1RunbooksRunbookIDParams object with the ability to set a custom HTTPClient for a request.
NewDeleteV1RunbooksRunbookIDParamsWithTimeout creates a new DeleteV1RunbooksRunbookIDParams object with the ability to set a timeout on a request.
NewGetV1RunbooksActionsOK creates a GetV1RunbooksActionsOK with default headers values.
NewGetV1RunbooksActionsParams creates a new GetV1RunbooksActionsParams object, with the default timeout for this client.
NewGetV1RunbooksActionsParamsWithContext creates a new GetV1RunbooksActionsParams object with the ability to set a context for a request.
NewGetV1RunbooksActionsParamsWithHTTPClient creates a new GetV1RunbooksActionsParams object with the ability to set a custom HTTPClient for a request.
NewGetV1RunbooksActionsParamsWithTimeout creates a new GetV1RunbooksActionsParams object with the ability to set a timeout on a request.
NewGetV1RunbooksExecutionsExecutionIDOK creates a GetV1RunbooksExecutionsExecutionIDOK with default headers values.
NewGetV1RunbooksExecutionsExecutionIDParams creates a new GetV1RunbooksExecutionsExecutionIDParams object, with the default timeout for this client.
NewGetV1RunbooksExecutionsExecutionIDParamsWithContext creates a new GetV1RunbooksExecutionsExecutionIDParams object with the ability to set a context for a request.
NewGetV1RunbooksExecutionsExecutionIDParamsWithHTTPClient creates a new GetV1RunbooksExecutionsExecutionIDParams object with the ability to set a custom HTTPClient for a request.
NewGetV1RunbooksExecutionsExecutionIDParamsWithTimeout creates a new GetV1RunbooksExecutionsExecutionIDParams object with the ability to set a timeout on a request.
NewGetV1RunbooksExecutionsExecutionIDStepsStepIDScriptOK creates a GetV1RunbooksExecutionsExecutionIDStepsStepIDScriptOK with default headers values.
NewGetV1RunbooksExecutionsExecutionIDStepsStepIDScriptParams creates a new GetV1RunbooksExecutionsExecutionIDStepsStepIDScriptParams object, with the default timeout for this client.
NewGetV1RunbooksExecutionsExecutionIDStepsStepIDScriptParamsWithContext creates a new GetV1RunbooksExecutionsExecutionIDStepsStepIDScriptParams object with the ability to set a context for a request.
NewGetV1RunbooksExecutionsExecutionIDStepsStepIDScriptParamsWithHTTPClient creates a new GetV1RunbooksExecutionsExecutionIDStepsStepIDScriptParams object with the ability to set a custom HTTPClient for a request.
NewGetV1RunbooksExecutionsExecutionIDStepsStepIDScriptParamsWithTimeout creates a new GetV1RunbooksExecutionsExecutionIDStepsStepIDScriptParams object with the ability to set a timeout on a request.
NewGetV1RunbooksExecutionsExecutionIDStepsStepIDVotesStatusOK creates a GetV1RunbooksExecutionsExecutionIDStepsStepIDVotesStatusOK with default headers values.
NewGetV1RunbooksExecutionsExecutionIDStepsStepIDVotesStatusParams creates a new GetV1RunbooksExecutionsExecutionIDStepsStepIDVotesStatusParams object, with the default timeout for this client.
NewGetV1RunbooksExecutionsExecutionIDStepsStepIDVotesStatusParamsWithContext creates a new GetV1RunbooksExecutionsExecutionIDStepsStepIDVotesStatusParams object with the ability to set a context for a request.
NewGetV1RunbooksExecutionsExecutionIDStepsStepIDVotesStatusParamsWithHTTPClient creates a new GetV1RunbooksExecutionsExecutionIDStepsStepIDVotesStatusParams object with the ability to set a custom HTTPClient for a request.
NewGetV1RunbooksExecutionsExecutionIDStepsStepIDVotesStatusParamsWithTimeout creates a new GetV1RunbooksExecutionsExecutionIDStepsStepIDVotesStatusParams object with the ability to set a timeout on a request.
NewGetV1RunbooksExecutionsExecutionIDVotesStatusOK creates a GetV1RunbooksExecutionsExecutionIDVotesStatusOK with default headers values.
NewGetV1RunbooksExecutionsExecutionIDVotesStatusParams creates a new GetV1RunbooksExecutionsExecutionIDVotesStatusParams object, with the default timeout for this client.
NewGetV1RunbooksExecutionsExecutionIDVotesStatusParamsWithContext creates a new GetV1RunbooksExecutionsExecutionIDVotesStatusParams object with the ability to set a context for a request.
NewGetV1RunbooksExecutionsExecutionIDVotesStatusParamsWithHTTPClient creates a new GetV1RunbooksExecutionsExecutionIDVotesStatusParams object with the ability to set a custom HTTPClient for a request.
NewGetV1RunbooksExecutionsExecutionIDVotesStatusParamsWithTimeout creates a new GetV1RunbooksExecutionsExecutionIDVotesStatusParams object with the ability to set a timeout on a request.
NewGetV1RunbooksExecutionsOK creates a GetV1RunbooksExecutionsOK with default headers values.
NewGetV1RunbooksExecutionsParams creates a new GetV1RunbooksExecutionsParams object, with the default timeout for this client.
NewGetV1RunbooksExecutionsParamsWithContext creates a new GetV1RunbooksExecutionsParams object with the ability to set a context for a request.
NewGetV1RunbooksExecutionsParamsWithHTTPClient creates a new GetV1RunbooksExecutionsParams object with the ability to set a custom HTTPClient for a request.
NewGetV1RunbooksExecutionsParamsWithTimeout creates a new GetV1RunbooksExecutionsParams object with the ability to set a timeout on a request.
NewGetV1RunbooksOK creates a GetV1RunbooksOK with default headers values.
NewGetV1RunbooksParams creates a new GetV1RunbooksParams object, with the default timeout for this client.
NewGetV1RunbooksParamsWithContext creates a new GetV1RunbooksParams object with the ability to set a context for a request.
NewGetV1RunbooksParamsWithHTTPClient creates a new GetV1RunbooksParams object with the ability to set a custom HTTPClient for a request.
NewGetV1RunbooksParamsWithTimeout creates a new GetV1RunbooksParams object with the ability to set a timeout on a request.
NewGetV1RunbooksRunbookIDOK creates a GetV1RunbooksRunbookIDOK with default headers values.
NewGetV1RunbooksRunbookIDParams creates a new GetV1RunbooksRunbookIDParams object, with the default timeout for this client.
NewGetV1RunbooksRunbookIDParamsWithContext creates a new GetV1RunbooksRunbookIDParams object with the ability to set a context for a request.
NewGetV1RunbooksRunbookIDParamsWithHTTPClient creates a new GetV1RunbooksRunbookIDParams object with the ability to set a custom HTTPClient for a request.
NewGetV1RunbooksRunbookIDParamsWithTimeout creates a new GetV1RunbooksRunbookIDParams object with the ability to set a timeout on a request.
NewGetV1RunbooksSelectOptionsIntegrationSlugActionSlugFieldOK creates a GetV1RunbooksSelectOptionsIntegrationSlugActionSlugFieldOK with default headers values.
NewGetV1RunbooksSelectOptionsIntegrationSlugActionSlugFieldParams creates a new GetV1RunbooksSelectOptionsIntegrationSlugActionSlugFieldParams object, with the default timeout for this client.
NewGetV1RunbooksSelectOptionsIntegrationSlugActionSlugFieldParamsWithContext creates a new GetV1RunbooksSelectOptionsIntegrationSlugActionSlugFieldParams object with the ability to set a context for a request.
NewGetV1RunbooksSelectOptionsIntegrationSlugActionSlugFieldParamsWithHTTPClient creates a new GetV1RunbooksSelectOptionsIntegrationSlugActionSlugFieldParams object with the ability to set a custom HTTPClient for a request.
NewGetV1RunbooksSelectOptionsIntegrationSlugActionSlugFieldParamsWithTimeout creates a new GetV1RunbooksSelectOptionsIntegrationSlugActionSlugFieldParams object with the ability to set a timeout on a request.
NewPatchV1RunbooksExecutionsExecutionIDStepsStepIDVotesOK creates a PatchV1RunbooksExecutionsExecutionIDStepsStepIDVotesOK with default headers values.
NewPatchV1RunbooksExecutionsExecutionIDStepsStepIDVotesParams creates a new PatchV1RunbooksExecutionsExecutionIDStepsStepIDVotesParams object, with the default timeout for this client.
NewPatchV1RunbooksExecutionsExecutionIDStepsStepIDVotesParamsWithContext creates a new PatchV1RunbooksExecutionsExecutionIDStepsStepIDVotesParams object with the ability to set a context for a request.
NewPatchV1RunbooksExecutionsExecutionIDStepsStepIDVotesParamsWithHTTPClient creates a new PatchV1RunbooksExecutionsExecutionIDStepsStepIDVotesParams object with the ability to set a custom HTTPClient for a request.
NewPatchV1RunbooksExecutionsExecutionIDStepsStepIDVotesParamsWithTimeout creates a new PatchV1RunbooksExecutionsExecutionIDStepsStepIDVotesParams object with the ability to set a timeout on a request.
NewPatchV1RunbooksExecutionsExecutionIDVotesOK creates a PatchV1RunbooksExecutionsExecutionIDVotesOK with default headers values.
NewPatchV1RunbooksExecutionsExecutionIDVotesParams creates a new PatchV1RunbooksExecutionsExecutionIDVotesParams object, with the default timeout for this client.
NewPatchV1RunbooksExecutionsExecutionIDVotesParamsWithContext creates a new PatchV1RunbooksExecutionsExecutionIDVotesParams object with the ability to set a context for a request.
NewPatchV1RunbooksExecutionsExecutionIDVotesParamsWithHTTPClient creates a new PatchV1RunbooksExecutionsExecutionIDVotesParams object with the ability to set a custom HTTPClient for a request.
NewPatchV1RunbooksExecutionsExecutionIDVotesParamsWithTimeout creates a new PatchV1RunbooksExecutionsExecutionIDVotesParams object with the ability to set a timeout on a request.
NewPostV1RunbooksCreated creates a PostV1RunbooksCreated with default headers values.
NewPostV1RunbooksExecutionsCreated creates a PostV1RunbooksExecutionsCreated with default headers values.
NewPostV1RunbooksExecutionsParams creates a new PostV1RunbooksExecutionsParams object, with the default timeout for this client.
NewPostV1RunbooksExecutionsParamsWithContext creates a new PostV1RunbooksExecutionsParams object with the ability to set a context for a request.
NewPostV1RunbooksExecutionsParamsWithHTTPClient creates a new PostV1RunbooksExecutionsParams object with the ability to set a custom HTTPClient for a request.
NewPostV1RunbooksExecutionsParamsWithTimeout creates a new PostV1RunbooksExecutionsParams object with the ability to set a timeout on a request.
NewPostV1RunbooksParams creates a new PostV1RunbooksParams object, with the default timeout for this client.
NewPostV1RunbooksParamsWithContext creates a new PostV1RunbooksParams object with the ability to set a context for a request.
NewPostV1RunbooksParamsWithHTTPClient creates a new PostV1RunbooksParams object with the ability to set a custom HTTPClient for a request.
NewPostV1RunbooksParamsWithTimeout creates a new PostV1RunbooksParams object with the ability to set a timeout on a request.
NewPutV1RunbooksExecutionsExecutionIDStepsStepIDOK creates a PutV1RunbooksExecutionsExecutionIDStepsStepIDOK with default headers values.
NewPutV1RunbooksExecutionsExecutionIDStepsStepIDParams creates a new PutV1RunbooksExecutionsExecutionIDStepsStepIDParams object, with the default timeout for this client.
NewPutV1RunbooksExecutionsExecutionIDStepsStepIDParamsWithContext creates a new PutV1RunbooksExecutionsExecutionIDStepsStepIDParams object with the ability to set a context for a request.
NewPutV1RunbooksExecutionsExecutionIDStepsStepIDParamsWithHTTPClient creates a new PutV1RunbooksExecutionsExecutionIDStepsStepIDParams object with the ability to set a custom HTTPClient for a request.
NewPutV1RunbooksExecutionsExecutionIDStepsStepIDParamsWithTimeout creates a new PutV1RunbooksExecutionsExecutionIDStepsStepIDParams object with the ability to set a timeout on a request.
NewPutV1RunbooksExecutionsExecutionIDStepsStepIDScriptStateOK creates a PutV1RunbooksExecutionsExecutionIDStepsStepIDScriptStateOK with default headers values.
NewPutV1RunbooksExecutionsExecutionIDStepsStepIDScriptStateParams creates a new PutV1RunbooksExecutionsExecutionIDStepsStepIDScriptStateParams object, with the default timeout for this client.
NewPutV1RunbooksExecutionsExecutionIDStepsStepIDScriptStateParamsWithContext creates a new PutV1RunbooksExecutionsExecutionIDStepsStepIDScriptStateParams object with the ability to set a context for a request.
NewPutV1RunbooksExecutionsExecutionIDStepsStepIDScriptStateParamsWithHTTPClient creates a new PutV1RunbooksExecutionsExecutionIDStepsStepIDScriptStateParams object with the ability to set a custom HTTPClient for a request.
NewPutV1RunbooksExecutionsExecutionIDStepsStepIDScriptStateParamsWithTimeout creates a new PutV1RunbooksExecutionsExecutionIDStepsStepIDScriptStateParams object with the ability to set a timeout on a request.
NewPutV1RunbooksRunbookIDOK creates a PutV1RunbooksRunbookIDOK with default headers values.
NewPutV1RunbooksRunbookIDParams creates a new PutV1RunbooksRunbookIDParams object, with the default timeout for this client.
NewPutV1RunbooksRunbookIDParamsWithContext creates a new PutV1RunbooksRunbookIDParams object with the ability to set a context for a request.
NewPutV1RunbooksRunbookIDParamsWithHTTPClient creates a new PutV1RunbooksRunbookIDParams object with the ability to set a custom HTTPClient for a request.
NewPutV1RunbooksRunbookIDParamsWithTimeout creates a new PutV1RunbooksRunbookIDParams object with the ability to set a timeout on a request.

# Structs

Client for runbooks API */.
DeleteV1RunbooksExecutionsExecutionIDNoContent describes a response with status code 204, with default header values.
DeleteV1RunbooksExecutionsExecutionIDParams contains all the parameters to send to the API endpoint for the delete v1 runbooks executions execution Id operation.
DeleteV1RunbooksExecutionsExecutionIDReader is a Reader for the DeleteV1RunbooksExecutionsExecutionID structure.
DeleteV1RunbooksRunbookIDOK describes a response with status code 200, with default header values.
DeleteV1RunbooksRunbookIDParams contains all the parameters to send to the API endpoint for the delete v1 runbooks runbook Id operation.
DeleteV1RunbooksRunbookIDReader is a Reader for the DeleteV1RunbooksRunbookID structure.
GetV1RunbooksActionsOK describes a response with status code 200, with default header values.
GetV1RunbooksActionsParams contains all the parameters to send to the API endpoint for the get v1 runbooks actions operation.
GetV1RunbooksActionsReader is a Reader for the GetV1RunbooksActions structure.
GetV1RunbooksExecutionsExecutionIDOK describes a response with status code 200, with default header values.
GetV1RunbooksExecutionsExecutionIDParams contains all the parameters to send to the API endpoint for the get v1 runbooks executions execution Id operation.
GetV1RunbooksExecutionsExecutionIDReader is a Reader for the GetV1RunbooksExecutionsExecutionID structure.
GetV1RunbooksExecutionsExecutionIDStepsStepIDScriptOK describes a response with status code 200, with default header values.
GetV1RunbooksExecutionsExecutionIDStepsStepIDScriptParams contains all the parameters to send to the API endpoint for the get v1 runbooks executions execution Id steps step Id script operation.
GetV1RunbooksExecutionsExecutionIDStepsStepIDScriptReader is a Reader for the GetV1RunbooksExecutionsExecutionIDStepsStepIDScript structure.
GetV1RunbooksExecutionsExecutionIDStepsStepIDVotesStatusOK describes a response with status code 200, with default header values.
GetV1RunbooksExecutionsExecutionIDStepsStepIDVotesStatusParams contains all the parameters to send to the API endpoint for the get v1 runbooks executions execution Id steps step Id votes status operation.
GetV1RunbooksExecutionsExecutionIDStepsStepIDVotesStatusReader is a Reader for the GetV1RunbooksExecutionsExecutionIDStepsStepIDVotesStatus structure.
GetV1RunbooksExecutionsExecutionIDVotesStatusOK describes a response with status code 200, with default header values.
GetV1RunbooksExecutionsExecutionIDVotesStatusParams contains all the parameters to send to the API endpoint for the get v1 runbooks executions execution Id votes status operation.
GetV1RunbooksExecutionsExecutionIDVotesStatusReader is a Reader for the GetV1RunbooksExecutionsExecutionIDVotesStatus structure.
GetV1RunbooksExecutionsOK describes a response with status code 200, with default header values.
GetV1RunbooksExecutionsParams contains all the parameters to send to the API endpoint for the get v1 runbooks executions operation.
GetV1RunbooksExecutionsReader is a Reader for the GetV1RunbooksExecutions structure.
GetV1RunbooksOK describes a response with status code 200, with default header values.
GetV1RunbooksParams contains all the parameters to send to the API endpoint for the get v1 runbooks operation.
GetV1RunbooksReader is a Reader for the GetV1Runbooks structure.
GetV1RunbooksRunbookIDOK describes a response with status code 200, with default header values.
GetV1RunbooksRunbookIDParams contains all the parameters to send to the API endpoint for the get v1 runbooks runbook Id operation.
GetV1RunbooksRunbookIDReader is a Reader for the GetV1RunbooksRunbookID structure.
GetV1RunbooksSelectOptionsIntegrationSlugActionSlugFieldOK describes a response with status code 200, with default header values.
GetV1RunbooksSelectOptionsIntegrationSlugActionSlugFieldParams contains all the parameters to send to the API endpoint for the get v1 runbooks select options integration slug action slug field operation.
GetV1RunbooksSelectOptionsIntegrationSlugActionSlugFieldReader is a Reader for the GetV1RunbooksSelectOptionsIntegrationSlugActionSlugField structure.
PatchV1RunbooksExecutionsExecutionIDStepsStepIDVotesOK describes a response with status code 200, with default header values.
PatchV1RunbooksExecutionsExecutionIDStepsStepIDVotesParams contains all the parameters to send to the API endpoint for the patch v1 runbooks executions execution Id steps step Id votes operation.
PatchV1RunbooksExecutionsExecutionIDStepsStepIDVotesReader is a Reader for the PatchV1RunbooksExecutionsExecutionIDStepsStepIDVotes structure.
PatchV1RunbooksExecutionsExecutionIDVotesOK describes a response with status code 200, with default header values.
PatchV1RunbooksExecutionsExecutionIDVotesParams contains all the parameters to send to the API endpoint for the patch v1 runbooks executions execution Id votes operation.
PatchV1RunbooksExecutionsExecutionIDVotesReader is a Reader for the PatchV1RunbooksExecutionsExecutionIDVotes structure.
PostV1RunbooksCreated describes a response with status code 201, with default header values.
PostV1RunbooksExecutionsCreated describes a response with status code 201, with default header values.
PostV1RunbooksExecutionsParams contains all the parameters to send to the API endpoint for the post v1 runbooks executions operation.
PostV1RunbooksExecutionsReader is a Reader for the PostV1RunbooksExecutions structure.
PostV1RunbooksParams contains all the parameters to send to the API endpoint for the post v1 runbooks operation.
PostV1RunbooksReader is a Reader for the PostV1Runbooks structure.
PutV1RunbooksExecutionsExecutionIDStepsStepIDOK describes a response with status code 200, with default header values.
PutV1RunbooksExecutionsExecutionIDStepsStepIDParams contains all the parameters to send to the API endpoint for the put v1 runbooks executions execution Id steps step Id operation.
PutV1RunbooksExecutionsExecutionIDStepsStepIDReader is a Reader for the PutV1RunbooksExecutionsExecutionIDStepsStepID structure.
PutV1RunbooksExecutionsExecutionIDStepsStepIDScriptStateOK describes a response with status code 200, with default header values.
PutV1RunbooksExecutionsExecutionIDStepsStepIDScriptStateParams contains all the parameters to send to the API endpoint for the put v1 runbooks executions execution Id steps step Id script state operation.
PutV1RunbooksExecutionsExecutionIDStepsStepIDScriptStateReader is a Reader for the PutV1RunbooksExecutionsExecutionIDStepsStepIDScriptState structure.
PutV1RunbooksRunbookIDOK describes a response with status code 200, with default header values.
PutV1RunbooksRunbookIDParams contains all the parameters to send to the API endpoint for the put v1 runbooks runbook Id operation.
PutV1RunbooksRunbookIDReader is a Reader for the PutV1RunbooksRunbookID structure.

# Interfaces

ClientService is the interface for Client methods.

# Type aliases

ClientOption is the option for Client methods.