README.md

Reconciliation

(reconciliation)

Available Operations

• create_policy - Create a policy
• delete_policy - Delete a policy
• get_policy - Get a policy
• get_reconciliation - Get a reconciliation
• list_policies - List policies
• list_reconciliations - List reconciliations
• reconcile - Reconcile using a policy
• reconciliationget_server_info - Get server info

create_policy

Create a policy

Example Usage

import sdk
from sdk.models import shared

s = sdk.SDK(
    authorization="<YOUR_AUTHORIZATION_HERE>",
)


res = s.reconciliation.create_policy(request=shared.PolicyRequest(
    ledger_name='default',
    ledger_query={
        'key': '<value>',
    },
    name='XXX',
    payments_pool_id='XXX',
))

if res.policy_response is not None:
    # handle response
    pass

Parameters

Parameter	Type	Required	Description
request	shared.PolicyRequest	✔️	The request object to use for the request.

Response

operations.CreatePolicyResponse

Errors

Error Object	Status Code	Content Type
errors.ReconciliationErrorResponse	default	application/json
errors.SDKError	4xx-5xx	/

delete_policy

Delete a policy by its id.

Example Usage

import sdk
from sdk.models import operations

s = sdk.SDK(
    authorization="<YOUR_AUTHORIZATION_HERE>",
)


res = s.reconciliation.delete_policy(request=operations.DeletePolicyRequest(
    policy_id='XXX',
))

if res is not None:
    # handle response
    pass

Parameters

Parameter	Type	Required	Description
request	operations.DeletePolicyRequest	✔️	The request object to use for the request.

Response

operations.DeletePolicyResponse

Errors

Error Object	Status Code	Content Type
errors.ReconciliationErrorResponse	default	application/json
errors.SDKError	4xx-5xx	/

get_policy

Get a policy

Example Usage

import sdk
from sdk.models import operations

s = sdk.SDK(
    authorization="<YOUR_AUTHORIZATION_HERE>",
)


res = s.reconciliation.get_policy(request=operations.GetPolicyRequest(
    policy_id='XXX',
))

if res.policy_response is not None:
    # handle response
    pass

Parameters

Parameter	Type	Required	Description
request	operations.GetPolicyRequest	✔️	The request object to use for the request.

Response

operations.GetPolicyResponse

Errors

Error Object	Status Code	Content Type
errors.ReconciliationErrorResponse	default	application/json
errors.SDKError	4xx-5xx	/

get_reconciliation

Get a reconciliation

Example Usage

import sdk
from sdk.models import operations

s = sdk.SDK(
    authorization="<YOUR_AUTHORIZATION_HERE>",
)


res = s.reconciliation.get_reconciliation(request=operations.GetReconciliationRequest(
    reconciliation_id='XXX',
))

if res.reconciliation_response is not None:
    # handle response
    pass

Parameters

Parameter	Type	Required	Description
request	operations.GetReconciliationRequest	✔️	The request object to use for the request.

Response

operations.GetReconciliationResponse

Errors

Error Object	Status Code	Content Type
errors.ReconciliationErrorResponse	default	application/json
errors.SDKError	4xx-5xx	/

list_policies

List policies

Example Usage

import sdk
from sdk.models import operations

s = sdk.SDK(
    authorization="<YOUR_AUTHORIZATION_HERE>",
)


res = s.reconciliation.list_policies(request=operations.ListPoliciesRequest(
    cursor='aHR0cHM6Ly9nLnBhZ2UvTmVrby1SYW1lbj9zaGFyZQ==',
    page_size=100,
))

if res.policies_cursor_response is not None:
    # handle response
    pass

Parameters

Parameter	Type	Required	Description
request	operations.ListPoliciesRequest	✔️	The request object to use for the request.

Response

operations.ListPoliciesResponse

Errors

Error Object	Status Code	Content Type
errors.ReconciliationErrorResponse	default	application/json
errors.SDKError	4xx-5xx	/

list_reconciliations

List reconciliations

Example Usage

import sdk
from sdk.models import operations

s = sdk.SDK(
    authorization="<YOUR_AUTHORIZATION_HERE>",
)


res = s.reconciliation.list_reconciliations(request=operations.ListReconciliationsRequest(
    cursor='aHR0cHM6Ly9nLnBhZ2UvTmVrby1SYW1lbj9zaGFyZQ==',
    page_size=100,
))

if res.reconciliations_cursor_response is not None:
    # handle response
    pass

Parameters

Parameter	Type	Required	Description
request	operations.ListReconciliationsRequest	✔️	The request object to use for the request.

Response

operations.ListReconciliationsResponse

Errors

Error Object	Status Code	Content Type
errors.ReconciliationErrorResponse	default	application/json
errors.SDKError	4xx-5xx	/

reconcile

Reconcile using a policy

Example Usage

import dateutil.parser
import sdk
from sdk.models import operations, shared

s = sdk.SDK(
    authorization="<YOUR_AUTHORIZATION_HERE>",
)


res = s.reconciliation.reconcile(request=operations.ReconcileRequest(
    reconciliation_request=shared.ReconciliationRequest(
        reconciled_at_ledger=dateutil.parser.isoparse('2021-01-01T00:00:00.000Z'),
        reconciled_at_payments=dateutil.parser.isoparse('2021-01-01T00:00:00.000Z'),
    ),
    policy_id='XXX',
))

if res.reconciliation_response is not None:
    # handle response
    pass

Parameters

Parameter	Type	Required	Description
request	operations.ReconcileRequest	✔️	The request object to use for the request.

Response

operations.ReconcileResponse

Errors

Error Object	Status Code	Content Type
errors.ReconciliationErrorResponse	default	application/json
errors.SDKError	4xx-5xx	/

reconciliationget_server_info

Get server info

Example Usage

import sdk

s = sdk.SDK(
    authorization="<YOUR_AUTHORIZATION_HERE>",
)


res = s.reconciliation.reconciliationget_server_info()

if res.server_info is not None:
    # handle response
    pass

Response

operations.ReconciliationgetServerInfoResponse

Errors

Error Object	Status Code	Content Type
errors.ReconciliationErrorResponse	default	application/json
errors.SDKError	4xx-5xx	/