Skip to content

Latest commit

 

History

History
534 lines (343 loc) · 17.3 KB

SupportAPI.md

File metadata and controls

534 lines (343 loc) · 17.3 KB

\SupportAPI

All URIs are relative to https://api.linode.com

Method HTTP request Description
GetTicket Get /{apiVersion}/support/tickets/{ticketId} Get a support ticket
GetTicketReplies Get /{apiVersion}/support/tickets/{ticketId}/replies List replies
GetTickets Get /{apiVersion}/support/tickets List support tickets
PostCloseTicket Post /{apiVersion}/support/tickets/{ticketId}/close Close a support ticket
PostTicket Post /{apiVersion}/support/tickets Open a support ticket
PostTicketAttachment Post /{apiVersion}/support/tickets/{ticketId}/attachments Create a support ticket attachment
PostTicketReply Post /{apiVersion}/support/tickets/{ticketId}/replies Create a reply

GetTicket

GetTickets200ResponseDataInner GetTicket(ctx, apiVersion, ticketId).Execute()

Get a support ticket

Example

package main

import (
	"context"
	"fmt"
	"os"
	openapiclient "github.com/GIT_USER_ID/GIT_REPO_ID"
)

func main() {
	apiVersion := "apiVersion_example" // string | __Enum__ Call either the `v4` URL, or `v4beta` for operations still in Beta. (default to "v4")
	ticketId := int32(56) // int32 | The ID of the Support Ticket.

	configuration := openapiclient.NewConfiguration()
	apiClient := openapiclient.NewAPIClient(configuration)
	resp, r, err := apiClient.SupportAPI.GetTicket(context.Background(), apiVersion, ticketId).Execute()
	if err != nil {
		fmt.Fprintf(os.Stderr, "Error when calling `SupportAPI.GetTicket``: %v\n", err)
		fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
	}
	// response from `GetTicket`: GetTickets200ResponseDataInner
	fmt.Fprintf(os.Stdout, "Response from `SupportAPI.GetTicket`: %v\n", resp)
}

Path Parameters

Name Type Description Notes
ctx context.Context context for authentication, logging, cancellation, deadlines, tracing, etc.
apiVersion string Enum Call either the `v4` URL, or `v4beta` for operations still in Beta. [default to "v4"]
ticketId int32 The ID of the Support Ticket.

Other Parameters

Other parameters are passed through a pointer to a apiGetTicketRequest struct via the builder pattern

Name Type Description Notes

Return type

GetTickets200ResponseDataInner

Authorization

personalAccessToken, oauth

HTTP request headers

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

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

GetTicketReplies

GetTicketReplies200Response GetTicketReplies(ctx, apiVersion, ticketId).Page(page).PageSize(pageSize).Execute()

List replies

Example

package main

import (
	"context"
	"fmt"
	"os"
	openapiclient "github.com/GIT_USER_ID/GIT_REPO_ID"
)

func main() {
	apiVersion := "apiVersion_example" // string | __Enum__ Call either the `v4` URL, or `v4beta` for operations still in Beta. (default to "v4")
	ticketId := int32(56) // int32 | The ID of the Support Ticket.
	page := int32(56) // int32 | The page of a collection to return. (optional) (default to 1)
	pageSize := int32(56) // int32 | The number of items to return per page. (optional) (default to 100)

	configuration := openapiclient.NewConfiguration()
	apiClient := openapiclient.NewAPIClient(configuration)
	resp, r, err := apiClient.SupportAPI.GetTicketReplies(context.Background(), apiVersion, ticketId).Page(page).PageSize(pageSize).Execute()
	if err != nil {
		fmt.Fprintf(os.Stderr, "Error when calling `SupportAPI.GetTicketReplies``: %v\n", err)
		fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
	}
	// response from `GetTicketReplies`: GetTicketReplies200Response
	fmt.Fprintf(os.Stdout, "Response from `SupportAPI.GetTicketReplies`: %v\n", resp)
}

Path Parameters

Name Type Description Notes
ctx context.Context context for authentication, logging, cancellation, deadlines, tracing, etc.
apiVersion string Enum Call either the `v4` URL, or `v4beta` for operations still in Beta. [default to "v4"]
ticketId int32 The ID of the Support Ticket.

Other Parameters

Other parameters are passed through a pointer to a apiGetTicketRepliesRequest struct via the builder pattern

Name Type Description Notes

page | int32 | The page of a collection to return. | [default to 1] pageSize | int32 | The number of items to return per page. | [default to 100]

Return type

GetTicketReplies200Response

Authorization

personalAccessToken, oauth

HTTP request headers

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

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

GetTickets

GetTickets200Response GetTickets(ctx, apiVersion).Page(page).PageSize(pageSize).Execute()

List support tickets

Example

package main

import (
	"context"
	"fmt"
	"os"
	openapiclient "github.com/GIT_USER_ID/GIT_REPO_ID"
)

func main() {
	apiVersion := "apiVersion_example" // string | __Enum__ Call either the `v4` URL, or `v4beta` for operations still in Beta. (default to "v4")
	page := int32(56) // int32 | The page of a collection to return. (optional) (default to 1)
	pageSize := int32(56) // int32 | The number of items to return per page. (optional) (default to 100)

	configuration := openapiclient.NewConfiguration()
	apiClient := openapiclient.NewAPIClient(configuration)
	resp, r, err := apiClient.SupportAPI.GetTickets(context.Background(), apiVersion).Page(page).PageSize(pageSize).Execute()
	if err != nil {
		fmt.Fprintf(os.Stderr, "Error when calling `SupportAPI.GetTickets``: %v\n", err)
		fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
	}
	// response from `GetTickets`: GetTickets200Response
	fmt.Fprintf(os.Stdout, "Response from `SupportAPI.GetTickets`: %v\n", resp)
}

Path Parameters

Name Type Description Notes
ctx context.Context context for authentication, logging, cancellation, deadlines, tracing, etc.
apiVersion string Enum Call either the `v4` URL, or `v4beta` for operations still in Beta. [default to "v4"]

Other Parameters

Other parameters are passed through a pointer to a apiGetTicketsRequest struct via the builder pattern

Name Type Description Notes

page | int32 | The page of a collection to return. | [default to 1] pageSize | int32 | The number of items to return per page. | [default to 100]

Return type

GetTickets200Response

Authorization

personalAccessToken, oauth

HTTP request headers

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

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

PostCloseTicket

map[string]interface{} PostCloseTicket(ctx, apiVersion, ticketId).Execute()

Close a support ticket

Example

package main

import (
	"context"
	"fmt"
	"os"
	openapiclient "github.com/GIT_USER_ID/GIT_REPO_ID"
)

func main() {
	apiVersion := "apiVersion_example" // string | __Enum__ Call either the `v4` URL, or `v4beta` for operations still in Beta. (default to "v4")
	ticketId := int32(56) // int32 | The ID of the Support Ticket.

	configuration := openapiclient.NewConfiguration()
	apiClient := openapiclient.NewAPIClient(configuration)
	resp, r, err := apiClient.SupportAPI.PostCloseTicket(context.Background(), apiVersion, ticketId).Execute()
	if err != nil {
		fmt.Fprintf(os.Stderr, "Error when calling `SupportAPI.PostCloseTicket``: %v\n", err)
		fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
	}
	// response from `PostCloseTicket`: map[string]interface{}
	fmt.Fprintf(os.Stdout, "Response from `SupportAPI.PostCloseTicket`: %v\n", resp)
}

Path Parameters

Name Type Description Notes
ctx context.Context context for authentication, logging, cancellation, deadlines, tracing, etc.
apiVersion string Enum Call either the `v4` URL, or `v4beta` for operations still in Beta. [default to "v4"]
ticketId int32 The ID of the Support Ticket.

Other Parameters

Other parameters are passed through a pointer to a apiPostCloseTicketRequest struct via the builder pattern

Name Type Description Notes

Return type

map[string]interface{}

Authorization

personalAccessToken, oauth

HTTP request headers

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

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

PostTicket

GetTickets200ResponseDataInner PostTicket(ctx, apiVersion).PostTicketRequest(postTicketRequest).Execute()

Open a support ticket

Example

package main

import (
	"context"
	"fmt"
	"os"
	openapiclient "github.com/GIT_USER_ID/GIT_REPO_ID"
)

func main() {
	apiVersion := "apiVersion_example" // string | __Enum__ Call either the `v4` URL, or `v4beta` for operations still in Beta. (default to "v4")
	postTicketRequest := *openapiclient.NewPostTicketRequest("I'm having trouble setting the root password on my Linode. I tried following the instructions but something is not working and I'm not sure what I'm doing wrong. Can you please help me figure out how I can reset it?", "Having trouble resetting root password on my Linode") // PostTicketRequest | Open a Support Ticket. (optional)

	configuration := openapiclient.NewConfiguration()
	apiClient := openapiclient.NewAPIClient(configuration)
	resp, r, err := apiClient.SupportAPI.PostTicket(context.Background(), apiVersion).PostTicketRequest(postTicketRequest).Execute()
	if err != nil {
		fmt.Fprintf(os.Stderr, "Error when calling `SupportAPI.PostTicket``: %v\n", err)
		fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
	}
	// response from `PostTicket`: GetTickets200ResponseDataInner
	fmt.Fprintf(os.Stdout, "Response from `SupportAPI.PostTicket`: %v\n", resp)
}

Path Parameters

Name Type Description Notes
ctx context.Context context for authentication, logging, cancellation, deadlines, tracing, etc.
apiVersion string Enum Call either the `v4` URL, or `v4beta` for operations still in Beta. [default to "v4"]

Other Parameters

Other parameters are passed through a pointer to a apiPostTicketRequest struct via the builder pattern

Name Type Description Notes

postTicketRequest | PostTicketRequest | Open a Support Ticket. |

Return type

GetTickets200ResponseDataInner

Authorization

personalAccessToken, oauth

HTTP request headers

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

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

PostTicketAttachment

map[string]interface{} PostTicketAttachment(ctx, apiVersion, ticketId).File(file).Execute()

Create a support ticket attachment

Example

package main

import (
	"context"
	"fmt"
	"os"
	openapiclient "github.com/GIT_USER_ID/GIT_REPO_ID"
)

func main() {
	apiVersion := "apiVersion_example" // string | __Enum__ Call either the `v4` URL, or `v4beta` for operations still in Beta. (default to "v4")
	ticketId := int32(56) // int32 | The ID of the Support Ticket.
	file := "file_example" // string | The local, absolute path to the file you want to attach to your Support Ticket.

	configuration := openapiclient.NewConfiguration()
	apiClient := openapiclient.NewAPIClient(configuration)
	resp, r, err := apiClient.SupportAPI.PostTicketAttachment(context.Background(), apiVersion, ticketId).File(file).Execute()
	if err != nil {
		fmt.Fprintf(os.Stderr, "Error when calling `SupportAPI.PostTicketAttachment``: %v\n", err)
		fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
	}
	// response from `PostTicketAttachment`: map[string]interface{}
	fmt.Fprintf(os.Stdout, "Response from `SupportAPI.PostTicketAttachment`: %v\n", resp)
}

Path Parameters

Name Type Description Notes
ctx context.Context context for authentication, logging, cancellation, deadlines, tracing, etc.
apiVersion string Enum Call either the `v4` URL, or `v4beta` for operations still in Beta. [default to "v4"]
ticketId int32 The ID of the Support Ticket.

Other Parameters

Other parameters are passed through a pointer to a apiPostTicketAttachmentRequest struct via the builder pattern

Name Type Description Notes

file | string | The local, absolute path to the file you want to attach to your Support Ticket. |

Return type

map[string]interface{}

Authorization

personalAccessToken, oauth

HTTP request headers

  • Content-Type: multipart/form-data
  • Accept: application/json

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

PostTicketReply

GetTicketReplies200ResponseDataInner PostTicketReply(ctx, apiVersion, ticketId).PostTicketReplyRequest(postTicketReplyRequest).Execute()

Create a reply

Example

package main

import (
	"context"
	"fmt"
	"os"
	openapiclient "github.com/GIT_USER_ID/GIT_REPO_ID"
)

func main() {
	apiVersion := "apiVersion_example" // string | __Enum__ Call either the `v4` URL, or `v4beta` for operations still in Beta. (default to "v4")
	ticketId := int32(56) // int32 | The ID of the Support Ticket.
	postTicketReplyRequest := *openapiclient.NewPostTicketReplyRequest("Thank you for your help. I was able to figure out what the problem was and I successfully reset my password. You guys are the best!") // PostTicketReplyRequest | Add a reply.

	configuration := openapiclient.NewConfiguration()
	apiClient := openapiclient.NewAPIClient(configuration)
	resp, r, err := apiClient.SupportAPI.PostTicketReply(context.Background(), apiVersion, ticketId).PostTicketReplyRequest(postTicketReplyRequest).Execute()
	if err != nil {
		fmt.Fprintf(os.Stderr, "Error when calling `SupportAPI.PostTicketReply``: %v\n", err)
		fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
	}
	// response from `PostTicketReply`: GetTicketReplies200ResponseDataInner
	fmt.Fprintf(os.Stdout, "Response from `SupportAPI.PostTicketReply`: %v\n", resp)
}

Path Parameters

Name Type Description Notes
ctx context.Context context for authentication, logging, cancellation, deadlines, tracing, etc.
apiVersion string Enum Call either the `v4` URL, or `v4beta` for operations still in Beta. [default to "v4"]
ticketId int32 The ID of the Support Ticket.

Other Parameters

Other parameters are passed through a pointer to a apiPostTicketReplyRequest struct via the builder pattern

Name Type Description Notes

postTicketReplyRequest | PostTicketReplyRequest | Add a reply. |

Return type

GetTicketReplies200ResponseDataInner

Authorization

personalAccessToken, oauth

HTTP request headers

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

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