-
Notifications
You must be signed in to change notification settings - Fork 0
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Deploying from URLR/api-clients-generation@6bbb1438
- Loading branch information
Showing
84 changed files
with
1,530 additions
and
70 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
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
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
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
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,34 @@ | ||
| # CreateLinkRequestQrcode | ||
|
|
||
| QR Code | ||
|
|
||
| ## Properties | ||
|
|
||
| Name | Type | Description | Notes | ||
| ------------ | ------------- | ------------- | ------------- | ||
| **size** | **int** | The size of the QR code (px) | [optional] [default to 600] | ||
| **format** | **str** | The format of the QR code | [optional] [default to 'png'] | ||
| **margin** | **int** | The margin around the QR code (px) | [optional] [default to 0] | ||
| **background_color** | **str** | The background color of the QR code (hexadecimal) | [optional] [default to '#ffffff'] | ||
| **foreground_color** | **str** | The foreground color of the QR code (hexadecimal) | [optional] [default to '#000000'] | ||
|
|
||
| ## Example | ||
|
|
||
| ```python | ||
| from urlr.models.create_link_request_qrcode import CreateLinkRequestQrcode | ||
|
|
||
| # TODO update the JSON string below | ||
| json = "{}" | ||
| # create an instance of CreateLinkRequestQrcode from a JSON string | ||
| create_link_request_qrcode_instance = CreateLinkRequestQrcode.from_json(json) | ||
| # print the JSON string representation of the object | ||
| print(CreateLinkRequestQrcode.to_json()) | ||
|
|
||
| # convert the object into a dict | ||
| create_link_request_qrcode_dict = create_link_request_qrcode_instance.to_dict() | ||
| # create an instance of CreateLinkRequestQrcode from a dict | ||
| create_link_request_qrcode_from_dict = CreateLinkRequestQrcode.from_dict(create_link_request_qrcode_dict) | ||
| ``` | ||
| [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) | ||
|
|
||
|
|
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,36 @@ | ||
| # CreateQrCodeRequest | ||
|
|
||
|
|
||
| ## Properties | ||
|
|
||
| Name | Type | Description | Notes | ||
| ------------ | ------------- | ------------- | ------------- | ||
| **size** | **int** | The size of the QR code (px) | [optional] [default to 600] | ||
| **format** | **str** | The format of the QR code | [optional] [default to 'png'] | ||
| **margin** | **int** | The margin around the QR code (px) | [optional] [default to 0] | ||
| **background_color** | **str** | The background color of the QR code (hexadecimal) | [optional] [default to '#ffffff'] | ||
| **foreground_color** | **str** | The foreground color of the QR code (hexadecimal) | [optional] [default to '#000000'] | ||
| **url** | **str** | URL of the QR Code | | ||
| **team_id** | **str** | Team API ID | | ||
| **link_id** | **str** | Link API ID of the QR Code | | ||
|
|
||
| ## Example | ||
|
|
||
| ```python | ||
| from urlr.models.create_qr_code_request import CreateQrCodeRequest | ||
|
|
||
| # TODO update the JSON string below | ||
| json = "{}" | ||
| # create an instance of CreateQrCodeRequest from a JSON string | ||
| create_qr_code_request_instance = CreateQrCodeRequest.from_json(json) | ||
| # print the JSON string representation of the object | ||
| print(CreateQrCodeRequest.to_json()) | ||
|
|
||
| # convert the object into a dict | ||
| create_qr_code_request_dict = create_qr_code_request_instance.to_dict() | ||
| # create an instance of CreateQrCodeRequest from a dict | ||
| create_qr_code_request_from_dict = CreateQrCodeRequest.from_dict(create_qr_code_request_dict) | ||
| ``` | ||
| [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) | ||
|
|
||
|
|
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,30 @@ | ||
| # CreateQrCodeRequestOneOf | ||
|
|
||
|
|
||
| ## Properties | ||
|
|
||
| Name | Type | Description | Notes | ||
| ------------ | ------------- | ------------- | ------------- | ||
| **url** | **str** | URL of the QR Code | | ||
| **team_id** | **str** | Team API ID | | ||
|
|
||
| ## Example | ||
|
|
||
| ```python | ||
| from urlr.models.create_qr_code_request_one_of import CreateQrCodeRequestOneOf | ||
|
|
||
| # TODO update the JSON string below | ||
| json = "{}" | ||
| # create an instance of CreateQrCodeRequestOneOf from a JSON string | ||
| create_qr_code_request_one_of_instance = CreateQrCodeRequestOneOf.from_json(json) | ||
| # print the JSON string representation of the object | ||
| print(CreateQrCodeRequestOneOf.to_json()) | ||
|
|
||
| # convert the object into a dict | ||
| create_qr_code_request_one_of_dict = create_qr_code_request_one_of_instance.to_dict() | ||
| # create an instance of CreateQrCodeRequestOneOf from a dict | ||
| create_qr_code_request_one_of_from_dict = CreateQrCodeRequestOneOf.from_dict(create_qr_code_request_one_of_dict) | ||
| ``` | ||
| [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) | ||
|
|
||
|
|
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,29 @@ | ||
| # CreateQrCodeRequestOneOf1 | ||
|
|
||
|
|
||
| ## Properties | ||
|
|
||
| Name | Type | Description | Notes | ||
| ------------ | ------------- | ------------- | ------------- | ||
| **link_id** | **str** | Link API ID of the QR Code | | ||
|
|
||
| ## Example | ||
|
|
||
| ```python | ||
| from urlr.models.create_qr_code_request_one_of1 import CreateQrCodeRequestOneOf1 | ||
|
|
||
| # TODO update the JSON string below | ||
| json = "{}" | ||
| # create an instance of CreateQrCodeRequestOneOf1 from a JSON string | ||
| create_qr_code_request_one_of1_instance = CreateQrCodeRequestOneOf1.from_json(json) | ||
| # print the JSON string representation of the object | ||
| print(CreateQrCodeRequestOneOf1.to_json()) | ||
|
|
||
| # convert the object into a dict | ||
| create_qr_code_request_one_of1_dict = create_qr_code_request_one_of1_instance.to_dict() | ||
| # create an instance of CreateQrCodeRequestOneOf1 from a dict | ||
| create_qr_code_request_one_of1_from_dict = CreateQrCodeRequestOneOf1.from_dict(create_qr_code_request_one_of1_dict) | ||
| ``` | ||
| [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) | ||
|
|
||
|
|
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
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,30 @@ | ||
| # GetLink200ResponseQrcode | ||
|
|
||
| QR Code associated to the short link | ||
|
|
||
| ## Properties | ||
|
|
||
| Name | Type | Description | Notes | ||
| ------------ | ------------- | ------------- | ------------- | ||
| **data** | **str** | QR Code Data URL | [optional] | ||
|
|
||
| ## Example | ||
|
|
||
| ```python | ||
| from urlr.models.get_link200_response_qrcode import GetLink200ResponseQrcode | ||
|
|
||
| # TODO update the JSON string below | ||
| json = "{}" | ||
| # create an instance of GetLink200ResponseQrcode from a JSON string | ||
| get_link200_response_qrcode_instance = GetLink200ResponseQrcode.from_json(json) | ||
| # print the JSON string representation of the object | ||
| print(GetLink200ResponseQrcode.to_json()) | ||
|
|
||
| # convert the object into a dict | ||
| get_link200_response_qrcode_dict = get_link200_response_qrcode_instance.to_dict() | ||
| # create an instance of GetLink200ResponseQrcode from a dict | ||
| get_link200_response_qrcode_from_dict = GetLink200ResponseQrcode.from_dict(get_link200_response_qrcode_dict) | ||
| ``` | ||
| [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) | ||
|
|
||
|
|
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,89 @@ | ||
| # urlr.QRCodesApi | ||
|
|
||
| All URIs are relative to *https://urlr.me/api/v1* | ||
|
|
||
| Method | HTTP request | Description | ||
| ------------- | ------------- | ------------- | ||
| [**create_qr_code**](QRCodesApi.md#create_qr_code) | **POST** /qrcodes/create | Create a QR Code | ||
|
|
||
|
|
||
| # **create_qr_code** | ||
| > bytearray create_qr_code(create_qr_code_request=create_qr_code_request) | ||
| Create a QR Code | ||
|
|
||
| ### Example | ||
|
|
||
| * Bearer (JWT) Authentication (bearerAuth): | ||
|
|
||
| ```python | ||
| import urlr | ||
| from urlr.models.create_qr_code_request import CreateQrCodeRequest | ||
| from urlr.rest import ApiException | ||
| from pprint import pprint | ||
|
|
||
| # Defining the host is optional and defaults to https://urlr.me/api/v1 | ||
| # See configuration.py for a list of all supported configuration parameters. | ||
| configuration = urlr.Configuration( | ||
| host = "https://urlr.me/api/v1" | ||
| ) | ||
|
|
||
| # The client must configure the authentication and authorization parameters | ||
| # in accordance with the API server security policy. | ||
| # Examples for each auth method are provided below, use the example that | ||
| # satisfies your auth use case. | ||
|
|
||
| # Configure Bearer authorization (JWT): bearerAuth | ||
| configuration = urlr.Configuration( | ||
| access_token = os.environ["BEARER_TOKEN"] | ||
| ) | ||
|
|
||
| # Enter a context with an instance of the API client | ||
| with urlr.ApiClient(configuration) as api_client: | ||
| # Create an instance of the API class | ||
| api_instance = urlr.QRCodesApi(api_client) | ||
| create_qr_code_request = urlr.CreateQrCodeRequest() # CreateQrCodeRequest | Info of the QR Code to create (optional) | ||
|
|
||
| try: | ||
| # Create a QR Code | ||
| api_response = api_instance.create_qr_code(create_qr_code_request=create_qr_code_request) | ||
| print("The response of QRCodesApi->create_qr_code:\n") | ||
| pprint(api_response) | ||
| except Exception as e: | ||
| print("Exception when calling QRCodesApi->create_qr_code: %s\n" % e) | ||
| ``` | ||
|
|
||
|
|
||
|
|
||
| ### Parameters | ||
|
|
||
|
|
||
| Name | Type | Description | Notes | ||
| ------------- | ------------- | ------------- | ------------- | ||
| **create_qr_code_request** | [**CreateQrCodeRequest**](CreateQrCodeRequest.md)| Info of the QR Code to create | [optional] | ||
|
|
||
| ### Return type | ||
|
|
||
| **bytearray** | ||
|
|
||
| ### Authorization | ||
|
|
||
| [bearerAuth](../README.md#bearerAuth) | ||
|
|
||
| ### HTTP request headers | ||
|
|
||
| - **Content-Type**: application/json | ||
| - **Accept**: image/png, image/webp, image/svg+xml, application/problem+json | ||
|
|
||
| ### HTTP response details | ||
|
|
||
| | Status code | Description | Response headers | | ||
| |-------------|-------------|------------------| | ||
| **201** | QR Code | - | | ||
| **401** | Unauthorized | - | | ||
| **422** | Validation Failed | - | | ||
| **429** | Limits Exceeded | - | | ||
| **500** | Internal Error | - | | ||
|
|
||
| [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) | ||
|
|
Oops, something went wrong.