github.com/grokify/go-ringcentral-client@v0.3.31/office/v1/client/docs/PushNotificationsApi.md (about)

     1  # \PushNotificationsApi
     2  
     3  All URIs are relative to *https://platform.devtest.ringcentral.com*
     4  
     5  Method | HTTP request | Description
     6  ------------- | ------------- | -------------
     7  [**CreateSubscription**](PushNotificationsApi.md#CreateSubscription) | **Post** /restapi/v1.0/subscription | Create Subscription
     8  [**DeleteSubscription**](PushNotificationsApi.md#DeleteSubscription) | **Delete** /restapi/v1.0/subscription/{subscriptionId} | Cancel Subscription
     9  [**GetSubscriptions**](PushNotificationsApi.md#GetSubscriptions) | **Get** /restapi/v1.0/subscription | Get Subscriptions
    10  [**LoadSubscription**](PushNotificationsApi.md#LoadSubscription) | **Get** /restapi/v1.0/subscription/{subscriptionId} | Get Subscription
    11  [**RenewSubscription**](PushNotificationsApi.md#RenewSubscription) | **Post** /restapi/v1.0/subscription/{subscriptionId}/renew | Renew Subscription
    12  [**UpdateSubscription**](PushNotificationsApi.md#UpdateSubscription) | **Put** /restapi/v1.0/subscription/{subscriptionId} | Renew Subscription / Update Event Filters
    13  
    14  
    15  # **CreateSubscription**
    16  > SubscriptionInfo CreateSubscription(ctx, createSubscriptionRequest)
    17  Create Subscription
    18  
    19  <p style='font-style:italic;'>Since 1.0.6 (Release 5.15)</p><p>Creates a new subscription.</p><h4>Usage Plan Group</h4><p>Medium</p>
    20  
    21  ### Required Parameters
    22  
    23  Name | Type | Description  | Notes
    24  ------------- | ------------- | ------------- | -------------
    25   **ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc.
    26    **createSubscriptionRequest** | [**CreateSubscriptionRequest**](CreateSubscriptionRequest.md)| JSON body | 
    27  
    28  ### Return type
    29  
    30  [**SubscriptionInfo**](SubscriptionInfo.md)
    31  
    32  ### Authorization
    33  
    34  [OAuth2](../README.md#OAuth2)
    35  
    36  ### HTTP request headers
    37  
    38   - **Content-Type**: application/json
    39   - **Accept**: application/json
    40  
    41  [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
    42  
    43  # **DeleteSubscription**
    44  > DeleteSubscription(ctx, subscriptionId)
    45  Cancel Subscription
    46  
    47  <p style='font-style:italic;'></p><p>Cancels the existent subscription.</p><h4>Usage Plan Group</h4><p>Medium</p>
    48  
    49  ### Required Parameters
    50  
    51  Name | Type | Description  | Notes
    52  ------------- | ------------- | ------------- | -------------
    53   **ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc.
    54    **subscriptionId** | **string**| Internal identifier of a subscription | 
    55  
    56  ### Return type
    57  
    58   (empty response body)
    59  
    60  ### Authorization
    61  
    62  [OAuth2](../README.md#OAuth2)
    63  
    64  ### HTTP request headers
    65  
    66   - **Content-Type**: Not defined
    67   - **Accept**: Not defined
    68  
    69  [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
    70  
    71  # **GetSubscriptions**
    72  > RecordsCollectionResourceSubscriptionResponse GetSubscriptions(ctx, )
    73  Get Subscriptions
    74  
    75  ### Required Parameters
    76  This endpoint does not need any parameter.
    77  
    78  ### Return type
    79  
    80  [**RecordsCollectionResourceSubscriptionResponse**](RecordsCollectionResourceSubscriptionResponse.md)
    81  
    82  ### Authorization
    83  
    84  [OAuth2](../README.md#OAuth2)
    85  
    86  ### HTTP request headers
    87  
    88   - **Content-Type**: Not defined
    89   - **Accept**: application/json
    90  
    91  [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
    92  
    93  # **LoadSubscription**
    94  > SubscriptionInfo LoadSubscription(ctx, subscriptionId)
    95  Get Subscription
    96  
    97  <p style='font-style:italic;'>Since 1.0.6 (Release 5.15)</p><p>Returns the requested subscription.</p><h4>Usage Plan Group</h4><p>Light</p>
    98  
    99  ### Required Parameters
   100  
   101  Name | Type | Description  | Notes
   102  ------------- | ------------- | ------------- | -------------
   103   **ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc.
   104    **subscriptionId** | **int32**| Internal identifier of a subscription | 
   105  
   106  ### Return type
   107  
   108  [**SubscriptionInfo**](SubscriptionInfo.md)
   109  
   110  ### Authorization
   111  
   112  [OAuth2](../README.md#OAuth2)
   113  
   114  ### HTTP request headers
   115  
   116   - **Content-Type**: Not defined
   117   - **Accept**: application/json
   118  
   119  [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
   120  
   121  # **RenewSubscription**
   122  > SubscriptionInfo RenewSubscription(ctx, subscriptionId)
   123  Renew Subscription
   124  
   125  <p style='font-style:italic;'>Since 1.0.26 (Release 8.12)</p><p>Renews an existent subscription by ID by posting request with an empty body..</p><h4>Usage Plan Group</h4><p>Medium</p>
   126  
   127  ### Required Parameters
   128  
   129  Name | Type | Description  | Notes
   130  ------------- | ------------- | ------------- | -------------
   131   **ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc.
   132    **subscriptionId** | **string**|  | 
   133  
   134  ### Return type
   135  
   136  [**SubscriptionInfo**](SubscriptionInfo.md)
   137  
   138  ### Authorization
   139  
   140  [OAuth2](../README.md#OAuth2)
   141  
   142  ### HTTP request headers
   143  
   144   - **Content-Type**: Not defined
   145   - **Accept**: application/json
   146  
   147  [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
   148  
   149  # **UpdateSubscription**
   150  > SubscriptionInfo UpdateSubscription(ctx, subscriptionId, modifySubscriptionRequest, optional)
   151  Renew Subscription / Update Event Filters
   152  
   153  <p style='font-style:italic;'>Since 1.0.6 (Release 5.15)</p><p>Renews the existent subscription if the request body is empty. If event filters are specified, calling this method modifies the event filters for the existing subscription. The client application can extend or narrow the events for which it receives notifications in the frame of one subscription.</p><h4>Usage Plan Group</h4><p>Medium</p>
   154  
   155  ### Required Parameters
   156  
   157  Name | Type | Description  | Notes
   158  ------------- | ------------- | ------------- | -------------
   159   **ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc.
   160    **subscriptionId** | **string**| Internal identifier of a subscription | 
   161    **modifySubscriptionRequest** | [**ModifySubscriptionRequest**](ModifySubscriptionRequest.md)| JSON body | 
   162   **optional** | ***UpdateSubscriptionOpts** | optional parameters | nil if no parameters
   163  
   164  ### Optional Parameters
   165  Optional parameters are passed through a pointer to a UpdateSubscriptionOpts struct
   166  
   167  Name | Type | Description  | Notes
   168  ------------- | ------------- | ------------- | -------------
   169  
   170  
   171   **aggregated** | **optional.Bool**| If &#39;True&#39; then aggregated presence status is returned in a notification payload | 
   172  
   173  ### Return type
   174  
   175  [**SubscriptionInfo**](SubscriptionInfo.md)
   176  
   177  ### Authorization
   178  
   179  [OAuth2](../README.md#OAuth2)
   180  
   181  ### HTTP request headers
   182  
   183   - **Content-Type**: application/json
   184   - **Accept**: application/json
   185  
   186  [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
   187