Package app.cybrid.cybrid_api_organization.client.api

Class SubscriptionsOrganizationApi

java.lang.Object

app.cybrid.cybrid_api_organization.client.api.SubscriptionsOrganizationApi

@Generated(value="org.openapitools.codegen.languages.JavaClientCodegen",
           date="2024-09-16T16:27:23.286758Z[Etc/UTC]")
public class SubscriptionsOrganizationApi
extends Object

Constructor Summary

Constructors

Constructor	Description
SubscriptionsOrganizationApi()
SubscriptionsOrganizationApi(ApiClient apiClient)

Method Summary

Modifier and Type	Method	Description
reactor.core.publisher.Mono<SubscriptionOrganizationModel>	createSubscription(PostSubscriptionOrganizationModel postSubscriptionOrganizationModel)	Create Subscription Creates a Subscription.
reactor.core.publisher.Mono<org.springframework.http.ResponseEntity<SubscriptionOrganizationModel>>	createSubscriptionWithHttpInfo(PostSubscriptionOrganizationModel postSubscriptionOrganizationModel)
reactor.core.publisher.Mono<Void>	deleteSubscription(String subscriptionGuid)	Delete Subscription Deletes a subscription.
reactor.core.publisher.Mono<org.springframework.http.ResponseEntity<Void>>	deleteSubscriptionWithHttpInfo(String subscriptionGuid)
ApiClient	getApiClient()
reactor.core.publisher.Mono<SubscriptionOrganizationModel>	getSubscription(String subscriptionGuid, Boolean includeSigningKey)	Get Subscription Retrieves a subscription.
reactor.core.publisher.Mono<org.springframework.http.ResponseEntity<SubscriptionOrganizationModel>>	getSubscriptionWithHttpInfo(String subscriptionGuid, Boolean includeSigningKey)
reactor.core.publisher.Mono<SubscriptionListOrganizationModel>	listSubscriptions(BigInteger page, BigInteger perPage, String guid, Boolean includeSigningKey)	Get subscriptions list Retrieves a listing of subscriptions.
reactor.core.publisher.Mono<org.springframework.http.ResponseEntity<SubscriptionListOrganizationModel>>	listSubscriptionsWithHttpInfo(BigInteger page, BigInteger perPage, String guid, Boolean includeSigningKey)
void	setApiClient(ApiClient apiClient)

Methods inherited from class java.lang.Object

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

Constructor Detail

SubscriptionsOrganizationApi

public SubscriptionsOrganizationApi()

SubscriptionsOrganizationApi

@Autowired
public SubscriptionsOrganizationApi(ApiClient apiClient)

Method Detail

getApiClient

public ApiClient getApiClient()

setApiClient

public void setApiClient(ApiClient apiClient)

createSubscription

public reactor.core.publisher.Mono<SubscriptionOrganizationModel> createSubscription(PostSubscriptionOrganizationModel postSubscriptionOrganizationModel)
                                                                              throws org.springframework.web.reactive.function.client.WebClientResponseException

Create Subscription Creates a Subscription. ## Subscription creation Subscriptions can be created for webhook endpoints. ## State | State | Description | |-------|-------------| | storing | The Platform is storing the subscription details in our private store | | completed | The Platform has created the subscription | | failed | The Platform was not able to successfully create the subscription | Required scope: **subscriptions:execute

201 - Subscription created

401 - Unauthorized - Authentication failed,

403 - Invalid scope

Parameters:

postSubscriptionOrganizationModel - The postSubscriptionOrganizationModel parameter

Returns:

SubscriptionOrganizationModel

Throws:

org.springframework.web.reactive.function.client.WebClientResponseException - if an error occurs while attempting to invoke the API

createSubscriptionWithHttpInfo

public reactor.core.publisher.Mono<org.springframework.http.ResponseEntity<SubscriptionOrganizationModel>> createSubscriptionWithHttpInfo(PostSubscriptionOrganizationModel postSubscriptionOrganizationModel)
                                                                                                                                   throws org.springframework.web.reactive.function.client.WebClientResponseException

Throws:

org.springframework.web.reactive.function.client.WebClientResponseException

deleteSubscription

public reactor.core.publisher.Mono<Void> deleteSubscription(String subscriptionGuid)
                                                     throws org.springframework.web.reactive.function.client.WebClientResponseException

Delete Subscription Deletes a subscription. Required scope: **subscriptions:execute**

204 - Subscription deleted

401 - Unauthorized - Authentication failed,

403 - Invalid scope

404 - Subscription not found

Parameters:

subscriptionGuid - Identifier for the subscription.

Throws:

org.springframework.web.reactive.function.client.WebClientResponseException - if an error occurs while attempting to invoke the API

deleteSubscriptionWithHttpInfo

public reactor.core.publisher.Mono<org.springframework.http.ResponseEntity<Void>> deleteSubscriptionWithHttpInfo(String subscriptionGuid)
                                                                                                          throws org.springframework.web.reactive.function.client.WebClientResponseException

Throws:

org.springframework.web.reactive.function.client.WebClientResponseException

getSubscription

public reactor.core.publisher.Mono<SubscriptionOrganizationModel> getSubscription(String subscriptionGuid,
                                                                                  Boolean includeSigningKey)
                                                                           throws org.springframework.web.reactive.function.client.WebClientResponseException

Get Subscription Retrieves a subscription. Required scope: **subscriptions:read**

200 - Subscription found

401 - Unauthorized - Authentication failed,

403 - Invalid scope

404 - Subscription not found

Parameters:

subscriptionGuid - Identifier for the subscription.

includeSigningKey - Flag to include signing key in the response.

Returns:

SubscriptionOrganizationModel

Throws:

org.springframework.web.reactive.function.client.WebClientResponseException - if an error occurs while attempting to invoke the API

getSubscriptionWithHttpInfo

public reactor.core.publisher.Mono<org.springframework.http.ResponseEntity<SubscriptionOrganizationModel>> getSubscriptionWithHttpInfo(String subscriptionGuid,
                                                                                                                                       Boolean includeSigningKey)
                                                                                                                                throws org.springframework.web.reactive.function.client.WebClientResponseException

Throws:

org.springframework.web.reactive.function.client.WebClientResponseException

listSubscriptions

public reactor.core.publisher.Mono<SubscriptionListOrganizationModel> listSubscriptions(BigInteger page,
                                                                                        BigInteger perPage,
                                                                                        String guid,
                                                                                        Boolean includeSigningKey)
                                                                                 throws org.springframework.web.reactive.function.client.WebClientResponseException

Get subscriptions list Retrieves a listing of subscriptions. Required scope: **subscriptions:read**

200 - Get list of subscriptions

400 - Invalid requests

401 - Unauthorized - Authentication failed,

403 - Invalid scope

Parameters:

page - The page index to retrieve.

perPage - The number of entities per page to return.

guid - Comma separated subscription_guids to list subscriptions for.

includeSigningKey - Flag to include signing key in the response.

Returns:

SubscriptionListOrganizationModel

Throws:

org.springframework.web.reactive.function.client.WebClientResponseException - if an error occurs while attempting to invoke the API

listSubscriptionsWithHttpInfo

public reactor.core.publisher.Mono<org.springframework.http.ResponseEntity<SubscriptionListOrganizationModel>> listSubscriptionsWithHttpInfo(BigInteger page,
                                                                                                                                             BigInteger perPage,
                                                                                                                                             String guid,
                                                                                                                                             Boolean includeSigningKey)
                                                                                                                                      throws org.springframework.web.reactive.function.client.WebClientResponseException

Throws:

org.springframework.web.reactive.function.client.WebClientResponseException