Skip to content

Latest commit

 

History

History
179 lines (126 loc) · 6.53 KB

CompaniesApi.md

File metadata and controls

179 lines (126 loc) · 6.53 KB
Raw

conekta.CompaniesApi

All URIs are relative to https://api.conekta.io

Method HTTP request Description
get_companies GET /companies Get List of Companies
get_company GET /companies/{id} Get Company

get_companies

GetCompaniesResponse get_companies(accept_language=accept_language, limit=limit, search=search, next=next, previous=previous)

Get List of Companies

Consume the list of child companies. This is used for holding companies with several child entities.

Example

  • Bearer Authentication (bearerAuth):
import conekta
from conekta.models.get_companies_response import GetCompaniesResponse
from conekta.rest import ApiException
from pprint import pprint

# Defining the host is optional and defaults to https://api.conekta.io
# See configuration.py for a list of all supported configuration parameters.
configuration = conekta.Configuration(
    host = "https://api.conekta.io"
)

# The client must configure the authentication and authorization parameters
# in accordance with the API server security policy.
# Examples for each auth method are provided below, use the example that
# satisfies your auth use case.

# Configure Bearer authorization: bearerAuth
configuration = conekta.Configuration(
    access_token = os.environ["BEARER_TOKEN"]
)

# Enter a context with an instance of the API client
with conekta.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = conekta.CompaniesApi(api_client)
    accept_language = es # str | Use for knowing which language to use (optional) (default to es)
    limit = 20 # int | The numbers of items to return, the maximum value is 250 (optional) (default to 20)
    search = 'search_example' # str | General order search, e.g. by mail, reference etc. (optional)
    next = 'next_example' # str | next page (optional)
    previous = 'previous_example' # str | previous page (optional)

    try:
        # Get List of Companies
        api_response = api_instance.get_companies(accept_language=accept_language, limit=limit, search=search, next=next, previous=previous)
        print("The response of CompaniesApi->get_companies:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling CompaniesApi->get_companies: %s\n" % e)

Parameters

Name Type Description Notes
accept_language str Use for knowing which language to use [optional] [default to es]
limit int The numbers of items to return, the maximum value is 250 [optional] [default to 20]
search str General order search, e.g. by mail, reference etc. [optional]
next str next page [optional]
previous str previous page [optional]

Return type

GetCompaniesResponse

Authorization

bearerAuth

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/vnd.conekta-v2.1.0+json

HTTP response details

Status code Description Response headers
200 successful * Date - The date and time that the response was sent
* Content-Type - The format of the response body
* Content-Length - The length of the response body in bytes
* Connection - The type of connection used to transfer the response
* Conekta-Media-Type -
401 authentication error -
500 internal server error -

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

get_company

CompanyResponse get_company(id, accept_language=accept_language)

Get Company

Example

  • Bearer Authentication (bearerAuth):
import conekta
from conekta.models.company_response import CompanyResponse
from conekta.rest import ApiException
from pprint import pprint

# Defining the host is optional and defaults to https://api.conekta.io
# See configuration.py for a list of all supported configuration parameters.
configuration = conekta.Configuration(
    host = "https://api.conekta.io"
)

# The client must configure the authentication and authorization parameters
# in accordance with the API server security policy.
# Examples for each auth method are provided below, use the example that
# satisfies your auth use case.

# Configure Bearer authorization: bearerAuth
configuration = conekta.Configuration(
    access_token = os.environ["BEARER_TOKEN"]
)

# Enter a context with an instance of the API client
with conekta.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = conekta.CompaniesApi(api_client)
    id = '6307a60c41de27127515a575' # str | Identifier of the resource
    accept_language = es # str | Use for knowing which language to use (optional) (default to es)

    try:
        # Get Company
        api_response = api_instance.get_company(id, accept_language=accept_language)
        print("The response of CompaniesApi->get_company:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling CompaniesApi->get_company: %s\n" % e)

Parameters

Name Type Description Notes
id str Identifier of the resource
accept_language str Use for knowing which language to use [optional] [default to es]

Return type

CompanyResponse

Authorization

bearerAuth

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/vnd.conekta-v2.1.0+json

HTTP response details

Status code Description Response headers
200 successful * Date - The date and time that the response was sent
* Content-Type - The format of the response body
* Content-Length - The length of the response body in bytes
* Connection - The type of connection used to transfer the response
* Conekta-Media-Type -
401 authentication error -
404 not found entity -
500 internal server error -

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