Skip to content

Latest commit

 

History

History
271 lines (208 loc) · 10.4 KB

CustomFieldApi.md

File metadata and controls

271 lines (208 loc) · 10.4 KB
Raw

killbill.CustomFieldApi

All URIs are relative to /

Method HTTP request Description
get_custom_field_audit_logs_with_history GET /1.0/kb/customFields/{customFieldId}/auditLogsWithHistory Retrieve custom field audit logs with history by id
get_custom_fields GET /1.0/kb/customFields/pagination List custom fields
search_custom_fields GET /1.0/kb/customFields/search/{searchKey} Search custom fields
search_custom_fields_by_type_name GET /1.0/kb/customFields/search Search custom fields by type, name and optional value

get_custom_field_audit_logs_with_history

list[AuditLog] get_custom_field_audit_logs_with_history(custom_field_id)

Retrieve custom field audit logs with history by id

Example

from __future__ import print_function
import time
import killbill
from killbill.rest import ApiException
from pprint import pprint

# Configure API key authorization: Killbill Api Key
configuration = killbill.Configuration()
configuration.api_key['X-Killbill-ApiKey'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['X-Killbill-ApiKey'] = 'Bearer'
# Configure API key authorization: Killbill Api Secret
configuration = killbill.Configuration()
configuration.api_key['X-Killbill-ApiSecret'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['X-Killbill-ApiSecret'] = 'Bearer'# Configure HTTP basic authorization: basicAuth
configuration = killbill.Configuration()
configuration.username = 'YOUR_USERNAME'
configuration.password = 'YOUR_PASSWORD'

# create an instance of the API class
api_instance = killbill.CustomFieldApi(killbill.ApiClient(configuration))
custom_field_id = '38400000-8cf0-11bd-b23e-10b96e4ef00d' # str | 

try:
    # Retrieve custom field audit logs with history by id
    api_response = api_instance.get_custom_field_audit_logs_with_history(custom_field_id)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling CustomFieldApi->get_custom_field_audit_logs_with_history: %s\n" % e)

Parameters

Name Type Description Notes
custom_field_id str

Return type

list[AuditLog]

Authorization

[Killbill Api Key](../README.md#Killbill Api Key), [Killbill Api Secret](../README.md#Killbill Api Secret), basicAuth

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

get_custom_fields

list[CustomField] get_custom_fields(offset=offset, limit=limit, audit=audit)

List custom fields

Example

from __future__ import print_function
import time
import killbill
from killbill.rest import ApiException
from pprint import pprint

# Configure API key authorization: Killbill Api Key
configuration = killbill.Configuration()
configuration.api_key['X-Killbill-ApiKey'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['X-Killbill-ApiKey'] = 'Bearer'
# Configure API key authorization: Killbill Api Secret
configuration = killbill.Configuration()
configuration.api_key['X-Killbill-ApiSecret'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['X-Killbill-ApiSecret'] = 'Bearer'# Configure HTTP basic authorization: basicAuth
configuration = killbill.Configuration()
configuration.username = 'YOUR_USERNAME'
configuration.password = 'YOUR_PASSWORD'

# create an instance of the API class
api_instance = killbill.CustomFieldApi(killbill.ApiClient(configuration))
offset = 0 # int |  (optional) (default to 0)
limit = 100 # int |  (optional) (default to 100)
audit = 'NONE' # str |  (optional) (default to NONE)

try:
    # List custom fields
    api_response = api_instance.get_custom_fields(offset=offset, limit=limit, audit=audit)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling CustomFieldApi->get_custom_fields: %s\n" % e)

Parameters

Name Type Description Notes
offset int [optional] [default to 0]
limit int [optional] [default to 100]
audit str [optional] [default to NONE]

Return type

list[CustomField]

Authorization

[Killbill Api Key](../README.md#Killbill Api Key), [Killbill Api Secret](../README.md#Killbill Api Secret), basicAuth

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

search_custom_fields

list[CustomField] search_custom_fields(search_key, offset=offset, limit=limit, audit=audit)

Search custom fields

Example

from __future__ import print_function
import time
import killbill
from killbill.rest import ApiException
from pprint import pprint

# Configure API key authorization: Killbill Api Key
configuration = killbill.Configuration()
configuration.api_key['X-Killbill-ApiKey'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['X-Killbill-ApiKey'] = 'Bearer'
# Configure API key authorization: Killbill Api Secret
configuration = killbill.Configuration()
configuration.api_key['X-Killbill-ApiSecret'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['X-Killbill-ApiSecret'] = 'Bearer'# Configure HTTP basic authorization: basicAuth
configuration = killbill.Configuration()
configuration.username = 'YOUR_USERNAME'
configuration.password = 'YOUR_PASSWORD'

# create an instance of the API class
api_instance = killbill.CustomFieldApi(killbill.ApiClient(configuration))
search_key = 'search_key_example' # str | 
offset = 0 # int |  (optional) (default to 0)
limit = 100 # int |  (optional) (default to 100)
audit = 'NONE' # str |  (optional) (default to NONE)

try:
    # Search custom fields
    api_response = api_instance.search_custom_fields(search_key, offset=offset, limit=limit, audit=audit)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling CustomFieldApi->search_custom_fields: %s\n" % e)

Parameters

Name Type Description Notes
search_key str
offset int [optional] [default to 0]
limit int [optional] [default to 100]
audit str [optional] [default to NONE]

Return type

list[CustomField]

Authorization

[Killbill Api Key](../README.md#Killbill Api Key), [Killbill Api Secret](../README.md#Killbill Api Secret), basicAuth

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

search_custom_fields_by_type_name

list[CustomField] search_custom_fields_by_type_name(object_type=object_type, field_name=field_name, field_value=field_value, offset=offset, limit=limit, audit=audit)

Search custom fields by type, name and optional value

Example

from __future__ import print_function
import time
import killbill
from killbill.rest import ApiException
from pprint import pprint

# Configure API key authorization: Killbill Api Key
configuration = killbill.Configuration()
configuration.api_key['X-Killbill-ApiKey'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['X-Killbill-ApiKey'] = 'Bearer'
# Configure API key authorization: Killbill Api Secret
configuration = killbill.Configuration()
configuration.api_key['X-Killbill-ApiSecret'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['X-Killbill-ApiSecret'] = 'Bearer'# Configure HTTP basic authorization: basicAuth
configuration = killbill.Configuration()
configuration.username = 'YOUR_USERNAME'
configuration.password = 'YOUR_PASSWORD'

# create an instance of the API class
api_instance = killbill.CustomFieldApi(killbill.ApiClient(configuration))
object_type = 'object_type_example' # str |  (optional)
field_name = 'field_name_example' # str |  (optional)
field_value = 'field_value_example' # str |  (optional)
offset = 0 # int |  (optional) (default to 0)
limit = 100 # int |  (optional) (default to 100)
audit = 'NONE' # str |  (optional) (default to NONE)

try:
    # Search custom fields by type, name and optional value
    api_response = api_instance.search_custom_fields_by_type_name(object_type=object_type, field_name=field_name, field_value=field_value, offset=offset, limit=limit, audit=audit)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling CustomFieldApi->search_custom_fields_by_type_name: %s\n" % e)

Parameters

Name Type Description Notes
object_type str [optional]
field_name str [optional]
field_value str [optional]
offset int [optional] [default to 0]
limit int [optional] [default to 100]
audit str [optional] [default to NONE]

Return type

list[CustomField]

Authorization

[Killbill Api Key](../README.md#Killbill Api Key), [Killbill Api Secret](../README.md#Killbill Api Secret), basicAuth

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]