Java SDK

<dependency>
    <groupId>io.pingram</groupId>
    <artifactId>pingram</artifactId>
    <version>1.0.0</version>
</dependency>

implementation 'io.pingram:pingram:1.0.0'

import io.pingram.Pingram;

Pingram client = new Pingram("YOUR_API_KEY");

// EU or CA region
Pingram client = new Pingram("YOUR_API_KEY", Pingram.Region.EU);

SenderPostBody senderPostBody = new SenderPostBody(); // SenderPostBody |
try {
    SenderPostResponse result = client.send(senderPostBody);
    System.out.println(result);
} catch (ApiException e) {
    System.err.println("Exception when calling DefaultApi#send: " + e.getMessage());
}

WebhookEndpointUpsertRequest webhookEndpointUpsertRequest = new WebhookEndpointUpsertRequest(); // WebhookEndpointUpsertRequest |
try {
    WebhookEndpoint result = client.getWebhooks().webhooksCreateWebhook(webhookEndpointUpsertRequest);
    System.out.println(result);
} catch (ApiException e) {
    System.err.println("Exception when calling WebhooksApi#webhooksCreateWebhook: " + e.getMessage());
}

String endpointId = "endpointId_example"; // String | Id of the webhook endpoint, from list or create.
try {
    client.getWebhooks().webhooksDeleteWebhook(endpointId);
} catch (ApiException e) {
    System.err.println("Exception when calling WebhooksApi#webhooksDeleteWebhook: " + e.getMessage());
}

try {
    WebhookEndpointsResponse result = client.getWebhooks().webhooksListWebhooks();
    System.out.println(result);
} catch (ApiException e) {
    System.err.println("Exception when calling WebhooksApi#webhooksListWebhooks: " + e.getMessage());
}

String endpointId = "endpointId_example"; // String | Id of the webhook endpoint, from list or create.
WebhookEndpointUpsertRequest webhookEndpointUpsertRequest = new WebhookEndpointUpsertRequest(); // WebhookEndpointUpsertRequest |
try {
    WebhookEndpoint result = client.getWebhooks().webhooksUpdateWebhook(endpointId, webhookEndpointUpsertRequest);
    System.out.println(result);
} catch (ApiException e) {
    System.err.println("Exception when calling WebhooksApi#webhooksUpdateWebhook: " + e.getMessage());
}

CreateAccountRequest createAccountRequest = new CreateAccountRequest(); // CreateAccountRequest |
try {
    CreateAccountResponse result = client.getAccounts().accountsCreateAccount(createAccountRequest);
    System.out.println(result);
} catch (ApiException e) {
    System.err.println("Exception when calling AccountsApi#accountsCreateAccount: " + e.getMessage());
}

try {
    ListAccountsResponse result = client.getAccounts().accountsListAccounts();
    System.out.println(result);
} catch (ApiException e) {
    System.err.println("Exception when calling AccountsApi#accountsListAccounts: " + e.getMessage());
}

CreateAddressRequest createAddressRequest = new CreateAddressRequest(); // CreateAddressRequest |
try {
    AddressResponse result = client.getAddresses().addressesCreateAddress(createAddressRequest);
    System.out.println(result);
} catch (ApiException e) {
    System.err.println("Exception when calling AddressesApi#addressesCreateAddress: " + e.getMessage());
}

String fullAddress = "fullAddress_example"; // String | Full address to delete (e.g. hello@example.com)
try {
    SuccessResponse result = client.getAddresses().addressesDeleteAddress(fullAddress);
    System.out.println(result);
} catch (ApiException e) {
    System.err.println("Exception when calling AddressesApi#addressesDeleteAddress: " + e.getMessage());
}

try {
    AccountAddressesResponse result = client.getAddresses().addressesListAddresses();
    System.out.println(result);
} catch (ApiException e) {
    System.err.println("Exception when calling AddressesApi#addressesListAddresses: " + e.getMessage());
}

UpdateAddressRequest updateAddressRequest = new UpdateAddressRequest(); // UpdateAddressRequest |
try {
    AddressResponse result = client.getAddresses().addressesUpdateAddress(updateAddressRequest);
    System.out.println(result);
} catch (ApiException e) {
    System.err.println("Exception when calling AddressesApi#addressesUpdateAddress: " + e.getMessage());
}

String broadcastId = "broadcastId_example"; // String | Broadcast ID
try {
    BroadcastResponse result = client.getBroadcasts().broadcastsArchive(broadcastId);
    System.out.println(result);
} catch (ApiException e) {
    System.err.println("Exception when calling BroadcastsApi#broadcastsArchive: " + e.getMessage());
}

String broadcastId = "broadcastId_example"; // String | Broadcast ID
try {
    BroadcastResponse result = client.getBroadcasts().broadcastsCancel(broadcastId);
    System.out.println(result);
} catch (ApiException e) {
    System.err.println("Exception when calling BroadcastsApi#broadcastsCancel: " + e.getMessage());
}

CreateBroadcastRequest createBroadcastRequest = new CreateBroadcastRequest(); // CreateBroadcastRequest |
try {
    BroadcastResponse result = client.getBroadcasts().broadcastsCreate(createBroadcastRequest);
    System.out.println(result);
} catch (ApiException e) {
    System.err.println("Exception when calling BroadcastsApi#broadcastsCreate: " + e.getMessage());
}

String broadcastId = "broadcastId_example"; // String | Broadcast ID
try {
    MessageResponse result = client.getBroadcasts().broadcastsDelete(broadcastId);
    System.out.println(result);
} catch (ApiException e) {
    System.err.println("Exception when calling BroadcastsApi#broadcastsDelete: " + e.getMessage());
}

String broadcastId = "broadcastId_example"; // String | Broadcast ID
try {
    BroadcastResponse result = client.getBroadcasts().broadcastsGet(broadcastId);
    System.out.println(result);
} catch (ApiException e) {
    System.err.println("Exception when calling BroadcastsApi#broadcastsGet: " + e.getMessage());
}

String broadcastId = "broadcastId_example"; // String | Broadcast ID
try {
    BroadcastMetricsResponse result = client.getBroadcasts().broadcastsGetMetrics(broadcastId);
    System.out.println(result);
} catch (ApiException e) {
    System.err.println("Exception when calling BroadcastsApi#broadcastsGetMetrics: " + e.getMessage());
}

BigDecimal limit = new BigDecimal(78); // BigDecimal | Max broadcasts to return (default 50)
String nextToken = "nextToken_example"; // String | Pagination token
try {
    ListBroadcastsResponse result = client.getBroadcasts().broadcastsList(limit, nextToken);
    System.out.println(result);
} catch (ApiException e) {
    System.err.println("Exception when calling BroadcastsApi#broadcastsList: " + e.getMessage());
}

String broadcastId = "broadcastId_example"; // String | Broadcast ID
String status = "status_example"; // String | Filter
BigDecimal limit = new BigDecimal(78); // BigDecimal | Max recipients to return (default 50)
String nextToken = "nextToken_example"; // String | Pagination token
try {
    ListBroadcastRecipientsResponse result = client.getBroadcasts().broadcastsListRecipients(broadcastId, status, limit, nextToken);
    System.out.println(result);
} catch (ApiException e) {
    System.err.println("Exception when calling BroadcastsApi#broadcastsListRecipients: " + e.getMessage());
}

String broadcastId = "broadcastId_example"; // String | Broadcast ID
try {
    BroadcastResponse result = client.getBroadcasts().broadcastsPause(broadcastId);
    System.out.println(result);
} catch (ApiException e) {
    System.err.println("Exception when calling BroadcastsApi#broadcastsPause: " + e.getMessage());
}

String broadcastId = "broadcastId_example"; // String | Broadcast ID
try {
    BroadcastResponse result = client.getBroadcasts().broadcastsResume(broadcastId);
    System.out.println(result);
} catch (ApiException e) {
    System.err.println("Exception when calling BroadcastsApi#broadcastsResume: " + e.getMessage());
}

String broadcastId = "broadcastId_example"; // String | Broadcast ID
ScheduleBroadcastRequest scheduleBroadcastRequest = new ScheduleBroadcastRequest(); // ScheduleBroadcastRequest |
try {
    BroadcastResponse result = client.getBroadcasts().broadcastsSchedule(broadcastId, scheduleBroadcastRequest);
    System.out.println(result);
} catch (ApiException e) {
    System.err.println("Exception when calling BroadcastsApi#broadcastsSchedule: " + e.getMessage());
}

String broadcastId = "broadcastId_example"; // String | Broadcast ID
try {
    BroadcastResponse result = client.getBroadcasts().broadcastsSend(broadcastId);
    System.out.println(result);
} catch (ApiException e) {
    System.err.println("Exception when calling BroadcastsApi#broadcastsSend: " + e.getMessage());
}

String broadcastId = "broadcastId_example"; // String | Broadcast ID
try {
    BroadcastResponse result = client.getBroadcasts().broadcastsUnarchive(broadcastId);
    System.out.println(result);
} catch (ApiException e) {
    System.err.println("Exception when calling BroadcastsApi#broadcastsUnarchive: " + e.getMessage());
}

String broadcastId = "broadcastId_example"; // String | Broadcast ID
UpdateBroadcastRequest updateBroadcastRequest = new UpdateBroadcastRequest(); // UpdateBroadcastRequest |
try {
    BroadcastResponse result = client.getBroadcasts().broadcastsUpdate(broadcastId, updateBroadcastRequest);
    System.out.println(result);
} catch (ApiException e) {
    System.err.println("Exception when calling BroadcastsApi#broadcastsUpdate: " + e.getMessage());
}

PostSendersRequestBody postSendersRequestBody = new PostSendersRequestBody(); // PostSendersRequestBody |
try {
    List<GetSendersResponseInner> result = client.getDomains().domainsAddDomain(postSendersRequestBody);
    System.out.println(result);
} catch (ApiException e) {
    System.err.println("Exception when calling DomainsApi#domainsAddDomain: " + e.getMessage());
}

String sender = "sender_example"; // String | Sender domain (URL encoded)
try {
    SuccessResponse result = client.getDomains().domainsDeleteDomain(sender);
    System.out.println(result);
} catch (ApiException e) {
    System.err.println("Exception when calling DomainsApi#domainsDeleteDomain: " + e.getMessage());
}

try {
    List<GetSendersResponseInner> result = client.getDomains().domainsListDomains();
    System.out.println(result);
} catch (ApiException e) {
    System.err.println("Exception when calling DomainsApi#domainsListDomains: " + e.getMessage());
}

String sender = "sender_example"; // String | Sender domain (URL encoded)
try {
    List<GetSendersResponseInner> result = client.getDomains().domainsStartDomainVerification(sender);
    System.out.println(result);
} catch (ApiException e) {
    System.err.println("Exception when calling DomainsApi#domainsStartDomainVerification: " + e.getMessage());
}

String reason = "reason_example"; // String | Suppression reason to clear (retryable | bounces)
try {
    MessageResponse result = client.getEmail().emailDeleteSuppressions(reason);
    System.out.println(result);
} catch (ApiException e) {
    System.err.println("Exception when calling EmailApi#emailDeleteSuppressions: " + e.getMessage());
}

SendEmailRequest sendEmailRequest = new SendEmailRequest(); // SendEmailRequest |
try {
    SendEmailApiResponse result = client.getEmail().emailSend(sendEmailRequest);
    System.out.println(result);
} catch (ApiException e) {
    System.err.println("Exception when calling EmailApi#emailSend: " + e.getMessage());
}

try {
    List<GetEnvironmentsResponseInner> result = client.getEnvironments().environmentsListEnvironments();
    System.out.println(result);
} catch (ApiException e) {
    System.err.println("Exception when calling EnvironmentsApi#environmentsListEnvironments: " + e.getMessage());
}

String clientId = "clientId_example"; // String | Environment client ID
EnvironmentPatchRequest environmentPatchRequest = new EnvironmentPatchRequest(); // EnvironmentPatchRequest |
try {
    Environment result = client.getEnvironments().environmentsUpdateEnvironment(clientId, environmentPatchRequest);
    System.out.println(result);
} catch (ApiException e) {
    System.err.println("Exception when calling EnvironmentsApi#environmentsUpdateEnvironment: " + e.getMessage());
}

String useCase = "useCase_example"; // String | Library use-case
CreateLibraryRequest createLibraryRequest = new CreateLibraryRequest(); // CreateLibraryRequest |
try {
    CreateLibraryResponse result = client.getLibrary().libraryCreate(useCase, createLibraryRequest);
    System.out.println(result);
} catch (ApiException e) {
    System.err.println("Exception when calling LibraryApi#libraryCreate: " + e.getMessage());
}

String useCase = "useCase_example"; // String | Library use-case
BigDecimal limit = new BigDecimal(78); // BigDecimal | Max items to return (default 50)
String nextToken = "nextToken_example"; // String | Pagination token
try {
    ListLibraryResponse result = client.getLibrary().libraryList(useCase, limit, nextToken);
    System.out.println(result);
} catch (ApiException e) {
    System.err.println("Exception when calling LibraryApi#libraryList: " + e.getMessage());
}

String trackingIds = "trackingIds_example"; // String | Comma-separated tracking IDs (URL encoded, max 25)
try {
    LogsDeliveryStatusResponse result = client.getLogs().logsGetDeliveryStatus(trackingIds);
    System.out.println(result);
} catch (ApiException e) {
    System.err.println("Exception when calling LogsApi#logsGetDeliveryStatus: " + e.getMessage());
}

try {
    LogsRetentionResponse result = client.getLogs().logsGetLogRetention();
    System.out.println(result);
} catch (ApiException e) {
    System.err.println("Exception when calling LogsApi#logsGetLogRetention: " + e.getMessage());
}

BigDecimal limit = new BigDecimal(78); // BigDecimal | Maximum number of logs to return (default
String cursor = "cursor_example"; // String | Pagination cursor for next page
try {
    GetLogsResponse result = client.getLogs().logsGetLogs(limit, cursor);
    System.out.println(result);
} catch (ApiException e) {
    System.err.println("Exception when calling LogsApi#logsGetLogs: " + e.getMessage());
}

String trackingIds = "trackingIds_example"; // String | Comma-separated tracking IDs (URL encoded)
try {
    LogsGetResponse result = client.getLogs().logsGetLogsByTrackingIds(trackingIds);
    System.out.println(result);
} catch (ApiException e) {
    System.err.println("Exception when calling LogsApi#logsGetLogsByTrackingIds: " + e.getMessage());
}

String queryId = "queryId_example"; // String | Query ID returned by Start Log Query
try {
    LogsQueryResultResponse result = client.getLogs().logsGetLogsQueryResult(queryId);
    System.out.println(result);
} catch (ApiException e) {
    System.err.println("Exception when calling LogsApi#logsGetLogsQueryResult: " + e.getMessage());
}

String trackingId = "trackingId_example"; // String | Tracking ID of the inbound email
try {
    MessageResponse result = client.getLogs().logsRetryInbound(trackingId);
    System.out.println(result);
} catch (ApiException e) {
    System.err.println("Exception when calling LogsApi#logsRetryInbound: " + e.getMessage());
}

LogQueryPostBody logQueryPostBody = new LogQueryPostBody(); // LogQueryPostBody |
try {
    LogsQueryResponse result = client.getLogs().logsStartLogsQuery(logQueryPostBody);
    System.out.println(result);
} catch (ApiException e) {
    System.err.println("Exception when calling LogsApi#logsStartLogsQuery: " + e.getMessage());
}

try {
    LogsTailResponse result = client.getLogs().logsTailLogs();
    System.out.println(result);
} catch (ApiException e) {
    System.err.println("Exception when calling LogsApi#logsTailLogs: " + e.getMessage());
}

try {
    ListPhoneNumbersResponse result = client.getNumbers().numbersList();
    System.out.println(result);
} catch (ApiException e) {
    System.err.println("Exception when calling NumbersApi#numbersList: " + e.getMessage());
}

try {
    ListReleasedPhoneNumbersResponse result = client.getNumbers().numbersListReleased();
    System.out.println(result);
} catch (ApiException e) {
    System.err.println("Exception when calling NumbersApi#numbersListReleased: " + e.getMessage());
}

OrderPhoneNumberRequest orderPhoneNumberRequest = new OrderPhoneNumberRequest(); // OrderPhoneNumberRequest |
try {
    OrderPhoneNumberResponse result = client.getNumbers().numbersOrderNumber(orderPhoneNumberRequest);
    System.out.println(result);
} catch (ApiException e) {
    System.err.println("Exception when calling NumbersApi#numbersOrderNumber: " + e.getMessage());
}

String phoneNumber = "phoneNumber_example"; // String | E.164 phone number to release
try {
    ReleasePhoneNumberResponse result = client.getNumbers().numbersReleaseNumber(phoneNumber);
    System.out.println(result);
} catch (ApiException e) {
    System.err.println("Exception when calling NumbersApi#numbersReleaseNumber: " + e.getMessage());
}

String countryCode = "countryCode_example"; // String | ISO 3166-1 alpha-2 country code (e.g., US, CA)
String features = "features_example"; // String | Comma-separated
String areaCode = "areaCode_example"; // String | National destination / area code filter
BigDecimal limit = new BigDecimal(78); // BigDecimal | Max results (default 10, max 50)
try {
    SearchAvailablePhoneNumbersResponse result = client.getNumbers().numbersSearchAvailable(countryCode, features, areaCode, limit);
    System.out.println(result);
} catch (ApiException e) {
    System.err.println("Exception when calling NumbersApi#numbersSearchAvailable: " + e.getMessage());
}

AcceptInviteRequest acceptInviteRequest = new AcceptInviteRequest(); // AcceptInviteRequest |
try {
    AcceptInviteResponse result = client.getProfile().profileAcceptInvite(acceptInviteRequest);
    System.out.println(result);
} catch (ApiException e) {
    System.err.println("Exception when calling ProfileApi#profileAcceptInvite: " + e.getMessage());
}

DeleteAccountRequest deleteAccountRequest = new DeleteAccountRequest(); // DeleteAccountRequest |
try {
    SuccessResponse result = client.getProfile().profileDeleteAccount(deleteAccountRequest);
    System.out.println(result);
} catch (ApiException e) {
    System.err.println("Exception when calling ProfileApi#profileDeleteAccount: " + e.getMessage());
}

String type = "type_example"; // String | MFA type (e.g. SOFTWARE_TOKEN_MFA)
try {
    SuccessResponse result = client.getProfile().profileDisableMfa(type);
    System.out.println(result);
} catch (ApiException e) {
    System.err.println("Exception when calling ProfileApi#profileDisableMfa: " + e.getMessage());
}

try {
    MFAStatusResponse result = client.getProfile().profileGetMfaStatus();
    System.out.println(result);
} catch (ApiException e) {
    System.err.println("Exception when calling ProfileApi#profileGetMfaStatus: " + e.getMessage());
}

MFASetupRequest mfASetupRequest = new MFASetupRequest(); // MFASetupRequest |
try {
    MFASetupResponse result = client.getProfile().profileSetupMfa(mfASetupRequest);
    System.out.println(result);
} catch (ApiException e) {
    System.err.println("Exception when calling ProfileApi#profileSetupMfa: " + e.getMessage());
}

MFAVerifyRequest mfAVerifyRequest = new MFAVerifyRequest(); // MFAVerifyRequest |
try {
    SuccessResponse result = client.getProfile().profileVerifyMfa(mfAVerifyRequest);
    System.out.println(result);
} catch (ApiException e) {
    System.err.println("Exception when calling ProfileApi#profileVerifyMfa: " + e.getMessage());
}

TenDlcBrandCreateRequest tenDlcBrandCreateRequest = new TenDlcBrandCreateRequest(); // TenDlcBrandCreateRequest |
try {
    TenDlcBrandRegistration result = client.getRegistrations().registrationsCreateUs10dlcBrand(tenDlcBrandCreateRequest);
    System.out.println(result);
} catch (ApiException e) {
    System.err.println("Exception when calling RegistrationsApi#registrationsCreateUs10dlcBrand: " + e.getMessage());
}

try {
    TenDlcBrandRegistration result = client.getRegistrations().registrationsGetUs10dlcBrand();
    System.out.println(result);
} catch (ApiException e) {
    System.err.println("Exception when calling RegistrationsApi#registrationsGetUs10dlcBrand: " + e.getMessage());
}

try {
    TenDlcCampaignRegistration result = client.getRegistrations().registrationsGetUs10dlcCampaign();
    System.out.println(result);
} catch (ApiException e) {
    System.err.println("Exception when calling RegistrationsApi#registrationsGetUs10dlcCampaign: " + e.getMessage());
}

TenDlcBrandUpdateRequest tenDlcBrandUpdateRequest = new TenDlcBrandUpdateRequest(); // TenDlcBrandUpdateRequest |
try {
    TenDlcBrandRegistration result = client.getRegistrations().registrationsUpdateUs10dlcBrand(tenDlcBrandUpdateRequest);
    System.out.println(result);
} catch (ApiException e) {
    System.err.println("Exception when calling RegistrationsApi#registrationsUpdateUs10dlcBrand: " + e.getMessage());
}

TenDlcCampaignUpdateRequest tenDlcCampaignUpdateRequest = new TenDlcCampaignUpdateRequest(); // TenDlcCampaignUpdateRequest |
try {
    TenDlcCampaignRegistration result = client.getRegistrations().registrationsUpdateUs10dlcCampaign(tenDlcCampaignUpdateRequest);
    System.out.println(result);
} catch (ApiException e) {
    System.err.println("Exception when calling RegistrationsApi#registrationsUpdateUs10dlcCampaign: " + e.getMessage());
}