Skip to content

Commit

Permalink
yarn pages
Browse files Browse the repository at this point in the history
  • Loading branch information
dphuang2 committed Mar 28, 2024
1 parent 8802d4a commit 5c34304
Show file tree
Hide file tree
Showing 20 changed files with 5,664 additions and 286 deletions.
6 changes: 6 additions & 0 deletions generator/konfig-docs/redirects.json
Original file line number Diff line number Diff line change
Expand Up @@ -39,6 +39,12 @@
"/sdk/brex/webhooks/": "/sdk/brex/webhooks/typescript/",
"/sdk/cornerstone-on-demand/talent-link": "/sdk/cornerstone-on-demand/talent-link/typescript/",
"/sdk/cornerstone-on-demand/talent-link/": "/sdk/cornerstone-on-demand/talent-link/typescript/",
"/sdk/customer-io/data-pipelines": "/sdk/customer-io/data-pipelines/typescript/",
"/sdk/customer-io/data-pipelines/": "/sdk/customer-io/data-pipelines/typescript/",
"/sdk/customer-io/journeys-app": "/sdk/customer-io/journeys-app/typescript/",
"/sdk/customer-io/journeys-app/": "/sdk/customer-io/journeys-app/typescript/",
"/sdk/customer-io/journeys-track": "/sdk/customer-io/journeys-track/typescript/",
"/sdk/customer-io/journeys-track/": "/sdk/customer-io/journeys-track/typescript/",
"/sdk/cyber-ark/conjur": "/sdk/cyber-ark/conjur/typescript/",
"/sdk/cyber-ark/conjur/": "/sdk/cyber-ark/conjur/typescript/",
"/sdk/dropbox/sign": "/sdk/dropbox/sign/typescript/",
Expand Down
81 changes: 81 additions & 0 deletions generator/konfig-docs/src/pages/sdk/bulk-sms-com/index.tsx
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.`}
/>
)
}
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()
```
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 &gt; Developer Settings &gt; 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"
})
```
Loading

0 comments on commit 5c34304

Please sign in to comment.