Files
sdk/api_transport.go

1096 lines
41 KiB
Go

/*
Hanzo Cloud API
The Hanzo Cloud API as a customer calls it: every operation under /v1/ except the operator's admin product, relay routes, legacy spellings and capabilities still reached by flag. Tagged by product: the first path segment after /v1/.
API version: v1
*/
// Code generated by OpenAPI Generator (https://openapi-generator.tech); DO NOT EDIT.
package hanzoai
import (
"bytes"
"context"
"io"
"net/http"
"net/url"
"strings"
)
// TransportAPIService TransportAPI service
type TransportAPIService service
type TransportAPIGetTransportRequest struct {
ctx context.Context
ApiService *TransportAPIService
}
func (r TransportAPIGetTransportRequest) Execute() (*TransportChatTransports, *http.Response, error) {
return r.ApiService.GetTransportExecute(r)
}
/*
GetTransport Reports every chat transport this org can send through, and whether it can send through it right now.
Reports every chat transport this org can send through, and whether it can
send through it right now.
A transport appears here whether or not it is connected — an empty list would
leave a caller unable to tell "this org has no Slack" from "Slack is down",
which are different problems with different fixes. Each entry carries the
connection behind it, so the answer to "why can I not post?" is in the same
response as the transport that cannot post.
@param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
@return TransportAPIGetTransportRequest
*/
func (a *TransportAPIService) GetTransport(ctx context.Context) TransportAPIGetTransportRequest {
return TransportAPIGetTransportRequest{
ApiService: a,
ctx: ctx,
}
}
// Execute executes the request
//
// @return TransportChatTransports
func (a *TransportAPIService) GetTransportExecute(r TransportAPIGetTransportRequest) (*TransportChatTransports, *http.Response, error) {
var (
localVarHTTPMethod = http.MethodGet
localVarPostBody interface{}
formFiles []formFile
localVarReturnValue *TransportChatTransports
)
localBasePath, err := a.client.cfg.ServerURLWithContext(r.ctx, "TransportAPIService.GetTransport")
if err != nil {
return localVarReturnValue, nil, &GenericOpenAPIError{error: err.Error()}
}
localVarPath := localBasePath + "/v1/transport"
localVarHeaderParams := make(map[string]string)
localVarQueryParams := url.Values{}
localVarFormParams := url.Values{}
// to determine the Content-Type header
localVarHTTPContentTypes := []string{}
// set Content-Type header
localVarHTTPContentType := selectHeaderContentType(localVarHTTPContentTypes)
if localVarHTTPContentType != "" {
localVarHeaderParams["Content-Type"] = localVarHTTPContentType
}
// to determine the Accept header
localVarHTTPHeaderAccepts := []string{"application/json", "application/problem+json"}
// set Accept header
localVarHTTPHeaderAccept := selectHeaderAccept(localVarHTTPHeaderAccepts)
if localVarHTTPHeaderAccept != "" {
localVarHeaderParams["Accept"] = localVarHTTPHeaderAccept
}
req, err := a.client.prepareRequest(r.ctx, localVarPath, localVarHTTPMethod, localVarPostBody, localVarHeaderParams, localVarQueryParams, localVarFormParams, formFiles)
if err != nil {
return localVarReturnValue, nil, err
}
localVarHTTPResponse, err := a.client.callAPI(req)
if err != nil || localVarHTTPResponse == nil {
return localVarReturnValue, localVarHTTPResponse, err
}
localVarBody, err := io.ReadAll(localVarHTTPResponse.Body)
localVarHTTPResponse.Body.Close()
localVarHTTPResponse.Body = io.NopCloser(bytes.NewBuffer(localVarBody))
if err != nil {
return localVarReturnValue, localVarHTTPResponse, err
}
if localVarHTTPResponse.StatusCode >= 300 {
newErr := &GenericOpenAPIError{
body: localVarBody,
error: localVarHTTPResponse.Status,
}
var v ProblemDetails
err = a.client.decode(&v, localVarBody, localVarHTTPResponse.Header.Get("Content-Type"))
if err != nil {
newErr.error = err.Error()
return localVarReturnValue, localVarHTTPResponse, newErr
}
newErr.error = formatErrorMessage(localVarHTTPResponse.Status, &v)
newErr.model = v
return localVarReturnValue, localVarHTTPResponse, newErr
}
err = a.client.decode(&localVarReturnValue, localVarBody, localVarHTTPResponse.Header.Get("Content-Type"))
if err != nil {
newErr := &GenericOpenAPIError{
body: localVarBody,
error: err.Error(),
}
return localVarReturnValue, localVarHTTPResponse, newErr
}
return localVarReturnValue, localVarHTTPResponse, nil
}
type TransportAPIGetTransportAgentRequest struct {
ctx context.Context
ApiService *TransportAPIService
transport *string
}
// Transport is the transport: discord, github, linear, slack, teams, telegram or whatsapp. Required; an unknown value is a 404.
func (r TransportAPIGetTransportAgentRequest) Transport(transport string) TransportAPIGetTransportAgentRequest {
r.transport = &transport
return r
}
func (r TransportAPIGetTransportAgentRequest) Execute() (*TransportTransportAgents, *http.Response, error) {
return r.ApiService.GetTransportAgentExecute(r)
}
/*
GetTransportAgent Returns which agent answers the caller org's transport: the default and every channel bound to another agent.
Returns which agent answers the caller org's transport: the default and
every channel bound to another agent.
@param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
@return TransportAPIGetTransportAgentRequest
*/
func (a *TransportAPIService) GetTransportAgent(ctx context.Context) TransportAPIGetTransportAgentRequest {
return TransportAPIGetTransportAgentRequest{
ApiService: a,
ctx: ctx,
}
}
// Execute executes the request
//
// @return TransportTransportAgents
func (a *TransportAPIService) GetTransportAgentExecute(r TransportAPIGetTransportAgentRequest) (*TransportTransportAgents, *http.Response, error) {
var (
localVarHTTPMethod = http.MethodGet
localVarPostBody interface{}
formFiles []formFile
localVarReturnValue *TransportTransportAgents
)
localBasePath, err := a.client.cfg.ServerURLWithContext(r.ctx, "TransportAPIService.GetTransportAgent")
if err != nil {
return localVarReturnValue, nil, &GenericOpenAPIError{error: err.Error()}
}
localVarPath := localBasePath + "/v1/transport/agent"
localVarHeaderParams := make(map[string]string)
localVarQueryParams := url.Values{}
localVarFormParams := url.Values{}
if r.transport != nil {
parameterAddToHeaderOrQuery(localVarQueryParams, "transport", r.transport, "form", "")
}
// to determine the Content-Type header
localVarHTTPContentTypes := []string{}
// set Content-Type header
localVarHTTPContentType := selectHeaderContentType(localVarHTTPContentTypes)
if localVarHTTPContentType != "" {
localVarHeaderParams["Content-Type"] = localVarHTTPContentType
}
// to determine the Accept header
localVarHTTPHeaderAccepts := []string{"application/json", "application/problem+json"}
// set Accept header
localVarHTTPHeaderAccept := selectHeaderAccept(localVarHTTPHeaderAccepts)
if localVarHTTPHeaderAccept != "" {
localVarHeaderParams["Accept"] = localVarHTTPHeaderAccept
}
req, err := a.client.prepareRequest(r.ctx, localVarPath, localVarHTTPMethod, localVarPostBody, localVarHeaderParams, localVarQueryParams, localVarFormParams, formFiles)
if err != nil {
return localVarReturnValue, nil, err
}
localVarHTTPResponse, err := a.client.callAPI(req)
if err != nil || localVarHTTPResponse == nil {
return localVarReturnValue, localVarHTTPResponse, err
}
localVarBody, err := io.ReadAll(localVarHTTPResponse.Body)
localVarHTTPResponse.Body.Close()
localVarHTTPResponse.Body = io.NopCloser(bytes.NewBuffer(localVarBody))
if err != nil {
return localVarReturnValue, localVarHTTPResponse, err
}
if localVarHTTPResponse.StatusCode >= 300 {
newErr := &GenericOpenAPIError{
body: localVarBody,
error: localVarHTTPResponse.Status,
}
var v ProblemDetails
err = a.client.decode(&v, localVarBody, localVarHTTPResponse.Header.Get("Content-Type"))
if err != nil {
newErr.error = err.Error()
return localVarReturnValue, localVarHTTPResponse, newErr
}
newErr.error = formatErrorMessage(localVarHTTPResponse.Status, &v)
newErr.model = v
return localVarReturnValue, localVarHTTPResponse, newErr
}
err = a.client.decode(&localVarReturnValue, localVarBody, localVarHTTPResponse.Header.Get("Content-Type"))
if err != nil {
newErr := &GenericOpenAPIError{
body: localVarBody,
error: err.Error(),
}
return localVarReturnValue, localVarHTTPResponse, newErr
}
return localVarReturnValue, localVarHTTPResponse, nil
}
type TransportAPIGetTransportAllowlistRequest struct {
ctx context.Context
ApiService *TransportAPIService
transport *string
}
// Transport is the transport to read: discord, github, linear, slack, teams, telegram or whatsapp. Required; an unknown value is a 404.
func (r TransportAPIGetTransportAllowlistRequest) Transport(transport string) TransportAPIGetTransportAllowlistRequest {
r.transport = &transport
return r
}
func (r TransportAPIGetTransportAllowlistRequest) Execute() (*TransportAllowlistView, *http.Response, error) {
return r.ApiService.GetTransportAllowlistExecute(r)
}
/*
GetTransportAllowlist Returns the caller org's access policy for one transport: whether DMs are pairing-gated, allowlisted or open, whether group channels are open, allowlisted or disabled, the config-managed DM and group allow entries, the senders approved through PAIRING (read-only here), and the org's named access groups.
Returns the caller org's access policy for one transport: whether
DMs are pairing-gated, allowlisted or open, whether group channels are open,
allowlisted or disabled, the config-managed DM and group allow entries, the
senders approved through PAIRING (read-only here), and the org's named access
groups. An unknown transport is a 404. The entries name the people the org's
bots admit, so reading them is an org admin's, as editing them is.
@param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
@return TransportAPIGetTransportAllowlistRequest
*/
func (a *TransportAPIService) GetTransportAllowlist(ctx context.Context) TransportAPIGetTransportAllowlistRequest {
return TransportAPIGetTransportAllowlistRequest{
ApiService: a,
ctx: ctx,
}
}
// Execute executes the request
//
// @return TransportAllowlistView
func (a *TransportAPIService) GetTransportAllowlistExecute(r TransportAPIGetTransportAllowlistRequest) (*TransportAllowlistView, *http.Response, error) {
var (
localVarHTTPMethod = http.MethodGet
localVarPostBody interface{}
formFiles []formFile
localVarReturnValue *TransportAllowlistView
)
localBasePath, err := a.client.cfg.ServerURLWithContext(r.ctx, "TransportAPIService.GetTransportAllowlist")
if err != nil {
return localVarReturnValue, nil, &GenericOpenAPIError{error: err.Error()}
}
localVarPath := localBasePath + "/v1/transport/allowlist"
localVarHeaderParams := make(map[string]string)
localVarQueryParams := url.Values{}
localVarFormParams := url.Values{}
if r.transport != nil {
parameterAddToHeaderOrQuery(localVarQueryParams, "transport", r.transport, "form", "")
}
// to determine the Content-Type header
localVarHTTPContentTypes := []string{}
// set Content-Type header
localVarHTTPContentType := selectHeaderContentType(localVarHTTPContentTypes)
if localVarHTTPContentType != "" {
localVarHeaderParams["Content-Type"] = localVarHTTPContentType
}
// to determine the Accept header
localVarHTTPHeaderAccepts := []string{"application/json", "application/problem+json"}
// set Accept header
localVarHTTPHeaderAccept := selectHeaderAccept(localVarHTTPHeaderAccepts)
if localVarHTTPHeaderAccept != "" {
localVarHeaderParams["Accept"] = localVarHTTPHeaderAccept
}
req, err := a.client.prepareRequest(r.ctx, localVarPath, localVarHTTPMethod, localVarPostBody, localVarHeaderParams, localVarQueryParams, localVarFormParams, formFiles)
if err != nil {
return localVarReturnValue, nil, err
}
localVarHTTPResponse, err := a.client.callAPI(req)
if err != nil || localVarHTTPResponse == nil {
return localVarReturnValue, localVarHTTPResponse, err
}
localVarBody, err := io.ReadAll(localVarHTTPResponse.Body)
localVarHTTPResponse.Body.Close()
localVarHTTPResponse.Body = io.NopCloser(bytes.NewBuffer(localVarBody))
if err != nil {
return localVarReturnValue, localVarHTTPResponse, err
}
if localVarHTTPResponse.StatusCode >= 300 {
newErr := &GenericOpenAPIError{
body: localVarBody,
error: localVarHTTPResponse.Status,
}
var v ProblemDetails
err = a.client.decode(&v, localVarBody, localVarHTTPResponse.Header.Get("Content-Type"))
if err != nil {
newErr.error = err.Error()
return localVarReturnValue, localVarHTTPResponse, newErr
}
newErr.error = formatErrorMessage(localVarHTTPResponse.Status, &v)
newErr.model = v
return localVarReturnValue, localVarHTTPResponse, newErr
}
err = a.client.decode(&localVarReturnValue, localVarBody, localVarHTTPResponse.Header.Get("Content-Type"))
if err != nil {
newErr := &GenericOpenAPIError{
body: localVarBody,
error: err.Error(),
}
return localVarReturnValue, localVarHTTPResponse, newErr
}
return localVarReturnValue, localVarHTTPResponse, nil
}
type TransportAPIGetTransportInboxRequest struct {
ctx context.Context
ApiService *TransportAPIService
since *string
limit *string
}
// Since is the exclusive cursor: only messages with a higher row id come back. Empty starts at the beginning. Must parse as an integer.
func (r TransportAPIGetTransportInboxRequest) Since(since string) TransportAPIGetTransportInboxRequest {
r.since = &since
return r
}
// Limit caps how many messages come back. Empty or 0 uses the store's default page size. Must parse as an integer.
func (r TransportAPIGetTransportInboxRequest) Limit(limit string) TransportAPIGetTransportInboxRequest {
r.limit = &limit
return r
}
func (r TransportAPIGetTransportInboxRequest) Execute() (*TransportInboxPage, *http.Response, error) {
return r.ApiService.GetTransportInboxExecute(r)
}
/*
GetTransportInbox Returns the caller's own messages to the org's connected chat bots — those recorded on the caller's linked account — oldest first, in the portable envelope shape every transport normalises into.
Returns the caller's own messages to the org's connected chat bots —
those recorded on the caller's linked account — oldest first, in the portable
envelope shape every transport normalises into. It is a CURSOR feed, not a
search: pass the returned cursor back as `since` to get only what has arrived
since. A message is its person's: another member's is never listed, an admin
of the org reads only their own, and one recorded on no account is listed to a
SuperAdmin alone.
@param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
@return TransportAPIGetTransportInboxRequest
*/
func (a *TransportAPIService) GetTransportInbox(ctx context.Context) TransportAPIGetTransportInboxRequest {
return TransportAPIGetTransportInboxRequest{
ApiService: a,
ctx: ctx,
}
}
// Execute executes the request
//
// @return TransportInboxPage
func (a *TransportAPIService) GetTransportInboxExecute(r TransportAPIGetTransportInboxRequest) (*TransportInboxPage, *http.Response, error) {
var (
localVarHTTPMethod = http.MethodGet
localVarPostBody interface{}
formFiles []formFile
localVarReturnValue *TransportInboxPage
)
localBasePath, err := a.client.cfg.ServerURLWithContext(r.ctx, "TransportAPIService.GetTransportInbox")
if err != nil {
return localVarReturnValue, nil, &GenericOpenAPIError{error: err.Error()}
}
localVarPath := localBasePath + "/v1/transport/inbox"
localVarHeaderParams := make(map[string]string)
localVarQueryParams := url.Values{}
localVarFormParams := url.Values{}
if r.since != nil {
parameterAddToHeaderOrQuery(localVarQueryParams, "since", r.since, "form", "")
}
if r.limit != nil {
parameterAddToHeaderOrQuery(localVarQueryParams, "limit", r.limit, "form", "")
}
// to determine the Content-Type header
localVarHTTPContentTypes := []string{}
// set Content-Type header
localVarHTTPContentType := selectHeaderContentType(localVarHTTPContentTypes)
if localVarHTTPContentType != "" {
localVarHeaderParams["Content-Type"] = localVarHTTPContentType
}
// to determine the Accept header
localVarHTTPHeaderAccepts := []string{"application/json", "application/problem+json"}
// set Accept header
localVarHTTPHeaderAccept := selectHeaderAccept(localVarHTTPHeaderAccepts)
if localVarHTTPHeaderAccept != "" {
localVarHeaderParams["Accept"] = localVarHTTPHeaderAccept
}
req, err := a.client.prepareRequest(r.ctx, localVarPath, localVarHTTPMethod, localVarPostBody, localVarHeaderParams, localVarQueryParams, localVarFormParams, formFiles)
if err != nil {
return localVarReturnValue, nil, err
}
localVarHTTPResponse, err := a.client.callAPI(req)
if err != nil || localVarHTTPResponse == nil {
return localVarReturnValue, localVarHTTPResponse, err
}
localVarBody, err := io.ReadAll(localVarHTTPResponse.Body)
localVarHTTPResponse.Body.Close()
localVarHTTPResponse.Body = io.NopCloser(bytes.NewBuffer(localVarBody))
if err != nil {
return localVarReturnValue, localVarHTTPResponse, err
}
if localVarHTTPResponse.StatusCode >= 300 {
newErr := &GenericOpenAPIError{
body: localVarBody,
error: localVarHTTPResponse.Status,
}
var v ProblemDetails
err = a.client.decode(&v, localVarBody, localVarHTTPResponse.Header.Get("Content-Type"))
if err != nil {
newErr.error = err.Error()
return localVarReturnValue, localVarHTTPResponse, newErr
}
newErr.error = formatErrorMessage(localVarHTTPResponse.Status, &v)
newErr.model = v
return localVarReturnValue, localVarHTTPResponse, newErr
}
err = a.client.decode(&localVarReturnValue, localVarBody, localVarHTTPResponse.Header.Get("Content-Type"))
if err != nil {
newErr := &GenericOpenAPIError{
body: localVarBody,
error: err.Error(),
}
return localVarReturnValue, localVarHTTPResponse, newErr
}
return localVarReturnValue, localVarHTTPResponse, nil
}
type TransportAPIGetTransportPairingRequest struct {
ctx context.Context
ApiService *TransportAPIService
}
func (r TransportAPIGetTransportPairingRequest) Execute() (*TransportPairingQueue, *http.Response, error) {
return r.ApiService.GetTransportPairingExecute(r)
}
/*
GetTransportPairing Returns the pairing requests waiting for the caller org to approve — one per person who messaged a connected bot on a transport whose DM policy is \"pairing\" and who is not allowed yet.
Returns the pairing requests waiting for the caller org to approve
— one per person who messaged a connected bot on a transport whose DM policy is
"pairing" and who is not allowed yet. Each row carries the CODE an org admin
passes to POST /v1/transport/pairing/approve. Expired requests are not
returned. Codes are capability strings: they are shown here, and never logged.
Reading them is an org admin's, as approving them is.
@param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
@return TransportAPIGetTransportPairingRequest
*/
func (a *TransportAPIService) GetTransportPairing(ctx context.Context) TransportAPIGetTransportPairingRequest {
return TransportAPIGetTransportPairingRequest{
ApiService: a,
ctx: ctx,
}
}
// Execute executes the request
//
// @return TransportPairingQueue
func (a *TransportAPIService) GetTransportPairingExecute(r TransportAPIGetTransportPairingRequest) (*TransportPairingQueue, *http.Response, error) {
var (
localVarHTTPMethod = http.MethodGet
localVarPostBody interface{}
formFiles []formFile
localVarReturnValue *TransportPairingQueue
)
localBasePath, err := a.client.cfg.ServerURLWithContext(r.ctx, "TransportAPIService.GetTransportPairing")
if err != nil {
return localVarReturnValue, nil, &GenericOpenAPIError{error: err.Error()}
}
localVarPath := localBasePath + "/v1/transport/pairing"
localVarHeaderParams := make(map[string]string)
localVarQueryParams := url.Values{}
localVarFormParams := url.Values{}
// to determine the Content-Type header
localVarHTTPContentTypes := []string{}
// set Content-Type header
localVarHTTPContentType := selectHeaderContentType(localVarHTTPContentTypes)
if localVarHTTPContentType != "" {
localVarHeaderParams["Content-Type"] = localVarHTTPContentType
}
// to determine the Accept header
localVarHTTPHeaderAccepts := []string{"application/json", "application/problem+json"}
// set Accept header
localVarHTTPHeaderAccept := selectHeaderAccept(localVarHTTPHeaderAccepts)
if localVarHTTPHeaderAccept != "" {
localVarHeaderParams["Accept"] = localVarHTTPHeaderAccept
}
req, err := a.client.prepareRequest(r.ctx, localVarPath, localVarHTTPMethod, localVarPostBody, localVarHeaderParams, localVarQueryParams, localVarFormParams, formFiles)
if err != nil {
return localVarReturnValue, nil, err
}
localVarHTTPResponse, err := a.client.callAPI(req)
if err != nil || localVarHTTPResponse == nil {
return localVarReturnValue, localVarHTTPResponse, err
}
localVarBody, err := io.ReadAll(localVarHTTPResponse.Body)
localVarHTTPResponse.Body.Close()
localVarHTTPResponse.Body = io.NopCloser(bytes.NewBuffer(localVarBody))
if err != nil {
return localVarReturnValue, localVarHTTPResponse, err
}
if localVarHTTPResponse.StatusCode >= 300 {
newErr := &GenericOpenAPIError{
body: localVarBody,
error: localVarHTTPResponse.Status,
}
var v ProblemDetails
err = a.client.decode(&v, localVarBody, localVarHTTPResponse.Header.Get("Content-Type"))
if err != nil {
newErr.error = err.Error()
return localVarReturnValue, localVarHTTPResponse, newErr
}
newErr.error = formatErrorMessage(localVarHTTPResponse.Status, &v)
newErr.model = v
return localVarReturnValue, localVarHTTPResponse, newErr
}
err = a.client.decode(&localVarReturnValue, localVarBody, localVarHTTPResponse.Header.Get("Content-Type"))
if err != nil {
newErr := &GenericOpenAPIError{
body: localVarBody,
error: err.Error(),
}
return localVarReturnValue, localVarHTTPResponse, newErr
}
return localVarReturnValue, localVarHTTPResponse, nil
}
type TransportAPIPostTransportByTransportSendRequest struct {
ctx context.Context
ApiService *TransportAPIService
transport string
}
func (r TransportAPIPostTransportByTransportSendRequest) Execute() (*http.Response, error) {
return r.ApiService.PostTransportByTransportSendExecute(r)
}
/*
PostTransportByTransportSend Send a message from your org's bot to one chat channel
Delivers text, attachments and actions to one channel on a connected chat transport — discord, github, linear, slack, teams, telegram or whatsapp — and answers that transport's own receipt, the `messageId` it assigned and the Unix second it landed. An unknown transport is a 404.
The body is the envelope's NARROW outbound projection: `channel`, `text`, `attachments`, `actions`, `replyTo` and `idempotency`, and nothing else. Identity is not a field — the transport is the path segment and the sender is the caller's validated org — so a body carrying `sender`, `account` or `transport` is refused with 400 rather than having it silently dropped. `channel.id` is required, and so is something to say: text, or at least one attachment.
Requires a validated principal; 401 without one. The channel must already belong to the caller's org — each transport verifies the binding itself, so a channel this org has not bound is 403 and a channel whose route the bot has never learned is 409, meaning someone has to message the bot there first. A route learned only so a pairing reply could be delivered lasts exactly as long as that pairing request does, so a channel whose sender was never approved goes back to 409 within the hour. A transport that fails answers 502 carrying status and shape only, never a token.
Sending is at-most-once only if you ask for it: pass an `idempotency` string and a replay answers 200 with the PRIOR receipt instead of sending twice, while a send that fails releases the key so the caller can re-attempt. Bodies over 1 MiB are refused. Every transport currently renders text only, so attachments and actions are flattened deterministically to one line each after the text rather than dropped.
@param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
@param transport
@return TransportAPIPostTransportByTransportSendRequest
*/
func (a *TransportAPIService) PostTransportByTransportSend(ctx context.Context, transport string) TransportAPIPostTransportByTransportSendRequest {
return TransportAPIPostTransportByTransportSendRequest{
ApiService: a,
ctx: ctx,
transport: transport,
}
}
// Execute executes the request
func (a *TransportAPIService) PostTransportByTransportSendExecute(r TransportAPIPostTransportByTransportSendRequest) (*http.Response, error) {
var (
localVarHTTPMethod = http.MethodPost
localVarPostBody interface{}
formFiles []formFile
)
localBasePath, err := a.client.cfg.ServerURLWithContext(r.ctx, "TransportAPIService.PostTransportByTransportSend")
if err != nil {
return nil, &GenericOpenAPIError{error: err.Error()}
}
localVarPath := localBasePath + "/v1/transport/{transport}/send"
localVarPath = strings.Replace(localVarPath, "{"+"transport"+"}", url.PathEscape(parameterValueToString(r.transport, "transport")), -1)
localVarHeaderParams := make(map[string]string)
localVarQueryParams := url.Values{}
localVarFormParams := url.Values{}
// to determine the Content-Type header
localVarHTTPContentTypes := []string{}
// set Content-Type header
localVarHTTPContentType := selectHeaderContentType(localVarHTTPContentTypes)
if localVarHTTPContentType != "" {
localVarHeaderParams["Content-Type"] = localVarHTTPContentType
}
// to determine the Accept header
localVarHTTPHeaderAccepts := []string{}
// set Accept header
localVarHTTPHeaderAccept := selectHeaderAccept(localVarHTTPHeaderAccepts)
if localVarHTTPHeaderAccept != "" {
localVarHeaderParams["Accept"] = localVarHTTPHeaderAccept
}
req, err := a.client.prepareRequest(r.ctx, localVarPath, localVarHTTPMethod, localVarPostBody, localVarHeaderParams, localVarQueryParams, localVarFormParams, formFiles)
if err != nil {
return nil, err
}
localVarHTTPResponse, err := a.client.callAPI(req)
if err != nil || localVarHTTPResponse == nil {
return localVarHTTPResponse, err
}
localVarBody, err := io.ReadAll(localVarHTTPResponse.Body)
localVarHTTPResponse.Body.Close()
localVarHTTPResponse.Body = io.NopCloser(bytes.NewBuffer(localVarBody))
if err != nil {
return localVarHTTPResponse, err
}
if localVarHTTPResponse.StatusCode >= 300 {
newErr := &GenericOpenAPIError{
body: localVarBody,
error: localVarHTTPResponse.Status,
}
return localVarHTTPResponse, newErr
}
return localVarHTTPResponse, nil
}
type TransportAPIPostTransportPairingApproveRequest struct {
ctx context.Context
ApiService *TransportAPIService
transportApprovePairingIn *TransportApprovePairingIn
}
func (r TransportAPIPostTransportPairingApproveRequest) TransportApprovePairingIn(transportApprovePairingIn TransportApprovePairingIn) TransportAPIPostTransportPairingApproveRequest {
r.transportApprovePairingIn = &transportApprovePairingIn
return r
}
func (r TransportAPIPostTransportPairingApproveRequest) Execute() (*TransportPairingApproved, *http.Response, error) {
return r.ApiService.PostTransportPairingApproveExecute(r)
}
/*
PostTransportPairingApprove Turns one pending pairing code into a standing allow entry, so that person can DM the org's bot on that transport from now on.
Turns one pending pairing code into a standing allow entry, so
that person can DM the org's bot on that transport from now on. It requires ORG
ADMIN, not merely membership. The first approval an org makes on a transport also
bootstraps that sender as the transport's owner, which the answer reports. An
unknown or expired code is a 404, and a code always belongs to exactly one
org, so it can never approve someone into another tenant.
@param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
@return TransportAPIPostTransportPairingApproveRequest
*/
func (a *TransportAPIService) PostTransportPairingApprove(ctx context.Context) TransportAPIPostTransportPairingApproveRequest {
return TransportAPIPostTransportPairingApproveRequest{
ApiService: a,
ctx: ctx,
}
}
// Execute executes the request
//
// @return TransportPairingApproved
func (a *TransportAPIService) PostTransportPairingApproveExecute(r TransportAPIPostTransportPairingApproveRequest) (*TransportPairingApproved, *http.Response, error) {
var (
localVarHTTPMethod = http.MethodPost
localVarPostBody interface{}
formFiles []formFile
localVarReturnValue *TransportPairingApproved
)
localBasePath, err := a.client.cfg.ServerURLWithContext(r.ctx, "TransportAPIService.PostTransportPairingApprove")
if err != nil {
return localVarReturnValue, nil, &GenericOpenAPIError{error: err.Error()}
}
localVarPath := localBasePath + "/v1/transport/pairing/approve"
localVarHeaderParams := make(map[string]string)
localVarQueryParams := url.Values{}
localVarFormParams := url.Values{}
if r.transportApprovePairingIn == nil {
return localVarReturnValue, nil, reportError("transportApprovePairingIn is required and must be specified")
}
// to determine the Content-Type header
localVarHTTPContentTypes := []string{"application/json"}
// set Content-Type header
localVarHTTPContentType := selectHeaderContentType(localVarHTTPContentTypes)
if localVarHTTPContentType != "" {
localVarHeaderParams["Content-Type"] = localVarHTTPContentType
}
// to determine the Accept header
localVarHTTPHeaderAccepts := []string{"application/json", "application/problem+json"}
// set Accept header
localVarHTTPHeaderAccept := selectHeaderAccept(localVarHTTPHeaderAccepts)
if localVarHTTPHeaderAccept != "" {
localVarHeaderParams["Accept"] = localVarHTTPHeaderAccept
}
// body params
localVarPostBody = r.transportApprovePairingIn
req, err := a.client.prepareRequest(r.ctx, localVarPath, localVarHTTPMethod, localVarPostBody, localVarHeaderParams, localVarQueryParams, localVarFormParams, formFiles)
if err != nil {
return localVarReturnValue, nil, err
}
localVarHTTPResponse, err := a.client.callAPI(req)
if err != nil || localVarHTTPResponse == nil {
return localVarReturnValue, localVarHTTPResponse, err
}
localVarBody, err := io.ReadAll(localVarHTTPResponse.Body)
localVarHTTPResponse.Body.Close()
localVarHTTPResponse.Body = io.NopCloser(bytes.NewBuffer(localVarBody))
if err != nil {
return localVarReturnValue, localVarHTTPResponse, err
}
if localVarHTTPResponse.StatusCode >= 300 {
newErr := &GenericOpenAPIError{
body: localVarBody,
error: localVarHTTPResponse.Status,
}
var v ProblemDetails
err = a.client.decode(&v, localVarBody, localVarHTTPResponse.Header.Get("Content-Type"))
if err != nil {
newErr.error = err.Error()
return localVarReturnValue, localVarHTTPResponse, newErr
}
newErr.error = formatErrorMessage(localVarHTTPResponse.Status, &v)
newErr.model = v
return localVarReturnValue, localVarHTTPResponse, newErr
}
err = a.client.decode(&localVarReturnValue, localVarBody, localVarHTTPResponse.Header.Get("Content-Type"))
if err != nil {
newErr := &GenericOpenAPIError{
body: localVarBody,
error: err.Error(),
}
return localVarReturnValue, localVarHTTPResponse, newErr
}
return localVarReturnValue, localVarHTTPResponse, nil
}
type TransportAPIPutTransportAgentRequest struct {
ctx context.Context
ApiService *TransportAPIService
transportTransportAgentsPut *TransportTransportAgentsPut
}
func (r TransportAPIPutTransportAgentRequest) TransportTransportAgentsPut(transportTransportAgentsPut TransportTransportAgentsPut) TransportAPIPutTransportAgentRequest {
r.transportTransportAgentsPut = &transportTransportAgentsPut
return r
}
func (r TransportAPIPutTransportAgentRequest) Execute() (*TransportTransportAgents, *http.Response, error) {
return r.ApiService.PutTransportAgentExecute(r)
}
/*
PutTransportAgent Binds agents to the caller org's transport and answers the bindings as GET would.
Binds agents to the caller org's transport and answers the bindings as
GET would. It requires ORG ADMIN. The agent is named by its ref — the name an
org gave it at POST /v1/agent, or a built-in such as dev, des or vi.
@param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
@return TransportAPIPutTransportAgentRequest
*/
func (a *TransportAPIService) PutTransportAgent(ctx context.Context) TransportAPIPutTransportAgentRequest {
return TransportAPIPutTransportAgentRequest{
ApiService: a,
ctx: ctx,
}
}
// Execute executes the request
//
// @return TransportTransportAgents
func (a *TransportAPIService) PutTransportAgentExecute(r TransportAPIPutTransportAgentRequest) (*TransportTransportAgents, *http.Response, error) {
var (
localVarHTTPMethod = http.MethodPut
localVarPostBody interface{}
formFiles []formFile
localVarReturnValue *TransportTransportAgents
)
localBasePath, err := a.client.cfg.ServerURLWithContext(r.ctx, "TransportAPIService.PutTransportAgent")
if err != nil {
return localVarReturnValue, nil, &GenericOpenAPIError{error: err.Error()}
}
localVarPath := localBasePath + "/v1/transport/agent"
localVarHeaderParams := make(map[string]string)
localVarQueryParams := url.Values{}
localVarFormParams := url.Values{}
if r.transportTransportAgentsPut == nil {
return localVarReturnValue, nil, reportError("transportTransportAgentsPut is required and must be specified")
}
// to determine the Content-Type header
localVarHTTPContentTypes := []string{"application/json"}
// set Content-Type header
localVarHTTPContentType := selectHeaderContentType(localVarHTTPContentTypes)
if localVarHTTPContentType != "" {
localVarHeaderParams["Content-Type"] = localVarHTTPContentType
}
// to determine the Accept header
localVarHTTPHeaderAccepts := []string{"application/json", "application/problem+json"}
// set Accept header
localVarHTTPHeaderAccept := selectHeaderAccept(localVarHTTPHeaderAccepts)
if localVarHTTPHeaderAccept != "" {
localVarHeaderParams["Accept"] = localVarHTTPHeaderAccept
}
// body params
localVarPostBody = r.transportTransportAgentsPut
req, err := a.client.prepareRequest(r.ctx, localVarPath, localVarHTTPMethod, localVarPostBody, localVarHeaderParams, localVarQueryParams, localVarFormParams, formFiles)
if err != nil {
return localVarReturnValue, nil, err
}
localVarHTTPResponse, err := a.client.callAPI(req)
if err != nil || localVarHTTPResponse == nil {
return localVarReturnValue, localVarHTTPResponse, err
}
localVarBody, err := io.ReadAll(localVarHTTPResponse.Body)
localVarHTTPResponse.Body.Close()
localVarHTTPResponse.Body = io.NopCloser(bytes.NewBuffer(localVarBody))
if err != nil {
return localVarReturnValue, localVarHTTPResponse, err
}
if localVarHTTPResponse.StatusCode >= 300 {
newErr := &GenericOpenAPIError{
body: localVarBody,
error: localVarHTTPResponse.Status,
}
var v ProblemDetails
err = a.client.decode(&v, localVarBody, localVarHTTPResponse.Header.Get("Content-Type"))
if err != nil {
newErr.error = err.Error()
return localVarReturnValue, localVarHTTPResponse, newErr
}
newErr.error = formatErrorMessage(localVarHTTPResponse.Status, &v)
newErr.model = v
return localVarReturnValue, localVarHTTPResponse, newErr
}
err = a.client.decode(&localVarReturnValue, localVarBody, localVarHTTPResponse.Header.Get("Content-Type"))
if err != nil {
newErr := &GenericOpenAPIError{
body: localVarBody,
error: err.Error(),
}
return localVarReturnValue, localVarHTTPResponse, newErr
}
return localVarReturnValue, localVarHTTPResponse, nil
}
type TransportAPIPutTransportAllowlistRequest struct {
ctx context.Context
ApiService *TransportAPIService
transportAllowlistPutIn *TransportAllowlistPutIn
}
func (r TransportAPIPutTransportAllowlistRequest) TransportAllowlistPutIn(transportAllowlistPutIn TransportAllowlistPutIn) TransportAPIPutTransportAllowlistRequest {
r.transportAllowlistPutIn = &transportAllowlistPutIn
return r
}
func (r TransportAPIPutTransportAllowlistRequest) Execute() (*TransportAllowlistView, *http.Response, error) {
return r.ApiService.PutTransportAllowlistExecute(r)
}
/*
PutTransportAllowlist Edits the caller org's access policy for one transport and answers the policy as GET would, so both verbs return ONE shape.
Edits the caller org's access policy for one transport and answers
the policy as GET would, so both verbs return ONE shape. It requires ORG ADMIN.
Every field but `transport` is optional and applied only when provided: an empty
policy string leaves that policy alone, an absent or null list leaves that list
alone, and an EMPTY list clears it. It writes only CONFIG-sourced allow entries
— senders approved through pairing belong to the approval flow, so a policy
edit can never revoke one. An unknown transport is a 404.
@param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
@return TransportAPIPutTransportAllowlistRequest
*/
func (a *TransportAPIService) PutTransportAllowlist(ctx context.Context) TransportAPIPutTransportAllowlistRequest {
return TransportAPIPutTransportAllowlistRequest{
ApiService: a,
ctx: ctx,
}
}
// Execute executes the request
//
// @return TransportAllowlistView
func (a *TransportAPIService) PutTransportAllowlistExecute(r TransportAPIPutTransportAllowlistRequest) (*TransportAllowlistView, *http.Response, error) {
var (
localVarHTTPMethod = http.MethodPut
localVarPostBody interface{}
formFiles []formFile
localVarReturnValue *TransportAllowlistView
)
localBasePath, err := a.client.cfg.ServerURLWithContext(r.ctx, "TransportAPIService.PutTransportAllowlist")
if err != nil {
return localVarReturnValue, nil, &GenericOpenAPIError{error: err.Error()}
}
localVarPath := localBasePath + "/v1/transport/allowlist"
localVarHeaderParams := make(map[string]string)
localVarQueryParams := url.Values{}
localVarFormParams := url.Values{}
if r.transportAllowlistPutIn == nil {
return localVarReturnValue, nil, reportError("transportAllowlistPutIn is required and must be specified")
}
// to determine the Content-Type header
localVarHTTPContentTypes := []string{"application/json"}
// set Content-Type header
localVarHTTPContentType := selectHeaderContentType(localVarHTTPContentTypes)
if localVarHTTPContentType != "" {
localVarHeaderParams["Content-Type"] = localVarHTTPContentType
}
// to determine the Accept header
localVarHTTPHeaderAccepts := []string{"application/json", "application/problem+json"}
// set Accept header
localVarHTTPHeaderAccept := selectHeaderAccept(localVarHTTPHeaderAccepts)
if localVarHTTPHeaderAccept != "" {
localVarHeaderParams["Accept"] = localVarHTTPHeaderAccept
}
// body params
localVarPostBody = r.transportAllowlistPutIn
req, err := a.client.prepareRequest(r.ctx, localVarPath, localVarHTTPMethod, localVarPostBody, localVarHeaderParams, localVarQueryParams, localVarFormParams, formFiles)
if err != nil {
return localVarReturnValue, nil, err
}
localVarHTTPResponse, err := a.client.callAPI(req)
if err != nil || localVarHTTPResponse == nil {
return localVarReturnValue, localVarHTTPResponse, err
}
localVarBody, err := io.ReadAll(localVarHTTPResponse.Body)
localVarHTTPResponse.Body.Close()
localVarHTTPResponse.Body = io.NopCloser(bytes.NewBuffer(localVarBody))
if err != nil {
return localVarReturnValue, localVarHTTPResponse, err
}
if localVarHTTPResponse.StatusCode >= 300 {
newErr := &GenericOpenAPIError{
body: localVarBody,
error: localVarHTTPResponse.Status,
}
var v ProblemDetails
err = a.client.decode(&v, localVarBody, localVarHTTPResponse.Header.Get("Content-Type"))
if err != nil {
newErr.error = err.Error()
return localVarReturnValue, localVarHTTPResponse, newErr
}
newErr.error = formatErrorMessage(localVarHTTPResponse.Status, &v)
newErr.model = v
return localVarReturnValue, localVarHTTPResponse, newErr
}
err = a.client.decode(&localVarReturnValue, localVarBody, localVarHTTPResponse.Header.Get("Content-Type"))
if err != nil {
newErr := &GenericOpenAPIError{
body: localVarBody,
error: err.Error(),
}
return localVarReturnValue, localVarHTTPResponse, newErr
}
return localVarReturnValue, localVarHTTPResponse, nil
}