Skip to content

Commit

Permalink
Update .NET API
Browse files Browse the repository at this point in the history
  • Loading branch information
OneSignal committed Aug 1, 2023
1 parent 7ed733c commit 3cff572
Show file tree
Hide file tree
Showing 110 changed files with 778 additions and 1,134 deletions.
14 changes: 8 additions & 6 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,8 +2,8 @@

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

- API version: 1.2.1
- SDK version: 2.0.0
- API version: 1.2.2
- SDK version: 2.0.2
- Build package: org.openapitools.codegen.languages.CSharpNetCoreClientCodegen
For more information, please visit [https://onesignal.com](https://onesignal.com)

Expand Down Expand Up @@ -140,7 +140,8 @@ Class | Method | HTTP request | Description
*DefaultApi* | [**DeleteSubscription**](docs/DefaultApi.md#deletesubscription) | **DELETE** /apps/{app_id}/subscriptions/{subscription_id} |
*DefaultApi* | [**DeleteUser**](docs/DefaultApi.md#deleteuser) | **DELETE** /apps/{app_id}/users/by/{alias_label}/{alias_id} |
*DefaultApi* | [**EndLiveActivity**](docs/DefaultApi.md#endliveactivity) | **DELETE** /apps/{app_id}/live_activities/{activity_id}/token/{subscription_id} | Stop Live Activity
*DefaultApi* | [**ExportPlayers**](docs/DefaultApi.md#exportplayers) | **POST** /players/csv_export?app_id={app_id} | CSV export
*DefaultApi* | [**ExportEvents**](docs/DefaultApi.md#exportevents) | **POST** /notifications/{notification_id}/export_events?app_id={app_id} | Export CSV of Events
*DefaultApi* | [**ExportPlayers**](docs/DefaultApi.md#exportplayers) | **POST** /players/csv_export?app_id={app_id} | Export CSV of Players
*DefaultApi* | [**FetchAliases**](docs/DefaultApi.md#fetchaliases) | **GET** /apps/{app_id}/subscriptions/{subscription_id}/user/identity |
*DefaultApi* | [**FetchUser**](docs/DefaultApi.md#fetchuser) | **GET** /apps/{app_id}/users/by/{alias_label}/{alias_id} |
*DefaultApi* | [**FetchUserIdentity**](docs/DefaultApi.md#fetchuseridentity) | **GET** /apps/{app_id}/users/by/{alias_label}/{alias_id}/identity |
Expand Down Expand Up @@ -168,7 +169,6 @@ Class | Method | HTTP request | Description
## Documentation for Models

- [Model.App](docs/App.md)
- [Model.BadRequestError](docs/BadRequestError.md)
- [Model.BasicNotification](docs/BasicNotification.md)
- [Model.BasicNotificationAllOf](docs/BasicNotificationAllOf.md)
- [Model.BasicNotificationAllOfAndroidBackgroundLayout](docs/BasicNotificationAllOfAndroidBackgroundLayout.md)
Expand All @@ -188,13 +188,14 @@ Class | Method | HTTP request | Description
- [Model.DeleteSegmentNotFoundResponse](docs/DeleteSegmentNotFoundResponse.md)
- [Model.DeleteSegmentSuccessResponse](docs/DeleteSegmentSuccessResponse.md)
- [Model.DeliveryData](docs/DeliveryData.md)
- [Model.ExportEventsSuccessResponse](docs/ExportEventsSuccessResponse.md)
- [Model.ExportPlayersRequestBody](docs/ExportPlayersRequestBody.md)
- [Model.ExportPlayersSuccessResponse](docs/ExportPlayersSuccessResponse.md)
- [Model.Filter](docs/Filter.md)
- [Model.FilterExpressions](docs/FilterExpressions.md)
- [Model.GenericError](docs/GenericError.md)
- [Model.GenericErrorErrorsInner](docs/GenericErrorErrorsInner.md)
- [Model.GetNotificationRequestBody](docs/GetNotificationRequestBody.md)
- [Model.IdentifyUserConflictResponse](docs/IdentifyUserConflictResponse.md)
- [Model.IdentifyUserConflictResponseErrorsInner](docs/IdentifyUserConflictResponseErrorsInner.md)
- [Model.InlineResponse200](docs/InlineResponse200.md)
- [Model.InlineResponse2003](docs/InlineResponse2003.md)
- [Model.InlineResponse201](docs/InlineResponse201.md)
Expand All @@ -221,6 +222,7 @@ Class | Method | HTTP request | Description
- [Model.PropertiesDeltas](docs/PropertiesDeltas.md)
- [Model.PropertiesObject](docs/PropertiesObject.md)
- [Model.Purchase](docs/Purchase.md)
- [Model.RateLimiterError](docs/RateLimiterError.md)
- [Model.Segment](docs/Segment.md)
- [Model.SegmentNotificationTarget](docs/SegmentNotificationTarget.md)
- [Model.StringMap](docs/StringMap.md)
Expand Down
3 changes: 3 additions & 0 deletions docs/BasicNotification.md
Original file line number Diff line number Diff line change
Expand Up @@ -104,9 +104,12 @@ Name | Type | Description | Notes
**EmailBody** | **string** | Channel: Email Required unless template_id is set. HTML suported The body of the email you wish to send. Typically, customers include their own HTML templates here. Must include [unsubscribe_url] in an <a> tag somewhere in the email. Note: any malformed HTML content will be sent to users. Please double-check your HTML is valid. | [optional]
**EmailFromName** | **string** | Channel: Email The name the email is from. If not specified, will default to \"from name\" set in the OneSignal Dashboard Email Settings. | [optional]
**EmailFromAddress** | **string** | Channel: Email The email address the email is from. If not specified, will default to \"from email\" set in the OneSignal Dashboard Email Settings. | [optional]
**EmailPreheader** | **string** | Channel: Email The preheader text of the email. Preheader is the preview text displayed immediately after an email subject that provides additional context about the email content. If not specified, will default to null. | [optional]
**IncludeUnsubscribed** | **bool** | Channel: Email Default is `false`. This field is used to send transactional notifications. If set to `true`, this notification will also be sent to unsubscribed emails. If a `template_id` is provided, the `include_unsubscribed` value from the template will be inherited. If you are using a third-party ESP, this field requires the ESP's list of unsubscribed emails to be cleared. | [optional]
**SmsFrom** | **string** | Channel: SMS Phone Number used to send SMS. Should be a registered Twilio phone number in E.164 format. | [optional]
**SmsMediaUrls** | **List<string>** | Channel: SMS URLs for the media files to be attached to the SMS content. Limit: 10 media urls with a total max. size of 5MBs. | [optional]
**Filters** | [**List<Filter>**](Filter.md) | | [optional]
**CustomData** | **Object** | Channel: All JSON object that can be used as a source of message personalization data for fields that support tag variable substitution. Push, SMS: Can accept up to 2048 bytes of valid JSON. Email: Can accept up to 10000 bytes of valid JSON. Example: {\"order_id\": 123, \"currency\": \"USD\", \"amount\": 25} | [optional]

[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)

3 changes: 3 additions & 0 deletions docs/BasicNotificationAllOf.md
Original file line number Diff line number Diff line change
Expand Up @@ -90,9 +90,12 @@ Name | Type | Description | Notes
**EmailBody** | **string** | Channel: Email Required unless template_id is set. HTML suported The body of the email you wish to send. Typically, customers include their own HTML templates here. Must include [unsubscribe_url] in an <a> tag somewhere in the email. Note: any malformed HTML content will be sent to users. Please double-check your HTML is valid. | [optional]
**EmailFromName** | **string** | Channel: Email The name the email is from. If not specified, will default to \"from name\" set in the OneSignal Dashboard Email Settings. | [optional]
**EmailFromAddress** | **string** | Channel: Email The email address the email is from. If not specified, will default to \"from email\" set in the OneSignal Dashboard Email Settings. | [optional]
**EmailPreheader** | **string** | Channel: Email The preheader text of the email. Preheader is the preview text displayed immediately after an email subject that provides additional context about the email content. If not specified, will default to null. | [optional]
**IncludeUnsubscribed** | **bool** | Channel: Email Default is `false`. This field is used to send transactional notifications. If set to `true`, this notification will also be sent to unsubscribed emails. If a `template_id` is provided, the `include_unsubscribed` value from the template will be inherited. If you are using a third-party ESP, this field requires the ESP's list of unsubscribed emails to be cleared. | [optional]
**SmsFrom** | **string** | Channel: SMS Phone Number used to send SMS. Should be a registered Twilio phone number in E.164 format. | [optional]
**SmsMediaUrls** | **List<string>** | Channel: SMS URLs for the media files to be attached to the SMS content. Limit: 10 media urls with a total max. size of 5MBs. | [optional]
**Filters** | [**List<Filter>**](Filter.md) | | [optional]
**CustomData** | **Object** | Channel: All JSON object that can be used as a source of message personalization data for fields that support tag variable substitution. Push, SMS: Can accept up to 2048 bytes of valid JSON. Email: Can accept up to 10000 bytes of valid JSON. Example: {\"order_id\": 123, \"currency\": \"USD\", \"amount\": 25} | [optional]

[[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 changes: 0 additions & 11 deletions docs/CreateSegmentBadRequestResponse.md

This file was deleted.

Loading

0 comments on commit 3cff572

Please sign in to comment.