Skip to content

akeneo-presales/descrb-php-api-client

BranchesTags

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

20 Commits
docs
docs
 
 
lib/DescrbAPI
lib/DescrbAPI
 
 
test/DescrbAPI/Service
test/DescrbAPI/Service
 
 
.gitignore
.gitignore
 
 
README.md
README.md
 
 
composer.json
composer.json
 
 
git_push.sh
git_push.sh
 
 
phpunit.xml.dist
phpunit.xml.dist
 
 

Repository files navigation

OpenAPIClient-php

No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator)

Installation & Usage

Requirements

PHP 7.3 and later. Should also work with PHP 8.0 but has not been tested.

Composer

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

{
  "repositories": [
    {
      "type": "vcs",
      "url": "https://github.com/akeneo-presales/descrb-php-api-client.git"
    }
  ],
  "require": {
    "akeneo-presales/descrb-php-api-client": "*@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: OAuth2PasswordBearer
$config = AkeneoPresales\DescrbAPI\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');


$apiInstance = new AkeneoPresales\DescrbAPI\Api\BrandApi(
    // 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
);
$image = "/path/to/file.txt"; // \SplFileObject | Image File
$photo_url = ''; // string | Photo URL
$brand_name = ''; // string | Product Name
$length = 512; // int | Numer of Tokens
$language = 'pl'; // string | Supported languages: en,de,fr,es,ro,pl
$data_language = ''; // string | Data Source Language
$language_style = 'Neutral'; // string | Choose between Neutral, Casual, Specialist

try {
    $result = $apiInstance->createBrandAdApiV1BrandPost($image, $photo_url, $brand_name, $length, $language, $data_language, $language_style);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling BrandApi->createBrandAdApiV1BrandPost: ', $e->getMessage(), PHP_EOL;
}

API Endpoints

All URIs are relative to https://app.descrb.com

Class Method HTTP request Description
BrandApi createBrandAdApiV1BrandPost POST /api/v1/brand/ Create Brand Ad
BrandApi reviewBrandDescriptionApiV1BrandBrandDescriptionIdReviewPost POST /api/v1/brand/{brand_description_id}/review Review Brand Description
BrandTemplateApi createTemplateApiV1BrandTemplatePost POST /api/v1/brand-template/ Create Template
BrandTemplateApi deleteTemplateApiV1BrandTemplateTemplateTemplateIdDelete DELETE /api/v1/brand-template/template/{template_id} Delete Template
BrandTemplateApi editTemplateApiV1BrandTemplateTemplateTemplateIdPatch PATCH /api/v1/brand-template/template/{template_id} Edit Template
BrandTemplateApi readUserTemplatesApiV1BrandTemplateMyTemplatesGet GET /api/v1/brand-template/my-templates Read User Templates
ContactApi contactFormApiV1ContactPost POST /api/v1/contact/ Contact Form
CrawlerApi colorsApiV1CrawlerLabelsPost POST /api/v1/crawler/labels Colors
CrawlerApi getImageApiV1CrawlerImagesFilenameGet GET /api/v1/crawler/images/{filename} Get Image
CrawlerApi logosApiV1CrawlerLogosPost POST /api/v1/crawler/logos Logos
CrawlerApi searchFromGoogleLensApiV1CrawlerPost POST /api/v1/crawler/ Search From Google Lens
DefaultApi metricsMetricsGet GET /metrics Metrics
LandingApi getDescriptionApiV1LandingCountGet GET /api/v1/landing/count Get Description
LoginApi authViaFacebookApiV1LoginAuthFacebookGet GET /api/v1/login/auth/facebook Auth Via Facebook
LoginApi authViaGoogleApiV1LoginAuthGoogleGet GET /api/v1/login/auth/google Auth Via Google
LoginApi authViaLinkedinApiV1LoginAuthLinkedinGet GET /api/v1/login/auth/linkedin Auth Via Linkedin
LoginApi disableTotpAuthenticationApiV1LoginTotpDelete DELETE /api/v1/login/totp Disable Totp Authentication
LoginApi enableTotpAuthenticationApiV1LoginTotpPut PUT /api/v1/login/totp Enable Totp Authentication
LoginApi loginViaFacebookApiV1LoginFacebookGet GET /api/v1/login/facebook Login Via Facebook
LoginApi loginViaGoogleApiV1LoginGoogleGet GET /api/v1/login/google Login Via Google
LoginApi loginViaLinkedinApiV1LoginLinkedinGet GET /api/v1/login/linkedin Login Via Linkedin
LoginApi loginWithMagicLinkApiV1LoginMagicEmailGet GET /api/v1/login/magic/{email} Login With Magic Link
LoginApi loginWithOauth2ApiV1LoginOauthPost POST /api/v1/login/oauth Login With Oauth2
LoginApi loginWithTotpApiV1LoginTotpPost POST /api/v1/login/totp Login With Totp
LoginApi recoverPasswordApiV1LoginRecoverEmailPost POST /api/v1/login/recover/{email} Recover Password
LoginApi refreshTokenApiV1LoginRefreshPost POST /api/v1/login/refresh Refresh Token
LoginApi registerApiV1LoginSignInPost POST /api/v1/login/sign-in Register
LoginApi resetPasswordApiV1LoginResetPost POST /api/v1/login/reset Reset Password
LoginApi revokeTokenApiV1LoginRevokePost POST /api/v1/login/revoke Revoke Token
LoginApi validateMagicLinkApiV1LoginClaimPost POST /api/v1/login/claim Validate Magic Link
LoginApi verifyRecaptchaEndpointApiV1LoginVerifyRecaptchaPost POST /api/v1/login/verify-recaptcha Verify Recaptcha Endpoint
ProductApi createDemoProductAdApiV1ProductDemoPost POST /api/v1/product/demo/ Create Demo Product Ad
ProductApi createProductAdApiV1ProductPost POST /api/v1/product/ Create Product Ad
ProductApi editBrandDescriptionApiV1ProductBrandDescriptionIdPatch PATCH /api/v1/product/brand/{description_id} Edit Brand Description
ProductApi editDescriptionApiV1ProductDescriptionDescriptionIdPatch PATCH /api/v1/product/description/{description_id} Edit Description
ProductApi editHistoryDescriptionApiV1ProductHistoryDescriptionIdPatch PATCH /api/v1/product/history/{description_id} Edit History Description
ProductApi exportChosenToCsvApiV1ProductExportChosenPut PUT /api/v1/product/export-chosen Export Chosen To Csv
ProductApi exportPageToCsvAdminPanelApiV1ProductAdminExportCurrentPageGet GET /api/v1/product/admin/export-current-page Export Page To Csv Admin Panel
ProductApi exportPageToCsvApiV1ProductExportCurrentPageGet GET /api/v1/product/export-current-page Export Page To Csv
ProductApi exportToCsvAdminPanelApiV1ProductAdminExportAllGet GET /api/v1/product/admin/export-all Export To Csv Admin Panel
ProductApi exportToCsvApiV1ProductExportAllGet GET /api/v1/product/export-all Export To Csv
ProductApi getDescriptionApiV1ProductDescriptionIdGet GET /api/v1/product/{description_id} Get Description
ProductApi readAllProductDescriptionsApiV1ProductAllGet GET /api/v1/product/all Read All Product Descriptions
ProductApi readUserProductDescriptionsApiV1ProductMyReviewsGet GET /api/v1/product/my-reviews Read User Product Descriptions
ProductApi regenerateBrandDescriptionApiV1ProductRegenerateBrandDescriptionDescriptionIdPost POST /api/v1/product/regenerate-brand-description/{description_id} Regenerate Brand Description
ProductApi regenerateDescriptionApiV1ProductRegenerateDescriptionDescriptionIdPost POST /api/v1/product/regenerate-description/{description_id} Regenerate Description
ProductApi regenerateEmptyApiV1ProductRegenerateEmptyDescriptionDescriptionIdPost POST /api/v1/product/regenerate-empty-description/{description_id} Regenerate Empty
ProductApi regenerateHistoryDescriptionApiV1ProductRegenerateHistoryDescriptionDescriptionIdPost POST /api/v1/product/regenerate-history-description/{description_id} Regenerate History Description
ProductApi regenerateTechnologyApiV1ProductRegenerateTechnologiesDescriptionDescriptionIdPost POST /api/v1/product/regenerate-technologies-description/{description_id} Regenerate Technology
ProductApi reviewBrandDescriptionApiV1ProductBrandDescriptionIdReviewPost POST /api/v1/product/brand/{description_id}/review Review Brand Description
ProductApi reviewDescriptionApiV1ProductDescriptionDescriptionIdReviewPost POST /api/v1/product/description/{description_id}/review Review Description
ProductApi reviewHistoryDescriptionApiV1ProductHistoryDescriptionIdReviewPost POST /api/v1/product/history/{description_id}/review Review History Description
ProductApi translateDescriptionApiV1ProductTranslateDescriptionDescriptionIdPost POST /api/v1/product/translate-description/{description_id} Translate Description
ProductTemplateApi createTemplateApiV1ProductTemplatePost POST /api/v1/product-template/ Create Template
ProductTemplateApi deleteTemplateApiV1ProductTemplateTemplateTemplateIdDelete DELETE /api/v1/product-template/template/{template_id} Delete Template
ProductTemplateApi editTemplateApiV1ProductTemplateTemplateTemplateIdPatch PATCH /api/v1/product-template/template/{template_id} Edit Template
ProductTemplateApi readUserTemplatesApiV1ProductTemplateMyTemplatesGet GET /api/v1/product-template/my-templates Read User Templates
ProxyApi proxyGetRequestApiV1ProxyPathGet GET /api/v1/proxy/{path} Proxy Get Request
ProxyApi proxyPostRequestApiV1ProxyPathPost POST /api/v1/proxy/{path} Proxy Post Request
TaskApi getStatusApiV1TaskCheckStatusGet GET /api/v1/task/check-status Get Status
UsersApi changeUserLanguageApiV1UsersLanguagePatch PATCH /api/v1/users/language Change User Language
UsersApi createTrialSubApiV1UsersGetTrialPatch PATCH /api/v1/users/get-trial Create Trial Sub
UsersApi createUserApiV1UsersCreatePost POST /api/v1/users/create Create User
UsersApi createUserProfileApiV1UsersPost POST /api/v1/users/ Create User Profile
UsersApi endActiveTrialApiV1UsersEndCurrentTrialPatch PATCH /api/v1/users/end-current-trial End Active Trial
UsersApi generateReportApiV1UsersReportGet GET /api/v1/users/report Generate Report
UsersApi markTrialNotificationAsSeenApiV1UsersNotificationAboutExpirePost POST /api/v1/users/notification-about-expire Mark Trial Notification As Seen
UsersApi patchUserApiV1UsersPatch PATCH /api/v1/users/ Patch User
UsersApi readAllUsersApiV1UsersAllGet GET /api/v1/users/all Read All Users
UsersApi readUserApiV1UsersGet GET /api/v1/users/ Read User
UsersApi readUserApiV1UsersPaymentsInfoGet GET /api/v1/users/payments-info Read User
UsersApi readUserDescriptionsApiV1UsersUserIdDescriptionsGet GET /api/v1/users/{user_id}/descriptions Read User Descriptions
UsersApi readUserNotReviewedDescriptionsApiV1UsersUserIdNotReviewedDescriptionsGet GET /api/v1/users/{user_id}/not-reviewed-descriptions Read User Not Reviewed Descriptions
UsersApi readUserNotSeenDescriptionsApiV1UsersUserIdNotSeenDescriptionsGet GET /api/v1/users/{user_id}/not-seen-descriptions Read User Not Seen Descriptions
UsersApi requestNewTotpApiV1UsersNewTotpPost POST /api/v1/users/new-totp Request New Totp
UsersApi testEndpointApiV1UsersTesterGet GET /api/v1/users/tester Test Endpoint
UsersApi toggleStateApiV1UsersToggleStatePost POST /api/v1/users/toggle-state Toggle State
UsersApi updateUserApiV1UsersPut PUT /api/v1/users/ Update User
UsersApi validateEmailApiV1UsersValidateEmailPost POST /api/v1/users/validate-email Validate Email

Models

Authorization

OAuth2PasswordBearer

  • Type: OAuth
  • Flow: password
  • 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: 0.1.0
  • Build package: org.openapitools.codegen.languages.PhpClientCodegen

About

Generated php API client client for the descrb.com api https://app.descrb.com/api/v1/openapi.json https://app.descrb.com/docs#/

Resources

Readme
Activity
Custom properties

Stars

0 stars

Watchers

4 watching

Forks

0 forks
Report repository

Releases

6 tags

Packages

No packages published

Languages