Skip to content

HelloAsso/helloasso-php

BranchesTags

Repository files navigation

OpenAPIClient-php

HelloAsso auto-generated SDK

Installation & Usage

Requirements

PHP 7.4 and later. Should also work with PHP 8.0.

Composer

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

{
  "repositories": [
    {
      "type": "vcs",
      "url": "https://github.com/GIT_USER_ID/GIT_REPO_ID.git"
    }
  ],
  "require": {
    "GIT_USER_ID/GIT_REPO_ID": "*@dev"
  }
}

Then run composer install

Manual Installation

Download the files and include autoload.php:

<?php
require_once('/path/to/OpenAPIClient-php/vendor/autoload.php');

Getting Started

Please follow the installation procedure and then run the following:

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



// Configure OAuth2 access token for authorization: OAuth2
$config = OpenAPI\Client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');


$apiInstance = new OpenAPI\Client\Api\AnnuaireApi(
    // If you want use custom http client, pass your client which implements `GuzzleHttp\ClientInterface`.
    // This is optional, `GuzzleHttp\Client` will be used as default.
    new GuzzleHttp\Client(),
    $config
);
$page_size = 20; // int | The number of items per page
$continuation_token = 'continuation_token_example'; // string | Continuation Token from which we wish to retrieve results
$hello_asso_api_v5_models_directory_list_forms_request = new \OpenAPI\Client\Model\HelloAssoApiV5ModelsDirectoryListFormsRequest(); // \OpenAPI\Client\Model\HelloAssoApiV5ModelsDirectoryListFormsRequest | Body which contains the filters to apply

try {
    $result = $apiInstance->directoryFormsPost($page_size, $continuation_token, $hello_asso_api_v5_models_directory_list_forms_request);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling AnnuaireApi->directoryFormsPost: ', $e->getMessage(), PHP_EOL;
}

API Endpoints

All URIs are relative to https://api.helloasso.com/v5

Class Method HTTP request Description
AnnuaireApi directoryFormsPost POST /directory/forms Récupérer les formulaires
AnnuaireApi directoryOrganizationsPost POST /directory/organizations Récupérer les organisations
CheckoutApi organizationsOrganizationSlugCheckoutIntentsCheckoutIntentIdGet GET /organizations/{organizationSlug}/checkout-intents/{checkoutIntentId} Récupérer une intention de paiement
CheckoutApi organizationsOrganizationSlugCheckoutIntentsPost POST /organizations/{organizationSlug}/checkout-intents Initialisation d'un Checkout
CommandesApi itemsItemIdGet GET /items/{itemId} Obtenir le détail d'un article contenu dans une commande
CommandesApi ordersOrderIdCancelPost POST /orders/{orderId}/cancel Annuler les paiements futurs pour une commande (pas de remboursement).
CommandesApi ordersOrderIdGet GET /orders/{orderId} Obtenir des informations détaillées sur une commande
CommandesApi organizationsOrganizationSlugFormsFormTypeFormSlugItemsGet GET /organizations/{organizationSlug}/forms/{formType}/{formSlug}/items Obtenir une liste d'articles vendus dans un formulaire
CommandesApi organizationsOrganizationSlugFormsFormTypeFormSlugOrdersGet GET /organizations/{organizationSlug}/forms/{formType}/{formSlug}/orders Obtenir les commandes d'un formulaire
CommandesApi organizationsOrganizationSlugItemsGet GET /organizations/{organizationSlug}/items Obtenir une liste d'articles vendus par une organisation
CommandesApi organizationsOrganizationSlugOrdersGet GET /organizations/{organizationSlug}/orders Obtenir les commandes d'une organisation
FormulairesApi organizationsOrganizationSlugFormTypesGet GET /organizations/{organizationSlug}/formTypes Obtenir une liste des types de formulaires pour une organisation
FormulairesApi organizationsOrganizationSlugFormsFormTypeActionQuickCreatePost POST /organizations/{organizationSlug}/forms/{formType}/action/quick-create Créer un événement simplifié pour un organisme
FormulairesApi organizationsOrganizationSlugFormsFormTypeFormSlugPublicGet GET /organizations/{organizationSlug}/forms/{formType}/{formSlug}/public Obtenir des données publiques détaillées sur un formulaire
FormulairesApi organizationsOrganizationSlugFormsGet GET /organizations/{organizationSlug}/forms Obtenir les formulaires d'une organisation
ListeDeValeursApi valuesCompanyLegalStatusGet GET /values/company-legal-status Obtenir la liste des statuts juridiques
ListeDeValeursApi valuesOrganizationCategoriesGet GET /values/organization/categories Obtenir la liste des catégories du JO
ListeDeValeursApi valuesTagsGet GET /values/tags Obtenir la liste des tags publiques
OrganisationApi organizationsLegalInformationsLegalStructuresGet GET /organizations/legal-informations/legal-structures Obtenir la structure juridique d'une organisation visible.
OrganisationApi organizationsLegalInformationsOrganizationSlugConfigurationGet GET /organizations/legal-informations/{organizationSlug}/configuration Obtenir la configuration des informations juridiques de l'organisation.
OrganisationApi organizationsLegalInformationsOrganizationSlugConfigurationPut PUT /organizations/legal-informations/{organizationSlug}/configuration Mettre à jour la configuration des informations juridiques de l'organisation.
OrganisationApi organizationsLegalInformationsTaxInformationTextsGet GET /organizations/legal-informations/tax-information-texts Obtenir les textes d'information fiscale de l'organisation.
OrganisationApi organizationsOrganizationSlugGet GET /organizations/{organizationSlug} Obtenir le détail d'une organisation
PaiementsApi organizationsOrganizationSlugFormsFormTypeFormSlugPaymentsGet GET /organizations/{organizationSlug}/forms/{formType}/{formSlug}/payments Obtenir les informations des paiements effectués sur un formulaire
PaiementsApi organizationsOrganizationSlugPaymentsGet GET /organizations/{organizationSlug}/payments Obtenir les informations des paiements effectués sur une organisation
PaiementsApi organizationsOrganizationSlugPaymentsSearchGet GET /organizations/{organizationSlug}/payments/search Rechercher des paiements.
PaiementsApi paymentsPaymentIdGet GET /payments/{paymentId} Obtenir les informations détaillées d'un paiement.
PaiementsApi paymentsPaymentIdRefundPost POST /payments/{paymentId}/refund Rembourser un paiement.
PartenairesApi partnersMeApiClientsPut PUT /partners/me/api-clients Mise à jour du domaine
PartenairesApi partnersMeApiNotificationsDelete DELETE /partners/me/api-notifications Suppression de l'URL de notification principale
PartenairesApi partnersMeApiNotificationsOrganizationsOrganizationSlugDelete DELETE /partners/me/api-notifications/organizations/{organizationSlug} Suppression d'une URL de notification liée à une organisation
PartenairesApi partnersMeApiNotificationsOrganizationsOrganizationSlugPut PUT /partners/me/api-notifications/organizations/{organizationSlug} Mise à jour d'une URL de notification liée à une organisation
PartenairesApi partnersMeApiNotificationsPut PUT /partners/me/api-notifications Mise à jour de l'URL de notification principale
PartenairesApi partnersMeGet GET /partners/me Récupération des informations
PartenairesApi partnersMeOrganizationsGet GET /partners/me/organizations Obtenir toutes les organisations
ReusFiscauxApi organizationsOrganizationSlugTaxReceiptConfigurationGet GET /organizations/{organizationSlug}/tax-receipt/configuration Obtenir la configuration des reçus fiscaux
ReusFiscauxApi organizationsOrganizationSlugTaxReceiptConfigurationPut PUT /organizations/{organizationSlug}/tax-receipt/configuration Mettre à jour la configuration des reçus fiscaux
ReusFiscauxApi organizationsOrganizationSlugTaxReceiptFiscalReceiptTransmitterPut PUT /organizations/{organizationSlug}/tax-receipt/fiscal-receipt-transmitter Mettre à jour l'émetteur des reçus fiscaux
ReusFiscauxApi organizationsOrganizationSlugTaxReceiptPreviewPost POST /organizations/{organizationSlug}/tax-receipt/preview Prévisualiser les reçus fiscaux
TagsApi tagsTagNameGet GET /tags/{tagName} Obtenir le détail d'un tag interne
UtilisateursApi usersMeOrganizationsGet GET /users/me/organizations Obtenir mes organisations

Models

Authorization

Authentication schemes defined for the API:

OAuth2

  • Type: OAuth
  • Flow: application
  • Authorization URL: ``
  • Scopes: N/A

Tests

To run the tests, use:

composer install
vendor/bin/phpunit

Author

About this package

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

  • API version: public
    • Generator version: 7.12.0
  • Build package: org.openapitools.codegen.languages.PhpClientCodegen

About

SDK PHP pour l'API HelloAsso

Resources

Readme
Activity
Custom properties

Stars

1 star

Watchers

2 watching

Forks

0 forks
Report repository

Releases

No releases published

Packages

No packages published

Contributors 2

  •  
  •  

Languages