Skip to content

HelloAsso/helloasso-node

BranchesTags

Repository files navigation

hello_asso_api

HelloAssoApi - JavaScript client for hello_asso_api HelloAsso auto-generated SDK This SDK is automatically generated by the OpenAPI Generator project:

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

Installation

For Node.js

npm

To publish the library as a npm, please follow the procedure in "Publishing npm packages".

Then install it via:

npm install hello_asso_api --save

Finally, you need to build the module:

npm run build
Local development

To use the library locally without publishing to a remote npm registry, first install the dependencies by changing into the directory containing package.json (and this README). Let's call this JAVASCRIPT_CLIENT_DIR. Then run:

npm install

Next, link it globally in npm with the following, also from JAVASCRIPT_CLIENT_DIR:

npm link

To use the link you just defined in your project, switch to the directory you want to use your hello_asso_api from, and run:

npm link /path/to/<JAVASCRIPT_CLIENT_DIR>

Finally, you need to build the module:

npm run build

git

If the library is hosted at a git repository, e.g.https://github.com/GIT_USER_ID/GIT_REPO_ID then install it via:

    npm install GIT_USER_ID/GIT_REPO_ID --save

For browser

The library also works in the browser environment via npm and browserify. After following the above steps with Node.js and installing browserify with npm install -g browserify, perform the following (assuming main.js is your entry file):

browserify main.js > bundle.js

Then include bundle.js in the HTML pages.

Webpack Configuration

Using Webpack you may encounter the following error: "Module not found: Error: Cannot resolve module", most certainly you should disable AMD loader. Add/merge the following section to your webpack config:

module: {
  rules: [
    {
      parser: {
        amd: false
      }
    }
  ]
}

Getting Started

Please follow the installation instruction and execute the following JS code:

var HelloAssoApi = require('hello_asso_api');

var defaultClient = HelloAssoApi.ApiClient.instance;
// Configure OAuth2 access token for authorization: OAuth2
var OAuth2 = defaultClient.authentications['OAuth2'];
OAuth2.accessToken = "YOUR ACCESS TOKEN"

var api = new HelloAssoApi.AnnuaireApi()
var opts = {
  'pageSize': 20, // {Number} The number of items per page
  'continuationToken': "continuationToken_example", // {String} Continuation Token from which we wish to retrieve results
  'helloAssoApiV5ModelsDirectoryListFormsRequest': new HelloAssoApi.HelloAssoApiV5ModelsDirectoryListFormsRequest() // {HelloAssoApiV5ModelsDirectoryListFormsRequest} Body which contains the filters to apply
};
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.directoryFormsPost(opts, callback);

Documentation for API Endpoints

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

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

Documentation for Models

Documentation for Authorization

Authentication schemes defined for the API:

OAuth2

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

About

SDK node pour l'API HelloAsso

Resources

Readme
Activity
Custom properties

Stars

0 stars

Watchers

2 watching

Forks

0 forks
Report repository

Releases

No releases published

Packages

No packages published

Contributors 2

  •  
  •  

Languages