2.2.0

URLR · Jun 16, 2024 · 6bbb143 · 6bbb143
1 parent 48bfee5
commit 6bbb143
Show file tree

Hide file tree

Showing 8 changed files with 132 additions and 6 deletions.
diff --git a/.github/workflows/build.yaml b/.github/workflows/build.yaml
@@ -31,6 +31,7 @@ jobs:
             PACKAGE_VERSION=$(awk '/- Package version:/{print $NF}' README.md)
             git tag -a $PACKAGE_VERSION -m $PACKAGE_VERSION || true
             git push --tags origin main
+            npm config set //registry.npmjs.org/:_authToken $NODE_AUTH_TOKEN
             npm publish --provenance
           else
             echo "  No changes, skipping."
@@ -94,8 +95,9 @@ jobs:
             git tag -a $PACKAGE_VERSION -m $PACKAGE_VERSION || true
             git push --tags origin main
             python -m pip install --upgrade pip
-            pip install twine
-          python -m build && twine upload dist/*
+            pip install twine build
+            python -m build
+            twine upload dist/*
           else
             echo "  No changes, skipping."
           fi
diff --git a/clients/urlr-javascript/CHANGELOG.md b/clients/urlr-javascript/CHANGELOG.md
@@ -1,5 +1,9 @@
 # Changelog
 
+## [2.2.0] - 2024-06-16
+
+- Updated URLR API version to 1.2
+
 ## [2.1.0] - 2024-06-07
 
 - Updated URLR API version to 1.1

diff --git a/clients/urlr-php/CHANGELOG.md b/clients/urlr-php/CHANGELOG.md
@@ -1,5 +1,9 @@
 # Changelog
 
+## [2.2.0] - 2024-06-16
+
+- Updated URLR API version to 1.2
+
 ## [2.1.0] - 2024-06-07
 
 - Updated URLR API version to 1.1

diff --git a/clients/urlr-python/CHANGELOG.md b/clients/urlr-python/CHANGELOG.md
@@ -1,5 +1,9 @@
 # Changelog
 
+## [2.2.0] - 2024-06-16
+
+- Updated URLR API version to 1.2
+
 ## [2.1.0] - 2024-06-07
 
 - Updated URLR API version to 1.1

diff --git a/openapi-generator/config-javascript.yaml b/openapi-generator/config-javascript.yaml
@@ -1,5 +1,5 @@
 npmName: urlr-js
-npmVersion: 2.1.0
+npmVersion: 2.2.0
 gitHost: github.com
 gitUserId: urlr
 gitRepoId: urlr-javascript

diff --git a/openapi-generator/config-php.yaml b/openapi-generator/config-php.yaml
@@ -1,6 +1,6 @@
 packageName: URLR
 composerPackageName: urlr/urlr-php
-artifactVersion: 2.1.0
+artifactVersion: 2.2.0
 invokerPackage: URLR
 variableNamingConvention: camelCase
 developerOrganization: URLR

diff --git a/openapi-generator/config-python.yaml b/openapi-generator/config-python.yaml
@@ -1,6 +1,6 @@
 projectName: URLR
 packageName: urlr
-packageVersion: 2.1.0
+packageVersion: 2.2.0
 infoName: URLR
 infoEmail: [email protected]
 gitUserId: urlr

diff --git a/openapi.yaml b/openapi.yaml
@@ -10,7 +10,7 @@ info:
   license:
     name: 'All rights reserved'
     url: 'https://urlr.me/en/legal-notice'
-  version: '1.1'
+  version: '1.2'
 servers:
   -
     url: 'https://urlr.me/api/v1'
@@ -124,6 +124,7 @@ paths:
                   domain: { description: Domain, type: string, example: urlr.me }
                   code: { description: 'Short code', type: string, example: xxxxx }
                   label: { description: Label, type: string }
+                  qrcode: { description: 'QR Code associated to the short link', properties: { data: { description: 'QR Code Data URL', type: string } }, type: object }
                   metatag: { description: 'Custom metadata for social previews', properties: { title: { description: 'Title of the link', type: string }, description: { description: 'Description of the link', type: string }, image: { description: 'Image URL of the link', type: string, format: url } }, type: object }
                   geolinks: { description: 'Geographical targeting links', type: array, items: { properties: { type: { description: 'Type of the geographic link', type: string }, value: { description: 'Value corresponding to the type of the geographic link', type: string }, url: { description: 'URL of the geographic link', type: string, format: url } }, type: object } }
                   created_at: { description: 'Creation date', type: string, format: date-time }
@@ -203,6 +204,10 @@ paths:
                 password:
                   description: Password
                   type: string
+                qrcode:
+                  description: 'QR Code'
+                  properties: { size: { description: 'The size of the QR code (px)', type: integer, default: 600 }, format: { description: 'The format of the QR code', type: string, default: png, enum: [png, webp, svg] }, margin: { description: 'The margin around the QR code (px)', type: integer, default: 0 }, background_color: { description: 'The background color of the QR code (hexadecimal)', type: string, default: '#ffffff' }, foreground_color: { description: 'The foreground color of the QR code (hexadecimal)', type: string, default: '#000000' } }
+                  type: object
                 metatag:
                   description: 'Custom metadata for social previews'
                   properties: { title: { description: 'Title for the link', type: string }, description: { description: 'Description for the link', type: string }, image: { description: 'Image URL for the link. Recommended: 1200X630px<br>Maximum size: 3Mb - Formats: PNG, JPEG, WebP and GIF.', type: string, format: url } }
@@ -226,6 +231,7 @@ paths:
                   domain: { description: Domain, type: string, example: urlr.me }
                   code: { description: 'Short code', type: string, example: xxxxx }
                   label: { description: Label, type: string }
+                  qrcode: { description: 'QR Code associated to the short link', properties: { data: { description: 'QR Code Data URL', type: string } }, type: object }
                   metatag: { description: 'Custom metadata for social previews', properties: { title: { description: 'Title of the link', type: string }, description: { description: 'Description of the link', type: string }, image: { description: 'Image URL of the link', type: string, format: url } }, type: object }
                   geolinks: { description: 'Geographical targeting links', type: array, items: { properties: { type: { description: 'Type of the geographic link', type: string }, value: { description: 'Value corresponding to the type of the geographic link', type: string }, url: { description: 'URL of the geographic link', type: string, format: url } }, type: object } }
                   created_at: { description: 'Creation date', type: string, format: date-time }
@@ -279,6 +285,112 @@ paths:
       security:
         -
           bearerAuth: []
+  /qrcodes/create:
+    post:
+      tags:
+        - 'QR Codes'
+      summary: 'Create a QR Code'
+      operationId: createQrCode
+      requestBody:
+        description: 'Info of the QR Code to create'
+        content:
+          application/json:
+            schema:
+              properties:
+                size:
+                  description: 'The size of the QR code (px)'
+                  type: integer
+                  default: 600
+                format:
+                  description: 'The format of the QR code'
+                  type: string
+                  default: png
+                  enum: [png, webp, svg]
+                margin:
+                  description: 'The margin around the QR code (px)'
+                  type: integer
+                  default: 0
+                background_color:
+                  description: 'The background color of the QR code (hexadecimal)'
+                  type: string
+                  default: '#ffffff'
+                foreground_color:
+                  description: 'The foreground color of the QR code (hexadecimal)'
+                  type: string
+                  default: '#000000'
+              type: object
+              oneOf:
+                -
+                  required: [url, team_id]
+                  properties: { url: { description: 'URL of the QR Code', type: string, format: url }, team_id: { description: 'Team API ID', type: string, format: uuid } }
+                  type: object
+                -
+                  required: [link_id]
+                  properties: { link_id: { description: 'Link API ID of the QR Code', type: string, format: uuid } }
+                  type: object
+      responses:
+        '201':
+          description: 'QR Code'
+          content:
+            image/png:
+              schema:
+                type: string
+                format: binary
+            image/webp:
+              schema:
+                type: string
+                format: binary
+            image/svg+xml:
+              schema:
+                type: string
+                format: binary
+        '401':
+          description: Unauthorized
+          content:
+            application/problem+json:
+              schema:
+                properties:
+                  type: { type: string }
+                  title: { type: string }
+                  status: { type: integer, example: 401 }
+                  detail: { type: string }
+                type: object
+        '422':
+          description: 'Validation Failed'
+          content:
+            application/problem+json:
+              schema:
+                properties:
+                  type: { type: string }
+                  title: { type: string }
+                  status: { type: integer, example: 422 }
+                  detail: { type: string }
+                type: object
+        '429':
+          description: 'Limits Exceeded'
+          content:
+            application/problem+json:
+              schema:
+                properties:
+                  type: { type: string }
+                  title: { type: string }
+                  status: { type: integer, example: 429 }
+                  detail: { type: string }
+                type: object
+        '500':
+          description: 'Internal Error'
+          content:
+            application/problem+json:
+              schema:
+                properties:
+                  type: { type: string }
+                  title: { type: string }
+                  status: { type: integer, example: 500 }
+                  detail: { type: string }
+                type: object
+      security:
+        -
+          bearerAuth: []
   /statistics:
     post:
       tags: