wpify/gebrueder-weiss-transport-sdk

API to create road transport orders

dev-master 2024-11-07 11:43 UTC

Requires

• php: ^7.4 || ^8.0
• ext-curl: *
• ext-json: *
• ext-mbstring: *
• guzzlehttp/guzzle: ^7.3
• guzzlehttp/psr7: ^1.7 || ^2.0

Requires (Dev)

• friendsofphp/php-cs-fixer: ^3.5
• phpunit/phpunit: ^8.0 || ^9.0

unlicense

• OpenAPI

• php
• rest
• api
• sdk
• openapi
• openapitools
• openapi-generator

README

API to create road transport orders

For more information, please visit https://developer.my.gw-world.com/support.

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/wpify/gebrueder-weiss-transport-sdk.git"
    }
  ],
  "require": {
    "wpify/gebrueder-weiss-transport-sdk": "*@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: default
$config = GebruederWeissTransportSDK\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');

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


$apiInstance = new GebruederWeissTransportSDK\Api\CusTransportApi(
    // 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
);
$accept_language = en; // string | Select the language for the response with one of the codes defined in the BCP 47 standard.
$transport_order_request = new \GebruederWeissTransportSDK\Model\TransportOrderRequest(); // \GebruederWeissTransportSDK\Model\TransportOrderRequest | request body containing transportOrder

try {
    $apiInstance->transportOrderPost($accept_language, $transport_order_request);
} catch (Exception $e) {
    echo 'Exception when calling CusTransportApi->transportOrderPost: ', $e->getMessage(), PHP_EOL;
}

API Endpoints

All URIs are relative to https://my.api.gw-world.com/transport/transport-order/1.0.0

Class	Method	HTTP request	Description
CusTransportApi	transportOrderPost	POST /transport-order	create a transportOrder

Models

• Address
• Barcode
• Contact
• Dimension
• ErrorMessage
• ErrorMessageLogInfo
• GoodsItem
• Incoterm
• LingualText
• LingualText1
• Measurement
• Note
• PackItem
• Reference
• TextKeyReference
• Translation
• TranslationResolved
• TransportAddress
• TransportOrder
• TransportOrderRequest
• TransportProduct
• TransportRequirements
• Value

Authorization

Authentication schemes defined for the API:

default

• Type: OAuth
• Flow: implicit
• Authorization URL: https://my.api.gw-world.com/authorize
• Scopes:
  • API_CUSAPI_TRANSPORT_ORDER_CREATE: This scope provides access to transport order creation for customers and partners

default

• Type: OAuth
• Flow: application
• Authorization URL: ``
• Scopes:
  • API_CUSAPI_TRANSPORT_ORDER_CREATE: This scope provides access to transport order creation for customers and partners

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