Skip to content

Latest commit

 

History

History
220 lines (143 loc) · 7.16 KB

ContactAPI.md

File metadata and controls

220 lines (143 loc) · 7.16 KB

ContactAPI

Note

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

Method HTTP request Description
CreateContacts POST /customer/{customer_id}/contacts Add a new customer contact
DeleteContact DELETE /customer/{customer_id}/contacts/{contact_id} Delete a contact
ListContacts GET /customer/{customer_id}/contacts List contacts

CreateContacts

Add a new customer contact

Example

package main

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

func main() {
    customerID := "customerId_example" // string | Alphanumeric string identifying the customer.
    userID := "userId_example" // string | The alphanumeric string representing the user for this customer contact. (optional)
    contactType := "contactType_example" // string | The type of contact. (optional)
    name := "name_example" // string | The name of this contact, when user_id is not provided. (optional)
    email := "email_example" // string | The email of this contact, when a user_id is not provided. (optional)
    phone := "phone_example" // string | The phone number for this contact. Required for primary, technical, and security contact types. (optional)
    customerID2 := "customerId_example" // string | The alphanumeric string representing the customer for this customer contact. (optional)

    cfg := fastly.NewConfiguration()
    apiClient := fastly.NewAPIClient(cfg)
    ctx := fastly.NewAPIKeyContextFromEnv("FASTLY_API_TOKEN")
    resp, r, err := apiClient.ContactAPI.CreateContacts(ctx, customerID).UserID(userID).ContactType(contactType).Name(name).Email(email).Phone(phone).CustomerID2(customerID2).Execute()
    if err != nil {
        fmt.Fprintf(os.Stderr, "Error when calling `ContactAPI.CreateContacts`: %v\n", err)
        fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
    }
    // response from `CreateContacts`: ContactResponse
    fmt.Fprintf(os.Stdout, "Response from `ContactAPI.CreateContacts`: %v\n", resp)
}

Path Parameters

Name Type Description Notes
ctx context.Context context for authentication, logging, cancellation, deadlines, tracing, etc.
customerID string Alphanumeric string identifying the customer.

Other Parameters

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

Name Type Description Notes
userID string The alphanumeric string representing the user for this customer contact. contactType

Return type

ContactResponse

Authorization

API Token

HTTP request headers

  • Content-Type: application/x-www-form-urlencoded
  • Accept: application/json

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

DeleteContact

Delete a contact

Example

package main

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

func main() {
    customerID := "customerId_example" // string | Alphanumeric string identifying the customer.
    contactID := "contactId_example" // string | An alphanumeric string identifying the customer contact.

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

Path Parameters

Name Type Description Notes
ctx context.Context context for authentication, logging, cancellation, deadlines, tracing, etc.
customerID string Alphanumeric string identifying the customer.
contactID string An alphanumeric string identifying the customer contact.

Other Parameters

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

Name Type Description Notes

Return type

InlineResponse200

Authorization

API Token

HTTP request headers

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

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

ListContacts

List contacts

Example

package main

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

func main() {
    customerID := "customerId_example" // string | Alphanumeric string identifying the customer.

    cfg := fastly.NewConfiguration()
    apiClient := fastly.NewAPIClient(cfg)
    ctx := fastly.NewAPIKeyContextFromEnv("FASTLY_API_TOKEN")
    resp, r, err := apiClient.ContactAPI.ListContacts(ctx, customerID).Execute()
    if err != nil {
        fmt.Fprintf(os.Stderr, "Error when calling `ContactAPI.ListContacts`: %v\n", err)
        fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
    }
    // response from `ListContacts`: []SchemasContactResponse
    fmt.Fprintf(os.Stdout, "Response from `ContactAPI.ListContacts`: %v\n", resp)
}

Path Parameters

Name Type Description Notes
ctx context.Context context for authentication, logging, cancellation, deadlines, tracing, etc.
customerID string Alphanumeric string identifying the customer.

Other Parameters

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

Name Type Description Notes

Return type

[]SchemasContactResponse

Authorization

API Token

HTTP request headers

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

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