postfinancecheckout 6.0.0__tar.gz → 6.1.0__tar.gz

{postfinancecheckout-6.0.0 → postfinancecheckout-6.1.0}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: postfinancecheckout
-Version: 6.0.0
+Version: 6.1.0
 Summary: PostFinance Checkout API
 Home-page: 
 Author: postfinancecheckout

{postfinancecheckout-6.0.0 → postfinancecheckout-6.1.0}/README.md

@@ -119,9 +119,14 @@ Web Api client: [*link*](https://checkout.postfinance.ch//api/client)<br>
   &nbsp;&nbsp;&nbsp;&nbsp;Deactivate an account
   <br><br>
 - <strong>AnalyticsQueriesService</strong><br>
-  &nbsp;&nbsp;* <code>delete_analytics_queries_query_token</code>
-  &nbsp;&nbsp;&nbsp;&nbsp;<strong>DELETE</strong> /analytics/queries/{queryToken}
-  &nbsp;&nbsp;&nbsp;&nbsp;Cancel a query execution
+  &nbsp;&nbsp;* <code>delete_analytics_queries_query_external_id_query_external_id</code>
+  &nbsp;&nbsp;&nbsp;&nbsp;<strong>DELETE</strong> /analytics/queries/queryExternalId/{queryExternalId}
+  &nbsp;&nbsp;&nbsp;&nbsp;Cancel a query execution, identifying it by its external id.
+  <br><br>
+- <strong>AnalyticsQueriesService</strong><br>
+  &nbsp;&nbsp;* <code>delete_analytics_queries_query_token_query_token</code>
+  &nbsp;&nbsp;&nbsp;&nbsp;<strong>DELETE</strong> /analytics/queries/queryToken/{queryToken}
+  &nbsp;&nbsp;&nbsp;&nbsp;Cancel a query execution, identifying it by its query token.
   <br><br>
 - <strong>AnalyticsQueriesService</strong><br>
   &nbsp;&nbsp;* <code>get_analytics_queries</code>
@@ -129,14 +134,24 @@ Web Api client: [*link*](https://checkout.postfinance.ch//api/client)<br>
   &nbsp;&nbsp;&nbsp;&nbsp;Get portion of query executions for account
   <br><br>
 - <strong>AnalyticsQueriesService</strong><br>
-  &nbsp;&nbsp;* <code>get_analytics_queries_query_token</code>
-  &nbsp;&nbsp;&nbsp;&nbsp;<strong>GET</strong> /analytics/queries/{queryToken}
-  &nbsp;&nbsp;&nbsp;&nbsp;Retrieve a query execution information
+  &nbsp;&nbsp;* <code>get_analytics_queries_query_external_id_query_external_id</code>
+  &nbsp;&nbsp;&nbsp;&nbsp;<strong>GET</strong> /analytics/queries/queryExternalId/{queryExternalId}
+  &nbsp;&nbsp;&nbsp;&nbsp;Retrieve a query execution information by its external id
+  <br><br>
+- <strong>AnalyticsQueriesService</strong><br>
+  &nbsp;&nbsp;* <code>get_analytics_queries_query_external_id_query_external_id_result</code>
+  &nbsp;&nbsp;&nbsp;&nbsp;<strong>GET</strong> /analytics/queries/queryExternalId/{queryExternalId}/result
+  &nbsp;&nbsp;&nbsp;&nbsp;Generate a temporary URL to download the query result. It retrieves the query by its external id
+  <br><br>
+- <strong>AnalyticsQueriesService</strong><br>
+  &nbsp;&nbsp;* <code>get_analytics_queries_query_token_query_token</code>
+  &nbsp;&nbsp;&nbsp;&nbsp;<strong>GET</strong> /analytics/queries/queryToken/{queryToken}
+  &nbsp;&nbsp;&nbsp;&nbsp;Retrieve a query execution information by its query token
   <br><br>
 - <strong>AnalyticsQueriesService</strong><br>
-  &nbsp;&nbsp;* <code>get_analytics_queries_query_token_result</code>
-  &nbsp;&nbsp;&nbsp;&nbsp;<strong>GET</strong> /analytics/queries/{queryToken}/result
-  &nbsp;&nbsp;&nbsp;&nbsp;Generate a temporary URL to download the query result
+  &nbsp;&nbsp;* <code>get_analytics_queries_query_token_query_token_result</code>
+  &nbsp;&nbsp;&nbsp;&nbsp;<strong>GET</strong> /analytics/queries/queryToken/{queryToken}/result
+  &nbsp;&nbsp;&nbsp;&nbsp;Generate a temporary URL to download the query result. It retrieves the query by its query token
   <br><br>
 - <strong>AnalyticsQueriesService</strong><br>
   &nbsp;&nbsp;* <code>post_analytics_queries_submit</code>

{postfinancecheckout-6.0.0 → postfinancecheckout-6.1.0}/postfinancecheckout/__init__.py

@@ -23,7 +23,7 @@ limitations under the License.
 """
 
 
-__version__ = "6.0.0"
+__version__ = "6.1.0"
 
 from postfinancecheckout.service.accounts_service import AccountsService
 from postfinancecheckout.service.analytics_queries_service import AnalyticsQueriesService

{postfinancecheckout-6.0.0 → postfinancecheckout-6.1.0}/postfinancecheckout/api_client.py

@@ -181,7 +181,7 @@ class ApiClient:
 
         # predefined default headers
         default_headers = {
-            'x-meta-sdk-version': '6.0.0',
+            'x-meta-sdk-version': '6.1.0',
             'x-meta-sdk-language': 'python',
             'x-meta-sdk-provider': 'postfinancecheckout',
             'x-meta-sdk-language-version': platform.python_version()

{postfinancecheckout-6.0.0 → postfinancecheckout-6.1.0}/postfinancecheckout/configuration.py

@@ -317,7 +317,7 @@ class Configuration:
                "OS: {env}\n"\
                "Python Version: {pyversion}\n"\
                "Version of the API: 2.0\n"\
-               "SDK Package Version: 6.0.0".\
+               "SDK Package Version: 6.1.0".\
                format(env=sys.platform, pyversion=sys.version)
 
     def get_host_settings(self):

{postfinancecheckout-6.0.0 → postfinancecheckout-6.1.0}/postfinancecheckout/models/analytics_query_execution_request.py

@@ -38,9 +38,9 @@ class AnalyticsQueryExecutionRequest(BaseModel):
     """
     AnalyticsQueryExecutionRequest
     """
-    sftp_dispatch_settings_id: Optional[StrictInt] = Field(default=None, description="Optional. Active SFTP Dispatch connection settings ID (dispatch settings ID) associated with the target account. Only required if the Analytics query result file is scheduled for delivery to a remote SFTP server.", alias="sftpDispatchSettingsId")
-    sftp_dispatch_result_file_rename_pattern: Optional[StrictStr] = Field(default=None, description="Optional. Renaming pattern for Analytics query result file (may be used when Analytics query results file is scheduled for SFTP delivery). Pattern may look like Latin alphabet string with some timestamp placeholder: \"transaction_report_{YYYMMDD_hhmmss}\". Supported placeholder formats are just these: DDMMYY , MMDDYY , YYYYMMDD , DD_MM_YY , DD-MM-YY , YYYY-MM-DD , YYYY_MM_DD , YYYYMMDD_hhmmss , YYYY-MM-DD_hh-mm-ss", alias="sftpDispatchResultFileRenamePattern")
-    sql: Optional[Annotated[str, Field(min_length=3, strict=True, max_length=100000)]] = Field(default=None, description="The SQL query (in PrestoDB dialect) to be executed against the analytics database. This query defines the data retrieval operation.")
+    sftp_dispatch_settings_id: Optional[StrictInt] = Field(default=None, description="Optional. ID of the active SFTP configuration to use (associated with the target account). This is only required if the result file is scheduled for delivery to a remote SFTP server.", alias="sftpDispatchSettingsId")
+    sftp_dispatch_result_file_rename_pattern: Optional[StrictStr] = Field(default=None, description="Optional. Renaming pattern used for the result file during SFTP delivery. You can use a combination of fixed Latin text and timestamp variables (e.g., \"transaction_report_{YYYMMDD_hhmmss}\"). Supported variable formats: DDMMYY, MMDDYY, YYYYMMDD, DD_MM_YY, DD-MM-YY, YYYY-MM-DD, YYYY_MM_DD, YYYYMMDD_hhmmss, YYYY-MM-DD_hh-mm-ss.", alias="sftpDispatchResultFileRenamePattern")
+    sql: Optional[Annotated[str, Field(min_length=3, strict=True, max_length=100000)]] = Field(default=None, description="The SQL query (in PrestoDB dialect) to execute on the analytics database. This query defines exactly which data should be retrieved.")
     __properties: ClassVar[List[str]] = ["sftpDispatchSettingsId", "sftpDispatchResultFileRenamePattern", "sql"]
 
     model_config = ConfigDict(

{postfinancecheckout-6.0.0 → postfinancecheckout-6.1.0}/postfinancecheckout/models/submitted_analytics_query_execution.py

@@ -39,6 +39,7 @@ class SubmittedAnalyticsQueryExecution(BaseModel):
     """
     SubmittedAnalyticsQueryExecution
     """
+    query_external_id: Optional[StrictStr] = Field(default=None, description="The external id associated with this query, if any.", alias="queryExternalId")
     account_id: Optional[StrictInt] = Field(default=None, description="The ID of the target account for which the analytics query will be executed, determining the data scope for the request.", alias="accountId")
     total_billed_execution_time_ms: Optional[StrictInt] = Field(default=None, description="The total execution time, in milliseconds, that has been billed for the query.", alias="totalBilledExecutionTimeMs")
     created_timestamp: Optional[datetime] = Field(default=None, description="The date and time when the query was created.", alias="createdTimestamp")
@@ -48,7 +49,7 @@ class SubmittedAnalyticsQueryExecution(BaseModel):
     portal_query_token: Optional[StrictStr] = Field(default=None, description="The unique query token associated with the analytics query execution.", alias="portalQueryToken")
     result_file_bytes: Optional[StrictInt] = Field(default=None, description="The size, in bytes, of the result file generated by the query.", alias="resultFileBytes")
     status: Optional[FacadeUserFriendlyQueryStatusModel] = None
-    __properties: ClassVar[List[str]] = ["accountId", "totalBilledExecutionTimeMs", "createdTimestamp", "downloadRequests", "originalQuery", "scannedBytes", "portalQueryToken", "resultFileBytes", "status"]
+    __properties: ClassVar[List[str]] = ["queryExternalId", "accountId", "totalBilledExecutionTimeMs", "createdTimestamp", "downloadRequests", "originalQuery", "scannedBytes", "portalQueryToken", "resultFileBytes", "status"]
 
     model_config = ConfigDict(
         populate_by_name=True,
@@ -88,8 +89,10 @@ class SubmittedAnalyticsQueryExecution(BaseModel):
         * OpenAPI `readOnly` fields are excluded.
         * OpenAPI `readOnly` fields are excluded.
         * OpenAPI `readOnly` fields are excluded.
+        * OpenAPI `readOnly` fields are excluded.
         """
         excluded_fields: Set[str] = set([
+            "query_external_id",
             "account_id",
             "total_billed_execution_time_ms",
             "created_timestamp",
@@ -117,6 +120,7 @@ class SubmittedAnalyticsQueryExecution(BaseModel):
             return cls.model_validate(obj)
 
         _obj = cls.model_validate({
+            "queryExternalId": obj.get("queryExternalId"),
             "accountId": obj.get("accountId"),
             "totalBilledExecutionTimeMs": obj.get("totalBilledExecutionTimeMs"),
             "createdTimestamp": obj.get("createdTimestamp"),