OpenAPIClient-php

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

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 API key authorization: APIKeyHeader
$config = OpenAPI\Client\Configuration::getDefaultConfiguration()->setApiKey('X-API-Key', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// $config = OpenAPI\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('X-API-Key', 'Bearer');


$apiInstance = new OpenAPI\Client\Api\ContentApi(
    // 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
);

try {
    $result = $apiInstance->checkIfContentCollectionExistsV1ContentsCollectionExistsGet();
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling ContentApi->checkIfContentCollectionExistsV1ContentsCollectionExistsGet: ', $e->getMessage(), PHP_EOL;
}

API Endpoints

All URIs are relative to /luma

Class	Method	HTTP request	Description
ContentApi	checkIfContentCollectionExistsV1ContentsCollectionExistsGet	GET /v1/contents/collection-exists	Check If Content Collection Exists.
ContentApi	createContentByTitleV1ContentsTitlePost	POST /v1/contents/{title}	Create Content By Title
ContentApi	createContentCollectionV1ContentsCollectionPost	POST /v1/contents/collection	Create Content Collection
ContentApi	deleteContentByInternalIdV1ContentsByInternalIdInternalIdDelete	DELETE /v1/contents/by-internal-id/{internal_id}	Delete Content By Internal Id
ContentApi	deleteContentByTitleV1ContentsTitleDelete	DELETE /v1/contents/{title}	Delete Content By Title
ContentApi	deleteContentCollectionV1ContentsCollectionDelete	DELETE /v1/contents/collection	Delete Content Collection
ContentApi	deletesAllContentFromCollectionV1ContentsResetCollectionDelete	DELETE /v1/contents/reset-collection	Deletes All Content From Collection
ContentApi	gestContentByTitleV1ContentsTitleGet	GET /v1/contents/{title}	Gest Content By Title
ContentApi	getAllContentsV1ContentsGet	GET /v1/contents	Get All Contents
ContentApi	importMultipleContentsV1ContentsPost	POST /v1/contents	Import Multiple Contents
ContentApi	updateContentByTitleV1ContentsTitlePut	PUT /v1/contents/{title}	Update Content By Title
DefaultApi	healthCheckV1HealthGet	GET /v1/health	Health Check
FaqApi	checkIfFAQCollectionExistsV1FaqsCollectionExistsGet	GET /v1/faqs/collection-exists	Check If Faq Collection Exists.
FaqApi	createFAQByQuestionV1FaqsQuestionPost	POST /v1/faqs/{question}	Create Faq By Question
FaqApi	createFAQCollectionV1FaqsCollectionPost	POST /v1/faqs/collection	Create Faq Collection
FaqApi	deleteFAQByInternalIdV1FaqsByInternalIdInternalIdDelete	DELETE /v1/faqs/by-internal-id/{internal_id}	Delete Faq By Internal Id
FaqApi	deleteFAQByQuestionV1FaqsQuestionDelete	DELETE /v1/faqs/{question}	Delete Faq By Question
FaqApi	deleteFAQCollectionV1FaqsCollectionDelete	DELETE /v1/faqs/collection	Delete Faq Collection
FaqApi	deletesAllFAQFromCollectionV1FaqsResetCollectionDelete	DELETE /v1/faqs/reset-collection	Deletes All Faq From Collection
FaqApi	getAllFAQsV1FaqsGet	GET /v1/faqs	Get All Faqs
FaqApi	getFAQByQuestionV1FaqsQuestionGet	GET /v1/faqs/{question}	Get Faq By Question
FaqApi	importMultipleFAQsV1FaqsPost	POST /v1/faqs	Import Multiple Faqs
FaqApi	updateFAQByQuestionV1FaqsQuestionPut	PUT /v1/faqs/{question}	Update Faq By Question
FaqApi	uploadFilesIntoCloudStorageV1FaqsUploadPost	POST /v1/faqs/upload/	Upload Files Into Cloud Storage
ProductApi	checkIfProductCollectionExistsV1ProductsCollectionExistsGet	GET /v1/products/collection-exists	Check If Product Collection Exists.
ProductApi	createProductBySKUV1ProductsSkuPost	POST /v1/products/{sku}	Create Product By Sku
ProductApi	createProductCollectionV1ProductsCollectionPost	POST /v1/products/collection	Create Product Collection
ProductApi	deleteProductByInternalIdV1ProductsByInternalIdInternalIdDelete	DELETE /v1/products/by-internal-id/{internal_id}	Delete Product By Internal Id
ProductApi	deleteProductBySKUV1ProductsSkuDelete	DELETE /v1/products/{sku}	Delete Product By Sku
ProductApi	deleteProductCollectionV1ProductsCollectionDelete	DELETE /v1/products/collection	Delete Product Collection
ProductApi	deletesAllProductsFromCollectionV1ProductsResetCollectionDelete	DELETE /v1/products/reset-collection	Deletes All Products From Collection
ProductApi	gestProductBySKUV1ProductsSkuGet	GET /v1/products/{sku}	Gest Product By Sku
ProductApi	getAllProductsV1ProductsGet	GET /v1/products	Get All Products
ProductApi	importMultipleProductsV1ProductsPost	POST /v1/products	Import Multiple Products
ProductApi	updateProductBySKUV1ProductsSkuPut	PUT /v1/products/{sku}	Update Product By Sku
ProductApi	uploadFilesIntoStorageV1ProductsUploadPost	POST /v1/products/upload/	Upload Files Into Storage
ReviewsApi	checkIfProductReviewSchemaExistsV1ReviewsIsSchemaExistsGet	GET /v1/reviews/is-schema-exists	Check If Product Review Schema Exists
ReviewsApi	createOneReviewV1ReviewsPost	POST /v1/reviews	Create One Review
ReviewsApi	createSchemaAndProductReviewTableV1ReviewsSchemaPost	POST /v1/reviews/schema	Create Schema And Product Review Table
ReviewsApi	deleteAllReviewsV1ReviewsDelete	DELETE /v1/reviews/	Delete All Reviews
ReviewsApi	deleteReviewsByProductSKUV1ReviewsSkuDelete	DELETE /v1/reviews/{sku}	Delete Reviews By Product Sku
ReviewsApi	deleteSingleReviewByInternalIdV1ReviewsByInternalIdInternalIdDelete	DELETE /v1/reviews/by-internal-id/{internal_id}	Delete Single Review By Internal Id
ReviewsApi	getAllReviewsV1ReviewsGet	GET /v1/reviews	Get All Reviews
ReviewsApi	getReviewsBySKUV1ReviewsSkuGet	GET /v1/reviews/{sku}	Get Reviews By Sku
ReviewsApi	importMultipleReviewsV1ReviewsImportPost	POST /v1/reviews/import	Import Multiple Reviews

Models

• Content
• Faq
• HTTPValidationError
• Product
• ProductAvailability
• Review
• ValidationError
• ValidationErrorLocInner

Authorization

Authentication schemes defined for the API:

APIKeyHeader

• Type: API key
• API key parameter name: X-API-Key
• Location: HTTP header

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.2.1
  • Generator version: 7.7.0
• Build package: org.openapitools.codegen.languages.PhpClientCodegen