Skip to content

Commit 918afc4

Browse files
author
abdullahmansss
committed
version 1.2.0
1 parent e0f2098 commit 918afc4

27 files changed

+1253
-50
lines changed

‎CHANGELOG.md‎

Lines changed: 109 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,113 @@
11
# Changelog
22

3+
## August 1, 2024 - v1.2.0
4+
5+
### 1. new methods added
6+
7+
#### 1.2. Paraphrase text: `paraphrase()`
8+
Generates a paraphrased version of the provided text.
9+
10+
[Check Documentation](https://documenter.getpostman.com/view/31106842/2s9Ye8faUp#aea28008-ac67-4245-a79b-26788bce3f44)
11+
12+
#### 1.2 Proofread & Grammar Check: `proofread()`
13+
14+
Proofreads (and checks grammar) of the provided text.
15+
16+
[Check Documentation](https://documenter.getpostman.com/view/31106842/2s9Ye8faUp#dcb4a490-1243-4001-93fc-652c570dbcd7)
17+
18+
#### 1.3 Subscription Info / Quota Check: `quota()`
19+
20+
Endpoint to check details regarding the subscription's current period.
21+
22+
```json
23+
{
24+
"timestamp": "2024-03-19T12:49:41.445736Z",
25+
"on_trial": false,
26+
"trial_ends": "2024-03-17T07:57:46.000000Z",
27+
"subscribed": true,
28+
"current_subscription_start": "2024-03-18T12:37:39.000000Z",
29+
"current_subscription_end": "2024-04-18T12:37:39.000000Z",
30+
"subscription_words_quota": 100000,
31+
"subscription_words_used": 9608,
32+
"subscription_words_used_percentage": 0.1
33+
}
34+
```
35+
* "subscription_words_used_percentage" is a percentage of current monthly quota usage
36+
* and might serve as an alert to the user of the depleted credits.
37+
* With a value above 80%, it's advised to subscribe to more credits
38+
* at https://sharpapi.com/dashboard/credits to avoid service disruption.
39+
40+
[Check Documentation](https://documenter.getpostman.com/view/31106842/2s9Ye8faUp#7c401a21-8354-4589-a20a-573d1ae00d65)
41+
42+
#### 1.4 Subscription Info / Quota Check: `ping()`
43+
44+
Simple PING endpoint to check the availability of the API and its internal time zone (timestamp).
45+
46+
```json
47+
{
48+
"ping": "pong",
49+
"timestamp": "2024-03-12T08:50:11.188308Z"
50+
}
51+
```
52+
53+
[Check Documentation](https://documenter.getpostman.com/view/31106842/2s9Ye8faUp#12a4aa9e-15cd-49a9-84ff-204ddc1116a3)
54+
55+
### 2. New Parameters added
56+
57+
#### 2.1 `max_quantity` - allows to limit the amount of returned items
58+
59+
**Added to methods:**
60+
- E-commerce > Product Categories / `productCategories()`
61+
- Travel, Tourism & Hospitality > Tours & Activities Product Categories / `toursAndActivitiesProductCategories()`
62+
- Travel, Tourism & Hospitality > Hospitality Product Categories / `hospitalityProductCategories()`
63+
- HR Tech > Related Job Positions / `relatedJobPositions()`
64+
- HR Tech > Related Skills / `relatedSkills()`
65+
66+
#### 2.2 `max_length` - allows to instruct AI model to limit the output of generated text
67+
68+
Please keep in mind that max_length serves as a strong suggestion for the Language Model,
69+
rather than a strict requirement, to maintain the general sense of the outcome.
70+
71+
**Added to methods:**
72+
- E-commerce > Generate Product Intro / `generateProductIntro()`
73+
- E-commerce > Generate Thank You E-mail / `generateThankYouEmail()`
74+
- Content & Marketing Automation > Summarize Content / `summarizeText()`
75+
- Content & Marketing Automation > Paraphrase Text / `paraphrase()`
76+
77+
#### 2.3 `voice_tone` - Tone of voice of the generated text
78+
79+
You can set your preferred writing style by providing
80+
an optional voice_tone parameter. It can be adjectives like
81+
`funny` or `joyous`, or even the name of a famous writer.
82+
You can provide multiple tones at the same time.
83+
84+
**Added to methods:**
85+
- SEO > Generate SEO Tags / `generateSeoTags()`
86+
- Content & Marketing Automation > Generate Keywords/Tags / `generateKeywords()`
87+
- Content & Marketing Automation > Summarize Content / `summarizeText()`
88+
- Content & Marketing Automation > Paraphrase Text / `paraphrase()`
89+
- Content & Marketing Automation > Translate Text / `translate()`
90+
- Travel, Tourism & Hospitality > Tours & Activities Product Categories / `toursAndActivitiesProductCategories()`
91+
- Travel, Tourism & Hospitality > Hospitality Product Categories / `hospitalityProductCategories()`
92+
- HR Tech > Generate Job Description / `generateJobDescription()`
93+
- E-commerce > Product Categories / `productCategories()`
94+
- E-commerce > Generate Product Intro / `generateProductIntro()`
95+
- E-commerce > Generate Thank You E-mail / `generateThankYouEmail()`
96+
97+
#### 2.4 `context` - adds more context/instructions for content processing
98+
99+
**Added to methods:**
100+
- HR Tech > Generate Job Description / `generateJobDescription()`
101+
- E-commerce > Generate Thank You E-mail / `generateThankYouEmail()`
102+
- E-commerce > Product Categories / `productCategories()`
103+
- Travel, Tourism & Hospitality > Tours & Activities Product Categories / `toursAndActivitiesProductCategories()`
104+
- Travel, Tourism & Hospitality > Hospitality Product Categories / `hospitalityProductCategories()`
105+
- Content & Marketing Automation > Translate Text / `translate()`
106+
- Content & Marketing Automation > Paraphrase Text / `paraphrase()`
107+
108+
### 3.0 Moving to individual job result endpoints, each with separate data formats.
109+
110+
## March 5, 2024 - v1.0.0
3111
- v1.0.0 initial release
4112

5-
All notable changes to `sharpapi-flutter-client` will be documented in this file.
113+
All notable changes to `sharpapi-flutter-client` will be documented in this file.

‎LICENSE.md‎

Lines changed: 21 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,21 @@
1+
The MIT License (MIT)
2+
3+
Copyright (c) SharpAPI <[email protected]>
4+
5+
Permission is hereby granted, free of charge, to any person obtaining a copy
6+
of this software and associated documentation files (the "Software"), to deal
7+
in the Software without restriction, including without limitation the rights
8+
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
9+
copies of the Software, and to permit persons to whom the Software is
10+
furnished to do so, subject to the following conditions:
11+
12+
The above copyright notice and this permission notice shall be included in
13+
all copies or substantial portions of the Software.
14+
15+
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
16+
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
17+
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
18+
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
19+
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
20+
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
21+
THE SOFTWARE.

‎README.md‎

Lines changed: 101 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -242,6 +242,49 @@ so you can personalize the rest of the email easily.
242242

243243
### Content
244244

245+
#### Paraphrase / Rephrase Text
246+
247+
Generates a paraphrased version of the provided text.
248+
Only the `content` parameter is required. You can define the output language,
249+
maximum character length, and tone of voice.
250+
251+
Additional instructions on how to process the text can be provided in the context parameter.
252+
Please keep in mind that `max_length` serves as a strong suggestion
253+
for the Language Model, rather than a strict requirement,
254+
to maintain the general sense of the outcome.
255+
256+
You can set your preferred writing style by providing an optional `voice_tone` parameter.
257+
It can be adjectives like `funny` or `joyous`, or even the name of a famous writer.
258+
259+
This API method also provides an optional `context` parameter,
260+
which can be used to supply additional flexible instructions for content processing.
261+
262+
```dart
263+
///*** paraphrase text
264+
SharpApi.paraphrase(
265+
text: 'ANY_TEXT',
266+
).then((value) {
267+
/// do something with the [value] here
268+
}).catchError((error) {
269+
/// do something with the [error] here
270+
});
271+
```
272+
273+
#### Proofread Text + Grammar Check
274+
275+
Proofreads (and checks grammar) a provided text.
276+
277+
```dart
278+
///*** proofread text
279+
SharpApi.proofread(
280+
text: 'ANY_TEXT',
281+
).then((value) {
282+
/// do something with the [value] here
283+
}).catchError((error) {
284+
/// do something with the [error] here
285+
});
286+
```
287+
245288
#### Translate Text
246289

247290
Translates provided text to selected language. 80 languages are supported.
@@ -421,6 +464,64 @@ Only first parameter `productName` is required.
421464
});
422465
```
423466

467+
### 🤖 Technical API Endpoints
468+
469+
#### Subscription information / quota check
470+
Endpoint to check details regarding the subscription's current period
471+
472+
```dart
473+
///*** quota
474+
SharpApi.quota().then((value) {
475+
/// do something with the [value] here
476+
}).catchError((error) {
477+
/// do something with the [error] here
478+
});
479+
```
480+
481+
will result in:
482+
```json
483+
{
484+
"timestamp": "2024-03-19T12:49:41.445736Z",
485+
"on_trial": false,
486+
"trial_ends": "2024-03-17T07:57:46.000000Z",
487+
"subscribed": true,
488+
"current_subscription_start": "2024-03-18T12:37:39.000000Z",
489+
"current_subscription_end": "2024-04-18T12:37:39.000000Z",
490+
"subscription_words_quota": 100000,
491+
"subscription_words_used": 9608,
492+
"subscription_words_used_percentage": 0.1
493+
}
494+
```
495+
496+
`subscription_words_used_percentage` is a percentage of current monthly quota usage
497+
and might serve as an alert to the user of the depleted credits.
498+
With a value above 80%, it's advised to subscribe to more credits
499+
at https://sharpapi.com/dashboard/credits to avoid service disruption.
500+
501+
These values are also available in the Dashboard at https://sharpapi.com/dashboard
502+
503+
#### Ping
504+
Simple PING endpoint to check the availability of the API and it's internal timze zone (timestamp).
505+
506+
```dart
507+
///*** ping
508+
SharpApi.ping().then((value) {
509+
/// do something with the [value] here
510+
}).catchError((error) {
511+
/// do something with the [error] here
512+
});
513+
```
514+
515+
will result in:
516+
```json
517+
{
518+
"ping": "pong",
519+
"timestamp": "2024-03-12T08:50:11.188308Z"
520+
}
521+
```
522+
523+
---
524+
424525
### Do you think our API is missing some obvious functionality?
425526

426527
[Please let us know»](https://github.com/sharpapi/sharpapi-php-client/issues)

‎example/ios/Podfile.lock‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -66,4 +66,4 @@ SPEC CHECKSUMS:
6666

6767
PODFILE CHECKSUM: 819463e6a0290f5a72f145ba7cde16e8b6ef0796
6868

69-
COCOAPODS: 1.11.3
69+
COCOAPODS: 1.15.2

‎example/ios/Runner.xcodeproj/project.pbxproj‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -216,7 +216,7 @@
216216
isa = PBXProject;
217217
attributes = {
218218
BuildIndependentTargetsInParallel = YES;
219-
LastUpgradeCheck = 1430;
219+
LastUpgradeCheck = 1510;
220220
ORGANIZATIONNAME = "";
221221
TargetAttributes = {
222222
331C8080294A63A400263BE5 = {

‎example/ios/Runner.xcodeproj/xcshareddata/xcschemes/Runner.xcscheme‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
<?xml version="1.0" encoding="UTF-8"?>
22
<Scheme
3-
LastUpgradeVersion = "1430"
3+
LastUpgradeVersion = "1510"
44
version = "1.3">
55
<BuildAction
66
parallelizeBuildables = "YES"

0 commit comments

Comments
 (0)