Recurly Automated Exports API

openapi: 3.2.0
info:
  title: Recurly Automated Exports API
  version: v2021-02-25
  description: 'Operations tagged Automated Exports across 2 of this provider''s published API definitions: recurly-v3-v2021-02-25-api.yaml, recurly-openapi.yml. Each path carries the servers of the definition it was published in.'
servers:
- url: https://v3.recurly.com
- url: https://v3.eu.recurly.com
security:
- api_key: []
tags:
- name: Automated Exports
  description: Automated exports of customer data.
paths:
  /export_dates:
    get:
      tags:
      - Automated Exports
      operationId: get_export_dates
      summary: List the dates that have an available export to download
      description: Returns a list of dates for which export files are available for download.
      parameters:
      - $ref: '#/components/parameters/accept_header'
      responses:
        '200':
          description: Returns a list of dates.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ExportDates'
        '400':
          description: Invalid or unpermitted parameter.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
        '404':
          description: Incorrect site ID.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
        default:
          description: Unexpected error.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
      x-code-samples:
      - lang: Node.js
        source: "try {\n  const export_dates = await client.getExportDates()\n  export_dates.dates.forEach(date => {\n    console.log(`Exports are available for: ${date}`)\n  })\n} catch (err) {\n  if (err instanceof recurly.ApiError) {\n    console.log('Unexpected error', err)\n  }\n}\n"
      - lang: Python
        source: "try:\n    export_dates = client.get_export_dates()\n    for date in export_dates.dates:\n        print( \"Exports are available for: %s\" % date)\nexcept recurly.errors.NotFoundError:\n    # If the resource was not found, you may want to alert the user or\n    # just return nil\n    print(\"Resource Not Found\")\n"
      - lang: .NET
        source: "try\n{\n    ExportDates exportDates = client.GetExportDates();\n    foreach (var date in exportDates.Dates)\n    {\n        System.Console.WriteLine($\"Exports are available for: {date}\");\n    }\n}\ncatch (Recurly.Errors.ApiError ex)\n{\n    // Use ApiError to catch a generic error from the API\n    Console.WriteLine($\"Unexpected Recurly Error: {ex.Error.Message}\");\n}\n"
      - lang: Ruby
        source: "begin\n  export_dates = @client.get_export_dates()\n  export_dates.dates.each do |date|\n    puts \"Exports are available for: #{date}\"\n  end\nrescue Recurly::Errors::NotFoundError\n  # If the resource was not found, you may want to alert the user or\n  # just return nil\n  puts \"Resource Not Found\"\nend\n"
      - lang: Java
        source: "try {\n    ExportDates exportDates = client.getExportDates();\n    for (String date : exportDates.getDates()) {\n        System.out.println(\"Exports are available for: \" + date);\n    }\n} catch (ApiException e) {\n    // Use ApiException to catch a generic error from the API\n    System.out.println(\"Unexpected Recurly Error: \" + e.getError().getMessage());\n}\n"
      - lang: PHP
        source: "try {\n    $export_dates = $client->getExportDates();\n    foreach($export_dates->getDates() as $date)\n    {\n        echo \"Exports are available for: {$date}\" . PHP_EOL;\n    }\n} catch (\\Recurly\\RecurlyError $e) {\n    echo 'Some unexpected Recurly error happened. Try again later.' . PHP_EOL;\n}\n"
      - lang: Go
        source: "exportDates, err := client.GetExportDates()\nif e, ok := err.(*recurly.Error); ok {\n\tfmt.Printf(\"Unexpected Recurly error: %v\", e)\n\treturn nil, err\n}\n\nfor _, date := range exportDates.Dates {\n\tfmt.Println(\"Exports are available for: \", date)\n}"
      x-readme:
        code-samples:
        - language: node
          code: "try {\n  const export_dates = await client.getExportDates()\n  export_dates.dates.forEach(date => {\n    console.log(`Exports are available for: ${date}`)\n  })\n} catch (err) {\n  if (err instanceof recurly.ApiError) {\n    console.log('Unexpected error', err)\n  }\n}\n"
          name: Node.js
        - language: python
          code: "try:\n    export_dates = client.get_export_dates()\n    for date in export_dates.dates:\n        print( \"Exports are available for: %s\" % date)\nexcept recurly.errors.NotFoundError:\n    # If the resource was not found, you may want to alert the user or\n    # just return nil\n    print(\"Resource Not Found\")\n"
          name: Python
        - language: csharp
          code: "try\n{\n    ExportDates exportDates = client.GetExportDates();\n    foreach (var date in exportDates.Dates)\n    {\n        System.Console.WriteLine($\"Exports are available for: {date}\");\n    }\n}\ncatch (Recurly.Errors.ApiError ex)\n{\n    // Use ApiError to catch a generic error from the API\n    Console.WriteLine($\"Unexpected Recurly Error: {ex.Error.Message}\");\n}\n"
          name: .NET
        - language: ruby
          code: "begin\n  export_dates = @client.get_export_dates()\n  export_dates.dates.each do |date|\n    puts \"Exports are available for: #{date}\"\n  end\nrescue Recurly::Errors::NotFoundError\n  # If the resource was not found, you may want to alert the user or\n  # just return nil\n  puts \"Resource Not Found\"\nend\n"
          name: Ruby
        - language: java
          code: "try {\n    ExportDates exportDates = client.getExportDates();\n    for (String date : exportDates.getDates()) {\n        System.out.println(\"Exports are available for: \" + date);\n    }\n} catch (ApiException e) {\n    // Use ApiException to catch a generic error from the API\n    System.out.println(\"Unexpected Recurly Error: \" + e.getError().getMessage());\n}\n"
          name: Java
        - language: php
          code: "try {\n    $export_dates = $client->getExportDates();\n    foreach($export_dates->getDates() as $date)\n    {\n        echo \"Exports are available for: {$date}\" . PHP_EOL;\n    }\n} catch (\\Recurly\\RecurlyError $e) {\n    echo 'Some unexpected Recurly error happened. Try again later.' . PHP_EOL;\n}\n"
          name: PHP
        - language: go
          code: "exportDates, err := client.GetExportDates()\nif e, ok := err.(*recurly.Error); ok {\n\tfmt.Printf(\"Unexpected Recurly error: %v\", e)\n\treturn nil, err\n}\n\nfor _, date := range exportDates.Dates {\n\tfmt.Println(\"Exports are available for: \", date)\n}"
          name: Go
    servers:
    - url: https://v3.recurly.com
    - url: https://v3.eu.recurly.com
  /export_dates/{export_date}/export_files:
    parameters:
    - $ref: '#/components/parameters/export_date'
    get:
      tags:
      - Automated Exports
      operationId: get_export_files
      summary: List of the export files that are available to download
      description: Returns a list of presigned URLs to download export files for the given date, with their MD5 sums.
      parameters:
      - $ref: '#/components/parameters/accept_header'
      responses:
        '200':
          description: Returns a list of export files to download.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ExportFiles'
        '400':
          description: Invalid or unpermitted parameter.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
        '404':
          description: Incorrect site ID or date.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
        default:
          description: Unexpected error.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
      x-code-samples:
      - lang: Node.js
        source: "try {\n  const export_files = await client.getExportFiles(export_date)\n  export_files.files.forEach(file => {\n    console.log(`Export file download URL: ${file.href}`)\n  })\n} catch (err) {\n  if (err instanceof recurly.ApiError) {\n    console.log('Unexpected error', err)\n  }\n}\n"
      - lang: Python
        source: "try:\n    export_files = client.get_export_files(export_date)\n    for file in export_files.files:\n        print( \"Export file download URL: %s\" % file.href)\nexcept recurly.errors.NotFoundError:\n    # If the resource was not found, you may want to alert the user or\n    # just return nil\n    print(\"Resource Not Found\")\n"
      - lang: .NET
        source: "try\n{\n    ExportFiles exportFiles = client.GetExportFiles(exportDate: exportDate);\n    foreach (var file in exportFiles.Files)\n    {\n        System.Console.WriteLine($\"Export file download URL: {file.Href}\");\n    }\n}\ncatch (Recurly.Errors.ApiError ex)\n{\n    // Use ApiError to catch a generic error from the API\n    Console.WriteLine($\"Unexpected Recurly Error: {ex.Error.Message}\");\n}\n"
      - lang: Ruby
        source: "begin\n  export_files = @client.get_export_files(export_date: export_date)\n  export_files.files.each do |file|\n    puts \"Export file download URL: #{file.href}\"\n  end\nrescue Recurly::Errors::NotFoundError\n  # If the resource was not found, you may want to alert the user or\n  # just return nil\n  puts \"Resource Not Found\"\nend\n"
      - lang: Java
        source: "try {\n    ExportFiles exportFiles = client.getExportFiles(exportDate);\n    for (ExportFile file : exportFiles.getFiles()) {\n        System.out.println(\"Export file download URL: \" + file.getHref());\n    }\n} catch (ApiException e) {\n    // Use ApiException to catch a generic error from the API\n    System.out.println(\"Unexpected Recurly Error: \" + e.getError());\n}\n"
      - lang: PHP
        source: "try {\n    $export_files = $client->getExportFiles($export_date);\n    foreach($export_files->getFiles() as $file)\n    {\n        echo \"Export file download URL: {$file->getHref()}\" . PHP_EOL;\n    }\n} catch (\\Recurly\\RecurlyError $e) {\n    echo 'Some unexpected Recurly error happened. Try again later.' . PHP_EOL;\n}\n"
      - lang: Go
        source: "exportFiles, err := client.GetExportFiles(exportDate)\nif e, ok := err.(*recurly.Error); ok {\n\tfmt.Printf(\"Unexpected Recurly error: %v\", e)\n\treturn nil, err\n}\n\nfor _, file := range exportFiles.Files {\n\tfmt.Println(\"Export file download URL: \", file.Href)\n}"
      x-readme:
        code-samples:
        - language: node
          code: "try {\n  const export_files = await client.getExportFiles(export_date)\n  export_files.files.forEach(file => {\n    console.log(`Export file download URL: ${file.href}`)\n  })\n} catch (err) {\n  if (err instanceof recurly.ApiError) {\n    console.log('Unexpected error', err)\n  }\n}\n"
          name: Node.js
        - language: python
          code: "try:\n    export_files = client.get_export_files(export_date)\n    for file in export_files.files:\n        print( \"Export file download URL: %s\" % file.href)\nexcept recurly.errors.NotFoundError:\n    # If the resource was not found, you may want to alert the user or\n    # just return nil\n    print(\"Resource Not Found\")\n"
          name: Python
        - language: csharp
          code: "try\n{\n    ExportFiles exportFiles = client.GetExportFiles(exportDate: exportDate);\n    foreach (var file in exportFiles.Files)\n    {\n        System.Console.WriteLine($\"Export file download URL: {file.Href}\");\n    }\n}\ncatch (Recurly.Errors.ApiError ex)\n{\n    // Use ApiError to catch a generic error from the API\n    Console.WriteLine($\"Unexpected Recurly Error: {ex.Error.Message}\");\n}\n"
          name: .NET
        - language: ruby
          code: "begin\n  export_files = @client.get_export_files(export_date: export_date)\n  export_files.files.each do |file|\n    puts \"Export file download URL: #{file.href}\"\n  end\nrescue Recurly::Errors::NotFoundError\n  # If the resource was not found, you may want to alert the user or\n  # just return nil\n  puts \"Resource Not Found\"\nend\n"
          name: Ruby
        - language: java
          code: "try {\n    ExportFiles exportFiles = client.getExportFiles(exportDate);\n    for (ExportFile file : exportFiles.getFiles()) {\n        System.out.println(\"Export file download URL: \" + file.getHref());\n    }\n} catch (ApiException e) {\n    // Use ApiException to catch a generic error from the API\n    System.out.println(\"Unexpected Recurly Error: \" + e.getError());\n}\n"
          name: Java
        - language: php
          code: "try {\n    $export_files = $client->getExportFiles($export_date);\n    foreach($export_files->getFiles() as $file)\n    {\n        echo \"Export file download URL: {$file->getHref()}\" . PHP_EOL;\n    }\n} catch (\\Recurly\\RecurlyError $e) {\n    echo 'Some unexpected Recurly error happened. Try again later.' . PHP_EOL;\n}\n"
          name: PHP
        - language: go
          code: "exportFiles, err := client.GetExportFiles(exportDate)\nif e, ok := err.(*recurly.Error); ok {\n\tfmt.Printf(\"Unexpected Recurly error: %v\", e)\n\treturn nil, err\n}\n\nfor _, file := range exportFiles.Files {\n\tfmt.Println(\"Export file download URL: \", file.Href)\n}"
          name: Go
    servers:
    - url: https://v3.recurly.com
    - url: https://v3.eu.recurly.com
components:
  schemas:
    AcceptHeaderEnum:
      type: string
      enum:
      - application/vnd.recurly.v2021-02-25
      - application/vnd.recurly.v2021-02-25+json
    ExportFile:
      type: object
      properties:
        name:
          type: string
          title: Filename
          description: Name of the export file.
        md5sum:
          type: string
          title: MD5 hash of the export file
          description: MD5 hash of the export file.
        href:
          type: string
          title: A link to the export file
          description: A presigned link to download the export file.
    Error:
      type: object
      properties:
        type:
          title: Type
          $ref: '#/components/schemas/ErrorTypeEnum'
        message:
          type: string
          title: Message
        params:
          type: array
          title: Parameter specific errors
          items:
            type: object
            properties:
              param:
                type: string
    ErrorTypeEnum:
      type: string
      enum:
      - bad_request
      - immutable_subscription
      - internal_server_error
      - invalid_api_key
      - invalid_api_version
      - invalid_content_type
      - invalid_permissions
      - invalid_token
      - missing_feature
      - not_found
      - rate_limited
      - service_not_available
      - simultaneous_request
      - tax_service_error
      - transaction
      - unauthorized
      - unavailable_in_api_version
      - unknown_api_version
      - validation
    ExportFiles:
      type: object
      properties:
        object:
          type: string
          title: Object type
          readOnly: true
        files:
          type: array
          items:
            $ref: '#/components/schemas/ExportFile'
    ExportDates:
      type: object
      properties:
        object:
          type: string
          title: Object type
          readOnly: true
        dates:
          type: array
          items:
            type: string
          title: An array of dates that have available exports.
  parameters:
    accept_header:
      name: Accept
      in: header
      description: The API version to use for this request, e.g. `application/vnd.recurly.v2021-02-25`. Requests without a versioned `Accept` header return a 406 response.
      required: true
      schema:
        default: application/vnd.recurly.v2021-02-25
        $ref: '#/components/schemas/AcceptHeaderEnum'
    export_date:
      name: export_date
      in: path
      description: Date for which to get a list of available automated export files. Date must be in YYYY-MM-DD format.
      required: true
      schema:
        type: string
  securitySchemes:
    api_key:
      type: http
      description: Enter the API key as the username and set the password to an empty string. You can locate and manage your API keys from the [API Credentials](https://app.recurly.com/go/developer/api_keys) page.
      scheme: basic
x-refined-from:
- recurly-v3-v2021-02-25-api.yaml
- recurly-openapi.yml
x-readme:
  explorer-enabled: false