Skip to content

Commit fcefd41

Browse files
abdullahmansssabdullahmansss
abdullahmansss
and
abdullahmansss
authored
1.2.0 (#2)
* version 1.2.0 * version 1.2.0 * version 1.2.0 * version 1.2.0 * version 1.2.0 --------- Co-authored-by: abdullahmansss <[email protected]>
1 parent e0f2098 commit fcefd41

27 files changed

+1366
-52
lines changed

‎CHANGELOG.md

+110-1
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,114 @@
11
# Changelog
22

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

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

‎LICENSE.md

+21
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.

0 commit comments

Comments
 (0)