telnyx-porting-in-java

<!-- Auto-generated from Telnyx OpenAPI specs. Do not edit. --> # Telnyx Porting In - Java ## Installation ```text // See https://github.com/team-telnyx/telnyx-java for Maven/Gradle setup ``` ## Setup ```java import com.telnyx.sdk.client.TelnyxClient; import com.telnyx.sdk.client.okhttp.TelnyxOkHttpClient; TelnyxClient client = TelnyxOkHttpClient.fromEnv(); ``` All examples below assume `client` is already initialized as shown above. ## List all porting events Returns a list of all porting events. `GET /porting/events` ```java import com.telnyx.sdk.models.porting.events.EventListPage; import com.telnyx.sdk.models.porting.events.EventListParams; EventListPage page = client.porting().events().list(); ``` ## Show a porting event Show a specific porting event. `GET /porting/events/{id}` ```java import com.telnyx.sdk.models.porting.events.EventRetrieveParams; import com.telnyx.sdk.models.porting.events.EventRetrieveResponse; EventRetrieveResponse event = client.porting().events().retrieve("182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e"); ``` ## Republish a porting event Republish a specific porting event. `POST /porting/events/{id}/republish` ```java import com.telnyx.sdk.models.porting.events.EventRepublishParams; client.porting().events().republish("182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e"); ``` ## Preview the LOA configuration parameters Preview the LOA template that would be generated without need to create LOA configuration. `POST /porting/loa_configuration_preview` ```java import com.telnyx.sdk.core.http.HttpResponse; import com.telnyx.sdk.models.porting.loaconfigurations.LoaConfigurationPreview0Params; LoaConfigurationPreview0Params params = LoaConfigurationPreview0Params.builder() .address(LoaConfigurationPreview0Params.Address.builder() .city("Austin") .countryCode("US") .state("TX") .streetAddress("600 Congress Avenue") .zipCode("78701") .build()) .companyName("Telnyx") .contact(LoaConfigurationPreview0Params.Contact.builder() .email("testing@telnyx.com") .phoneNumber("+12003270001") .build()) .logo(LoaConfigurationPreview0Params.Logo.builder() .documentId("182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e") .build()) .name("My LOA Configuration") .build(); HttpResponse response = client.porting().loaConfigurations().preview0(params); ``` ## List LOA configurations List the LOA configurations. `GET /porting/loa_configurations` ```java import com.telnyx.sdk.models.porting.loaconfigurations.LoaConfigurationListPage; import com.telnyx.sdk.models.porting.loaconfigurations.LoaConfigurationListParams; LoaConfigurationListPage page = client.porting().loaConfigurations().list(); ``` ## Create a LOA configuration Create a LOA configuration. `POST /porting/loa_configurations` ```java import com.telnyx.sdk.models.porting.loaconfigurations.LoaConfigurationCreateParams; import com.telnyx.sdk.models.porting.loaconfigurations.LoaConfigurationCreateResponse; LoaConfigurationCreateParams params = LoaConfigurationCreateParams.builder() .address(LoaConfigurationCreateParams.Address.builder() .city("Austin") .countryCode("US") .state("TX") .streetAddress("600 Congress Avenue") .zipCode("78701") .build()) .companyName("Telnyx") .contact(LoaConfigurationCreateParams.Contact.builder() .email("testing@telnyx.com") .phoneNumber("+12003270001") .build()) .logo(LoaConfigurationCreateParams.Logo.builder() .documentId("182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e") .build()) .name("My LOA Configuration") .build(); LoaConfigurationCreateResponse loaConfiguration = client.porting().loaConfigurations().create(params); ``` ## Retrieve a LOA configuration Retrieve a specific LOA configuration. `GET /porting/loa_configurations/{id}` ```java import com.telnyx.sdk.models.porting.loaconfigurations.LoaConfigurationRetrieveParams; import com.telnyx.sdk.models.porting.loaconfigurations.LoaConfigurationRetrieveResponse; LoaConfigurationRetrieveResponse loaConfiguration = client.porting().loaConfigurations().retrieve("182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e"); ``` ## Update a LOA configuration Update a specific LOA configuration. `PATCH /porting/loa_configurations/{id}` ```java import com.telnyx.sdk.models.porting.loaconfigurations.LoaConfigurationUpdateParams; import com.telnyx.sdk.models.porting.loaconfigurations.LoaConfigurationUpdateResponse; LoaConfigurationUpdateParams params = LoaConfigurationUpdateParams.builder() .id("182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e") .address(LoaConfigurationUpdateParams.Address.builder() .city("Austin") .countryCode("US") .state("TX") .streetAddress("600 Congress Avenue") .zipCode("78701") .build()) .companyName("Telnyx") .contact(LoaConfigurationUpdateParams.Contact.builder() .email("testing@telnyx.com") .phoneNumber("+12003270001") .build()) .logo(LoaConfigurationUpdateParams.Logo.builder() .documentId("182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e") .build()) .name("My LOA Configuration") .build(); LoaConfigurationUpdateResponse loaConfiguration = client.porting().loaConfigurations().update(params); ``` ## Delete a LOA configuration Delete a specific LOA configuration. `DELETE /porting/loa_configurations/{id}` ```java import com.telnyx.sdk.models.porting.loaconfigurations.LoaConfigurationDeleteParams; client.porting().loaConfigurations().delete("182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e"); ``` ## Preview a LOA configuration Preview a specific LOA configuration. `GET /porting/loa_configurations/{id}/preview` ```java import com.telnyx.sdk.core.http.HttpResponse; import com.telnyx.sdk.models.porting.loaconfigurations.LoaConfigurationPreview1Params; HttpResponse response = client.porting().loaConfigurations().preview1("182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e"); ``` ## List all porting orders Returns a list of your porting order. `GET /porting_orders` ```java import com.telnyx.sdk.models.portingorders.PortingOrderListPage; import com.telnyx.sdk.models.portingorders.PortingOrderListParams; PortingOrderListPage page = client.portingOrders().list(); ``` ## Create a porting order Creates a new porting order object. `POST /porting_orders` — Required: `phone_numbers` ```java import com.telnyx.sdk.models.portingorders.PortingOrderCreateParams; import com.telnyx.sdk.models.portingorders.PortingOrderCreateResponse; import java.util.List; PortingOrderCreateParams params = PortingOrderCreateParams.builder() .phoneNumbers(List.of( "+13035550000", "+13035550001", "+13035550002" )) .build(); PortingOrderCreateResponse portingOrder = client.portingOrders().create(params); ``` ## Retrieve a porting order Retrieves the details of an existing porting order. `GET /porting_orders/{id}` ```java import com.telnyx.sdk.models.portingorders.PortingOrderRetrieveParams; import com.telnyx.sdk.models.portingorders.PortingOrderRetrieveResponse; PortingOrderRetrieveResponse portingOrder = client.portingOrders().retrieve("182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e"); ``` ## Edit a porting order Edits the details of an existing porting order. `PATCH /porting_orders/{id}` ```java import com.telnyx.sdk.models.portingorders.PortingOrderUpdateParams; import com.telnyx.sdk.models.portingorders.PortingOrderUpdateResponse; PortingOrderUpdateResponse portingOrder = client.portingOrders().update("182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e"); ``` ## Delete a porting order Deletes an existing porting order. `DELETE /porting_orders/{id}` ```java import com.telnyx.sdk.models.portingorders.PortingOrderDeleteParams; client.portingOrders().delete("182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e"); ``` ## Activate every number in a porting order asynchronously. Activate each number in a porting order asynchronously. `POST /porting_orders/{id}/actions/activate` ```java import com.telnyx.sdk.models.portingorders.actions.ActionActivateParams; import com.telnyx.sdk.models.portingorders.actions.ActionActivateResponse; ActionActivateResponse response = client.portingOrders().actions().activate("182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e"); ``` ## Cancel a porting order `POST /porting_orders/{id}/actions/cancel` ```java import com.telnyx.sdk.models.portingorders.actions.ActionCancelParams; import com.telnyx.sdk.models.portingorders.actions.ActionCancelResponse; ActionCancelResponse response = client.portingOrders().actions().cancel("182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e"); ``` ## Submit a porting order. Confirm and submit your porting order. `POST /porting_orders/{id}/actions/confirm` ```java import com.telnyx.sdk.models.portingorders.actions.ActionConfirmParams; import com.telnyx.sdk.models.portingorders.actions.ActionConfirmResponse; ActionConfirmResponse response = client.portingOrders().actions().confirm("182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e"); ``` ## Share a porting order Creates a sharing token for a porting order. `POST /porting_orders/{id}/actions/share` ```java import com.telnyx.sdk.models.portingorders.actions.ActionShareParams; import com.telnyx.sdk.models.portingorders.actions.ActionShareResponse; ActionShareResponse response = client.portingOrders().actions().share("182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e"); ``` ## List all porting activation jobs Returns a list of your porting activation jobs. `GET /porting_orders/{id}/activation_jobs` ```java import com.telnyx.sdk.models.portingorders.activationjobs.ActivationJobListPage; import com.telnyx.sdk.models.portingorders.activationjobs.ActivationJobListParams; ActivationJobListPage page = client.portingOrders().activationJobs().list("182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e"); ``` ## Retrieve a porting activation job Returns a porting activation job. `GET /porting_orders/{id}/activation_jobs/{activationJobId}` ```java import com.telnyx.sdk.models.portingorders.activationjobs.ActivationJobRetrieveParams; import com.telnyx.sdk.models.portingorders.activationjobs.ActivationJobRetrieveResponse; ActivationJobRetrieveParams params = ActivationJobRetrieveParams.builder() .id("182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e") .activationJobId("182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e") .build(); ActivationJobRetrieveResponse activationJob = client.portingOrders().activationJobs().retrieve(params); ``` ## Update a porting activation job Updates the activation time of a porting activation job. `PATCH /porting_orders/{id}/activation_jobs/{activationJobId}` ```java import com.telnyx.sdk.models.portingorders.activationjobs.ActivationJobUpdateParams; import com.telnyx.sdk.models.portingorders.activationjobs.ActivationJobUpdateResponse; ActivationJobUpdateParams params = ActivationJobUpdateParams.builder() .id("182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e") .activationJobId("182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e") .build(); ActivationJobUpdateResponse activationJob = client.portingOrders().activationJobs().update(params); ``` ## List additional documents Returns a list of additional documents for a porting order. `GET /porting_orders/{id}/additional_documents` ```java import com.telnyx.sdk.models.portingorders.additionaldocuments.AdditionalDocumentListPage; import com.telnyx.sdk.models.portingorders.additionaldocuments.AdditionalDocumentListParams; AdditionalDocumentListPage page = client.portingOrders().additionalDocuments().list("182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e"); ``` ## Create a list of additional documents Creates a list of additional documents for a porting order. `POST /porting_orders/{id}/additional_documents` ```java import com.telnyx.sdk.models.portingorders.additionaldocuments.AdditionalDocumentCreateParams; import com.telnyx.sdk.models.portingorders.additionaldocuments.AdditionalDocumentCreateResponse; AdditionalDocumentCreateResponse additionalDocument = client.portingOrders().additionalDocuments().create("182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e"); ``` ## Delete an additional document Deletes an additional document for a porting order. `DELETE /porting_orders/{id}/additional_documents/{additional_document_id}` ```java import com.telnyx.sdk.models.portingorders.additionaldocuments.AdditionalDocumentDeleteParams; AdditionalDocumentDeleteParams params = AdditionalDocumentDeleteParams.builder() .id("182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e") .additionalDocumentId("182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e") .build(); client.portingOrders().additionalDocuments().delete(params); ``` ## List allowed FOC dates Returns a list of allowed FOC dates for a porting order. `GET /porting_orders/{id}/allowed_foc_windows` ```java import com.telnyx.sdk.models.portingorders.PortingOrderRetrieveAllowedFocWindowsParams; import com.telnyx.sdk.models.portingorders.PortingOrderRetrieveAllowedFocWindowsResponse;