formance-sdk-python 4.1.0__tar.gz → 4.2.0__tar.gz

{formance-sdk-python-4.1.0/src/formance_sdk_python.egg-info → formance-sdk-python-4.2.0}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: formance-sdk-python
-Version: 4.1.0
+Version: 4.2.0
 Summary: Python Client SDK Generated by Speakeasy
 Home-page: https://github.com/formancehq/formance-sdk-python.git
 Author: Formance
@@ -276,13 +276,13 @@ Description: # formance-sdk-python
         
         * [get_versions](https://github.com/formancehq/formance-sdk-python/blob/master/docs/sdks/sdk/README.md#get_versions) - Show stack version information
         
-        ### [search](https://github.com/formancehq/formance-sdk-python/blob/master/docs/sdks/search/README.md)
+        ### [~~search~~](https://github.com/formancehq/formance-sdk-python/blob/master/docs/sdks/search/README.md)
         
         
-        #### [search.v1](https://github.com/formancehq/formance-sdk-python/blob/master/docs/sdks/sdksearchv1/README.md)
+        #### [~~search.v1~~](https://github.com/formancehq/formance-sdk-python/blob/master/docs/sdks/sdksearchv1/README.md)
         
-        * [search](https://github.com/formancehq/formance-sdk-python/blob/master/docs/sdks/sdksearchv1/README.md#search) - search.v1
-        * [searchget_server_info](https://github.com/formancehq/formance-sdk-python/blob/master/docs/sdks/sdksearchv1/README.md#searchget_server_info) - Get server info
+        * [~~search~~](https://github.com/formancehq/formance-sdk-python/blob/master/docs/sdks/sdksearchv1/README.md#search) - search.v1 :warning: **Deprecated**
+        * [~~searchget_server_info~~](https://github.com/formancehq/formance-sdk-python/blob/master/docs/sdks/sdksearchv1/README.md#searchget_server_info) - Get server info :warning: **Deprecated**
         
         ### [wallets](https://github.com/formancehq/formance-sdk-python/blob/master/docs/sdks/wallets/README.md)
         
@@ -338,10 +338,10 @@ Description: # formance-sdk-python
         
         When custom error responses are specified for an operation, the SDK may also raise their associated exception. You can refer to respective *Errors* tables in SDK docs for more details on possible exception types for each operation. For example, the `create_transactions` method may raise the following exceptions:
         
-        | Error Type           | Status Code          | Content Type         |
-        | -------------------- | -------------------- | -------------------- |
-        | errors.ErrorResponse | default              | application/json     |
-        | errors.SDKError      | 4XX, 5XX             | \*/\*                |
+        | Error Type           | Status Code | Content Type     |
+        | -------------------- | ----------- | ---------------- |
+        | errors.ErrorResponse | default     | application/json |
+        | errors.SDKError      | 4XX, 5XX    | \*/\*            |
         
         ### Example
         
@@ -410,10 +410,12 @@ Description: # formance-sdk-python
         
         You can override the default server globally by passing a server index to the `server_idx: int` optional parameter when initializing the SDK client instance. The selected server will then be used as the default on the operations that use it. This table lists the indexes associated with the available servers:
         
-        | # | Server | Variables |
-        | - | ------ | --------- |
-        | 0 | `http://localhost` | None |
-        | 1 | `https://{organization}.{environment}.formance.cloud` | `environment` (default is `sandbox`), `organization` (default is `orgID-stackID`) |
+        | #   | Server                                                | Variables                                                       | Default values                    |
+        | --- | ----------------------------------------------------- | --------------------------------------------------------------- | --------------------------------- |
+        | 0   | `http://localhost`                                    |                                                                 |                                   |
+        | 1   | `https://{organization}.{environment}.formance.cloud` | `environment: models.ServerEnvironment`<br/>`organization: str` | `"sandbox"`<br/>`"orgID-stackID"` |
+        
+        If the selected server has variables, you may override their default values through the additional parameters made available in the SDK constructor.
         
         #### Example
         
@@ -438,12 +440,6 @@ Description: # formance-sdk-python
         
         ```
         
-        #### Variables
-        
-        Some of the server options above contain variables. If you want to set the values of those variables, the following optional parameters are available when initializing the SDK client instance:
-         * `environment: models.ServerEnvironment`
-         * `organization: str`
-        
         ### Override Server URL Per-Client
         
         The default server can also be overridden globally by passing a URL to the `server_url: str` optional parameter when initializing the SDK client instance. For example:
@@ -492,9 +488,9 @@ Description: # formance-sdk-python
         
         This SDK supports the following security scheme globally:
         
-        | Name                           | Type                           | Scheme                         |
-        | ------------------------------ | ------------------------------ | ------------------------------ |
-        | `client_id` `client_secret`    | oauth2                         | OAuth2 Client Credentials Flow |
+        | Name                            | Type   | Scheme                         |
+        | ------------------------------- | ------ | ------------------------------ |
+        | `client_id`<br/>`client_secret` | oauth2 | OAuth2 Client Credentials Flow |
         
         You can set the security parameters through the `security` optional parameter when initializing the SDK client instance. For example:
         ```python

{formance-sdk-python-4.1.0 → formance-sdk-python-4.2.0}/README.md

@@ -269,13 +269,13 @@ if res.get_versions_response is not None:
 
 * [get_versions](docs/sdks/sdk/README.md#get_versions) - Show stack version information
 
-### [search](docs/sdks/search/README.md)
+### [~~search~~](docs/sdks/search/README.md)
 
 
-#### [search.v1](docs/sdks/sdksearchv1/README.md)
+#### [~~search.v1~~](docs/sdks/sdksearchv1/README.md)
 
-* [search](docs/sdks/sdksearchv1/README.md#search) - search.v1
-* [searchget_server_info](docs/sdks/sdksearchv1/README.md#searchget_server_info) - Get server info
+* [~~search~~](docs/sdks/sdksearchv1/README.md#search) - search.v1 :warning: **Deprecated**
+* [~~searchget_server_info~~](docs/sdks/sdksearchv1/README.md#searchget_server_info) - Get server info :warning: **Deprecated**
 
 ### [wallets](docs/sdks/wallets/README.md)
 
@@ -331,10 +331,10 @@ By default, an API error will raise a errors.SDKError exception, which has the f
 
 When custom error responses are specified for an operation, the SDK may also raise their associated exception. You can refer to respective *Errors* tables in SDK docs for more details on possible exception types for each operation. For example, the `create_transactions` method may raise the following exceptions:
 
-| Error Type           | Status Code          | Content Type         |
-| -------------------- | -------------------- | -------------------- |
-| errors.ErrorResponse | default              | application/json     |
-| errors.SDKError      | 4XX, 5XX             | \*/\*                |
+| Error Type           | Status Code | Content Type     |
+| -------------------- | ----------- | ---------------- |
+| errors.ErrorResponse | default     | application/json |
+| errors.SDKError      | 4XX, 5XX    | \*/\*            |
 
 ### Example
 
@@ -403,10 +403,12 @@ if res.transactions_response is not None:
 
 You can override the default server globally by passing a server index to the `server_idx: int` optional parameter when initializing the SDK client instance. The selected server will then be used as the default on the operations that use it. This table lists the indexes associated with the available servers:
 
-| # | Server | Variables |
-| - | ------ | --------- |
-| 0 | `http://localhost` | None |
-| 1 | `https://{organization}.{environment}.formance.cloud` | `environment` (default is `sandbox`), `organization` (default is `orgID-stackID`) |
+| #   | Server                                                | Variables                                                       | Default values                    |
+| --- | ----------------------------------------------------- | --------------------------------------------------------------- | --------------------------------- |
+| 0   | `http://localhost`                                    |                                                                 |                                   |
+| 1   | `https://{organization}.{environment}.formance.cloud` | `environment: models.ServerEnvironment`<br/>`organization: str` | `"sandbox"`<br/>`"orgID-stackID"` |
+
+If the selected server has variables, you may override their default values through the additional parameters made available in the SDK constructor.
 
 #### Example
 
@@ -431,12 +433,6 @@ if res.get_versions_response is not None:
 
 ```
 
-#### Variables
-
-Some of the server options above contain variables. If you want to set the values of those variables, the following optional parameters are available when initializing the SDK client instance:
- * `environment: models.ServerEnvironment`
- * `organization: str`
-
 ### Override Server URL Per-Client
 
 The default server can also be overridden globally by passing a URL to the `server_url: str` optional parameter when initializing the SDK client instance. For example:
@@ -485,9 +481,9 @@ s = sdk.SDK(client=http_client)
 
 This SDK supports the following security scheme globally:
 
-| Name                           | Type                           | Scheme                         |
-| ------------------------------ | ------------------------------ | ------------------------------ |
-| `client_id` `client_secret`    | oauth2                         | OAuth2 Client Credentials Flow |
+| Name                            | Type   | Scheme                         |
+| ------------------------------- | ------ | ------------------------------ |
+| `client_id`<br/>`client_secret` | oauth2 | OAuth2 Client Credentials Flow |
 
 You can set the security parameters through the `security` optional parameter when initializing the SDK client instance. For example:
 ```python

{formance-sdk-python-4.1.0 → formance-sdk-python-4.2.0}/setup.py

@@ -19,7 +19,7 @@ except FileNotFoundError:
 
 setuptools.setup(
     name='formance-sdk-python',
-    version='4.1.0',
+    version='4.2.0',
     author='Formance',
     description='Python Client SDK Generated by Speakeasy',
     url='https://github.com/formancehq/formance-sdk-python.git',

{formance-sdk-python-4.1.0 → formance-sdk-python-4.2.0/src/formance_sdk_python.egg-info}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: formance-sdk-python
-Version: 4.1.0
+Version: 4.2.0
 Summary: Python Client SDK Generated by Speakeasy
 Home-page: https://github.com/formancehq/formance-sdk-python.git
 Author: Formance
@@ -276,13 +276,13 @@ Description: # formance-sdk-python
         
         * [get_versions](https://github.com/formancehq/formance-sdk-python/blob/master/docs/sdks/sdk/README.md#get_versions) - Show stack version information
         
-        ### [search](https://github.com/formancehq/formance-sdk-python/blob/master/docs/sdks/search/README.md)
+        ### [~~search~~](https://github.com/formancehq/formance-sdk-python/blob/master/docs/sdks/search/README.md)
         
         
-        #### [search.v1](https://github.com/formancehq/formance-sdk-python/blob/master/docs/sdks/sdksearchv1/README.md)
+        #### [~~search.v1~~](https://github.com/formancehq/formance-sdk-python/blob/master/docs/sdks/sdksearchv1/README.md)
         
-        * [search](https://github.com/formancehq/formance-sdk-python/blob/master/docs/sdks/sdksearchv1/README.md#search) - search.v1
-        * [searchget_server_info](https://github.com/formancehq/formance-sdk-python/blob/master/docs/sdks/sdksearchv1/README.md#searchget_server_info) - Get server info
+        * [~~search~~](https://github.com/formancehq/formance-sdk-python/blob/master/docs/sdks/sdksearchv1/README.md#search) - search.v1 :warning: **Deprecated**
+        * [~~searchget_server_info~~](https://github.com/formancehq/formance-sdk-python/blob/master/docs/sdks/sdksearchv1/README.md#searchget_server_info) - Get server info :warning: **Deprecated**
         
         ### [wallets](https://github.com/formancehq/formance-sdk-python/blob/master/docs/sdks/wallets/README.md)
         
@@ -338,10 +338,10 @@ Description: # formance-sdk-python
         
         When custom error responses are specified for an operation, the SDK may also raise their associated exception. You can refer to respective *Errors* tables in SDK docs for more details on possible exception types for each operation. For example, the `create_transactions` method may raise the following exceptions:
         
-        | Error Type           | Status Code          | Content Type         |
-        | -------------------- | -------------------- | -------------------- |
-        | errors.ErrorResponse | default              | application/json     |
-        | errors.SDKError      | 4XX, 5XX             | \*/\*                |
+        | Error Type           | Status Code | Content Type     |
+        | -------------------- | ----------- | ---------------- |
+        | errors.ErrorResponse | default     | application/json |
+        | errors.SDKError      | 4XX, 5XX    | \*/\*            |
         
         ### Example
         
@@ -410,10 +410,12 @@ Description: # formance-sdk-python
         
         You can override the default server globally by passing a server index to the `server_idx: int` optional parameter when initializing the SDK client instance. The selected server will then be used as the default on the operations that use it. This table lists the indexes associated with the available servers:
         
-        | # | Server | Variables |
-        | - | ------ | --------- |
-        | 0 | `http://localhost` | None |
-        | 1 | `https://{organization}.{environment}.formance.cloud` | `environment` (default is `sandbox`), `organization` (default is `orgID-stackID`) |
+        | #   | Server                                                | Variables                                                       | Default values                    |
+        | --- | ----------------------------------------------------- | --------------------------------------------------------------- | --------------------------------- |
+        | 0   | `http://localhost`                                    |                                                                 |                                   |
+        | 1   | `https://{organization}.{environment}.formance.cloud` | `environment: models.ServerEnvironment`<br/>`organization: str` | `"sandbox"`<br/>`"orgID-stackID"` |
+        
+        If the selected server has variables, you may override their default values through the additional parameters made available in the SDK constructor.
         
         #### Example
         
@@ -438,12 +440,6 @@ Description: # formance-sdk-python
         
         ```
         
-        #### Variables
-        
-        Some of the server options above contain variables. If you want to set the values of those variables, the following optional parameters are available when initializing the SDK client instance:
-         * `environment: models.ServerEnvironment`
-         * `organization: str`
-        
         ### Override Server URL Per-Client
         
         The default server can also be overridden globally by passing a URL to the `server_url: str` optional parameter when initializing the SDK client instance. For example:
@@ -492,9 +488,9 @@ Description: # formance-sdk-python
         
         This SDK supports the following security scheme globally:
         
-        | Name                           | Type                           | Scheme                         |
-        | ------------------------------ | ------------------------------ | ------------------------------ |
-        | `client_id` `client_secret`    | oauth2                         | OAuth2 Client Credentials Flow |
+        | Name                            | Type   | Scheme                         |
+        | ------------------------------- | ------ | ------------------------------ |
+        | `client_id`<br/>`client_secret` | oauth2 | OAuth2 Client Credentials Flow |
         
         You can set the security parameters through the `security` optional parameter when initializing the SDK client instance. For example:
         ```python

{formance-sdk-python-4.1.0 → formance-sdk-python-4.2.0}/src/sdk/sdk_search_v1.py

@@ -18,6 +18,8 @@ class SDKSearchV1:
     def search(self, request: shared.Query) -> operations.SearchResponse:
         r"""search.v1
         Elasticsearch.v1 query engine
+
+        Deprecated method: This will be removed in a future release, please migrate away from it as soon as possible.
         """
         hook_ctx = HookContext(operation_id='search', oauth2_scopes=['auth:read','search:write'], security_source=self.sdk_configuration.security)
         base_url = utils.template_url(*self.sdk_configuration.get_server_details())
@@ -76,7 +78,10 @@ class SDKSearchV1:
     
     
     def searchget_server_info(self) -> operations.SearchgetServerInfoResponse:
-        r"""Get server info"""
+        r"""Get server info
+
+        Deprecated method: This will be removed in a future release, please migrate away from it as soon as possible.
+        """
         hook_ctx = HookContext(operation_id='searchgetServerInfo', oauth2_scopes=['auth:read','search:read'], security_source=self.sdk_configuration.security)
         base_url = utils.template_url(*self.sdk_configuration.get_server_details())
         

{formance-sdk-python-4.1.0 → formance-sdk-python-4.2.0}/src/sdk/sdkconfiguration.py

@@ -35,10 +35,10 @@ class SDKConfiguration:
     server_idx: Optional[int] = 0
     server_defaults: List[Dict[str, str]] = field(default_factory=List)
     language: str = 'python'
-    openapi_doc_version: str = 'v2.1.0-beta.3'
-    sdk_version: str = '4.1.0'
-    gen_version: str = '2.438.15'
-    user_agent: str = 'speakeasy-sdk/python 4.1.0 2.438.15 v2.1.0-beta.3 formance-sdk-python'
+    openapi_doc_version: str = 'v2.1.1'
+    sdk_version: str = '4.2.0'
+    gen_version: str = '2.461.2'
+    user_agent: str = 'speakeasy-sdk/python 4.2.0 2.461.2 v2.1.1 formance-sdk-python'
     retry_config: Optional[RetryConfig] = None
 
     def __post_init__(self):