Skip to content

Commit

Permalink
Merge pull request #3 from OneSignal/api
Browse files Browse the repository at this point in the history
Dependency Update
  • Loading branch information
brismithers committed May 18, 2022
2 parents c456b91 + f3f05fe commit 68a554f
Show file tree
Hide file tree
Showing 107 changed files with 891 additions and 743 deletions.
25 changes: 25 additions & 0 deletions .github/ISSUE_TEMPLATE/ask-question.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,25 @@
name: 🙋‍♂️ Ask a question
description: Tell us what's on your mind
title: "[question]: "
labels: ["triage"]
body:
- type: markdown
attributes:
value: |
Having issues integrating this API library?
- type: textarea
id: question
attributes:
label: How can we help?
description: Specific question regarding integrating this API library.
placeholder: How do I...?
validations:
required: true
- type: checkboxes
id: terms
attributes:
label: Code of Conduct
description: By submitting this issue, you agree to follow our [Code of Conduct](https://github.com/OneSignal/api/blob/main/CONTRIBUTING.md)
options:
- label: I agree to follow this project's Code of Conduct
required: true
51 changes: 51 additions & 0 deletions .github/ISSUE_TEMPLATE/bug-report.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,51 @@
name: 🪳 Bug report
description: File a bug report
title: "[Bug]: "
labels: ["bug", "triage"]
body:
- type: markdown
attributes:
value: |
Thanks for taking the time to fill out this bug report!
- type: textarea
id: what-happened
attributes:
label: What happened?
description: Provide a thorough description of whats going on.
placeholder: The latest version of the API library throws an exception when creating a notification targetting all Active Users.
validations:
required: true
- type: textarea
id: reproduction-steps
attributes:
label: Steps to reproduce?
description: Provide as much detail as posible to reproduce the issue.
placeholder: |
1. Install vX.Y.Z of dependency
2. Run provided code snippet
3. Note that the app crashes
render: Markdown
validations:
required: true
- type: textarea
id: what-are-expectations
attributes:
label: What did you expect to happen?
description: Also tell us, what did you expect to happen?
placeholder: I expected the API library to properly deserialize any response returned by OneSignal.
validations:
required: true
- type: textarea
id: logs
attributes:
label: Relevant log output
description: Please copy and paste any relevant log output. This will be automatically formatted into code, so no need for backticks.
render: Shell
- type: checkboxes
id: terms
attributes:
label: Code of Conduct
description: By submitting this issue, you agree to follow our [Code of Conduct](https://github.com/OneSignal/api/blob/main/CONTRIBUTING.md)
options:
- label: I agree to follow this project's Code of Conduct
required: true
25 changes: 25 additions & 0 deletions .github/ISSUE_TEMPLATE/general-feedback.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,25 @@
name: 📣 General feedback
description: Tell us what's on your mind
title: "[Bug]: "
labels: ["triage"]
body:
- type: markdown
attributes:
value: |
Thanks for sharing your valuable feedback!
- type: textarea
id: feedback
attributes:
label: What's on your mind?
description: Feedback regarding this API library.
placeholder: Share your feedback...
validations:
required: true
- type: checkboxes
id: terms
attributes:
label: Code of Conduct
description: By submitting this issue, you agree to follow our [Code of Conduct](https://github.com/OneSignal/api/blob/main/CONTRIBUTING.md)
options:
- label: I agree to follow this project's Code of Conduct
required: true
44 changes: 44 additions & 0 deletions .github/PULL_REQUEST_TEMPLATE/pull_request_template.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,44 @@
<!-- START -->
# READ AND DELETE THIS SECTION BEFORE SUBMITTING PR
* **Fill out each _REQUIRED_ section**
* **Fill out _OPTIONAL_ sections, remove section if it doesn't apply to your PR**
* **Read and fill out each of the checklists below**
* **Remove this section after reading**
<!-- END -->

# Description
## One Line Summary
**REQUIRED** - Very short description that summaries the changes in this PR.

## Details

### Motivation
**REQUIRED -** Why is this code change being made? Or what is the goal of this PR? Examples: Fixes a specific bug, provides additional logging to debug future issues, feature to allow X.

### Scope
**RECOMMEND - OPTIONAL -** What is intended to be effected. What is known not to change. Example: Notifications are grouped when parameter X is set, not enabled by default.

### OPTIONAL - Other
**OPTIONAL -** Feel free to add any other sections or sub-sections that can explain your PR better.

# Testing

## Manual testing
**REQUIRED -** Explain what scenarios were tested and the environment.


# Checklist
## Overview
- [ ] I have filled out all **REQUIRED** sections above
- [ ] PR does one thing
- If it is hard to explain how any codes changes are related to each other then it most likely needs to be more than one PR
- [ ] Any Public API changes are explained in the PR details and conform to existing APIs

## Testing
- [ ] I have personally tested this on my device, or explained why that is not possible

## Final pass
- [ ] Code is as readable as possible.
- Simplify with less code, followed by splitting up code into well named functions and variables, followed by adding comments to the code.
- [ ] I have reviewed this PR myself, ensuring it meets each checklist item
- WIP (Work In Progress) is ok, but explain what is still in progress and what you would like feedback on. Start the PR title with "WIP" to indicate this.
2 changes: 1 addition & 1 deletion OneSignalSDK.Server.sln → OneSignalApi.sln
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@ Microsoft Visual Studio Solution File, Format Version 12.00
# Visual Studio 14
VisualStudioVersion = 14.0.25420.1
MinimumVisualStudioVersion = 10.0.40219.1
Project("{FAE04EC0-301F-11D3-BF4B-00C04F79EFBC}") = "OneSignalSDK.Server", "src\OneSignalSDK.Server\OneSignalSDK.Server.csproj", "{737BAB48-F05A-4CB4-B89F-277D51F30186}"
Project("{FAE04EC0-301F-11D3-BF4B-00C04F79EFBC}") = "OneSignalApi", "src\OneSignalApi\OneSignalApi.csproj", "{737BAB48-F05A-4CB4-B89F-277D51F30186}"
EndProject
Global
GlobalSection(SolutionConfigurationPlatforms) = preSolution
Expand Down
16 changes: 8 additions & 8 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,9 +1,9 @@
# OneSignalSDK.Server - the C# library for the OneSignal
# OneSignalApi - the C# library for the OneSignal

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

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

Expand Down Expand Up @@ -38,9 +38,9 @@ Generate the DLL using your preferred tool (e.g. `dotnet build`)

Then include the DLL (under the `bin` folder) in the C# project, and use the namespaces:
```csharp
using OneSignalSDK.Server.Api;
using OneSignalSDK.Server.Client;
using OneSignalSDK.Server.Model;
using OneSignalApi.Api;
using OneSignalApi.Client;
using OneSignalApi.Model;
```
<a name="usage"></a>
## Usage
Expand All @@ -59,9 +59,9 @@ c.Proxy = webProxy;
```csharp
using System.Collections.Generic;
using System.Diagnostics;
using OneSignalSDK.Server.Api;
using OneSignalSDK.Server.Client;
using OneSignalSDK.Server.Model;
using OneSignalApi.Api;
using OneSignalApi.Client;
using OneSignalApi.Model;

namespace Example
{
Expand Down
5 changes: 4 additions & 1 deletion RELEASE_INSTRUCTIONS.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,4 +5,7 @@
3. Build Release
* Run: `dotnet build --configuration Release`
4. Create NuGet Package
* Run: `dotnet pack --configuration Release`
* Run: `dotnet pack --configuration Release`
5. Publish NuGet Pakcage
* To publish version 0.1.0 of the package, run: `dotnet nuget push src/OneSignalApi/bin/Release/OneSignalApi.0.1.0.nupkg --source https://www.nuget.org/packages/OneSignalApi --api-key $NUGET_APIKEY`
* To publish a beta version, simply add `-beta1`, `-beta2` etc... after the semantic version (e.g: `OneSignalApi-0.1.0-beta1`)
2 changes: 1 addition & 1 deletion docs/App.md
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
# OneSignalSDK.Server.Model.App
# OneSignalApi.Model.App

## Properties

Expand Down
2 changes: 1 addition & 1 deletion docs/Button.md
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
# OneSignalSDK.Server.Model.Button
# OneSignalApi.Model.Button

## Properties

Expand Down
Loading

0 comments on commit 68a554f

Please sign in to comment.