Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

feat: Typescript and Python SDK DX + v1 #580

Draft
wants to merge 5 commits into
base: main
Choose a base branch
from
Draft

feat: Typescript and Python SDK DX + v1 #580

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
5 commits
Select commit Hold shift + click to select a range
f613a0c
feat: make public-token and api-version header to be common to every …
Nabhag8848 May 28, 2024
f9e3be2
feat: generate sdk locally under packages
Nabhag8848 May 28, 2024
337a8cc
fix: generators to have config, and revert fieldMappings and sync cha…
Nabhag8848 May 28, 2024
30477fa
fix: sdk to skip validations
Nabhag8848 May 29, 2024
9f637e1
fix: let devs generate specific sdk
Nabhag8848 May 29, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 4 additions & 0 deletions .gitignore
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -86,3 +86,7 @@ npm-debug.log*
!fern/**/*.yml
revert-dev.js
.yarn/install-state.gz

# SDKs
**/node-sdk
**/python-sdk
3 changes: 3 additions & 0 deletions fern/definition/api.yml
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,4 +1,7 @@
name: revert-api
headers:
x-revert-api-token: string
x-api-version: optional<string>
error-discrimination:
strategy: status-code
environments:
Expand Down
6 changes: 0 additions & 6 deletions fern/definition/chat/channels.yml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -16,15 +16,9 @@ service:
base-path: /chat/channels
auth: false
headers:
x-revert-api-token:
type: string
docs: Your official API key for accessing revert apis.
x-revert-t-id:
type: string
docs: The unique customer id used when the customer linked their account.
x-api-version:
type: optional<string>
docs: Optional Revert API version you're using. If missing we default to the latest version of the API.
audiences:
- external
endpoints:
Expand Down
6 changes: 0 additions & 6 deletions fern/definition/chat/messages.yml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -16,15 +16,9 @@ service:
base-path: /chat/message
auth: false
headers:
x-revert-api-token:
type: string
docs: Your official API key for accessing revert apis.
x-revert-t-id:
type: string
docs: The unique customer id used when the customer linked their account.
x-api-version:
type: optional<string>
docs: Optional Revert API version you're using. If missing we default to the latest version of the API.
audiences:
- external
endpoints:
Expand Down
6 changes: 0 additions & 6 deletions fern/definition/chat/users.yml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -16,15 +16,9 @@ service:
base-path: /chat/users
auth: false
headers:
x-revert-api-token:
type: string
docs: Your official API key for accessing revert apis.
x-revert-t-id:
type: string
docs: The unique customer id used when the customer linked their account.
x-api-version:
type: optional<string>
docs: Optional Revert API version you're using. If missing we default to the latest version of the API.
audiences:
- external
endpoints:
Expand Down
7 changes: 0 additions & 7 deletions fern/definition/connection.yml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -73,13 +73,6 @@ types:
service:
base-path: ''
auth: false
headers:
x-revert-api-token:
type: string
docs: Your official API key for accessing revert apis.
x-api-version:
type: optional<string>
docs: Optional Revert API version you're using. If missing we default to the latest version of the API.
audiences:
- external
endpoints:
Expand Down
6 changes: 0 additions & 6 deletions fern/definition/crm/company.yml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -37,15 +37,9 @@ service:
base-path: /crm/companies
auth: false
headers:
x-revert-api-token:
type: string
docs: Your official API key for accessing revert apis.
x-revert-t-id:
type: string
docs: The unique customer id used when the customer linked their account.
x-api-version:
type: optional<string>
docs: Optional Revert API version you're using. If missing we default to the latest version of the API.
audiences:
- external
endpoints:
Expand Down
6 changes: 0 additions & 6 deletions fern/definition/crm/contact.yml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -38,15 +38,9 @@ service:
base-path: /crm/contacts
auth: false
headers:
x-revert-api-token:
type: string
docs: Your official API key for accessing revert apis.
x-revert-t-id:
type: string
docs: The unique customer id used when the customer linked their account.
x-api-version:
type: optional<string>
docs: Optional Revert API version you're using. If missing we default to the latest version of the API.
audiences:
- external
endpoints:
Expand Down
6 changes: 0 additions & 6 deletions fern/definition/crm/deal.yml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -38,15 +38,9 @@ service:
base-path: /crm/deals
auth: false
headers:
x-revert-api-token:
type: string
docs: Your official API key for accessing revert apis.
x-revert-t-id:
type: string
docs: The unique customer id used when the customer linked their account.
x-api-version:
type: optional<string>
docs: Optional Revert API version you're using. If missing we default to the latest version of the API.
audiences:
- external
endpoints:
Expand Down
6 changes: 0 additions & 6 deletions fern/definition/crm/event.yml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -43,15 +43,9 @@ service:
base-path: /crm/events
auth: false
headers:
x-revert-api-token:
type: string
docs: Your official API key for accessing revert apis.
x-revert-t-id:
type: string
docs: The unique customer id used when the customer linked their account.
x-api-version:
type: optional<string>
docs: Optional Revert API version you're using. If missing we default to the latest version of the API.
audiences:
- external
endpoints:
Expand Down
6 changes: 0 additions & 6 deletions fern/definition/crm/lead.yml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -38,15 +38,9 @@ service:
base-path: /crm/leads
auth: false
headers:
x-revert-api-token:
type: string
docs: Your official API key for accessing revert apis.
x-revert-t-id:
type: string
docs: The unique customer id used when the customer linked their account.
x-api-version:
type: optional<string>
docs: Optional Revert API version you're using. If missing we default to the latest version of the API.
audiences:
- external
endpoints:
Expand Down
6 changes: 0 additions & 6 deletions fern/definition/crm/note.yml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -38,15 +38,9 @@ service:
base-path: /crm/notes
auth: false
headers:
x-revert-api-token:
type: string
docs: Your official API key for accessing revert apis.
x-revert-t-id:
type: string
docs: The unique customer id used when the customer linked their account.
x-api-version:
type: optional<string>
docs: Optional Revert API version you're using. If missing we default to the latest version of the API.
audiences:
- external
endpoints:
Expand Down
6 changes: 0 additions & 6 deletions fern/definition/crm/properties.yml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -28,15 +28,9 @@ service:
base-path: /crm/properties
auth: false
headers:
x-revert-api-token:
type: string
docs: Your official API key for accessing revert apis.
x-revert-t-id:
type: string
docs: The unique customer id used when the customer linked their account.
x-api-version:
type: optional<string>
docs: Optional Revert API version you're using. If missing we default to the latest version of the API.
audiences:
- external
endpoints:
Expand Down
6 changes: 0 additions & 6 deletions fern/definition/crm/proxy.yml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -20,15 +20,9 @@ service:
base-path: /crm/proxy
auth: false
headers:
x-revert-api-token:
type: string
docs: Your official API key for accessing revert apis.
x-revert-t-id:
type: string
docs: The unique customer id used when the customer linked their account.
x-api-version:
type: optional<string>
docs: Optional Revert API version you're using. If missing we default to the latest version of the API.
audiences:
- external
endpoints:
Expand Down
6 changes: 0 additions & 6 deletions fern/definition/crm/task.yml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -38,15 +38,9 @@ service:
base-path: /crm/tasks
auth: false
headers:
x-revert-api-token:
type: string
docs: Your official API key for accessing revert apis.
x-revert-t-id:
type: string
docs: The unique customer id used when the customer linked their account.
x-api-version:
type: optional<string>
docs: Optional Revert API version you're using. If missing we default to the latest version of the API.
audiences:
- external
endpoints:
Expand Down
6 changes: 0 additions & 6 deletions fern/definition/crm/user.yml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -36,15 +36,9 @@ service:
base-path: /crm/users
auth: false
headers:
x-revert-api-token:
type: string
docs: Your official API key for accessing revert apis.
x-revert-t-id:
type: string
docs: The unique customer id used when the customer linked their account.
x-api-version:
type: optional<string>
docs: Optional Revert API version you're using. If missing we default to the latest version of the API.
audiences:
- external
endpoints:
Expand Down
14 changes: 0 additions & 14 deletions fern/definition/field-mapping.yml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -78,9 +78,6 @@ service:
request:
name: GetFieldMappingsRequest
headers:
x-revert-api-token:
type: string
docs: Your official API key for accessing revert apis.
x-revert-t-id:
type: string
docs: The unique customer id used when the customer linked their account.
Expand Down Expand Up @@ -118,9 +115,6 @@ service:
request:
name: DeleteFieldMappingRequest
headers:
x-revert-api-token:
type: string
docs: Your official API key for accessing revert apis.
x-revert-t-id:
type: string
docs: The unique customer id used when the customer linked their account.
Expand All @@ -136,10 +130,6 @@ service:
request:
name: CreateAccountFieldMappingRequest
body: CreateAccountFieldMappingRequestBody
headers:
x-revert-api-token:
type: string
docs: Your official API key for accessing revert apis.
response: CreateAccountFieldMappingResponse
errors:
- errors.UnAuthorizedError
Expand All @@ -151,10 +141,6 @@ service:
path: '/config'
request:
name: DeleteAccountFieldMappingConfigRequest
headers:
x-revert-api-token:
type: string
docs: Your official API key for accessing revert apis.
response: DeleteAccountFieldMappingConfigResponse
errors:
- errors.UnAuthorizedError
Expand Down
12 changes: 4 additions & 8 deletions fern/definition/internal/account.yml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -12,8 +12,6 @@ types:
service:
base-path: /internal/account
auth: false
headers:
x-revert-api-token: string
audiences:
- internal
endpoints:
Expand Down Expand Up @@ -54,16 +52,14 @@ service:
docs: create Revert App for Account
method: POST
path: /apps
request:
request:
name: CreateRevertAppForAccount
body:
properties:
body:
properties:
userId: string
tpId: types.TPID
environment: string
response: GetAccountDetailsResponse
errors:
errors:
- errors.UnAuthorizedError
- errors.InternalServerError


2 changes: 0 additions & 2 deletions fern/definition/internal/analytics.yml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -11,8 +11,6 @@ types:
service:
base-path: /internal/analytics
auth: false
headers:
x-revert-api-token: string
audiences:
- internal
endpoints:
Expand Down
2 changes: 0 additions & 2 deletions fern/definition/internal/telemetry.yml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -12,8 +12,6 @@ types:
service:
base-path: /internal/telemetry
auth: false
headers:
x-revert-api-token: string
audiences:
- internal
endpoints:
Expand Down
3 changes: 0 additions & 3 deletions fern/definition/sync.yml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -22,9 +22,6 @@ service:
request:
name: TriggerSyncRequest
headers:
x-revert-api-token:
type: string
docs: Your official API key for accessing revert apis.
x-revert-t-id:
type: string
docs: The unique customer id used when the customer linked their account.
Expand Down
6 changes: 0 additions & 6 deletions fern/definition/ticket/collection.yml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -14,15 +14,9 @@ service:
base-path: /ticket/collections
auth: false
headers:
x-revert-api-token:
type: string
docs: Your official API key for accessing revert apis.
x-revert-t-id:
type: string
docs: The unique customer id used when the customer linked their account.
x-api-version:
type: optional<string>
docs: Optional Revert API version you're using. If missing we default to the latest version of the API.
audiences:
- external
endpoints:
Expand Down
6 changes: 0 additions & 6 deletions fern/definition/ticket/comment.yml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -26,15 +26,9 @@ service:
base-path: /ticket/comments
auth: false
headers:
x-revert-api-token:
type: string
docs: Your official API key for accessing revert apis.
x-revert-t-id:
type: string
docs: The unique customer id used when the customer linked their account.
x-api-version:
type: optional<string>
docs: Optional Revert API version you're using. If missing we default to the latest version of the API.
audiences:
- external
endpoints:
Expand Down
6 changes: 0 additions & 6 deletions fern/definition/ticket/proxy.yml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -17,15 +17,9 @@ service:
base-path: /ticket/proxy
auth: false
headers:
x-revert-api-token:
type: string
docs: Your official API key for accessing revert apis.
x-revert-t-id:
type: string
docs: The unique customer id used when the customer linked their account.
x-api-version:
type: optional<string>
docs: Optional Revert API version you're using. If missing we default to the latest version of the API.
audiences:
- external
endpoints:
Expand Down
Loading