Package: ding-api-sdk
Ding's Python SDK🏗Welcome to your new SDK!🏗It has been generated successfully based on your OpenAPI spec. However, it is not yet ready for production use. Here are some next steps:🛠 Make your SDK feel handcrafted bycustomizing it♻️ Refine your SDK quickly by iterating locally with theSpeakeasy CLI🎁 Publish your SDK to package managers byconfiguring automatic publishing✨ When ready to productionize, delete this section from the READMESDK Installationpipinstallding_api_sdkSDK Example Usageimportdingfromding.modelsimportshareds=ding.Ding(api_key="",)req=shared.CreateAuthenticationRequest(app_realm='1234567890',app_version='1.0.0',callback_url='https://example.com/callback',customer_uuid='28591d9e-a825-47f6-ab11-1a61726305bf',device_id='1234567890',device_model='iPhone 15 Pro',os_version='13.2.1',phone_number='+1234567890',)res=s.otp.post_authentication(req)ifres.create_authentication_responseisnotNone:# handle responsepassAvailable Resources and Operations.otppost_authentication- Create an authenticationpost_check- Check an authentication codepost_retry- Retry an authentication.lookuppost_lookup- Lookup a phone numberError HandlingHandling errors in your SDK should largely match your expectations.  All operations return a response object or raise an error.  If Error objects are specified in your OpenAPI Spec, the SDK will raise the appropriate Error type.Exampleimportdingfromding.modelsimportshareds=ding.Ding(api_key="",)req=shared.CreateAuthenticationRequest(app_realm='1234567890',app_version='1.0.0',callback_url='https://example.com/callback',customer_uuid='28591d9e-a825-47f6-ab11-1a61726305bf',device_id='1234567890',device_model='iPhone 15 Pro',os_version='13.2.1',phone_number='+1234567890',)res=Nonetry:res=s.otp.post_authentication(req)except(ErrorResponse)ase:print(e)# handle exceptionifres.create_authentication_responseisnotNone:# handle responsepassServer SelectionSelect Server by IndexYou can override the default server globally by passing a server index to theserver_idx: intoptional 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:#ServerVariables0https://api.ding.live/v1NoneFor example:importdingfromding.modelsimportshareds=ding.Ding(server_idx=0,api_key="",)req=shared.CreateAuthenticationRequest(app_realm='1234567890',app_version='1.0.0',callback_url='https://example.com/callback',customer_uuid='28591d9e-a825-47f6-ab11-1a61726305bf',device_id='1234567890',device_model='iPhone 15 Pro',os_version='13.2.1',phone_number='+1234567890',)res=s.otp.post_authentication(req)ifres.create_authentication_responseisnotNone:# handle responsepassOverride Server URL Per-ClientThe default server can also be overridden globally by passing a URL to theserver_url: stroptional parameter when initializing the SDK client instance. For example:importdingfromding.modelsimportshareds=ding.Ding(server_url="https://api.ding.live/v1",api_key="",)req=shared.CreateAuthenticationRequest(app_realm='1234567890',app_version='1.0.0',callback_url='https://example.com/callback',customer_uuid='28591d9e-a825-47f6-ab11-1a61726305bf',device_id='1234567890',device_model='iPhone 15 Pro',os_version='13.2.1',phone_number='+1234567890',)res=s.otp.post_authentication(req)ifres.create_authentication_responseisnotNone:# handle responsepassCustom HTTP ClientThe Python SDK makes API calls using the (requests)[https://pypi.org/project/requests/] HTTP library.  In order to provide a convenient way to configure timeouts, cookies, proxies, custom headers, and other low-level configuration, you can initialize the SDK client with a customrequests.Sessionobject.For example, you could specify a header for every request that your sdk makes as follows:importdingimportrequestshttp_client=requests.Session()http_client.headers.update({'x-custom-header':'someValue'})s=ding.Ding(client:http_client)AuthenticationPer-Client Security SchemesYour SDK supports the following security scheme globally:NameTypeSchemeapi_keyapiKeyAPI keyTo authenticate with the API theapi_keyparameter must be set when initializing the SDK client instance. For example:importdingfromding.modelsimportshareds=ding.Ding(api_key="",)req=shared.CreateAuthenticationRequest(app_realm='1234567890',app_version='1.0.0',callback_url='https://example.com/callback',customer_uuid='28591d9e-a825-47f6-ab11-1a61726305bf',device_id='1234567890',device_model='iPhone 15 Pro',os_version='13.2.1',phone_number='+1234567890',)res=s.otp.post_authentication(req)ifres.create_authentication_responseisnotNone:# handle responsepassDevelopmentMaturityThis SDK is in beta, and there may be breaking changes between versions without a major version update. Therefore, we recommend pinning usage
to a specific package version. This way, you can install the same version each time without breaking changes unless you are intentionally
looking for the latest version.ContributionsWhile we value open-source contributions to this SDK, this library is generated programmatically.
Feel free to open a PR or a Github issue as a proof of concept and we'll do our best to include it in a future release!SDK Created bySpeakeasy