Go SDK

go get github.com/pingram-io/pingram-go

import (
    pingram "github.com/pingram-io/pingram-go"
)

client := pingram.NewClient("pingram_sk_your_api_key")

client := pingram.NewClient("pingram_sk_...", pingram.WithRegion(pingram.RegionEU))

package main

import (
  "context"
  "encoding/json"
  "fmt"
  "log"

  pingram "github.com/pingram-io/pingram-go"
)

func main() {
  client := pingram.NewClient("pingram_sk_your_api_key") // or WithBaseURL("https://api.pingram.click") for custom host

  body := pingram.SenderPostBody{
    Type: pingram.PtrString("domain_verification"),
    User: &pingram.GetUsersResponseUsersInner{
      Id:    "user@example.com",
      Email: pingram.PtrString("user@example.com"),
    },
    Email: &pingram.SenderPostBodyEmail{
      Subject: "Domain Verification",
      Html:    "<p>Please verify your domain by clicking the link below.</p>",
    },
  }

  resp, _, err := client.DefaultAPI.Send(context.Background()).SenderPostBody(body).Execute()
  if err != nil {
    log.Fatal(err)
  }
  out, _ := json.MarshalIndent(resp, "", "  ")
  fmt.Println(string(out))
}

senderPostBody := *pingram.NewSenderPostBody() // SenderPostBody

resp, _, err := client.DefaultAPI.Send(ctx).SenderPostBody(senderPostBody).Execute()
if err != nil {
  // handle error
}
// resp is SenderPostResponse

webhookEndpointUpsertRequest := *pingram.NewWebhookEndpointUpsertRequest("Webhook_example", []string{"Events_example"}) // WebhookEndpointUpsertRequest

resp, _, err := client.WebhooksAPI.WebhooksCreateWebhook(ctx).WebhookEndpointUpsertRequest(webhookEndpointUpsertRequest).Execute()
if err != nil {
  // handle error
}
// resp is WebhookEndpoint

endpointId :=  // Webhook endpoint id

_, err := client.WebhooksAPI.WebhooksDeleteWebhook(ctx, endpointId).Execute()
if err != nil {
  // handle error
}

resp, _, err := client.WebhooksAPI.WebhooksListWebhooks(ctx).Execute()
if err != nil {
  // handle error
}
// resp is WebhookEndpointsResponse

endpointId :=  // Webhook endpoint id
webhookEndpointUpsertRequest := *pingram.NewWebhookEndpointUpsertRequest("Webhook_example", []string{"Events_example"}) // WebhookEndpointUpsertRequest

resp, _, err := client.WebhooksAPI.WebhooksUpdateWebhook(ctx, endpointId).WebhookEndpointUpsertRequest(webhookEndpointUpsertRequest).Execute()
if err != nil {
  // handle error
}
// resp is WebhookEndpoint

createAccountRequest := *pingram.NewCreateAccountRequest("Name_example") // CreateAccountRequest

resp, _, err := client.AccountsAPI.AccountsCreateAccount(ctx).CreateAccountRequest(createAccountRequest).Execute()
if err != nil {
  // handle error
}
// resp is CreateAccountResponse

resp, _, err := client.AccountsAPI.AccountsListAccounts(ctx).Execute()
if err != nil {
  // handle error
}
// resp is ListAccountsResponse

createAddressRequest := *pingram.NewCreateAddressRequest("Prefix_example") // CreateAddressRequest

resp, _, err := client.AddressesAPI.AddressesCreateAddress(ctx).CreateAddressRequest(createAddressRequest).Execute()
if err != nil {
  // handle error
}
// resp is AddressResponse

fullAddress :=  // Full address to delete (e.g. hello@example.com)

resp, _, err := client.AddressesAPI.AddressesDeleteAddress(ctx, fullAddress).Execute()
if err != nil {
  // handle error
}
// resp is SuccessResponse

resp, _, err := client.AddressesAPI.AddressesListAddresses(ctx).Execute()
if err != nil {
  // handle error
}
// resp is AccountAddressesResponse

updateAddressRequest := *pingram.NewUpdateAddressRequest("FullAddress_example") // UpdateAddressRequest

resp, _, err := client.AddressesAPI.AddressesUpdateAddress(ctx).UpdateAddressRequest(updateAddressRequest).Execute()
if err != nil {
  // handle error
}
// resp is AddressResponse

postSendersRequestBody := *pingram.NewPostSendersRequestBody("Sender_example") // PostSendersRequestBody

resp, _, err := client.DomainsAPI.DomainsAddDomain(ctx).PostSendersRequestBody(postSendersRequestBody).Execute()
if err != nil {
  // handle error
}
// resp is []GetSendersResponseInner

sender :=  // Sender domain (URL encoded)

resp, _, err := client.DomainsAPI.DomainsDeleteDomain(ctx, sender).Execute()
if err != nil {
  // handle error
}
// resp is SuccessResponse

resp, _, err := client.DomainsAPI.DomainsListDomains(ctx).Execute()
if err != nil {
  // handle error
}
// resp is []GetSendersResponseInner

sender :=  // Sender domain (URL encoded)

resp, _, err := client.DomainsAPI.DomainsStartDomainVerification(ctx, sender).Execute()
if err != nil {
  // handle error
}
// resp is []GetSendersResponseInner

reason :=  // Suppression reason to clear (retryable | bounces)

resp, _, err := client.EmailAPI.EmailDeleteSuppressions(ctx, reason).Execute()
if err != nil {
  // handle error
}
// resp is MessageResponse

sendEmailRequest := *pingram.NewSendEmailRequest("Type_example", "To_example", "Subject_example", "Html_example") // SendEmailRequest

resp, _, err := client.EmailAPI.EmailSend(ctx).SendEmailRequest(sendEmailRequest).Execute()
if err != nil {
  // handle error
}
// resp is SendEmailApiResponse

resp, _, err := client.EnvironmentsAPI.EnvironmentsListEnvironments(ctx).Execute()
if err != nil {
  // handle error
}
// resp is []GetEnvironmentsResponseInner

clientId :=  // Environment client ID
environmentPatchRequest := *pingram.NewEnvironmentPatchRequest() // EnvironmentPatchRequest

resp, _, err := client.EnvironmentsAPI.EnvironmentsUpdateEnvironment(ctx, clientId).EnvironmentPatchRequest(environmentPatchRequest).Execute()
if err != nil {
  // handle error
}
// resp is Environment

resp, _, err := client.LogsAPI.LogsGetLogRetention(ctx).Execute()
if err != nil {
  // handle error
}
// resp is LogsRetentionResponse

limit := float32(8.14) // float32 (optional)
cursor := "cursor_example" // string (optional)

resp, _, err := client.LogsAPI.LogsGetLogs(ctx).Limit(limit).Cursor(cursor).Execute()
if err != nil {
  // handle error
}
// resp is GetLogsResponse

trackingIds :=  // Comma-separated tracking IDs (URL encoded)

resp, _, err := client.LogsAPI.LogsGetLogsByTrackingIds(ctx, trackingIds).Execute()
if err != nil {
  // handle error
}
// resp is LogsGetResponse

queryId :=  // Query ID returned by Start Log Query

resp, _, err := client.LogsAPI.LogsGetLogsQueryResult(ctx, queryId).Execute()
if err != nil {
  // handle error
}
// resp is LogsQueryResultResponse

logQueryPostBody := *pingram.NewLogQueryPostBody() // LogQueryPostBody

resp, _, err := client.LogsAPI.LogsStartLogsQuery(ctx).LogQueryPostBody(logQueryPostBody).Execute()
if err != nil {
  // handle error
}
// resp is LogsQueryResponse

resp, _, err := client.LogsAPI.LogsTailLogs(ctx).Execute()
if err != nil {
  // handle error
}
// resp is LogsTailResponse

resp, _, err := client.NumbersAPI.NumbersList(ctx).Execute()
if err != nil {
  // handle error
}
// resp is ListPhoneNumbersResponse

resp, _, err := client.NumbersAPI.NumbersListReleased(ctx).Execute()
if err != nil {
  // handle error
}
// resp is ListReleasedPhoneNumbersResponse

orderPhoneNumberRequest := *pingram.NewOrderPhoneNumberRequest("PhoneNumber_example") // OrderPhoneNumberRequest

resp, _, err := client.NumbersAPI.NumbersOrderNumber(ctx).OrderPhoneNumberRequest(orderPhoneNumberRequest).Execute()
if err != nil {
  // handle error
}
// resp is OrderPhoneNumberResponse

phoneNumber :=  // E.164 phone number to release

resp, _, err := client.NumbersAPI.NumbersReleaseNumber(ctx, phoneNumber).Execute()
if err != nil {
  // handle error
}
// resp is ReleasePhoneNumberResponse

countryCode := "countryCode_example" // string
features := "features_example" // string (optional)
areaCode := "areaCode_example" // string (optional)
limit := float32(8.14) // float32 (optional)

resp, _, err := client.NumbersAPI.NumbersSearchAvailable(ctx).CountryCode(countryCode).Features(features).AreaCode(areaCode).Limit(limit).Execute()
if err != nil {
  // handle error
}
// resp is SearchAvailablePhoneNumbersResponse

acceptInviteRequest := *pingram.NewAcceptInviteRequest("Token_example") // AcceptInviteRequest

resp, _, err := client.ProfileAPI.ProfileAcceptInvite(ctx).AcceptInviteRequest(acceptInviteRequest).Execute()
if err != nil {
  // handle error
}
// resp is AcceptInviteResponse

changeEmailRequest := *pingram.NewChangeEmailRequest("NewEmail_example") // ChangeEmailRequest

resp, _, err := client.ProfileAPI.ProfileChangeEmail(ctx).ChangeEmailRequest(changeEmailRequest).Execute()
if err != nil {
  // handle error
}
// resp is SuccessResponse

deleteAccountRequest := *pingram.NewDeleteAccountRequest() // DeleteAccountRequest

resp, _, err := client.ProfileAPI.ProfileDeleteAccount(ctx).DeleteAccountRequest(deleteAccountRequest).Execute()
if err != nil {
  // handle error
}
// resp is SuccessResponse

type_ :=  // MFA type (e.g. SOFTWARE_TOKEN_MFA)

resp, _, err := client.ProfileAPI.ProfileDisableMfa(ctx, type_).Execute()
if err != nil {
  // handle error
}
// resp is SuccessResponse

resp, _, err := client.ProfileAPI.ProfileGetMfaStatus(ctx).Execute()
if err != nil {
  // handle error
}
// resp is MFAStatusResponse

mFASetupRequest := *pingram.NewMFASetupRequest("Type_example") // MFASetupRequest

resp, _, err := client.ProfileAPI.ProfileSetupMfa(ctx).MFASetupRequest(mFASetupRequest).Execute()
if err != nil {
  // handle error
}
// resp is MFASetupResponse

mFAVerifyRequest := *pingram.NewMFAVerifyRequest("Type_example", "Code_example", "Session_example") // MFAVerifyRequest

resp, _, err := client.ProfileAPI.ProfileVerifyMfa(ctx).MFAVerifyRequest(mFAVerifyRequest).Execute()
if err != nil {
  // handle error
}
// resp is SuccessResponse

tenDlcBrandCreateRequest := *pingram.NewTenDlcBrandCreateRequest("ScenarioId_example", "BusinessType_example", "DisplayName_example", "Website_example", "Country_example", "Street_example", "City_example", "State_example", "PostalCode_example", "ComplianceContactEmail_example", "ComplianceContactPhone_example") // TenDlcBrandCreateRequest

resp, _, err := client.RegistrationsAPI.RegistrationsCreateUs10dlcBrand(ctx).TenDlcBrandCreateRequest(tenDlcBrandCreateRequest).Execute()
if err != nil {
  // handle error
}
// resp is TenDlcBrandRegistration

resp, _, err := client.RegistrationsAPI.RegistrationsGetUs10dlcBrand(ctx).Execute()
if err != nil {
  // handle error
}
// resp is TenDlcBrandRegistration

resp, _, err := client.RegistrationsAPI.RegistrationsGetUs10dlcCampaign(ctx).Execute()
if err != nil {
  // handle error
}
// resp is TenDlcCampaignRegistration

tenDlcBrandUpdateRequest := *pingram.NewTenDlcBrandUpdateRequest() // TenDlcBrandUpdateRequest

resp, _, err := client.RegistrationsAPI.RegistrationsUpdateUs10dlcBrand(ctx).TenDlcBrandUpdateRequest(tenDlcBrandUpdateRequest).Execute()
if err != nil {
  // handle error
}
// resp is TenDlcBrandRegistration

tenDlcCampaignUpdateRequest := *pingram.NewTenDlcCampaignUpdateRequest() // TenDlcCampaignUpdateRequest

resp, _, err := client.RegistrationsAPI.RegistrationsUpdateUs10dlcCampaign(ctx).TenDlcCampaignUpdateRequest(tenDlcCampaignUpdateRequest).Execute()
if err != nil {
  // handle error
}
// resp is TenDlcCampaignRegistration

trackingId :=  // The tracking ID of the scheduled notification

resp, _, err := client.SenderAPI.SenderDeleteSchedule(ctx, trackingId).Execute()
if err != nil {
  // handle error
}
// resp is MessageResponse

trackingId :=  // The tracking ID of the scheduled notification
senderPostBody := *pingram.NewSenderPostBody() // SenderPostBody

resp, _, err := client.SenderAPI.SenderUpdateSchedule(ctx, trackingId).SenderPostBody(senderPostBody).Execute()
if err != nil {
  // handle error
}
// resp is MessageResponse

sendSmsRequest := *pingram.NewSendSmsRequest("Type_example", "To_example") // SendSmsRequest

resp, _, err := client.SmsAPI.SmsSend(ctx).SendSmsRequest(sendSmsRequest).Execute()
if err != nil {
  // handle error
}
// resp is SendSmsResponse

notificationId :=  // Notification ID
channel :=  // Channel type
templatePostRequest := *pingram.NewTemplatePostRequest("TemplateId_example") // TemplatePostRequest

resp, _, err := client.TemplatesAPI.TemplatesCreateTemplate(ctx, notificationId, channel).TemplatePostRequest(templatePostRequest).Execute()
if err != nil {
  // handle error
}
// resp is Template

notificationId :=  // Notification ID
channel :=  // Channel type
templateId :=  // Template ID

_, err := client.TemplatesAPI.TemplatesDeleteTemplate(ctx, notificationId, channel, templateId).Execute()
if err != nil {
  // handle error
}

notificationId :=  // Notification ID
channel :=  // Channel type
templateId :=  // Template ID

resp, _, err := client.TemplatesAPI.TemplatesGetTemplate(ctx, notificationId, channel, templateId).Execute()
if err != nil {
  // handle error
}
// resp is GetTemplatesResponse

notificationId :=  // Notification ID
channel :=  // Channel type

resp, _, err := client.TemplatesAPI.TemplatesListTemplates(ctx, notificationId, channel).Execute()
if err != nil {
  // handle error
}
// resp is []GetTemplatesListResponseInner

notificationId :=  // Notification ID
channel :=  // Channel type
setDefaultTemplateRequest := *pingram.NewSetDefaultTemplateRequest("TemplateId_example", []string{"Modes_example"}) // SetDefaultTemplateRequest

resp, _, err := client.TemplatesAPI.TemplatesSetDefaultTemplate(ctx, notificationId, channel).SetDefaultTemplateRequest(setDefaultTemplateRequest).Execute()
if err != nil {
  // handle error
}
// resp is Template

notificationId :=  // Notification ID
channel :=  // Channel type
templateId :=  // Template ID
templatePatchRequest := *pingram.NewTemplatePatchRequest() // TemplatePatchRequest

resp, _, err := client.TemplatesAPI.TemplatesUpdateTemplate(ctx, notificationId, channel, templateId).TemplatePatchRequest(templatePatchRequest).Execute()
if err != nil {
  // handle error
}
// resp is Template

notificationCreateRequest := *pingram.NewNotificationCreateRequest("NotificationId_example", "Title_example", []string{"Channels_example"}) // NotificationCreateRequest

resp, _, err := client.TypesAPI.TypesCreateNotificationType(ctx).NotificationCreateRequest(notificationCreateRequest).Execute()
if err != nil {
  // handle error
}
// resp is Notification