Socket
Socket
Sign inDemoInstall

apimatic-core

Package Overview
Dependencies
0
Maintainers
1
Alerts
File Explorer

Install Socket

Detect and block malicious and high-risk dependencies

Install

    apimatic-core

A library that contains core logic and utilities for consuming REST APIs using Python SDKs generated by APIMatic.


Maintainers
1

Readme

apimatic-core

PyPI Tests Test Coverage Licence

Introduction

The APIMatic Core libraries provide a stable runtime that powers all the functionality of SDKs. This includes functionality like the ability to create HTTP requests, handle responses, apply authentication schemes, convert API responses back to object instances, and validate user and server data.

Installation

You will need Python 3.7-3.11 to support this package.

Simply run the command below to install the core library in your SDK. The core library will be added as a dependency your SDK.

pip install apimatic-core

API Call Classes

NameDescription
RequestBuilderA builder class used to build an API Request
APICallA class used to create an API Call object
ResponseHandlerUsed to handle the response returned by the server

Authentication

NameDescription
HeaderAuthA class supports HTTP authentication through HTTP Headers
QueryAuthA class supports HTTP authentication through query parameters
AuthGroupA helper class to support multiple authentication operation
AndA helper class to support AND operation between multiple authentication types
OrA helper class to support OR operation between multiple authentication types
SingleA helper class to support single authentication

Configurations

NameDescription
EndpointConfigurationA class which hold the possible configurations for an endpoint
GlobalConfigurationA class which hold the global configuration properties to make a successful Api Call

Decorators

NameDescription
LazyPropertyA decorator class for lazy instantiation

Exceptions

NameDescription
OneOfValidationExceptionAn exception class for the failed validation of oneOf (union-type) cases
AnyOfValidationExceptionAn exception class for the failed validation of anyOf (union-type) cases
AuthValidationExceptionAn exception class for the failed validation of authentication schemes

Factories

NameDescription
HttpResponseFactoryA factory class to create an HTTP Response

HTTP

NameDescription
HttpCallBackA factory class to create an HTTP Response
HttpClientConfigurationA class used for configuring the SDK by a user
HttpRequestA class which contains information about the HTTP Response
ApiResponseA wrapper class for Api Response
HttpResponseA class which contains information about the HTTP Response

Logging Configuration

NameDescription
ApiLoggingConfigurationHolds overall logging configuration for logging an API call
ApiRequestLoggingConfigurationHolds logging configuration for API request
ApiResponseLoggingConfigurationHolds logging configuration for API response

Logger

NameDescription
SdkLoggerResponsible for logging the request and response of an API call, it represents the default implementation of ApiLogger when there exist any logging configuration
NoneSdkLoggerRepresents the default implementation for ApiLogger when no logging configuration is provided
ConsoleLoggerRepresents the default implementation for Logger when no custom implementation is provided
LoggerFactoryResponsible for providing the ApiLogger implementation (SdkLogger | NoneSdkLogger) based on the logging configuration

Types

NameDescription
SerializationFormatsAn Enumeration of Array serialization formats
DateTimeFormatAn Enumeration of Date Time formats
ErrorCaseA class to represent Exception types
FileWrapperA wrapper to allow passing in content type for file uploads
ParameterA class to represent information about a Parameter passed in an endpoint
XmlAttributesA class to represent information about a XML Parameter passed in an endpoint
OneOfA class to represent information about OneOf union types
AnyOfA class to represent information about AnyOf union types
LeafTypeA class to represent the case information in an OneOf or AnyOf union type

Utilities

NameDescription
ApiHelperA Helper Class with various functions associated with making an API Call
AuthHelperA Helper Class with various functions associated with authentication in API Calls
ComparisonHelperA Helper Class used for the comparison of expected and actual API response
FileHelperA Helper Class for files
XmlHelperA Helper class that holds utility methods for xml serialization and deserialization.
DateTimeHelperA Helper class that holds utility methods for validation of different datetime formats.
UnionTypeHelperA Helper class that holds utility methods for deserialization and validation of OneOf/AnyOf union types.

FAQs


Did you know?

Socket for GitHub automatically highlights issues in each pull request and monitors the health of all your open source dependencies. Discover the contents of your packages and block harmful activity before you install or update your dependencies.

Install

Related posts

SocketSocket SOC 2 Logo

Product

  • Package Alerts
  • Integrations
  • Docs
  • Pricing
  • FAQ
  • Roadmap

Stay in touch

Get open source security insights delivered straight into your inbox.


  • Terms
  • Privacy
  • Security

Made with ⚡️ by Socket Inc