Merge branch 'main' of https://github.com/panoratech/Panora into feat…

…/auth-password
mit-27 · Aug 1, 2024 · 6de18b0 · 6de18b0
2 parents 19dbf85 + 44746ba
commit 6de18b0
Show file tree

Hide file tree

Showing 110 changed files with 26,880 additions and 17,453 deletions.
diff --git a/.env.example b/.env.example
@@ -27,7 +27,13 @@ MAIL_PASSWORD=your-email-password
 
 
 # ================================================
+# Tip: use mailtrap.io for local development
+EMAIL_SENDING_ADDRESS=hello@panora.dev
 
+SMTP_HOST=
+SMTP_PORT=
+SMTP_USER=
+SMTP_PASSWORD=
 # ================================================
 # Database
 # ================================================

diff --git a/.speakeasy/workflow.lock b/.speakeasy/workflow.lock
@@ -0,0 +1,26 @@
+speakeasyVersion: 1.351.2
+sources:
+    merge-code-samples-into-spec:
+        sourceNamespace: merge-code-samples-into-spec
+        sourceRevisionDigest: sha256:dde6fc4b932928239b169ca6e69ec20c1f777ea02caa0a4f79efad8af48d528e
+        sourceBlobDigest: sha256:b1a2083cb9aded332422c5c036d95babc9e941d4050125cbf3da0bbbc4f7084f
+        tags:
+            - latest
+            - main
+targets: {}
+workflow:
+    workflowVersion: 1.0.0
+    speakeasyVersion: latest
+    sources:
+        merge-code-samples-into-spec:
+            inputs:
+                - location: registry.speakeasyapi.dev/panora/panora/panora-open-api-swagger
+            overlays:
+                - location: registry.speakeasyapi.dev/panora/panora/code-samples-typescript-my-first-target:main
+                - location: registry.speakeasyapi.dev/panora/panora/code-samples-python:main
+                - location: registry.speakeasyapi.dev/panora/panora/go-sdk:main
+                - location: registry.speakeasyapi.dev/panora/panora/code-samples-ruby:main
+            output: packages/api/swagger/openapi-with-code-samples.yaml
+            registry:
+                location: registry.speakeasyapi.dev/panora/panora/merge-code-samples-into-spec
+    targets: {}
diff --git a/.speakeasy/workflow.yaml b/.speakeasy/workflow.yaml
@@ -1,9 +1,15 @@
 workflowVersion: 1.0.0
+speakeasyVersion: latest
 sources:
     merge-code-samples-into-spec:
         inputs:
             - location: registry.speakeasyapi.dev/panora/panora/panora-open-api-swagger
         overlays:
             - location: registry.speakeasyapi.dev/panora/panora/code-samples-typescript-my-first-target:main
-        output: docs/openapi-with-code-samples.json
+            - location: registry.speakeasyapi.dev/panora/panora/code-samples-python:main
+            - location: registry.speakeasyapi.dev/panora/panora/go-sdk:main
+            - location: registry.speakeasyapi.dev/panora/panora/code-samples-ruby:main
+        output: packages/api/swagger/openapi-with-code-samples.yaml
+        registry:
+            location: registry.speakeasyapi.dev/panora/panora/merge-code-samples-into-spec
 targets: {}
diff --git a/a b/a
diff --git a/apps/webapp/src/hooks/create/useCreateApiKey.tsx b/apps/webapp/src/hooks/create/useCreateApiKey.tsx
@@ -11,7 +11,7 @@ export interface IApiKeyDto {
 // Adjusted useCreateApiKey hook to include a promise-returning function
 const useCreateApiKey = () => {
     const addApiKey = async (data: IApiKeyDto) => {
-        const response = await fetch(`${config.API_URL}/auth/generate-apikey`, {
+        const response = await fetch(`${config.API_URL}/auth/api_keys`, {
             method: 'POST',
             body: JSON.stringify(data),
             headers: {

diff --git a/apps/webapp/src/hooks/create/useCreateLinkedUser.tsx b/apps/webapp/src/hooks/create/useCreateLinkedUser.tsx
@@ -9,7 +9,7 @@ interface ILinkedUserDto {
 }
 const useCreateLinkedUser = () => {    
     const add = async (linkedUserData: ILinkedUserDto) => {
-        const response = await fetch(`${config.API_URL}/linked-users/internal`, {
+        const response = await fetch(`${config.API_URL}/linked_users/internal`, {
             method: 'POST',
             body: JSON.stringify(linkedUserData),
             headers: {

diff --git a/apps/webapp/src/hooks/create/useCreateMagicLink.tsx b/apps/webapp/src/hooks/create/useCreateMagicLink.tsx
@@ -11,7 +11,7 @@ interface ILinkDto {
 
 const useCreateMagicLink = () => {
     const add = async (data: ILinkDto) => {
-        const response = await fetch(`${config.API_URL}/magic-links`, {
+        const response = await fetch(`${config.API_URL}/magic_links`, {
             method: 'POST',
             body: JSON.stringify(data),
             headers: {

diff --git a/apps/webapp/src/hooks/create/useRefreshAccessToken.tsx b/apps/webapp/src/hooks/create/useRefreshAccessToken.tsx
@@ -8,7 +8,7 @@ interface IRefreshOutputDto {
 
 const useRefreshAccessToken = () => {
     const refreshAccessToken = async (projectId: string) => {
-        const response = await fetch(`${config.API_URL}/auth/refresh-token`, {
+        const response = await fetch(`${config.API_URL}/auth/refresh_tokens`, {
             method: 'POST',
             body: JSON.stringify({
                 projectId: projectId

diff --git a/apps/webapp/src/hooks/get/useApiKeys.tsx b/apps/webapp/src/hooks/get/useApiKeys.tsx
@@ -7,7 +7,7 @@ const useApiKeys = () => {
   return useQuery({
     queryKey: ['api-keys'], 
     queryFn: async (): Promise<ApiKey[]> => {
-      const response = await fetch(`${config.API_URL}/auth/api-keys`,
+      const response = await fetch(`${config.API_URL}/auth/api_keys`,
       {
         method: 'GET',
         headers: {

diff --git a/apps/webapp/src/hooks/get/useFieldMappings.tsx b/apps/webapp/src/hooks/get/useFieldMappings.tsx
@@ -7,7 +7,7 @@ const useFieldMappings = () => {
   return useQuery({
     queryKey: ['mappings'], 
     queryFn: async (): Promise<Attribute[]> => {
-      const response = await fetch(`${config.API_URL}/field-mappings/attribute`,
+      const response = await fetch(`${config.API_URL}/field_mappings/attributes`,
       {
         method: 'GET',
         headers: {

diff --git a/apps/webapp/src/hooks/get/useLinkedUsers.tsx b/apps/webapp/src/hooks/get/useLinkedUsers.tsx
@@ -7,7 +7,7 @@ const useLinkedUsers = () => {
   return useQuery({
     queryKey: ['linked-users'], 
     queryFn: async (): Promise<LinkedUser[]> => {
-      const response = await fetch(`${config.API_URL}/linked-users/internal`,
+      const response = await fetch(`${config.API_URL}/linked_users/internal`,
       {
         method: 'GET',
         headers: {

diff --git a/apps/webapp/src/hooks/get/useProviderProperties.tsx b/apps/webapp/src/hooks/get/useProviderProperties.tsx
@@ -6,7 +6,7 @@ const useProviderProperties = (linkedUserId: string, providerId: string, vertica
   return useQuery({
     queryKey: ['providerProperties', linkedUserId, providerId, vertical], 
     queryFn: async () => {
-      const response = await fetch(`${config.API_URL}/field-mappings/properties?linkedUserId=${linkedUserId}&providerId=${providerId}&vertical=${vertical}`,
+      const response = await fetch(`${config.API_URL}/field_mappings/properties?linkedUserId=${linkedUserId}&providerId=${providerId}&vertical=${vertical}`,
       {
         method: 'GET',
         headers: {

diff --git a/apps/webapp/src/hooks/get/useWebhooks.tsx b/apps/webapp/src/hooks/get/useWebhooks.tsx
@@ -8,7 +8,7 @@ const useWebhooks = () => {
     queryKey: ['webhooks'], 
     queryFn: async (): Promise<Webhook[]> => {
       console.log("Webhook mutation called")
-      const response = await fetch(`${config.API_URL}/webhook/internal`,
+      const response = await fetch(`${config.API_URL}/webhooks/internal`,
       {
         method: 'GET',
         headers: {

diff --git a/docker-compose.dev.yml b/docker-compose.dev.yml
@@ -165,6 +165,11 @@ services:
       HELPSCOUT_TICKETING_CLOUD_CLIENT_SECRET: ${HELPSCOUT_TICKETING_CLOUD_CLIENT_SECRET}
       IRONCLAD_TICKETING_CLOUD_CLIENT_ID: ${IRONCLAD_TICKETING_CLOUD_CLIENT_ID}
       IRONCLAD_TICKETING_CLOUD_CLIENT_SECRET: ${IRONCLAD_TICKETING_CLOUD_CLIENT_SECRET}
+      EMAIL_SENDING_ADDRESS: ${EMAIL_SENDING_ADDRESS}
+      SMTP_HOST: ${SMTP_HOST}
+      SMTP_PORT: ${SMTP_PORT}
+      SMTP_USER: ${SMTP_USER}
+      SMTP_PASSWORD: ${SMTP_PASSWORD}
 
     restart: unless-stopped
     ports:
@@ -275,14 +280,14 @@ services:
   #       condition: service_healthy
   #   network_mode: "host"
 
-  docs:
-    build:
-      dockerfile: ./Dockerfile.dev
-      context: ./docs/
-    ports:
-      - 911:3000
-    volumes:
-      - ./docs/:/app
+  # docs:
+  #   build:
+  #     dockerfile: ./Dockerfile.dev
+  #     context: ./docs/
+  #   ports:
+  #     - 911:3000
+  #   volumes:
+  #     - ./docs/:/app
 
 volumes:
   local_pgdata:

diff --git a/docker-compose.source.yml b/docker-compose.source.yml
@@ -165,6 +165,11 @@ services:
       HELPSCOUT_TICKETING_CLOUD_CLIENT_SECRET: ${HELPSCOUT_TICKETING_CLOUD_CLIENT_SECRET}
       IRONCLAD_TICKETING_CLOUD_CLIENT_ID: ${IRONCLAD_TICKETING_CLOUD_CLIENT_ID}
       IRONCLAD_TICKETING_CLOUD_CLIENT_SECRET: ${IRONCLAD_TICKETING_CLOUD_CLIENT_SECRET}
+      EMAIL_SENDING_ADDRESS: ${EMAIL_SENDING_ADDRESS}
+      SMTP_HOST: ${SMTP_HOST}
+      SMTP_PORT: ${SMTP_PORT}
+      SMTP_USER: ${SMTP_USER}
+      SMTP_PASSWORD: ${SMTP_PASSWORD}
     restart: unless-stopped
     ports:
       - 3000:3000

diff --git a/docker-compose.yml b/docker-compose.yml
@@ -159,6 +159,11 @@ services:
       HELPSCOUT_TICKETING_CLOUD_CLIENT_SECRET: ${HELPSCOUT_TICKETING_CLOUD_CLIENT_SECRET}
       IRONCLAD_TICKETING_CLOUD_CLIENT_ID: ${IRONCLAD_TICKETING_CLOUD_CLIENT_ID}
       IRONCLAD_TICKETING_CLOUD_CLIENT_SECRET: ${IRONCLAD_TICKETING_CLOUD_CLIENT_SECRET}
+      EMAIL_SENDING_ADDRESS: ${EMAIL_SENDING_ADDRESS}
+      SMTP_HOST: ${SMTP_HOST}
+      SMTP_PORT: ${SMTP_PORT}
+      SMTP_USER: ${SMTP_USER}
+      SMTP_PASSWORD: ${SMTP_PASSWORD}
     restart: unless-stopped
     ports:
       - 3000:3000

diff --git a/docs/api-reference/auth/create-api-key.mdx b/docs/api-reference/auth/create-api-key.mdx
@@ -1,3 +1,3 @@
 ---
-openapi: post /auth/generate-apikey
+openapi: post /auth/api_keys
 ---
diff --git a/docs/api-reference/auth/retrieve-api-keys.mdx b/docs/api-reference/auth/retrieve-api-keys.mdx
@@ -1,3 +1,3 @@
 ---
-openapi: get /auth/api-keys
+openapi: get /auth/api_keys
 ---
diff --git a/docs/api-reference/field-mapping/define-target-field.mdx b/docs/api-reference/field-mapping/define-target-field.mdx
@@ -1,3 +1,3 @@
 ---
-openapi: post /field-mapping/define
+openapi: post /field_mappings/definitions
 ---
diff --git a/docs/api-reference/field-mapping/map-custom-field.mdx b/docs/api-reference/field-mapping/map-custom-field.mdx
@@ -1,3 +1,3 @@
 ---
-openapi: post /field-mapping/map
+openapi: post /field_mappings/mappings
 ---
diff --git a/docs/api-reference/field-mapping/retrieve-custom-properties.mdx b/docs/api-reference/field-mapping/retrieve-custom-properties.mdx
@@ -1,3 +1,3 @@
 ---
-openapi: get /field-mapping/properties
+openapi: get /field_mappings/properties
 ---
diff --git a/docs/api-reference/field-mapping/retrieve-field-mapping-entities.mdx b/docs/api-reference/field-mapping/retrieve-field-mapping-entities.mdx
@@ -1,3 +1,3 @@
 ---
-openapi: get /field-mapping/entities
+openapi: get /field_mappings/entities
 ---
diff --git a/docs/api-reference/field-mapping/retrieve-field-mappings-values.mdx b/docs/api-reference/field-mapping/retrieve-field-mappings-values.mdx
@@ -1,3 +1,3 @@
 ---
-openapi: get /field-mapping/value
+openapi: get /field_mappings/values
 ---
diff --git a/docs/api-reference/field-mapping/retrieve-field-mappings.mdx b/docs/api-reference/field-mapping/retrieve-field-mappings.mdx
@@ -1,3 +1,3 @@
 ---
-openapi: get /field-mapping/attribute
+openapi: get /field_mappings/attributes
 ---
diff --git a/docs/api-reference/magic-link/retrieve-magic-links.mdx b/docs/api-reference/magic-link/retrieve-magic-links.mdx
@@ -1,3 +1,3 @@
 ---
-openapi: get /magic-link
+openapi: get /magic_links
 ---
diff --git a/docs/api-reference/projects/create-a-project.mdx b/docs/api-reference/projects/create-a-project.mdx
@@ -1,3 +1,3 @@
 ---
-openapi: post /projects/create
+openapi: post /projects
 ---
diff --git a/docs/core-concepts/custom-fields.mdx b/docs/core-concepts/custom-fields.mdx
@@ -56,7 +56,7 @@ The following example creates a custom field mapping in two steps (**define and
 
 ```shell Create custom field
 curl --request POST \
-         --url https://api.panora.dev/field-mappings \
+         --url https://api.panora.dev/field_mappings \
          --header 'Authorization: Bearer <MY_API_KEY>' \
          --header 'Content-Type: application/json' \
          --data '{
@@ -76,7 +76,7 @@ The following example creates a custom field mapping in two steps (**define and
         <CodeGroup>
         ```shell Define custom field
         curl --request POST \
-             --url https://api.panora.dev/field-mappings/define \
+             --url https://api.panora.dev/field_mappings/definitions \
              --header 'Authorization: Bearer <MY_API_KEY>' \
              --header 'Content-Type: application/json' \
              --data '{
@@ -89,7 +89,7 @@ The following example creates a custom field mapping in two steps (**define and
 
         ```shell Map custom field
         curl --request POST \
-             --url https://api.panora.dev/field-mappings/map \
+             --url https://api.panora.dev/field_mappings/mappings \
              --header 'Authorization: Bearer <MY_API_KEY>' \
              --header 'Content-Type: application/json' \
              --data '{