Skip to content

Commit 8ae0fe7

Browse files
authored
Merge pull request #76 from OneSignal/user-api-updates
Add v5.4.0-beta1 package updates
2 parents a3a107b + 4220b0b commit 8ae0fe7

File tree

102 files changed

+9427
-1968
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

102 files changed

+9427
-1968
lines changed

README.md

Lines changed: 30 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -2,8 +2,8 @@
22

33
A powerful way to send personalized messages at scale and build effective customer engagement strategies. Learn more at onesignal.com
44

5-
- API version: 5.2.1
6-
- SDK version: 5.3.1-beta1
5+
- API version: 5.3.0
6+
- SDK version: 5.4.0-beta1
77
- Build package: org.openapitools.codegen.languages.CSharpNetCoreClientCodegen
88
For more information, please visit [https://onesignal.com](https://onesignal.com)
99

@@ -127,16 +127,22 @@ All URIs are relative to *https://api.onesignal.com*
127127
Class | Method | HTTP request | Description
128128
------------ | ------------- | ------------- | -------------
129129
*DefaultApi* | [**CancelNotification**](docs/DefaultApi.md#cancelnotification) | **DELETE** /notifications/{notification_id} | Stop a scheduled or currently outgoing notification
130+
*DefaultApi* | [**CopyTemplateToApp**](docs/DefaultApi.md#copytemplatetoapp) | **POST** /templates/{template_id}/copy_to_app | Copy template to another app
130131
*DefaultApi* | [**CreateAlias**](docs/DefaultApi.md#createalias) | **PATCH** /apps/{app_id}/users/by/{alias_label}/{alias_id}/identity |
131132
*DefaultApi* | [**CreateAliasBySubscription**](docs/DefaultApi.md#createaliasbysubscription) | **PATCH** /apps/{app_id}/subscriptions/{subscription_id}/user/identity |
133+
*DefaultApi* | [**CreateApiKey**](docs/DefaultApi.md#createapikey) | **POST** /apps/{app_id}/auth/tokens | Create API key
132134
*DefaultApi* | [**CreateApp**](docs/DefaultApi.md#createapp) | **POST** /apps | Create an app
135+
*DefaultApi* | [**CreateCustomEvents**](docs/DefaultApi.md#createcustomevents) | **POST** /apps/{app_id}/integrations/custom_events | Create custom events
133136
*DefaultApi* | [**CreateNotification**](docs/DefaultApi.md#createnotification) | **POST** /notifications | Create notification
134137
*DefaultApi* | [**CreateSegment**](docs/DefaultApi.md#createsegment) | **POST** /apps/{app_id}/segments | Create Segment
135138
*DefaultApi* | [**CreateSubscription**](docs/DefaultApi.md#createsubscription) | **POST** /apps/{app_id}/users/by/{alias_label}/{alias_id}/subscriptions |
139+
*DefaultApi* | [**CreateTemplate**](docs/DefaultApi.md#createtemplate) | **POST** /templates | Create template
136140
*DefaultApi* | [**CreateUser**](docs/DefaultApi.md#createuser) | **POST** /apps/{app_id}/users |
137141
*DefaultApi* | [**DeleteAlias**](docs/DefaultApi.md#deletealias) | **DELETE** /apps/{app_id}/users/by/{alias_label}/{alias_id}/identity/{alias_label_to_delete} |
142+
*DefaultApi* | [**DeleteApiKey**](docs/DefaultApi.md#deleteapikey) | **DELETE** /apps/{app_id}/auth/tokens/{token_id} | Delete API key
138143
*DefaultApi* | [**DeleteSegment**](docs/DefaultApi.md#deletesegment) | **DELETE** /apps/{app_id}/segments/{segment_id} | Delete Segment
139144
*DefaultApi* | [**DeleteSubscription**](docs/DefaultApi.md#deletesubscription) | **DELETE** /apps/{app_id}/subscriptions/{subscription_id} |
145+
*DefaultApi* | [**DeleteTemplate**](docs/DefaultApi.md#deletetemplate) | **DELETE** /templates/{template_id} | Delete template
140146
*DefaultApi* | [**DeleteUser**](docs/DefaultApi.md#deleteuser) | **DELETE** /apps/{app_id}/users/by/{alias_label}/{alias_id} |
141147
*DefaultApi* | [**ExportEvents**](docs/DefaultApi.md#exportevents) | **POST** /notifications/{notification_id}/export_events?app_id={app_id} | Export CSV of Events
142148
*DefaultApi* | [**ExportSubscriptions**](docs/DefaultApi.md#exportsubscriptions) | **POST** /players/csv_export?app_id={app_id} | Export CSV of Subscriptions
@@ -150,28 +156,44 @@ Class | Method | HTTP request | Description
150156
*DefaultApi* | [**GetOutcomes**](docs/DefaultApi.md#getoutcomes) | **GET** /apps/{app_id}/outcomes | View Outcomes
151157
*DefaultApi* | [**GetSegments**](docs/DefaultApi.md#getsegments) | **GET** /apps/{app_id}/segments | Get Segments
152158
*DefaultApi* | [**GetUser**](docs/DefaultApi.md#getuser) | **GET** /apps/{app_id}/users/by/{alias_label}/{alias_id} |
159+
*DefaultApi* | [**RotateApiKey**](docs/DefaultApi.md#rotateapikey) | **POST** /apps/{app_id}/auth/tokens/{token_id}/rotate | Rotate API key
160+
*DefaultApi* | [**StartLiveActivity**](docs/DefaultApi.md#startliveactivity) | **POST** /apps/{app_id}/activities/activity/{activity_type} | Start Live Activity
153161
*DefaultApi* | [**TransferSubscription**](docs/DefaultApi.md#transfersubscription) | **PATCH** /apps/{app_id}/subscriptions/{subscription_id}/owner |
154162
*DefaultApi* | [**UnsubscribeEmailWithToken**](docs/DefaultApi.md#unsubscribeemailwithtoken) | **POST** /apps/{app_id}/notifications/{notification_id}/unsubscribe | Unsubscribe with token
163+
*DefaultApi* | [**UpdateApiKey**](docs/DefaultApi.md#updateapikey) | **PATCH** /apps/{app_id}/auth/tokens/{token_id} | Update API key
155164
*DefaultApi* | [**UpdateApp**](docs/DefaultApi.md#updateapp) | **PUT** /apps/{app_id} | Update an app
156165
*DefaultApi* | [**UpdateLiveActivity**](docs/DefaultApi.md#updateliveactivity) | **POST** /apps/{app_id}/live_activities/{activity_id}/notifications | Update a Live Activity via Push
157166
*DefaultApi* | [**UpdateSubscription**](docs/DefaultApi.md#updatesubscription) | **PATCH** /apps/{app_id}/subscriptions/{subscription_id} |
167+
*DefaultApi* | [**UpdateSubscriptionByToken**](docs/DefaultApi.md#updatesubscriptionbytoken) | **PATCH** /apps/{app_id}/subscriptions_by_token/{token_type}/{token} | Update subscription by token
168+
*DefaultApi* | [**UpdateTemplate**](docs/DefaultApi.md#updatetemplate) | **PATCH** /templates/{template_id} | Update template
158169
*DefaultApi* | [**UpdateUser**](docs/DefaultApi.md#updateuser) | **PATCH** /apps/{app_id}/users/by/{alias_label}/{alias_id} |
170+
*DefaultApi* | [**ViewApiKeys**](docs/DefaultApi.md#viewapikeys) | **GET** /apps/{app_id}/auth/tokens | View API keys
171+
*DefaultApi* | [**ViewTemplate**](docs/DefaultApi.md#viewtemplate) | **GET** /templates/{template_id} | View template
172+
*DefaultApi* | [**ViewTemplates**](docs/DefaultApi.md#viewtemplates) | **GET** /templates | View templates
159173

160174

161175
<a name="documentation-for-models"></a>
162176
## Documentation for Models
163177

178+
- [Model.ApiKeyToken](docs/ApiKeyToken.md)
179+
- [Model.ApiKeyTokensListResponse](docs/ApiKeyTokensListResponse.md)
164180
- [Model.App](docs/App.md)
165181
- [Model.BasicNotification](docs/BasicNotification.md)
166182
- [Model.BasicNotificationAllOf](docs/BasicNotificationAllOf.md)
167183
- [Model.BasicNotificationAllOfAndroidBackgroundLayout](docs/BasicNotificationAllOfAndroidBackgroundLayout.md)
168184
- [Model.Button](docs/Button.md)
185+
- [Model.CopyTemplateRequest](docs/CopyTemplateRequest.md)
186+
- [Model.CreateApiKeyRequest](docs/CreateApiKeyRequest.md)
187+
- [Model.CreateApiKeyResponse](docs/CreateApiKeyResponse.md)
169188
- [Model.CreateNotificationSuccessResponse](docs/CreateNotificationSuccessResponse.md)
170189
- [Model.CreateSegmentConflictResponse](docs/CreateSegmentConflictResponse.md)
171190
- [Model.CreateSegmentSuccessResponse](docs/CreateSegmentSuccessResponse.md)
191+
- [Model.CreateTemplateRequest](docs/CreateTemplateRequest.md)
172192
- [Model.CreateUserConflictResponse](docs/CreateUserConflictResponse.md)
173193
- [Model.CreateUserConflictResponseErrorsInner](docs/CreateUserConflictResponseErrorsInner.md)
174194
- [Model.CreateUserConflictResponseErrorsItemsMeta](docs/CreateUserConflictResponseErrorsItemsMeta.md)
195+
- [Model.CustomEvent](docs/CustomEvent.md)
196+
- [Model.CustomEventsRequest](docs/CustomEventsRequest.md)
175197
- [Model.DeliveryData](docs/DeliveryData.md)
176198
- [Model.ExportEventsSuccessResponse](docs/ExportEventsSuccessResponse.md)
177199
- [Model.ExportSubscriptionsRequestBody](docs/ExportSubscriptionsRequestBody.md)
@@ -204,12 +226,18 @@ Class | Method | HTTP request | Description
204226
- [Model.Segment](docs/Segment.md)
205227
- [Model.SegmentData](docs/SegmentData.md)
206228
- [Model.SegmentNotificationTarget](docs/SegmentNotificationTarget.md)
229+
- [Model.StartLiveActivityRequest](docs/StartLiveActivityRequest.md)
230+
- [Model.StartLiveActivitySuccessResponse](docs/StartLiveActivitySuccessResponse.md)
207231
- [Model.Subscription](docs/Subscription.md)
208232
- [Model.SubscriptionBody](docs/SubscriptionBody.md)
209233
- [Model.SubscriptionNotificationTarget](docs/SubscriptionNotificationTarget.md)
234+
- [Model.TemplateResource](docs/TemplateResource.md)
235+
- [Model.TemplatesListResponse](docs/TemplatesListResponse.md)
210236
- [Model.TransferSubscriptionRequestBody](docs/TransferSubscriptionRequestBody.md)
237+
- [Model.UpdateApiKeyRequest](docs/UpdateApiKeyRequest.md)
211238
- [Model.UpdateLiveActivityRequest](docs/UpdateLiveActivityRequest.md)
212239
- [Model.UpdateLiveActivitySuccessResponse](docs/UpdateLiveActivitySuccessResponse.md)
240+
- [Model.UpdateTemplateRequest](docs/UpdateTemplateRequest.md)
213241
- [Model.UpdateUserRequest](docs/UpdateUserRequest.md)
214242
- [Model.User](docs/User.md)
215243
- [Model.UserIdentityBody](docs/UserIdentityBody.md)

docs/ApiKeyToken.md

Lines changed: 15 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,15 @@
1+
# OneSignalApi.Model.ApiKeyToken
2+
3+
## Properties
4+
5+
Name | Type | Description | Notes
6+
------------ | ------------- | ------------- | -------------
7+
**TokenId** | **string** | | [optional]
8+
**UpdatedAt** | **string** | | [optional]
9+
**CreatedAt** | **string** | | [optional]
10+
**Name** | **string** | | [optional]
11+
**IpAllowlistMode** | **string** | | [optional]
12+
**IpAllowlist** | **List&lt;string&gt;** | | [optional]
13+
14+
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
15+

docs/ApiKeyTokensListResponse.md

Lines changed: 10 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,10 @@
1+
# OneSignalApi.Model.ApiKeyTokensListResponse
2+
3+
## Properties
4+
5+
Name | Type | Description | Notes
6+
------------ | ------------- | ------------- | -------------
7+
**Tokens** | [**List&lt;ApiKeyToken&gt;**](ApiKeyToken.md) | | [optional]
8+
9+
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
10+

docs/CopyTemplateRequest.md

Lines changed: 10 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,10 @@
1+
# OneSignalApi.Model.CopyTemplateRequest
2+
3+
## Properties
4+
5+
Name | Type | Description | Notes
6+
------------ | ------------- | ------------- | -------------
7+
**TargetAppId** | **string** | Destination OneSignal App ID in UUID v4 format. |
8+
9+
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
10+

docs/CreateApiKeyRequest.md

Lines changed: 12 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,12 @@
1+
# OneSignalApi.Model.CreateApiKeyRequest
2+
3+
## Properties
4+
5+
Name | Type | Description | Notes
6+
------------ | ------------- | ------------- | -------------
7+
**Name** | **string** | | [optional]
8+
**IpAllowlistMode** | **string** | | [optional]
9+
**IpAllowlist** | **List&lt;string&gt;** | | [optional]
10+
11+
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
12+

docs/CreateApiKeyResponse.md

Lines changed: 11 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,11 @@
1+
# OneSignalApi.Model.CreateApiKeyResponse
2+
3+
## Properties
4+
5+
Name | Type | Description | Notes
6+
------------ | ------------- | ------------- | -------------
7+
**TokenId** | **string** | | [optional]
8+
**FormattedToken** | **string** | | [optional]
9+
10+
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
11+

docs/CreateTemplateRequest.md

Lines changed: 17 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,17 @@
1+
# OneSignalApi.Model.CreateTemplateRequest
2+
3+
## Properties
4+
5+
Name | Type | Description | Notes
6+
------------ | ------------- | ------------- | -------------
7+
**AppId** | **string** | Your OneSignal App ID in UUID v4 format. |
8+
**Name** | **string** | Name of the template. |
9+
**Contents** | [**LanguageStringMap**](LanguageStringMap.md) | |
10+
**IsEmail** | **bool** | Set true for an Email template. | [optional]
11+
**EmailSubject** | **string** | Subject of the email. | [optional]
12+
**EmailBody** | **string** | Body of the email (HTML supported). | [optional]
13+
**IsSMS** | **bool** | Set true for an SMS template. | [optional]
14+
**DynamicContent** | **string** | JSON string for dynamic content personalization. | [optional]
15+
16+
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
17+

docs/CustomEvent.md

Lines changed: 14 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,14 @@
1+
# OneSignalApi.Model.CustomEvent
2+
3+
## Properties
4+
5+
Name | Type | Description | Notes
6+
------------ | ------------- | ------------- | -------------
7+
**Name** | **string** | The identifier or name of the event. Maximum 128 characters. |
8+
**ExternalId** | **string** | The external ID of the user targeted for the event. Either the user&#39;s External ID or OneSignal ID is required. | [optional]
9+
**OnesignalId** | **string** | The OneSignal ID of the user targeted for the event. Either the user&#39;s External ID or OneSignal ID is required. | [optional]
10+
**Timestamp** | **DateTime** | Time the event occurred as an ISO8601 formatted string. Defaults to now if not included or past date provided. | [optional]
11+
**Payload** | **Dictionary&lt;string, Object&gt;** | Properties or data related to the event, like {\&quot;geography\&quot;: \&quot;USA\&quot;} | [optional]
12+
13+
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
14+

docs/CustomEventsRequest.md

Lines changed: 10 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,10 @@
1+
# OneSignalApi.Model.CustomEventsRequest
2+
3+
## Properties
4+
5+
Name | Type | Description | Notes
6+
------------ | ------------- | ------------- | -------------
7+
**Events** | [**List&lt;CustomEvent&gt;**](CustomEvent.md) | |
8+
9+
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
10+

0 commit comments

Comments
 (0)