openapi

Developer-friendly & type-safe Java SDK specifically catered to leverage openapi API.

Important

This SDK is not yet ready for production use. To complete setup please follow the steps outlined in your workspace. Delete this section before > publishing to a package manager.

Summary

Twilio - Voice: This is the public Twilio REST API.

Table of Contents

• openapi
  • SDK Installation
  • SDK Example Usage
  • Authentication
  • Available Resources and Operations
  • Error Handling
  • Server Selection
• Development
  • Maturity
  • Contributions

SDK Installation

Getting started

JDK 11 or later is required.

The samples below show how a published SDK artifact is used:

Gradle:

implementation 'org.openapis:openapi:0.1.0'

Maven:

<dependency>
    <groupId>org.openapis</groupId>
    <artifactId>openapi</artifactId>
    <version>0.1.0</version>
</dependency>

How to build

After cloning the git repository to your file system you can build the SDK artifact from source to the build directory by running ./gradlew build on *nix systems or gradlew.bat on Windows systems.

If you wish to build from source and publish the SDK artifact to your local Maven repository (on your filesystem) then use the following command (after cloning the git repo locally):

On *nix:

./gradlew publishToMavenLocal -Pskip.signing

On Windows:

gradlew.bat publishToMavenLocal -Pskip.signing

SDK Example Usage

Example

package hello.world;

import java.lang.Exception;
import java.time.LocalDate;
import org.openapis.openapi.SDK;
import org.openapis.openapi.models.components.Security;
import org.openapis.openapi.models.operations.DeleteArchivedCallResponse;

public class Application {

    public static void main(String[] args) throws Exception {

        SDK sdk = SDK.builder()
                .security(Security.builder()
                    .username("")
                    .password("")
                    .build())
            .build();

        DeleteArchivedCallResponse res = sdk.voiceV1ArchivedCall().deleteArchivedCall()
                .date(LocalDate.parse("2024-07-27"))
                .sid("<id>")
                .call();

        // handle response
    }
}

Authentication

Per-Client Security Schemes

This SDK supports the following security scheme globally:

Name	Type	Scheme
username password	http	HTTP Basic

You can set the security parameters through the security builder method when initializing the SDK client instance. For example:

package hello.world;

import java.lang.Exception;
import java.time.LocalDate;
import org.openapis.openapi.SDK;
import org.openapis.openapi.models.components.Security;
import org.openapis.openapi.models.operations.DeleteArchivedCallResponse;

public class Application {

    public static void main(String[] args) throws Exception {

        SDK sdk = SDK.builder()
                .security(Security.builder()
                    .username("")
                    .password("")
                    .build())
            .build();

        DeleteArchivedCallResponse res = sdk.voiceV1ArchivedCall().deleteArchivedCall()
                .date(LocalDate.parse("2024-07-27"))
                .sid("<id>")
                .call();

        // handle response
    }
}

Available Resources and Operations

Available methods

voiceV1ArchivedCall()

• deleteArchivedCall - Delete an archived call record from Bulk Export. Note: this does not also delete the record from the Voice API.

voiceV1BulkCountryUpdate()

• createDialingPermissionsCountryBulkUpdate - Create a bulk update request to change voice dialing country permissions of one or more countries identified by the corresponding ISO country code

voiceV1ByocTrunk()

• createByocTrunk
• listByocTrunk
• fetchByocTrunk
• updateByocTrunk
• deleteByocTrunk

voiceV1ConnectionPolicy()

• createConnectionPolicy
• listConnectionPolicy
• fetchConnectionPolicy
• updateConnectionPolicy
• deleteConnectionPolicy

voiceV1ConnectionPolicyTarget()

• createConnectionPolicyTarget
• listConnectionPolicyTarget
• fetchConnectionPolicyTarget
• updateConnectionPolicyTarget
• deleteConnectionPolicyTarget

voiceV1Country()

• fetchDialingPermissionsCountry - Retrieve voice dialing country permissions identified by the given ISO country code
• listDialingPermissionsCountry - Retrieve all voice dialing country permissions for this account

voiceV1HighriskSpecialPrefix()

• listDialingPermissionsHrsPrefixes - Fetch the high-risk special services prefixes from the country resource corresponding to the ISO country code

voiceV1IpRecord()

• createIpRecord
• listIpRecord
• fetchIpRecord
• updateIpRecord
• deleteIpRecord

voiceV1Settings()

• fetchDialingPermissionsSettings - Retrieve voice dialing permissions inheritance for the sub-account
• updateDialingPermissionsSettings - Update voice dialing permissions inheritance for the sub-account

voiceV1SourceIpMapping()

• createSourceIpMapping
• listSourceIpMapping
• fetchSourceIpMapping
• updateSourceIpMapping
• deleteSourceIpMapping

Error Handling

Handling errors in this SDK should largely match your expectations. All operations return a response object or raise an exception.

By default, an API error will throw a models/errors/APIException exception. When custom error responses are specified for an operation, the SDK may also throw their associated exception. You can refer to respective Errors tables in SDK docs for more details on possible exception types for each operation. For example, the deleteArchivedCall method throws the following exceptions:

Error Type	Status Code	Content Type
models/errors/APIException	4XX, 5XX	*/*

Example

package hello.world;

import java.lang.Exception;
import java.time.LocalDate;
import org.openapis.openapi.SDK;
import org.openapis.openapi.models.components.Security;
import org.openapis.openapi.models.operations.DeleteArchivedCallResponse;

public class Application {

    public static void main(String[] args) throws Exception {

        SDK sdk = SDK.builder()
                .security(Security.builder()
                    .username("")
                    .password("")
                    .build())
            .build();

        DeleteArchivedCallResponse res = sdk.voiceV1ArchivedCall().deleteArchivedCall()
                .date(LocalDate.parse("2024-07-27"))
                .sid("<id>")
                .call();

        // handle response
    }
}

Server Selection

Override Server URL Per-Client

The default server can be overridden globally using the .serverURL(String serverUrl) builder method when initializing the SDK client instance. For example:

package hello.world;

import java.lang.Exception;
import java.time.LocalDate;
import org.openapis.openapi.SDK;
import org.openapis.openapi.models.components.Security;
import org.openapis.openapi.models.operations.DeleteArchivedCallResponse;

public class Application {

    public static void main(String[] args) throws Exception {

        SDK sdk = SDK.builder()
                .serverURL("https://voice.twilio.com")
                .security(Security.builder()
                    .username("")
                    .password("")
                    .build())
            .build();

        DeleteArchivedCallResponse res = sdk.voiceV1ArchivedCall().deleteArchivedCall()
                .date(LocalDate.parse("2024-07-27"))
                .sid("<id>")
                .call();

        // handle response
    }
}

Override Server URL Per-Operation

The server URL can also be overridden on a per-operation basis, provided a server list was specified for the operation. For example:

package hello.world;

import java.lang.Exception;
import java.time.LocalDate;
import org.openapis.openapi.SDK;
import org.openapis.openapi.models.components.Security;
import org.openapis.openapi.models.operations.DeleteArchivedCallResponse;

public class Application {

    public static void main(String[] args) throws Exception {

        SDK sdk = SDK.builder()
                .security(Security.builder()
                    .username("")
                    .password("")
                    .build())
            .build();

        DeleteArchivedCallResponse res = sdk.voiceV1ArchivedCall().deleteArchivedCall()
                .serverURL("https://voice.twilio.com")
                .date(LocalDate.parse("2024-07-27"))
                .sid("<id>")
                .call();

        // handle response
    }
}

Development

Maturity

This SDK is in beta, and there may be breaking changes between versions without a major version update. Therefore, we recommend pinning usage to a specific package version. This way, you can install the same version each time without breaking changes unless you are intentionally looking for the latest version.

Contributions

While we value open-source contributions to this SDK, this library is generated programmatically. Any manual changes added to internal files will be overwritten on the next generation. We look forward to hearing your feedback. Feel free to open a PR or an issue with a proof of concept and we'll do our best to include it in a future release.

SDK Created by Speakeasy