Skip to content

Latest commit

 

History

History
1086 lines (1047 loc) · 102 KB

README.md

File metadata and controls

1086 lines (1047 loc) · 102 KB
Raw

SwaggerClient-php

this is the Ageras API

This PHP package is automatically generated by the Swagger Codegen project:

  • API version: 2.0
  • Build date: 2023-03-29T12:04:19.314Z
  • Build package: class io.swagger.codegen.languages.PhpClientCodegen

Requirements

PHP 5.4.0 and later

Installation & Usage

Composer

To install the bindings via Composer, add the following to composer.json:

{
  "repositories": [
    {
      "type": "git",
      "url": "https://github.com/ageras-com/ageras-api.git"
    }
  ],
  "require": {
    "ageras-com/ageras-api": "*@dev"
  }
}

Then run composer install

Manual Installation

Download the files and include autoload.php:

    require_once('/path/to/SwaggerClient-php/autoload.php');

Tests

To run the unit tests:

composer install
./vendor/bin/phpunit

Getting Started

Please follow the installation procedure and then run the following:

<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure API key authorization: jwt
Ageras\Api\Configuration::getDefaultConfiguration()->setApiKey('token', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// Ageras\Api\Configuration::getDefaultConfiguration()->setApiKeyPrefix('token', 'Bearer');
// Configure HTTP basic authorization: login
Ageras\Api\Configuration::getDefaultConfiguration()->setUsername('YOUR_USERNAME');
Ageras\Api\Configuration::getDefaultConfiguration()->setPassword('YOUR_PASSWORD');

$api_instance = new Ageras\Api\Api\ActivitiesApi();
$activity_id = "activity_id_example"; // string | 
$activity_action_resource = new \Ageras\Api\ActivityActionResource(); // \Ageras\Api\ActivityActionResource | 

try {
    $result = $api_instance->activitiesActionsCreate($activity_id , $activity_action_resource);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling ActivitiesApi->activitiesActionsCreate: ', $e->getMessage(), PHP_EOL;
}

?>

Documentation for API Endpoints

All URIs are relative to https://api.ageras.com/v2

Class Method HTTP request Description
ActivitiesApi activitiesActionsCreate POST /activities/{activity_id}/actions
ActivitiesApi activitiesIndex GET /activities List activities
AffiliatesApi affiliatesCampaignsIndex GET /affiliates/{affiliate_id}/campaigns
AffiliatesApi affiliatesIndex GET /affiliates
AuthApi authCreate POST /auth
AuthApi authDelete DELETE /auth/{auth_id}
AuthApi authGet GET /auth/{auth_id}
AuthApi authPasswordCreate POST /auth/password
AuthApi authPasswordUpdate PUT /auth/password
AuthApi authPasswordreminderCreate POST /auth/passwordreminder
AuthApi authPermissionsIndex GET /auth/permissions
AuthApi authTokenDelete DELETE /auth/token
AuthApi authTokenGet GET /auth/token
AuthApi authTokenUpdate PUT /auth/token
AuthApi authUpdate PUT /auth/{auth_id}
BusinessmodelsApi businessModelsCreate POST /business_models
BusinessmodelsApi businessModelsDelete DELETE /business_models/{business_model_id}
BusinessmodelsApi businessModelsGet GET /business_models/{business_model_id}
BusinessmodelsApi businessModelsIndex GET /business_models
BusinessmodelsApi businessModelsUpdate PUT /business_models/{business_model_id}
CertificationsApi certificationsIndex GET /certifications
ChargesApi chargesIndex GET /charges
CheckoutsApi checkoutsCreate POST /checkouts
CheckoutsApi checkoutsGet GET /checkouts/{checkout_id}
CheckoutsApi checkoutsIndex GET /checkouts
CheckoutsApi checkoutsUpdate PUT /checkouts/{checkout_id}
ClientsApi clientsAllocationsuggestionsActionsCreate POST /clients/{client_id}/allocationsuggestions/actions
ClientsApi clientsAllocationsuggestionsIndex GET /clients/{client_id}/allocationsuggestions
ClientsApi clientsBrowserpushsubscriptionsCreate POST /clients/{client_id}/browserpushsubscriptions
ClientsApi clientsGet GET /clients/{client_id}
ClientsApi clientsUpdate PUT /clients/{client_id}
ClientsignupsApi clientsignupsActionsCreate POST /clientsignups/{client_sign_up_id}/actions
ClientsignupsApi clientsignupsCreate POST /clientsignups
CompanysizesApi companysizesIndex GET /companysizes
ContactarchivesApi contactarchivesActionsCreate POST /contactarchives/{contact_archive_id}/actions
ContactarchivesApi contactarchivesIndex GET /contactarchives
ContentsApi contentsPagesAggregationsIndex GET /contents/pages/aggregations
ContentsApi contentsPagesAggregationsIndex_0 GET /contents/{content_id}/pages/aggregations
ContentsApi contentsPagesGet GET /contents/pages/{content_page_id}
ContentsApi contentsPagesGet_0 GET /contents/{content_id}/pages/{content_page_id}
ContentsApi contentsPagesIndex GET /contents/pages
ContentsApi contentsPagesTypesIndex GET /contents/pages/types
ConversationsApi conversationsActionsCreate POST /conversations/{conversation_id}/actions
ConversationsApi conversationsAttachmentsCreate POST /conversations/attachments
ConversationsApi conversationsAttachmentsCreate_0 POST /conversations/{conversation_id}/attachments
ConversationsApi conversationsAttachmentsGet GET /conversations/attachments/{attachment_id}
ConversationsApi conversationsAttachmentsGet_0 GET /conversations/{conversation_id}/attachments/{attachment_id}
ConversationsApi conversationsAttachmentsIndex GET /conversations/attachments
ConversationsApi conversationsAttachmentsIndex_0 GET /conversations/{conversation_id}/attachments
ConversationsApi conversationsCreate POST /conversations
ConversationsApi conversationsGet GET /conversations/{conversation_id}
ConversationsApi conversationsIndex GET /conversations
ConversationsApi conversationsMessagesAttachmentsCreate POST /conversations/conversations/messages/attachments
ConversationsApi conversationsMessagesAttachmentsCreate_0 POST /conversations/messages/attachments
ConversationsApi conversationsMessagesAttachmentsCreate_1 POST /conversations/{conversation_id}/messages/attachments
ConversationsApi conversationsMessagesAttachmentsGet GET /conversations/conversations/messages/attachments/{attachment_id}
ConversationsApi conversationsMessagesAttachmentsGet_0 GET /conversations/messages/attachments/{attachment_id}
ConversationsApi conversationsMessagesAttachmentsGet_1 GET /conversations/{conversation_id}/messages/attachments/{attachment_id}
ConversationsApi conversationsMessagesAttachmentsIndex GET /conversations/conversations/messages/attachments
ConversationsApi conversationsMessagesAttachmentsIndex_0 GET /conversations/messages/attachments
ConversationsApi conversationsMessagesAttachmentsIndex_1 GET /conversations/{conversation_id}/messages/attachments
ConversationsApi conversationsMessagesCreate POST /conversations/messages
ConversationsApi conversationsMessagesCreate_0 POST /conversations/{conversation_id}/messages
ConversationsApi conversationsMessagesGet GET /conversations/messages/{message_id}
ConversationsApi conversationsMessagesGet_0 GET /conversations/{conversation_id}/messages/{message_id}
ConversationsApi conversationsMessagesIndex GET /conversations/messages
ConversationsApi conversationsMessagesIndex_0 GET /conversations/{conversation_id}/messages
CreditsystemApi creditsystemActionsCreate POST /creditsystem/actions
CustomersApi customersActionsCreate POST /customers/{client_id}/actions
CustomersApi customersPhoneverificationsCreate POST /customers/phoneverifications
CvApi cvAwardCreate POST /cv/{partner_user_id}/award
CvApi cvAwardDelete DELETE /cv/{partner_user_id}/award/{award_id}
CvApi cvAwardUpdate PUT /cv/{partner_user_id}/award
CvApi cvBadgeCreate POST /cv/{partner_user_id}/badge
CvApi cvBadgeDelete DELETE /cv/{partner_user_id}/badge/{badge_id}
CvApi cvCourseCreate POST /cv/{partner_user_id}/course
CvApi cvCourseDelete DELETE /cv/{partner_user_id}/course/{course_id}
CvApi cvCourseUpdate PUT /cv/{partner_user_id}/course
CvApi cvDescriptionCreate POST /cv/{partner_user_id}/description
CvApi cvDescriptionDelete DELETE /cv/{partner_user_id}/description/{description_id}
CvApi cvDescriptionUpdate PUT /cv/{partner_user_id}/description
CvApi cvEducationCreate POST /cv/{partner_user_id}/education
CvApi cvEducationDelete DELETE /cv/{partner_user_id}/education/{education_id}
CvApi cvEducationUpdate PUT /cv/{partner_user_id}/education
CvApi cvExperienceCreate POST /cv/{partner_user_id}/experience
CvApi cvExperienceDelete DELETE /cv/{partner_user_id}/experience/{experience_id}
CvApi cvExperienceUpdate PUT /cv/{partner_user_id}/experience
CvApi cvExpertiseCreate POST /cv/{partner_user_id}/expertise
CvApi cvExpertiseDelete DELETE /cv/{partner_user_id}/expertise/{expertise_id}
CvApi cvExpertiseUpdate PUT /cv/{partner_user_id}/expertise
CvApi cvGet GET /cv/{partner_user_id}
CvApi cvIndex GET /cv
CvApi cvLanguageCreate POST /cv/{partner_user_id}/language
CvApi cvLanguageDelete DELETE /cv/{partner_user_id}/language/{language_id}
CvApi cvLanguageUpdate PUT /cv/{partner_user_id}/language
CvApi cvSocialDelete DELETE /cv/cv/{partner_user_id}/social
CvApi cvSocialDelete_0 DELETE /cv/{partner_user_id}/social
CvApi cvSocialUpdate PUT /cv/{partner_user_id}/social
DatafieldsApi datafieldsIndex GET /datafields
FormsApi formsIndex GET /forms
FormsApi formsResponsesCreate POST /forms/{form_id}/responses
IndustriesApi industriesGroupIndex GET /industries/group
IndustriesApi industriesIndex GET /industries Get all industries.
InvoicesApi invoicesGet GET /invoices/{invoice_id}
InvoicesApi invoicesIndex GET /invoices
InvoicesApi invoicesRefundrequestsActionsCreate POST /invoices/{invoice_id}/refundrequests/{voucher_refund_request_id}/actions
InvoicesApi invoicesRefundrequestsCreate POST /invoices/{invoice_id}/refundrequests
InvoicesApi invoicesRefundrequestsGet GET /invoices/refundrequests/{voucher_refund_request_id}
InvoicesApi invoicesRefundrequestsGet_0 GET /invoices/{invoice_id}/refundrequests/{voucher_refund_request_id}
InvoicesApi invoicesRefundrequestsIndex GET /invoices/refundrequests
InvoicesApi invoicesRefundrequestsIndex_0 GET /invoices/{voucher_id}/refundrequests
KpiApi kpiIndex GET /kpi
KpiApi kpiTargetsCreate POST /kpi/targets
KpiApi kpiTargetsIndex GET /kpi/targets
KpiApi kpiValuesIndex GET /kpi/values
LanguagesApi languagesIndex GET /languages
LeadsApi leadsActionsCreate POST /leads/{lead_id}/actions This function serves up one class with a lot of functionality
LeadsApi leadsAggregationsIndex GET /leads/aggregations
LeadsApi leadsAllocationsCreate POST /leads/{lead_id}/allocations
LeadsApi leadsAllocationsIndex GET /leads/allocations
LeadsApi leadsAllocationsuggestionsDelete DELETE /leads/{lead_id}/allocationsuggestions/{allocation_suggestion_id}
LeadsApi leadsCategoriesIndex GET /leads/categories
LeadsApi leadsCertificationsCreate POST /leads/{lead_id}/certifications
LeadsApi leadsCertificationsDelete DELETE /leads/{lead_id}/certifications/{certification_id}
LeadsApi leadsCertificationsIndex GET /leads/{lead_id}/certifications
LeadsApi leadsCertificationsUpdate PUT /leads/{lead_id}/certifications
LeadsApi leadsCompanysizesIndex GET /leads/{lead_id}/companysizes
LeadsApi leadsCompanysizesUpdate PUT /leads/{lead_id}/companysizes
LeadsApi leadsCreate POST /leads
LeadsApi leadsDelete DELETE /leads/{lead_id}
LeadsApi leadsDemopartnersIndex GET /leads/demopartners/{partner_id}
LeadsApi leadsDemopartnersIndex_0 GET /leads/{lead_id}/demopartners/{partner_id}
LeadsApi leadsDiscardsCreate POST /leads/discards
LeadsApi leadsExcludedpartnersCreate POST /leads/{lead_id}/excludedpartners
LeadsApi leadsExcludedpartnersDelete DELETE /leads/{lead_id}/excludedpartners/{partner_id}
LeadsApi leadsExcludedpartnersIndex GET /leads/{lead_id}/excludedpartners
LeadsApi leadsGet GET /leads/{lead_id}
LeadsApi leadsIndex GET /leads
LeadsApi leadsNotesCreate POST /leads/{lead_id}/notes
LeadsApi leadsQuotefeesCreate POST /leads/{lead_id}/quotefees
LeadsApi leadsQuotefeesDelete DELETE /leads/{lead_id}/quotefees
LeadsApi leadsQuotesActionsCreate POST /leads/{lead_id}/quotes/{lead_quote_id}/actions
LeadsApi leadsQuotesCreate POST /leads/{lead_id}/quotes
LeadsApi leadsQuotesDelete DELETE /leads/{lead_id}/quotes/{lead_quote_id}
LeadsApi leadsQuotesGet GET /leads/quotes/{lead_quote_id}
LeadsApi leadsQuotesGet_0 GET /leads/{lead_id}/quotes/{lead_quote_id}
LeadsApi leadsQuotesIndex GET /leads/quotes
LeadsApi leadsQuotesIndex_0 GET /leads/{lead_id}/quotes
LeadsApi leadsQuotesItemsCreate POST /leads/{lead_id}/quotes/{lead_quote_id}/items
LeadsApi leadsQuotesItemsDelete DELETE /leads/{lead_id}/quotes/{lead_quote_id}/items/{lead_quote_item_id}
LeadsApi leadsQuotesItemsGet GET /leads/{lead_id}/quotes/{lead_quote_id}/items/{lead_quote_item_id}
LeadsApi leadsQuotesItemsIndex GET /leads/{lead_id}/quotes/{lead_quote_id}/items
LeadsApi leadsQuotesItemsUpdate PUT /leads/{lead_id}/quotes/{lead_quote_id}/items/{lead_quote_item_id}
LeadsApi leadsQuotesLoansUpdate PUT /leads/{lead_id}/quotes/{lead_quote_id}/loans/{lead_quote_loan_id}
LeadsApi leadsQuotesProgressstepsIndex GET /leads/quotes/progresssteps
LeadsApi leadsQuotesUpdate PUT /leads/quotes/{lead_quote_id}
LeadsApi leadsQuotesUpdate_0 PUT /leads/{lead_id}/quotes/{lead_quote_id}
LeadsApi leadsSegmentationsubgeoregionsIndex GET /leads/{lead_id}/segmentationsubgeoregions
LeadsApi leadsSegmentationsubgeoregionsUpdate PUT /leads/{lead_id}/segmentationsubgeoregions
LeadsApi leadsTypegroupsIndex GET /leads/typegroups
LeadsApi leadsTypesIndex GET /leads/types
LeadsApi leadsUpdate PUT /leads/{lead_id}
LocationsApi locationsGet GET /locations/{location_id}
LocationsApi locationsIndex GET /locations
LocationsApi locationsSegmentationgeoregionsIndex GET /locations/segmentationgeoregions
LocationsApi locationsSegmentationgeoregionsSegmentationsubgeoregionsIndex GET /locations/segmentationgeoregions/segmentationsubgeoregions
MatchesApi matchesIndex GET /matches
MeetingsApi meetingsActionsCreate POST /meetings/actions
NotificationsApi notificationsActionsCreate POST /notifications/actions
NotificationsApi notificationsActionsCreate_0 POST /notifications/{notification_id}/actions
NotificationsApi notificationsGet GET /notifications/{notification_id}
NotificationsApi notificationsIndex GET /notifications
OffersApi offersActionsCreate POST /offers/{offer_id}/actions
OffersApi offersGet GET /offers/{offer_id}
OffersApi offersIndex GET /offers
OrdersApi ordersActionsCreate POST /orders/{order_id}/actions
OrdersApi ordersIndex GET /orders
OrganisationApi organisationEmployeesActionsCreate POST /organisation/employees/{employee_id}/actions
OrganisationApi organisationEmployeesActionsCreate_0 POST /organisation/{organisation_id}/employees/{employee_id}/actions
OrganisationApi organisationEmployeesGet GET /organisation/employees/{employee_id}
OrganisationApi organisationEmployeesGet_0 GET /organisation/{organisation_id}/employees/{employee_id}
OrganisationApi organisationEmployeesIndex GET /organisation/employees
OrganisationApi organisationEmployeesKpiIndex GET /organisation/employees/kpi
OrganisationApi organisationEmployeesKpiIndex_0 GET /organisation/organisation/employees/kpi
OrganisationApi organisationEmployeesKpiIndex_1 GET /organisation/{organisation_id}/employees/kpi
OrganisationApi organisationEmployeesLeadpredictionsCreate POST /organisation/employees/{employee_id}/leadpredictions
OrganisationApi organisationEmployeesLeadpredictionsCreate_0 POST /organisation/{organisation_id}/employees/{employee_id}/leadpredictions
OrganisationApi organisationEmployeesNotificationsIndex GET /organisation/employees/{employee_id}/notifications
OrganisationApi organisationEmployeesNotificationsIndex_0 GET /organisation/{organisation_id}/employees/{employee_id}/notifications
OrganisationApi organisationFrontendemployeesIndex GET /organisation/frontendemployees
OrganisationApi organisationFrontendemployeeteamsIndex GET /organisation/frontendemployeeteams
PackagesApi packagesFeaturesIndex GET /packages/features
PackagesApi packagesGet GET /packages/{id}
PackagesApi packagesIndex GET /packages
PartnersApi partnersActionfeesIndex GET /partners/{partner_id}/actionfees
PartnersApi partnersActionsCreate POST /partners/{partner_id}/actions
PartnersApi partnersAggregationsIndex GET /partners/aggregations
PartnersApi partnersAllocationboostsCreate POST /partners/{partner_id}/allocationboosts
PartnersApi partnersAllocationdeliveriesIndex GET /partners/allocationdeliveries
PartnersApi partnersAllocationdeliveriesIndex_0 GET /partners/{partner_id}/allocationdeliveries
PartnersApi partnersAllocationpausesCreate POST /partners/{partner_id}/allocationpauses
PartnersApi partnersAssigneesCreate POST /partners/{partner_id}/assignees
PartnersApi partnersAssigneesDelete DELETE /partners/{partner_id}/assignees/{partner_assignee_id}
PartnersApi partnersAssigneesIndex GET /partners/{partner_id}/assignees
PartnersApi partnersBankaccountsCreate POST /partners/{partner_id}/bankaccounts
PartnersApi partnersBankaccountsIndex GET /partners/{partner_id}/bankaccounts
PartnersApi partnersBrowserpushsubscriptionsCreate POST /partners/{partner_id}/browserpushsubscriptions
PartnersApi partnersBusinessunitcontractsCreate POST /partners/{partner_id}/businessunitcontracts
PartnersApi partnersBusinessunitcontractsGet GET /partners/{partner_id}/businessunitcontracts/{contract_id}
PartnersApi partnersBusinessunitcontractsIndex GET /partners/{partner_id}/businessunitcontracts
PartnersApi partnersBusinessunitsAllocationlimitsCreate POST /partners/{partner_id}/businessunits/{partner_business_unit_id}/allocationlimits
PartnersApi partnersBusinessunitsAllocationlimitsDelete DELETE /partners/{partner_id}/businessunits/{partner_business_unit_id}/allocationlimits/{limit_id}
PartnersApi partnersBusinessunitsAllocationlimitsIndex GET /partners/{partner_id}/businessunits/allocationlimits
PartnersApi partnersBusinessunitsAllocationlimitsUpdate PUT /partners/{partner_id}/businessunits/{partner_business_unit_id}/allocationlimits/{limit_id}
PartnersApi partnersBusinessunitsAllocationquotasCreate POST /partners/{partner_id}/businessunits/{partner_business_unit_id}/allocationquotas
PartnersApi partnersBusinessunitsAllocationquotasDelete DELETE /partners/{partner_id}/businessunits/{partner_business_unit_id}/allocationquotas/{quota_id}
PartnersApi partnersBusinessunitsAllocationquotasIndex GET /partners/{partner_id}/businessunits/allocationquotas
PartnersApi partnersBusinessunitsCreate POST /partners/{partner_id}/businessunits
PartnersApi partnersBusinessunitsDelete DELETE /partners/{partner_id}/businessunits/{partner_businessunit_id}
PartnersApi partnersBusinessunitsGet GET /partners/{partner_id}/businessunits/{partner_business_unit_id}
PartnersApi partnersBusinessunitsIndex GET /partners/businessunits
PartnersApi partnersBusinessunitsIndustriesIndex GET /partners/{partner_id}/businessunits/{partner_business_unit_id}/industries
PartnersApi partnersBusinessunitsIndustriesUpdate PUT /partners/{partner_id}/businessunits/{partner_business_unit_id}/industries
PartnersApi partnersBusinessunitsRevenuerangesCreate POST /partners/{partner_id}/businessunits/{partner_business_unit_id}/revenueranges
PartnersApi partnersBusinessunitsSectorsIndex GET /partners/{partner_id}/businessunits/{partner_business_unit_id}/sectors
PartnersApi partnersBusinessunitsSectorsUpdate PUT /partners/{partner_id}/businessunits/{partner_business_unit_id}/sectors
PartnersApi partnersBusinessunitsSegmentationgeoregionsIndex GET /partners/{partner_id}/businessunits/{partner_business_unit_id}/segmentationgeoregions
PartnersApi partnersBusinessunitsSegmentationgeoregionsUpdate PUT /partners/{partner_id}/businessunits/{partner_business_unit_id}/segmentationgeoregions
PartnersApi partnersBusinessunitsTypesIndex GET /partners/{partner_id}/businessunits/{partner_business_unit_id}/types
PartnersApi partnersBusinessunitsTypesUpdate PUT /partners/{partner_id}/businessunits/{partner_business_unit_id}/types
PartnersApi partnersBusinessunitsUpdate PUT /partners/{partner_id}/businessunits/{partner_business_unit_id}
PartnersApi partnersCategoriesIndex GET /partners/categories
PartnersApi partnersCertificationsCreate POST /partners/{partner_id}/certifications
PartnersApi partnersCertificationsDelete DELETE /partners/{partner_id}/certifications/{certification_id}
PartnersApi partnersCertificationsGet GET /partners/{partner_id}/certifications/{certification_id}
PartnersApi partnersCertificationsIndex GET /partners/{partner_id}/certifications
PartnersApi partnersCertificationsUpdate PUT /partners/{partner_id}/certifications
PartnersApi partnersContentsDelete DELETE /partners/{partner_id}/contents/{content_key}
PartnersApi partnersContentsGet GET /partners/{partner_id}/contents/{content_key}
PartnersApi partnersContentsUpdate PUT /partners/{partner_id}/contents/{content_key}
PartnersApi partnersContractoffergroupsCreate POST /partners/{partner_id}/contractoffergroups
PartnersApi partnersContractoffergroupsIndex GET /partners/{partner_id}/contractoffergroups
PartnersApi partnersContractsActionsCreate POST /partners/{partner_id}/contracts/{contract_id}/actions
PartnersApi partnersContractsAllocationboostsDelete DELETE /partners/{partner_id}/contracts/{partner_contract_id}/allocationboosts/{boost_id}
PartnersApi partnersContractsAllocationboostsUpdate PUT /partners/{partner_id}/contracts/{partner_contract_id}/allocationboosts/{boost_id}
PartnersApi partnersContractsAllocationpausesDelete DELETE /partners/{partner_id}/contracts/{partner_contract_id}/allocationpauses/{pause_id}
PartnersApi partnersContractsAllocationpausesUpdate PUT /partners/{partner_id}/contracts/{partner_contract_id}/allocationpauses/{pause_id}
PartnersApi partnersContractsCreate POST /partners/{partner_id}/contracts
PartnersApi partnersContractsDelete DELETE /partners/{partner_id}/contracts/{partner_contract_id}
PartnersApi partnersContractsGet GET /partners/{partner_id}/contracts/{contract_id}
PartnersApi partnersContractsIndex GET /partners/{partner_id}/contracts
PartnersApi partnersContractsPdfGet GET /partners/{partner_id}/contracts/{contract_id}/pdf
PartnersApi partnersContractsSignedpdfCreate POST /partners/{partner_id}/contracts/{contract_id}/signedpdf
PartnersApi partnersContractsSignedpdfGet GET /partners/{partner_id}/contracts/{contract_id}/signedpdf
PartnersApi partnersContractsSigningurlGet GET /partners/{partner_id}/contracts/{contract_id}/signingurl
PartnersApi partnersContractsUpdate PUT /partners/{partner_id}/contracts/{partner_contract_id}
PartnersApi partnersCouponsActionsCreate POST /partners/{partner_id}/coupons/{coupon_id}/actions
PartnersApi partnersCouponsCreate POST /partners/{partner_id}/coupons
PartnersApi partnersCouponsIndex GET /partners/{partner_id}/coupons
PartnersApi partnersCreate POST /partners Create a Partner
PartnersApi partnersDelete DELETE /partners/{partner_id}
PartnersApi partnersDeliverablesCreate POST /partners/deliverables
PartnersApi partnersDeliverablesCreate_0 POST /partners/{partner_id}/deliverables
PartnersApi partnersDeliverablesGet GET /partners/deliverables/{partnerDeliverable_id}
PartnersApi partnersDeliverablesGet_0 GET /partners/{partner_id}/deliverables/{partnerDeliverable_id}
PartnersApi partnersDeliverablesIndex GET /partners/deliverables
PartnersApi partnersDeliverablesIndex_0 GET /partners/{partner_id}/deliverables
PartnersApi partnersDeliverablesLinesCreate POST /partners/deliverables/{partnerDeliverable_id}/lines
PartnersApi partnersDeliverablesLinesCreate_0 POST /partners/{partner_id}/deliverables/{partnerDeliverable_id}/lines
PartnersApi partnersDeliverablesLinesDelete DELETE /partners/deliverables/{partnerDeliverable_id}/lines/{partnerDeliverableLine_id}
PartnersApi partnersDeliverablesLinesDelete_0 DELETE /partners/{partner_id}/deliverables/{partnerDeliverable_id}/lines/{partnerDeliverableLine_id}
PartnersApi partnersDeliverablesLinesGet GET /partners/deliverables/{partnerDeliverable_id}/lines/{partnerDeliverableLine_id}
PartnersApi partnersDeliverablesLinesGet_0 GET /partners/{partner_id}/deliverables/{partnerDeliverable_id}/lines/{partnerDeliverableLine_id}
PartnersApi partnersDeliverablesLinesIndex GET /partners/deliverables/{partnerDeliverable_id}/lines
PartnersApi partnersDeliverablesLinesIndex_0 GET /partners/{partner_id}/deliverables/{partnerDeliverable_id}/lines
PartnersApi partnersDeliverablesLinesUpdate PUT /partners/deliverables/{partnerDeliverable_id}/lines/{partnerDeliverableLine_id}
PartnersApi partnersDeliverablesLinesUpdate_0 PUT /partners/{partner_id}/deliverables/{partnerDeliverable_id}/lines/{partnerDeliverableLine_id}
PartnersApi partnersDeliverablesUpdate PUT /partners/deliverables/{partnerDeliverable_id}
PartnersApi partnersDeliverablesUpdate_0 PUT /partners/{partner_id}/deliverables/{partnerDeliverable_id}
PartnersApi partnersDiscountsCreate POST /partners/{partner_id}/discounts
PartnersApi partnersDiscountsDelete DELETE /partners/{partner_id}/discounts/{partner_package_type_discount_id}
PartnersApi partnersDiscountsIndex GET /partners/{partner_id}/discounts
PartnersApi partnersEmployeenotesCreate POST /partners/{partner_id}/employeenotes
PartnersApi partnersEmployeenotesDelete DELETE /partners/{partner_id}/employeenotes/{employee_note_id}
PartnersApi partnersEmployeenotesIndex GET /partners/{partner_id}/employeenotes
PartnersApi partnersFeaturesCreate POST /partners/{partner_id}/features
PartnersApi partnersFeaturesDelete DELETE /partners/{partner_id}/features/{feature_identifier}
PartnersApi partnersFeesCreate POST /partners/{partner_id}/fees
PartnersApi partnersFeesDelete DELETE /partners/{partner_id}/fees/{id}
PartnersApi partnersFeesIndex GET /partners/fees
PartnersApi partnersGet GET /partners/{partner_id} Get a single partner by ID
PartnersApi partnersImpressumsCreate POST /partners/{partner_id}/impressums
PartnersApi partnersIndex GET /partners List partners
PartnersApi partnersIndustriesCreate POST /partners/{partner_id}/industries
PartnersApi partnersIndustriesDelete DELETE /partners/{partner_id}/industries/{industry_id}
PartnersApi partnersIndustriesGet GET /partners/{partner_id}/industries/{industry_id}
PartnersApi partnersIndustriesIndex GET /partners/{partner_id}/industries
PartnersApi partnersIndustriesUpdate PUT /partners/{partner_id}/industries
PartnersApi partnersInvoicingsIndex GET /partners/invoicings
PartnersApi partnersInvoicingsIndex_0 GET /partners/{partner_id}/invoicings
PartnersApi partnersLeadtypesCreate POST /partners/{partner_id}/lead_types
PartnersApi partnersLeadtypesDelete DELETE /partners/{partner_id}/lead_types/{lead_type_id}
PartnersApi partnersLeadtypesGet GET /partners/lead_types/{lead_type_id}
PartnersApi partnersLeadtypesGet_0 GET /partners/{partner_id}/lead_types/{lead_type_id}
PartnersApi partnersLeadtypesIndex GET /partners/lead_types
PartnersApi partnersLeadtypesIndex_0 GET /partners/{partner_id}/lead_types
PartnersApi partnersLeadtypesUpdate PUT /partners/{partner_id}/lead_types
PartnersApi partnersNotesCreate POST /partners/notes
PartnersApi partnersNotesCreate_0 POST /partners/{partner_id}/notes
PartnersApi partnersNotesGet GET /partners/{partner_id}/notes/{partner_note_id}
PartnersApi partnersNotesIndex GET /partners/notes
PartnersApi partnersNotesIndex_0 GET /partners/{partner_id}/notes
PartnersApi partnersQuoteloanproductpricesCreate POST /partners/{partner_id}/quoteloanproductprices
PartnersApi partnersQuoteloanproductpricesDelete DELETE /partners/{partner_id}/quoteloanproductprices/{quote_loan_product_price_id}
PartnersApi partnersQuoteloanproductpricesIndex GET /partners/{partner_id}/quoteloanproductprices
PartnersApi partnersQuoteproductcommentsCreate POST /partners/{partner_id}/quoteproductcomments
PartnersApi partnersQuoteproductcommentsDelete DELETE /partners/{partner_id}/quoteproductcomments/{quote_product_comment_id}
PartnersApi partnersQuoteproductcommentsIndex GET /partners/{partner_id}/quoteproductcomments
PartnersApi partnersQuoteproductpricesCreate POST /partners/{partner_id}/quoteproductprices
PartnersApi partnersQuoteproductpricesDelete DELETE /partners/{partner_id}/quoteproductprices/{quote_product_price_id}
PartnersApi partnersQuoteproductpricesIndex GET /partners/{partner_id}/quoteproductprices
PartnersApi partnersQuotevendorsIndex GET /partners/quotevendors
PartnersApi partnersRevenuerangesCreate POST /partners/{partner_id}/revenueranges
PartnersApi partnersRevenuesegmentsActionsCreate POST /partners/{partner_id}/revenuesegments/actions
PartnersApi partnersRevenuesegmentsCreate POST /partners/revenuesegments
PartnersApi partnersRevenuesegmentsCreate_0 POST /partners/{partner_id}/revenuesegments
PartnersApi partnersRevenuesegmentsDelete DELETE /partners/{partner_id}/revenuesegments/{partner_revenue_segment_id}
PartnersApi partnersRevenuesegmentsIndex GET /partners/{partner_id}/revenuesegments
PartnersApi partnersSectorsIndex GET /partners/{partner_id}/sectors
PartnersApi partnersSectorsUpdate PUT /partners/{partner_id}/sectors
PartnersApi partnersSellingpointsCreate POST /partners/{partner_id}/sellingpoints
PartnersApi partnersSellingpointsDelete DELETE /partners/{partner_id}/sellingpoints/{selling_point_id}
PartnersApi partnersSellingpointsIndex GET /partners/{partner_id}/sellingpoints
PartnersApi partnersSellingpointsUpdate PUT /partners/{partner_id}/sellingpoints/{selling_point_id}
PartnersApi partnersSubscriptionagreementsActionsCreate POST /partners/{partner_id}/subscriptionagreements/{agreement_id}/actions
PartnersApi partnersSubscriptionagreementsCreate POST /partners/{partner_id}/subscriptionagreements
PartnersApi partnersSubscriptionagreementsIndex GET /partners/{partner_id}/subscriptionagreements
PartnersApi partnersSubscriptionagreementsUpdate PUT /partners/{partner_id}/subscriptionagreements/{agreement_id}
PartnersApi partnersSubscriptionsActionsCreate POST /partners/{partner_id}/subscriptions/{subscription_id}/actions
PartnersApi partnersSubscriptionsCreate POST /partners/{partner_id}/subscriptions
PartnersApi partnersSubscriptionsIndex GET /partners/{partner_id}/subscriptions
PartnersApi partnersSubscriptionsPausesCreate POST /partners/{partner_id}/subscriptions/{subscription_id}/pauses
PartnersApi partnersSubscriptionsPausesDelete DELETE /partners/{partner_id}/subscriptions/{subscription_id}/pauses/{pause_id}
PartnersApi partnersSubscriptionsPausesIndex GET /partners/{partner_id}/subscriptions/{subscription_id}/pauses
PartnersApi partnersSubscriptionsPricesCreate POST /partners/{partner_id}/subscriptions/{subscription_id}/prices
PartnersApi partnersSubscriptionsPricesDelete DELETE /partners/{partner_id}/subscriptions/{subscription_id}/prices/{subscription_price_id}
PartnersApi partnersSubscriptionsPricesIndex GET /partners/{partner_id}/subscriptions/{subscription_id}/prices
PartnersApi partnersSubscriptionsUpdate PUT /partners/{partner_id}/subscriptions/{subscription_id}
PartnersApi partnersSubscriptiontypesIndex GET /partners/subscriptiontypes
PartnersApi partnersSubscriptiontypesIndex_0 GET /partners/{partner_id}/subscriptiontypes
PartnersApi partnersSuggestIndex GET /partners/suggest
PartnersApi partnersTitlesIndex GET /partners/titles
PartnersApi partnersTransactionsIndex GET /partners/{partner_id}/transactions
PartnersApi partnersUpdate PUT /partners/{partner_id}
PartnersApi partnersUsersActionsCreate POST /partners/{partner_id}/users/{partner_user_id}/actions
PartnersApi partnersUsersContentsDelete DELETE /partners/users/{partner_user_id}/contents/{content_key}
PartnersApi partnersUsersContentsDelete_0 DELETE /partners/{partner_id}/users/{partner_user_id}/contents/{content_key}
PartnersApi partnersUsersContentsGet GET /partners/users/{partner_user_id}/contents/{content_key}
PartnersApi partnersUsersContentsGet_0 GET /partners/{partner_id}/users/{partner_user_id}/contents/{content_key}
PartnersApi partnersUsersContentsUpdate PUT /partners/users/{partner_user_id}/contents/{content_key}
PartnersApi partnersUsersContentsUpdate_0 PUT /partners/{partner_id}/users/{partner_user_id}/contents/{content_key}
PartnersApi partnersUsersCreate POST /partners/users
PartnersApi partnersUsersCreate_0 POST /partners/{partner_id}/users
PartnersApi partnersUsersDelete DELETE /partners/{partner_id}/users/{partner_user_id}
PartnersApi partnersUsersGet GET /partners/users/{partner_user_id}
PartnersApi partnersUsersGet_0 GET /partners/{partner_id}/users/{partner_user_id}
PartnersApi partnersUsersIndex GET /partners/users
PartnersApi partnersUsersIndex_0 GET /partners/{partner_id}/users
PartnersApi partnersUsersUpdate PUT /partners/users/{partner_user_id}
PartnersApi partnersUsersUpdate_0 PUT /partners/{partner_id}/users/{partner_user_id}
PartnersApi partnersVerificationsIndex GET /partners/verifications
PartnersApi partnersVerificationsIndex_0 GET /partners/{partner_id}/verifications
PartnersApi partnersVerificationsUpdate PUT /partners/{partner_id}/verifications
PartnersignupsApi partnersignupsActionsCreate POST /partnersignups/{partner_sign_up_id}/actions
PartnersignupsApi partnersignupsCreate POST /partnersignups
PartnersignupsApi partnersignupsIndex GET /partnersignups
PaymentsApi paymentsCardsCreate POST /payments/cards
PaymentsApi paymentsCardsDelete DELETE /payments/cards/{card_id} Delete a card for a given id.
PaymentsApi paymentsCardsDelete_0 DELETE /payments/{payment_id}/cards/{card_id} Delete a card for a given id.
PaymentsApi paymentsCardsGet GET /payments/cards/{payment_card_id}
PaymentsApi paymentsCardsGet_0 GET /payments/{payment_id}/cards/{payment_card_id}
PaymentsApi paymentsCardsIndex GET /payments/cards
PaymentsApi paymentsMethodsActionsCreate POST /payments/methods/{payment_method_id}/actions
PaymentsApi paymentsMethodsActionsCreate_0 POST /payments/{payment_id}/methods/{payment_method_id}/actions
PaymentschedulesApi paymentschedulesIndex GET /paymentschedules
PaymentsolutionsApi paymentsolutionsIndex GET /paymentsolutions
PhonesApi phonesActionsCreate POST /phones/{phone_id}/actions
PrepaymentsApi prepaymentsCreate POST /prepayments
ProductsApi productsCreate POST /products Create product.
ProductsApi productsIndex GET /products List products.
ProjectsApi projectsCreate POST /projects
ProjectsApi projectsDelete DELETE /projects/{project_id}
ProjectsApi projectsEventsCreate POST /projects/events
ProjectsApi projectsEventsCreate_0 POST /projects/{project_id}/events
ProjectsApi projectsEventsDelete DELETE /projects/{project_id}/events/{project_event_id}
ProjectsApi projectsEventsGet GET /projects/events/{project_event_id}
ProjectsApi projectsEventsGet_0 GET /projects/{project_id}/events/{project_event_id}
ProjectsApi projectsEventsIndex GET /projects/events
ProjectsApi projectsEventsIndex_0 GET /projects/{project_id}/events
ProjectsApi projectsEventsUpdate PUT /projects/events/{project_event_id}
ProjectsApi projectsEventsUpdate_0 PUT /projects/{project_id}/events/{project_event_id}
ProjectsApi projectsGet GET /projects/{project_id}
ProjectsApi projectsIndex GET /projects
ProjectsApi projectsNotesCreate POST /projects/notes
ProjectsApi projectsNotesCreate_0 POST /projects/{project_id}/notes
ProjectsApi projectsNotesDelete DELETE /projects/{project_id}/notes/{project_note_id}
ProjectsApi projectsNotesGet GET /projects/notes/{project_note_id}
ProjectsApi projectsNotesGet_0 GET /projects/{project_id}/notes/{project_note_id}
ProjectsApi projectsNotesIndex GET /projects/notes
ProjectsApi projectsNotesIndex_0 GET /projects/{project_id}/notes
ProjectsApi projectsNotesUpdate PUT /projects/notes/{project_note_id}
ProjectsApi projectsNotesUpdate_0 PUT /projects/{project_id}/notes/{project_note_id}
ProjectsApi projectsStatusesGet GET /projects/{status}/statuses
ProjectsApi projectsStatusesIndex GET /projects/statuses
ProjectsApi projectsUpdate PUT /projects/{project_id}
PromptsApi promptsActionsCreate POST /prompts/{prompt_id}/actions
PromptsApi promptsIndex GET /prompts
RatingsApi ratingsCreate POST /ratings
RatingsApi ratingsGet GET /ratings/{rating_id}
RatingsApi ratingsIndex GET /ratings
RatingsApi ratingsUpdate PUT /ratings/{rating_id}
RefundsApi refundsGet GET /refunds/{refund_id}
RefundsApi refundsIndex GET /refunds
RevenuesegmentsApi revenuesegmentsIndex GET /revenuesegments
SearchApi searchIndex GET /search
SearchApi searchSuggestIndex GET /search/suggest
SearchApi searchTypeaheadIndex GET /search/typeahead
SectorsApi sectorsIndex GET /sectors
SoftconversionsApi softconversionsCreate POST /softconversions
TasksApi tasksCreate POST /tasks
TasksApi tasksDelete DELETE /tasks/{task_id}
TasksApi tasksGet GET /tasks/{task_id}
TasksApi tasksIndex GET /tasks
TasksApi tasksPrioritiesGet GET /tasks/priorities/{priority_id}
TasksApi tasksPrioritiesGet_0 GET /tasks/{task_id}/priorities/{priority_id}
TasksApi tasksPrioritiesIndex GET /tasks/priorities
TasksApi tasksStatusesGet GET /tasks/statuses/{status_id}
TasksApi tasksStatusesGet_0 GET /tasks/{task_id}/statuses/{status_id}
TasksApi tasksStatusesIndex GET /tasks/statuses
TasksApi tasksTaskablesCreate POST /tasks/{task_id}/taskables
TasksApi tasksTaskablesDelete DELETE /tasks/{task_id}/taskables/{taskable_id}
TasksApi tasksTaskablesGet GET /tasks/{task_id}/taskables/{taskable_id}
TasksApi tasksTaskablesIndex GET /tasks/{task_id}/taskables
TasksApi tasksUpdate PUT /tasks/{task_id}
TermsApi termsAcceptedIndex GET /terms/accepted
TermsApi termsActionsCreate POST /terms/{terms_id}/actions
TermsApi termsGet GET /terms/{terms_id}
TermsApi termsIndex GET /terms
VapidApi vapidGet GET /vapid
VouchersApi vouchersActionsCreate POST /vouchers/{voucher_id}/actions

Documentation For Models

Documentation For Authorization

jwt

  • Type: API key
  • API key parameter name: token
  • Location: URL query string

login

  • Type: HTTP basic authentication

Author

[email protected]