InvitationsAPI.md

InvitationsAPI

Note

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

Method	HTTP request	Description
CreateInvitation	POST /invitations	Create an invitation
DeleteInvitation	DELETE /invitations/{invitation_id}	Delete an invitation
ListInvitations	GET /invitations	List invitations

CreateInvitation

Create an invitation

Example

package main

import (
    "context"
    "fmt"
    "os"
    "github.com/fastly/fastly-go/fastly"
)

func main() {
    invitation := *openapiclient.NewInvitation() // Invitation |  (optional)

    cfg := fastly.NewConfiguration()
    apiClient := fastly.NewAPIClient(cfg)
    ctx := fastly.NewAPIKeyContextFromEnv("FASTLY_API_TOKEN")
    resp, r, err := apiClient.InvitationsAPI.CreateInvitation(ctx).Invitation(invitation).Execute()
    if err != nil {
        fmt.Fprintf(os.Stderr, "Error when calling `InvitationsAPI.CreateInvitation`: %v\n", err)
        fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
    }
    // response from `CreateInvitation`: InvitationResponse
    fmt.Fprintf(os.Stdout, "Response from `InvitationsAPI.CreateInvitation`: %v\n", resp)
}

Path Parameters

Other Parameters

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

Name	Type	Description	Notes
invitation	Invitation

Return type

InvitationResponse

Authorization

API Token

HTTP request headers

• Content-Type: application/vnd.api+json
• Accept: application/vnd.api+json

Back to top | Back to API list | Back to README

DeleteInvitation

Delete an invitation

Example

package main

import (
    "context"
    "fmt"
    "os"
    "github.com/fastly/fastly-go/fastly"
)

func main() {
    invitationID := "invitationId_example" // string | Alphanumeric string identifying an invitation.

    cfg := fastly.NewConfiguration()
    apiClient := fastly.NewAPIClient(cfg)
    ctx := fastly.NewAPIKeyContextFromEnv("FASTLY_API_TOKEN")
    resp, r, err := apiClient.InvitationsAPI.DeleteInvitation(ctx, invitationID).Execute()
    if err != nil {
        fmt.Fprintf(os.Stderr, "Error when calling `InvitationsAPI.DeleteInvitation`: %v\n", err)
        fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
    }
}

Path Parameters

Name	Type	Description	Notes
ctx	context.Context	context for authentication, logging, cancellation, deadlines, tracing, etc.
invitationID	string	Alphanumeric string identifying an invitation.

Other Parameters

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

Name	Type	Description	Notes

Return type

(empty response body)

Authorization

API Token

HTTP request headers

• Content-Type: Not defined
• Accept: Not defined

Back to top | Back to API list | Back to README

ListInvitations

List invitations

Example

package main

import (
    "context"
    "fmt"
    "os"
    "github.com/fastly/fastly-go/fastly"
)

func main() {
    pageNumber := int32(1) // int32 | Current page. (optional)
    pageSize := int32(20) // int32 | Number of records per page. (optional) (default to 20)

    cfg := fastly.NewConfiguration()
    apiClient := fastly.NewAPIClient(cfg)
    ctx := fastly.NewAPIKeyContextFromEnv("FASTLY_API_TOKEN")
    resp, r, err := apiClient.InvitationsAPI.ListInvitations(ctx).PageNumber(pageNumber).PageSize(pageSize).Execute()
    if err != nil {
        fmt.Fprintf(os.Stderr, "Error when calling `InvitationsAPI.ListInvitations`: %v\n", err)
        fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
    }
    // response from `ListInvitations`: InvitationsResponse
    fmt.Fprintf(os.Stdout, "Response from `InvitationsAPI.ListInvitations`: %v\n", resp)
}

Path Parameters

Other Parameters

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

Name	Type	Description	Notes
pageNumber	int32	Current page.	pageSize

Return type

InvitationsResponse

Authorization

API Token

HTTP request headers

• Content-Type: Not defined
• Accept: application/vnd.api+json

Back to top | Back to API list | Back to README