cloud.metaapi.sdk.meta_api

Class ProvisioningProfileApi

java.lang.Object

cloud.metaapi.sdk.meta_api.ProvisioningProfileApi

public class ProvisioningProfileApi
extends Object

Exposes provisioning profile API logic to the consumers

Constructor Summary

Constructors

Constructor and Description
ProvisioningProfileApi(ProvisioningProfileClient provisioningProfileClient) Constructs a provisioning profile API instance

Method Summary

Modifier and Type	Method and Description
CompletableFuture<ProvisioningProfile>	createProvisioningProfile(NewProvisioningProfileDto profile) Creates a provisioning profile
CompletableFuture<ProvisioningProfile>	getProvisioningProfile(String provisioningProfileId) Retrieves a provisioning profile by id
CompletableFuture<List<ProvisioningProfile>>	getProvisioningProfiles() Retrieves provisioning profiles without filtering by version or status.
CompletableFuture<List<ProvisioningProfile>>	getProvisioningProfiles(Integer version, String status) Retrieves provisioning profiles

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

ProvisioningProfileApi

public ProvisioningProfileApi(ProvisioningProfileClient provisioningProfileClient)

Constructs a provisioning profile API instance

Parameters:

provisioningProfileClient - provisioning profile REST API client

Method Detail

getProvisioningProfiles

public CompletableFuture<List<ProvisioningProfile>> getProvisioningProfiles()

Retrieves provisioning profiles without filtering by version or status.

Returns:

completable future resolving with a list of provisioning profile entities

getProvisioningProfiles

public CompletableFuture<List<ProvisioningProfile>> getProvisioningProfiles(Integer version,
                                                                            String status)

Retrieves provisioning profiles

Parameters:

version - optional version filter (allowed values are 4 and 5) or null

status - optional status filter (allowed values are new and active) or null

Returns:

completable future resolving with a list of provisioning profile entities

getProvisioningProfile

public CompletableFuture<ProvisioningProfile> getProvisioningProfile(String provisioningProfileId)

Retrieves a provisioning profile by id

Parameters:

provisioningProfileId - provisioning profile id

Returns:

completable future resolving with provisioning profile entity

createProvisioningProfile

public CompletableFuture<ProvisioningProfile> createProvisioningProfile(NewProvisioningProfileDto profile)

Creates a provisioning profile

Parameters:

profile - provisioning profile data

Returns:

completable future resolving with provisioning profile entity