Skip to content

Commit

Permalink
docs (Numbers): javadoc
Browse files Browse the repository at this point in the history
  • Loading branch information
JPPortier committed Jul 9, 2024
1 parent 95dd0d6 commit 497541d
Show file tree
Hide file tree
Showing 30 changed files with 134 additions and 53 deletions.
22 changes: 16 additions & 6 deletions client/src/main/com/sinch/sdk/domains/numbers/NumbersService.java
Original file line number Diff line number Diff line change
Expand Up @@ -15,45 +15,55 @@ public interface NumbersService {
* @return V1 service instance for project
* @see <a
* href="https://developers.sinch.com/docs/numbers/sdk/java/syntax-reference/">Documentation</a>
* @since TODO NEXT_RELEASE_VERSION
* @since 1.2
*/
com.sinch.sdk.domains.numbers.api.v1.NumbersService v1();

/**
* Available Number Service instance
* Non versioned Available Number Service instance
*
* @apiNote This version is no longer updated, to get updates use V1 version: {@link
* com.sinch.sdk.domains.numbers.api.v1.AvailableNumberService}
* @return service instance for project
* @since 1.0
*/
AvailableNumberService available();

/**
* Available Region Service instance
* Non versioned Available Region Service instance
*
* @apiNote This version is no longer updated, to get updates use V1 version: {@link
* com.sinch.sdk.domains.numbers.api.v1.AvailableRegionService}
* @return service instance for project
* @since 1.0
*/
AvailableRegionService regions();

/**
* Active Number Service instance
* Non versioned Active Number Service instance
*
* @apiNote This version is no longer updated, to get updates use V1 version: {@link
* com.sinch.sdk.domains.numbers.api.v1.ActiveNumberService}
* @return service instance for project
* @since 1.0
*/
ActiveNumberService active();

/**
* Callbacks Configuration Service instance
* Non versioned Callbacks Configuration Service instance
*
* @apiNote This version is no longer updated, to get updates use V1 version: {@link
* com.sinch.sdk.domains.numbers.api.v1.CallbackConfigurationService}
* @return service instance for project
* @since 1.0
*/
CallbackConfigurationService callback();

/**
* Webhooks helpers instance
* Non versioned Webhooks helpers instance
*
* @apiNote This version is no longer updated, to get updates use V1 version: {@link
* com.sinch.sdk.domains.numbers.api.v1.WebHooksService}
* @return instance service related to webhooks helpers
* @since 1.0
*/
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -12,7 +12,7 @@
* @see <a
* href="https://developers.sinch.com/docs/numbers/sdk/java/syntax-reference/#numbersactive-endpoint-category">online
* documentation</a>
* @since TODO NEXT_RELEASE_VERSION
* @since 1.2
*/
public interface ActiveNumberService {

Expand All @@ -21,7 +21,7 @@ public interface ActiveNumberService {
*
* @param parameters Filtering criteria
* @return List of active numbers
* @since TODO NEXT_RELEASE_VERSION
* @since 1.2
*/
ActiveNumberListResponse list(ActiveNumberListRequest parameters) throws ApiException;

Expand All @@ -30,7 +30,7 @@ public interface ActiveNumberService {
*
* @param phoneNumber Phone number
* @return Active number information
* @since TODO NEXT_RELEASE_VERSION
* @since 1.2
*/
ActiveNumber get(String phoneNumber) throws ApiException;

Expand All @@ -39,7 +39,7 @@ public interface ActiveNumberService {
*
* @param phoneNumber Phone number
* @return Released active number
* @since TODO NEXT_RELEASE_VERSION
* @since 1.2
*/
ActiveNumber release(String phoneNumber) throws ApiException;

Expand All @@ -49,7 +49,7 @@ public interface ActiveNumberService {
* @param phoneNumber Phone number
* @param parameters Parameters to be updated
* @return Updated active number
* @since TODO NEXT_RELEASE_VERSION
* @since 1.2
*/
ActiveNumber update(String phoneNumber, ActiveNumberUpdateRequest parameters) throws ApiException;
}
Original file line number Diff line number Diff line change
Expand Up @@ -13,8 +13,8 @@
*
* @see <a
* href="https://developers.sinch.com/docs/numbers/sdk/java/syntax-reference/#numbersavailable-endpoint-category">online
* documentatio</a>
* @since TODO NEXT_RELEASE_VERSION
* documentation</a>
* @since 1.2
*/
public interface AvailableNumberService {

Expand All @@ -29,7 +29,7 @@ public interface AvailableNumberService {
*
* @param parameters Filtering criteria
* @return List of available numbers according to search criteria
* @since TODO NEXT_RELEASE_VERSION
* @since 1.2
*/
AvailableNumberListResponse list(AvailableNumberListRequest parameters) throws ApiException;

Expand All @@ -40,7 +40,7 @@ public interface AvailableNumberService {
*
* @param phoneNumber Phone number
* @return Available number information
* @since TODO NEXT_RELEASE_VERSION
* @since 1.2
*/
AvailableNumber checkAvailability(String phoneNumber) throws ApiException;

Expand All @@ -60,7 +60,7 @@ public interface AvailableNumberService {
* @param phoneNumber Number to be activated
* @param parameters Activation parameters
* @return Activated number
* @since TODO NEXT_RELEASE_VERSION
* @since 1.2
*/
ActiveNumber rent(String phoneNumber, AvailableNumberRentRequest parameters) throws ApiException;

Expand All @@ -72,7 +72,7 @@ public interface AvailableNumberService {
*
* @param parameters Selection and activation parameters
* @return Activated number according to criteria
* @since TODO NEXT_RELEASE_VERSION
* @since 1.2
*/
ActiveNumber rentAny(AvailableNumberRentAnyRequest parameters) throws ApiException;
}
Original file line number Diff line number Diff line change
Expand Up @@ -10,7 +10,7 @@
* @see <a
* href="https://developers.sinch.com/docs/numbers/sdk/java/syntax-reference/#numbersregions-endpoint-category">online
* documentation</a>
* @since TODO NEXT_RELEASE_VERSION
* @since 1.2
*/
public interface AvailableRegionService {

Expand All @@ -19,7 +19,7 @@ public interface AvailableRegionService {
*
* @param parameters Filtering criteria
* @return List of available regions according to search criteria
* @since TODO NEXT_RELEASE_VERSION
* @since 1.2
*/
AvailableRegionListResponse list(AvailableRegionListRequest parameters) throws ApiException;
}
Original file line number Diff line number Diff line change
Expand Up @@ -10,15 +10,15 @@
* @see <a
* href="https://developers.sinch.com/docs/numbers/sdk/java/syntax-reference/#numberscallback-endpoint-category">online
* documentation</a>
* @since TODO NEXT_RELEASE_VERSION
* @since 1.2
*/
public interface CallbackConfigurationService {

/**
* Get callbacks configuration
*
* @return callbacks configuration for the project
* @since TODO NEXT_RELEASE_VERSION
* @since 1.2
*/
CallbackConfigurationResponse get() throws ApiException;

Expand All @@ -27,7 +27,7 @@ public interface CallbackConfigurationService {
*
* @param parameters Parameters to be updated
* @return Updated callbacks configuration
* @since TODO NEXT_RELEASE_VERSION
* @since 1.2
*/
CallbackConfigurationResponse update(CallbackConfigurationUpdateRequest parameters)
throws ApiException;
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -3,49 +3,49 @@
/**
* Numbers Service
*
* @see <a href="https://developers.sinch.com/docs/numbers/sdk/java/syntax-reference/">online
* @see <a href="https://developers.sinch.com/docs/numbers/sdk/java/syntax-reference">online
* documentation</a>
* @since TODO NEXT_RELEASE_VERSION
* @since 1.2
*/
public interface NumbersService {

/**
* Available Number Service instance
*
* @return service instance for project
* @since TODO NEXT_RELEASE_VERSION
* @since 1.2
*/
AvailableNumberService available();

/**
* Available Region Service instance
*
* @return service instance for project
* @since TODO NEXT_RELEASE_VERSION
* @since 1.2
*/
AvailableRegionService regions();

/**
* Active Number Service instance
*
* @return service instance for project
* @since TODO NEXT_RELEASE_VERSION
* @since 1.2
*/
ActiveNumberService active();

/**
* Callbacks Configuration Service instance
*
* @return service instance for project
* @since TODO NEXT_RELEASE_VERSION
* @since 1.2
*/
CallbackConfigurationService callback();

/**
* Webhooks helpers instance
*
* @return instance service related to webhooks helpers
* @since TODO NEXT_RELEASE_VERSION
* @since 1.2
*/
WebHooksService webhooks();
}
Original file line number Diff line number Diff line change
Expand Up @@ -10,9 +10,10 @@
* callback URL
*
* <p>see <a
* href="https://developers.sinch.com/docs/numbers/api-reference/numbers/tag/Callbacks/#tag/Callbacks/operation/ImportedNumberService_EventsCallback">https://developers.sinch.com/docs/numbers/api-reference/numbers/tag/Callbacks/#tag/Callbacks/operation/ImportedNumberService_EventsCallback</a>
* href="https://developers.sinch.com/docs/numbers/api-reference/numbers/tag/Numbers-Callbacks/#tag/Numbers-Callbacks/operation/ImportedNumberService_EventsCallback">online
* documentation</a>
*
* @since TODO NEXT_RELEASE_VERSION
* @since 1.2
*/
public interface WebHooksService {

Expand All @@ -22,7 +23,7 @@ public interface WebHooksService {
*
* @param jsonPayload Received payload to be un-serialized
* @return The decoded event notification instance class
* @since TODO NEXT_RELEASE_VERSION
* @since 1.2
*/
NumberEvent parseEvent(String jsonPayload) throws ApiMappingException;
}
Original file line number Diff line number Diff line change
@@ -1,11 +1,13 @@
/**
* Numbers API interface
* Numbers API interface V1
*
* <p>The Numbers API enables you to search for, view, and activate numbers. It's considered a
* precursor to other APIs in the Sinch product family. The numbers API can be used in tandem with
* any of our APIs that perform messaging or calling. Once you have activated your numbers, you can
* precursor to other APIs in the Sinch product family. <p>The numbers API can be used in tandem with
* any of our APIs that perform messaging or calling. <p>Once you have activated your numbers, you can
* then use the various other APIs, such as SMS or Voice, to assign and use those numbers.
*
* @since 1.0
* @see <a
* href="https://developers.sinch.com/docs/numbers">https://developers.sinch.com/docs/numbers</a>
* @since 1.2
*/
package com.sinch.sdk.domains.numbers.api.v1;
Original file line number Diff line number Diff line change
Expand Up @@ -10,7 +10,7 @@
*
* @see <a
* href="https://developers.sinch.com/docs/numbers/api-reference/numbers/tag/Active-Number">https://developers.sinch.com/docs/numbers/api-reference/numbers/tag/Active-Number/</a>
* @since TODO NEXT_RELEASE_VERSION
* @since 1.2
*/
public interface ActiveNumberListRequest {

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -12,7 +12,7 @@
*
* @see <a
* href="https://developers.sinch.com/docs/numbers/api-reference/numbers/tag/Active-Number">https://developers.sinch.com/docs/numbers/api-reference/numbers/tag/Active-Number/</a>
* @since 1.0
* @since 1.2
*/
public class ActiveNumberListRequestImpl implements ActiveNumberListRequest {

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,7 @@
/**
* Supported fields for ordering
*
* @since 1.0
* @since 1.2
*/
public final class OrderBy extends EnumDynamic<String, OrderBy> {
/** Ordering by phoneNumber */
Expand Down
Original file line number Diff line number Diff line change
@@ -0,0 +1,6 @@
/**
* Numbers Active API requests related models
*
* @since 1.2
*/
package com.sinch.sdk.domains.numbers.models.v1.active.request;
Original file line number Diff line number Diff line change
Expand Up @@ -12,7 +12,7 @@
/**
* Lists all active numbers for a project
*
* @since TODO NEXT_RELEASE_VERSION
* @since 1.2
*/
public class ActiveNumberListResponse extends ListResponse<ActiveNumber> {

Expand Down
Original file line number Diff line number Diff line change
@@ -0,0 +1,6 @@
/**
* Numbers Active API responses related models
*
* @since 1.2
*/
package com.sinch.sdk.domains.numbers.models.v1.active.response;
Original file line number Diff line number Diff line change
Expand Up @@ -10,7 +10,7 @@
*
* @see <a
* href="https://developers.sinch.com/docs/numbers/api-reference/numbers/tag/Available-Number/#tag/Available-Number/operation/NumberService_ListAvailableNumbers">https://developers.sinch.com/docs/numbers/api-reference/numbers/tag/Available-Number/#tag/Available-Number/operation/NumberService_ListAvailableNumbers/</a>
* @since TODO NEXT_RELEASE_VERSION
* @since 1.2
*/
public interface AvailableNumberListRequest {

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -12,7 +12,7 @@
*
* @see <a
* href="https://developers.sinch.com/docs/numbers/api-reference/numbers/tag/Available-Number/#tag/Available-Number/operation/NumberService_ListAvailableNumbers">https://developers.sinch.com/docs/numbers/api-reference/numbers/tag/Available-Number/#tag/Available-Number/operation/NumberService_ListAvailableNumbers/</a>
* @since TODO NEXT_RELEASE_VERSION
* @since 1.2
*/
public class AvailableNumberListRequestImpl implements AvailableNumberListRequest {
private final OptionalValue<String> regionCode;
Expand Down
Original file line number Diff line number Diff line change
@@ -0,0 +1,6 @@
/**
* Numbers Available API requests related models
*
* @since 1.2
*/
package com.sinch.sdk.domains.numbers.models.v1.available.request;
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,7 @@
/**
* Lists all available numbers for a project
*
* @since TODO NEXT_RELEASE_VERSION
* @since 1.2
*/
public class AvailableNumberListResponse extends ListResponse<AvailableNumber> {

Expand Down
Original file line number Diff line number Diff line change
@@ -0,0 +1,6 @@
/**
* Numbers Available API responses related models
*
* @since 1.2
*/
package com.sinch.sdk.domains.numbers.models.v1.available.response;
Original file line number Diff line number Diff line change
@@ -0,0 +1,6 @@
/**
* Numbers Callback Configuration API requests related models
*
* @since 1.2
*/
package com.sinch.sdk.domains.numbers.models.v1.callbacks.request;
Loading

0 comments on commit 497541d

Please sign in to comment.