gigs-client 0.0.1

Gigs Core API

gigs-client

API to manage voice & data plans for smartphones, wearables and IoT in 200+ countries.

This Python package is automatically generated by the OpenAPI Generator project:

• API version: 0.0.1
• Package version: 0.0.1
• Build package: org.openapitools.codegen.languages.PythonClientCodegen

Requirements.

Python 3.7+

Installation & Usage

pip install

If the python package is hosted on a repository, you can install directly using:

pip install git+https://github.com/SwadeshInc/gigs_py_client.git

(you may need to run pip with root permission: sudo pip install git+https://github.com/SwadeshInc/gigs_py_client.git)

Then import the package:

import gigs_client

Setuptools

Install via Setuptools.

python setup.py install --user

(or sudo python setup.py install to install the package for all users)

Then import the package:

import gigs_client

Tests

Execute pytest to run the tests.

Getting Started

Please follow the installation procedure and then run the following:

import time
import gigs_client
from gigs_client.rest import ApiException
from pprint import pprint

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

# 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 = gigs_client.Configuration(
    access_token = os.environ["BEARER_TOKEN"]
)


# Enter a context with an instance of the API client
with gigs_client.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = gigs_client.AddonsApi(api_client)
    project = None # object | The unique identifier for the [project](https://developers.gigs.com/docs/api/b3A6MzMwODcxMzI-retrieve-a-project).
    addon = None # object | The unique identifier for the addon.

    try:
        # Archive an addon
        api_response = api_instance.addons_archive(project, addon)
        print("The response of AddonsApi->addons_archive:\n")
        pprint(api_response)
    except ApiException as e:
        print("Exception when calling AddonsApi->addons_archive: %s\n" % e)

Documentation for API Endpoints

All URIs are relative to https://api.gigs.com

Class	Method	HTTP request	Description
AddonsApi	addons_archive	POST /projects/{project}/addons/{addon}/archive	Archive an addon
AddonsApi	addons_list	GET /projects/{project}/addons	List all addons
AddonsApi	addons_publish	POST /projects/{project}/addons/{addon}/publish	Publish an addon
AddonsApi	addons_retrieve	GET /projects/{project}/addons/{addon}	Retrieve an addon
AddonsApi	addons_update	PATCH /projects/{project}/addons/{addon}	Update an addon
DevicesApi	device_model_brands_list	GET /deviceModelBrands	List all device model brands
DevicesApi	device_models_list	GET /deviceModels	List all device models
DevicesApi	device_models_retrieve	GET /deviceModels/{id}	Retrieve a device model
DevicesApi	device_models_search	POST /deviceModels/search	Search for device models
DevicesApi	devices_create	POST /projects/{project}/devices	Create a device
DevicesApi	devices_delete	DELETE /projects/{project}/devices/{id}	Delete a device
DevicesApi	devices_list	GET /projects/{project}/devices	List all devices
DevicesApi	devices_retrieve	GET /projects/{project}/devices/{id}	Retrieve a device
DevicesApi	devices_search	POST /projects/{project}/devices/search	Search for devices
DevicesApi	devices_update	PATCH /projects/{project}/devices/{id}	Update a device
PlansApi	plan_documents_list	GET /projects/{project}/plans/{plan}/documents	List all plan documents
PlansApi	plan_documents_retrieve	GET /projects/{project}/plans/{plan}/documents/{id}	Retrieve a plan document
PlansApi	plans_archive	POST /projects/{project}/plans/{plan}/archive	Archive a plan
PlansApi	plans_list	GET /projects/{project}/plans	List all plans
PlansApi	plans_publish	POST /projects/{project}/plans/{plan}/publish	Publish a plan
PlansApi	plans_retrieve	GET /projects/{project}/plans/{plan}	Retrieve a plan
PlansApi	plans_search	POST /projects/{project}/plans/search	Search for Plans
PlansApi	plans_update	PATCH /projects/{project}/plans/{plan}	Update a plan
PortingsApi	portings_cancel	POST /projects/{project}/portings/{id}/cancel	Cancel a porting
PortingsApi	portings_create	POST /projects/{project}/portings	Create a porting
PortingsApi	portings_list	GET /projects/{project}/portings	List all portings
PortingsApi	portings_retrieve	GET /projects/{project}/portings/{id}	Retrieve a Porting
PortingsApi	portings_update	PATCH /projects/{project}/portings/{id}	Update a porting
PortingsApi	service_providers_list	GET /serviceProviders	List all service providers
PortingsApi	service_providers_retrieve	GET /serviceProviders/{id}	Retrieve a service provider
ProjectsApi	projects_credentials	GET /projects/{project}/credentials	Retrieve the project credentials
ProjectsApi	projects_list	GET /projects	List all projects
ProjectsApi	projects_retrieve	GET /projects/{project}	Retrieve a project
SIMsApi	sims_credentials	GET /projects/{project}/sims/{id}/credentials	Retrieve the SIM credentials
SIMsApi	sims_list	GET /projects/{project}/sims	List all SIMs
SIMsApi	sims_retrieve	GET /projects/{project}/sims/{id}	Retrieve a SIM
SIMsApi	sims_search	POST /projects/{project}/sims/search	Search for SIMs
SubscriptionAddonsApi	subscription_addons_create	POST /projects/{project}/subscriptionAddons	Create a subscription addon
SubscriptionAddonsApi	subscription_addons_end	DELETE /projects/{project}/subscriptionAddons/{id}	End a subscription addon
SubscriptionAddonsApi	subscription_addons_list	GET /projects/{project}/subscriptionAddons	List all subscription addons
SubscriptionAddonsApi	subscription_addons_retrieve	GET /projects/{project}/subscriptionAddons/{id}	Retrieve a subscription addon
SubscriptionChangesApi	subscription_changes_create	POST /projects/{project}/subscriptionChanges	Create a subscription change
SubscriptionChangesApi	subscription_changes_delete	DELETE /projects/{project}/subscriptionChanges/{id}	Delete a subscription change
SubscriptionChangesApi	subscription_changes_list	GET /projects/{project}/subscriptionChanges	List all subscription changes
SubscriptionChangesApi	subscription_changes_retrieve	GET /projects/{project}/subscriptionChanges/{id}	Retrieve a subscription change
SubscriptionsApi	subscriptions_cancel	POST /projects/{project}/subscriptions/{id}/cancel	Cancel an active subscription
SubscriptionsApi	subscriptions_create	POST /projects/{project}/subscriptions	Create a subscription
SubscriptionsApi	subscriptions_end	DELETE /projects/{project}/subscriptions/{id}	End an active subscription
SubscriptionsApi	subscriptions_list	GET /projects/{project}/subscriptions	List all subscriptions
SubscriptionsApi	subscriptions_resume	POST /projects/{project}/subscriptions/{id}/resume	Resume a canceled subscription
SubscriptionsApi	subscriptions_retrieve	GET /projects/{project}/subscriptions/{id}	Retrieve a subscription
SubscriptionsApi	subscriptions_search	POST /projects/{project}/subscriptions/search	Search for subscriptions
UsageApi	subscription_usage_list	GET /projects/{project}/subscriptions/{id}/usage	List subscription usage records
UserAddressesApi	user_addresses_create	POST /projects/{project}/users/{user}/addresses	Create a user address
UserAddressesApi	user_addresses_delete	DELETE /projects/{project}/users/{user}/addresses/{id}	Delete a user address
UserAddressesApi	user_addresses_list	GET /projects/{project}/users/{user}/addresses	List all user addresses
UserAddressesApi	user_addresses_retrieve	GET /projects/{project}/users/{user}/addresses/{id}	Retrieve a user address
UsersApi	users_create	POST /projects/{project}/users	Create a user
UsersApi	users_delete	DELETE /projects/{project}/users/{id}	Delete a user
UsersApi	users_list	GET /projects/{project}/users	List all users
UsersApi	users_retrieve	GET /projects/{project}/users/{id}	Retrieve a user
UsersApi	users_search	POST /projects/{project}/users/search	Search for users
UsersApi	users_update	PATCH /projects/{project}/users/{id}	Update a user

Documentation For Models

• Addon
• AddonPrice
• AddonValidity
• AddonsList200Response
• AddonsUpdateRequest
• Coverage
• Device
• DeviceModel
• DeviceModelBrands
• DeviceModelsSearch200Response
• DeviceModelsSearchRequest
• DeviceUser
• DevicesCreateRequest
• DevicesSearch200Response
• DevicesSearchRequest
• DevicesUpdateRequest
• Error
• Organization
• Period
• Plan
• PlanDocument
• PlanDocumentsList200Response
• PlanRequirements
• PlansSearch200Response
• PlansSearchRequest
• PlansSearchRequestCompatibleWith
• PlansUpdateRequest
• Porting
• PortingDonorProvider
• PortingRecipientProvider
• PortingsCreateRequest
• PortingsList200Response
• PortingsUpdateRequest
• Price
• Project
• ProjectCredentials
• ProjectLegal
• ProjectPayments
• ProjectSupport
• ProjectsList200Response
• PropertyErrorDetailError
• ServiceProvider
• ServiceProvidersList200Response
• Sim
• SimCredentials
• SimsSearch200Response
• SimsSearchRequest
• Subscription
• SubscriptionAddon
• SubscriptionAddonAddon
• SubscriptionAddonCurrentPeriod
• SubscriptionAddonsCreateRequest
• SubscriptionAddonsList200Response
• SubscriptionChange
• SubscriptionChangePlan
• SubscriptionChangesCreateRequest
• SubscriptionChangesList200Response
• SubscriptionCurrentPeriod
• SubscriptionPorting
• SubscriptionSim
• SubscriptionUsageList200Response
• SubscriptionsCreateRequest
• SubscriptionsSearch200Response
• SubscriptionsSearchRequest
• UsageRecord
• User
• UserAddress
• UserAddressesCreateRequest
• UserAddressesList200Response
• UsersCreateRequest
• UsersSearch200Response
• UsersSearchRequest
• UsersUpdateRequest
• Validity

Documentation For Authorization

Authentication schemes defined for the API:

bearerAuth

• Type: Bearer authentication

Author

[e-mail]