-
Notifications
You must be signed in to change notification settings - Fork 376
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
Showing
20 changed files
with
5,664 additions
and
286 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
81 changes: 81 additions & 0 deletions
81
generator/konfig-docs/src/pages/sdk/bulk-sms-com/index.tsx
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,81 @@ | ||
import React from 'react'; | ||
import { Company } from '../../../components/Company'; | ||
|
||
const sdks = [ | ||
{ | ||
"name": "BulkSMS.com", | ||
"numberOfMethods": 15, | ||
"categories": [ | ||
"messaging", | ||
"sms", | ||
"communications", | ||
"sms_api", | ||
"sms_messaging", | ||
"personalised_sms_messaging", | ||
"scheduled_sms_messaging", | ||
"sms_software" | ||
], | ||
"index": "bulk-sms-com/typescript", | ||
"language": "TypeScript", | ||
"link": "/sdk/bulk-sms-com/typescript/", | ||
"developerDocumentation": "www.bulksms.com/developer/json/v1/#", | ||
"openapiGitHubUi": "https://github.com/konfig-sdks/openapi-examples/tree/HEAD/bulksms-com/openapi.yaml" | ||
}, | ||
{ | ||
"name": "BulkSMS.com", | ||
"numberOfMethods": 15, | ||
"categories": [ | ||
"messaging", | ||
"sms", | ||
"communications", | ||
"sms_api", | ||
"sms_messaging", | ||
"personalised_sms_messaging", | ||
"scheduled_sms_messaging", | ||
"sms_software" | ||
], | ||
"index": "bulk-sms-com/python", | ||
"language": "Python", | ||
"link": "/sdk/bulk-sms-com/python/", | ||
"developerDocumentation": "www.bulksms.com/developer/json/v1/#", | ||
"openapiGitHubUi": "https://github.com/konfig-sdks/openapi-examples/tree/HEAD/bulksms-com/openapi.yaml" | ||
}, | ||
{ | ||
"name": "BulkSMS.com", | ||
"numberOfMethods": 15, | ||
"categories": [ | ||
"messaging", | ||
"sms", | ||
"communications", | ||
"sms_api", | ||
"sms_messaging", | ||
"personalised_sms_messaging", | ||
"scheduled_sms_messaging", | ||
"sms_software" | ||
], | ||
"index": "bulk-sms-com/java", | ||
"language": "Java", | ||
"link": "/sdk/bulk-sms-com/java/", | ||
"developerDocumentation": "www.bulksms.com/developer/json/v1/#", | ||
"openapiGitHubUi": "https://github.com/konfig-sdks/openapi-examples/tree/HEAD/bulksms-com/openapi.yaml" | ||
} | ||
]; | ||
|
||
export default function BulkSmsCom() { | ||
const allCategories: string[] = Array.from( | ||
new Set(sdks.flatMap((service) => service.categories)), | ||
) | ||
return ( | ||
<Company | ||
company="BulkSMS.com" | ||
previewLinkImage="https://raw.githubusercontent.com/konfig-sdks/openapi-examples/HEAD/bulksms-com/imagePreview.png" | ||
logo="https://raw.githubusercontent.com/konfig-sdks/openapi-examples/HEAD/bulksms-com/logo.png" | ||
favicon="https://raw.githubusercontent.com/konfig-sdks/openapi-examples/HEAD/bulksms-com/favicon.png" | ||
sdks={sdks} | ||
homepage="www.bulksms.com/" | ||
companyKebabCase="bulk-sms-com" | ||
categories={allCategories} | ||
metaDescription={`BulkSMS.com is a leading SMS messaging service provider offering two-way SMS communications. The BulkSMS gateway reaches across borders and connects to over 800 mobile network operators worldwide.`} | ||
/> | ||
) | ||
} |
4 changes: 4 additions & 0 deletions
4
generator/konfig-docs/src/pages/sdk/bulk-sms-com/typescript/_first-request.mdx
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,4 @@ | ||
```typescript index.ts | ||
// List blocked numbers | ||
const listRetrievalResponse = bulkSmsCom.blockedNumbers.listRetrieval() | ||
``` |
33 changes: 33 additions & 0 deletions
33
generator/konfig-docs/src/pages/sdk/bulk-sms-com/typescript/_getting-started.mdx
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,33 @@ | ||
```typescript index.ts | ||
import { BulkSmsCom } from 'bulk-sms-com-typescript-sdk'; | ||
|
||
const bulkSmsCom = new BulkSmsCom({ | ||
/* | ||
* The API uses HTTP Basic Auth for authentication. | ||
* | ||
* You are requested to preemptively provide the `Authorization` header in your requests and not wait until the server has provided a `401 Unauthorized` response. | ||
* | ||
* Doing so will reduce the number of requests required to achieve your goal, which will improve overall performance. | ||
* | ||
* You authenticate using either the username you supplied when you registered with [BulkSMS](https://www.bulksms.com) or with an _API Token_. API tokens can be created by logging into your account and visiting _Settings > Developer Settings > API Tokens_. | ||
* | ||
* __Important:__ | ||
* - Where possible, use an API Token instead of the username and password when writing software against the API. | ||
* | ||
* Whether you use a username or an API Token, the values must be [Base64 encoded](https://en.wikipedia.org/wiki/Base64) before using it in the header. | ||
* For example, if the username is `Aladdin` and the password is `OpenSesame`, the unencoded header value is `Aladdin:OpenSesame`. After encoding, the full header becomes | ||
* | ||
* ``` | ||
* Authorization: Basic QWxhZGRpbjpPcGVuU2VzYW1l | ||
* ``` | ||
* When using an API token, the value to be encoded will be `<token-id>:<token-secret>`. These values _before Base64 encoding_ look something like this | ||
* | ||
* ` | ||
* BBDE1B476E03498AA768F66A286AABDC-01-B:9jSbVDK20!MXdfRGiIIFu#ffUE8*S | ||
* ` | ||
* | ||
*/ | ||
username: "USERNAME", | ||
password: "PASSWORD" | ||
}) | ||
``` |
Oops, something went wrong.